PBO Tools

https://pbo.tools/docs/
Admin
PBO Tools is a free and user-friendly obfuscation suite for DayZ and ARMA, simplifying the PBO...
Tokens:14,679
Snippets:198
Trust Score:4.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### Recommended starting configuration

Source: https://pbo.tools/docs/configuration/settings-file-reference

A partial example of the settings file with version 2.9. Do not delete other properties written by PBO Tools.

```json
{
  "version": "2.9",
  "language": "",
  "configuration": {
    "game": "dayz",
    "outputLocation": "P:\\Output\\",
    "signingKeyLocation": "C:\\Users\\YourName\\Documents\\SigningKeys\\my_mod.biprivatekey"
  },
  "updates": {
    "channel": "stable"
  },
  "notifications": {
    "errors": true,
    "warnings": true,
    "success": true
  },
  "pboSettings": {
    "binarize": true,
    "compression": true
  },
  "automation": {
    "enableAllObfuscation": false,
    "showGuidanceWarning": true,
    "autoExitOnSuccess": false,
    "autoSignPBO": false,
    "parallelBatchPacking": false,
    "maxBatchParallelism": 2,
    "recursiveBatchDiscovery": true
  },
  "obfuscation": {
    "preset": "medium"
  },
  "codeObfuscation": {
    "autoMode": "manual",
    "autoPreset": "medium",
    "autoReport": false,
    "autoPreserveSymbols": [],
    "autoPublicApiPolicy": "conservative",
    "autoMappingMode": "disabled"
  }
}
```

--------------------------------

### Configure obfuscation.preset to medium

Source: https://pbo.tools/docs/configuration/pbo-protection-settings

JSON configuration example showing how to set the PBO protection preset to 'medium' in the settings file. The preset is stored under the 'obfuscation.preset' key.

```json
{
  "obfuscation": {
    "preset": "medium"
  }
}
```

--------------------------------

### Automation defaults JSON configuration

Source: https://pbo.tools/docs/configuration/automation-defaults

Example configuration for automation settings in Settings.json. Set enableAllObfuscation to true to enable PBO protection and obfuscation; autoExitOnSuccess closes only after a clean successful operation. Defaults: maxBatchParallelism is 2 and recursiveBatchDiscovery is true.

```json
{
  "automation": {
    "enableAllObfuscation": false,
    "showGuidanceWarning": true,
    "autoExitOnSuccess": false,
    "autoSignPBO": false,
    "parallelBatchPacking": false,
    "maxBatchParallelism": 2,
    "recursiveBatchDiscovery": true
  }
}
```

--------------------------------

### Basic Build with PBO Tools CLI

Source: https://pbo.tools/docs/cli-and-automation/cli-quick-start

Builds a PBO from a single root folder or a parent folder whose nested roots are packed as one batch. Requires PBO Tools Pro.

```powershell
& 'C:\Tools\PBO Tools.exe' --cli 'R:\Mods\MyMod'

```

--------------------------------

### Build and Sign PBO

Source: https://pbo.tools/docs/cli-and-automation/cli-quick-start

Builds and signs the PBO output. Configure configuration.signingKeyLocation first.

```powershell
& 'C:\Tools\PBO Tools.exe' --cli --sign-pbo 'R:\Mods\MyMod'

```

--------------------------------

### CLI syntax

Source: https://pbo.tools/docs/cli-and-automation/cli-reference

Shows the general command-line syntax for PBO Tools. Use exactly one mod-folder argument and quote paths that contain spaces.

```plaintext
PBO Tools.exe --cli [options] <mod-folder>

```

--------------------------------

### Sign PBO from the CLI with --sign-pbo

Source: https://pbo.tools/docs/core-workflows/signing-pbos

Run a CLI build with the --sign-pbo option to sign the PBO. The CLI does not sign unless this option is present.

```powershell
& '.\PBO Tools.exe' --cli --sign-pbo 'R:\Mods\MyMod'
```

--------------------------------

### Pack project with -c

Source: https://pbo.tools/docs/cli-and-automation/cli-reference

Packs a parent project containing several PBO roots using the -c (--cli) flag.

```powershell
& '.\PBO Tools.exe' -c 'P:\MyProject'

```

--------------------------------

### Configure beta release channel

Source: https://pbo.tools/docs/configuration/updates-and-release-channels

Use this JSON configuration to set the update channel to 'beta' for testing prerelease behavior. Beta may include changes that need wider project testing before becoming stable.

```json
{
  "updates": {
    "channel": "beta"
  }
}
```

--------------------------------

### Build with PBO Protection

Source: https://pbo.tools/docs/cli-and-automation/cli-quick-start

Builds a PBO with PBO protection enabled via the --obfuscate-pbo flag.

```powershell
& 'C:\Tools\PBO Tools.exe' --cli --obfuscate-pbo 'R:\Mods\MyMod'

```

--------------------------------

### Configure signingKeyLocation in Settings.json

Source: https://pbo.tools/docs/core-workflows/signing-pbos

Set the signing key file path in Settings.json. The application must be closed when editing this file. The path points to a .biprivatekey file.

```json
{
  "configuration": {
    "signingKeyLocation": "C:\\Users\\YourName\\Documents\\SigningKeys\\my_mod.biprivatekey"
  }
}
```

--------------------------------

### PBO Tools.exe --cli [options] <mod-folder>

Source: https://pbo.tools/docs/cli-and-automation/cli-reference

Runs PBO Tools in command-line mode to build and optionally protect PBO files from a specified mod folder. This is the primary CLI command for scripting and automation.

```APIDOC
## PBO Tools.exe --cli [options] <mod-folder>

### Description
Runs PBO Tools in command-line mode to build and optionally protect PBO files from a specified mod folder. This is the primary CLI command for scripting and automation.

### Method
CLI

### Endpoint
PBO Tools.exe --cli [options] <mod-folder>

### Parameters
#### Path Parameters
- **mod-folder** (string) - Required - The folder containing the mod project. May contain several nested PBO roots. Quote paths that contain spaces.

#### Options
- **-c, --cli** (flag) - Optional - Runs without interactive build prompts. Recommended for scripts.
- **-o, --obfuscate-pbo** (flag) - Optional - Enables PBO protection using the configured preset.
- **-d, --obfuscate-code** (flag) - Optional - Enables code protection using the configured Code mode and Automatic strength.
- **-r, --remove-comments** (flag) - Optional - Removes comments and implies code processing.
- **-s, --sign-pbo** (flag) - Optional - Signs completed PBOs with the configured private key.
- **-h, --help** (flag) - Optional - Displays command help. `-?` is also accepted.

### Request Example
```
& '.\PBO Tools.exe' -c 'P:\MyProject'
```

### Response
#### Exit Codes
- **0** - The requested build completed successfully.
- **1** - Processing, access, service, licensing, or publication failed.
- **2** - The command line or source-folder argument was invalid.

#### Response Example
```
if ($LASTEXITCODE -ne 0) { throw "PBO Tools failed with exit code $LASTEXITCODE" }
```

```

--------------------------------

### Release build with -c -o -d -r -s and exit-code check

Source: https://pbo.tools/docs/cli-and-automation/cli-reference

Runs a release build with all configured processing and signing, then checks the exit code and throws on failure.

```powershell
& '.\PBO Tools.exe' -c -o -d -r -s 'P:\MyProject'
if ($LASTEXITCODE -ne 0) { throw "PBO Tools failed with exit code $LASTEXITCODE" }

```

--------------------------------

### Set configuration.game in Settings.json

Source: https://pbo.tools/docs/configuration/game-selection

Set the target game by editing the configuration.game key in Settings.json. Use "dayz" for DayZ or "arma" for Arma 3. Required before unattended CLI runs because the CLI cannot ask which game to use.

```json
{
  "configuration": {
    "game": "dayz"
  }
}

```

--------------------------------

### Exclude files from compression with exclusions.fromCompression

Source: https://pbo.tools/docs/configuration/exclusions

Use `exclusions.fromCompression` for formats that are already compressed or should remain uncompressed. These files can still be included in the PBO; they are simply stored without the normal compression step.

```json
{
  "exclusions": {
    "fromCompression": [
      ".p3d",
      ".wss",
      ".ogg",
      ".jpg",
      ".wav",
      ".paa",
      ".bin"
    ]
  }
}
```

--------------------------------

### Settings file location

Source: https://pbo.tools/docs/configuration/settings-file-reference

The path to the PBO Tools settings file. Close PBO Tools before editing and use double backslashes in Windows paths.

```text
%USERPROFILE%\Documents\SIX Software\PBO Tools\Settings.json
```

--------------------------------

### Configure stable release channel

Source: https://pbo.tools/docs/configuration/updates-and-release-channels

Use this JSON configuration to set the update channel to 'stable', which is the default and recommended for production mod work.

```json
{
  "updates": {
    "channel": "stable"
  }
}
```

--------------------------------

### Exclude files from PBO with exclusions.fromPBO

Source: https://pbo.tools/docs/configuration/exclusions

Add names, extensions, or patterns to `exclusions.fromPBO` to keep development files out of the PBO. Default exclusions cover common source-control data, editable source assets, logs, backups, existing PBO output, signing keys, and documentation files. Review custom exclusions carefully; excluding a runtime script, config, model, texture, or sound can make the mod incomplete.

```json
{
  "exclusions": {
    "fromPBO": [
      ".git",
      ".psd",
      ".bak",
      "readme",
      "source"
    ]
  }
}
```

--------------------------------

### Build with Code Obfuscation and Comment Removal

Source: https://pbo.tools/docs/cli-and-automation/cli-quick-start

Builds a PBO with code obfuscation and comment removal. Code mode and automatic strength come from Settings.json; Automatic or Hybrid mode requires the matching ACO entitlement. Configure and test these in the interactive menu first.

```powershell
& 'C:\Tools\PBO Tools.exe' --cli --obfuscate-pbo --obfuscate-code --remove-comments 'R:\Mods\MyMod'

```

--------------------------------

### Protect PBO and code with -o -d

Source: https://pbo.tools/docs/cli-and-automation/cli-reference

Protects PBO contents and processes code by combining -o (--obfuscate-pbo) and -d (--obfuscate-code) with -c.

```powershell
& '.\PBO Tools.exe' -c -o -d 'P:\MyProject'

```
Tokens:
Raw