Home
Home is where a session starts. It shows your mods, what you can do next with the active one, the files you opened lately and what changed in the last releases. When the Beans Assistant is available, its composer is in the middle: describe what you want to build.
The screen
- First steps (strip under the header): what a new install needs. Find DayZ, add or create a mod, create a signing key, connect an agent, get the Beans Launcher. A done step is checked; click one that is not to do it. The strip can be closed for good.
- Ask (middle, with the assistant): the composer, starter requests and your last conversations. Signed in, your usage bar shows above the composer: click it for your account (usage, purchases, plans and packs, sign out).
- Project roadmap (middle, with the assistant and an active mod): the mod's goal and milestones, done and to do, with Continue to start a session on the next one. Without a roadmap, Plan it sets one up over several days. See Build a mod over several days.
- Start from a recipe (middle, with the assistant): six guided recipes (import a weapon, test on a local server, set up a trader, publish…). A click starts one in a new conversation: it asks a few questions, proposes a plan, then works step by step with checks. See all opens the whole catalogue with a search box and a filter by category. A recipe that needs a higher plan than yours shows a lock with the plan's name; clicking it opens the shop.
- Tasks (middle): one tile per stage on the active mod. Write a script, Make a UI, Build & sign, Test, Publish. Each opens the right page, already on that mod.
- Server tiles (when a DayZ Server is set): analyse the server's logs for errors and health.
- Projects (side): the mods the Workbench knows. One is active; every page works on it. New mod creates one, Open a mod folder adds an existing one.
- Recent files (side): reopen a file in the page of its type.
- Learn (side): the tour of the Workbench and the documentation.
- What's new and the suite card (side): the last releases, the Beans Launcher.
First steps
- Check that the status bar says DayZ is found. If not, open Settings.
- Click New mod in Projects. Give it a name, choose its folder and its kind.
- The mod becomes the active project. Click Write a script: the Script Editor opens on it.
Take the tour of Home (in the app)
Common tasks
Switch to another mod
Click it in Projects, or use the project selector in the status bar. Pages reload their file lists.
Open a mod you already have
Open a mod folder, pick the folder that holds its addons (the one with config.cpp inside or
one level down). It is added to the workspaces in Settings.
Reopen what you were doing
Recent files lists the last files; the Workbench also reopens the last file at start.
Build the active mod
The Build & sign tile opens Steam Workshop on the mod's build file and runs the build; without a build file it opens the PBO Packer.
Examples
- Create a mod (in the app): the New mod dialog.
- A new menu in DZML (in the app): the Layout Editor on a new page.
- The game's own files (in the app): the vanilla
PlayerBasescript, read-only.
Concepts
- Active project: the one mod folder the pages work on. It is remembered between sessions.
- Kinds of mod in New mod: script (client and server code), server (server-only code), item (a config class with a model and textures), UI (a menu with its layout and script).
Pitfalls
- A grey task tile means there is no active mod: create or open one first.
- Opening the Steam
!Workshopfolder or the DayZ folder as a mod does nothing useful: a workspace is a folder of your own sources.
For agents
mod_new {name, author, parent, kind}creates a mod like the dialog does.file_list,file_glob,file_grepexplore the active mod;server_reportis the server analysis.- The page context gives the active project, the workspaces and the install folders.