Steam Workshop
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
- Header: the list of
build*.yamlfiles found in your project folders, Open (any config on disk), New config. - My Workshop items: the items the Steam account of this computer published (private ones
included), matched with your projects: visibility, subscribers, last update, local project,
and per row Open, Publish… (loads its
build.yaml), Create config, links to the item. It contacts Steam only when you press Refresh. - Introduction (while no config is open): what a publish checks and the two ways to start.
- With a config open:
- Item: mod name, Workshop item id (
0= a new item will be created), content folder, the item's public details, Protected item, and the options to also update the visibility or the tags. - Pre-flight checks: one line per check with an OK / Warning / Error badge, and fix
buttons where the page can fix it (write
meta.cpp, install steamcmd). - Build mod: sources, addons found, output folder, signing key, Build mod, Rebuild everything, the build log, then Test with a local server, Offline diag instead and Publish….
- Change note: the text of this version (Steam BBCode).
- Steam login: upload through the Steam client or steamcmd, timeout, the extra confirmation of a protected item, Publish to Workshop.
- Discord announcement: announce after a publish, webhook, who to ping, message, Send test.
- The generated upload description (VDF) and the upload log.
First steps
- Press New config and pick your mod folder: a built
@MyMod, an addon folder (with aconfig.cpp) or the folder that holds your addon folders. The rest of the form fills in. - Leave
workshop_item_idat0for a mod that is not on the Workshop yet. Keep the visibility Private for a first upload. Press Create and open:ci/build.yamlandci/CHANGENOTE.mdare written in your project. - In Build mod, check the addons and the signing key, then press Build mod. The PBOs
are written to
target/@MyMod/addons, signed, withkeys/,meta.cppandmod.cpp. - Press Test with a local server: the Launcher starts a server with the built mod, then the game.
- Back here, read Pre-flight checks. Fix every red line.
- 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
- New config, pick the mod folder.
- Set the item id (
0for new, or paste the id / link of an existing item), title, visibility, optional preview image (png / jpg / gif under 1 MB), description and tags. - Open Preview build.yaml to see the file, then Create and open.
Build the mod
- Open the config, press Build mod.
- Addons whose files did not change are kept; tick Rebuild everything to pack all again.
- The badges give built / unchanged / skipped / failed, and whether it is ready to publish.
Publish an update
- Build, test, then check that no pre-flight line is red.
- Write the change note.
- 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).
- 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
- Open its config, tick Protected item.
- 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: trueinbuild.yamlprotects it fordztand assistants too.
Announce on Discord
- In Discord, create a webhook for the channel and copy its URL.
- Paste it in Webhook (it is saved in your local settings for this config).
- Choose who to ping, optionally a message, press Send test (no ping).
- 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
build.yaml: the publishing config of a project, usuallyci/build.yaml. Main fields:mod_name(@MyMod),workshop_item_id(0= create),content_dir(defaulttarget/<mod_name>),title,description/description_file,preview_image,visibility(0 public, 1 friends, 2 private, 3 unlisted),tags,changenote/changenote_file,update_metadata,protected, adiscord:block, and build settings:src_dir,skip,exclude_packages,exclude_files,private_key/key_dir,sign,binarize,author,version,mod_cpp.- What a build does: each addon folder of
src_dir(defaultsrc/, else the folders of the project root holding aconfig.cpp) is packed to<content>/addons/<name>.pbowithconfig.cppbinarised; unchanged addons are skipped; every PBO is signed with the project key (private_key, else the only*.biprivatekeyofkey_dir, else your default key); signatures of other keys or of deleted PBOs are removed;keys/<authority>.bikey,meta.cpp(with the item id) andmod.cppare written; then the pre-flight checks run. A build never uploads. - The plan and its pre-flight checks: before any upload the page computes a plan: the
resolved change note, the exact upload description, and checks: PBOs present in
addons/, each.bisignvalid againstkeys/*.bikey,meta.cppwith the rightpublishedid, preview image under 1 MB, nothing that must not ship (a private key), protected item confirmed. An Error blocks the Publish button; a Warning does not. - Change note: the text Steam shows in the item's change history. It comes from
changenote_file(defaultci/CHANGENOTE.md; lines starting with#are comments) orchangenote. Edits on the page apply to this publish only. meta.cpp/mod.cpp: small files at the root of@Mod.meta.cppties the folder to its Workshop item (publishedid);mod.cppgives the name and author shown in launchers.- Protected items: an item with a live audience. Publishing to it needs an explicit extra
confirmation, in the page and in
dzt(confirm_protected). - Discord webhook: a secret URL that lets anyone post in your channel. It is kept in the
local settings only, never in
build.yaml; CI reads it from an environment variable (DISCORD_WEBHOOK_URLunlessdiscord.webhook_envnames another). It is never sent to an assistant. - The DayZ Workshop: https://steamcommunity.com/app/221100/workshop/.
Pitfalls
- Publishing an old build: edit sources, forget to build, publish. Build first. In My Workshop items, needs update marks an item whose local build is newer than what is published.
- Wrong item id: an update overwrites the item for every subscriber. The confirmation shows the item title and subscriber count: read it. Protect live items.
update_metadata: it re-sends title, description, visibility and preview and overwrites what you edited on the Steam page. Leave it off and use the two "also update" boxes.- Config inside the uploaded folder: the page refuses to save
build.yamlinside@Mod. - First upload public by accident: new items default to Private; make them public when tested.
- Steam shows you "playing DayZ" for a few seconds during Refresh and during an upload through the Steam client: expected.
- Passwords: the steamcmd password is used for the upload and never stored; a Steam Guard code is single use.
- A publish goes on when you leave the page: the new item's id is still written to the config and Discord is still announced. Come back to see its log.
For agents
- Tools of
dztthat do the same work without the window: mod_build: build the whole mod from itsbuild.yaml(never uploads).workshop_plan: dry run of a publish: change note, upload description, pre-flight checks. Never contacts Steam. Always run it and show it before publishing.workshop_publish: upload; needsconfirm: true, andconfirm_protected: truefor a protected item. Only on the user's explicit request.workshop_changenote: render a change note (Markdown → Steam BBCode).workshop_announce: post the Discord announcement without publishing (confirm: true).workshop_item_info: public details of an item;workshop_my_items: the account's items.workshop_install_steamcmd: download steamcmd (confirm: true).mod_new: create a project that already hasci/build.yaml.- Files read:
build.yaml, the change note and description files, the preview image, the content folder (target/@Mod), the cached item list (<config>/workshop/published.json). Files written: by New configci/build.yaml,ci/CHANGENOTE.md,ci/DESCRIPTION.md(when a description is typed) and the emptytarget/@Mod/addons; by a build the PBOs,.bisign,keys/*.bikey,meta.cpp,mod.cpp; after a first publish the new item id inbuild.yaml. Settings hold the protected items and the Discord webhooks. - Page state given to the assistant: the open config file, the mod name, the Workshop item (id or "new item"), and the plan's error as a problem. Never the Steam login, the password, the Guard code or the Discord webhook. Do not ask for them in chat.
- Anchors:
workshop-config-picker,workshop-open,workshop-new-config,workshop-my-items,workshop-intro; with a config open:workshop-item,workshop-preflight,workshop-build,workshop-build-button,workshop-changenote,workshop-upload,workshop-publish,workshop-discord. Point atworkshop-publish, never click it for the user.
See also
- PBO Packer: pack a single addon, look inside a PBO.
- Keys & Signing: create the key Build mod signs with.
- Launcher: test the built mod with a local server before publishing.
- Beans Workbench overview.