The SpawnWeaver SDK is a single Godot addon: addons/spawnweaver/. Install it with the one-line script or by copying the folder, enable the plugin, and paste your project key.

Requirements

Requirement Version
Godot 4.3 or newer
Renderer / platform Any — the SDK is pure GDScript over WebSockets

Install methods

Run from your Godot project root — the folder that contains project.godot:

iwr https://spawnweaver.dev/install.ps1 -UseBasicParsing | iex   # Windows

curl -fsSL https://spawnweaver.dev/install.sh | bash             # macOS / Linux

The script downloads the packaged addon (/sdk/spawnweaver.zip) from the server and extracts it into addons/spawnweaver/.

Manual install

Copy the addons/spawnweaver/ folder from the SDK repository into your project so you end up with:

your-game/
  project.godot
  addons/
    spawnweaver/
      spawnweaver.gd        # the autoload — the whole client API
      plugin.gd / plugin.cfg
      models/               # SWResult, SWError, SWPlayer, SWRoom, SWRoomSummary
      nodes/                # SpawnSync, PlayerSpawner
      editor/               # the SpawnWeaver dock
      templates/            # starter scene generated by the dock

Enable the plugin

Project → Project Settings → Plugins → enable "SpawnWeaver".

Enabling the plugin registers three things:

What Details
Autoload SpawnWeaver at /root/SpawnWeaver — the entire client API
Editor dock Right panel: key/server config, Test connection, live counts, starter scene generator
Node types SpawnSync and PlayerSpawner, available in the Create Node dialog

Configure

Open the SpawnWeaver dock, paste your project key (pk_… from the dashboard), and click Save, then Test connection.

The dock has three fields:

Field Meaning
Project key Your pk_… public key
Server WebSocket URL. Leave empty for the hosted service (wss://spawnweaver.dev/connect); use ws://127.0.0.1:5159/connect for a local server
Environment A label for your own bookkeeping: production, staging, or development

The config file: res://spawnweaver.cfg

The dock writes a plain Godot ConfigFile at your project root:

[spawnweaver]

project_key="pk_your_public_key"
server_url="wss://spawnweaver.dev/connect"
environment="production"
  • project_key — required. The public key is safe to ship and safe to commit; add the file to .gitignore only if you prefer to keep keys out of a public repo.
  • server_url — optional; defaults to the hosted service.
  • debug — optional boolean; true turns on SDK console logging (same as SpawnWeaver.set_debug_enabled(true)).

The file lives at the project root (not inside addons/) so addon upgrades never touch it, and the dock never overwrites a custom server URL.

Configuration resolution order

When SpawnWeaver.start() runs, values are resolved in this order — first hit wins:

  1. SpawnWeaver.configure("pk_…", "wss://…") called in code before start()
  2. user://spawnweaver_override.cfg — per-machine override used by local tooling and tests; never ship this file
  3. res://spawnweaver.cfg — the file the dock writes
  4. Built-in default server URL (wss://spawnweaver.dev/connect)
# Optional: skip the config file entirely and configure in code.
SpawnWeaver.configure("pk_your_public_key", "ws://127.0.0.1:5159/connect")
await SpawnWeaver.start()

Upgrading

Re-run the one-line installer from your project root. It replaces addons/spawnweaver/ with the latest version; your res://spawnweaver.cfg and any scenes using SpawnSync/PlayerSpawner are untouched. After upgrading, restart the editor so the plugin reloads cleanly.

Verify the install

  1. The SpawnWeaver dock appears in the right panel.
  2. Test connection in the dock reports success.
  3. From any script: print(SpawnWeaver.SDK_VERSION) prints the SDK version.

If the dock is missing or scripts report SpawnWeaver as undeclared, the plugin is not enabled — see Troubleshooting.

Next