# PvPScout – PvP ratings in your tooltip

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

## Features

- Tooltip integration: 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
- Options panel: enable/disable, show rank, trend (7‑day delta, optional), minimap icon, per-bracket visibility and ordering, stale threshold
- Minimap button: draggable; hover glow; color-coded ring by data age (fresh → green, warning → yellow, stale → red); right-click quick menu (Enable, Show Rank/Header/Updated Age/Trend, per-bracket, Share)
- Slash commands: `/pvpscout` prints target ratings; `/pvpscout enable|disable` toggles; `/pvpscout` opens options
- Region auto-detect: uses your game portal; supports EU/US/KR/TW
- Lightweight & privacy-friendly: only uses public ladder data

## How it works

- The addon ships with a `Data.lua` containing ladder snapshots built from Blizzard’s official APIs.
- A cloud workflow refreshes the data about every 3 hours and publishes alpha builds; tagged releases upload to CurseForge.
- Because the WoW client cannot make web requests, updates require installing a new addon build.

## Usage

- Hover any player to see their ratings in the tooltip (if the character appears on the ladder).
- Share ratings (chat): target a player, right‑click the minimap button → “Share ratings to chat”; a compact line is inserted into your chat box, which you can 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

- Players below ladder thresholds might not appear until they qualify.
- Realms are normalized to match in-game formats; report mismatches on GitHub.

## Source & issues

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

---

## Gallery

Below are screenshots showcasing PvPScout in action. These are curated in the Gallery tab on CurseForge.

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