Open
Conversation
IExploitableMan
requested changes
Mar 25, 2026
docs/docs/introduction.md
Outdated
| Hi! This page will teach you the very basics of modding Polytopia. | ||
|
|
||
| # How do I make a mod? | ||
| Polytopia mods are essentially a folder/`.zip` file/`.polymod` file that contains a `manifest.json` file and other components of the mod. Mods are stored in the `Mods` folder of the Polytopia root folder. |
Contributor
There was a problem hiding this comment.
folder/
.zipfile/.polymod
looks bad
Polytopia root folder.
explain root folder
docs/docs/introduction.md
Outdated
| # How do I make a mod? | ||
| Polytopia mods are essentially a folder/`.zip` file/`.polymod` file that contains a `manifest.json` file and other components of the mod. Mods are stored in the `Mods` folder of the Polytopia root folder. | ||
|
|
||
| In order to make a new mod, you have to create a new folder inside the `Mods` folder, name it whatever, and then put a `manifest.json` file in it (more on this later). You can also zip this folder to turn it into a distributable mod, and you can rename the extention to .polymod so you can properly distribute it on the [polymod.dev](https://polymod.dev/) website. |
Contributor
There was a problem hiding this comment.
Ziping folder is bad
name it whatever
bruh?
docs/docs/introduction.md
Outdated
| } | ||
| ``` | ||
| > [!TIP] | ||
| > If you aren't familiar with the JSON format, try reading a bit about it first. |
Author
There was a problem hiding this comment.
mb bro imma add it if i find out how
docs/docs/introduction.md
Outdated
| ``` | ||
|
|
||
| # Manifest | ||
| The `manifest.json` file contains basic information about your mod, like its id, name, description, authors, dependencies, so on. This file is a json file, and looks something like this: |
Contributor
There was a problem hiding this comment.
*metadata of the mod
Author
|
@IExploitableMan wdyt? |
📝 WalkthroughWalkthroughExpanded the introduction documentation from a bare header into a full guide covering mod creation, supported packaging formats (folder, Changes
Estimated Code Review Effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
docs/docs/introduction.md (2)
23-30: Add a language hint to the fenced code block.The hierarchy example fence has no language tag. Add one (for example
text) to satisfy markdown lint and improve readability.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/docs/introduction.md` around lines 23 - 30, The fenced code block showing the mod folder hierarchy currently has no language tag; update the triple-backtick fence that precedes the block containing "The Battle of Polytopia (this is your "polytopia root" folder)" so it becomes a language-tagged fence (e.g., ```text) to satisfy markdown lint and improve readability; keep the block content identical and only add the language identifier after the opening backticks.
7-7: Clean up spelling/wording in key instructional lines.There are a few visible typos/phrasing issues (e.g., “aswell”, “extention”, “user friendly”, “you format is”, “whats”). Quick pass will improve polish and reduce reader confusion.
Also applies to: 20-20, 65-65, 67-67, 77-77
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/docs/introduction.md` at line 7, Fix spelling and wording in the instructional text: change "aswell" to "as well", "extention" to "extension", "user friendly" to "user-friendly", "you format is" to "your format is", and "whats" to "what's"; also simplify the parenthetical "Polytopia root folder (Polytopia root folder is the folder that holds all the information about the game)" to a concise phrase like "Polytopia root folder, which contains the game's data." Apply these edits to the sentence starting with "Mods also have a `manifest.json` file, aswell ..." and make the same spelling/phrasing fixes at the other flagged locations (lines referenced in the review).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/docs/introduction.md`:
- Around line 16-19: The doc contains an unresolved placeholder under the "**On
epic**" section reading "I HAVE NO CLUE LMAO TO FIX!!!!!!!!!!!!"; replace that
exact placeholder with either a short, verified set of Epic steps (clear
actionable bullets) or a neutral "TBD — Epic steps to be added" note, and ensure
the text uses professional tone and matches surrounding Markdown style (e.g.,
keep the bold heading "**On epic**" and use bullet list or a single neutral
sentence).
- Around line 59-61: The NOTE admonition block starting with "[!NOTE]" has a
line ("We advise you use some code editor app...") that is missing the
blockquote prefix, breaking rendering; update the markdown so every line in that
admonition is prefixed with ">" (i.e., add ">" before the editor recommendation
line) so the entire NOTE block renders correctly in the introduction.md file.
- Around line 34-55: The manifest.json example contains invalid JSON due to a
trailing comma after the "min": "2.0.0" entry in the dependencies object (the
polytopia dependency); remove that trailing comma so the object becomes valid
JSON, then validate the snippet (e.g., with a JSON linter) to ensure no other
trailing commas or syntax errors remain before committing.
---
Nitpick comments:
In `@docs/docs/introduction.md`:
- Around line 23-30: The fenced code block showing the mod folder hierarchy
currently has no language tag; update the triple-backtick fence that precedes
the block containing "The Battle of Polytopia (this is your "polytopia
root" folder)" so it becomes a language-tagged fence (e.g., ```text) to satisfy
markdown lint and improve readability; keep the block content identical and only
add the language identifier after the opening backticks.
- Line 7: Fix spelling and wording in the instructional text: change "aswell" to
"as well", "extention" to "extension", "user friendly" to "user-friendly", "you
format is" to "your format is", and "whats" to "what's"; also simplify the
parenthetical "Polytopia root folder (Polytopia root folder is the folder that
holds all the information about the game)" to a concise phrase like "Polytopia
root folder, which contains the game's data." Apply these edits to the sentence
starting with "Mods also have a `manifest.json` file, aswell ..." and make the
same spelling/phrasing fixes at the other flagged locations (lines referenced in
the review).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+16
to
+19
| > **On epic** | ||
| > | ||
| > [I HAVE NO CLUE LMAO TO FIX!!!!!!!!!!!!] | ||
|
|
There was a problem hiding this comment.
Replace unresolved placeholder text before merge.
Line 18 still contains an internal placeholder (I HAVE NO CLUE...) and shouldn’t ship in public docs. Either provide verified Epic steps or explicitly mark as “TBD” in neutral language.
🧰 Tools
🪛 LanguageTool
[style] ~19-~19: Consider a more concise word here.
Context: ... HAVE NO CLUE LMAO TO FIX!!!!!!!!!!!!] In order to make a new mod, you have to create a ne...
(IN_ORDER_TO_PREMIUM)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/docs/introduction.md` around lines 16 - 19, The doc contains an
unresolved placeholder under the "**On epic**" section reading "I HAVE NO CLUE
LMAO TO FIX!!!!!!!!!!!!"; replace that exact placeholder with either a short,
verified set of Epic steps (clear actionable bullets) or a neutral "TBD — Epic
steps to be added" note, and ensure the text uses professional tone and matches
surrounding Markdown style (e.g., keep the bold heading "**On epic**" and use
bullet list or a single neutral sentence).
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (2)
docs/docs/introduction.md (2)
16-18:⚠️ Potential issue | 🔴 CriticalUnresolved placeholder text in public documentation.
Line 18 still contains the internal placeholder
[I HAVE NO CLUE LMAO TO FIX!!!!!!!!!!!!]flagged in previous reviews. This must be replaced with either verified Epic instructions or a professional placeholder like "To be documented" before merging public-facing documentation.✍️ Suggested neutral placeholder
> **On epic** > -> [I HAVE NO CLUE LMAO TO FIX!!!!!!!!!!!!] +> Epic game launcher instructions to be added.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/docs/introduction.md` around lines 16 - 18, Replace the unresolved placeholder text "[I HAVE NO CLUE LMAO TO FIX!!!!!!!!!!!!]" under the "**On epic**" section with either the verified Epic instructions or a neutral professional placeholder like "To be documented"; locate the "**On epic**" heading in the introduction document and update the paragraph content accordingly so no internal/debug placeholder remains in public docs.
59-61:⚠️ Potential issue | 🟡 MinorFix broken NOTE admonition formatting.
Line 60 is missing the
>blockquote prefix, which will break the NOTE block rendering. All lines within a markdown admonition must be prefixed with>.📝 Proposed fix
> [!NOTE] -We advise you use some code editor app like Visual Studio Code or Notepad++ (or anything, just be comfortable writing JSON). +> We advise you use some code editor app like Visual Studio Code or Notepad++ (or anything, just be comfortable writing JSON).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/docs/introduction.md` around lines 59 - 61, The NOTE admonition is broken because the second line ("We advise you use some code editor...") lacks the leading ">" so the blockquote stops; edit the markdown in docs/docs/introduction.md to prefix that line (and any subsequent lines belonging to the NOTE) with ">" so the entire admonition (the "[!NOTE]" line and its text) is consistently blockquoted and renders correctly before the "## Components of a manifest file:" header.
🧹 Nitpick comments (1)
docs/docs/introduction.md (1)
67-67: Consider clearer phrasing for version format.The phrase "format is so" is informal. Consider "format it as" or "use the format" for better clarity.
✍️ Suggested alternatives
-Tells the user, aswell as the [polymod.dev](https://polymod.dev/) website what version of your mod this is. It only accepts numbers, and you format is so: `x.y.z.w` (`z` and `w` are optional, though `x` and `y` are not). +Tells the user, as well as the [polymod.dev](https://polymod.dev/) website what version of your mod this is. It only accepts numbers, and you format it as: `x.y.z.w` (`z` and `w` are optional, though `x` and `y` are not).Note: Also corrects "aswell" → "as well"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/docs/introduction.md` at line 67, Update the sentence that currently reads "Tells the user, aswell as the [polymod.dev]... what version of your mod this is. It only accepts numbers, and you format is so: `x.y.z.w`..." by correcting "aswell" to "as well" and replacing the informal "you format is so" with a clearer phrase such as "format it as" or "use the format", e.g. "Tells the user, as well as the [polymod.dev] website, what version of your mod this is. It only accepts numbers; format it as `x.y.z.w` (`z` and `w` are optional, though `x` and `y` are not)."
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/docs/introduction.md`:
- Line 65: The phrase "user friendly" in the sentence "The user friendly name of
the mod." should be a compound adjective; change it to "user-friendly" so the
sentence reads "The user-friendly name of the mod." Update this exact text in
docs/docs/introduction.md (look for the sentence "The user friendly name of the
mod.") to apply the hyphen.
- Line 20: Replace the misspelled word "extention" with "extension" in the
sentence that reads "zip this folder and rename the extention to `.polymod`"
within the introduction docs; update that exact phrase so it reads "...rename
the extension to `.polymod`" to correct the user-facing documentation.
- Line 77: Update the sentence "Here you can tell users what your mod is about!
When publishing, try to be descriptive cause this is whats going to show up the
mod catalogue!" by replacing "cause" with "because", changing "whats" to the
contraction "what's", and inserting the preposition "in" before "the mod
catalogue" so the line reads naturally (e.g., "...what your mod is about! When
publishing, try to be descriptive because this is what's going to show up in the
mod catalogue!").
---
Duplicate comments:
In `@docs/docs/introduction.md`:
- Around line 16-18: Replace the unresolved placeholder text "[I HAVE NO CLUE
LMAO TO FIX!!!!!!!!!!!!]" under the "**On epic**" section with either the
verified Epic instructions or a neutral professional placeholder like "To be
documented"; locate the "**On epic**" heading in the introduction document and
update the paragraph content accordingly so no internal/debug placeholder
remains in public docs.
- Around line 59-61: The NOTE admonition is broken because the second line ("We
advise you use some code editor...") lacks the leading ">" so the blockquote
stops; edit the markdown in docs/docs/introduction.md to prefix that line (and
any subsequent lines belonging to the NOTE) with ">" so the entire admonition
(the "[!NOTE]" line and its text) is consistently blockquoted and renders
correctly before the "## Components of a manifest file:" header.
---
Nitpick comments:
In `@docs/docs/introduction.md`:
- Line 67: Update the sentence that currently reads "Tells the user, aswell as
the [polymod.dev]... what version of your mod this is. It only accepts numbers,
and you format is so: `x.y.z.w`..." by correcting "aswell" to "as well" and
replacing the informal "you format is so" with a clearer phrase such as "format
it as" or "use the format", e.g. "Tells the user, as well as the [polymod.dev]
website, what version of your mod this is. It only accepts numbers; format it as
`x.y.z.w` (`z` and `w` are optional, though `x` and `y` are not)."
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
teehee
Summary by CodeRabbit