towerdef/docs/PROTOCOL.md
Claude 107ef60ec6 Add Netwall solo client, shared simulation core and protocol spec
- public/js/sim.js: pure game rules shared by browser and server (flow-field
  pathing with no corner cutting, placement validation that can never seal the
  route, towers, enemies, waves, economy, snapshots)
- Responsive canvas client: desktop, landscape and portrait phones (board
  rotates 90 degrees in portrait), mouse + touch input, pinch zoom/pan,
  tap-to-preview placement, route preview, effects, synth sfx + music
- Local and Remote controllers behind one interface (remote: snapshot
  interpolation, auto-reconnect, seat resume)
- docs/PROTOCOL.md: co-op wire protocol and server requirements
- README, PWA manifest and icons, 20 sim unit tests

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Tb8pW2KAN4oFkh1aK1BfD8
2026-10-09 19:14:35 +00:00

9.8 KiB

Netwall multiplayer protocol (v1)

Two people play the same map together: one shared base, one shared credit pool, one shared set of lives. The Node server runs the game (the same public/js/sim.js the browser uses for solo play) and is the single source of truth. Clients send commands; the server steps the simulation and broadcasts snapshots. Clients never simulate in multiplayer; they render (with interpolation) what the server says.

Transport: one WebSocket per player at ws(s)://<host>/ws, JSON text frames, one object per frame, field t = message type. Client -> server frames are capped at 2048 bytes (maxPayload).

Server

server/index.js exports createServer(opts) and, when run directly (node server/index.js), starts it.

createServer({ port = 8080, host = '::', publicDir = <repo>/public,
               graceMs = 60000, snapshotHz = 20, maxRooms = 50,
               trustProxy = 'auto', allowedOrigins = [], maxConnPerIp = 40, pingMs = 25000, log = console.log })
  -> Promise<{ port, addresses: string[], close(): Promise<void>, rooms: Map }>

Env when run directly: PORT (8080), HOST (::), TRUST_PROXY (auto|1|0), ALLOWED_ORIGINS (comma separated, e.g. https://game.example.com), MAX_CONN_PER_IP, GRACE_MS. Prints http://localhost:PORT/ and every non-internal LAN URL from os.networkInterfaces() (IPv4 as http://a.b.c.d:PORT/, IPv6 as http://[addr]:PORT/, skip link-local fe80::). Handles SIGINT/SIGTERM by closing sockets and exiting 0.

Dual stack

Default host is :: and the listen call must pass ipv6Only: false so that one socket serves IPv4 and IPv6 (IPv4 arrives as ::ffff:a.b.c.d; normalise it for logs). If binding :: fails with EAFNOSUPPORT, EADDRNOTAVAIL or similar (IPv6 disabled in the container), fall back to 0.0.0.0 and log that. Any explicit host (e.g. 127.0.0.1 in tests, or HOST=0.0.0.0) is honoured as given. addresses lists what is bound.

Behind a reverse proxy (nginx Proxy Manager, nginx, Caddy, Traefik)

The server is meant to sit behind TLS-terminating proxies with "Websockets Support" enabled and must work both at a domain root and under a path prefix the proxy strips.

  • Keep-alive. Proxies drop idle connections (nginx proxy_read_timeout defaults to 60 s). Every pingMs the server sends a WebSocket protocol ping to each socket and terminates sockets that did not pong since the previous round (so a dead mobile client is noticed within ~2 rounds and goes into the grace period).
  • Real client IP is used only for logging and the per-IP socket cap maxConnPerIp. trustProxy:'auto' means: if the TCP peer is loopback / RFC1918 / fc00::/7 / link-local, take the first address of X-Forwarded-For (else X-Real-IP) as the client IP; otherwise use the TCP peer and ignore those headers. true/false force it. maxConnPerIp: 0 disables the cap. Reject extra sockets with HTTP 429 on upgrade.
  • Origin check (see below) accepts: Origin host == Host header; or == X-Forwarded-Host when the proxy is trusted; or the Origin is listed in allowedOrigins. Compare scheme-less host[:port], treat default ports (80/443) as equal to "no port", case-insensitive.
  • No absolute URLs, no hard-coded port anywhere in served content; the client builds the socket URL relative to the page (new URL('ws', location.href) with http->ws, https->wss), so https://x.example/netwall/ proxied to / works. The server therefore accepts the upgrade on path /ws only (the proxy strips any prefix).
  • HEAD/GET /healthz returns 200 ok for proxy health checks.
  • Do not trust X-Forwarded-Proto for anything security relevant.
  • Disable ws per-message-deflate (default for the server) - snapshots are small and CPU is better spent elsewhere.

HTTP

  • GET|HEAD of files under public/ only. / -> index.html. Correct MIME (html, js, css, json, svg, png, jpg, ico, woff2, mp3, ogg, wav, txt). Cache-Control: no-cache.
  • Path traversal (.., %2e%2e, %2f, backslash, NUL, absolute paths, dotfiles) -> 400/404, never a file outside public/. Other methods -> 405.
  • GET /healthz -> 200 ok.
  • Headers on every response: X-Content-Type-Options: nosniff, Referrer-Policy: no-referrer, Content-Security-Policy: default-src 'self'; connect-src 'self' ws: wss:; img-src 'self' data:; style-src 'self' 'unsafe-inline'; media-src 'self' data:; base-uri 'none'; frame-ancestors 'none'.

WebSocket upgrade

  • Only on path /ws. If the request has an Origin header, its host must equal the Host header, else 403 (stops random web pages from driving a LAN server). No Origin (non-browser clients/tests) is fine.
  • A socket that has not sent a valid join within 10 s is closed (4408).
  • Per-socket rate limit: token bucket 60 msg/s, burst 120; beyond that close with 4429.
  • More than 20 malformed/unknown messages on a socket -> close 4400.

Handshake

Client's first message:

{ t:'join', pid, name, room?, map? }
  • pid ^[A-Za-z0-9_-]{8,40}$ - random, generated by the client, kept in sessionStorage (stable across reloads).
  • name any string; server trims, strips control chars, caps at 16 chars, default "Player".
  • room absent -> create a room. map must be a key of TD.MAPS (default 'open'). Server generates a 4 character code from ABCDEFGHJKLMNPQRSTUVWXYZ23456789, unique among rooms.
  • room present (^[A-Za-z0-9]{4}$, case-insensitive -> upper-cased) -> join.

Failure: { t:'error', code, msg } then the server closes the socket (code 4000+). Codes: bad_request, no_room, full (two other pids already hold the slots), too_many_rooms, bad_map.

Success: reply to the joiner

{ t:'joined', room, resumed, you:{ pid, slot, host },
  players:[ { pid, slot, name, host, online } ],      // everyone incl. you
  state:  <sim.fullState()>,   snap: <sim.snapshot()>,  speed, paused }

then broadcast { t:'players', players:[...] } to all other players.

  • A player owns a slot (0 or 1), the lowest free one, kept until they leave for good.
  • Host = creator; if the host leaves for good the other player becomes host.
  • Reconnect: a join whose pid already holds a slot in that room re-binds to it (resumed:true); the old socket, if still open, is closed with 4001. No full error for the pid that owns the slot.
  • Grace: when a socket closes the player stays in the room with online:false for graceMs, then is removed (and players re-broadcast). A player who sent {t:'leave'} is removed immediately.
  • The simulation only ticks while at least one player is online. A room with no one left is deleted.

Client -> server (after joining)

message meaning
{t:'cmd', c:'place', type, x, y} build. Server calls sim.cmd({...msg, by: slot}) (never trust a by from the client)
{t:'cmd', c:'sell', id} / 'upgrade' id / 'target' id,mode / 'wave' / 'auto' v / 'continue' other sim commands, same path
{t:'ctl', c:'pause', v:bool} / {t:'ctl', c:'speed', v:1|2|3} room-level; reflected in snap.pa / snap.sp
{t:'cursor', x, y} hover position in cell units (floats) or x:null to hide; clamp to board, round to 2 dp
{t:'mark', x, y} map ping; at most 1 per 400 ms per player; server broadcasts mark (below)
{t:'rtt', ts} latency probe; reply immediately with the same ts
{t:'sync'} ask for a full state resend
{t:'newgame', map} host only: replace the sim with a fresh new Sim({map}); resets pause/speed
{t:'leave'} leave now

Command validation is the server's job: t:'cmd' must carry a string c in the whitelist above; unknown c, non-object, etc. count as malformed. A command the sim refuses ({ok:false, reason}) gets { t:'reject', c, reason, x?, y?, id? } sent to the sender only (echo x,y/id when present). Successful commands send nothing extra; the effect arrives via snap. newgame from a non-host -> reject with reason:'not_host'; newgame with a bad map -> reject bad_map.

Server -> client

{ t:'snap', seq, ...sim.snapshot(), ev:[ ...sim.drainEvents() ],
  cur:[ [slot, x, y], ... ],            // other players' cursors (only those currently set), all players included
  pa:0|1, sp:1|2|3,
  tw?: sim.towerList() }                // ONLY when sim.rev changed since the previous snap was sent to the room
{ t:'state', state:<fullState>, snap:<snapshot>, speed, paused, newgame?:true }   // reply to sync / newgame
{ t:'players', players:[...] }
{ t:'mark', slot, x, y }                // to everyone in the room, including the sender
{ t:'rtt', ts }
{ t:'reject', c, reason, ... }
{ t:'error', code, msg }
  • seq increments by 1 per snapshot per room.
  • Snapshots are sent every 1000/snapshotHz ms whether or not the sim advanced (paused rooms still send, so cursors keep moving) but only to online players, and only if at least one player is online.
  • ev events are drained from the sim once per snapshot, so every client sees every event exactly once.
  • Because WebSocket is reliable and ordered, tw deltas cannot be lost; snap.rev lets a client detect a bug/desync (rev differs from the rev it last applied and no tw came along) and ask for sync.

Tick loop

Fixed step TD.STEP (1/60 s) with an accumulator driven by process.hrtime.bigint(); real time elapsed is multiplied by speed (1-3) and ignored while paused; clamp elapsed per iteration to 250 ms so a stalled event loop does not fast-forward the game. Drive it with a setInterval of ~8 ms (or setTimeout chain) per room, or one global loop for all rooms. Must keep working with several rooms at once.

Events (ev), produced by the sim

place, sell, up, shot, arc, boom, kill, leak, wave, clear, win, lose (see sim.js). Treat them as opaque JSON.