mirror of https://github.com/Kelsidavis/WoWee.git synced 2026-04-02 03:33:51 +00:00

Kelsi dab534e631 docs: fix stale references across 10 documentation files

- CONTRIBUTING.md: C++17 → C++20 (matches CMakeLists.txt)
- TROUBLESHOOTING.md: fix log path (~/.wowee/logs/ → logs/wowee.log)
- docs/authentication.md: remove stale "next milestone" (char enum
  and world entry have been working for months)
- docs/srp-implementation.md: update session key status (RC4 encryption
  is implemented), fix file reference to actual src/auth/srp.cpp
- docs/packet-framing.md: remove stale "next steps" (realm list is
  fully implemented), update status with tested servers
- docs/WARDEN_IMPLEMENTATION.md: fix file list — handler is in
  warden_handler.cpp not game_handler.cpp, add warden_memory.hpp/cpp
- docs/WARDEN_QUICK_REFERENCE.md: fix header/source paths (include/
  not src/), add warden_handler and warden_memory
- docs/quickstart.md: fix clone command (--recurse-submodules, WoWee
  not wowee), remove obsolete manual ImGui clone step, fix log path
- docs/server-setup.md: update version to v1.8.9-preview, date to
  2026-03-30, add all supported expansions
- assets/textures/README.md: remove broken doc references
  (TURTLEHD_IMPORT.md, TEXTURE_MANIFEST.txt), update integration
  status to reflect working PNG override pipeline

2026-03-30 18:33:21 -07:00

2.8 KiB

Raw Blame History

Contributing to Wowee

Build Setup

See BUILD_INSTRUCTIONS.md for full platform-specific details. The short version: CMake + Make on Linux/macOS, MSYS2 on Windows.

cmake -B build -DCMAKE_BUILD_TYPE=Debug
make -C build -j$(nproc)

Code Style

C++20. Use #pragma once for include guards.
Namespaces: wowee::game, wowee::rendering, wowee::ui, wowee::core, wowee::network.
Conventional commit messages in imperative mood:
- feat: new feature
- fix: bug fix
- refactor: code restructuring with no behavior change
- perf: performance improvement
Prefer constexpr over static const for compile-time data.
Mark functions whose return value should not be ignored with [[nodiscard]].

Pull Request Process

Branch from master.
Keep commits focused -- one logical change per commit.
Describe what changed and why in the PR description.
Ensure the project compiles cleanly before submitting.
Manual testing against a WoW 3.3.5a server (e.g. AzerothCore/ChromieCraft) is expected for gameplay-affecting changes.

Architecture Overview

See docs/architecture.md for the full picture. Key namespaces:

Namespace	Responsibility
`wowee::game`	Game state, packet handling (`GameHandler`), opcode dispatch
`wowee::rendering`	Vulkan renderer, M2/WMO/terrain, sky system
`wowee::ui`	ImGui windows and HUD (`GameScreen`)
`wowee::core`	Coordinates, math, utilities
`wowee::network`	Connection, `Packet` read/write API

Packet Handlers

The standard pattern for adding a new server packet handler:

Define a struct FooData holding the parsed fields.
Write void GameHandler::handleFoo(network::Packet& packet) to parse into FooData.
Register it in the dispatch table: registerHandler(LogicalOpcode::SMSG_FOO, &GameHandler::handleFoo).

Helper variants: registerWorldHandler (requires isInWorld()), registerSkipHandler (discard), registerErrorHandler (log warning).

Testing

There is no automated test suite. Changes are verified by manual testing against WoW 3.3.5a private servers (primarily ChromieCraft/AzerothCore). Classic and TBC expansion paths are tested against their respective server builds.

Key Files for New Contributors

File	What it does
`include/game/game_handler.hpp`	Central game state and all packet handler declarations
`src/game/game_handler.cpp`	Packet dispatch registration and handler implementations
`include/network/packet.hpp`	`Packet` class -- the read/write API every handler uses
`include/ui/game_screen.hpp`	Main gameplay UI screen (ImGui)
`src/rendering/m2_renderer.cpp`	M2 model loading and rendering
`docs/architecture.md`	High-level system architecture reference

2.8 KiB Raw Blame History