Skip to content

README.md

Latest commit

 

History

History
174 lines (121 loc) · 7.15 KB

README.md

File metadata and controls

174 lines (121 loc) · 7.15 KB
Raw
RaidLogAuto

RaidLogAuto

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

Latest Release License WoW Versions Build CurseForge Downloads Wago Downloads

RaidLogAuto automatically toggles the combat log when you enter or leave raid, dungeon, and Mythic+ content, so you never end a session with a missing or empty WoWCombatLog.txt.

✨ Features

  • 🔄 Automatic Logging - Auto-enables combat log on raid/dungeon/M+ entry, auto-disables on exit
  • ⏱️ Grace Period - 5-second grace period after Mythic+ completion to capture final logs
  • ⚔️ Granular Toggles - Per-content-type toggles: raid, dungeon, and Mythic+
  • 📊 ACL Auto-Enable - Optional Advanced Combat Logging auto-enable for detailed parse data
  • 🔔 One-Time Reminder - Popup reminder about ACL settings and CombatLog.txt cleanup
  • 🌍 Multi-Version - Supports Retail, MoP Classic, TBC Anniversary, and Classic Era
  • 🪶 Zero Dependencies - Lightweight footprint with zero external library dependencies (no Ace3, no LibStub)
  • 💾 Account-Wide - Settings persist across characters via SavedVariables

🔧 How It Works

 ┌──────────────┐         ┌──────────────────┐         ┌──────────────┐
 │  Enter Raid  │ ──────▶ │  Combat Logging  │ ──────▶ │  Leave Raid  │
 │  or Mythic+  │         │    ENABLED ✅     │         │  or Mythic+  │
 └──────────────┘         └──────────────────┘         └──────┬───────┘
                                                              │
                                                              ▼
                                                   ┌──────────────────┐
                                                   │  Combat Logging  │
                                                   │   DISABLED ❌     │
                                                   └──────────────────┘

RaidLogAuto monitors instance transitions and Mythic+ lifecycle events. When you enter a supported instance type, the addon ensures combat logging is active. To prevent truncated logs in Mythic+, the addon waits for a 5-second grace period after CHALLENGE_MODE_COMPLETED before disabling the log.

🎮 Supported Versions

Client Interface Listener File
Retail 120005, 120001, 120000 RaidLogAuto_Retail.lua
MoP Classic 50502, 50503 RaidLogAuto_Mists.lua
TBC Anniversary 20505 RaidLogAuto_BCC.lua
Classic Era 11508, 11507 RaidLogAuto_Vanilla.lua

📋 Events Handled

Event Purpose
ADDON_LOADED Initialize SavedVariables and apply defaults
PLAYER_ENTERING_WORLD Re-evaluate context after login or zone change
ZONE_CHANGED_NEW_AREA Toggle log when crossing into raid/dungeon boundaries
CHALLENGE_MODE_START Force-enable log for Mythic+ runs
CHALLENGE_MODE_COMPLETED Schedule 5-second delayed disable to capture final events

📦 Installation

Download

CurseForge Wago GitHub

Manual Install

  1. Download the latest release from one of the sources above.
  2. Extract the RaidLogAuto folder into your AddOns directory:
    • World of Warcraft/_retail_/Interface/AddOns/RaidLogAuto/
  3. Restart WoW or type /reload.

⌨️ Slash Commands

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

Command Description
/rla Show current status and settings
/rla on Enable the addon
/rla off Disable the addon
/rla toggle Toggle addon status on/off
/rla mythic Toggle Mythic+ logging (Retail/MoP only)
/rla silent Toggle chat notifications (Silent Mode)
/rla acl Manually check or enable Advanced Combat Logging
/rla help Show help commands

⚙️ Configuration

Settings are stored in the RaidLogAutoDB SavedVariable and are account-wide.

Variable Default Description
enabled true Master toggle - enable or disable the addon
raidOnly true Only log in raid instances
mythicPlus false Log Mythic+ dungeons (Retail/MoP only)
printMessages true Show status messages in chat
combatLogReminderDismissed false Tracks if the one-time cleanup reminder was dismissed

📁 Combat Log Location

After a session, your combat log is saved to:

OS Path
Windows World of Warcraft\_retail_\Logs\WoWCombatLog.txt
macOS /Applications/World of Warcraft/_retail_/Logs/WoWCombatLog.txt

Replace _retail_ with the appropriate folder for your game version (e.g., _classic_era_, _classic_).

🤝 Contributing

Contributions are welcome! Please refer to AGENTS.md and CONTRIBUTING.md for development guidelines, including the use of luacheck.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feat/my-feature)
  3. Commit your changes (git commit -m 'feat: add my feature')
  4. Push to the branch (git push origin feat/my-feature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

License

Made with ❤️ for the WoW community by Xerrion