--- sdk_version: "36.1.0" build_time: "2026-03-04T17:12:20.240Z" docker_image_tag: "9850d60616" git_commit: "9850d60616" --- # Metaplay Technical Documentation This is the LLM-optimized technical reference for the Metaplay SDK. ## Available Content ### /docs - Documentation All technical documentation for the Metaplay SDK as markdown files. Access `/docs/index.md` for a list of all documents. docs/ index.md: index cloud-deployments/ getting-started.md: Getting Started with Cloud Deployments - How to get started with cloud environments and deploy your first server. introduction.md: Introduction to Cloud Deployments - An overview of the Metaplay Cloud and deploying game servers to it. setup-ci-pipeline.md: Setup CI Pipeline - How to set up a CI/CD pipeline to deploy your game server into Metaplay Cloud. troubleshooting.md: Troubleshooting - This page describes how and where to look when your game server is down or not responding. advanced-topics/ configuring-a-deployment.md: Configuring a Deployment - This guide walks you through some common steps for configuring a Deployment by tweaking metaplay-gameserver Helm values. configuring-alertmanager-rules.md: Configuring Alertmanager Rules - This guide demonstrates how to create your own Alertmanager alerting/recording rules for an environment. configuring-grafana-dashboard.md: Configuring Grafana Dashboard - This guide walks you through common steps for customizing Grafana Dashboards. connecting-to-databases.md: Connecting to Databases - This guide explains how to connect directly to the game database. interacting-with-aws.md: Interacting with AWS - Interacting with a selection of AWS resources for advanced usage. how-to-guides/ database-operations.md: Database Operations - How to reset the database of a cloud environment and export and import database snapshots. install-upgrade-and-uninstall.md: Upgrade and Remove Deployments - How to upgrade cloud deployments to newer versions and remove them when no longer needed. observing-a-deployment.md: Observing a Deployment - This guide provides instructions for observing a deployment. persisting-secrets.md: Secrets Management - This guide walks you through creating your first Secret in a cloud environment and using it in your game server. rolling-out-updates.md: Rolling Out Updates - This guide explains how to minimize player downtime and keep things running smoothly during game updates. feature-cookbooks/ automated-testing/ advanced-playwright-testing.md: Advanced Playwright Dashboard Testing - Deep dive into running and debugging tests, fixtures, and testing patterns on the LiveOps Dashboard using the Playwright testing framework. advanced-system-testing.md: Advanced System Testing - This page explains how to write complex test cases to test the game server from the outside. botclient-testing.md: BotClient Testing - This page explains how to use the BotClient to use headless bots to load test your project with lots of concurrent users. dashboard-testing.md: LiveOps Dashboard Testing - This page describes how to make and run all types of LiveOps Dashboard tests. dotnet-unit-testing.md: .NET Unit Testing - This page describes how to use .NET unit and functional tests to test your game's logic and features. integration-testing.md: Integration Testing - This page describes how to run all the different test suites in a single run. introduction-to-automated-testing.md: Introduction to Automated Testing - This page gives an overview of how we've implemented automated tests in the Metaplay SDK and how you can use them in your project. custom-multiplayer-features/ introduction-to-multiplayer-entities.md: Introduction To Multiplayer Entities - This page demonstrates the implementation of a simple multiplayer game feature using the Multiplayer Entities system. developer-players/ working-with-developer-players.md: Working with Developer Players - This article explains how to mark players as developers, what privileges they have, and how to work with them in-game code. experiments-a-b-testing/ implementing-experiments.md: Implementing Experiments - Experiments are a tool to conduct controlled studies of how changes to your game configs might affect your players. integrating-experiment-analytics-into-a-data-processing-pipeline.md: Analytics Processing - This page describes how to integrate analytics events emitted from participants in player experiments into an analytics solution. This is necessary for analyzing the results of experiments. introduction-to-experiments.md: Introduction to Experiments - Experiments are a tool to conduct controlled studies of how changes to your game configs might affect your players. optimizing-experiments.md: Optimizing Experiments - Experiments are a tool to conduct controlled studies of how changes to your game configs might affect your players. game-analytics/ bigquery-analytics-event-format.md: BigQuery Analytics Event Format - This document describes the data format used in Analytics Events that are implementing-analytics-events-in-game-logic.md: Implementing Analytics Events in Game Logic - This page describes how to implement and configure a persistent per-entity log of game-defined events for game entities such as players and guilds. streaming-analytics-events-to-external-storage.md: Streaming Analytics Events to External Storage - This article describes how Analytics Events can be exported from the Game Servers to external storage such as S3 or BigQuery. game-configs/ deep-dive-custom-game-config-build-pipelines.md: Custom Game Config Build Pipelines - This page describes the process of building the Game Configs from source data to runtime-compatible binary data. deep-dive-game-config-archives.md: Game Config Archives - A game config archive is a file containing a collection of Game Config Libraries as binary serialized files. Archive files are used to group together a set of related configs as a single atomic unit. game-config-item-identifiers.md: Game Config Item Identifiers - Game Config Items must define an unique identifier so can be referred to. This article describes how to define such identifier. game-config-item-references.md: Game Config Item References - How to refer to Game Config Items in Models and in other Game Config Items. key-value-game-configs.md: Key-Value Game Config Data - Key-Value Game Configs are an alternative to Game Config Libraries for simple, elemental data. managing-game-configs-from-the-dashboard.md: Managing Game Configs from the Dashboard - This article will guide you through configuring your LiveOps Dashboard to manage your game configs. renaming-config-items.md: Renaming Config Items - How to remove an Game Config Item or change its identifier without compatibility issues. using-multiple-sources.md: Using Multiple Game Config Sources - This page will guide you on configuring your game config to be built from multiple data sources. working-with-game-config-data.md: Working with Game Config Data - Metaplay supports a data-driven way to specify the game's design, economy, and localization data using external tools like Google Sheets and Excel. working-with-game-configs.md: Working with Game Configs - Metaplay's game configs are a data-driven way to specify the game's design economy and localization data using external tools like Google Sheets and Excel. guilds/ implementing-guild-invites.md: Implementing Guild Invites - This page describes how Guild Invites work and how they can be used in a game. preview-guild-framework.md: Preview: Guild Framework - Metaplay guild framework contains various tools to accelerate implementing Guilds in a game-specific manner. This document lists these tools and describes how they are intended to be used. in-app-purchases/ advanced-usage-of-in-app-purchases.md: Advanced Usage of In-App Purchases - This page builds on top of our Getting Started guide to explain how to record resolved Purchases' contents, implement Dynamic-Content Purchases, and add the Context information to analytics events. configuring-steam-purchases.md: Configuring Steam Purchases - This page explains additional in-app purchase configuration and limitations for the Steam platform. getting-started-with-in-app-purchases.md: Getting Started with In-App Purchases - This page explains how to set up In-App Purchases in your game such that Metaplay is aware of them, enabling server-supported purchase validation. implementing-auto-renewing-subscriptions.md: Auto-Renewing Subscriptions - This guide explains how to use Auto-Renewing Subscriptions in your game. implementing-google-play-refunds.md: Google Play Refunds - This guide helps you set up the convenience utility for an easy way of requesting refunds for Google Play purchases straight from the LiveOps Dashboard. sandbox-purchases.md: Sandbox Purchases - This guide describes how to configure the server to accept sandbox (test) purchases and to report whether a purchase was a sandbox or real-money purchase. in-game-events/ advanced-liveops-events-integration.md: Advanced LiveOps Events Integration - This page provides a guide on how to integrate the events flow into your game's gameplay logic. configuring-liveops-events.md: Configuring LiveOps Events - This page describes various ways to configure LiveOps in-game events. implementing-game-events.md: Implementing Config-Driven Game Events - This page describes how to implement config-driven Events in your game. The events will support player segment targeting and calendar-based schedules. implementing-liveops-events.md: Implementing LiveOps Events - This page describes how to implement in-game events that can be scheduled and configured via the LiveOps Dashboard. introduction-to-game-events.md: Introduction to Game Events - This page introduces the various ways in which Metaplay supports implementing in-game Events. in-game-mail-and-broadcasts/ implementing-in-game-mail.md: Implementing In-Game Mail - This guide introduces a basic implementation of custom in-game mails in your game based on Metaplay SDK's example code. managing-broadcasts.md: Managing Broadcasts - This document describes how to use the Broadcasts feature of the LiveOps Dashboard to send in-game messages to your players. in-game-offers/ getting-started-with-in-game-offers.md: Getting Started with In-Game Offers - This document contains a step-by-step guide for integrating the Metaplay SDK's in-game offers in your game, as well as advanced use cases. leagues/ configuring-leagues.md: Customizing Leagues - This page describes the necessary configurations for a league and its divisions needed before a season can start. leagues-advanced-features.md: Advanced Leagues Customization - This page explains how to further customize leagues to your game's needs using advanced features. leagues-quick-guide.md: Leagues Quickstart Guide - The Leagues are a season-based leaderboard system to match players against opponents of the same rank, allowing competition, progression, and rewards depending on in-game performance. localization/ implementing-localization.md: Localization - The page describes how Metaplay's localization system works and how you can integrate it into your game. matchmaking/ deep-dive-async-matchmaker.md: Deep Dive: Async Matchmaker - This guide will help you deepen your understanding of the matchmaker service's inner workings and customize it for more specialized needs. integrating-the-async-matchmaker.md: Integrating the Async Matchmaker - This guide provides a hands-on introduction to a basic implementation of an asynchronous matchmaker into your game. introduction-to-matchmaking.md: Introduction to Matchmaking - This page is an introduction to the Metaplay SDK's matchmaking system. platform-plugins/ using-external-dependency-manager-for-unity-edm4u.md: Using the External Dependency Manager for Unity on Android - This document describes how to install and use the External Dependency Manager for Unity (EDM4U) player-ip-geolocation/ implementing-player-ip-geolocation.md: Implementing Player IP Geolocation - This document describes how to enable and access IP-based player geolocation information. player-segments/ implementing-player-segments.md: Implementing Player Segments - This is a hands-on guide on how to implement player segmentation in your game. Segments define groups of players and can be used by other game features to target subsets of your entire player base. using-segments-for-audience-targeting.md: Using Segments for Audience Targeting - Game features can be targeted at groups of players through the LiveOps push-notifications/ implementing-push-notifications.md: Implementing Push Notifications - This page describes how to configure Push Notifications for your game. For how to send notification campaigns, see "Managing Push Notifications". managing-push-notifications.md: Managing Push Notifications - This document describes how to use the Push Notification feature of the LiveOps Dashboard to send push notification messages to your players. social-logins/ getting-started-with-social-logins.md: Getting Started with Social Logins - This article will discuss the general benefits and use cases of social logins as well as describe a test platform that can be used to test and verify the system as a whole. implementing-steam-auth.md: Implementing Steam Authentication - How to integrate Steam as a device login source. managing-conflicting-social-logins.md: Managing Conflicting Social Logins - When using social logins, combining multiple different platforms and devices can create conflicts. This article details the outcomes and implementation of possible conflict-solving strategies. social-platform-apple-game-center.md: Platform: Apple Game Center - How to integrate Apple Game Center as a social login source. social-platform-facebook-login.md: Platform: Facebook Login - How to integrate Facebook Login as a social login source. social-platform-google-play-games.md: Platform: Google Play Games - How to integrate Google Play Games as a social login source. social-platform-google-sign-in.md: Platform: Google Sign-In - How to integrate Google Sign-In as a social login source. social-platform-immutablex-wallet.md: Platform: ImmutableX Wallet - How to integrate ImmutableX Wallet as a social login source. social-platform-sign-in-with-apple.md: Platform: Sign in with Apple - How to integrate Sign in with Apple as a social login source. time-skip/ testing-game-schedules-with-time-skipping.md: Testing Game Schedules With Time Skipping - This document describes how to use the Metaplay SDK's time-skipping feature to set the server's time to the future for testing purposes. unity-sdk-features/ client-build-version.md: Client Build Version - This guide describes the means of populating client build version information. connection-management.md: Connection Management - This guide gives an overview of how the connection is formed and maintained within the Metaplay SDK and how to handle the various error states in your game. environment-configs.md: Environment Configs - This document describes the features of the Environment Configs system, as well as its advanced use cases. implementing-changing-the-player-name.md: Changing the Player's Name - A player's name can be changed by the game client or through the LiveOps implementing-custom-incident-reports.md: Implementing Custom Incident Reports - This document describes how to report incidents and implement custom incident report types. implementing-in-game-player-account-deletion.md: Player Account Deletion - To comply with Apple App Store requirements and to give more control to the end user, it should be possible for the end user to request their game account to be deleted within the game. implementing-maintenance-mode-on-the-game-client.md: Maintenance Mode - The game client can detect when maintenance mode has been scheduled on the Game Backend and react accordingly - showing a message on the UI or preventing the player from starting a new game. implementing-player-banning.md: Player Banning - This guide provides an overview of how to implement banning in your game. simulating-a-poor-network-connection.md: Simulating a Poor Network Connection - Metaplay SDK can simulate various poor network connection scenarios. This allows for testing and validating that the game handles spotty network connectivity in a desirable way. webgl.md: Metaplay & WebGL - The Metaplay SDK supports Unity projects built with WebGL. Here's how to get started. web3/ getting-started-with-nfts.md: Getting Started with NFTs - This document contains a step-by-step guide for integrating NFTs into a game using Metaplay SDK. game-logic/ deep-dive-game-logic-execution-model.md: Deep Dive: Game Logic Execution Model - This document describes the core concepts of the Metaplay SDK's game logic time-and-ticks.md: Time and Ticks - This page describes how time advances in the server, the player model, and other models in general. how-to-guides/ accounts-and-authentication.md: Accounts and Authentication - This page describes the authentication methods used by the game client to connect to the server. client-and-server-listeners.md: Client and Server Listeners - Listeners are a way to route events from game logic to trigger behavior on the client or server. They can help alter behavior outside the models as a consequence of actions, for example. implementing-cheat-proof-randomization.md: Implementing Cheat-Proof Randomization - This guide explains why randomization of gameplay elements needs to be cheat-proof and how to easily implement this with the Metaplay SDK. implementing-development-only-features.md: Development-Only Features - This guide explains how to implement and enable game features on development servers while keeping them disabled on production servers. implementing-your-own-game-server-connection.md: Implementing Your Own Game Server Connection - How to integrate the MetaplaySDK connection into your own state manager. initializing-data-on-the-player-model.md: Initializing Data on The Player Model - This page describes how to use appropriate hooks to initialize and update members on the player model. logging.md: Logs & Debugging - This guide gives an overview of how you can log data from both the client and Game Backend and how to efficiently work with those logs in various environments. utilities/ client-patches.md: Client Patches - This page describes the process of doing client-only hotfixes and controlling which client patch versions are accepted by the server. commit-id-check.md: Commit ID Check - This page describes how to prevent clients from connecting to the server if they have been built from different source code versions. deep-dive-data-serialization.md: Deep Dive: Data Serialization - This guide explains how to serialize data in a game, either to persist into the database or to transfer between the client and the server. deterministic-collections.md: Deterministic Collections - This page describes how to use deterministic collections in your game logic. fixed-point-math.md: Fixed-Point Math - This page describes how to use fixed-point math in your game logic. implementing-metarewards.md: Implementing MetaRewards - This guide explains why and how to use the built-in MetaRewards classes in your game. logic-versions.md: Logic Versions - This page describes how to use the Metaplay SDK to allow the server to support multiple client versions simultaneously. model-inspector.md: Model Inspector - Integrating the Metaplay SDK into your Unity project also adds a window that shows you the current Model's properties while in Play Mode. game-server-programming/ custom-server-logic.md: Custom Server Logic - This page demonstrates how to add a custom server-only entity to the backend. game-server-programming.md: Introduction to Game Server Programming - This article describes how metaplay's server architecture works and how to get started with game server programming. introduction-to-entities-and-actors.md: Introduction to Entities and Actors - Entities and Actors are the core building blocks of the Metaplay SDK. introduction-to-the-game-server-architecture.md: Game Server Architecture - This guide gives an overview of the Metaplay SDK’s game server software architecture and its programming model. how-to-guides/ balancing-load-between-nodes.md: Balancing Load Between Nodes - The Metaplay SDK provides a system to track load and schedule work across the server nodes. configuring-cluster-topology.md: Configuring Cluster Topology - This page describes how Metaplay clustering works and how to customize the topology for your game. custom-entities.md: Custom Entities - This article gives an example on how to add custom Entities to the server to add new server-only game features. database-scan-jobs.md: Database Scan Jobs - The Metaplay SDK provides a database scanning system to perform operations on server entities according to custom parameters. deep-dive-entity-to-entity-communication.md: Deep Dive: Entity-to-Entity Communication - >- dynamic-scaling.md: Dynamic Scaling - This document describes how to automatically adjust the number of server nodes based on the backend's load. entity-schema-versions-and-migrations.md: Entity Schema Versions and Migrations - This page explains the concept of Schema Versions for persisted entities and how to implement Schema Version Migrations. public-web-endpoints.md: Public Web Endpoints - This document describes introducing new gameserver HTTP endpoints intended for public use. queuing-server-actions.md: Queuing Server Actions - This article describes how to use a queue pattern to time server actions more precisely. troubleshooting-servers.md: Troubleshooting Servers - This article describes how to troubleshoot high CPU usage or memory leaks in the game server. udp-passthrough.md: UDP Passthrough - This article describes how to implement a UDP server that can be embedded within a Metaplay backend. working-with-runtime-options.md: Working with Runtime Options - Runtime options are used to configure the game server with game and environment-specific data for each cloud environment and can be set through multiple sources. working-with-the-database.md: Working with the Database - This article explains how Metaplay's data persistence model is organized and how you can extend it for your game-specific data. introduction/ introduction-to-metaplay.md: Introduction to Metaplay - A modern, fully-programmable platform for building and operating top-grossing live-service games with Unity and C#. sample-projects-overview.md: Metaplay Sample Projects - The Metaplay SDK ships with a collection of sample projects that demonstrate the SDK's features. getting-started/ index.md: Getting Started - Guides for taking Metaplay into use in both new and existing games. new-project/ adding-the-sdk-to-a-unity-project.md: Adding the SDK to a Unity Project - This article will guide you through integrating the Metaplay SDK package into your existing Unity game project. connecting-to-the-game-server.md: Connecting to the Game Server - This article will guide you through running a Metaplay server locally and connecting to it. creating-and-using-actions.md: Creating and Using Actions - This article will guide you through setting up your first Actions. index.md: Integrate Metaplay Into a New Game - How to integrate Metaplay SDK into a game that is still early in development. project-configuration.md: Project Configuration - This article helps you configure the use of Metaplay in your project. saving-player-data-on-the-server.md: Saving Player Data to the Server - This article will guide you through setting up your first PlayerModel. sdk-integration-guide.md: Integrate the Metaplay SDK - This article will guide you through integrating the Metaplay SDK package into your Unity game project. setting-up-game-configs.md: Setting Up Game Configs - This article will guide you through setting up your first Game Configs. trash-dash/ index.md: Integrate Metaplay Into an Existing Game - A tutorial on how to integrate Metaplay into an existing Unity Game. tutorial-01-basic-integration.md: Tutorial: Minimal SDK Integration - Add the Metaplay SDK into an existing game and start syncing player state. tutorial-02-game-configs.md: Tutorial: Game Configs - Integrate game configs to remotely configure and balance your game. tutorial-03-liveops-features.md: Tutorial: LiveOps Features - Use game configs to implement A/B testing, segmentation, and LiveOps events into your game. tutorial-04-customize-dashboard.md: Tutorial: Customize The Dashboard - This section explains how to add your own visualizations for the player's state to the dashboard. tutorial-05-wrapping-up.md: Tutorial: Review & Next Steps - Summary of what we've learned and next steps for building your game with Metaplay. samples/ helloworld/ index.md: Hello World Sample - A minimal starter project that scaffolds a new Metaplay-powered game. idler/ index.md: Idler Sample - A testing ground for Metaplay features in a simple idle live-service game. orca/ index.md: Orca Sample orca-arch.md: Orca - Architecture Overview - Technical overview of Orca, how it is built, and how it integrates with Metaplay's systems. trash-dash/ index.md: Trash Dash Sample Project - A complete sample of how to integrate Metaplay into an existing Unity game. wordle-tutorial/ index.md: Wordle Tutorial - This section has some practical exercises that introduce Metaplay's main concepts and teach you how to build a Wordle clone. tutorial-cheat-proof-gameplay.md: Tutorial: Cheat-Proof Gameplay - In this tutorial, we'll take the Wordle clone we built previously and implement server actions and configs to make it cheat-proof. tutorial-learn-to-write-game-logic-with-a-wordle-clone.md: Tutorial: Game Logic - This article gives a practical overview of how to program games using Metaplay’s actions and models paradigm by implementing a clone of Wordle using the Metaplay SDK. tutorial-wordle-game-configs.md: Tutorial: Game Configs - This tutorial builds on the previous guide on implementing a Wordle clone. This time, we're focusing on the project's Game Configs to fetch data from Google Sheets for a more realistic workflow. liveops-dashboard/ configuring-the-liveops-dashboard.md: Configuring the LiveOps Dashboard - This page provides an overview of how to configure the LiveOps Dashboard. developing-the-liveops-dashboard.md: Developing the LiveOps Dashboard - This article will guide you on how to set up a custom LiveOps Dashboard and run an instance of it locally. introduction-to-the-liveops-dashboard.md: Introduction to the LiveOps Dashboard - Metaplay SDK ships with a pre-configured website, the LiveOps Dashboard, for viewing and managing your game. liveops-timeline.md: Using the LiveOps Timeline - The LiveOps Dashboard uses a timeline view for monitoring and interacting with various time-related items, such as LiveOps events. how-to-guides/ customizing-the-liveops-dashboard-frontend.md: Customizing the LiveOps Dashboard Frontend - This page documents customizing the LiveOps Dashboard to your game's needs. dashboard-actions.md: Tutorial: Add an Admin Action - This page gives a practical overview of how to add a new admin action to the player details page of the LiveOps Dashboard. fetching-data-from-the-game-server.md: Fetching Data from the Game Server - This document outlines the different methods of fetching data from the game server into the LiveOps Dashboard. viewing-event-streams.md: Viewing Event Streams - This article will guide you through how to navigate streams of events in the LiveOps Dashboard. Event streams can be used to understand how something has changed over time. working-with-generated-dashboard-forms-and-views.md: Working with Generated Dashboard UI - Generated UIs are an experimental Metaplay feature that allows the generation of dashboard UI from C# type information. It can replace the need for a lot of game-specific custom UI components. working-with-subscriptions.md: Working with Subscriptions - Subscriptions are the recommended way to fetch data from the game server. This document dives into the detail of how to work with subscriptions. working-with-the-liveops-dashboard-http-api.md: Working with the LiveOps Dashboard HTTP API - This guide walks you through implementing a new end-to-end feature into the LiveOps Dashboard. miscellaneous/ cli-command-reference.md: CLI Command Reference - Complete reference for all Metaplay CLI commands and their usage. creating-support-tickets.md: Creating Support Tickets - This page describes how to create support tickets and the approximate response time you can expect depending on your support plan. ai-assistants/ custom-gpt.md: Metaplay Docs Custom GPT - Use the Metaplay Docs Custom GPT for quick answers and discovery. index.md: AI Assistants - Practical ways to use AI assistants with Metaplay. llm-docs-mcp.md: Metaplay Docs MCP - Connect Metaplay documentation, SDK source, and sample projects to your coding agents. portal-mcp.md: Metaplay Portal MCP - Connect AI assistants to Metaplay portal with secure, role-scoped access. licenses/ game-server-licenses.md: Game Server OSS Licenses - This page lists the OSS licenses of the third-party packages used in the Game Server. index.md: Open Source Software Licenses - This document lists the open source software licenses used in the Metaplay SDK. infrastructure-licenses.md: Infrastructure OSS Licenses - This document lists the OSS licenses for the infrastructure components used by Metaplay. liveops-dashboard-licenses.md: LiveOps Dashboard OSS Licenses - This document lists the OSS licenses of the LiveOps Dashboard and its dependencies. sdk-updates/ compatibility.md: Metaplay Compatibility Matrix - Version compatibilities across different Metaplay SDK components. index.md: Updating the Metaplay SDK - Learn how to update the Metaplay SDK in your project. release-notes/ index.md: Release Notes - A list of all Metaplay SDK updates to date! release-1.md: Release 1 - March 6th, 2020 release-10.md: Release 10 - March 10th, 2021 release-11.md: Release 11 - April 16th, 2021 release-12.md: Release 12 - June 4th, 2021 release-13.md: Release 13 - June 30th, 2021 release-14.md: Release 14 - September 2nd, 2021 release-15.md: Release 15 - November 5th, 2021 release-16.md: Release 16 - December 22nd, 2021 release-17.md: Release 17 - February 18th, 2022 release-18.md: Release 18 - April 14th, 2022 release-19.md: Release 19 - July 22nd, 2022 release-2.md: Release 2 - March 30th, 2020 release-20-1.md: Release 20.1 - October 11th, 2022 release-20.md: Release 20 - September 29th, 2022 release-21.md: Release 21 - December 16th, 2022 release-22.md: Release 22 - March 14th, 2023 release-23.md: Release 23 - May 26th, 2023 release-24.md: Release 24 - August 25th, 2023 release-25-environment-configs-migration-guide.md: Release 25 Environment Configs Migration Guide - Release 25 migration guide for the new environment config system, which provides a way to define client-side environment-specific values, including the server endpoint to connect to. release-25-migration-guide.md: Release 25 Game Config Migration Guide - Release 25 migration guide for game config changes. release-25.md: Release 25 - November 14th, 2023 release-26.md: Release 26 - December 22nd, 2023 release-27-custom-entities.md: Release 27 Migration Guide for Custom Entities - This article explains the steps needed to migrate custom entities to be compatible with Release 27. release-27-gameconfig-migration-guide.md: Release 27 Game Config Migration Guide - Release 27 migration guide for game config changes. release-27-managed-env-migrations.md: Release 27 Migration Guide for Managed Environments - This article explains the steps to add some required environment configuration files for the customers using Metaplay managed environments and started their project before Release 27. release-27.md: Release 27 - March 22nd, 2024 release-28.md: Release 28 - June 7th, 2024 release-29.md: Release 29 - August 26th, 2024 release-3.md: Release 3 - May 8th, 2020 release-30.md: Release 30 - October 14th, 2024 release-31.md: Release 31 - December 16th, 2024 release-32.md: Release 32 - April 2nd, 2025 release-33.md: Release 33 - June 18th, 2025 release-34.md: Release 34 - September 10th, 2025 release-35.md: Release 35 - November 27th, 2025 release-36.md: Release 36 - February 11th, 2026 release-4.md: Release 4 - June 10th, 2020 release-5.md: Release 5 - July 13th, 2020 release-6.md: Release 6 - August 27th, 2020 release-7.md: Release 7 - September 25th, 2020 release-8.md: Release 8 - November 3rd, 2020 release-9.md: Release 9 - December 17th, 2020 security-bulletins/ index.md: Security Bulletins - Metaplay security bulletins and advisories related to security. met-2024-001.md: MET-2024-001 - XZ Utils (CVE-2024-3094) met-2025-001.md: MET-2025-001 - ingress-nginx (CVE-2025-1974) met-2025-002.md: MET-2025-002 - Kubernetes C# client (CVE-2025-9708) met-2025-003.md: MET-2025-003 - Akka.Remote (CVE-2025-61778) met-2025-004.md: MET-2025-004 - ASP.NET (CVE-2025-55315) operating-a-live-game/ customer-support/ working-with-entity-export-import.md: Entity Export and Import - The LiveOps Dashboard can be used to export and import entities (such as players, guilds) to help during development and testing. This section gives an overview of the feature and how to customize it. working-with-player-deletion.md: Working with Player Deletion - In compliance to GDPR's "right to be forgotten", a player must be able to delete their data from your game's database. Metaplay handles most of the work, but there's still some customizing to do. game-server-metrics/ customizing-game-server-metrics.md: Customizing Game Server Metrics - This page shows how to create your own game-specific Metrics and how to customize the Metrics feature. introduction-to-game-server-metrics.md: Introduction to Game Server Metrics - This page outlines what the game server metrics feature is and what it isn't, and how to access the metrics. security-and-compliance/ implementing-gdpr-compliance.md: GDPR Compliance - This section outlines how to use and customize the built-in General Data Protection Regulation (GDPR) data exporting features for easy compliance with player data requests. managing-dashboard-permissions.md: Dashboard User Authentication - This page explains how Metaplay's user authentication and authorization works with the LiveOps Dashboard, and how to adopt it in your project. working-with-liveops-dashboard-audit-logs.md: LiveOps Dashboard Audit Logs - This page explains that what users do on the LiveOps Dashboard is logged, and shows you how to view the logged events. self-hosting/ introduction-to-metaplay-cloud-infrastructure.md: Introduction to Metaplay Cloud Infrastructure - This article provides a high-level overview of the cloud infrastructure architecture that powers Metaplay game servers. ### /MetaplaySDK - SDK Source Code Full source code of the Metaplay SDK. - **Backend/** - C# server framework and core systems - **Client/** - Unity client SDK and networking - **Frontend/** - LiveOps Dashboard and reusable JS modules (Vue/TypeScript) - **Plugins/** - Platform integrations Access `/MetaplaySDK/index.md` for a file tree. ### /samples - Sample Projects Sample projects demonstrating SDK usage patterns. - **HelloWorld/** - Minimal starter template demonstrating basic SDK setup and core concepts - **HelloNFT/** - Minimal starter template with NFT support - **Idler/** - Full-featured idle game showcasing advanced features and LiveOps integration - **Wordle/** - Word game with daily challenges, demonstrating content scheduling and player state - **orca/** - Full merge-2 mobile game (from github.com/metaplay-shared/orca) - **trashdash-sample/** - Minimal integration sample demonstrating basic Metaplay SDK integration (from github.com/metaplay-shared/trashdash-sample) Access `/samples/index.md` for a file tree. ### /website - Blog & Case Studies Content from the Metaplay website (metaplay.io) including blog posts and customer case studies. - **blog/** - Technical articles, guides, and announcements - **case-studies/** - Customer success stories Access `/website/index.md` for a full listing. ## Usage - Use ripgrep (/rg) to search across all content - Use find (/find) to find files by pattern - Read individual files by their full file path (e.g. `/docs/index.md`)