Commands

All included command-line tools offer built-in help, accessible by passing either the -h or --help option, e.g.:

unpbo -h

Note

More tools will be added in the future.

unpbo

The unpbo command enables the viewing or extracting of the contents of a PBO file. Pass -l or --list to list the contents of the PBO:

unpbo --list C:\path\to\filename.pbo

To extract all of the files contained in the PBO into the current directory:

unpbo C:\path\to\filename.pbo

To extract one or more individual files from the PBO, list their full names (as displayed in the -l/--list output), space separated, on the command line after the PBO filename:

unpbo C:\path\to\filename.pbo Prefix\scripts\3_Game\foo.c Prefix\config.cpp

run-server

The run-server command provides a convenient method for running DayZ Server locally (i.e. for testing mods). It supports loading collections of mods and configuring server parameters through the use of “bundles”, which are specified on the command line. Bundles can be defined either in the server.toml config file or as functions in a Python module.

Bundles defined in the config file generally look like:

[bundle.mybundle]
mods = '@CF;@MasPuertas;P:\MyModPack'
mission_directory = 'mpmissions\dayzoffline.enoch'

To load a bundle, specify it on the command line as a positional argument. For example:

run-server mybundle

Bundles defined in Python require more typing but offer more flexibility than config file bundles.

See also

Bundles as Configuration

Python Bundles

Configuration File

The run-server command can be configured using a config file, named server.toml by default. Most settings are in the server table of the file. For example:

[server]
executable = "server.exe"
config = "config.cfg"
profile_directory = "profile"
mission_directory = 'mpmissions\dayzoffline.enoch'
bundles = 'path\to\module.py'

[workshop]
directory = 'E:\DayZ\Workshop'

Note

All settings are optional and have reasonable defaults.

Server Executable

By default, run-server will try to run DayZ Server by running .\DayZServer_x64.exe. To override the executable path, set the executable key:

[server]
executable = "server.exe"

Server Configuration

By default, run-server will tell DayZ Server to load its configuration from serverDZ.cfg. To override the config file path, set the config key:

[server]
config = "config.cfg"

Profile Directory

By default, run-server will let DayZ Server choose a profile directory automatically (usually, %LOCALAPPDATA\DayZ). The profile directory is where DayZ Server writes logs and other information. To override the profile directory, set the profile_directory key:

[server]
profile_directory = "profile"

DayZ Mission Directory

By default, run-server will let DayZ Server choose the mission directory based on the server configuration file (e.g. serverDZ.cfg). To override the mission directory, set the mission_directory key:

[server]
mission_directory = 'mpmissions\dayzoffline.enoch'

Bundles Python Module

By default, run-server will look for bundles in a Python file named bundles.py. To override the Python bundles module filename, set the bundles key:

[server]
bundles = 'path\to\module.py'

Bundles can also be loaded from the run-server config file, as described below.

DayZ Workshop Directory

By default, run-server will load mods prefixed with @ from the C:\Program Files (x86)\Steam\steamapps\common\DayZ\!Workshop directory. If DayZ client is installed in a different location, override the default by setting the directory key in the workshop table:

[workshop]
directory = 'E:\DayZ\Workshop'

Bundles as Configuration

In the config file, each bundle is defined as a table. For example, to define a bundle named example:

[bundle.example]
executable = 'path\to\server.exe'
config = 'path\to\config.cfg'
profile_directory = 'path\to\profile'
mission_directory = 'path\to\mission'
workshop_directory = 'path\to\workshop'

These settings work the same as the ones of the same names described in Configuration File. In addition, bundles can define DayZ mods and server mods to add to the command line:

[bundle.example]
mods = '@Mod1;@Mod2;C:\path\to\mod'
server_mods = '@ServerMod;@ServerMod2;C:\path\to\servermod'

Mods and server mods can also be configured as lists of strings:

[bundle.example]
mods = [ '@Mod1', '@Mod2', 'C:\path\to\mod' ]
server_mods = [ '@ServerMod', '@ServerMod2', 'C:\path\to\servermod' ]

Mod names and server mod names that start with @ will be loaded from the DayZ workshop directory (see DayZ Workshop Directory).

Python Bundles

More advanced bundles can be created using Python code in the Bundles Python Module. Each function defined in the module can be referenced as a bundle. Bundle functions must take a single dayz_dev_tools.launch_settings.LaunchSettings argument. For example, to define a bundle named example:

def example(settings):
    settings.set_mission_directory(r"path\to\mission")
    settings.add_mod("@Mod1")
    settings.add_mod(r"C:\path\to\mod")