# The wow-stats manual

**For:** everyone: players, AI users, people who run a server, and contributors. **At the
end:** you've found the page for what you want to do.

New here? [How it works](https://sam-dumont.github.io/wow-mcp/how-it-works/) in five minutes, or the
[questions and answers](https://sam-dumont.github.io/wow-mcp/faq/).

## Play

A friend runs wow-stats and sent you a link.

1. [Join a friend's server](https://sam-dumont.github.io/wow-mcp/play/getting-started/): the addons, one command, about
   15 minutes.
2. [Your page at a glance](https://sam-dumont.github.io/wow-mcp/play/your-page/), then each part in detail:
   [Overview and next moves](https://sam-dumont.github.io/wow-mcp/play/overview/), [Gear and upgrades](https://sam-dumont.github.io/wow-mcp/play/gear/),
   [Dungeons](https://sam-dumont.github.io/wow-mcp/play/dungeons/), [Plan your next hours](https://sam-dumont.github.io/wow-mcp/play/plan/),
   [Climb, timeline, journal](https://sam-dumont.github.io/wow-mcp/play/history/).
3. [Something's wrong](https://sam-dumont.github.io/wow-mcp/play/troubleshooting/): fixes by symptom.
4. [What's shared](https://sam-dumont.github.io/wow-mcp/play/privacy/): what your friends and the public see.

## Connect your AI

1. [Connect your AI](https://sam-dumont.github.io/wow-mcp/ai/connect/): Claude, ChatGPT, Claude Code and a dozen more clients.
2. [Ask about your character](https://sam-dumont.github.io/wow-mcp/ai/asking/): what to ask, and how the server checks the
   numbers.
3. [Tools and prompts](https://sam-dumont.github.io/wow-mcp/ai/tools/): every tool your assistant can call.

## Self-host

Start here:

1. [Try it at home](https://sam-dumont.github.io/wow-mcp/self-host/try-at-home/): five made-up characters on your computer, 10 minutes.
2. [Install it for real](https://sam-dumont.github.io/wow-mcp/self-host/install/): the server, the addons and the shipper, for yourself.

Set it up:

- [Run it on a server](https://sam-dumont.github.io/wow-mcp/self-host/production/): the order to set things up.
- [Reverse proxy and HTTPS](https://sam-dumont.github.io/wow-mcp/self-host/reverse-proxy/): Caddy, Traefik or nginx.
- [The login for your AI](https://sam-dumont.github.io/wow-mcp/self-host/oidc/): any OIDC provider, Keycloak as the example.
- [Share your page](https://sam-dumont.github.io/wow-mcp/self-host/sharing/): the public site, the sealed friends' site, the
  pictures of past levels.
- [Add friends](https://sam-dumont.github.io/wow-mcp/self-host/friends/): several players on one server.
- [Admin overview](https://sam-dumont.github.io/wow-mcp/self-host/admin/): who uses the install, when, and whether its parts answer.
- [Battle.net data](https://sam-dumont.github.io/wow-mcp/self-host/battlenet/): your own API client and the 30-day rule.
- [Without Docker Compose](https://sam-dumont.github.io/wow-mcp/self-host/deploy/): Kubernetes or plain containers.

Keep it running:

- [Back up and restore](https://sam-dumont.github.io/wow-mcp/self-host/backup/).
- [Upgrade](https://sam-dumont.github.io/wow-mcp/self-host/upgrade/).
- [Monitor it](https://sam-dumont.github.io/wow-mcp/self-host/monitoring/).
- [Harden it](https://sam-dumont.github.io/wow-mcp/self-host/hardening/).
- [Uninstall](https://sam-dumont.github.io/wow-mcp/self-host/uninstall/).

Look it up:

- [Environment variables](https://sam-dumont.github.io/wow-mcp/self-host/environment/): every setting, which program reads it,
  its default.
- [HTTP endpoints](https://sam-dumont.github.io/wow-mcp/self-host/http-endpoints/): every path, its port and its login.
- [Sizing](https://sam-dumont.github.io/wow-mcp/self-host/sizing/): measured time, memory and disk.
- [The shipper](https://sam-dumont.github.io/wow-mcp/self-host/shipper/): its files, flags and schedule.
- [The shipper's events](https://sam-dumont.github.io/wow-mcp/self-host/contract/): every event and field it sends.

## Game data

- [Addons it reads](https://sam-dumont.github.io/wow-mcp/game-data/addons/): every addon and what it adds to the page.
- [Gear upgrades](https://sam-dumont.github.io/wow-mcp/game-data/gear-reference/), [Route times](https://sam-dumont.github.io/wow-mcp/game-data/route-reference/),
  [Forever reference](https://sam-dumont.github.io/wow-mcp/game-data/forever-reference/), [Model reference](https://sam-dumont.github.io/wow-mcp/game-data/model3d-reference/): the game data the kit
  ships.
- [The knowledge base](https://sam-dumont.github.io/wow-mcp/game-data/kb/): where the game rules your assistant quotes come from.

## Under the hood

- [Architecture](https://sam-dumont.github.io/wow-mcp/explain/architecture/): the parts and how an event travels.
- [MCP and the play analysis](https://sam-dumont.github.io/wow-mcp/explain/mcp/): the tools, plans, analysis and login, inside.
- [Privacy tiers](https://sam-dumont.github.io/wow-mcp/explain/privacy-tiers/): what's collected, and who sees what.
- [Security notes](https://sam-dumont.github.io/wow-mcp/explain/security/): what an install has to get right, and the findings left open
  on purpose.

## Project and contributing

- [Changelog](https://sam-dumont.github.io/wow-mcp/project/changelog/) and the [security policy](https://sam-dumont.github.io/wow-mcp/project/security/).
- [How to contribute](https://sam-dumont.github.io/wow-mcp/contribute/contributing/) and [Development and releases](https://sam-dumont.github.io/wow-mcp/contribute/development/).
