Build System¶
Core pipeline¶
The build pipeline is orchestrated by tools/build.py and powered by Ninja.
High-level flow:
- Clean/create working directories.
- Copy filtered source data from
src/toobj/src/. - Generate build rules into
build.ninja. - Convert/copy files into
obj/ark/andobj/raw/. - Pack output ark/hdr into
out/gen/. - Copy selected XEX binaries into
out/. - Optionally generate Xenia patch and run Xenia.
File conversion behavior¶
.png-> converted withsuperfreqto.png_xbox.dta-> validated withdtacheck, serialized and encrypted viadtabto.dtb- Other files -> copied as-is
Platform-specific tools are selected from:
tools/linux/tools/macos/tools/windows/
Build variants¶
By default, the build includes deluxe retail.
Flags add more variants:
--vanillaadds vanilla retail--debugadds debug builds for whichever families are enabled
CLI reference¶
./tools/build.py src bin [options]
Common options:
--output <dir>set output root--includes <dir>include additional files in output--cleanremove generated cache directories after successful build--allow-dtacheck-errorskeep building even ifdtacheckreports errors--patch-output <dir>copy Xenia patch to directory--xenia-root <path>Xenia root directory (patch will be copied to patches/ subdirectory)--xenia-path <path>path to Xenia executable--xenia-run 0..4auto-launch selected build in Xenia--xenia-args "..."pass extra args to Xenia
Wrapper scripts¶
scripts/build.sh: Linux/macOS wrapper for default buildscripts/build.bat: Windows wrapper for default build
Both wrappers call tools/build.py with src bin.
Installation¶
Prebuilt release ZIP¶
- Download the prebuilt ZIP from the GitHub release.
- Extract it into your game folder, the one that already contains
default.xexandgen/. - Launch
definitive.xex.
Optional: Back up default.xex and rename definitive.xex to default.xex if you want the base game hidden from the dashboard.
The ZIP also includes the Xenia patch under xenia/patches/373307D9 - Dance Central 3.patch.toml.
With Xenia emulator¶
- Download the prebuilt ZIP from the GitHub release.
- Copy
xenia/patches/373307D9 - Dance Central 3.patch.tomlfrom the ZIP into your Xenia installation'spatches/folder. - Launch
definitive.xex(ordefault.xexif renamed) through Xenia.