CursorRing

---

CursorRing is a World of Warcraft addon that enhances your mouse cursor with a customizable, class-colored ring, real-time spell cast/channel progress, and optional mouse trail effects. It is inspired by the excellent Ultimate Mouse Cursor WeakAura by Ultimate and improved by the contributions of my brother.

---

Features

• Class-colored cursor ring
  • Matches your character’s class color or a custom RGB color.
  • Customizable shape between Ring, Thin Ring, and Star (more coming soon)
• Cast progress display
  • Real-time radial cast bar or fill during casts and channels.
  • Customizable color
• Visibility control
  • Only show in combat/instances, or always show.
• Mouse Trail & Sparkles
  • Optional glowing trail and sparkle effect behind the cursor.
  • Customizable trail/sparkle color and fade length.
  • Customizable sparkle size
• Full in-game configuration
  • Accessible via Options → AddOns → CursorRing or the modern Settings menu.
• Persistent, per-spec settings
  • Persistent settings stored in character-specific SavedVariables

---

Textures and Assets

The addon expects the following files in
Interface\AddOns\CursorRing\:

• ring.tga — main cursor ring
• ring_fill.tga - fill texture for the main cursor ring
• thin_ring.tga — thin option for the main cursor ring
• thin_ring_fill.tga — fill texture for the thin option for the main cursor ring
• star.tga — star option for the main cursor ring
• star_fill.tga — fill texture for the star option for the main cursor ring
• cast_segment.tga — segment for cast/channel progress ring
• cast_wedge.tga - wedge for cast/channel progress wedge option
• sparkle.tga
• trail_glow.tga

---

Installation

1. Download or clone this repository:

   git clone https://github.com/RedAntisocial/CursorRing.git

2. Put the CursorRing folder inside your WoW AddOns directory:

   World of Warcraft/_retail_/Interface/AddOns/CursorRing/
   

3. Ensure the required files from the assets section are present.
4. Reload your UI (/reload).

Alternatively, use your favourite addon manager (Wago, CurseForge, etc).

---

Usage & Configuration

• Open the options panel:
  • In-game: Interface → AddOns → CursorRing or via the new Settings system.
• Configure:
  • Cursor ring enabled, size, color (or reset to class color)
  • Cast ring style and color
  • Mouse trail (toggle, color, length)
  • Sparkle effect for mouse trail
  • Trail/sparkle color pickers
  • Show only in combat/instances or anywhere

Commands

• Type /reload after changing settings for best results (or use in-game settings).

---

Technical Summary

• Language: Lua, WoW API (no dependencies outside Blizzard UI)
• Event-driven: Handles spellcast, combat, spec, zone, and login events automatically
• Saved Variables (per-spec):
  • CursorRingDB.ringEnabled
  • CursorRingDB.ringSize
  • CursorRingDB.ringColor
  • CursorRingDB.castColor
  • CursorRingDB.showOutOfCombat
  • CursorRingDB.castStyle
  • CursorRingDB.mouseTrail
  • CursorRingDB.sparkleTrail
  • CursorRingDB.trailFadeTime
  • CursorRingDB.trailColor
  • CursorRingDB.sparkleColor

---

Contributing

Contributions and feature requests are welcome!

• Submit issues or pull requests via GitHub.
• Follow Blizzard’s Lua API standards.
• Test changes with /reload and enable script errors using /console scriptErrors 1.
• Ensure compatibility with Retail (The War Within and Midnight).

---

Credits

• Authors: Alex Pierce and brother.
• Art & Design: Alex Pierce (GIMP 3.x) and WoW artists whose icons are used.
• Special Thanks: Blizzard UI API authors, and Ultimate Mouse Cursor.

---

License

This project is licensed under the GNU General Public License v3.0 (GPL v3).
You are free to modify and redistribute under the same terms.
Full text: https://www.gnu.org/licenses/gpl-3.0.html

---