Skip to content

Document C compiler requirement for map generator 📝 - #4877

Closed
FloPinguin wants to merge 2 commits into
mainfrom
map-generator-readme-c-compiler
Closed

Document C compiler requirement for map generator 📝#4877
FloPinguin wants to merge 2 commits into
mainfrom
map-generator-readme-c-compiler

Conversation

@FloPinguin

Copy link
Copy Markdown
Contributor

Description:

Add a C compiler installation step to the map-generator README. The chai2010/webp dependency bundles libwebp-1.4 and uses CGO, so a C compiler (GCC on Windows/Linux, Xcode CLI tools on macOS) is required to build the map generator.

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

@coderabbitai

coderabbitai Bot commented Aug 5, 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: c7cbade3-829d-42e7-bbfa-840e770b3f4f

📥 Commits

Reviewing files that changed from the base of the PR and between 2c5f190 and ebede19.

📒 Files selected for processing (1)
  • map-generator/README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • map-generator/README.md

Walkthrough

The map generator README now requires a C compiler for the WebP dependency. It provides setup instructions for Windows, macOS, and Linux.

Changes

Map generator installation

Layer / File(s) Summary
Document C compiler setup
map-generator/README.md
The installation steps now include platform-specific C compiler setup before the existing generator commands.

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

Poem

A compiler joins the map-making crew,
WebP now builds as it should do.
Windows, macOS, Linux align,
Clear steps guide the build pipeline.
Small docs change, smooth paths unwind.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documented C compiler requirement for the map generator.
Description check ✅ Passed The description directly explains the README change and the C compiler requirement for the WebP dependency.
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.

@FloPinguin FloPinguin added this to the v34 milestone Aug 5, 2026
@FloPinguin FloPinguin mentioned this pull request Aug 5, 2026
1 task

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@map-generator/README.md`:
- Line 15: Update the Windows installation guidance in the README to name the
exact MSYS2 UCRT64 package and installation command,
`mingw-w64-ucrt-x86_64-gcc`, and clarify that `gcc` must be used from the
corresponding MSYS2 terminal or compiler directory; keep the alternative TDM-GCC
guidance unchanged.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 0021e0c1-ad33-462a-b589-6b643a9fabd4

📥 Commits

Reviewing files that changed from the base of the PR and between d77e4a0 and 2c5f190.

📒 Files selected for processing (1)
  • map-generator/README.md

Comment thread map-generator/README.md Outdated
@github-project-automation github-project-automation Bot moved this from Triage to Development in OpenFront Release Management Aug 5, 2026
@VariableVince

Copy link
Copy Markdown
Contributor

@FloPinguin this seems no longer needed now that #4879 has been merged, correct?

@FloPinguin FloPinguin closed this Aug 5, 2026
@github-project-automation github-project-automation Bot moved this from Development to Complete in OpenFront Release Management Aug 5, 2026
@FloPinguin

Copy link
Copy Markdown
Contributor Author

@FloPinguin this seems no longer needed now that #4879 has been merged, correct?

Correct :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Complete

Development

Successfully merging this pull request may close these issues.

2 participants