Limits and rules
How much a mod can hold, which files it may contain, the Workshop content rules, and what happens to your save when a mod is taken away.
This page has four parts: file count and size limits, the Workshop content rules, what happens when a mod is removed, and the rules for achievements and the demo.
File count and size limits#
| Item | Limit |
|---|---|
| Files in one mod | 200 |
| Total size of a mod | 32 MB |
| A single JSON file | 2 MB |
A script file (.js) | 512 KB |
mod.json | 64 KB |
| Options | 32 |
Dependencies (dependsOn) | 16 |
| Blocks in one item | 4000, with every coordinate between -64 and 64 |
Preview image preview.png | Up to 5 MB, longest side up to 2048 pixels |
| Title when publishing | 1 to 128 characters |
| Summary when publishing | Up to 1000 characters |
Which files are allowed#
A mod folder may only contain these five file types:
.json:mod.json, content tables, voxel models, translations..js: scripts..png: the preview image..mdand.txt: notes and text.
Other formats (images, music, programs) cannot be included and will not be loaded. Files whose names start with . (such as .DS_Store and .git) are ignored. The folder name can only use English letters, digits, underscores and hyphens, up to 64 characters, and must start with a letter or digit. JSON that is nested too deeply is rejected.
Mods cannot change world generation (terrain, biomes) yet. Building blueprints can be placed in the world, but the terrain itself cannot be changed.
Workshop content rules#
You can share mods and character styles for Fangjie Shattered Altars on the Workshop. Please follow these rules.
Allowed#
- Original items, food, rules, creatures, quests, building blueprints, script mods, and character styles.
- Only upload assets you have the right to publish.
Not allowed#
- Sexual or explicit sexual content.
- Hate speech, harassment, or content that targets a group of people.
- Personally identifiable information.
- Impersonating official content, or pretending to be another person, brand, or organization.
- Copyrighted material you do not have permission to use, including art, music, and trademarks.
- Malicious code: anything that tries to read, change, or send other players' data, or otherwise harms players.
- Asking players to open external links or download and run any file.
Mature themes#
Dark-themed works may include grim or intense themes, but must not contain sexual content. If your work contains mature themes, state “Mature Theme” in the description.
Enforcement#
Works that break these rules may be marked incompatible, banned, or removed. Mod content is validated on each player's computer before it is applied, and script mods only run in a sandbox that cannot reach a player's save or the network.
What happens when a mod is removed#
Switching the set of mods (enabling, disabling, updating, unsubscribing) reloads the game. Mod content already saved in a world is not deleted. The world's save remembers which mods it used.
| Content | While the mod is missing | When the mod is back |
|---|---|---|
| Items (bag and storage) | Mod items the game does not recognize are set aside, not lost. | They return to where they were. |
| Pets and creature species | Unknown mod species are set aside. | They appear again. |
| Crop seeds | Seeds are items, so they are set aside too. | They return to where they were. |
| Mod crops already planted | If a village field has a mod crop the game does not recognize, those rows are not drawn and cannot be harvested, but they are kept in the save as they were. | The crop shows up again and keeps growing with game time. |
| Quests | Mod quests the game does not recognize are hidden for now. | They show up again. |
| Building blueprints | Building positions are worked out from the active mods and the world seed each time. Without the mod the building is gone: it does not appear in places you have not visited, and in places you have seen it turns back into ordinary terrain when that area loads again, along with its creatures and chest. Blocks you placed or dug yourself are saved separately and are not affected. | The building appears again in the same place. |
The same goes for taking a character with mod items into a base-game world: those items are set aside, and come back in a modded world. So feel free to experiment, you can always turn a mod off. The only thing that does not come back is a mod folder you deleted yourself without a backup.
Achievements and the demo#
- Achievements: a world created with mods that change numbers or content is a modded world, and Steam achievements do not unlock in it. When you create a world the game warns you: “Some mods change balance, so this will be a modded world: Steam achievements will not unlock.”
- The demo has no mods: mods are a feature of the full game and only work in the desktop (Steam) version. The web version cannot use them either: “Mods are only available in the desktop (Steam) version.”
To publish your own mod, go on to Publishing and updates. If something goes wrong, see the FAQ.