Better info.json documentation 🗺️ - #4814
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
WalkthroughThe changes add map-generation guidance and expand ChangesMapGenerator documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
Suggested labels: Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Description:
Restructured the
## Create info.jsonsection in the map-generator README with proper sub-headings and tables, documented all fields (including previously missingcustom_tribes,themes, and the newlayersoption), and created a newdocs/Maps.mdentry point linking into the MapGenerator README.Changes:
map-generator/README.md: Reorganized the info.json docs into### Fields,### Categories,### Nations, and### Layerssub-sections with tables. Addedlayersfield documentation (id, placement, nukeable) and an example in the JSON sample. Marked nationcoordinatesas optional (omit for random spawn). Addedcustom_tribesandthemesfields that were previously undocumented.docs/Maps.md: New file that links to the MapGenerator README sections for map creation, info.json schema, impassable terrain, output files, and CLI flags.Please complete the following:
Please put your Discord username so you can be contacted if a bug or regression is found:
FloPinguin