Dependencies

• Metaplay SDK core integration - This guide presumes that you already have an instance of the game server setup and running. Please read the Integrating the Metaplay SDK quick guide to learn how to run the game server locally.

Getting Started

Development Environment Setup

To develop and build the LiveOps Dashboard you first need to install Node.js and PNPM:

1. Download and install version 18 of Node.js. tip: we recommend using the Node Version Manager
2. Install PNPM by running npm install -g pnpm in your terminal of choice.
3. Optional: Download a web development IDE of your choice. tip: we prefer Visual Studio Code

Initial Setup

The dashboard code is split into two parts: the core SDK, and the game-specific part written by you. If you followed the Integrating the Metaplay SDK then you'll already have both of these parts created. You will have a folder structure that looks something like this:

YourProjectRoot
+--- Backend
|   +--- Dashboard
|   +--- Server
|   +--- ...
+--- MetaplaySDK
|   +--- Server
|   +--- ...
+--- pnpm-workspace.yaml

We just need to perform one last step to initialize the dashboard code:

1. Open your game's dashboard folder YourProjectRoot/Backend/Dashboard/ in your terminal of choice and run pnpm install to install all of the required dependencies.
2. Done!

Running the LiveOps Dashboard

The game server ships with a pre-built copy of the dashboard that it serves on port 5550. However, for development, you'll want to run a standalone version for faster iterations. This standalone version is served on port 5551. These development builds come with Node.js debugging (breakpoints inside your editor!) and file hot loading to name just a few benefits.

1. Run the game server, so the dashboard has something to connect to.
2. Run pnpm dev in the dashboard project folder (ie: YourProjectRoot/Backend/Dashboard/)
3. Open the resulting URL in your browser.
4. When done, stop the server with q.

Further Reading

Once you have the LiveOps Dashboard set up and running locally, you can start configuring and customizing the LiveOps Dashboard.

• Configure the dashboard - Now you can start making the dashboard your own by, for example, adding your own links to the quick links menu. Get started on the Configuring the LiveOps Dashboard page.
• Customize the dashboard - For customization beyond simple configuration, have a look at the Customizing the LiveOps Dashboard Frontend guide to get started!