Files
Commonwealth-Online-Public/protocol
andrew d724d7404c Document local networking prototype and protocol
Expand documentation to describe the current local networking prototype and its protocol. Adds a Current Architecture section and Fake Client responsibilities, clarifies that the Fallout 4 plugin currently only sends transforms (no receive loop yet), and documents implemented message types (welcome, transform, disconnect) with packet field descriptions and examples. Update player-sync and packets docs to reflect movementType, server/client timestamps, and the in-memory remote player state model used by server/fake_client.py. Flesh out server/README with run/test flow and implemented behavior. Revise dev-log with milestone entries, testing notes, and an entry template for future updates.
2026-05-31 19:28:58 +12:00
..
2026-05-30 18:13:54 +12:00
2026-05-30 18:13:54 +12:00

Protocol

This folder documents the planned network protocol for Fallout 4 Together.

The first protocol should be simple and focused on player transform sync.

First Packet Types

  • Welcome packet
  • Transform packet
  • Disconnect packet

Future Packet Types

  • Animation state packet
  • Fire weapon packet
  • Health packet
  • Chat packet
  • Cell change packet

Design Goals

The protocol should be:

  • Simple
  • Easy to debug
  • Versioned
  • Safe to extend
  • Clear enough to test outside Fallout 4

Early Testing

The protocol should be testable using fake clients before being connected to Fallout 4.