Skip to content

Commit 52c5afd

Browse files
XerrionXerrion
authored
docs: refresh README to reflect current addon state (#45) (#46)
Removes fabricated Cataclysm Classic support, fixes Supported Versions table to match the TOC and actual listener filenames, corrects the Configuration scope claim from per-character to account-wide, adds the 5-second M+ post-completion grace period to How It Works, adds a new Events Handled table, and highlights the zero-external-dependencies design. Closes #45
1 parent c38749b commit 52c5afd

1 file changed

Lines changed: 64 additions & 54 deletions

File tree

‎README.md‎

Lines changed: 64 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,32 @@
44

55
# RaidLogAuto
66

7-
**Automatically enable combat logging in raids & Mythic+ — so you never forget again.**
7+
**Automatically enable combat logging in raids & Mythic+ - so you never forget again.**
88

99
[![Latest Release](https://img.shields.io/github/v/release/Xerrion/RaidLogAuto?style=for-the-badge&logo=github&label=Latest%20Release)](https://github.com/Xerrion/RaidLogAuto/releases/latest)
1010
[![License](https://img.shields.io/badge/License-MIT-green?style=for-the-badge)](LICENSE)
1111
[![WoW Versions](https://img.shields.io/badge/WoW-Retail%20%7C%20Classic-blue?style=for-the-badge&logo=battledotnet)](https://worldofwarcraft.blizzard.com/)
1212
[![Build](https://img.shields.io/github/actions/workflow/status/Xerrion/RaidLogAuto/release.yml?style=for-the-badge&logo=github&label=Build)](https://github.com/Xerrion/RaidLogAuto/actions)
1313
[![CurseForge Downloads](https://img.shields.io/curseforge/dt/1457114?style=for-the-badge&logo=curseforge&label=CurseForge)](https://www.curseforge.com/wow/addons/raidlogauto)
14+
[![Wago Downloads](https://img.shields.io/badge/Wago-rN4kWyGD-C1272D?style=for-the-badge&logo=wago)](https://addons.wago.io/addons/raidlogauto)
1415

1516
</div>
1617

1718
---
1819

20+
RaidLogAuto automatically toggles the combat log when you enter or leave raid, dungeon, and Mythic+ content, so you
21+
never end a session with a missing or empty WoWCombatLog.txt.
22+
1923
## ✨ Features
2024

21-
- 🔄 **Automatic Combat Logging** — Starts recording when you enter a raid, stops when you leave
22-
- ⚔️ **Mythic+ Support** — Optionally log Mythic+ dungeons (Retail & MoP Classic)
23-
- 🌍 **Multi-Version** — Works across Retail, MoP Classic, Cataclysm Classic, TBC Anniversary, and Classic Era
24-
- 📊 **Advanced Combat Logging** — Automatically enables Advanced Combat Logging for detailed parse data
25-
- 🔔 **Combat Log Reminder** — One-time popup reminder about deleting old CombatLog.txt files
26-
- 🪶 **Lightweight** — Minimal memory footprint, zero performance impact
27-
- 🔇 **Silent Mode** — Toggle chat notifications on or off
28-
- ⚡ **Zero Config** — Install and forget — it just works
25+
- 🔄 **Automatic Logging** - Auto-enables combat log on raid/dungeon/M+ entry, auto-disables on exit
26+
- ⏱️ **Grace Period** - 5-second grace period after Mythic+ completion to capture final logs
27+
- ⚔️ **Granular Toggles** - Per-content-type toggles: raid, dungeon, and Mythic+
28+
- 📊 **ACL Auto-Enable** - Optional Advanced Combat Logging auto-enable for detailed parse data
29+
- 🔔 **One-Time Reminder** - Popup reminder about ACL settings and CombatLog.txt cleanup
30+
- 🌍 **Multi-Version** - Supports Retail, MoP Classic, TBC Anniversary, and Classic Era
31+
- 🪶 **Zero Dependencies** - Lightweight footprint with zero external library dependencies (no Ace3, no LibStub)
32+
- 💾 **Account-Wide** - Settings persist across characters via SavedVariables
2933

3034
---
3135

@@ -38,25 +42,38 @@
3842
└──────────────┘ └──────────────────┘ └──────┬───────┘
3943
│
4044
▼
41-
┌──────────────────┐
42-
│ Combat Logging │
43-
│ DISABLED ❌ │
44-
└──────────────────┘
45+
┌──────────────────┐
46+
│ Combat Logging │
47+
│ DISABLED ❌ │
48+
└──────────────────┘
4549
```
4650

47-
RaidLogAuto listens for instance changes. When you zone into a raid (or a Mythic+ dungeon, if enabled), it automatically calls `/combatlog` for you. When you leave, it turns logging off — keeping your log files clean and your uploads hassle-free.
51+
RaidLogAuto monitors instance transitions and Mythic+ lifecycle events. When you enter a supported instance type,
52+
the addon ensures combat logging is active. To prevent truncated logs in Mythic+, the addon waits for a 5-second
53+
grace period after `CHALLENGE_MODE_COMPLETED` before disabling the log.
4854

4955
---
5056

5157
## 🎮 Supported Versions
5258

53-
| Version | Lua File | Features |
54-
|:--------|:---------|:---------|
55-
| **Retail** | `RaidLogAuto_Retail.lua` | Raid logging + Mythic+ + Advanced Combat Logging |
56-
| **MoP Classic** | `RaidLogAuto_Mists.lua` | Raid logging + Mythic+ + Advanced Combat Logging |
57-
| **Cataclysm Classic** | `RaidLogAuto_Cata.lua` | Raid logging + Advanced Combat Logging |
58-
| **TBC Anniversary** | `RaidLogAuto_TBC.lua` | Raid logging + Advanced Combat Logging |
59-
| **Classic Era** | `RaidLogAuto_Classic.lua` | Raid logging + Advanced Combat Logging |
59+
| Client | Interface | Listener File |
60+
|:---|:---|:---|
61+
| Retail | 120005, 120001, 120000 | `RaidLogAuto_Retail.lua` |
62+
| MoP Classic | 50502, 50503 | `RaidLogAuto_Mists.lua` |
63+
| TBC Anniversary | 20505 | `RaidLogAuto_BCC.lua` |
64+
| Classic Era | 11508, 11507 | `RaidLogAuto_Vanilla.lua` |
65+
66+
---
67+
68+
## 📋 Events Handled
69+
70+
| Event | Purpose |
71+
|:---|:---|
72+
| `ADDON_LOADED` | Initialize SavedVariables and apply defaults |
73+
| `PLAYER_ENTERING_WORLD` | Re-evaluate context after login or zone change |
74+
| `ZONE_CHANGED_NEW_AREA` | Toggle log when crossing into raid/dungeon boundaries |
75+
| `CHALLENGE_MODE_START` | Force-enable log for Mythic+ runs |
76+
| `CHALLENGE_MODE_COMPLETED` | Schedule 5-second delayed disable to capture final events |
6077

6178
---
6279

@@ -74,72 +91,65 @@ RaidLogAuto listens for instance changes. When you zone into a raid (or a Mythic
7491

7592
### Manual Install
7693

77-
1. Download the latest release from one of the sources above
94+
1. Download the latest release from one of the sources above.
7895
2. Extract the `RaidLogAuto` folder into your AddOns directory:
79-
```
80-
World of Warcraft/_retail_/Interface/AddOns/RaidLogAuto/
81-
```
82-
3. Restart WoW or type `/reload`
83-
84-
> **Tip:** Use an addon manager like [CurseForge App](https://www.curseforge.com/download/app) or [WowUp](https://wowup.io/) for automatic updates.
96+
- `World of Warcraft/_retail_/Interface/AddOns/RaidLogAuto/`
97+
3. Restart WoW or type `/reload`.
8598

8699
---
87100

88-
## ⌨️ Commands
101+
## ⌨️ Slash Commands
89102

90103
All commands use the `/rla` prefix (or the full `/raidlogauto`):
91104

92105
| Command | Description |
93-
|:--------|:------------|
94-
| `/rla` | Show current status |
95-
| `/rla on` | Enable auto-logging |
96-
| `/rla off` | Disable auto-logging |
97-
| `/rla toggle` | Toggle on/off |
98-
| `/rla mythic` | Toggle Mythic+ logging *(Retail & MoP Classic only)* |
99-
| `/rla silent` | Toggle chat notifications |
100-
| `/rla acl` | Check and enable Advanced Combat Logging |
101-
| `/rla help` | Show help |
106+
|:---|:---|
107+
| `/rla` | Show current status and settings |
108+
| `/rla on` | Enable the addon |
109+
| `/rla off` | Disable the addon |
110+
| `/rla toggle` | Toggle addon status on/off |
111+
| `/rla mythic` | Toggle Mythic+ logging (Retail/MoP only) |
112+
| `/rla silent` | Toggle chat notifications (Silent Mode) |
113+
| `/rla acl` | Manually check or enable Advanced Combat Logging |
114+
| `/rla help` | Show help commands |
102115

103116
---
104117

105118
<details>
106119
<summary><h2>⚙️ Configuration</h2></summary>
107120

108-
Settings are stored in the `RaidLogAutoDB` SavedVariable and persist per-character.
121+
Settings are stored in the `RaidLogAutoDB` SavedVariable and are **account-wide**.
109122

110123
| Variable | Default | Description |
111-
|:---------|:--------|:------------|
112-
| `enabled` | `true` | Master toggle — enable or disable the addon |
124+
|:---|:---|:---|
125+
| `enabled` | `true` | Master toggle - enable or disable the addon |
113126
| `raidOnly` | `true` | Only log in raid instances |
114-
| `mythicPlus` | `false` | Log Mythic+ dungeons *(Retail & MoP Classic only)* |
127+
| `mythicPlus` | `false` | Log Mythic+ dungeons (Retail/MoP only) |
115128
| `printMessages` | `true` | Show status messages in chat |
116-
| `combatLogReminderDismissed` | `false` | Whether the one-time combat log reminder has been dismissed |
117-
118-
All settings can be changed via the [slash commands](#%EF%B8%8F-commands) above.
129+
| `combatLogReminderDismissed` | `false` | Tracks if the one-time cleanup reminder was dismissed |
119130

120131
</details>
121132

122133
<details>
123134
<summary><h2>📁 Combat Log Location</h2></summary>
124135

125-
After a raid, your combat log is saved to:
136+
After a session, your combat log is saved to:
126137

127138
| OS | Path |
128-
|:---|:-----|
129-
| **Windows** | `World of Warcraft\_retail_\Logs\WoWCombatLog.txt` |
130-
| **macOS** | `/Applications/World of Warcraft/_retail_/Logs/WoWCombatLog.txt` |
131-
132-
> Replace `_retail_` with the appropriate folder for your game version (e.g. `_classic_era_`, `_classic_`).
139+
|:---|:---|
140+
| Windows | `World of Warcraft\_retail_\Logs\WoWCombatLog.txt` |
141+
| macOS | `/Applications/World of Warcraft/_retail_/Logs/WoWCombatLog.txt` |
133142

134-
Upload your logs to [Warcraft Logs](https://www.warcraftlogs.com/) for detailed analysis! 📊
143+
Replace `_retail_` with the appropriate folder for your game version (e.g., `_classic_era_`, `_classic_`).
135144

136145
</details>
137146

138147
---
139148

140149
## 🤝 Contributing
141150

142-
Contributions are welcome! Feel free to open an [issue](https://github.com/Xerrion/RaidLogAuto/issues) or submit a [pull request](https://github.com/Xerrion/RaidLogAuto/pulls).
151+
Contributions are welcome! Please refer to [AGENTS.md](AGENTS.md) and [CONTRIBUTING.md](CONTRIBUTING.md) for
152+
development guidelines, including the use of `luacheck`.
143153

144154
1. Fork the repository
145155
2. Create your feature branch (`git checkout -b feat/my-feature`)
@@ -153,7 +163,7 @@ Contributions are welcome! Feel free to open an [issue](https://github.com/Xerri
153163

154164
## 📄 License
155165

156-
This project is licensed under the **MIT License** — see the [LICENSE](LICENSE) file for details.
166+
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
157167

158168
[![License](https://img.shields.io/badge/License-MIT-green?style=flat-square)](LICENSE)
159169

0 commit comments

Comments
 (0)