NexQuake / Documentation
brsm.dev Docker GitHub

Relay Package

WebSocket-to-UDP relay package for NQ (NetQuake) dedicated game servers.

Import path: github.com/0xBrsm/NexQuake/nexus/nqrelay Module: github.com/0xBrsm/NexQuake/nexus (src/nexus/go.mod) Versioned with: NexQuake commits/tags (not a separate module)

Full API documentation is in the Go source — run go doc ./... or visit pkg.go.dev.

Vendoring checklist

  1. Frame format is fixed: 2-byte big-endian port header + payload. Keep client and relay in sync.
  2. Port 0 is the control channel. Define your own payload semantics in HandleControlFrame.
  3. Override Upgrader.CheckOrigin for production deployments.
  4. Set IsAllowedPort to restrict clients to specific UDP destinations.
  5. Keep sourceKey stable across reconnects if deterministic virtual-IP identity matters.