app.worldplane.net

The web panel

The panel at app.worldplane.net is where a studio signs up, subscribes, and runs its games. It uses the same API as the CLI, with your session in a cookie.

Signing in#

  • Register your studio with your e-mail, your name and a password of 10 characters or more. If someone invited your e-mail to an organisation, its role is yours as soon as you register.
  • Sign in with e-mail and password, and the authenticator code if you set one up. After 5 wrong passwords or codes for one e-mail, its sign-ins wait 15 minutes.
  • Forgot your password? mails a link that works for an hour. Setting a new password signs out every session the account had.
  • A session lasts 30 days; Sign out ends it.

An authenticator app (TOTP) is set up through the API, POST /v1/me/totp; the panel then asks for its code at sign-in.

Organisations#

The first page lists your organisations and your role in each. Create the organisation takes a name and a short name (the slug: 2 to 18 lowercase letters, digits or dashes, starting with a letter, which never changes). You become its owner.

An organisation's page has five tabs:

TabWhat it holds
OverviewA checklist of the next steps (subscribe, project, environment, build, deploy, Atlas), the Studio plan card while the organisation isn't subscribed, and its projects. Create a project takes a name and a short name.
TeamMembers and pending invitations. Add someone by e-mail with a role, optionally on one project only. Someone without an account is invited by e-mail and joins when they sign up.
API keysKeys for CI and tools. Make the key with what uses it (such as ci), a role (any but owner) and optionally one project. The key (wpk_...) is shown once. Keys can be revoked.
Billing & usageThis month's spend so far, server-hours and USD per environment, the subscription's state, Invoices & payment at Stripe, and the monthly spend limit. Owners, admins and billing members see it.
ActivityThe audit log: everything changed in the organisation, newest first, with who did it. Owners and admins see it.

Roles#

RoleCan
OwnerEverything, billing and other owners included.
AdminMembers (not owners), keys, projects, environments, budgets, secrets, deploys; reads usage and activity. Not billing setup.
OperatorUploads builds and deploys or stops anywhere; secrets on dev and test; reads everything else.
DeveloperUploads builds; deploys to, stops and sets secrets on dev and test; reads the rest.
ViewerReads, Atlas included; changes nothing.
BillingUsage, subscribing, payment and the spend limit.

A role given on one project applies to that project only. An organisation keeps at least one owner.

Subscribing#

Until the organisation subscribes, the overview shows Subscribe to the Studio plan: $100 a month for the organisation, plus server time by the minute, billed monthly through Stripe. Subscribe at Stripe opens Stripe Checkout, which asks for a billing address and accepts a business tax ID and promotion codes, then returns to the panel. Only owners and billing members can subscribe; others see who to ask. See billing.

Engine integrations#

An organisation's overview has the downloads:

  • Unreal Engine 5.8: Download plugin gives the WorldPlane and WorldPlaneGAS plugins as one zip, for members of a subscribed organisation. Unzip it into your project's Plugins/ folder; the Unreal guide goes on from there.
  • Command-line tool: the worldplane CLI for Windows or Linux, for anyone signed in, and a link to the Claude Code and Codex skill.
  • Unity and a generic SDK for web apps and custom engines are marked coming soon.

Projects#

A project's page shows the same checklist, its environments, and its builds.

Environments#

Each tile shows the environment's state (stopped, starting, running, sleeping or failed), map, region, server count and size, and budget. Create the environment asks for:

FieldMeaning
Name and short nameSuch as Test and test. Developers deploy only to dev and test.
RegionWhere its servers run. It can't change later: another region is another environment.
MapThe Unreal map your servers open: its package path, such as /Game/Maps/World.
Server sizeStandard (1 vCPU, 2 GiB), Plus (2 vCPU, 4 GiB) or Max (4 vCPU, 8 GiB): 1×, 2× or 4× server time.
Most serversThe zone never runs more than this at once.
Spare servers kept readyWarm servers: booted and idle, billed like any server.
Hourly budgetThe most the zone may spend, USD an hour. Empty: no budget.
Sleep afterMinutes with no players before the zone sleeps. Empty: never.
AdvancedZone half-size (metres from the map's origin), server capacity, fewest servers, and extra server arguments.

Builds#

The project's builds, newest first, with their state and progress: uploading, checking, imaging, starting, then ready, rejected (with the reason) or failed (with try again, which images it again without another upload). The page follows a build's progress by itself.

  • Upload a build: a version label and the server archive, a zip of the packaged LinuxServer folder (see packaging).
  • A server image already in your registry: a version label and the image by digest (registry/repository@sha256:...), for hosted zones.

Uploading needs an active subscription.

An environment's page#

  • Zone: its state. While running: Players connect to, the gateway's host:port with a copy button; the number of player accounts; its servers; and Open in Atlas. A stopped zone can be started again with the build it last ran.
  • Deploy: choose a ready build and deploy it. Deploying an older build rolls back. Stop the zone stops its servers and gateway.
  • Settings: the same fields as at creation, except the region and short name. A running zone takes changes at its next deploy.
  • Secrets: names and when each was set. Set a secret with a name (capitals, digits and _) and a value of up to 4 KiB, which is never shown again. Setting one again replaces it.

Atlas#

Open in Atlas on a running zone opens WorldPlane's live map of it in the same tab: the servers' areas, and every player and NPC coloured by the server that owns it. Anyone who may read the environment can open it. When the panel can't reach the zone's live feed, the card says so instead of showing the button.

Billing & usage#

  • This month is the spend so far (UTC month), with server-hours and USD per environment. Server-hours count bigger servers as several: an hour of a plus server is 2.
  • Invoices & payment at Stripe opens Stripe's customer portal: payment method, invoices, billing details and tax ID, and cancelling.
  • Monthly spend limit: once this month's server time reaches it, new deploys stop; running zones keep running, each capped by its own budget. Leave it empty for no limit.