Skip to content

docs(project): update the documentation for the Part 1 delivery - #11

Merged
AdryzR merged 5 commits into
mainfrom
docs/project/part1-update
Oct 18, 2026
Merged

AdryzR merged 5 commits into
mainfrom
docs/project/part1-update

Conversation

@AdryzR

@AdryzR AdryzR commented Oct 18, 2026

Copy link
Copy Markdown
Contributor

📝 Description

  • Getting started: Linux and Windows are both supported (Visual Studio 2022 requirements, --config Release), the client finds its assets from any working directory, controls table (keyboard and gamepad), note that the client does not talk to the server yet.
  • Protecs (new page): shared library (sockets, Packet, packet types, shared components, PacketError). The networking section leaves the Wrecks page; the Wrecks ECS example declares ATTRIBUTES, and SequenceContainer is listed under utilities. Index, architecture diagrams and technical study now show Protecs.
  • Protocol: packets are 24 bytes, five packet types with their byte layout (EntityPosition is now type 1), new u16 and bits64 types. Layouts checked by serializing real packets with Protecs 2da1ef9.
  • Client: the playable local game: game loop with the update / render stages, the ten systems, controls, asset lookup, next steps. Accessibility marks remappable controls, gamepad and hold-to-fire as available.
  • Server: current layout, network thread and ThreadQueue, players, PacketError handling, updated next steps.

🎯 Why is this change needed?

The documentation is graded at the Part 1 defense and described code that changed today.

Closes #10

🧩 Impacted component

  • server (Multiplayer & game logic)
  • client (Graphical game)
  • ECS (Wrecks engine)
  • ci (GitHub Actions / Hooks)
  • docs (Documentation)

🧪 How to test manually?

  1. python3 -m venv .venv && .venv/bin/pip install -r requirements.txt
  2. .venv/bin/mkdocs build --strict passes with no warning
  3. .venv/bin/mkdocs serve and read the Getting started, Protecs, Protocol, Client and Server pages

✅ Author checklist

  • I ran the build locally (cmake --build build) and there is no compilation error. (mkdocs build --strict)
  • I checked that the pre-commit hooks (clang-format) passed. (no hooks configured yet)
  • The PR title follows the team conventions (e.g. feat(server): ...).
  • I updated the relevant documentation if needed.

@AdryzR
AdryzR merged commit 58a0b65 into main Oct 18, 2026
2 checks passed
@AdryzR
AdryzR deleted the docs/project/part1-update branch October 18, 2026 20:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(project): update the documentation for the Part 1 delivery

1 participant