# PvPLedger-AppHelper

**PvPLedger-AppHelper** is the required companion addon for [PvPLedger](https://github.com/simplebooleanjim/PvPLedger). It is a small bridge — not the desktop app — that holds ladder snapshot data the main addon reads in-game.

WoW addons cannot download files from the internet. This addon solves that by storing imported ladder payloads in `AppData.lua`, which **PvPLedger** merges into its ladder browser, title cutoffs, and standing estimates.

---

## What it does

- Ships a **bundled ladder snapshot** in `AppData.lua` so PvPLedger works immediately after install

- Receives **newer snapshots** when **PvPLedger Sync** (Windows tray app) updates `AppData.lua` on your PC

- Handles **export acknowledgements** when optional match sharing is enabled in PvPLedger settings

---

## Requirements

- **PvPLedger** (main addon) — install and enable alongside this addon

- **Recommended:** [PvPLedger Sync](https://github.com/simplebooleanjim/PvPLedger/releases/latest) from GitHub for automatic ladder updates (CurseForge cannot host the `.exe`)

This addon works **without** Sync using the bundled snapshot. Sync is what keeps ladder data current over time.

---

## Installation

1. Install **PvPLedger** and **PvPLedger-AppHelper** from your addon manager.

2. Enable **both** addons in the WoW AddOns list.

3. Run **`/reload`** in-game.

For automatic ladder updates:

4. Download **[PvPLedger-Setup.exe](https://github.com/simplebooleanjim/PvPLedger/releases/latest)** (or **PvPLedger-Sync.exe** if you already have the addons) from GitHub.

5. Run the installer or tray app, leave it running in the background.

6. When Sync updates ladder files, run **`/reload`** again in WoW.

Check snapshot age and data sources anytime with **`/pvl status`** in-game.

---

## Optional addons

- **PvPLedger-Data-{REGION}** — optional bundled regional ladder packs (US, EU, KR, TW). PvPLedger uses the newest snapshot from any installed source.

---

## Privacy

- Ladder snapshots are public PvP leaderboard data written locally to this addon’s folder.

- Match export upload is **off by default** in PvPLedger settings and only runs when you enable it and use PvPLedger Sync.

See the [PvPLedger README](https://github.com/simplebooleanjim/PvPLedger#privacy--data-collection) for full details.

---

## Links

- **Main addon:** PvPLedger (required)

- **Windows sync app:** [GitHub Releases](https://github.com/simplebooleanjim/PvPLedger/releases/latest)

- **Source & issues:** [github.com/simplebooleanjim/PvPLedger](https://github.com/simplebooleanjim/PvPLedger)

**License:** MIT

thePvPLedgerapphelper