diff --git a/README.md b/README.md index bc9a279..6cdc5a2 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,34 @@ # 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 - Node.js (preferably latest) - Yarn +- Existing installation of Super Mario War ## Setup -1. Install dependencies: +1. Create `tools/` in the Super Mario War directory. +2. Clone this repository inside `tools/`. +3. Install dependencies: ```shell yarn [install] ``` -2. Build the app: + +4. Link the assets to the game files: + + ```shell + yarn link-gfx + ``` +5. Build the app: ```shell yarn build ``` -3. Run the app on `http://localhost:3000`: +6. Run the app on `http://localhost:3000`: ```shell 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/). 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). -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.