File naming and location
VDF files live inside your ContentBuilderscripts/ directory. Onyx expects exactly this naming convention:
Your ContentBuilder directory should look like this:
ContentBuilder
builder
content
output
scripts
app_1234560.vdf
depot_1234561.vdf
depot_1234562.vdf
App VDF structure
The app VDF tells SteamCMD which depots to include, where to write build output, and metadata about the build. Onyx generates this file from a template during setup.app_1234560.vdf
Field reference
The
desc field is the only app VDF value Onyx modifies after initial setup. Whatever you type in the build description field in the UI is written to desc immediately before SteamCMD runs.Depot VDF structure
Each depot VDF describes what files to include for one depot, and where those files live on disk.depot_1234561.vdf
Field reference
Changing FileExclusion
The default exclusion rule (*.pdb) drops Windows debug symbols, which are large and unnecessary for players. You may want to adjust this if:
- You ship a Linux build where
.pdbfiles don’t exist (the rule is harmless but you can remove it for clarity). - You want to exclude additional file types, such as editor metadata or source assets.
- You intentionally ship debug symbols for a developer branch.
FileExclusion lines:
Fields Onyx reads vs. fields you manage manually
Managed by Onyx
appid— read to identify the builddesc— written before every uploaddepotsblock — parsed to list and count depotsDepotID— read per depotcontentroot(depot) — displayed in the depot list
Edit manually in the VDF
buildoutput— must point to your actual SDK output foldersetlive— set the branch name when you want auto-promotionpreview— set to"1"for dry-run testingcontentroot(app) — set if depots use relative pathsFileMappingrules — customize inclusions per depotFileExclusionrules — add or remove file filters