The mod editor
The in-game mod editor: the left column lists what your mod has, the middle is a form, the right is a preview, the bottom checks as you go, one button jumps into a test field, and you publish from the same screen.
The mod editor is the main place to make a mod. It lays your whole mod out as a list, with one form per thing: names, numbers, colours, drop-down lists, no code. Every field you change is checked right away, and one button takes you into a test field to see the result.
How to open it#
- 1Make a new one
On the title screen: Workshop, then Make Mods, then New mod. Pick a template, give it a name, and press Create. The editor opens right away. (The exception is New rules pack: that one stays on the Make Mods page so you can tune it with sliders first. You can still open it in the editor afterwards.)
- 2Edit one you already made
On the Make Mods page, pick a mod under My creations on the left and press Edit.
- 3Leave
Press Back at the top left, or press Esc. If you have unsaved changes it asks: Save and leave, Leave without saving or Cancel. Closing the editor window asks the same question.
Open the editor without starting the game#
If you want to make mods without playing the game first, you can open just the editor. It opens in its own window, with no intro, no title screen and no world. Only the editor is on screen.
- 1Pick Mod Editor in Steam
In your Steam library, find Fangjie Shattered Altars and press Play. Steam asks which one to start: the game, or the Mod Editor. Choose Mod Editor and only the editor opens.
- 2Open it from inside the game
If you are already in the game, the title screen has a Mod Editor entry. It opens the editor in its own window, and the game window stays where it was. Under Workshop, on the Make Mods page, New mod and Edit open it the same way.
- 3Go back to the game
The editor window has an Open game button at the top. Press it to start the game.
What the screen looks like#
| Where | What is there |
|---|---|
| Top bar | Back, the mod name, the save status (Saved, Unsaved changes, Saving, Save failed), Undo, Redo, Save, Open folder, Test, Publish |
| Left column | What is in your mod, grouped by kind. Every entry is listed under its kind, and an entry with a problem has a red dot next to it |
| Middle | The form for the selected entry |
| Right column | A preview. Only items, creatures, dishes, loot, dialogue, quests and blueprints have one |
| Bottom bar | The live check. Open it to see each problem |
The left column: what is in your mod#
At the top of the left column there is always Mod info (name, description, version, who needs to install it). Below it come the groups, showing only the kinds your mod already has:
| Group | Kinds inside | Notes |
|---|---|---|
| Mod | Mod info, Translations, Script | The mod's name card, see Mod info; every text a player can see, side by side, see Translations; the Script page only shows when the mod has a script, see Scripting |
| Gear & items | Items, Recipes | See Items and Recipes |
| Food & gathering | Dishes, Fish, Crops, Buffs | See Dishes, Fish, Crops and Buffs |
| Creatures | Creatures, Spawns | See Creatures and Spawns |
| Story | Dialogue, Quests | See Dialogue and Quests |
| World | World events, Blueprints | See World events and Blueprints |
| Rules | Rules, Loot, Base game tweaks | See Rules packs, Loot and Base game tweaks |
To add a kind of content your mod does not have yet, press Add new content at the bottom of the left column and pick one. That creates the first entry. Where the file goes and how it gets registered is handled by the editor, so you never have to think about it.
Every kind has an Add button that creates a blank entry. Items, creatures, dishes, fish, crops and buffs also have Copy from game, covered next.
Copy from game#
When you do not know where to start, the quickest way is to start from something the game already has. Copy from game opens a searchable list of the base game's items, creatures, dishes, fish, crops or buffs, each with an icon. Pick one and its data becomes a new entry in your mod:
- The name gets "(copy)" added, and the code is changed to one that will not clash. You can rename it.
- An item takes the base game's stats, colours and shape with it.
- A creature is built on top of that base game creature, with every multiplier at 1. That means it starts out identical to the original, and you adjust from there.
- The base game's own thing is never changed. To change a base game value directly, use Base game tweaks, see Base game tweaks.
For something already in your mod, press Duplicate above that entry to make a copy, or Delete and then Click again to delete to remove it.
The middle: forms#
- Every field has one plain line under it, for example "Positive is faster, negative is slower".
- Text fields like names and descriptions have Other languages under them. Open it to fill in English, Simp. Chinese and Trad. Chinese separately. A language you leave empty uses the main field's text.
- A field that asks for "which thing" (such as a recipe's ingredients or a loot item) is a searchable list. Base game things and From this mod things are both in it, each with an icon, so you never need to remember a code.
- Most numbers are sliders with the result shown beside them. A creature's stats are multipliers, and the real number is worked out beside it, like "120 → 168".
- Groups marked Advanced are folded away by default. New creators can ignore them.
- Dialogue, quests and blueprints have their own forms and previews. See Dialogue, Quests and Blueprints.
- World events do not have a form yet. Selecting one shows a text box where you edit that entry directly. If the text has a format mistake it shows Format error, not applied yet and does not save it. See World events for how to write it.
Drawing an item's shape#
In the item form, under Shape, press Draw shape or Edit shape to open the Shape editor. If you do not draw one, the item uses the game's built-in look for its type.
| Tool | What it does |
|---|---|
| Add | Click or drag to add blocks on a face |
| Erase | Click or drag to remove blocks |
| Paint, Pick, Fill | Recolour with the current colour, take a colour from a block, or recolour a whole connected patch of one colour |
| Box | Drag out a volume and fill it in one go |
| Extrude | Click a face and that patch grows outward one layer |
| Select | Select blocks, then Paint them, Mirror them to the other side or Delete them |
There are also Mirror (symmetry), Show grid lines and Clear all, and five views: Front, Left, Right, Back and Top. Grid lets you choose Coarse (10 cm cells, good for armor and big items) or Fine (5 cm cells, finer detail for held weapons). There is a limit on the number of blocks, and the screen shows how many you have used. Press Done when you are finished, or Cancel to throw the changes away.
Mod info#
| Section | What is in it |
|---|---|
| Basics | Mod name, Description (what players see in the mod list and on the Workshop), Author, Mod code (cannot be changed after you publish) and Version (three boxes: Big, Small, Fix) |
| Who needs this mod | Everyone in the room needs it, Only the host needs it, Only I see it. If the mod has any content, it is always everyone, and the screen says so |
| Mods needed first | When your mod relies on other mods to work, pick them from your installed mods |
| Options players can change | Toggles, sliders or pick-one lists that the host can adjust when opening a room |
For the full rules on options, dependencies and scope, see Folder and mod.json.
Translations#
The Translations page under Mod in the left column lays out every text in your mod that a player can see (names, descriptions, dialogue lines, quest objectives, button labels and so on) in one table, with Traditional Chinese, Simplified Chinese and English side by side. A cell with no text in that language is highlighted in yellow.
- The left of each row says where the text lives, for example "Dialogue · a line · Choice · No. 2 · Text", and you edit the three cells right there. They change the matching language of that entry, so you do not have to go back to each form.
- The top shows "N lines in total, M missing". Only missing keeps just the rows with a yellow cell, and the search box finds text or places.
- A language you leave empty falls back to the main text, so yellow is not an error, only a reminder that you can fill more in.
The bottom bar: the live check#
As soon as you stop typing, the editor checks the whole mod and shows the result at the bottom: No problems, ready to test or N problem(s) (click to see). Open it and every problem is clickable, jumping straight to the entry that is wrong. The form also lists that entry's problems at the top.
This is the same check the game runs when it loads a mod at startup. If the editor says there are no problems, the game will not trip over your formatting. While there are problems, Test, Try this one and Publish cannot be pressed, and hovering shows "Fix the problems listed below first".
Saving, undo, and outside editors#
- Ctrl+S saves, Ctrl+Z undoes, Ctrl+Shift+Z redoes. The top bar has the same buttons.
- Open folder opens this mod's own folder in your file browser.
- You can edit the mod's files in an outside text editor at the same time. After you save there, the editor reads the changes in by itself. If both sides changed the same file, a notice appears at the top saying it was changed outside, and you choose Use theirs or Keep mine. Nothing is overwritten silently.
- Fields the form does not show (advanced settings you wrote by hand in the file) are kept exactly as they are when the editor saves.
Test: one button into the test field#
| Button | What happens |
|---|---|
| Test in the top bar | Saves, reloads the game with only this mod and the mods it needs, and drops you straight into a flat, daytime test world called "Mod test field" |
| Try this one on an item | The same, and that item is put in your bag ("The item to test is in your bag") |
| Try this one on a creature | The same, and that creature appears right in front of you ("The creature to test is right in front of you") |
| Box one in the world on a blueprint | Saves, then takes you into a creative test world (not the flat test field). A bar at the top reads "Capture mode", and you box a building with the panel and save it as a blueprint. See Blueprints |
A bar at the top of the test field reads "Testing your mod, everything is set up", with Back to editor next to it. Press it and the game reloads and returns you to the entry you were just editing.
When you press Test in the editor window, the editor stays open where it is. The game opens in its own window and goes straight into the test field. If the game window is already open, it loads the test there instead.
- If the game window is in the middle of a world, pressing Test first asks whether to save and leave that world.
- If you are in a multiplayer room, the test is refused until you leave the room.
- Press End test in the game (or Back to editor on the test field bar) to return to the editor.
- If the game window was opened only for the test, it closes by itself when the test ends.
Publish#
Press Publish in the top bar. The editor saves first, then opens the publish window. At the top it tells you whether this is the First publish or Already published, this is an update.
- Version: shows the current version. Big change, New stuff and Small fix work out the next number for you, or you can type it yourself. If the new version is not newer than the last one it warns you, because players would not see an update.
- Cover image (optional): press Choose an image. PNG or JPG both work and it is shrunk automatically. If you skip it, a default picture is made for you.
- The other fields (title, summary, theme, language, visibility, change note) are the same as always. See Publishing and updating.
What the editor cannot do#
- Writing scripts: you cannot write code inside the editor. The Script page tells you which file it is and which events you can use, and keeps the log of your last test. The code itself is edited with Open folder, in
scripts/main.jsin an outside editor, and then you press Test. See Scripting. - World events: no form yet, so you can only edit their content in a text box.
- Quickly tuning a rules pack with sliders is a small tool on the Make Mods page. See In-game tools. Importing a MagicaVoxel .vox building is there too, and also on the blueprint form as Import a building file.