Skip to content

Pure-GDScript multiplayer signaling for Godot 4

Signal Fish Godot Client

A drop-in Godot 4 addon for the Signal Fish protocol. Copy one folder, add a SignalFishClient node, and connect, join rooms, and relay game data with typed methods and signals. The relay client needs no C#, GDExtension, or compilation and supports web exports. Native mesh builds need the Godot WebRTC extension.

AI disclosure

This project was developed with substantial assistance from Claude and Codex. Humans created the protocol concepts and core design and retained oversight of architecture and code review.

Get started View on GitHub

Release status

Work in progress toward v1. The full v2 protocol surface and the v3 session-plan signaling are shipped and covered by deterministic fixture tests. The addon is on the Godot Asset Library; releases update that listing automatically.

Get connected

  1. Copy addons/signal_fish/ into your project.
  2. Create a SignalFishConfig, set app_id and endpoint_url.
  3. Add a SignalFishClient node and call connect_to_server().
  4. Handle authenticated, then join_room().
  5. Send and receive game data; everything is polled, never blocked.

The quick start has the full first client. The demo project ships runnable relay and P2P scenes.

Pick the right path

If you are building Start with
A Godot 4 native or web game on the relay path SignalFishClient and the quick start
A game that needs binary game data Game Data (message_pack negotiation)
A game that must survive disconnects Reconnection & Replay
A game with direct peer-to-peer traffic Protocol v3 and the mesh guide after the relay path works
A browser export Web Export rules, then the same relay path

Read by task

  • Installation & Quick Start


    Install the addon, connect, authenticate, and join a room.

    Quick Start

  • Client API Reference


    Config, lifecycle methods, send methods, and state machines.

    Client API Reference

  • Events


    One signal per server event, with typed payload objects.

    Events

  • Errors


    The error-code enum, sentinels, and where each error surfaces.

    Errors

  • Game Data


    JSON, MessagePack, and binary frames.

    Game Data

  • Reconnection & Replay


    Tokens, missed-event replay, and opt-in auto-reconnect.

    Reconnection

  • Web Export


    Browser rules: wss://, Origin, storage, and polling.

    Web Export

  • Deterministic Testing


    Fixture suites, fake transports, and the CI entry point.

    Testing

  • :material-mesh:{ .lg .middle } Mesh (v3)


    Turn v3 session plans into a WebRTCMultiplayerPeer mesh.

    Mesh Guide