Kelsidavis-WoWee/docs/quickstart.md

# 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`