Files
RelationshipsAttune/README.md
T
2026-07-09 17:30:26 +01:00

92 lines
2.6 KiB
Markdown

# Relationships Attune
A Vanilla-only attunement tracker for **Turtle WoW / Octo WoW** (client 1.12,
Lua 5.0). Same shape as the classic *Attune* addon — per-character progress,
step lists, group sync — trimmed to Vanilla content plus Turtle/Octo custom
raids.
## Install
Copy the folder `RelationshipsAttune/` into:
```
<WoW>/Interface/AddOns/RelationshipsAttune/
```
Make sure the folder contains `RelationshipsAttune.toc` at its root.
Restart the client (or `/reload`).
## Commands
```
/rattune toggle the window
/rattune show show
/rattune hide hide
/rattune scan rescan quests + bags
/rattune sync request attunement data from your party/raid
/rattune reset wipe this character's stored data
```
## What it tracks
**Vanilla:** Onyxia, Molten Core, Blackwing Lair, Naxxramas, UBRS key,
Scholomance key, AQ40 (level gate).
**Turtle / Octo custom:** Karazhan Crypt (10), Lower Karazhan Halls (40),
Emerald Sanctum, Gilneas, Hateforge Quarry, Stormwind Vault.
The custom entries currently use placeholder quest/item IDs marked with
`TODO:` in `Data.lua`. Replace those numbers with the real IDs from your
server and the tracker will light up automatically.
## Adding or fixing entries
Open `Data.lua` and edit the `RelationshipsAttune_Data` table. Each
attunement is:
```lua
{
id = "kara10", name = "Karazhan Crypt (10)",
category = "Turtle", faction = "Both",
steps = {
{ type = "level", level = 55, name = "Level 55" },
{ type = "quest", id = 40001, name = "Crypt attunement" },
{ type = "item", id = 60001, name = "Crypt Key" },
{ type = "rep", faction = "Argent Dawn", standing = 5, name = "Honored" },
},
},
```
Step types: `level`, `quest`, `item`, `rep`. Standing uses
`1=Hostile ... 4=Neutral, 5=Honored, 6=Revered, 7=Exalted`.
## Group sync
When you're in a party or raid the addon sends a compact per-attunement
summary over the addon channel (`RATTUNE` prefix). Click **Sync** in the
window or run `/rattune sync` to force an exchange. Group members without
the addon are simply ignored.
## Notes on the 1.12 client
- Uses only APIs available in 1.12 (`CreateFrame`, `SendAddonMessage`,
`GetContainerItemLink`, `GetQuestLogTitle`, `GetFactionInfo`).
- Registers `QUEST_TURNED_IN` defensively — Turtle backports it, real
1.12 doesn't; without it the addon falls back to scanning the quest
log's Complete state and remembering completions in saved variables.
- No external libraries required.
## Files
```
RelationshipsAttune.toc
Locales.lua
Data.lua
Core.lua
Comm.lua
UI.lua
README.md
```
Author: RelationshipsAttune · Version 1.0.0