mirror of
https://github.com/openfrontio/OpenFrontIO.git
synced 2026-06-21 14:50:44 +00:00
Aotumuri
2450ef29ca
## Description: This PR removes the `map-generator/generated` directory to avoid confusion. The current map generation process (`map-generator/main.go`) outputs map data to: - `../resources/maps` (for normal maps) - `../tests/testdata/maps` (for test maps) The `generated` directory is not used anywhere in the current codebase. Keeping the unused `map-generator/generated` directory may cause confusion for contributors or users who expect it to be part of the active map pipeline. Removing it clarifies that only `resources/maps` and `testdata/maps` are valid output directories. No functional changes are introduced. ## Please complete the following: - [x] I have added screenshots for all UI updates - [x] I process any text displayed to the user through translateText() and I've added it to the en.json file - [x] I have added relevant tests to the test directory - [x] I confirm I have thoroughly tested these changes and take full responsibility for any bugs introduced ## Please put your Discord username so you can be contacted if a bug or regression is found: aotumuri
MapGenerator
This is a tool to generate map files for OpenFront.
Installation
- Install go https://go.dev/doc/install
- Install dependencies:
go mod download - Run the generator:
go run .
Creating a new map
- Create a new folder in assets/maps/<map_name>
- Create image.png
- Create info.json with name and countries
- Add the map name in main.go
- Run the generator:
go run . - Find the output folder at generated/maps/<map_name>
Create image.png
- Download world map (warning very large file) https://drive.google.com/file/d/1W2oMPj1L5zWRyPhh8LfmnY3_kve-FBR2/view?usp=sharing
- Crop the file (recommend Gimp), we recommend roughly 2 million pixels for performance reasons. Do not go over 4 million pixels.
Create info.json
- Look at existing info.json for structure
- Use country codes found here: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
Notes
- Islands smaller than 30 tiles (pixels) are automatically removed by the script.
- Bodies of water smaller than 200 tiles (pixels) are also removed.