Launcher
The Launcher starts DayZ with your mods to test them: a server on this computer and the game joining it, the game alone on an offline mission, or each one apart. Before anything starts it shows the plan (program, config, mission, port, mods, log folder); afterwards it shows the output and the logs. You need DayZ installed; a local server also needs DayZ Server, a separate tool of your Steam library (Steam app 223350), with its folder set in Settings.
It is the "test locally" step of the build-and-ship path: pack (PBO Packer), sign (Keys & Signing), test here, publish (Steam Workshop). Test with a local server in the Workshop page's Build mod panel brings the built mod here and starts the local test.
The screen
- Header: three chips, DayZ, DayZDiag, Server: green when found, red when not (hover for the folder), a count of running instances, and Kill all DayZ (stops every DayZ client and server on this computer).
- Launch tab:
- the four modes: Local test, Offline · DayZDiag, Server only, Game only;
- What will start: one numbered row per process with its server config and mission, or
the address it connects to, the port, the program, the log folder (Follow logs).
Problems are in red, warnings in orange. Advanced opens, per profile: runner, DayZDiag
switch, log folder, launch flags (
-filePatching,-doLogs…) and the full command line; - the side card Mods: the selection and which side loads each mod, a saved set to apply, Attach script debugger (offline DayZDiag), Check styles before launch, the start button, and a Stop button per process started here;
- Output: lines of the started processes and of the followed log folder.
- Mods tab: add from the Workshop (link or id → Steam's page opens; the mod is added once downloaded) or Add a folder; the table of every mod on this computer (name, source, Game and Server checkboxes, signature state); Mod sets (saved selections); a VPP Admin Tools card when that mod is installed.
- Running tab: every DayZ instance on this computer, whoever started it, with its log files (RPT, script, crash, ADM) followed live, a filter, errors only, and Stop.
- Diagnostics tab: the checks a launch needs, Check again, Test DayZDiag, and "The launch contract": the plan as the assistant receives it.
- Play tab: the live view of the local test client while Beans Assistant plays it, what the crosshair targets, the recent game events, and Stop.
First steps
- Look at the header chips. If Server is red, install DayZ Server from Steam (Library → Tools) and set its folder in Settings.
- Open the Mods tab and tick Game and Server for your mod. A build of your project
(
target/@MyMod) is listed with the Workshop mods. - Open the Launch tab and select Local test.
- Read What will start: server (config, mission, port), the wait, then the game connecting to it. Fix any red line.
- Press Start the local test. The server starts, the page waits for it to accept players (the line "Player connect enabled" in its log, 90 s at most), then starts the game.
- Read Output; for more, open the Running tab and select the server or the client.
Take the tour (in the app) (it starts nothing) · Tour: when something does not start (in the app)
Common tasks
Test a mod with a local server and client
- Build the mod (Steam Workshop → Build mod) and press its Test with a local server, or tick the built mod in the Mods tab.
- Mode Local test, Start the local test.
- When done, stop each process with its Stop button.
Quick script loop without a server
- Mode Offline · DayZDiag: the game alone on an offline mission, with the diagnostic build.
- Tick Attach script debugger to use breakpoints from the Script Editor.
- Start DayZDiag offline. No DayZ Server needed. A mission written for a server does not create a player here: use the local test for that.
Choose which side loads a mod
- Mods tab: Game = the client loads it, Server = the server loads it.
- Both ticked: a normal mod. Server only: passed as
-serverMod(server-side scripts). - Save the selection under a name in Mod sets to switch between test setups.
Find why the game or the server did not start
- Diagnostics tab: read the checks, press Check again after a fix.
- Test DayZDiag starts the game without mods until its scripts load, then stops it: it tells whether the game itself works.
- Running tab: select the instance, open its crash or script log, tick Errors / warnings.
Join another server with your selection
- Mode Game only, type the address and the port.
- Start the game. Only mods that server allows will let you in.
Examples
This page has no example to open: it starts the real game. The offline mode with no mod selected is the safest first launch.
Concepts
- Client, server, DayZDiag:
DayZ_x64.exeis the game;DayZDiag_x64.exe, in the same folder, is its diagnostic build (script debugger, file patching, no BattlEye); DayZ Server is a separate Steam install with its own folder,serverDZ.cfgandmpmissions. - What needs DayZ Server: the modes Local test and Server only, the server rows of
the Diagnostics tab, and everything the assistant does in game (
game_smoke, the play tools), because they run on a local test. Offline · DayZDiag and Game only work with the game alone. - Mods and load order: the selected mods are passed as
-mod=(both sides) and-serverMod=(server only), in the order they were added to the selection: untick and tick again to move a mod to the end. The Launch tab's Mods card and the command line under Advanced show the order. Which addon overrides which is decided byrequiredAddonsin eachCfgPatches, not by this order alone. - Signatures: a server with
verifySignatures = 2kicks a client loading a PBO whose key is not in the server'skeys/. At launch the page copies the.bikeyfiles of the mods the server loads into that folder. An unsigned mod is flagged in the Mods tab and in Diagnostics. See Keys & Signing. - Instances: any running DayZ process, started here, by
dzt, by a script or by Steam. An instance that exits stays listed (the last 12) so its crash log can still be read. - Logs: each process writes into its
-profiles=folder: the.RPT(engine log),script_*.log(script errors),crash_*.log, and.ADM(server admin log). - Profiles and
launcher.json: the mode, the mod selection, the saved sets and the per-process settings are saved inlauncher.jsonof the Workbench's config folder. The assistant'slaunch_planreads the same file, so it starts exactly what the page shows. - Mission and server config: the server row lists the
*.cfgfiles of the server folder; the mission comes from thetemplateof the chosen config. - Server configuration reference (serverDZ.cfg, verifySignatures): https://community.bistudio.com/wiki/DayZ:Server_Configuration.
Pitfalls
- No DayZ Server: Local test and Server only cannot start; the plan says so in red. Use Offline · DayZDiag meanwhile.
- Client kicked on join: an unsigned mod, or
verifySignaturesnot2. Read Diagnostics. - Port already in use: another server is running; Diagnostics shows the port as busy. Stop it in the Running tab or change the port.
- Testing server logic offline: an offline mission is not a server; spawn, economy and server-only scripts need the local test.
- Kill all DayZ also stops instances you did not start here. Use the per-process Stop buttons for a single one.
- Style errors dialog before launch: Check styles before launch found widget styles the game would not load; fix them in the Layout Editor or launch anyway.
- Stale build: the Launcher runs the PBOs of
target/@MyMod; rebuild after changing sources (file patching aside). - On Linux the server folder is prepared before a start (mods mirrored in lowercase) and the game runs through Proton; on Windows neither applies.
For agents
- Tools of
dztthat do the same work without the window: launch_mods: the mods on this computer and the user's selection.launch_select: change the selection or the mode (shared with the page).launch_plan: what a mode will start, without starting it. Show it before any start.launch_start: start a mode (local_test,offline,server,client); starts nothing while the plan has a problem. Only when the user asked to run the game.launch_output,logs_tail: output of a started process, new log lines of a folder.launch_instances: every DayZ instance running.launch_stop: stop a pid started withlaunch_start;all: trueonly when the user asks for it.launch_list_mods:@modsof a folder.dayz_environment: detected install folders.game_smoke,play_*: run and play the local test (need DayZ Server).fix_scan: group the script errors of a log folder.- Files read:
launcher.json, the game, server and Workshop folders, the server's*.cfg, the mod folders (their info files and keys), the log folders. Files written:launcher.json; the-profiles=folders (created); in the server folder the.bikeyfiles inkeys/(and on Linux the lowercase mirrors of the mods); the VPP Admin Tools password and admin files when its card is used. Game files are never modified. - Page state given to the assistant: the selected mode (
mode local_test…), the selected mods with their side, the processes started here (name and pid), and the last error lines of the output as problems. Never a password, a player name or a connect address. - Anchors:
launcher-status,launcher-kill-all,launcher-tabs,launcher-tab-launch,launcher-tab-mods,launcher-tab-running,launcher-tab-health,launcher-tab-play; Launch tab:launcher-modes,launcher-plan,launcher-selection,launcher-go,launcher-output; Mods tab:launcher-mods-add,launcher-mods-list,launcher-mod-sets; Diagnostics:launcher-health-checks,launcher-contract; Running:launcher-running; Play:launcher-play. Point atlauncher-goandlauncher-kill-all, never click them for the user. Clicking a tab is harmless.
See also
- Steam Workshop: Build mod, then Test with a local server.
- Keys & Signing: sign the mod so the local server accepts it.
- PBO Packer: pack a single addon.
- Script Editor: the script debugger used with the offline mode.
- Settings: the DayZ, DayZ Server and DayZ Tools folders.
- Beans Workbench overview.