# BLU | Better Level-Up!

[![In-Game Options - Preview Image](https://mods.dicematrix.cloud/sites/default/files/images/preview.png)](https://mods.dicematrix.cloud/sites/default/files/images/preview.png)

## Overview

**BLU | Better Level-Up!** changes up the repetitive sounds in World of Warcraft, giving you the option to hear sounds from other games when you level-up, complete Trade Post activities, gain reputation, or level-up your Delve Companion.

## Features

- **Achievements:** Play sounds from other games when you earn achievements.
- **Battle-Pets:** *(`R`etail Only)* Play sounds from other games when you level-up battle-pets.
- **Delve Companion Level-Up:** *(`R`etail Only)* Play sounds from other games when your Delve Companion levels-up.
- **Honor Ranks:** *(`R`etail Only)* Play sounds from other games when you gain honor ranks.
- **Level-Up:** Play sounds from other games when you level-up.
- **Renown Reputation Ranks:** *(`R`etail Only)* Play sounds from other games when you gain renown reputation ranks.
- **Reputation Ranks:** Play sounds from other games when you gain reputation ranks.
- **Quests:** Play sounds from other games when you accept or turn in quests.
- **Trading Post Activities:** *(`R`etail Only)* Play sounds from other games when you complete Trading Post activities.

*`Note`: All sounds feature independent volume adjustment capability.*

## Slash Commands

The addon can be managed using the following slash commands:

* `/blu`: Opens the options panel.
* `/blu debug`: Toggles debug mode.
* `/blu welcome`: Toggles the welcome message on login.
* `/blu help`: Displays help information.

## Available Game Sounds

|   |   |   |
|---|---|---|
| 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 | Skyrim |
| Elden Ring | Legend of Zelda | Spyro The Dragon | 
| EverQuest | Maplestory | Super Mario Bros 3 |
| Fallout - New Vegas | Metal Gear Solid 5 | The Witcher 3 |
| Fallout 3 | Minecraft |  |
| Final Fantasy | Modern Warfare 2 |  |
| Fire Emblem | Morrowind |  | 

*`Note`: When new sounds are added, they are listed in alphabetical order. This may change the selection order in the code for `sounds.lua`. You may need to re-select previously selected sounds after updates.*

## Compatibility

* **The War Within**
* **Classic WoW** (Season of Discovery, Classic Hardcore)
* **Classic Cataclysm**

*`Note`: Double Quest Accept Sound in WoW Classic is a game bug, not related to BLU.*

## Installation

1. **Download** the addon from:
    * [CurseForge](https://www.curseforge.com/wow/addons/blu-better-level-up)
    * [GitHub](https://github.com/donniedice/BLU)
    * [Wago.io](https://addons.wago.io/addons/blu)
    * [WoWInterface](https://www.wowinterface.com/downloads/info26465-BLU-BetterLevelUp.html)
2. **Extract** to your WoW `Interface/AddOns` directory:
    * For **The War Within**: `World of Warcraft/_retail_/Interface/AddOns`
    * For **Classic Cataclysm**: `World of Warcraft/_classic_/Interface/AddOns`
    * For **Classic WoW** (Season of Discovery, Classic Hardcore): `World of Warcraft/_classic_era_/Interface/AddOns`
3. **Restart WoW** and enable the addon in the AddOns menu.


## Support the Project

* **Buy Me a Coffee:** [☕️ Donate](https://www.buymeacoffee.com/donniedice)
* **Donate via CashApp:** [💸 Donate](https://bit.ly/3fyxxSU)
* **Star on GitHub:** [⭐️ BLU](https://github.com/donniedice/BLU)
* **Share:** Share it with friends and guildmates!

## Feedback and Contributions

Your feedback is valuable! If you encounter any issues or have suggestions:

* **Report Issues:** [GitHub Issues](https://github.com/donniedice/BLU/issues)
* **Contribute:** Submit a pull request on [GitHub](https://github.com/donniedice/BLU).
* **Contact:** Reach out via [GitHub](https://github.com/donniedice).

## License

This project is licensed under the [MIT License](https://github.com/donniedice/BLU/blob/main/LICENSE).

## Disclaimer

**Disclaimer:** This addon is provided "as is" without warranty. Use at your own risk. The author is not responsible for any issues arising from its use.