Metaplay Docs

Appearance

metaplay init dashboard [flags]

Initialize a custom LiveOps Dashboard for the project

metaplay init dashboard [flags] ​

Setup the development environment for a custom LiveOps Dashboard in your project.

This command does the following:

  1. Populate a fresh LiveOps Dashboard Node.js project into Backend/Dashboard
  2. Initialize the following in your project:
  • pnpm-workspace.yaml (pnpm workspace configuration file)
  • Backend/dashboard.code-workspace (Visual Studio Code workspace)
  1. Update metaplay-project.yaml to refer to your custom dashboard.
  2. Generate the pnpm-lock.yaml file using 'pnpm install'.

Related commands:

  • 'metaplay build dashboard' to build the dashboard locally.
  • 'metaplay dev dashboard' to serve the dashboard locally.

Examples ​

sh
# Initialize the custom LiveOps Dashboard in the project.
metaplay init dashboard

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]