Resolves#2594
## Description:
- Added an optional `--maps` flag to the map-generator that allows
passing a subset of maps to process.
- Updated `README.md` w/ documentation for using the new flag
Used the [go/flag](https://pkg.go.dev/flag) package.
Running without the flag, or with no arguments matches existing behavior
of processing all the maps defined in `main.go`
`go run .`
`go run . --maps=`
New behavior is triggered to process a subset of maps by passing the
`--maps` flag. Multiple maps are defined in a comma-separated list
`go run . --maps=world,africa`
Or a single map (useful for map development)
`go run . --maps=fourislands`
If an invalid map is passed, the process aborts and renders the error
```bash
go run . --maps=invalidmapname
Error generating terrain maps: map "invalidmapname" is not defined
exit status 1
```
By using the default flag package, we get `--help` for free:
```bash
go run . --help
Usage of <path-to-exe>/exe/map-generator:
-maps string
optional comma-separated list of maps to process. ex: --maps=world,eastasia,big_plains
```
I do not write GO often. Gemini contributed to this syntax.
## 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:
tidwell
I'd like to submit some PRs in the future to add additional options for
logging and debugging to the map-generator, however I don't want to
introduce any code style changes in feature requests.
## Description:
I noticed there was not any style guide or formatting being done for the
go files, and went with the simplest built-in approach w/ [go
fmt](https://go.dev/blog/gofmt)
- Adds a `format:map-generator` npm command that will run the default
`go fmt` in the `map-generator` directory to format the go code.
- Runs the formatter and commits the changes to `main.go` and
`map_generator.go`
- Updates the `map-generator` README:
- Updated location for generated files
- Updated Links to use markdown links
- Add `info.json` example
- Add in-game enabling instructions with list of files to modify
- Add development tools section with format command
## 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:
tidwell
