Metaplay Docs

Appearance

metaplay init project-config [flags]

Initialize the metaplay-project.yaml in an existing project

metaplay init project-config [flags] ​

Initialize a metaplay-project.yaml configuration file in an existing project directory. This file is used by the CLI to understand the project structure and configuration.

The command will auto-detect various project paths and settings:

  • Unity project location
  • MetaplaySDK directory
  • Game backend directory
  • Game dashboard directory (if present)
  • Shared code directory
  • .NET runtime version

The detected paths can be overridden using command-line flags if needed. All paths are stored relative to the project root directory.

After detection, the command will:

  1. Validate the detected paths and settings
  2. Show a summary of what was found
  3. Ask for confirmation (unless --yes is specified)
  4. Create the metaplay-project.yaml file

Requires Metaplay SDK 32.0 or later to be updated in your project repository.

Related commands:

  • 'metaplay init project' to create a new project from scratch
  • 'metaplay update project-environments' to update environment configurations

Examples ​

sh
# Generate the in your project.
metaplay init project-config
# Specify the project ID.
metaplay init project-config --project-id=lovely-wombats-build
# Auto-approve the operation.
metaplay init project-config --yes

Flags ​

  • --backend-path <string>: Path to the game backend directory (default: auto-detect)
  • --dashboard-path <string>: Path to the game dashboard directory (default: auto-detect)
  • --dotnet-version <string>: .NET runtime version (default: auto-detect)
  • --project-id <string>: The ID for your project, eg, 'fancy-gorgeous-bear' (optional)
  • --sdk-path <string>: Path to the MetaplaySDK directory (default: auto-detect)
  • --shared-code-path <string>: Path to the shared code directory (default: auto-detect)
  • --unity-project <string>: Path to the Unity project files within the project (default: auto-detect)
  • --yes: Automatically confirm to 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]