Browse Source

Update README

Ensure SMWar is present.
master
TheoryOfNekomata 2 years ago
parent
commit
8e506139fc
1 changed files with 15 additions and 5 deletions
  1. +15
    -5
      README.md

+ 15
- 5
README.md View File

@@ -1,25 +1,34 @@
# real-worldgen # real-worldgen


Generate Super Mario War worlds from real-world data.
Generate [Super Mario War](http://supermariowar.supersanctuary.net/) worlds from real-world data.


## Requirements ## Requirements


- Node.js (preferably latest) - Node.js (preferably latest)
- Yarn - Yarn
- Existing installation of Super Mario War


## Setup ## Setup


1. Install dependencies:
1. Create `tools/` in the Super Mario War directory.
2. Clone this repository inside `tools/`.
3. Install dependencies:


```shell ```shell
yarn [install] yarn [install]
``` ```
2. Build the app:

4. Link the assets to the game files:

```shell
yarn link-gfx
```
5. Build the app:


```shell ```shell
yarn build yarn build
``` ```
3. Run the app on `http://localhost:3000`:
6. Run the app on `http://localhost:3000`:


```shell ```shell
yarn start yarn start
@@ -34,4 +43,5 @@ This project is made from [Next](https://nextjs.org). Development practices for
Biome map obtained from [Minecraft Earth Map](https://earth.motfe.net/tiles-biomes/). Biome map obtained from [Minecraft Earth Map](https://earth.motfe.net/tiles-biomes/).
Land elevation, bathymetry, and real-color maps obtained from [Visible Earth](https://visibleearth.nasa.gov/). Land elevation, bathymetry, and real-color maps obtained from [Visible Earth](https://visibleearth.nasa.gov/).
Water mask map obtained from [Shaded Relief](https://www.shadedrelief.com/natural3/pages/extra.html). Water mask map obtained from [Shaded Relief](https://www.shadedrelief.com/natural3/pages/extra.html).
Uses [D3](https://d3js.org/) (d3-geo) for map projections.
Uses [D3](https://d3js.org/) (d3-geo) for map projections. Super Mario is a property of Nintendo.
[Super Mario War](http://supermariowar.supersanctuary.net/) is a fangame inspired by Super Mario games.

Loading…
Cancel
Save