Highlights

Changes

Metaplay SDK

Complete List

LiveOps Dashboard

Complete List

Samples

Complete List

Documentation

Complete List

Notable CLI Changes

Known Issues

We are aware of the following issues in this release:

Migration Guide for All Customers

Please apply the following changes to your project to ensure compatibility with the latest Metaplay SDK.

Backward-Incompatible Changes

Bump your game's MetaplayCoreOptions.supportedLogicVersions to force a synchronized update of your game client and server.

Upgrade Helm Chart to Latest Version

The Metaplay SDK now requires Helm chart v#.#.# or later for cloud deployments.

Migration Steps:

1. Update your metaplay-project.yaml to the latest Helm chart version.

   metaplay-project.yaml

   serverChartVersion: 0.x.y
   serverChartVersion: #.#.# #

2. Roll out the change to each environment by running the CI job to build and deploy a new version.

   You can do this for each environment separately, whenever is a good time for you.

Migration Guide for Self-Service Customers

Premium SDK Update Support

If your support contract includes Metaplay-provided SDK updates, all the following steps have already been applied to your project. You can skip this migration guide!

This guide offers step-by-step instructions for migrating your project to the latest version of the Metaplay SDK. You can skip the migrations steps for features you are not using in your project.

Before You Begin

It's a good idea to run the Metaplay integration test suite on your project before and after upgrading to the latest SDK version.

MyProject$ metaplay test integration

You should get a clean test run before starting the upgrade process to know that your project is in a good state, and know that any test failures after the upgrade are related to the upgrade itself.

For All Metaplay Projects

The following core SDK changes affect all Metaplay projects:

Apply Database Schema Migrations

Metaplay's built-in database schema has changed, and you need to apply the migration steps to your project.

Migration Steps:

1. Generate the database schema migration code with:

   # Install or update the EFCore tool:
   Backend/Server$ dotnet tool install -g dotnet-ef
   # Then, generate the migration code:
   Backend/Server$ dotnet ef migrations add MetaplayReleaseXX

2. Then, add the generated files to your project's source control. For example, using Git:

   Backend/Server$ git add .
   Backend/Server$ git commit -m "Database schema migrations"

The migration steps will be automatically applied when you deploy the updated game server into an environment.

For Games With Customized LiveOps Dashboard

The following LiveOps Dashboard changes affect projects that have a game-specific dashboard project:

Update the LiveOps Dashboard Project Files

As usual, we have updated the underlying dependencies and configurations of the LiveOps Dashboard. This causes changes to several configuration files, which you will need to update in your dashboard project. We use the MetaplaySDK/Frontend/DefaultDashboard folder as the source of truth for these files.

Migration Steps:

1. TBD

Clear and Recreate the Dashboard Dependencies

To ensure that your dashboard project has the correct dependencies, you will need to clear the existing cached files and recreate them.

Migration Steps:

1. First, make sure you're on the latest version of the Metaplay CLI by running metaplay update cli or installing the CLI using instructions at Metaplay CLI.
2. Next, remove any files that Node has cached in your project. This will lead to a fresh install of all dependencies.
   • Run metaplay dev clean-dashboard-artifacts from within your project folder. This clears any currently installed dependencies and built files.
   • Delete the pnpm-lock.yaml file from the root of your project. This clears the cached dependency versions.
3. Run metaplay dev dashboard from within your project folder. This recreates all of the above files and folders with the correct dependencies, and runs the dashboard in development mode.

Final Validation

You should run the Metaplay integration test suite on your project after the SDK upgrade to make sure everything is still working as expected:

MyProject$ metaplay test integration