Skip to content

Better info.json documentation 🗺️ - #4814

Merged
evanpelle merged 1 commit into
mainfrom
update-map-generator-docs
Jul 31, 2026
Merged

Better info.json documentation 🗺️#4814
evanpelle merged 1 commit into
mainfrom
update-map-generator-docs

Conversation

@FloPinguin

Copy link
Copy Markdown
Contributor

Description:

Restructured the ## Create info.json section in the map-generator README with proper sub-headings and tables, documented all fields (including previously missing custom_tribes, themes, and the new layers option), and created a new docs/Maps.md entry point linking into the MapGenerator README.

Changes:

  • map-generator/README.md: Reorganized the info.json docs into ### Fields, ### Categories, ### Nations, and ### Layers sub-sections with tables. Added layers field documentation (id, placement, nukeable) and an example in the JSON sample. Marked nation coordinates as optional (omit for random spawn). Added custom_tribes and themes fields 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:

  • I have added screenshots for all UI updates
  • I process any text displayed to the user through translateText() and I've added it to the en.json file
  • I have added relevant tests to the test directory

Please put your Discord username so you can be contacted if a bug or regression is found:

FloPinguin

@FloPinguin FloPinguin added this to the v33 milestone Jul 31, 2026
@FloPinguin FloPinguin added the Maps A new map, or adjustments to an existing map itself, its json, etc, label Jul 31, 2026
@FloPinguin
FloPinguin requested a review from a team as a code owner July 31, 2026 19:59
@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 03fa487f-965f-4fef-b0f6-a56995544d68

📥 Commits

Reviewing files that changed from the base of the PR and between 3fa1a8e and 973e33a.

📒 Files selected for processing (2)
  • docs/Maps.md
  • map-generator/README.md

Walkthrough

The changes add map-generation guidance and expand info.json documentation. They cover MapGenerator references, map fields, categories, nations, layers, overlays, localization, and related metadata.

Changes

MapGenerator documentation

Layer / File(s) Summary
Map generation and metadata documentation
docs/Maps.md, map-generator/README.md
Adds MapGenerator links and command-line guidance. Replaces prose-only info.json guidance with structured examples and tables for map fields, nations, layers, overlays, localization, and metadata.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

Suggested labels: small-fix

Suggested reviewers: tidwell

Poem

Maps gain a clearer guide,
Fields and layers stand beside.
Nations, themes, flags align,
info.json reads clear by design.
Paths and commands now shine.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: improved info.json documentation.
Description check ✅ Passed The description directly explains the README restructuring and the new Maps documentation entry point.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-project-automation github-project-automation Bot moved this from Triage to Final Review in OpenFront Release Management Jul 31, 2026
@evanpelle
evanpelle merged commit aa8b259 into main Jul 31, 2026
17 of 18 checks passed
@evanpelle
evanpelle deleted the update-map-generator-docs branch July 31, 2026 21:12
@github-project-automation github-project-automation Bot moved this from Final Review to Complete in OpenFront Release Management Jul 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Maps A new map, or adjustments to an existing map itself, its json, etc,

Projects

Status: Complete

Development

Successfully merging this pull request may close these issues.

2 participants