Update README.md

This commit is contained in:
Relationship
2026-07-10 08:08:49 +01:00
committed by GitHub
parent 5b9e5f6442
commit 664fc36e0d
+92 -76
View File
@@ -1,101 +1,117 @@
<img src="https://cdn.discordapp.com/attachments/1510333697277300856/1524819837270884362/kkk.gif?ex=6a5122a2&is=6a4fd122&hm=b82d19b995b2d1f8b252fcbaf44dcaa7b5f30255fb1401f50f931919c980a4ce&"/> <img src="https://cdn.discordapp.com/attachments/1510333697277300856/1524819837270884362/kkk.gif?ex=6a5122a2&is=6a4fd122&hm=b82d19b995b2d1f8b252fcbaf44dcaa7b5f30255fb1401f50f931919c980a4ce&"/>
# RelationshipsAttune # RelationshipsAttune
A lightweight raid / dungeon / misc attunement tracker for **World of Warcraft 1.12** (Vanilla and OctoWoW). A lightweight **World of Warcraft 1.12** attunement and dungeon access tracker built for **OctoWoW**.
Keep track of every attunement step for yourself — quests, key items, reputation, and level requirements — all in one clean window. RelationshipsAttune automatically scans your character's progress, tracks raid attunements, dungeon keys, reputation requirements, and important access chains, while allowing you to view the progress of other players who are using the addon.
--- ---
## ✨ What it does ## Features
Relationships Attune scans your quest log, bags, and reputations to figure out exactly how far along you are in each raid attunement. It then shares that progress with your party, raid, or guild so you can instantly see who's ready for what. * ✅ Automatic quest scanning
* ✅ Automatic bag, equipment and keyring scanning
No more asking *"do you have your Onyxia key?"* in guild chat. * ✅ Tracks raid attunements
* ✅ Tracks dungeon keys and access quests
* ✅ Reputation requirement tracking
* ✅ Progress bars for every attunement
* ✅ Detailed step-by-step guides
* ✅ Tooltips showing where every quest starts
* ✅ Supports Alliance and Horde specific quest chains
* ✅ Share progress with other addon users
* ✅ Minimap button
* ✅ Manual rescan button
* ✅ Designed for Lua 5.0 / WoW 1.12 compatibility
--- ---
## 🎯 Features # Included Raid Attunements
- **Full attunement tracking** for classic raids: ### Vanilla
- Onyxia's Lair (both Alliance & Horde chains)
- Molten Core * Onyxia's Lair
- Blackwing Lair * Molten Core
- Naxxramas * Blackwing Lair
- AQ40 * Naxxramas
- **Turtle / Octo WoW custom raids** supported * Ruins of Ahn'Qiraj (AQ20)
- **Auto-detection** of your progress by scanning: * Temple of Ahn'Qiraj (AQ40)
- Quest log (completed & in-progress quests)
- Bags (key items)
- Faction reputations
- Character level
- **Faction-aware** — only shows steps that apply to your character
- **Party / Raid / Guild sync** — see the attunement status of everyone in your group
- **Clean UI** with:
- Scrollable player list
- Color-coded progress (green = done, yellow = partial, red = not started)
- Hover tooltips explaining every step and where to start it
- Click any step to see extra details
- **Movable, hideable minimap button** — drag it anywhere on your screen
- **Throttled auto-scan** — stays light on performance
- **Per-character progress** saved between sessions
--- ---
## 📦 Installation # Included Dungeon & Key Access
* Upper Blackrock Spire (Seal of Ascension)
* Blackrock Depths (Shadowforge Key)
* Scholomance
* Stratholme Service Entrance
* Dire Maul
* Gnomeregan Workshop Shortcut
* Maraudon Portal Shortcut
* Sunken Temple
* Hydraxian Waterlords (Molten Core Rune access)
* Scarlet Monastery Cathedral
* BRD Prison Cell Key
* Searing Gorge Access
* Uldaman (Discs of Norgannon)
---
# Included OctoWoW Content
* Karazhan Crypt (10)
* Lower Karazhan Halls (40)
* Emerald Sanctum
* Gilneas City
* Hateforge Quarry
* Stormwind Vault
* Dragonmaw Retreat
---
# What is Tracked
RelationshipsAttune tracks:
* Character level requirements
* Quest progression
* Completed quest chains
* Dungeon keys
* Raid attunements
* Reputation requirements
* Required items
* Final attunement items
* Character completion status
---
# Commands
```
/attune
```
Opens the Relationships Attune window.
---
# Installation
1. Download the addon. 1. Download the addon.
2. Extract the `RelationshipsAttune` folder into your WoW addons directory: 2. Extract the folder into:
``` ```
/Interface/AddOns/RelationshipsAttune/ /Interface/AddOns/
``` ```
4. Restart WoW (or reload with `/reload`).
--- 3. Launch the game.
4. Enable **RelationshipsAttune** on the character selection screen.
5. Type:
## 🕹️ Usage ```
/attune
Open the window by clicking the minimap button, or use a slash command: ```
| Command | What it does |
|---|---|
| `/attune` | Toggle the main window |
| `/rattune show` | Show the window |
| `/rattune hide` | Hide the window |
| `/rattune scan` | Rescan your quest log and bags |
| `/rattune sync` | Request attunement data from your group |
| `/rattune reset` | Wipe stored data for this character |
### The main window
- **Left side:** list of players (you + anyone in your group/guild running the addon).
- **Right side:** every attunement broken down step by step.
- **Hover** a step to see what it is and where to start it.
- **Click** a step to expand extra info.
- Completed steps highlight in **green**, in-progress steps in **yellow**, missing steps in **red**.
### Minimap button
- **Left-click:** open/close the window.
- **Drag:** move the button anywhere on your screen.
- Hide it entirely via the options if you prefer a clean UI.
---
## ❓ FAQ
**Does it work on Turtle WoW / Octo WoW?**
Yes — the addon is built for 1.12 clients and is fully compatible with Turtle/Octo. Custom raid attunements are included.
**Will other players see my progress if they don't have the addon?**
No. Sync only happens between players who both have Relationships Attune installed.
**How do I move or hide the minimap button?**
Just click and drag it anywhere. To hide it, use the addon options (or set `minimapHide = true` in the saved variables).
**My progress looks wrong — what do I do?**
Run `/rattune scan` to force a rescan of your quest log, bags, and reputation. If it's still wrong, `/rattune reset` will wipe stored data for that character and rebuild it.
--- ---