Curse Surge Alert v1.12.0
========================

A lightweight World of Warcraft: Midnight 12.1 addon for the rotating Curse
Surges on The Coiled Isle.

Features
--------
- Small movable tracker showing both the currently active Curse Surge and the next scheduled Surge.
- Compact-by-default layout: only event/timer information and clickable coordinates remain visible until the cog-wheel button is clicked.
- Small cog-wheel button expands/collapses the full options dropdown; the expanded/collapsed state is saved.
- When the next-event countdown reaches zero, that Surge moves into the Current Active section while the Next section immediately advances to the following location.
- Current and next events each have their own clickable coordinates/TomTom waypoint.
- Display the box on The Coiled Isle only, throughout Midnight zones, or in all zones.
- Optional Hide in Instances mode for raids, dungeons, delves, scenarios and other instanced content.
- Separate Mute in Dungeons/Raids option suppresses automatic warning audio in dungeon and raid instances without disabling the tracker or chat warning.
- Movable minimap button can show/hide the tracker and temporarily reopen it when automatic rules hide it.
- Lock/Unlock button prevents or allows dragging.
- Shows clickable event coordinates.
- Clicking the coordinates creates a TomTom waypoint when TomTom is enabled.
- Select a warning at 5 minutes, 2 minutes or 1 minute before the Surge begins.
- Select one of five warning sounds: Voice Clip, Raid Warning, Ready Check, Dungeon Ready or Alarm Warning.
- Select the playback channel: Master, Sound Effects, Music, Ambience or Dialog.
- Dedicated Test button plays the current sound through the current channel.
- Pause Next suppresses only the upcoming Surge reminder.
- The next later Surge automatically returns to normal alerting.
- Position, visibility, display scope, instance-hiding choice, dungeon/raid audio mute choice, minimap position/visibility, lock state, warning time, sound choice, channel and alert state are saved.
- Uses Blizzard's Event Scheduler and retries if POI details arrive late.

Install
-------
1. Exit World of Warcraft completely.
2. Extract the CurseSurgeAlert folder into:
   World of Warcraft\_retail_\Interface\AddOns\
3. Start WoW and ensure Curse Surge Alert is enabled in the AddOns list.

Louder custom sound
-------------------
The bundled MP3 is:
Sounds\YouAreCursed.mp3

The bundled copy has been loudness-normalised and peak-limited so it plays much
louder than the original upload without digital clipping. WoW still applies the
volume slider for the selected channel.


Compact options dropdown
------------------------
The tracker starts in its compact layout. Current Active and Next Curse Surge
information, timers and clickable coordinates stay visible at all times.

Click the small cog-wheel in the top-right corner to expand the settings below
the timers. Click it again to collapse the settings. The choice is saved.

All existing controls are inside the expanded section: warning time, display
scope, instance hiding, dungeon/raid audio mute, minimap visibility, sound,
test, channel, Pause Next and Lock/Unlock.

Slash-command alternatives:
/csa options
/csa options open
/csa options close

Display scope
-------------
The Show button cycles between:
- All Zones
- Midnight Zones
- Coiled Isle Only

This controls only the tracker box. Sound alerts remain active in every zone.
Midnight detection follows Blizzard's current map-parent hierarchy, so child
maps and interiors inherit their Midnight zone classification.

If a restrictive choice hides the box where you are standing, use:
/csa scope all


Hide in Instances
-----------------
The Hide in Instances button toggles automatic hiding of the tracker box whenever
WoW reports that the player is inside instanced content. It is enabled by default and covers content such as dungeons, raids, delves and
scenarios.

This setting affects the tracker box only. Audio reminders are controlled separately
by Mute in Dungeons/Raids. If you want the box briefly while inside an instance,
left-click the minimap button; this temporarily overrides the automatic zone/instance
hiding rule until the next loading-screen transition.

Use:
/csa instances on
/csa instances off


Mute in Dungeons/Raids
----------------------
The Mute in Dungeons/Raids button controls only automatic Curse Surge warning
audio. When enabled, the selected Voice/Raid/Ready/Dungeon/Alarm sound is not
played while WoW reports the current instance type as a dungeon (party) or raid.

The tracker remains governed by the separate Hide in Instances setting, and the
chat warning still prints. The Test button and /csa test commands intentionally
still play so you can test sound settings manually while inside an instance.

This option is OFF by default to preserve the previous addon behaviour.

Use:
/csa muteinstances on
/csa muteinstances off

Minimap button
--------------
A Curse Surge Alert button is shown around the minimap by default.
- Left-click: show/hide the tracker.
- If an automatic zone/instance rule hid the tracker, left-click temporarily
  reopens it.
- Drag the minimap button around the minimap to reposition it.
- Its angle/position is saved between sessions.

The panel's Minimap Button control can hide the icon. If needed, restore it with:
/csa minimap on

Other commands:
/csa minimap off
/csa minimap reset

Warning time
------------
The Warning button cycles between:
- 5 minutes
- 2 minutes
- 1 minute

The addon plays one reminder per Surge at the selected time. Changing the
setting does not create a second reminder for a Surge that has already alerted.
The selected warning time is saved between sessions.

Use /csa warning 5, /csa warning 2 or /csa warning 1 to select it directly.

Sound controls
--------------
- Click Sound to cycle through five warning choices:
  1. Voice Clip - bundled, loudness-normalised "You Are Cursed" recording.
  2. Raid Warning - Blizzard RAID_WARNING sound kit.
  3. Ready Check - Blizzard READY_CHECK sound kit.
  4. Dungeon Ready - Blizzard LFG role-check alert sound kit.
  5. Alarm Warning - Blizzard alarm clock warning sound kit.
- Click Channel to cycle through the available playback channels.
- Click Test to play the displayed sound/channel combination immediately.
- The selected mode and channel are saved between sessions.

Master is usually the most reliable channel for an important warning. The other
channels let the alert follow your Sound Effects, Music, Ambience or Dialog
volume settings.

TomTom
------
TomTom is optional. All countdown and reminder features work without it.
With TomTom enabled, click either cyan coordinate line. Use /csa activeway for the current active Surge or /csa waypoint for the next Surge.

Slash commands
--------------
/csa status              Show the active Surge, next Surge and current settings.
/csa test                Test the current sound on the saved channel.
/csa test master         Test on Master without changing the saved channel.
/csa test sfx            Test on Sound Effects without changing the saved channel.
/csa test music          Test on Music without changing the saved channel.
/csa test ambience       Test on Ambience without changing the saved channel.
/csa test dialog         Test on Dialog without changing the saved channel.
/csa sound               Show the selected warning sound.
/csa sound voice         Use the bundled voice clip.
/csa sound raid          Use WoW's Raid Warning sound.
/csa sound ready         Use WoW's Ready Check sound.
/csa sound dungeon       Use WoW's LFG/Dungeon Ready-style alert.
/csa sound alarm         Use WoW's Alarm Warning sound.
/csa voice               Alias for /csa sound voice.
/csa raid                Alias for /csa sound raid.
/csa ready               Alias for /csa sound ready.
/csa dungeon             Alias for /csa sound dungeon.
/csa alarm               Alias for /csa sound alarm.
/csa channel             Show the selected playback channel.
/csa channel master      Save Master as the playback channel.
/csa channel sfx         Save Sound Effects as the playback channel.
/csa channel music       Save Music as the playback channel.
/csa channel ambience    Save Ambience as the playback channel.
/csa channel dialog      Save Dialog as the playback channel.
/csa scope                Show the current tracker display scope.
/csa scope all            Show the tracker in all zones.
/csa scope midnight       Show it only in Midnight zones.
/csa scope coiled         Show it only on The Coiled Isle.
/csa instances             Show the current Hide in Instances setting.
/csa instances on          Hide the tracker in instanced content.
/csa instances off         Allow the tracker in instanced content.
/csa muteinstances          Show the dungeon/raid audio-mute setting.
/csa muteinstances on       Suppress automatic warning sounds in dungeons/raids.
/csa muteinstances off      Allow automatic warning sounds in dungeons/raids.
/csa minimap               Show the minimap-button setting.
/csa minimap on            Show the minimap button.
/csa minimap off           Hide the minimap button.
/csa minimap reset         Reset the minimap button position and show it.
/csa options               Toggle the cog-wheel options dropdown.
/csa options open          Expand the options dropdown.
/csa options close         Collapse the options dropdown.
/csa warning              Show the selected warning time.
/csa warning 5            Warn five minutes before each Surge.
/csa warning 2            Warn two minutes before each Surge.
/csa warning 1            Warn one minute before each Surge.
/csa on                  Enable alerts at the selected warning time.
/csa off                 Disable Curse Surge alerts.
/csa pause               Pause only the next Surge reminder.
/csa resume              Resume the next Surge reminder.
/csa activeway           Create a TomTom waypoint for the active Surge.
/csa currentway          Alias for /csa activeway.
/csa waypoint            Create a TomTom waypoint for the next Surge.
/csa way                 Alias for /csa waypoint.
/csa lock                Lock the timer box.
/csa unlock              Unlock the timer box.
/csa show                Show the timer box.
/csa hide                Hide the timer box.
/csa reset               Reset the timer box position.
/csa rescan              Request and refresh Blizzard's event data.
