PBO Packer
A PBO is the archive format DayZ loads: the game does not read loose folders, it reads one
.pbo file per addon folder of a mod. This page packs an addon folder into a PBO (what
Bohemia's AddonBuilder does) and opens any existing PBO to list, preview and extract its files.
Use it to pack a single addon by hand or to study how a vanilla or third-party addon is made.
You need an addon folder (a folder with a config.cpp) to pack; nothing to browse.
Packing is the first step of the build-and-ship path: pack here, sign on Keys & Signing, test in the Launcher, publish from Steam Workshop. For a mod with several addon folders, Build mod on the Steam Workshop page does the first two steps for the whole mod at once.
The screen
- Tabs: Pack (shown first) and Browse & extract.
- Pack, left card "Source":
- Addon folder: the folder to pack. The rest of the form is remembered per folder.
- Output .pbo: a file or a folder. Empty: inside a project (a
ci/build.yamlor atarget/@Namefolder next to the source) the PBO goes totarget/@Name/addons/<folder>.pbo; elsewhere it is written next to the source folder. The placeholder shows the path. - Prefix: empty uses the folder's
$PBOPREFIX$file, shown as placeholder. When there is neither, a warning appears with Write $PBOPREFIX$ from the folder name. - Binarize config.cpp → config.bin (on by default) and Sign after packing (then a Private key field appears, filled with your default key).
- Pack and the log of the result (files packed, output path, SHA-1).
- Pack, right card "Exclude patterns": one wildcard pattern per line (
*,?); matching files are not packed. - Browse & extract, left pane: Open PBO, a filter, Extract all; then the header badges (prefix, file count, size, checksum, other header fields) and the file table (name, size, stored or LZSS-compressed). With nothing open: an explanation, Open PBO, Open an example and your recent PBOs.
- Browse & extract, right pane "Preview": the selected file as text (scripts, configs,
config.binconverted back to text), as an image (.paa,.edds,.png,.tga) or as a hex dump of its first 4096 bytes.
First steps
- Open PBO Packer; the Pack tab is shown.
- In Addon folder, pick the folder that holds your
config.cpp. - Look at Prefix. If the badge "No $PBOPREFIX$ and no prefix" shows, press
Write $PBOPREFIX$ from the folder name (or type a prefix such as
MyMod\scripts). - Leave Binarize config.cpp ticked. Tick Sign after packing if you already have a key.
- Press Pack. The log says where the PBO was written.
- Switch to Browse & extract, open the PBO you just made and check its prefix and files.
Take the tour (in the app) · Tour: look inside a PBO (in the app)
Common tasks
Pack one addon folder
- Pack tab, choose the Addon folder.
- Check the prefix, keep Binarize ticked.
- Pack. A green line in the log gives the output path.
Pack and sign in one go
- Tick Sign after packing.
- Choose your
.biprivatekey(the default key of Keys & Signing is prefilled). - Pack. The log adds "Signed → …bisign". If only the signature fails, the PBO is still written and the log says so.
Look inside a vanilla PBO
- Browse & extract tab, Open PBO, pick a file of
<DayZ>/Addons(or use the example). - Type in the filter (
config,.p3d,.paa…). - Click a row to preview it.
config.binis shown as readable config text.
Extract a PBO to read or reuse its files
- Open the PBO, press Extract all.
- Choose a destination folder: the files go to
<destination>/<pbo name>/. - The PBO itself is not changed. Do not redistribute other authors' files.
Leave files out of a PBO
- Pack tab, right card.
- Add one pattern per line, for example
*.psdordocs/*. - The patterns are remembered with the folder.
Examples
- A vanilla PBO: gear_drinks (in the app):
Addons/gear_drinks.pboof your DayZ folder, opened read-only. Look at the prefix badge (DZ\gear\drinks), the green checksum badge, theconfig.binrow (click it: the binary config is shown as text, with theCfgVehiclesclasses of the drinks) andCanteen.p3dwith its textures underdata\. It needs DayZ installed and its folder set in Settings.
Concepts
- PBO ("packed bank of files"): one archive with a small header (key/value pairs such as
prefix), a list of entries (name, size, timestamp, compressed or not), the file data and a SHA-1 checksum at the end. Reference: https://community.bistudio.com/wiki/PBO_File_Format. - Prefix and
$PBOPREFIX$: the prefix is the virtual path the game gives the content of the PBO. A filescripts\4_World\x.cin a PBO with prefixMyModisMyMod\scripts\4_World\x.cfor the game, and that is the path you write inconfig.cppand in scripts. The convention is a text file named$PBOPREFIX$at the root of the addon folder holding the prefix; it is read at pack time and not packed itself. - Binarised config: the game reads configs in a binary form ("rapified",
config.bin). Packing with Binarize converts eachconfig.cpptoconfig.bininside the PBO; your source file is untouched. Only configs are converted here: models and textures are packed as they are. - What gets excluded: by default the same list as DayZ Tools'
exclude.lstplus version control clutter:*.h,*.hpp.bak,*.psd,*.tga,*.png,*.pac,*.bak,*.blend,*.blend1,*.fbx,*.max,*.xcf,thumbs.db,.git/*,.gitignore,.gitattributes,.vscode/*,.idea/*,$pboprefix$,$prefix$,$pboprefix$.txt,*.dep,*.tmp. A pattern starting with/is anchored to the root of the folder. - Protected PBOs: some authors encrypt (EBO) or obfuscate their PBOs. The Workbench lists them but never opens, extracts or indexes their files.
- Signature: a
.bisignfile next to the PBO proves who packed it. See Keys & Signing.
Pitfalls
- No prefix: without
$PBOPREFIX$and without a typed prefix, the game cannot resolve the packed files. The page warns before you pack and can write the file for you. - Excluding what you need:
*.pngand*.tgaare excluded by default (source images are normally converted to.paa). If your mod really ships a.png, remove that line. - Wrong output place: with the output left empty inside a project, the PBO lands in
target/@Name/addons/, where Build mod and the Launcher expect it. A typed output is remembered for that folder. - Editing a PBO after signing: any change to the
.pboinvalidates its.bisign. Pack, then sign, never the other way round. - Game files are read-only: browse and extract them, never repack a vanilla PBO. Change the game with your own addon instead.
- "checksum mismatch": the file was truncated or modified after packing; pack it again.
For agents
- Tools of
dztthat do the same work without the window: pbo_pack: pack an addon folder (prefix from$PBOPREFIX$unless given,config.cppbinarized by default, optional signature with a.biprivatekey).pbo_list: header, files with sizes, checksum validity,protection(argumentspbo,filter).pbo_read_file: one file of a PBO as text (config.binderapified).pbo_extract: every file of a PBO into a folder (optionally only some extensions).vfs_search/vfs_read: find and read game files by virtual path without naming the PBO.mod_build: the whole mod (every addon folder) fromci/build.yaml.- Files read: the addon folder, its
$PBOPREFIX$, aci/build.yamlortarget/@*next to it (to choose the default output), the opened.pbo. Files written: the output.pbo, its.bisignwhen signing,$PBOPREFIX$only from its button, extracted files only into the folder the user picked. The pack form per source folder is kept in the settings. - Page state given to the assistant:
tab(pack or browse & extract). Pack: source folder, output, prefix (typed or detected), binarize yes/no, sign yes/no, and the warning / error lines of the log as problems. Browse: the open file, its prefix,protectedreason, the filter and the selected entry. The signing key path is never included. - Anchors:
pbo-tabs,pbo-tab-pack,pbo-tab-browse,pbo-pack-source,pbo-pack-prefix,pbo-pack-options,pbo-pack-excludes,pbo-pack-button,pbo-open,pbo-files,pbo-preview,pbo-extract(only with a PBO open).
See also
- Keys & Signing: sign the PBO you packed.
- Steam Workshop: build the whole mod and publish it.
- Launcher: test the packed mod with a local server.
- Config: read the merged game config that the
config.binfiles make. - Beans Workbench overview.