# 🎮 BLU | Better Level-Up!
## 🎮 **RGX Mods** - *RealmGX Community Project*

<div align="center">

<img src="https://raw.githubusercontent.com/donniedice/BLU/main/images/BLU_Logo.png" alt="BLU Logo" width="256">

[![BLU Icon](https://img.shields.io/badge/BLU-Better%20Level%20Up!-05dffa?style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==&logoColor=white)](https://github.com/donniedice/BLU)

### 🌟 **Join the <span style="color:#ff6b6b">R</span>ealmGX Community - <span style="color:#4ecdc4">G</span>amers e<span style="color:#4ecdc4">X</span>treme!** 🌟
[![Discord](https://img.shields.io/discord/YOUR_DISCORD_ID?color=7289da&label=Join%20Our%20Discord&logo=discord&logoColor=white&style=for-the-badge)](https://discord.gg/N7kdKAHVVF)

### 🎵 *Experience level-up sounds from your favorite games in WoW!* 🎵

**Professional World of Warcraft addon that replaces default sounds with iconic audio from 50+ games, with extensive customization options.**

**🎯 Connect with fellow gamers, get support, and be part of the RGX Mods family!**

<!-- GitHub Stats & Badges -->
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/donniedice/BLU?style=for-the-badge&logo=github&color=success)](https://github.com/donniedice/BLU/releases)
[![GitHub stars](https://img.shields.io/github/stars/donniedice/BLU?style=for-the-badge&logo=github&color=yellow)](https://github.com/donniedice/BLU/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/donniedice/BLU?style=for-the-badge&logo=github&color=blue)](https://github.com/donniedice/BLU/network/members)
[![GitHub issues](https://img.shields.io/github/issues/donniedice/BLU?style=for-the-badge&logo=github&color=red)](https://github.com/donniedice/BLU/issues)
[![GitHub license](https://img.shields.io/github/license/donniedice/BLU?style=for-the-badge&logo=github&color=lightgrey)](https://github.com/donniedice/BLU/blob/main/LICENSE)

[![GitHub last commit](https://img.shields.io/github/last-commit/donniedice/BLU?style=flat-square&logo=github)](https://github.com/donniedice/BLU/commits/main)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/donniedice/BLU?style=flat-square&logo=github)](https://github.com/donniedice/BLU/graphs/contributors)
[![GitHub repo size](https://img.shields.io/github/repo-size/donniedice/BLU?style=flat-square&logo=github)](https://github.com/donniedice/BLU)
[![GitHub code size](https://img.shields.io/github/languages/code-size/donniedice/BLU?style=flat-square&logo=github)](https://github.com/donniedice/BLU)

<!-- Platform Badges -->
[![CurseForge Downloads](https://img.shields.io/badge/CurseForge-Downloads-orange?style=flat-square&logo=curseforge)](https://www.curseforge.com/wow/addons/blu-better-level-up)
[![Wago Downloads](https://img.shields.io/badge/Wago.io-Downloads-purple?style=flat-square&logo=wago)](https://addons.wago.io/addons/blu)
[![WoWInterface Downloads](https://img.shields.io/badge/WoWInterface-Downloads-blue?style=flat-square&logo=worldofwarcraft)](https://www.wowinterface.com/downloads/info26465-BLU-BetterLevelUp.html)

<!-- WoW Compatibility -->
[![WoW Retail](https://img.shields.io/badge/WoW-The%20War%20Within-green?style=flat-square&logo=worldofwarcraft)](https://worldofwarcraft.com)
[![WoW Cataclysm](https://img.shields.io/badge/WoW-Cataclysm%20Classic-green?style=flat-square&logo=worldofwarcraft)](https://worldofwarcraft.com)
[![WoW Classic](https://img.shields.io/badge/WoW-Classic%20Era-green?style=flat-square&logo=worldofwarcraft)](https://worldofwarcraft.com)

</div>

## 🌟 Join the RGX Mods Community!

<div align="center">

### 💬 **RealmGX Discord - Your Gaming Home!**

[![Join Discord](https://img.shields.io/badge/Join%20Our%20Discord-RealmGX%20Community-7289da?style=for-the-badge&logo=discord&logoColor=white&labelColor=5865F2)](https://discord.gg/N7kdKAHVVF)

**🎮 <span style="color:#ff6b6b">R</span>ealm <span style="color:#4ecdc4">G</span>amers e<span style="color:#4ecdc4">X</span>treme - Where WoW Enthusiasts Unite!**

✨ **What awaits you in our Discord:**
- 🛠️  **Instant addon support** from the RGX Mods team
- 🎯 **Feature requests** and direct dev communication
- 🚀 **Beta testing** opportunities for new releases
- 🤝 **Community of WoW players** sharing tips and experiences
- 📢 **First to know** about new RGX Mods releases
- 🎉 **Events, giveaways**, and community activities

</div>

## 💖 Support RGX Mods

<div align="center">

**Your support helps keep RGX Mods alive and constantly improving!**

<a href="https://www.buymeacoffee.com/donniedice" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>

[![Donate](https://img.shields.io/badge/Donate-CashApp-00C853?style=for-the-badge&logo=cash-app&logoColor=white)](https://bit.ly/3fyxxSU)
[![GitHub Sponsor](https://img.shields.io/badge/Sponsor-GitHub-ff69b4?style=for-the-badge&logo=github-sponsors&logoColor=white)](https://github.com/sponsors/donniedice)

[![Star this repository](https://img.shields.io/badge/⭐-Star%20this%20repository-yellow?style=for-the-badge&logo=github)](https://github.com/donniedice/BLU)

*Every coffee helps fund new features and sound additions!*

</div>

## 🎯 What is BLU?

**BLU | Better Level-Up!** transforms the repetitive sounds in World of Warcraft by letting you hear iconic sounds from your favorite games when you level-up, complete activities, gain reputation, or achieve milestones. With support for over 50 games and extensive customization options, BLU makes every achievement feel special.

## 🎮 Supported Events Matrix

<div align="center">

| Event | Retail | Cata Classic | MoP Remix | Classic Era |
|:------|:------:|:------------:|:---------:|:-----------:|
| ⭐ **Level-Up** | ✅ | ✅ | ✅ | ✅ |
| 📜 **Quest Accept** | ✅ | ✅ | ✅ | ✅ |
| ✅ **Quest Complete** | ✅ | ✅ | ✅ | ✅ |
| 📈 **Reputation Rank-Up** | ✅ | ✅ | ✅ | ✅ |
| 🏆 **Achievement Earned** | ✅ | ✅ | ✅ | ❌ |
| 🐾 **Battle Pet Level-Up** | ✅ | ❌ | ✅ | ❌ |
| ⚔️ **Honor Level-Up** | ✅ | ❌ | ❌ | ❌ |
| 👑 **Renown Rank-Up** | ✅ | ❌ | ❌ | ❌ |
| 🛒 **Trading Post Complete** | ✅ | ❌ | ❌ | ❌ |
| 🗡️ **Delve Companion Level-Up** | ✅ | ❌ | ❌ | ❌ |

</div>

## ✨ Features

<div align="center">

| Feature | Description | Availability |
|---------|-------------|--------------|
| 🎵 **50+ Game Sounds** | Choose from iconic sounds from games like Final Fantasy, Zelda, Mario, and more | All Versions |
| 🔊 **Volume Control** | Independent volume adjustment for each sound type (Off, Low, Medium, High) | All Versions |
| ⚙️ **Smart Management** | Automatically mutes default WoW sounds when replacing | All Versions |
| 💾 **Persistent Settings** | Your preferences are saved between sessions | All Versions |
| 🎨 **Professional UI** | Clean options panel with intuitive controls | All Versions |
| 🛡️ **Error-Free** | Comprehensive error handling and validation | All Versions |
| 🔧 **Debug Mode** | Built-in debugging for troubleshooting | All Versions |

</div>

## 🚀 Quick Start

1. **Install** BLU from your preferred platform
2. **Launch** World of Warcraft
3. **Type** `/blu` to open the options panel
4. **Choose** your favorite sounds for each event
5. **Enjoy** your personalized WoW experience!

## 📋 Command Reference

<div align="center">

| Command | Description |
|---------|-------------|
| `/blu` | Open the options panel |
| `/blu help` | Display help information |
| `/blu debug` | Toggle debug mode on/off |
| `/blu welcome` | Toggle welcome message on/off |

</div>

## 🎵 Available Game Sounds

<div align="center">

### 🎮 **50+ Games Available!**

| | | |
|---|---|---|
| Altered Beast | Fly For Fun | Old School Runescape |
| Assassin's Creed | Fortnite | Palworld |
| Castlevania | GTA - San Andreas | Path of Exile |
| Diablo 2 | Kingdom Hearts 3 | Pokemon |
| Dragon Quest | Kirby | Ragnarok Online |
| DotA 2 | League of Legends | Shining Force 2 |
| Elden Ring | Legend of Zelda | Shining Force 3 |
| EverQuest | Maplestory | Skyrim |
| Fallout - New Vegas | Metal Gear Solid 5 | Sonic the Hedgehog |
| Fallout 3 | Minecraft | Spyro The Dragon |
| Final Fantasy | Modern Warfare 2 | Super Mario Bros 3 |
| Fire Emblem | Morrowind | Warcraft 3 |
| Fire Emblem Awakening | | The Witcher 3 |

*`Note`: Each game includes Low, Medium, and High volume variants for all sound types.*

### 🎯 **Special Sound Collections**
- **Elden Ring**: 6 unique variations
- **Shining Force 3**: 11 different battle themes
- **Warcraft 3**: Multiple unit acknowledgment sounds
- **The Witcher 3**: Quest completion variations

</div>

## 🎮 Sound Events

### Supported Events:
- **Level-Up**: Play custom sounds when you gain a level
- **Achievements**: Celebrate achievements with unique sounds
- **Quest Accept**: Custom sound when accepting quests
- **Quest Complete**: Rewarding sounds for quest turn-ins
- **Reputation Gains**: Audio feedback for reputation increases
- **Battle Pet Level-Up**: Special sounds for pet leveling (Retail/MoP only)
- **Trading Post**: Completion sounds for activities (Retail only)
- **Honor Ranks**: Recognition for PvP progression (Retail only)
- **Renown**: Sounds for renown reputation gains (Retail only)
- **Delve Companion**: Level-up sounds for your companion (Retail only)

### Volume Options:
Each sound type has three volume levels:
- **High**: Full volume for maximum impact
- **Medium**: Balanced volume (default)
- **Low**: Subtle volume for background play

## 📥 Installation

1. **Download** from your preferred platform:
   - [CurseForge](https://www.curseforge.com/wow/addons/blu-better-level-up)
   - [Wago.io](https://addons.wago.io/addons/blu)
   - [WoWInterface](https://www.wowinterface.com/downloads/info26465-BLU-BetterLevelUp.html)
   - [GitHub](https://github.com/donniedice/BLU)

2. **Extract** to your WoW AddOns directory:
   - **Retail**: `World of Warcraft/_retail_/Interface/AddOns`
   - **Cata Classic**: `World of Warcraft/_classic_/Interface/AddOns`
   - **Classic Era**: `World of Warcraft/_classic_era_/Interface/AddOns`

3. **Restart** WoW and enable in AddOns menu

## 🛠️ Configuration Tips

### Recommended Settings:
- **Level-Up**: Final Fantasy, Pokemon, or Zelda for nostalgic feels
- **Achievements**: Elden Ring or Dark Souls for epic moments  
- **Quests**: Skyrim or Witcher 3 for immersive RPG experience
- **Reputation**: Warcraft 3 sounds to stay in the Warcraft universe

### Performance:
- Use "Low" volume variants if you experience any audio delays
- Debug mode can help identify any issues with sound playback
- All sounds are optimized .ogg files for minimal impact

## 🐛 Known Issues

- Double quest accept sound in Classic is a Blizzard bug, not BLU-related
- Some sounds may have slight delays on first play (cached after)

## 🤝 Contributing

Contributions are welcome! Feel free to:
- Report bugs via [GitHub Issues](https://github.com/donniedice/BLU/issues)
- Submit pull requests with improvements
- Suggest new game sounds to add
- Help with translations

## 📊 Repository Statistics

<div align="center">

[![GitHub Activity Graph](https://github-readme-activity-graph.vercel.app/graph?username=donniedice&theme=react-dark&hide_border=true)](https://github.com/donniedice/BLU)

</div>

---

## 📈 Project Metrics

<div align="center">

| Metric | Value |
|--------|-------|
| **Repository Size** | ![GitHub repo size](https://img.shields.io/github/repo-size/donniedice/BLU?style=flat-square) |
| **Last Commit** | ![GitHub last commit](https://img.shields.io/github/last-commit/donniedice/BLU?style=flat-square) |
| **Open Issues** | ![GitHub issues](https://img.shields.io/github/issues/donniedice/BLU?style=flat-square) |
| **Pull Requests** | ![GitHub pull requests](https://img.shields.io/github/issues-pr/donniedice/BLU?style=flat-square) |
| **Contributors** | ![GitHub contributors](https://img.shields.io/github/contributors/donniedice/BLU?style=flat-square) |
| **Total Game Sounds** | 50+ unique games |
| **Sound Files** | 198 audio files |
| **Supported Events** | 10 event types |
| **Languages** | ![GitHub top language](https://img.shields.io/github/languages/top/donniedice/BLU?style=flat-square) |
| **Watchers** | ![GitHub watchers](https://img.shields.io/github/watchers/donniedice/BLU?style=flat-square) |

</div>

---

## 🤝 Contributors

<div align="center">

Thanks to all the amazing people who have contributed to BLU! 🎉

<a href="https://github.com/donniedice/BLU/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=donniedice/BLU" alt="Contributors" />
</a>

</div>


---

<div align="center">

## 🌟 **Thank you for choosing RGX Mods!** 🌟

**Made with ❤️ by the RealmGX Community**

**Lead Developer: [DonnieDice](https://github.com/donniedice)**

*"Make every level count with sounds that matter!"*

[![Join Discord](https://img.shields.io/badge/🎮%20Join%20RealmGX%20Discord-Realm%20Gamers%20eXtreme-7289da?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/N7kdKAHVVF)

[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-Support%20RGX%20Mods-yellow?style=for-the-badge)](https://www.buymeacoffee.com/donniedice)
[![GitHub Stars](https://img.shields.io/github/stars/donniedice/BLU?style=for-the-badge&logo=github)](https://github.com/donniedice/BLU)

**🎮 RGX Mods - Powered by RealmGX Community**

</div>