Metaplay Docs

Appearance

metaplay init project [flags]

Initialize Metaplay SDK in an existing Unity project

metaplay init project [flags] ​

Integrate Metaplay SDK into an existing project.

By default, this command downloads the latest Metaplay SDK from the portal. You must be logged in (using 'metaplay auth login') and have signed the SDK terms and conditions in the portal (https://portal.metaplay.dev).

This command does the following:

  1. Extract the Metaplay SDK contents into MetaplaySDK/.
  2. Initialize the following in your project:
  • metaplay-project.yaml ...
  • <unity-project>/Assets/MetaplayHelloWorld
  • <unity-project>/Assets/SharedCode
  • <unity-project>/Assets/StreamingAssets/...
  • Backend/
  1. Add reference to the Metaplay Client SDK to your Unity project package.json.

Related commands:

  • 'metaplay build image' builds a docker image to be deployed to the cloud.
  • 'metaplay update project-environments' updates the environments list in metaplay-project.yaml from the cloud.
  • 'metaplay init dashboard' initializes custom LiveOps Dashboard in the project.

Examples ​

sh
# Initialize SDK in your project using the interactive wizard.
metaplay init project
# Initialize SDK in your project using a specific project ID.
metaplay init project --project-id=fancy-gorgeous-bear
# Initialize SDK in your project at a specific path.
metaplay init project --project ../project-path
# Specify Metaplay SDK version to use (only 34.0 and above are supported).
metaplay init project --sdk-version=34.0
# Use a pre-downloaded Metaplay SDK archive.
metaplay init project --sdk-source=metaplay-sdk-release-34.0.zip

Flags ​

  • --auto-agree: Automatically agree to the privacy policy and terms and conditions
  • --no-sample: Skip installing the MetaplayHelloWorld sample scene
  • --project-id <string>: The ID for your project, eg, 'fancy-gorgeous-bear' (optional)
  • --sdk-source <string>: Install from the specified SDK archive file or use existing MetaplaySDK directory, eg, 'metaplay-sdk-release-34.0.zip' (optional)
  • --sdk-version <string>: Specify Metaplay SDK version to use, defaults to latest (optional)
  • --unity-project <string>: Path to the Unity project files within the project (default: auto-detect)
  • --yes: Automatically confirm the 'Does this look correct?' confirmation

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]