Developer Setup

This page walks through the one-time setup required to connect a Softfire game to the Worldweave platform.

Create a developer account

Go to portal.softfire.dev and click Create Account. Use the same email you want billing notifications sent to — you can add additional team members later. After confirming your email, log in and you will land on the developer dashboard.

Register your game

In the dashboard, click My Games → Register New Game. Fill in the following fields:

Field	Notes
Display name	Shown to players in achievement notifications and the social layer
Description	One or two sentences describing the game
Platform targets	Tick all platforms you plan to ship on
Genre	Select the closest genre — used for matchmaking pool defaults

After saving, your game receives a permanent Game ID (a UUID). This ID never changes — it is safe to embed in code and assets.

Copy your API key

On the game’s detail page, click API Keys → Show Key. Your initial API key is shown once. Copy it immediately and store it in your team password manager or secrets service. If you lose it, rotate the key (see below) — you cannot retrieve the original.

API keys have the format ww_live_ for production and ww_dev_ for development environments. Always use a ww_dev_ key for local development so that test sessions do not count against your MAU.

Caution

Never commit your API key to source control. Add Worldweave.ww-config.json to your .gitignore and distribute it to team members out-of-band. Exposed production keys should be rotated immediately.

Add WorldweaveClientConfig to your project

Create Content/Worldweave.ww-config.json in your game project:

{
  "gameId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "apiKey": "ww_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "environment": "production"
}

Register it in your MGCB .mgcb pipeline file:

/build:Worldweave.ww-config.json

The engine detects and loads this asset automatically at startup. No code changes are required to activate the Worldweave client.

For local development, create a second config file (Worldweave.dev.ww-config.json) with your ww_dev_ key and "environment": "development". Use a build define or a directory-level content reference to switch between the two.

Test the connection

In the Softfire editor, open Project Settings → Worldweave. If the config file is present and the project has been built at least once, you will see:

• Your registered game name
• Current MAU count and tier
• A Test Connection button

Click Test Connection. The editor will attempt to authenticate against the Root using your API key. A green status indicator and session ID confirm success. A red indicator shows the error response from the Root — common causes include a malformed key, a revoked key, or a network firewall blocking root.softfire.dev.

Key rotation

Rotate your API key when:

• A team member with access to the key leaves
• The key is exposed in a public repository or log file
• You are transitioning from development to a production release

In the developer portal, go to My Games → [Your Game] → API Keys → Rotate Key. A new key is generated immediately. The old key continues to work for a 24-hour overlap window, giving you time to deploy the new config. After 24 hours the old key is revoked automatically.

Tip

Schedule routine key rotation into your annual security checklist. The 24-hour overlap window means rotation is low-risk — deploy the new config during off-peak hours and verify the connection before the overlap window closes.

Revoking a specific key

If you have multiple keys (development, CI, production) and need to revoke one immediately without waiting for the overlap window, use Revoke on the specific key in the portal. This takes effect within 60 seconds.