Metaplay Docs

Appearance

Updating the Metaplay SDK

Learn how to update the Metaplay SDK in your project.

Dependencies ​

  • A project with the Metaplay SDK integrated - If you don't have a project yet, you can follow our Adding the SDK to a Unity Project guide. You should also have a working knowledge of your project's code base and any potential customizations you may have done to the Metaplay SDK in your project.
  • Automated tests - While not strictly required, being able to run our automated integration tests will greatly help you in verifying that the update was successful. If you don't have automated tests set up yet, you can follow our Introduction to Automated Testing guide.

Overview ​

Updating the SDK might look intimidating but it's usually a straightforward process. Please keep in mind that you should not "skip" versions, as each SDK update will have migration steps that need to be followed. If you're more than one version behind, you should follow the migration guide for each version in order.

The latest version of the SDK can always be found on the Portal and in the Release Notes. If you're not sure which version you're running, the version number can be found in DeploymentOptions.CurrentMetaplayVersion or in the LiveOps Dashboard under Runtime Options -> Deployment.

Before applying the update, you should review the release notes for the new version of the SDK for any breaking changes and migration steps. This will give you an idea of what to expect in case you have customized our core SDK code.

Performing the Update ​

1. Establish a Clean Working State ​

Before applying the update, you should have a clean working state. This means that you should have no uncommitted or other work-in-progress changes that could get mixed up with the file changes from the update.

If possible, you should create a new branch in your version control system to apply the update. This will make it easier in later steps to compare changes, run tests, and potentially revert the update if necessary. Working in a branch also allows other team members to continue working on the project without being affected by the update.

2. Download the Latest SDK ​

The latest version of the SDK can always be found on our Portal.

3. Apply the Update ​

At its simplest, applying the update is a matter of replacing the old SDK files with the new ones and updating your project configuration. However, here are the exact steps we prefer to use:

  1. Close your IDE and running processes - Before applying the update, make sure that your IDE is closed, the local game server or dashboard is not running, and Unity is closed. This will prevent any potential issues with file locks or other conflicts.
  2. Remove the old SDK - Remove the old MetaplaySDK folder from your project. This needs to be done as old files may otherwise linger and cause errors down the line.
  3. Extract the new SDK - Extract the MetaplaySDK folder from the release zip into your project, replacing the old SDK files.
  4. Perform game server migrations - Open your IDE and check for any new errors. Run through any migration steps that affect your game server.
  5. Perform Unity migrations - Open Unity and check for any new errors. Run through any migration steps that affect your Unity project.
  6. Test locally - Try to connect Unity to your local game server and see if everything runs smoothly. If you encounter any issues, refer to the release notes for troubleshooting steps.
  7. Perform LiveOps Dashboard migrations - If you're using a custom LiveOps Dashboard, make sure to check for any migration steps to the project configuration or components. Test the dashboard against your local game server.
  8. Update Helm charts - Update the metaplay-gameserver helm chart to the recommended version for the new release as per the release migration guide and deploy the changes to your environments.

4. Test the Update ​

After applying the update, commit your changes, trigger your CI pipelines, run our integration test suite, and do manual smoke testing to ensure that everything is working as expected.

5. Final Review ​

Before merging the update into your main branch, make sure to review the changes and verify that there are no unexpected or accidental changes to files outside of the update. This is also a good time to double-check that you have not missed any customizations you may have done to our core SDK code.

Support ​

If you run into any issues during the SDK update, feel free to join our Discord and ask for help!

If you have a support contract with Metaplay, as always, if you need any assistance, feel free to contact us through your official support channels.

Further Reading ​