FOnline Engine
Current master GitHub
Documentation Docs/en/reference/packages/cli.md

Packager Command Line

Generated reference. Do not edit this page directly. Update BuildTools/PackageInterface.json or BuildTools/package.py, then run python BuildTools/docs_package.py --write.

Index Declaration Matrix Payloads CLI Canonical JSON

CMake normally invokes this internal CLI once for each BINARY clause. Direct callers must provide the same build hash, config, input, and output context.

usage: package.py [-h] -maincfg MAINCFG -buildhash BUILDHASH -devname DEVNAME -nicename NICENAME -target {Server,Client,Mapper,Baker,AnimationViewer,ParticleViewer} -platform {Windows,Linux,Android,macOS,iOS,Web} -arch ARCH
                  [-expect-client-runtime EXPECT_CLIENT_RUNTIME] -pack PACK -config CONFIG -input INPUT [-binary-output-postfix BINARY_OUTPUT_POSTFIX] -output OUTPUT [-resource-pack-compress-level {0,1,2,3,4,5,6,7,8,9}]
                  [-resource-pack-jobs RESOURCE_PACK_JOBS] [-resource-pack-hash-library RESOURCE_PACK_HASH_LIBRARY] [-bundle-compress-level {0,1,2,3,4,5,6,7,8,9}]

FOnline packager

options:
  -h, --help            show this help message and exit
  -maincfg MAINCFG      Main config path
  -buildhash BUILDHASH  build hash
  -devname DEVNAME      Dev game name
  -nicename NICENAME    Representable game name
  -target {Server,Client,Mapper,Baker,AnimationViewer,ParticleViewer}
                        package target type
  -platform {Windows,Linux,Android,macOS,iOS,Web}
                        platform type
  -arch ARCH            architectures to include (divided by +)
  -expect-client-runtime EXPECT_CLIENT_RUNTIME
                        Client variant whose runtime payload this server package must distribute, as Platform:arch[:postfix]. Repeatable
  -pack PACK            package type
  -config CONFIG        config name
  -input INPUT          input dir (from FO_OUTPUT_PATH)
  -binary-output-postfix BINARY_OUTPUT_POSTFIX
                        suffix appended to binary output dir names
  -output OUTPUT        output dir
  -resource-pack-compress-level {0,1,2,3,4,5,6,7,8,9}
                        override the resource pack compression level (zlib scale: 0 stores, 9 is the strongest)
  -resource-pack-jobs RESOURCE_PACK_JOBS
                        maximum concurrent resource archives (default: FO_RESOURCE_PACK_JOBS or 1)
  -resource-pack-hash-library RESOURCE_PACK_HASH_LIBRARY
                        explicit host FNV-1a library; otherwise discover it under input Binaries/BuildTools-*
  -bundle-compress-level {0,1,2,3,4,5,6,7,8,9}
                        override the bundle compression level (zlib scale: 0 stores, 9 is the strongest)
Stable ID Argument Required Action Choices Default Description
package.cli.argument.maincfg -maincfg yes store - - Main config path
package.cli.argument.buildhash -buildhash yes store - - build hash
package.cli.argument.devname -devname yes store - - Dev game name
package.cli.argument.nicename -nicename yes store - - Representable game name
package.cli.argument.target -target yes store Server, Client, Mapper, Baker, AnimationViewer, ParticleViewer - package target type
package.cli.argument.platform -platform yes store Windows, Linux, Android, macOS, iOS, Web - platform type
package.cli.argument.arch -arch yes store - - architectures to include (divided by +)
package.cli.argument.expect_client_runtime -expect-client-runtime no append - - Client variant whose runtime payload this server package must distribute, as Platform:arch[:postfix]. Repeatable
package.cli.argument.pack -pack yes store - - package type
package.cli.argument.config -config yes store - - config name
package.cli.argument.input -input yes append - - input dir (from FO_OUTPUT_PATH)
package.cli.argument.binary_output_postfix -binary-output-postfix no store - - suffix appended to binary output dir names
package.cli.argument.output -output yes store - - output dir
package.cli.argument.resource_pack_compress_level -resource-pack-compress-level no store 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 - override the resource pack compression level (zlib scale: 0 stores, 9 is the strongest)
package.cli.argument.resource_pack_jobs -resource-pack-jobs no store - 1 maximum concurrent resource archives (default: FO_RESOURCE_PACK_JOBS or 1)
package.cli.argument.resource_pack_hash_library -resource-pack-hash-library no store - - explicit host FNV-1a library; otherwise discover it under input Binaries/BuildTools-*
package.cli.argument.bundle_compress_level -bundle-compress-level no store 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 - override the bundle compression level (zlib scale: 0 stores, 9 is the strongest)
Start typing to search.