# 🌟 Treasure Chest System
## 🗺️ Description
A dynamic treasure chest system for **AzerothCore** that allows Game Masters to create and manage treasure chests with custom loot and hints. Players can discover and loot these chests, with server-wide announcements for discoveries.
---
## 🚀 Installation Guide
Follow these steps to install the script:
### 1️⃣ **Download the Files**
- **Lua Script**: Copy the `treasure_chest_system.lua` file to your `lua_scripts` folder.
> 📂 **Path Example**: `AzerothCore/server/lua_scripts/`
- **SQL Script**: Execute the SQL installation file in your **world** database.
### 2️⃣ **Execute the SQL Script**
1. Open a database management tool like **HeidiSQL**, **Navicat**, or **MySQL Workbench**.
2. Connect to your **AzerothCore world database** (commonly named `acore_world`).
3. Import and execute the provided SQL script (`treasure_chest_install.sql`).
### 3️⃣ **Restart the Server**
Once the Lua script is in place and the SQL script is executed:
1. Restart your server to load the new script and changes.
2. You’re good to go! 🎉
---
## 📜 SQL Details
The SQL installation script:
- 🛠️ **Creates** a custom gameobject (ID: `500001`).
- 🎨 **Sets** the chest model (`DisplayID: 8686`).
- ⚙️ **Configures** basic properties (type `3` for chest).
- 🎁 **Adds** initial test loot:
- 🧵 *Linen Cloth*
- 🧀 *Darnassian Bleu*
- 🧵 *Silk Cloth*
- 🔗 **Links** loot templates properly to the chest.
---
## ⚙️ Configuration
Customize the script with the following options in the `CONFIG` table:
```lua
CONFIG = {
CHEST_ENTRY = 500001, -- Must match SQL entry ID
DEBUG = false, -- Enable/disable debug messages
MIN_GM_LEVEL = 3, -- Minimum GM level required to use commands
ANNOUNCE_COLOR = "|cFFFFFF00", -- Color for announcements
ERROR_COLOR = "|cFFFF0000", -- Color for error messages
SUCCESS_COLOR = "|cFF00FF00" -- Color for success messages
}The system uses different colors to improve visibility:
- 🟡 Yellow: General announcements
- 🔴 Red: Error messages
- 🟢 Green: Success messages
- ⚪ White: Standard information
- AzerothCore v4.0.0+
- Eluna Lua Engine
- Loot Changes: Always use
.reload gameobject_loot_templateafter adding items for changes to take effect. - Persistence: Chest contents remain in the database until manually cleared.
- Verify you used
.reload gameobject_loot_template. - Check if the item ID exists in the database.
- Ensure your GM level is 3 or higher.
- Check the console for error messages.
- Confirm the gameobject entry exists in the database.
- Make sure you're in a valid location.
#chest spawn- 🗺️ Spawns a treasure chest at your location.#chest list- 📜 Lists the current chest contents.#chest clear- 🧹 Clears all chest contents.#chest add <itemID> <count>- 🎁 Adds an item to the chest.- 📝 Note: Use
.reload gameobject_loot_templateafter adding items!
- 📝 Note: Use
#chest gold <amount>- 💰 Sets gold amount.#chest reload- 🔄 Reloads chest loot templates.#chest hint- ❓ Displays the current chest hint.#chest addhint <text>- 🖋️ Sets a hint for the chest.
1. #chest add 49426 1 // Add item to chest
2. .reload gameobject_loot_template // Reload templates
3. #chest spawn // Spawn the chest with updated loot
- Zyggy123 - Original script development.
This module is released under the GNU AGPL v3.
For issues and feature requests, please use the GitHub issue tracker.
- Fork the repository.
- Create your feature branch.
- Commit your changes.
- Push to the branch.
- Create a Pull Request.
- 1.0.0
- Initial release with basic chest functionality.
- Command system.
- SQL installation script included.
