WoW-Lights

# WoW Lights Retail Revival

WoW Lights brings World of Warcraft events to per-key RGB keyboards. The addon renders a compact 6x3 animated color grid in the lower-left corner of the game. Logitech G Hub Screen Sampler mirrors those colors across groups of keyboard keys.

Combat can pulse red, looted money can sweep across the keyboard in coin colors, achievements and level-ups can trigger celebratory animations, and many other original WoW Lights effects are preserved.

## Credits

**Original addon, concept, artwork, animations, and documentation:** Waldokind / JD-Softcode  
**Retail 12.1.0 revival and G Hub helper safety fixes:** JC

Original project and illustrated guide:  
[WoW Lights by JD-Softcode](http://www.jdsoftcode.net/wow-lights.html)

## Requirements

- World of Warcraft Retail 12.1.0
- A per-key RGB keyboard
- Logitech G Hub with Screen Sampler for the included setup workflow
- The separately downloadable **WoW Lights G Hub Setup Tool 3.1** for first-time G Hub configuration

The addon can display its grid without G Hub, but keyboard lighting requires compatible screen-sampling software.

## Addon installation

1. Install through the CurseForge app or extract `Wowlights` into `_retail_/Interface/AddOns`.
2. Enable **WoW Lights 1.4 Retail Revival**.
3. Type `/wlights` or `/wowlights`.

## Logitech G Hub setup

1. Create a World of Warcraft profile associated with `_retail_/Wow.exe`.
2. Select **LIGHTSYNC > Screen Sampler**.
3. Rename the five default samples exactly: `wl11`, `wl12`, `wl13`, `wl14`, `wl15`.
4. Completely quit G Hub.
5. Download and run the separate **G Hub Setup Tool 3.1**. It makes a timestamped backup and creates the complete 18-sample layout.
6. Restart G Hub and distribute keyboard keys over:

```
wl11 wl12 wl13 wl14 wl15 wl16
wl21 wl22 wl23 wl24 wl25 wl26
wl31 wl32 wl33 wl34 wl35 wl36
```

7. Open `/wlights`, click **Cal Colors**, and adjust **Frame Size** until the keyboard matches the 6x3 test pattern.

Frame Size depends on display resolution, operating-system scaling, WoW UI scale, and sampler geometry. It is not specific to a keyboard model.

## Version 1.4.2

- Updated for Retail Interface 120100.
- Fixed Retail 12.1 secret combat-health errors.
- Fixed protected aura access during combat.
- Fixed persistent Frame Size entry.
- Added an attribution/version footer and project information window.
- Preserved the original animations and per-character color profiles.

## Privacy and safety

The addon does not use external network services. The optional Python helper operates locally on Logitech G Hub's `settings.db` and creates a timestamped backup before changing it.

Please include the first complete Lua error, WoW build, G Hub version, keyboard model, resolution, and Windows scaling when reporting a problem.