Getting started
Beans Workbench gathers the tools of a DayZ modder in one window. You write scripts and menus, look at models and textures, pack and sign a mod, publish it to the Steam Workshop, tune a server's economy and traders, and test the result with a local server. It reads the game from your DayZ folder and never modifies it.
Take the tour of the Workbench (in the app)
The window
- Rail (left): one button per tool, grouped the way a mod is made. Ctrl+B shows the names.
- Page (middle): the tool you chose. Its header says what it does and holds its main actions.
- Help (F1, or the
?of a page): what the page is for, a guided tour of its controls, examples to open, its documentation and, for most tools, a tutorial video (Watch the tutorial). - Beans Assistant (the spark in the rail, Ctrl+J): it sees the page you are on, does the work with you, and can point at the controls while it explains.
- Status bar (bottom): whether the game is found, the active mod, what the Workbench is doing.
The tools
| Group | Page | What you do there |
|---|---|---|
| Write | Script Editor | Enforce Script with errors as you type, the game's code one click away |
| Layout Editor | Menus and HUDs, drawn as the game draws them, written in DZML or .layout |
|
| Style Studio | Buttons, panels and icons of your own: styles and imagesets | |
| Assets | Models | Look at .p3d models, check their LODs, write model.cfg |
| Particles | Read and edit particle effects (preview) | |
| Animations | Read animation graphs and clips (preview) | |
| Textures | View and convert .paa textures, edit materials |
|
| Config | Browse the game's classes, convert config.cpp and config.bin |
|
| Build and ship | PBO Packer | Pack a folder into a PBO, look inside one |
| Keys & Signing | Create your key, sign your PBOs, check signatures | |
| Steam Workshop | Build the whole mod and publish it | |
| World | Central Economy | What spawns on a server, how much, for how long |
| Traders | Prices, stock and categories of trader mods | |
| Map Editor | Place objects on a terrain in 3D (preview) | |
| Run | Launcher | A local server and the game with your mod, logs and health |
| Connect my agent | Give Claude or another agent the Workbench's tools |
Your first mod, start to finish
- Find the game. The dot in the status bar is green when your DayZ folder is read. If it is not, open Settings and click Detect.
- Create a mod. On Home, New mod: a name, a folder, a kind (script, server,
item, UI). You get a working skeleton:
config.cpp, the script modules, a build file. - Write. Open the Script Editor. Your mod is in the explorer, the game's
scripts are beside it. To change the game, write a
modded classthat overrides a method and callssuper; never copy a whole vanilla file. - Build and sign. Keys & Signing creates your key once. The build packs each addon folder into a PBO and signs it.
- Test. The Launcher starts a local server and the game with your mod (it needs DayZ Server, free on Steam for owners of the game) and shows the script errors.
- Publish. Steam Workshop checks the mod, then uploads it.
Words you will meet
- Mod folder: your sources. Addon: one folder of it with a
config.cpp, packed into one PBO (the archive format of the game). @Mod: the built mod, withaddons/andkeys/. - config.cpp: declares the addon (
CfgPatches), its classes (items, weapons, vehicles) and its script modules (CfgMods). - Enforce Script: the game's scripting language, in modules
3_Game,4_World,5_Mission; a module sees only itself and the lower ones. - Key: a
.biprivatekeyyou keep secret signs your PBOs (.bisign); servers accept them with the matching public.bikey. - Mission: a server's world folder (
mpmissions/...), with the Central Economy files. - P: drive: the work drive DayZ Tools expects; optional here.
Getting help
- F1 on any page.
- Ask Beans Assistant: "show me how to sign my mod". It walks you through the page.
- External agents (Claude Desktop, Claude Code): see Connect my agent.
- How DZML works for menus.
- Recipes: guided tasks Beans Assistant carries out step by step. Help > Recipes opens the catalogue; the help panel (F1) of a page lists the recipes for that page.
- Found a bug or have an idea? Feedback in the status bar (or Help → Report a bug or an idea) sends it to the Beans team: say what happened, add captures of the window or images, and an optional contact if you want an answer. The context sent with it (version, system, page, recent log) is shown before you send and can be left out. Discord works too.
For agents
docs_page {page}returns the documentation of a page and the elements of its screen that can be pointed at.studio_guideshows a page, starts a tour, or points at elements with your own explanation.- Game files are read-only references; player data is never opened; secrets from Settings never leave them.
- Read before you write (
vfs_search,vfs_read,script_class,game_config_class), and verify after (script_check,config_check,layout_render,ce_validate).