Skip to content

New online docs#144

Open
wasdeilonn wants to merge 6 commits into
PolyModdingTeam:mainfrom
wasdeilonn:main
Open

New online docs#144
wasdeilonn wants to merge 6 commits into
PolyModdingTeam:mainfrom
wasdeilonn:main

Conversation

@wasdeilonn

@wasdeilonn wasdeilonn commented Mar 25, 2026

Copy link
Copy Markdown

teehee

@IExploitableMan IExploitableMan changed the title intro and manifest New online docs Mar 25, 2026
Comment thread 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.

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.

folder/.zip file/.polymod

looks bad

Polytopia root folder.

explain root folder

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

true

Comment thread 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.

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.

Ziping folder is bad

name it whatever
bruh?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

k

Comment thread docs/docs/introduction.md Outdated
}
```
> [!TIP]
> If you aren't familiar with the JSON format, try reading a bit about it first.

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.

Reading where??
https://json.org/

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

mb bro imma add it if i find out how

Comment thread 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:

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.

*metadata of the mod

@wasdeilonn wasdeilonn marked this pull request as draft March 25, 2026 19:19
@wasdeilonn

Copy link
Copy Markdown
Author

@IExploitableMan wdyt?

@wasdeilonn wasdeilonn marked this pull request as ready for review March 26, 2026 15:31
coderabbitai[bot]

This comment was marked as low quality.

coderabbitai[bot]

This comment was marked as low quality.

wasdeilonn and others added 3 commits March 26, 2026 18:03
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>
@PolyModdingTeam PolyModdingTeam deleted a comment from coderabbitai Bot Apr 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants