PlanyDocs
Get started

Concepts

Accounts, projects, regions, credit and limits — how the pieces of Plany fit together.

Accounts

An account is you, or your studio. It holds the credit balance, the plan, the people who can sign in to it, its API keys and service accounts, and the record of everything changed on it.

People are users, and a user can belong to more than one account. When you sign in you choose which account the session is for, and everything you do in that session happens in that account.

Projects

A project is where things run. Game servers, autoscaling groups, schematics, sandboxes, networks and secrets all live in one. A project is the unit of:

  • billing — the project's account pays for everything in it,
  • access — most roles are granted on a project rather than on the whole account,
  • quota — most limits are counted per project and region,
  • networking — each project has its own private network in each region.

A good rule of thumb is one project per game, or per environment of a game.

Regions

A region is a place your workloads run. Anything that runs, or holds capacity, belongs to a region and says so in its name — a game server, a schematic, an autoscaling group, a sandbox, a network, a secret. Accounts, projects, API keys and service accounts belong to no region.

Regional APIs answer at <service>.<region>.plany.cloud; the rest answer at <service>.plany.cloud. eu-west-2 (London) is the region Plany runs in. See Regions.

The resources

ResourceLives inWhat it is
GamePlany's catalogue, or your accountSomething that can be run, as a node in a tree. Only entries with a build behind them can be run.
BuildPlany's catalogue, or your accountThe files a server installs — an upload, a Steam app, or a vendor archive.
GameServerproject + regionOne copy of a game, with an address players connect to.
GameServerSchematicproject + regionA saved copy of a server's disk, so new servers start with the game installed and the world generated.
GameServerGroupproject + regionA fleet of servers that grows and shrinks with demand.
Sandboxproject + regionA container image, running on requests or on game events, at a URL.
Vpcproject + regionA private network, and the firewall rules that decide what may reach it.
Secretproject + regionA credential stored once and referenced by name.
ApiKey / ServiceAccountaccountCredentials and non-human identities.

Every resource is named by one string that carries its whole location — see Resource names.

Credit, not invoices

Your plan grants credit every month (Hobby $5, Pro $20, or $25 when Pro is paid annually — all of it spendable). What you run draws it down by the hour, and you can top up at any time. When the balance reaches zero, what is running stops and your data is kept; a top-up lets you start it again.

That is why creating anything that costs money checks your balance first, and why the number worth watching in the console is when your credit will run out rather than a running total. See Billing and credit.

Two kinds of limit

They are easy to confuse, and they are fixed differently.

Every change is on the record

Everything anybody changes on your account is recorded — what changed, by whom, from where and when. Nothing can edit or remove an entry afterwards, and Plany can prove that rather than asking you to take its word for it. See Activity.