# PvPScout – PvP ratings in your tooltip

PvPScout shows a player’s PvP ratings from Blizzard’s official leaderboards directly in unit tooltips and via a simple chat print. Data is pre‑fetched outside the game (WoW AddOns can’t access the internet) and shipped with the addon.

## Features

- Tooltip ratings for 2v2, 3v3, Solo Shuffle, Rated Battlegrounds (10v10), and Blitz RBG
- Polished header: region + season, optional “Updated X ago”, optional stale‑data notice, optional color‑by‑rating
- Shuffle/Blitz spec logic:
  - For your character: uses your current specialization only
  - For other players: shows their best available spec (best rank; tie → highest rating)
- Options panel: enable/disable, show rank, trend (optional 7‑day delta), per‑bracket visibility and ordering, stale threshold, minimap icon
- Minimap button: draggable, native hover glow, right‑click quick menu (Enable, Show Rank/Header/Updated Age/Trend, per‑bracket toggles, Share to chat)
- Slash commands: `/pvpscout` prints target ratings; `/pvpscout enable|disable` toggles
- Region auto‑detect (EU/US/KR/TW); lightweight & privacy‑friendly (only public ladder data)

## How it works

- The addon ships with a `Data.lua` containing ladder snapshots built primarily from Blizzard’s official Game Data APIs. When credentials aren’t available, a polite HTML fallback collects the same public leaderboards.
- A cloud workflow refreshes the data on a schedule (about every 3 hours) and publishes alpha builds. Tagged releases upload to CurseForge and always include fresh data.
- The WoW client cannot make web requests; to receive updated data you install a new addon build.

## Usage

- Hover a player to see ratings for the enabled brackets (if the character appears on the leaderboards).
- Share ratings (chat): target a player, right‑click the minimap button → “Share ratings to chat”; a compact line is inserted into your chat box to send or edit.
- Commands:
  - `/pvpscout` → print ratings for your current target (or open options when not applicable)
  - `/pvpscout enable` | `/pvpscout disable` → toggle the addon

## Installation

- Recommended: Install via the CurseForge app
- Manual: Download the ZIP and extract to:
  - Windows: World of Warcraft/_retail_/Interface/AddOns/
  - macOS: /Applications/World of Warcraft/_retail_/Interface/AddOns/
  - Ensure the folder name is `PvPScout`

## Supported game versions

- Retail (The War Within, 11.x). The TOC is kept current.

## Known limitations

- WoW AddOns are offline: there is no live web lookup in‑game.
- Only characters present on the official leaderboards will show ratings.
- Realms are normalized to match in‑game formats; report mismatches on GitHub.

## Source & issues

- GitHub: <https://github.com/dominikreckziegel/PvPScout>
- License: MIT

---

## Gallery

Screenshots (see the Gallery tab on CurseForge):

1. Options – Enable/disable, show rank, trend, per‑bracket toggles and ordering, minimap icon
2. Tooltip – Header with region/season, optional “Updated X ago”, per‑bracket ratings (with rank/trend when enabled)
3. Minimap – Draggable button with centered ring, native hover glow, and right‑click quick menu (Share included)
4. Slash – `/pvpscout` prints ratings for your target
