# Open Play

> Open Play is a game backend platform: player identity and sessions, characters, inventory, economy, store, rewards, social features, leaderboards, notifications, webhooks and realtime connections in a single server. Games connect over HTTP (REST) and WebSocket with the TypeScript or Unity SDK; the game team configures the same server from the admin panel.

Pages below are plain markdown copies of the developer documentation (English). Turkish is the source language and lives under the `tr/` path.

Server-only operations need a server key; player calls use a player session. Start with the getting-started pages.

## Getting started

- [Open Play overview](https://open-play.b4klabs.dev/docs/en/getting-started/overview.md): Explains what Open Play gives your game, which surfaces you talk to, and where to start.
- [Core concepts](https://open-play.b4klabs.dev/docs/en/getting-started/concepts.md): Defines the concepts of studio, game, environment, module, API key types, player session, and plugin.
- [Quickstart](https://open-play.b4klabs.dev/docs/en/getting-started/quickstart.md): Creates a game and a key in the panel, then makes your first server call, your first guest sign-in from a browser, and your first sign-in from Unity.
- [Architecture and hosting](https://open-play.b4klabs.dev/docs/en/getting-started/architecture-and-hosting.md): Explains what runs where in the Open Play stack, direct CORS calls and the reverse-proxy option for browser games, and domain binding.
- [Using AI tools (MCP)](https://open-play.b4klabs.dev/docs/en/getting-started/ai-tools.md): Explains how to set up the MCP server that connects AI assistants such as Claude Code, Cursor and VS Code to the Open Play docs and SDK API, and what its tools do.
- [AGENTS.md for your game](https://open-play.b4klabs.dev/docs/en/getting-started/agents-md.md): A ready-made AGENTS.md template for your game repository that helps AI coding agents integrate Open Play correctly, and how to use it together with the MCP server.

## Auth

- [Authentication overview](https://open-play.b4klabs.dev/docs/en/auth/overview.md): Summarizes the player sign-in methods, the shared request rules, the response format, the rate limits, and which method maps to which SDK call.
- [Guest sign-in](https://open-play.b4klabs.dev/docs/en/auth/guest.md): Explains how an account-less guest player is created, how the secret is stored, and how a guest account is turned into a permanent account.
- [Email and password](https://open-play.b4klabs.dev/docs/en/auth/email-password.md): Describes the sign-up, sign-in, guest upgrade, password change, password reset, and magic link endpoints with request and response examples.
- [Sign in with Google](https://open-play.b4klabs.dev/docs/en/auth/oauth.md): Describes the Google OAuth redirect flow, the callback page, the automatic linking by email rule, and native platform proofs.
- [Sessions and CSRF](https://open-play.b4klabs.dev/docs/en/auth/sessions-and-csrf.md): Describes carrying the session with a cookie or Bearer, lifetimes, refresh and sign-out, the single active session option, and double-submit CSRF protection.
- [Account linking](https://open-play.b4klabs.dev/docs/en/auth/account-linking.md): Describes guest upgrade, linking and unlinking a provider identity, listing linked identities, and the conflict rules.
- [Account deletion](https://open-play.b4klabs.dev/docs/en/auth/account-deletion.md): Explains how a player deletes their own account from inside the game, the recent sign-in rule, what is erased and what stays, and the app-store privacy expectation.
- [Verifying the player on your game server](https://open-play.b4klabs.dev/docs/en/auth/server-verification.md): Describes verifying the player's access JWT offline with the JWKS, alternatively verifying by asking Open Play about the session, and the limits of both paths.

## SDK

- [TypeScript SDK](https://open-play.b4klabs.dev/docs/en/sdk/typescript.md): Describes installing the TypeScript SDK from GitHub Packages, its entry points, client types, error and number rules, and which modules have a typed client.
- [Unity SDK](https://open-play.b4klabs.dev/docs/en/sdk/unity.md): Describes installing the Unity SDK from GitHub Packages, session and plugin use, the WebGL rule, and the verified platforms.

## Guides

- [Characters](https://open-play.b4klabs.dev/docs/en/guides/characters.md): Describes character templates, creating characters, commands, level curves and the version rule.
- [Inventory and items](https://open-play.b4klabs.dev/docs/en/guides/inventory-items.md): Describes item definitions, item instances, inventory placement and the item catalog.
- [Economy](https://open-play.b4klabs.dev/docs/en/guides/economy.md): Describes currencies, wallets, the ledger, transfers, merchants, player trading and economy reports.
- [Store and in-app purchases](https://open-play.b4klabs.dev/docs/en/guides/store-iap.md): Describes the store showcase, a player's purchase with their own session, the server-side reservation flow and in-app purchase (IAP) verification.
- [Rewards](https://open-play.b4klabs.dev/docs/en/guides/rewards.md): Describes reward tables, granting rewards from a table, the daily login reward, quests, NPC rewards and VIP status.
- [Clans and parties](https://open-play.b4klabs.dev/docs/en/guides/social.md): Describes the clan and party model, membership flows, the clan treasury, party reward distribution and server calls.
- [Chat](https://open-play.b4klabs.dev/docs/en/guides/chat.md): Describes chat channels, sending messages and reading the archive, the chat WebSocket, moderation rules and limits.
- [Leaderboards and tournaments](https://open-play.b4klabs.dev/docs/en/guides/competition.md): Describes leaderboard definitions, seasons, writing scores, reading the board and the tournament flow.
- [Notifications](https://open-play.b4klabs.dev/docs/en/guides/notifications.md): Describes notification providers, templates, rules, device registration, the in-game inbox and sending notifications from the server.
- [Webhooks](https://open-play.b4klabs.dev/docs/en/guides/webhooks.md): Describes webhook endpoint registration, event types, the delivery envelope, signature verification, retry rules and an example receiver.
- [Scenes, assets and 3D models](https://open-play.b4klabs.dev/docs/en/guides/scenes-assets-models.md): Describes scene provisioning, the content-addressed image store, the 3D model library and how your game reads them.
- [Content groups](https://open-play.b4klabs.dev/docs/en/guides/content-groups.md): Describes the game-data groups defined in the panel, field types, the publish flow and how your game reads this data from the catalog.
- [Game rules and automations](https://open-play.b4klabs.dev/docs/en/guides/game-rules.md): Describes game rule values set from the panel, event-driven automations, the REST rule endpoints and the limits of CEL rules.
- [Player data (cloud save)](https://open-play.b4klabs.dev/docs/en/guides/player-data.md): Describes the per-player key-value cloud save, the versioned write rule, the limits, the error codes and how to inspect the data in the panel.

## Realtime

- [Realtime overview](https://open-play.b4klabs.dev/docs/en/realtime/overview.md): Describes Open Play's three WebSockets, which one to use for what, and the connection requirements.
- [Realtime protocol](https://open-play.b4klabs.dev/docs/en/realtime/protocol.md): Describes the ticket, subprotocol, and authentication flow of the plugin realtime socket and all frames with their fields.
- [Reconnect and limits](https://open-play.b4klabs.dev/docs/en/realtime/reconnect-and-limits.md): Describes how to resume with the cursor and epoch when the realtime socket drops, idle close, compression, and all limits.

## Plugins

- [Plugins overview](https://open-play.b4klabs.dev/docs/en/plugins/overview.md): Describes what a plugin is, which plugins run today as trusted, compiled code, and their per-environment enablement states.
- [Writing a plugin](https://open-play.b4klabs.dev/docs/en/plugins/authoring.md): Describes the anatomy of a trusted plugin compiled into the Open Play server, a small worked example, versioning and safe release steps, enabling per environment, client bindings, and panel integration.
- [Calling plugins](https://open-play.b4klabs.dev/docs/en/plugins/calling-plugins.md): Describes the rules for calling plugin commands, queries, the result query, and the schema endpoint over HTTP, and the error envelope.
- [Bindings and schema pinning](https://open-play.b4klabs.dev/docs/en/plugins/bindings.md): Describes generating TypeScript and Unity bindings from a plugin schema document, pinning the version with schemaSha256, and what happens on a mismatch.

## Reference

- [Error reference](https://open-play.b4klabs.dev/docs/en/reference/errors.md): Gathers the status codes, error body formats, and machine codes of the core REST and plugin endpoints in a single table.
- [Idempotency and concurrency](https://open-play.b4klabs.dev/docs/en/reference/idempotency-and-concurrency.md): Describes replay safety with Idempotency-Key, optimistic version checking with If-Match and expectedVersion, and what to do on a conflict.
- [Pagination](https://open-play.b4klabs.dev/docs/en/reference/pagination.md): Describes the pagination formats Open Play uses on its list endpoints, page size limits, and cursor rules by endpoint family.
- [Rate limits](https://open-play.b4klabs.dev/docs/en/reference/rate-limits.md): Honestly lists Open Play's known rate limit buckets, the format of the 429 response, and the Retry-After rules.
- [Numbers and encoding](https://open-play.b4klabs.dev/docs/en/reference/numbers-and-encoding.md): Describes the wire format of integers, monetary values, timestamps, identifiers, and enumeration values.
- [Versioning](https://open-play.b4klabs.dev/docs/en/reference/versioning.md): Describes what the protocol, plugin schema, and SDK versions in Open Play mean, and the deprecation (Deprecation) practice.
- [Endpoint reference](https://open-play.b4klabs.dev/docs/en/reference/endpoints.md): Generated list of the Open Play core REST endpoints with method, path, module, credential type and header requirements.
- [Webhook events](https://open-play.b4klabs.dev/docs/en/reference/webhook-events.md): Generated list of the event types a webhook endpoint can receive, with the delivery headers.
- [Glossary](https://open-play.b4klabs.dev/docs/en/reference/glossary.md): Short definitions of the terms used in the Open Play documentation; studio, environment, key types, session, plugin, and realtime concepts.

## Operations

- [Security](https://open-play.b4klabs.dev/docs/en/operations/security.md): A security guide for API key management and rotation, player sessions and CSRF, CORS and the same-origin rule, and webhook signature verification.
- [Production checklist](https://open-play.b4klabs.dev/docs/en/operations/production-checklist.md): A list to tick off under the headings of network, identity, keys, replay safety, realtime, and monitoring before taking your game live with Open Play.
- [Troubleshooting](https://open-play.b4klabs.dev/docs/en/operations/troubleshooting.md): Tables that go from symptom to cause to fix; identity, network, plugin, realtime, and webhook problems by real error codes and status codes.
- [Frequently asked questions](https://open-play.b4klabs.dev/docs/en/operations/faq.md): The most frequently asked questions during integration and their short answers; key types, CORS, numbers, replay safety, plugins, and realtime.

## Panel

- [Game overview](https://open-play.b4klabs.dev/docs/en/panel/dashboard.md): See the state of the selected game and environment at a glance: players, characters, content, rules, plugin and recent actions.
- [Players](https://open-play.b4klabs.dev/docs/en/panel/players.md): Search, filter and inspect your game's player accounts, and create a new account by hand if you need to.
- [Player characters](https://open-play.b4klabs.dev/docs/en/panel/characters.md): Find the characters players play in the game, open their profile and, if needed, create a new character from a definition.
- [Clans](https://open-play.b4klabs.dev/docs/en/panel/clans.md): Inspect, read-only, the clans players have created, their members, invites and applications, clan treasury movements and command history.
- [Parties](https://open-play.b4klabs.dev/docs/en/panel/parties.md): Inspect, read-only, the parties players have created, their members, invites and the results of reward distributions.
- [City chat](https://open-play.b4klabs.dev/docs/en/panel/scene-chat.md): Read the city chat, delete a harmful message and mute its author for a set time; every action is written to the audit log with a reason.
- [Player organizations](https://open-play.b4klabs.dev/docs/en/panel/organizations.md): Manage the organizations players have created (not studios), their members, invites, teams and dynamic roles; this screen is being retired.
- [Session center](https://open-play.b4klabs.dev/docs/en/panel/sessions.md): See players' open session counts and last sign-ins; to close sessions, go to the player's security page.
- [Content](https://open-play.b4klabs.dev/docs/en/panel/content.md): Manage your game content such as vehicles, characters and items in groups. The game sees only the version you published.
- [Character templates](https://open-play.b4klabs.dev/docs/en/panel/character-templates.md): The templates of characters and items in the game. Changing a template releases a new version; the old version is not deleted.
- [3D models](https://open-play.b4klabs.dev/docs/en/panel/models.md): Upload a model; the server converts it to glb and validates it. Bind a ready model to an item or character; the game sees the change without a redeploy.
- [Store](https://open-play.b4klabs.dev/docs/en/panel/store.md): Products players buy in the game. Manage their image, price and stock from here.
- [Currencies](https://open-play.b4klabs.dev/docs/en/panel/currencies.md): The currencies used to set prices in the store and to give money in rewards.
- [Reward tables](https://open-play.b4klabs.dev/docs/en/panel/reward-tables.md): Tables that tie NPC, creature, tournament and mission rewards to chance.
- [Economy reports](https://open-play.b4klabs.dev/docs/en/panel/economy.md): Shows how money circulates in the game.
- [Rules](https://open-play.b4klabs.dev/docs/en/panel/rules.md): Set how the game reacts to events from here. Changes reach the game when you release them; every release can be rolled back.
- [Leaderboards](https://open-play.b4klabs.dev/docs/en/panel/leaderboards.md): Tables where players are ranked by their scores. Tables reset by themselves at the interval you choose, and past seasons are kept.
- [Notifications](https://open-play.b4klabs.dev/docs/en/panel/notifications.md): Manage the messages sent to players; first connect a push notification provider, then write a template, then add a rule or send a test.
- [General](https://open-play.b4klabs.dev/docs/en/panel/game-settings-general.md): See the selected game's name, short name, studio and plugin; rename or archive the game.
- [Plugins](https://open-play.b4klabs.dev/docs/en/panel/plugins.md): See the game's plugin and the other plugins authorized in the selected environment; an authorized admin can change a plugin's state.
- [Safety switches](https://open-play.b4klabs.dev/docs/en/panel/safety-switches.md): Loosen or force back the game's protection rules in this environment without a deploy; every change is written to the audit log with a reason.
- [Audit log](https://open-play.b4klabs.dev/docs/en/panel/audit.md): See the unchangeable record of changes admins made; check who changed what, when and why.
- [Sign-in methods](https://open-play.b4klabs.dev/docs/en/panel/game-settings-sign-in.md): See which methods players use to get into the game; enter Google sign-in details and set the single active session rule.
- [Modules](https://open-play.b4klabs.dev/docs/en/panel/game-settings-modules.md): See which product modules are on in the selected environment; a super admin can turn a module on or off.
- [API keys](https://open-play.b4klabs.dev/docs/en/panel/game-settings-api-keys.md): Create the keys your game uses to connect to Open Play, and manage their expiry and status.
- [Webhooks and event queue](https://open-play.b4klabs.dev/docs/en/panel/webhooks.md): Inspect, read-only, the registered webhook endpoints, delivery attempts and the event queue; see why failed deliveries failed.
- [Background jobs](https://open-play.b4klabs.dev/docs/en/panel/operations.md): See the records of plugins' scheduled background jobs, and inspect, read-only, a player's linked sign-in accounts and devices.
- [Studios and games](https://open-play.b4klabs.dev/docs/en/panel/tenancy.md): See studios, games and environments; create a new studio or game, rename them and archive them.
- [Panel admins](https://open-play.b4klabs.dev/docs/en/panel/operators.md): Create the admin accounts that sign in to the panel; set their roles and the environments they can access, disable an account, and reset their sessions and two-step verification.
- [Player profile](https://open-play.b4klabs.dev/docs/en/panel/player-profile.md): Inspect a player's account, sessions, sign-in history and bans; edit the profile, manage the password, ban or delete the player.
- [Character profile](https://open-play.b4klabs.dev/docs/en/panel/character-profile.md): Inspect a character's attributes, wallet and history; if needed, run a command or roll back to an earlier version.
- [Model](https://open-play.b4klabs.dev/docs/en/panel/model-profile.md): Preview a 3D model, publish or roll back its versions, add clips and archive it.
- [Edit content group](https://open-play.b4klabs.dev/docs/en/panel/content-group-edit.md): Set up a content group's name and fields in two steps; every entry is filled in with these fields.
- [Content entry](https://open-play.b4klabs.dev/docs/en/panel/content-entry-edit.md): See a content entry's values, edit its draft or create a new entry.
- [Store product](https://open-play.b4klabs.dev/docs/en/panel/store-product.md): See and change a product's image, price, stock and sale time, or add a new product.
- [Currency](https://open-play.b4klabs.dev/docs/en/panel/currency-profile.md): Manage a currency's icon, decimal places and supply cap; see its movement over recent days.
- [Reward table](https://open-play.b4klabs.dev/docs/en/panel/reward-table-profile.md): See and edit a reward table's rows and chances, try it without saving or create a new table.
- [Leaderboard detail](https://open-play.b4klabs.dev/docs/en/panel/leaderboard-detail.md): See one leaderboard's ranking this season, its past seasons and its settings; change its visibility in the game and its score format.
- [Rule card](https://open-play.b4klabs.dev/docs/en/panel/rules-game-card.md): See when a game rule you chose runs and change its settings; a change does not reach the game until it is released.
- [Rule history](https://open-play.b4klabs.dev/docs/en/panel/rules-history.md): See the full list of game rule releases, check what each version changed and go back to an older version if needed.
- [Automation editor](https://open-play.b4klabs.dev/docs/en/panel/rules-automation-editor.md): Create, try and release a rule that automatically does something to a character when a game event happens, without writing code.
- [Environments and domains](https://open-play.b4klabs.dev/docs/en/panel/game-settings-environments.md): See the game's environments, add a new environment, bind each environment to its own domains or archive an environment.
- [Plugin page](https://open-play.b4klabs.dev/docs/en/panel/plugin-page.md): Explains how the screens a game's plugin defines in the panel work, how actions are performed and what the status warnings mean.

## Optional

- [TypeScript SDK API reference](https://open-play.b4klabs.dev/docs/sdk/typescript/): Generated TypeDoc reference for @open-play/sdk and @open-play/panel-kit.
- [Unity SDK API reference](https://open-play.b4klabs.dev/docs/sdk/unity/): Generated DocFX reference for OpenPlay.Core and OpenPlay.PackageRide.
- [AGENTS.md template for your game](https://open-play.b4klabs.dev/docs/AGENTS.md): Copy-paste rules file that makes AI coding agents integrate Open Play correctly (use the MCP server first, keys, sessions, plugins).
- [Full documentation in one file](https://open-play.b4klabs.dev/docs/llms-full.txt): Every page below concatenated, front matter stripped.
- [Türkçe llms.txt](https://open-play.b4klabs.dev/docs/tr/llms.txt): Turkish index (source language).