Use this reference to connect to SoulFire, control bots, and run server tasks. It documents the SDK source and generated protocol types for the version in the page title. For a first bot, start with the TypeScript tutorial.
| Goal | Start here |
|---|---|
| Connect or install SoulFire | SoulFire, SoulFireClient |
| Provision accounts in an instance | SoulFireInstance |
| Start a bot, read state, or perform actions | SoulFireBot |
| Run and inspect server jobs | SoulFireTasks, SoulFireTask |
| Observe events and maintain live state | BotSession |
| Query or change inventory | SoulFireInventory |
| Discover and execute routes | SoulFirePathfinder |
SDK operations return lazy Effects or Streams. Read connection and bot lifecycle for setup, readiness, cleanup, and timeouts. Read task execution for results, progress, and cancellation ownership.
createBot.Modules under generated/ expose protobuf services and wire types.
Use them when the application needs fields outside the high-level helpers.
They remain fully documented alongside the public SDK.
The SDK guides explain workflows and game concepts. The recipes contain complete programs. The Python reference covers the same protocol with Python conventions.