Mods are a feature of the full game, not the demo. They open when the full game launches, and details may change before then.

Publishing and updates

Press Publish in the mod editor to upload your mod to the Steam Workshop: how to test it first, what the publish window asks for, why the first upload is always private, how to update it, and how players find it.

Publishing uploads your mod folder to the Steam Workshop. After that, anyone can subscribe and the game downloads it for them. You do all of it inside the game, and the smoothest way is the Publish button in the top bar of the mod editor. Mods are a feature of the full game. The demo does not have them.

Before you publish: test it#

In the editor, the bottom bar checks your mod as you work and says either “No problems, ready to test” or “N problem(s) (click to see)”. Click a problem and it jumps to the entry that has it. Fix them all before you go on.

Press Test in the top bar. The editor saves, the game reloads with only this mod (and the mods it needs), and you land straight in a flat, daytime test field. To try just one item or creature, press Try this one on that entry: the item is put in your bag, or the creature appears right in front of you. Back to editor at the top of the test field takes you back to the same entry. More in the Test section of the mod editor page.

The Make Mods tab of the Workshop screen also has Test and Publish to Workshop buttons next to each mod, so you can use them without opening the editor. In that case you create a new world to play with it.

Press Publish#

Press Publish in the editor's top bar. The editor saves first. If there are still problems in the check, the button cannot be pressed until you fix them. Then the publish window opens. At the top it says whether this is a “First publish” (it starts as private) or “Already published, this is an update”. It has these parts:

  • Version: shows what it is “now”, with three buttons: Big change (gameplay changed), New stuff (you added things) and Small fix (typos and number tweaks). Each one fills in the next version number for you. You can also edit the three boxes yourself. If the number is not newer than the last one, the window warns you, because players would not see it as an update.
  • Cover image (optional): press Choose an image. PNG or JPG both work, and the game shrinks it for you. Once there is a cover the button reads Choose another image, and Keep the old one undoes your pick. If you skip it, a default picture is made for you.
  • Below that is the usual publish form, with these fields.
FieldWhat to enter
Title1 to 128 characters. Filled in with your mod name.
SummaryUp to 1000 characters, optional. Say what the mod does and how to play it. Filled in with the description from mod.json.
Theme (optional)Pick any: Fantasy, Eastern Fantasy, Dark, Cute, Sci-Fi.
LanguageSet from your current game language (Traditional Chinese or English). If your mod does not depend on a language, choose “Mark as language-neutral”.
VisibilityPrivate, Friends Only, Public or Unlisted. See the next section.

At the bottom the window says “By submitting, you agree to the Steam Workshop terms.” and has a View Terms on Steam button. When everything is filled in, press the Publish button that submits it. You will see “Uploading”, then “Published”.

Visibility: start private#

ChoiceWho can see it
PrivateOnly you.
Friends OnlyYour Steam friends.
PublicEveryone. It shows up in Workshop lists and searches.
UnlistedAnyone with the link. It does not show up in lists or searches.

After publishing you can also change the description, preview image and visibility on the item's Steam Workshop page.

Accepting the Steam Workshop agreement#

Steam asks every account to accept the Workshop agreement before its first Workshop item goes live. If you have not accepted it yet, the finish screen says “One More Step on Steam” and asks you to complete it in Steam. Press Open on Steam to jump to the item's page. The item is not really live until you accept.

The agreement is Steam's, and you accept it on Steam. The game never accepts it for you. To read it first, press View Terms on Steam in the form.

Preview image#

When you publish from the editor, just press Choose an image in the publish window. Your picture is shrunk, turned into a PNG, saved as preview.png at the top of your mod folder, and uploaded with the mod. If you choose nothing, the default picture is used.

If you manage the file yourself (for example by dropping an image in from an outside editor), the cover image of a Workshop item is the file called preview.png at the top of your mod folder. It has to meet these rules:

  • It must be a real PNG file, named exactly preview.png, at the top level of the mod folder.
  • It must be 5 MB or smaller.
  • Its longest side must be 2048 pixels or less (whichever of width and height is larger).

If there is no preview.png, or it does not meet the rules, the game makes a placeholder for you: a dark background with a shaded block whose colour comes from the mod id, so two placeholder mods do not look the same. If the preview is rejected during upload, you see “The preview image cannot be used. Replace preview.png with another PNG and try again.”

You can also swap the image later on the item's Steam Workshop page without uploading again.

Tags are added for you#

You do not pick categories. The game adds tags from the content tables in your mod, so players can filter by category in the Workshop.

TagAdded when the mod has
ModAlways, on every mod.
Itemsitems, recipes, buffs or loot.
Fooddishes, fish or crops.
Rulesrules or patches.
Creaturesspecies or spawns.
Questsquests, dialogue or directorEvents.
Buildingsblueprints.
ScriptA script (content.script).

The language and theme tags you chose in the form are added on top (only one language is allowed).

Updating the same item#

An update does not create a second item. It changes the same Workshop item, and subscribers get the new version automatically.

  1. 1
    Change it in the editor

    Edit as usual, and press Test first to check it.

  2. 2
    Press Publish

    The game knows this mod was published before. The window says “Already published, this is an update”, the form title becomes “Update mod” and the submit button becomes “Publish Update”.

  3. 3
    Raise the version with the buttons

    Press Big change, New stuff or Small fix to bump the number. Multiplayer rooms compare versions, so raise it on every update.

  4. 4
    Write a change note

    The change note is required. The button stays disabled without one, and the game says “Updates need a short change note.” One sentence about what changed is enough.

You can also update without the editor: on the Make Mods tab of the Workshop screen, press Publish to Workshop next to the mod. The steps are the same, except you raise version in mod.json yourself (for example from 1.0.0 to 1.0.1).

You can change the visibility again when you update. It does not have to stay private. Only the Steam account that published the item can update it. Another account sees “This Workshop item was published by another account, so you cannot update it.”

How players find your mod#

Once it is public there are two places to find it.

  • In the game: Workshop on the title screen, then the Explore tab. Sort by Popular, Newest or Most subscribed. Filter with the category buttons (Mods, Items, Food, Rules, Creatures, Quests, Scripts, Buildings), or type a name in the search box and press Search. Press Subscribe on a card.
  • On Steam: browse the game's Workshop page, or open the link you share. Each card in the Explore tab also has an Open in Steam button.

After subscribing, the mod appears in the My Mods tab of the Workshop screen. Select it, press Enable, then Apply and reload. It is active the next time the game loads.

If publishing fails#

What the game saysWhat to do
The mod has problems. Fix them using the check results in Make Mods, then publish.Go back to the editor (or the Make Mods page) and fix what the check lists.
Cannot reach Steam. Make sure Steam is signed in and try again.Start Steam and sign in.
The previous upload is still running. Please wait.Wait for the earlier upload to finish.
The preview image cannot be used. Replace preview.png with another PNG and try again.Check its size and dimensions, or remove preview.png to use the placeholder.
Publishing mods is not available in this version yet.This build of the game has publishing turned off.

Before you publish, read Limits and rules: the file count and size limits, and the Workshop content rules.