Skip to main content
Getting Started

Not translated yet — showing English.

Architecture

PlayServ is the backend your game talks to, run for you. Your game connects through the SDK; your game servers, if you have them, register their rooms; your team shapes everything in the Backoffice and ships code with the CLI. Each project is split into environments, and the key a caller uses decides which project and environment it reaches.

PlayServ · your project's environment Players: sign-in and sessions Data: schema, records, live updates Cloud functions Game rooms and game servers Settings, keys, team and deploys the key decides the project and environment Your game · PlayServ SDK Your game servers Your team · Backoffice, CLI client key server key manage, deploy
Your game, game servers and team on one side; the platform's players, data, functions and rooms on the other, reached with a key per caller

The parts

PartWhat it is
Your gameYour Unity project with the PlayServ SDK. It signs players in, reads and writes data, gets live updates, receives events and calls functions.
Your game serversOptional dedicated servers. They register the rooms players join, and talk to the platform with a server key. See Game Server Hosting.
BackofficeThe web console where your team manages projects, keys, players, the schema and data, functions, servers and rooms.
CLIThe playserv command line, for deploying functions and game servers. See Command Line Interface.
PlayersPlayer accounts, sign-in providers and sessions. See Managing Players.
DataYour schema and its records, with live updates to the game. See Building a Game Schema.
Cloud functionsYour server-side code, run by the platform. See Functions.
Game roomsThe rooms your game servers run, and the players in them. See Game Rooms.

How the game connects

The game keeps one live connection to PlayServ. PlayServ.Connect() signs the player in and opens it; the SDK keeps it alive and reconnects after a drop.

OverWhat travels
The live connectionLive data updates, events from your servers, RPC calls.
Separate requestsMost reads and writes of records, calling cloud functions, signing in.

You don't choose between them: the SDK picks the right path for each call. The connection's states, reconnects and session handling are in Connection & Session.


Keys, environments and players

TermWhat it is
ProjectOne game's backend. See Create a Project.
EnvironmentA separate copy of the project's data, functions and players, such as dev and prod. See Environments.
Client key (pk_…)Built into the game. It decides the project and environment the game reaches. Safe to ship.
Server key (sk_…)For your servers, tools and CI. Never ship it in a game build. See API Key Management.
PlayerEvery connected game signs in as a player, anonymous at first. The player comes from their session, not from a setting. See User Login.

One key, one environment

A build with a dev client key always talks to dev. To release, build with a key of the environment players should use.


SDK modules

The SDK is one package, com.playserv.sdk, with modules for each area, plus optional companion packages.

ModuleWhat it doesGuide
PlayServConnects, configures and disconnects.Connection & Session
PlayServAuthSigns players in, links providers, ends sessions.User Login
PlayServDataReads, writes and subscribes to records.Reading Records
PlayServCodeCalls cloud functions.Functions
PlayServEvents · PlayServRpcReceives events from your servers; calls RPCs.Server Events
PlayServMatchmakingBrowses and joins game rooms.Browse, Host & Join Rooms

Companion packages add sign-in providers, a dedicated game server, and other optional features. They're installed from Tools ▸ PlayServ ▸ Settings, see Connect Your Game.


Next steps

Last updated on 19 Oct 2026