🧙‍♂️ Beginner Companion (Eluna Module)

A fully featured, interactive, and modular personal guide for World of Warcraft servers (3.3.5a). Powered by the Eluna Lua Engine, the Beginner Companion is designed to assist new players by providing an in-game Wiki, random helpful tips, dynamic personalities, and a progression system that rewards them for learning!

---

✨ Features

• Quick Summoning: Players can summon or dismiss their companion anywhere by typing .newplayer. The companion will follow them for 60 seconds before automatically despawning.
• In-Game Wiki System: A multi-layered gossip menu acting as an in-game wiki for things like Dungeons, Professions, Classes, and generic server info.
• Journal & Rewards Progression:
  • Every time a player reads a new wiki article, it gets saved in their Journal.
  • Reaching reading milestones automatically rewards the player!
    • 5 Articles: 4x Netherweave Bags
    • 10 Articles: Potions Bundle (Health, Mana, Speed)
    • 15 Articles: 500 Gold
    • 20 Articles: Lil' Smoky Companion Pet
• Dynamic Personalities: Players can choose how their companion talks (Friendly, Serious, or Funny). The companion's greetings change based on this selection.
• Random Tips: Right before despawning, the companion will whisper a random helpful tip to the player.
• Persistent Data: History of read articles and chosen personality is saved in the Character Database to persist across logins.

---

🛠️ Requirements

• World of Warcraft 3.3.5a (AzerothCore or TrinityCore)
• Eluna Lua Engine installed on your core.

---

🚀 Installation

1. Database Setup

You need to import the SQL files to create the Companion NPC and the player data tables.

1. Run sql/world/base/beginner_companion_world.sql into your World database.
2. Run sql/characters/base/beginner_companion_characters.sql into your Characters database.

2. Lua Scripts

1. Copy the lua_scripts/BeginnerCompanion folder.
2. Paste it directly into your server's lua_scripts directory.

3. Configuration (Optional)

The script comes with default variables already configured, but you can override them using the .conf file.

1. Open the conf folder and rename beginner_companion.conf.dist to beginner_companion.conf.
2. Move it to your server's etc / modules folder, OR copy the contents and paste them at the bottom of your worldserver.conf.

(Alternatively, you can edit the variables directly in lua_scripts/BeginnerCompanion/core/config.lua).

---

🎮 Usage In-Game

• Type .newplayer in chat to summon your companion.
• Right-click the summoned companion to open the Main Menu.
• Explore the Wiki to read articles and gain rewards.
• Check your Journal to track your progress and see how many articles you need for the next reward.
• Change the Personality to customize how your companion talks to you.
• Type .newplayer again to dismiss the companion early, or wait 60 seconds.

---

📂 File Structure

• /conf - Contains the configuration template.
• /sql - Contains the World and Character database queries.
• /lua_scripts/BeginnerCompanion
  • /core - Core mechanics (Events, Database connection, Movement, Gossip logic).
  • /modules - Feature modules (Wiki, Journal, Cosmetics, Personality, Tips).
  • /data - Easily editable data files (wiki_data.lua, tips_data.lua).

✍️ Customization

To add new Wiki articles, modify data/wiki_data.lua. To add new random Tips, modify data/tips_data.lua. To change the rewards given, open modules/cosmetics.lua and adjust the IDs.