readme.md

readme.md

@@ -1,29 +1,116 @@
-# UI Overhowl
+# Hail Mary Guild Tools
 
-# Debug Message
+Hail Mary Guild Tools is a World of Warcraft addon focused on raid and group coordination.
+It combines cooldown tracking, encounter reminders, notes, and map utilities in a single Ace3-based addon.
 
-# Update Buff Ending
+## Status
-Füge eine Option hinzu ob es im Raid und in der Gruppe aktiv sein soll
 
-# Demo Warlock Pet Interrupt
+- Stable version: `1.3`
+- Current build: `2.0-beta`
+- SavedVariables: `HailMaryGuildToolsDB`
 
-# Spell Database
+## Main Features
-- WarlockW
--- Raid Cooldowns 0
--- Group Cooldowns
------ Offensiv
-- Tyrant
 
-# UI Anpassungen
+- Custom tracker system with individual tracker configs
-Bei den Tracked Spells hat jede klasse auch noch mal einen Unterpunkt dieser ist aber leer und wenn man drauf klickt kommt man zu der slection bitte entferne diesen
+- Interrupt, raid cooldown, and group cooldown tracking
-Die Buff Ending Tracked Buffs bitte auch überarbeiten
+- Per-tracker bar and icon layouts
+- Buff Ending Announcer for selected buffs and channels
+- Raid Timeline for encounter-based text reminders and raid cooldown assignments
+- Notes window for raid or personal note management
+- Map Overlay with custom world map POIs
+- Version mismatch detection inside groups and raids
+- Blizzard AddOn options integration with Ace3-based module configuration
 
-Bei Raid Timeline bitte auch Tree und Master Panel einbauen so das die Encounter unter Raidtimeline aufklappbar sind und man dann im Master Panel die Timeline Einträge für den Boss sieht. Bitte im Tree Panel dann erstmal den Raid dann dadrunter den Schwierigkeitsgrad und dann den Boss als Tree View
+## Modules
 
+### Tracker
 
-# Neues Modul "Quality of Life"
+The tracker system is the core feature of HMGT.
-- Charakter Fenster
+It supports multiple independent tracker bars with custom spell categories, display modes, growth directions, party-frame attachment, and demo/test modes.
-    Gems und Verzauberungen anzeigen wie im Style bei Elvui 
 
+### Buff Ending Announcer
 
-# UI Überarbeitungen und Code Aufräumen
+Tracks selected buffs and channel-based spells and warns before they expire.
+
+### Map Overlay
+
+Lets you create custom POIs on the world map and assign curated icon presets.
+
+### Raid Timeline
+
+Allows encounter-based planning with timed reminders and raid cooldown assignments.
+The system is designed around `encounterId` data and supports encounter-specific configuration.
+
+### Notes
+
+Provides a dedicated notes window for raid notes, personal notes, and drafts.
+
+## Commands
+
+- `/hmgt`
+  Opens the addon configuration
+- `/hmgt lock`
+  Locks all tracker frames
+- `/hmgt unlock`
+  Unlocks all tracker frames
+- `/hmgt demo`
+  Toggles tracker demo mode
+- `/hmgt test`
+  Toggles tracker test mode
+- `/hmgt notes`
+  Opens the notes window
+- `/hmgt debug`
+  Opens the developer tools window
+- `/hmgt dev`
+  Alias for the developer tools window
+- `/hmgt version`
+  Opens the version window when developer tools are enabled
+
+## Installation
+
+1. Copy the `HailMaryGuildTools` folder into:
+   `World of Warcraft/_retail_/Interface/AddOns/`
+2. Start or restart the game
+3. Enable the addon on the character selection screen if needed
+
+## Project Structure
+
+- `HailMaryGuildTools.lua`
+  Main addon bootstrap, communication, settings normalization, slash commands
+- `HailMaryGuildToolsOptions.lua`
+  Root options UI and module integration
+- `Core/`
+  Shared windows and developer tooling
+- `Modules/Tracker/`
+  Tracker rendering, data, and options
+- `Modules/BuffEndingAnnouncer/`
+  Buff ending module and options
+- `Modules/MapOverlay/`
+  World map POIs, icon config, and options
+- `Modules/RaidTimeline/`
+  Encounter timeline logic, bossmod bridges, and options
+- `Modules/Notes/`
+  Notes window and options
+- `Locales/`
+  Localization files
+- `Changelog.lua`
+  Ingame changelog data
+
+## Development Notes
+
+- The addon uses embedded Ace3 libraries
+- Module options are split into their own files where possible
+- Current development is happening on the `2.0-beta` build line
+- The tracker system was heavily reworked in `2.0`
+
+## Changelog
+
+The ingame changelog is stored in `Changelog.lua`.
+Recent `2.0` highlights include:
+
+- Reworked tracker architecture based on individual tracker configs
+- Custom tracker creation
+- Improved party-frame attachment and upward bar layouts
+- Persistent tracker category selections
+- Tracker removal confirmation
+- Improved bar coloring behavior