premium banner
A ledger for GDKP/gold run raid

Description

# Raid Book

**Version:** see `RaidBook.toc` → `## Version` (currently **3.0.1**)

Ledger-style addon for **GDKP / gold-split raids**: record item sales, debits/credits, beneficiaries, and per-member totals—then **post summaries to raid chat** or **copy plain text**.

---

## Features (short)

- **Table ledger**: items with links, beneficiary, bid price (gold only—no copper/silver math inside the addon).
- **Quality filter** for the visible list (e.g. rare+); separate **whitelist / blacklist** names for auto-capture.
- **Distribution math**: all-split vs “no-loot” split, subgroup hints on the Blizzard raid frame.
- **Outputs**: detailed / summary raid messages, export to a text box; optional **attribution footer** lines on reports.
- **Trade hook**: optional auto lines when trading gold/items (raid/party context).
- **Manual +item**: button mode—**Shift+click** items from bags **or item links** from chat/addons.
- **Raid sync**: leader / assigned editor can sync the ledger to others with the addon (read-only mode when not editor).
- **Auction countdown** messages (`/rb countdown` …).
- **Minimap** broker button (LibDBIcon): open UI / settings per your client.

---

## Slash commands

| Command | Purpose |
|--------|---------|
| `/rb` | Open ledger UI + short help in chat |
| `/raidbook` | Same |
| `/br`, `/rb2` | Legacy aliases |
| `/rb toggle` | Cycle auto-record mode (always / raid only / off)—exact strings from in-game |
| `/rb countdown` | Configure auction countdown strings |
| `/rb autoclear on\|off` | Prompt to clear ledger when **entering an instance while in a raid** |
| `/rb sync` | Sync status (leader, distributor, editor flag, addon users) |
| `/rb synctest on\|off` | Solo test receive path |

Dragging an **item link** onto the chat edit box after `/rb` (with permission) can still add loot—see in-game messages.

---

## Installation

1. Copy the **`RaidBook`** folder into:  
   `World of Warcraft\_<flavor>_\Interface\AddOns\`
2. Ensure the folder name is **`RaidBook`** (matches `RaidBook.toc`).
3. Enable **Raid Book** on the character(s) that should keep a ledger (`SavedVariablesPerCharacter`).

**Embedded libraries** (no separate download): LibStub, CallbackHandler-1.0, LibDataBroker-1.1, LibDeformat-3.0, LibDBIcon-1.0, ScrollingTable (`lib/lib-st`).

---

## Saved data

- **Per character:** `RaidBookDatabase`, `RaidLedgerDatabase` (legacy merge—see addon code).
- **Per account:** `RaidBookGlobalConfig`, `RaidLedgerGlobalConfig`.

---

## CurseForge project

- **Listing icon:** use the bundled **`Media/RaidBook-CurseForge-400.png`** (400×400, 1:1). Upload it under project *Images* / gallery as required by CurseForge.
- **Description:** you can paste sections of this README or the longer Korean draft in `wowinven.md`.

---

## License / attribution

Respect the author’s terms shipped with the package. Report/export footers may include fixed attribution strings—do not strip them when redistributing modified builds if you want to stay aligned with the author’s policy.

---

## 한국어 요약

**골드 분배·GDKP 공격대**용 장부 애드온입니다. 아이템·획득자·낙찰가(골드)를 표로 관리하고, **공대 출력·텍스트 저장·거래 연동·+아이템(Shift+링크)**·**공대 동기화**·**카운트다운** 등을 지원합니다. 슬래시는 **`/rb`**, **`/raidbook`** 입니다. 자세한 한글 설명은 **`wowinven.md`** 를 참고하세요.