Documentation
/
Docs/en/reference/packages/payloads.md
Package Payloads and Artifacts
Generated reference. Do not edit this page directly. Update BuildTools/PackageInterface.json or BuildTools/package.py, then run python BuildTools/docs_package.py --write.
The packager stages one target payload, applies binary/resource transformations, emits artifact packs in a fixed finalization order, and removes the staged directory unless Raw retains it.
| Stable ID |
Platform |
Status |
Payload |
package.payload.Windows |
Windows |
implemented |
Patched PE executable or DLL, companion runtime files, PDBs when present, and resource ZIP directories unless NoRes is selected. Managed builds carry target-specific managed assemblies and the prepared runtime inside the selected resource pack. win32-win7 and win64-win7 read the canonical win32/win64 binary entry selected by the same per-binary POSTFIX. |
package.payload.Linux |
Linux |
implemented |
Patched executable or shared runtime, companion files, and resource ZIP directories unless NoRes is selected. Managed builds carry target-specific managed assemblies and the prepared runtime inside the selected resource pack. |
package.payload.Android |
Android |
implemented |
Generated Gradle project containing libmain.so per ABI and baked resources under app assets; managed assemblies and the prepared runtime remain in the resource-pack assets. Apk optionally emits a sibling APK. |
package.payload.Web |
Web |
implemented |
JavaScript, patched Wasm, HTML shell, Resources.data/Resources.js preload files, target-specific managed assemblies and runtime resources when enabled, and an optional local server helper. |
package.payload.macOS |
macOS |
unsupported |
No payload is emitted in the current repository state. |
package.payload.iOS |
iOS |
unsupported |
No payload is emitted in the current repository state. |
Output-producing packs
| Stable ID |
Pack |
Status |
Output |
Effect |
package.pack.Raw |
Raw |
implemented |
<target-output> |
Retain the staged target directory after finalization. |
package.pack.Zip |
Zip |
implemented |
<target-output>.zip |
Create a deterministic ZIP beside the staged target directory. |
package.pack.SingleZip |
SingleZip |
implemented |
<output>/<output-name>.zip |
Append the staged target directory to one package-wide ZIP; identical same-name members are stored once, while conflicting contents fail packaging. |
package.pack.Tar |
Tar |
implemented |
<target-output>.tar |
Create an uncompressed tar archive. |
package.pack.TarGz |
TarGz |
implemented |
<target-output>.tar.gz |
Create a gzip-compressed tar archive. |
package.pack.Root |
Root |
implemented |
<output> |
Merge the staged target directory into the package output root. |
package.pack.Wix |
Wix |
implemented |
<output>/<nice-name>[_<postfix>].msi |
Build a required MSI from the staged Windows client payload; POSTFIX is appended to the installer base name. |
package.pack.Apk |
Apk |
implemented |
<output>/<target-output-name>.apk |
Run Gradle and copy the selected signed/debug APK beside the staged project. |
A package invocation must select at least one implemented output-producing pack. Modifier-only lists and unknown, duplicate, placeholder, unsupported-platform, or target-incompatible tokens fail before output staging.
