protocol

Imported from ysle0/highp-mmorpg (protocol/AGENTS.md). Install upstream with npx skills add ysle0/highp-mmorpg --skill protocol. Copyright stays with the author.

protocol

Purpose

FlatBuffers-based protocol library. Contains schemas defining the wire format and generated C++ serialization headers. Provides the shared message contract between server and client under the namespace highp::protocol.

Key Files

Subdirectories

For AI Agents

Working In This Directory

• Do not manually edit files inside flatbuf/gen/ - they are auto-generated.
• After modifying any .fbs schema under flatbuf/schemas/, run the generation script:

  powershell -ExecutionPolicy Bypass -File scripts/gen_flatbuffers.ps1

• The Visual Studio project (protocol.vcxproj) references both the schema files and the generated headers. Keep the filters file (protocol.vcxproj.filters) in sync if adding new schemas.

Common Patterns

• All protocol types live under the highp::protocol namespace (defined in generated headers).
• The root wire type is Packet (see flatbuf/gen/packet_generated.h). All messages are wrapped in a Packet before being sent over the wire.
• Use flatbuffers::FlatBufferBuilder to construct messages and flatbuffers::GetRoot<highp::protocol::Packet>() to deserialize.

Dependencies

Internal

• lib/ - shared utilities (logging, error handling)
• network/ consumes this library to decode incoming buffers and encode outgoing messages

External

• FlatBuffers (Google) - schema compiler (flatc) and runtime headers