Metaplay Docs

Appearance

metaplay build image [IMAGE] [flags] [-- EXTRA_ARGS]

Build a Docker image of the server components that can be deployed in the cloud

metaplay build image [IMAGE] [flags] [-- EXTRA_ARGS] ​

Build a Docker image of your project to be deployed in the cloud. The built image contains both the game server (C# project), the LiveOps Dashboard, and the BotClient.

Expected arguments:

  • IMAGE (optional) -- Docker image name (optional) and tag, eg, 'mygame:364cff09' or '364cff09'.
  • EXTRA_ARGS (optional) -- Passed as-is to docker build.

Related commands:

  • 'metaplay deploy server ...' to push and deploy the game server image into a cloud environment.
  • 'metaplay image push ...' to push the built image into a target environment's registry.

Examples ​

sh
# Only recommended when building images manually. In CI, you should always specify the tag explicitly.
metaplay build image
# Specify only the tag, produces image named '<projectID>:364cff09'.
metaplay build image 364cff09
# Build a project from another directory.
metaplay -p ../MyProject build image
# Build docker image with commit ID and build number specified.
metaplay build image mygame:364cff09 --commit-id=1a27c25753 --build-number=123
# Build using docker's BuildKit engine (in case buildx isn't available).
metaplay build image mygame:364cff09 --engine=buildkit
# Build an image to be run on an arm64 machine.
metaplay build image mygame:364cff09 --architecture=arm64
# Build a multi-arch image for both amd64 and arm64 (only supported with 'buildx').
metaplay build image mygame:364cff09 --architecture=amd64,arm64
# Pass extra arguments to the docker build.
metaplay build image mygame:364cff09 -- --build-arg FOO=BAR

Flags ​

  • --architecture <stringSlice>: Architectures of build targets (comma-separated), eg, 'amd64' or 'amd64,arm64' (default: [amd64])
  • --build-number <string>: Number identifying this build, eg, '715'
  • --commit-id <string>: Git commit SHA hash or similar, eg, '7d1ebc858b'
  • --engine <string>: Docker build engine to use ('buildx' or 'buildkit'), auto-detected if not specified

Inherited Flags ​

  • --color <string>: Should the output be colored (yes/no/auto)? [env: METAPLAYCLI_COLOR] (default: auto)
  • --project <string>: Path to the to project directory (where metaplay-project.yaml is located)
  • --skip-version-check: Skip the check for a new CLI version being available
  • --verbose: Enable verbose logging, useful for troubleshooting [env: METAPLAYCLI_VERBOSE]