Steam Workshop

Tutorial · 3:13

This page builds a whole mod and publishes it on the Steam Workshop, where players and servers download DayZ mods. It works from one small file of your project, ci/build.yaml: it packs and signs every addon (Build mod), runs pre-flight checks, lets you write the change note, and uploads only after you confirm. You need a mod folder (sources or an already built @Mod), a signing key (Keys & Signing) and a Steam account that owns DayZ.

It is the last step of the build-and-ship path: pack (PBO Packer), sign (Keys & Signing), test locally (Launcher), publish. Build mod does the pack and sign steps for the whole mod, and its Test with a local server button hands the result to the Launcher.

The screen

First steps

  1. Press New config and pick your mod folder: a built @MyMod, an addon folder (with a config.cpp) or the folder that holds your addon folders. The rest of the form fills in.
  2. Leave workshop_item_id at 0 for a mod that is not on the Workshop yet. Keep the visibility Private for a first upload. Press Create and open: ci/build.yaml and ci/CHANGENOTE.md are written in your project.
  3. In Build mod, check the addons and the signing key, then press Build mod. The PBOs are written to target/@MyMod/addons, signed, with keys/, meta.cpp and mod.cpp.
  4. Press Test with a local server: the Launcher starts a server with the built mod, then the game.
  5. Back here, read Pre-flight checks. Fix every red line.
  6. Write the Change note, press Publish to Workshop, read the confirmation, confirm.

Take the tour (in the app) · Tour: prepare a release (in the app)

Common tasks

Create the build.yaml of a mod

  1. New config, pick the mod folder.
  2. Set the item id (0 for new, or paste the id / link of an existing item), title, visibility, optional preview image (png / jpg / gif under 1 MB), description and tags.
  3. Open Preview build.yaml to see the file, then Create and open.

Build the mod

  1. Open the config, press Build mod.
  2. Addons whose files did not change are kept; tick Rebuild everything to pack all again.
  3. The badges give built / unchanged / skipped / failed, and whether it is ready to publish.

Publish an update

  1. Build, test, then check that no pre-flight line is red.
  2. Write the change note.
  3. Upload through: the Steam client (Steam running, logged in with the account that owns the item; no password) or steamcmd (user name, password, Steam Guard code).
  4. Publish to Workshop → the dialog shows the item, its subscribers and the note → confirm. For a new item, its id is written back into build.yaml.

Protect a live item

  1. Open its config, tick Protected item.
  2. Every publish then needs one more tick ("This is a protected item… I really want to update it") before the button works. The switch is kept in your settings; protected: true in build.yaml protects it for dzt and assistants too.

Announce on Discord

  1. In Discord, create a webhook for the channel and copy its URL.
  2. Paste it in Webhook (it is saved in your local settings for this config).
  3. Choose who to ping, optionally a message, press Send test (no ping).
  4. Tick Announce: after a successful publish the title, link, preview and change note are posted.

Examples

This page has no example to open: it works on your own project and your Steam account. To see a complete project, create a mod from Home (New mod) and open the ci/build.yaml it contains.

Concepts

Pitfalls

For agents

See also