mirror of
https://github.com/Kelsidavis/WoWee.git
synced 2026-04-03 12:03:50 +00:00
dab534e631
- 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
98 lines
2.2 KiB
Markdown
98 lines
2.2 KiB
Markdown
# Quick Start Guide
|
|
|
|
## Current Status
|
|
|
|
Wowee is a native C++ World of Warcraft 3.3.5a client focused on online multiplayer.
|
|
|
|
Implemented today:
|
|
|
|
- SRP6a authentication + world connection
|
|
- Character creation/selection and in-world entry
|
|
- Full 3D rendering pipeline (terrain, water, sky, M2/WMO, particles)
|
|
- Core gameplay plumbing (movement, combat/spell casting, inventory/equipment, chat)
|
|
- Transport support (boats/zeppelins) with active ongoing fixes
|
|
|
|
For a more honest snapshot of gaps and current direction, see `docs/status.md`.
|
|
|
|
## Build And Run
|
|
|
|
### 1. Clone
|
|
|
|
```bash
|
|
git clone --recurse-submodules https://github.com/Kelsidavis/WoWee.git
|
|
cd WoWee
|
|
```
|
|
|
|
### 2. Build
|
|
|
|
```bash
|
|
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
|
|
cmake --build build -j"$(nproc)"
|
|
```
|
|
|
|
### 4. Provide WoW Data (Extract + Manifest)
|
|
|
|
Wowee loads assets from an extracted loose-file tree indexed by `manifest.json`.
|
|
|
|
If you do not already have an extracted `Data/manifest.json`, extract from your WoW install:
|
|
|
|
```bash
|
|
# WotLK 3.3.5a example
|
|
./extract_assets.sh /path/to/WoW/Data wotlk
|
|
```
|
|
|
|
By default wowee uses `./Data/`. To override:
|
|
|
|
```bash
|
|
export WOW_DATA_PATH=/path/to/extracted/Data
|
|
```
|
|
|
|
### 5. Run
|
|
|
|
```bash
|
|
./build/bin/wowee
|
|
```
|
|
|
|
## Connect To A Server
|
|
|
|
1. Launch `./build/bin/wowee`
|
|
2. Enter account credentials
|
|
3. Set auth server address (default: `localhost`)
|
|
4. Login, pick realm, pick character, enter world
|
|
|
|
For local AzerothCore setup, see `docs/server-setup.md`.
|
|
|
|
## Useful Controls
|
|
|
|
- `WASD`: Move
|
|
- `Mouse`: Look/orbit camera
|
|
- `Tab`: Cycle targets
|
|
- `1-9,0,-,=`: Action bar slots
|
|
- `B`: Bags
|
|
- `C`: Character
|
|
- `P`: Spellbook
|
|
- `N`: Talents
|
|
- `L`: Quest log
|
|
- `M`: World map
|
|
- `O`: Guild roster
|
|
- `Enter`: Chat
|
|
- `/`: Chat slash command
|
|
- `F1`: Performance HUD
|
|
- `F4`: Toggle shadows
|
|
|
|
## Troubleshooting
|
|
|
|
### Build fails on missing dependencies
|
|
|
|
Use `BUILD_INSTRUCTIONS.md` for distro-specific package lists.
|
|
|
|
### Client cannot connect
|
|
|
|
- Verify auth/world server is running
|
|
- Check host/port settings
|
|
- Check server logs and client logs in `logs/wowee.log`
|
|
|
|
### Missing assets (models/textures/terrain)
|
|
|
|
- Verify `Data/manifest.json` exists (or re-run `./extract_assets.sh ...`)
|
|
- Or export `WOW_DATA_PATH=/path/to/extracted/Data`
|