Skip to content
Browse documentation

Agents and API resources

Give your tools the same kit information and guides that power the website.

View Markdown
On this page

Find the right resource

ResourceUse it for
llms.txtAn index of the maintained guides and discovery files.
Kit catalogKit IDs, supported combinations, dependencies, scripts, and download URLs.
OpenAPI documentThe public catalog and curated download endpoint contracts.
auth.mdSupported sign-in behavior and current limitations.
Agent skill ZIPA reusable skill with create, extend, publish, and authentication references.

Every guide also has a Markdown version. Use Copy as Markdown at the top of a guide, or choose View Markdown to open the plain-text source. HTML and Markdown are generated from the same maintained content.

Read the kit catalog

HTTP · public catalog
GET https://spawnkit.cloud/catalog/v1.json

The response uses schemaVersion: 1 and describes rendering engines, physics, UI, telemetry, component requirements, and curated kits. Each kit includes its ID, download URL, and resolved scripts and dependencies.

Resolve supported combinations before generating or changing a project. Use IDs returned by the catalog; do not assume that any arbitrary combination of engines and modules is supported.

JavaScript · find a kit download
const response = await fetch('https://spawnkit.cloud/catalog/v1.json')
if (!response.ok) throw new Error(`Catalog request failed: ${response.status}`)

const catalog = await response.json()
const kit = catalog.kits.find((kit) => kit.id === 'phaser')
if (!kit) throw new Error('Kit unavailable')

console.log(kit.downloadUrl)
console.log(kit.scripts)

Run this example in Node.js 24 or in your agent's tooling. Downloaded archives contain standalone source projects; downloading one does not install dependencies or run the game.

Use the SpawnKit skill

Download the SpawnKit skill ZIP, extract the spawnkit folder, and add it using your agent's documented skill-installation mechanism.

Skill package
spawnkit/
├── SKILL.md
└── references/
    ├── create.md
    ├── extend.md
    ├── publish.md
    └── authentication.md

The skill directs your agent to the relevant guide. The project's AGENTS.md adds its own setup and validation instructions. Read and preserve any instructions already present in an existing game.

API coverage and responses

The OpenAPI document covers the public catalog and curated kit downloads. Authenticated project, billing, and administrative APIs are outside its scope. For the implemented command interface, see the CLI reference.

ResponseMeaning
200The requested resource is available.
404The kit or resource does not exist. Refresh the catalog before retrying an old kit ID.
405The HTTP method is unsupported. Read the Allow header; downloads support GET and HEAD.

Catalog v1 changes are additive. Clients should ignore unknown fields; breaking changes require a new versioned path. Prefer the URLs returned by the catalog over constructing download paths.

Automating an existing CLI

@spawnkit/cli supports --json for machine output. See CLI installation for package-runner and global installation commands.

  • Successful commands write their JSON result to stdout.
  • Login writes newline-delimited authorization and completion records.
  • Live build progress goes to stderr; a failure returns a JSON error there and exits nonzero.
  • Use --dry-run --json to inspect a mutation. JSON mode is noninteractive; mutations require --yes.
  • Check returned status fields and preserve operation IDs when resuming or retrying.

See CLI deployment and recovery for the command sequence, and Accounts and access for local sign-in behavior.

Need a hand? Get support

Explore the guides

Build your first game

Download a standalone game kit, run it locally, and make your first change.

Create and build a game with @spawnkit/cli

Start in a parent folder, generate your game, then run every development command inside the new game folder.

Upload an existing browser game

Upload a self-contained browser build. Your original source, engine, and build tools can stay as they are.

Publish your game

The dashboard accepts a ZIP of your built game. You will need an account to deploy it.

Use the SpawnKit dashboard

The dashboard manages your hosted games. Your editor or AI agent remains where you change and build your game source.

Make a browser game with Codex

Use Codex with a standalone TypeScript game kit. Start with a working scene and improve it one playable change at a time.

Make a browser game with Claude Code

Use Claude Code with a standalone TypeScript game kit. Start with a working scene and improve it one playable change at a time.

Make a browser game with Cursor

Use Cursor with a standalone TypeScript game kit. Start with a working scene and improve it one playable change at a time.

Extend your game

Find the right files, make a focused change, and check it in a playable build.

A complete publishing example

Follow a small example from editable source to a ZIP with index.html at its root. Use your own game title, description, and artwork.

Add tools to an existing game

Keep a recoverable baseline, inspect the proposed changes, and verify one addition at a time.

Test and debug your game

Combine automated checks with a short playthrough of the production build. A successful build alone does not verify gameplay.

Project structure and configuration

Your downloaded kit is a standalone TypeScript project. Its files belong to you and do not depend on the SpawnKit repository.

SpawnKit CLI reference

A command-by-command reference to the implemented CLI. Local generation works without an account; hosted operations require access to a project.

Accounts and access

Building locally is account-free. Publishing requires an account with access to the target project.

Agents and API resources

Public discovery endpoints are account-free. Use the dashboard or @spawnkit/cli for publishing.

16 guides available