mirror of
https://github.com/Kelsidavis/WoWee.git
synced 2026-04-03 20:03:50 +00:00
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
This commit is contained in:
parent
c103743c3a
commit
dab534e631
10 changed files with 55 additions and 29 deletions
|
|
@ -12,7 +12,7 @@ make -C build -j$(nproc)
|
||||||
|
|
||||||
## Code Style
|
## Code Style
|
||||||
|
|
||||||
- **C++17**. Use `#pragma once` for include guards.
|
- **C++20**. Use `#pragma once` for include guards.
|
||||||
- Namespaces: `wowee::game`, `wowee::rendering`, `wowee::ui`, `wowee::core`, `wowee::network`.
|
- Namespaces: `wowee::game`, `wowee::rendering`, `wowee::ui`, `wowee::core`, `wowee::network`.
|
||||||
- Conventional commit messages in imperative mood:
|
- Conventional commit messages in imperative mood:
|
||||||
- `feat:` new feature
|
- `feat:` new feature
|
||||||
|
|
|
||||||
|
|
@ -151,9 +151,7 @@ Graphics Preset: HIGH or ULTRA
|
||||||
## Getting Help
|
## Getting Help
|
||||||
|
|
||||||
### Check Logs
|
### Check Logs
|
||||||
Detailed logs are saved to:
|
Detailed logs are saved to `logs/wowee.log` in the working directory (typically `build/bin/`).
|
||||||
- **Linux/macOS**: `~/.wowee/logs/`
|
|
||||||
- **Windows**: `%APPDATA%\wowee\logs\`
|
|
||||||
|
|
||||||
Include relevant log entries when reporting issues.
|
Include relevant log entries when reporting issues.
|
||||||
|
|
||||||
|
|
|
||||||
33
assets/textures/README.md
Normal file
33
assets/textures/README.md
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
# HD Texture Assets
|
||||||
|
|
||||||
|
**Source**: TurtleHD Texture Pack (Turtle WoW)
|
||||||
|
**Imported**: 2026-01-27
|
||||||
|
**Total Files**: 298 BLP textures
|
||||||
|
**Total Size**: 10MB
|
||||||
|
|
||||||
|
## Directory Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
textures/
|
||||||
|
├── character/
|
||||||
|
│ └── human/ # 274 human male textures
|
||||||
|
├── creature/ # 15 creature textures
|
||||||
|
├── item/ # (reserved for future)
|
||||||
|
└── world/
|
||||||
|
├── generic/ # 1 generic world texture
|
||||||
|
└── stormwind/ # 8 Stormwind building textures
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
These HD BLP textures are ready for integration with:
|
||||||
|
- **WMO Renderer**: Building texture mapping
|
||||||
|
- **Character Renderer**: M2 model skin/face textures
|
||||||
|
- **Creature Renderer**: NPC texture application
|
||||||
|
|
||||||
|
## Integration Status
|
||||||
|
|
||||||
|
Textures are loaded via the BLP pipeline and applied to WMO/M2 renderers.
|
||||||
|
HD texture overrides (e.g. TurtleHD packs) can be placed as PNG files
|
||||||
|
alongside the original BLP paths — the asset manager checks for `.png`
|
||||||
|
overrides before loading the `.blp` version.
|
||||||
|
|
@ -93,13 +93,16 @@ The RSA public modulus is extracted from WoW.exe (`.rdata` section at offset 0x0
|
||||||
## Key Files
|
## Key Files
|
||||||
|
|
||||||
```
|
```
|
||||||
|
include/game/warden_handler.hpp - Packet handler interface
|
||||||
|
src/game/warden_handler.cpp - handleWardenData + module manager init
|
||||||
include/game/warden_module.hpp - Module loader interface
|
include/game/warden_module.hpp - Module loader interface
|
||||||
src/game/warden_module.cpp - 8-step pipeline
|
src/game/warden_module.cpp - 8-step pipeline
|
||||||
include/game/warden_emulator.hpp - Emulator interface
|
include/game/warden_emulator.hpp - Emulator interface
|
||||||
src/game/warden_emulator.cpp - Unicorn Engine executor + API hooks
|
src/game/warden_emulator.cpp - Unicorn Engine executor + API hooks
|
||||||
include/game/warden_crypto.hpp - Crypto interface
|
include/game/warden_crypto.hpp - Crypto interface
|
||||||
src/game/warden_crypto.cpp - RC4 / key derivation
|
src/game/warden_crypto.cpp - RC4 / key derivation
|
||||||
src/game/game_handler.cpp - Packet handler (handleWardenData)
|
include/game/warden_memory.hpp - PE image + memory patch interface
|
||||||
|
src/game/warden_memory.cpp - PE loader, runtime globals patching
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -58,10 +58,11 @@ strict Warden enforcement in that mode.
|
||||||
## Key Files
|
## Key Files
|
||||||
|
|
||||||
```
|
```
|
||||||
src/game/warden_module.hpp/cpp - Module loader (8-step pipeline)
|
include/game/warden_handler.hpp + src/game/warden_handler.cpp - Packet handler
|
||||||
src/game/warden_emulator.hpp/cpp - Unicorn Engine executor
|
include/game/warden_module.hpp + src/game/warden_module.cpp - Module loader (8-step pipeline)
|
||||||
src/game/warden_crypto.hpp/cpp - RC4/MD5/SHA1/RSA crypto
|
include/game/warden_emulator.hpp + src/game/warden_emulator.cpp - Unicorn Engine executor
|
||||||
src/game/game_handler.cpp - Packet handler (handleWardenData)
|
include/game/warden_crypto.hpp + src/game/warden_crypto.cpp - RC4/MD5/SHA1/RSA crypto
|
||||||
|
include/game/warden_memory.hpp + src/game/warden_memory.cpp - PE image + memory patching
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -563,5 +563,4 @@ The client is now ready for character operations and world entry! 🎮
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Implementation Status:** 100% Complete for authentication
|
**Implementation Status:** Complete — authentication, character enumeration, and world entry all working.
|
||||||
**Next Milestone:** Character enumeration and world entry
|
|
||||||
|
|
|
||||||
|
|
@ -397,6 +397,4 @@ The authentication system can now reliably communicate with WoW 3.3.5a servers!
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Status:** ✅ Complete and tested
|
**Status:** ✅ Complete and tested against AzerothCore, TrinityCore, Mangos, and Turtle WoW.
|
||||||
|
|
||||||
**Next Steps:** Test with live server and implement realm list protocol.
|
|
||||||
|
|
|
||||||
|
|
@ -19,17 +19,11 @@ For a more honest snapshot of gaps and current direction, see `docs/status.md`.
|
||||||
### 1. Clone
|
### 1. Clone
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/Kelsidavis/WoWee.git
|
git clone --recurse-submodules https://github.com/Kelsidavis/WoWee.git
|
||||||
cd wowee
|
cd WoWee
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Install ImGui
|
### 2. Build
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/ocornut/imgui.git extern/imgui
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. Build
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
|
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
|
||||||
|
|
@ -96,7 +90,7 @@ Use `BUILD_INSTRUCTIONS.md` for distro-specific package lists.
|
||||||
|
|
||||||
- Verify auth/world server is running
|
- Verify auth/world server is running
|
||||||
- Check host/port settings
|
- Check host/port settings
|
||||||
- Check server logs and client logs in `build/bin/logs/`
|
- Check server logs and client logs in `logs/wowee.log`
|
||||||
|
|
||||||
### Missing assets (models/textures/terrain)
|
### Missing assets (models/textures/terrain)
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -609,6 +609,6 @@ Once you have a working local server connection:
|
||||||
---
|
---
|
||||||
|
|
||||||
**Status**: Ready for local server testing
|
**Status**: Ready for local server testing
|
||||||
**Last Updated**: 2026-01-27
|
**Last Updated**: 2026-03-30
|
||||||
**Client Version**: 1.0.3
|
**Client Version**: v1.8.9-preview
|
||||||
**Server Compatibility**: WoW 3.3.5a (12340)
|
**Server Compatibility**: Vanilla 1.12, TBC 2.4.3, WotLK 3.3.5a (12340), Turtle WoW 1.17
|
||||||
|
|
|
||||||
|
|
@ -351,13 +351,13 @@ The expensive operation (session key computation) only happens once per login.
|
||||||
2. **No Plaintext Storage:** Password is immediately hashed, never stored
|
2. **No Plaintext Storage:** Password is immediately hashed, never stored
|
||||||
3. **Forward Secrecy:** Ephemeral keys (a, A) are generated per session
|
3. **Forward Secrecy:** Ephemeral keys (a, A) are generated per session
|
||||||
4. **Mutual Authentication:** Both client and server prove knowledge of password
|
4. **Mutual Authentication:** Both client and server prove knowledge of password
|
||||||
5. **Secure Channel:** Session key K can be used for encryption (not implemented yet)
|
5. **Secure Channel:** Session key K is used for RC4 header encryption after auth completes
|
||||||
|
|
||||||
## References
|
## References
|
||||||
|
|
||||||
- [SRP Protocol](http://srp.stanford.edu/)
|
- [SRP Protocol](http://srp.stanford.edu/)
|
||||||
- [WoWDev Wiki - SRP](https://wowdev.wiki/SRP)
|
- [WoWDev Wiki - SRP](https://wowdev.wiki/SRP)
|
||||||
- Original wowee: `/wowee/src/lib/crypto/srp.js`
|
- Implementation: `src/auth/srp.cpp`, `include/auth/srp.hpp`
|
||||||
- OpenSSL BIGNUM: https://www.openssl.org/docs/man1.1.1/man3/BN_new.html
|
- OpenSSL BIGNUM: https://www.openssl.org/docs/man1.1.1/man3/BN_new.html
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue