WorldForge Studio

Docs / SDK guides

SDK guides

Install @blueforge-studio/worldforge-sdk, mint an API key, and integrate: typed REST client, offline world tools, realtime and MCP — in that order.

  1. 00

    00 — Quickstart

    Install the WorldForge SDK, mint an API key, and read a world in three steps.

  2. 01

    01 — Authentication

    Two actor kinds, one header: API keys for integrations, JWTs for first-party sessions.

  3. 02

    02 — Worlds and resources

    The typed REST surface: one client object, a resource module per route group, and a raw escape hatch for everything else.

  4. 03

    03 — Offline world tools

    Work with .gas-world documents without a server: validate, migrate, edit lore, and read the calendar — the world-engine bundled into the SDK.

  5. 04

    04 — Realtime

    The live view over SSE and the collaborative Yjs document over the realm WebSocket.

  6. 05

    05 — MCP client

    The server's Model Context Protocol endpoint, wrapped: /mcp subpath over the official @modelcontextprotocol/sdk.

  7. 06

    06 — Troubleshooting & versioning

    Install problems, runtime limits, and how SDK versions relate to the server and the world-schema ladder.