metaplay build dashboard [flags]

Build the Vue.js LiveOps Dashboard locally.

This command first checks that Node.js and pnpm are installed and satisfy version requirements. Then it installs dashboard dependencies (unless --skip-install is used) and builds the dashboard.

The build process includes TypeScript compilation and Vite bundling. By default, the output is placed in Backend/Dashboard/dist/. The locally running game server (with 'metaplay run server') will serve this output on http://localhost:5550.

If you want to include a pre-built version of the dashboard in your version control, so that it can be served locally without the Node/pnpm tooling installed, use the --output-prebuilt flag to place the build output in Backend/PrebuiltDashboard/. If you do this, you should commit the Backend/PrebuiltDashboard/ directory to version control.

If you run into issues during the build process, try running 'metaplay dev clean-dashboard-artifacts' to remove dashboard build artifacts.

Related commands:

• 'metaplay build server' builds the game server .NET project.
• 'metaplay build image' builds a Docker image with the server and dashboard.
• 'metaplay dev dashboard' runs the dashboard in development mode.
• 'metaplay dev clean-dashboard-artifacts' removes dashboard build artifacts.

Examples

# Build the dashboard.
metaplay build dashboard
# Output pre-built dashboard (see help text for explanations)
metaplay build dashboard --output-prebuilt
# Skip dependency installation (faster builds if deps already installed)
metaplay build dashboard --skip-install
# Pass extra arguments to vite build
metaplay build dashboard -- --mode production

Flags

• --output-prebuilt: Output pre-built version of the dashboard (see help text)
• --skip-install: Skip the pnpm install step
• --skip-pnpm: Skip the pnpm install step (deprecated, use --skip-install)

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]