Files
AzerothCore-RealmMaster/docs/MODULES.md
uprightbass360 82a5104e87 profile updates
2025-11-27 01:06:48 -05:00

19 KiB

AzerothCore RealmMaster - Module Catalog

This document provides a comprehensive overview of all available modules in the AzerothCore RealmMaster project. These modules enhance gameplay, provide quality-of-life improvements, add new features, and extend server functionality.

Overview

AzerothCore RealmMaster currently ships a manifest of 348 modules (221 marked supported/active). The default RealmMaster preset enables 33 of these for day-to-day testing. All modules are automatically downloaded, configured, and SQL scripts executed when enabled. Modules are organized into logical categories for easy browsing and selection.

How Modules Work

  • Automatic Integration: All enabled modules are automatically downloaded and configured during deployment
  • SQL Automation: Database scripts are executed automatically for enabled modules
  • Configuration Management: Module configuration files are automatically created and managed
  • Profile-Based Deployment: Different deployment profiles support various module combinations

Module Categories

The module collection is organized into the following categories:


Automation

Module Description
mod-ollama-chat Connects playerbots to an Ollama LLM so they can chat with humans organically
mod-player-bot-level-brackets Keeps bot levels spread evenly across configured brackets
mod-playerbots Adds scriptable playerbot characters that can form dungeon parties, raid, and PvP with humans
npcbot-extended-commands Provides gear templates, transmog clearing, and chat features for NPC bots

Quality of Life

Module Description
mod-aoe-loot Lets characters loot multiple corpses with one click for faster farming
mod-auto-revive Automatically resurrects characters on death—handy for casual PvE or testing realms
mod-fireworks-on-level Spawns celebratory fireworks whenever a player dings a new level
mod-instance-reset Adds commands to reset instances quickly—useful for testing or events
mod-learn-spells Teaches class spells automatically at the correct level to streamline leveling
mod-solo-lfg A solo-friendly queue that lets every player run dungeons without needing a premade group

Gameplay Enhancement

Module Description
DungeonRespawn Teleports dead players back to the dungeon entrance instead of a distant graveyard
StatBooster Lets players refine gear stats by rerolling random enchantments with special materials
horadric-cube-for-world-of-warcraft Diablo II-inspired crafting system with item synthesis and transmutation
lua-hardcoremode Implements hardcore mode system allowing activation via NPC token
mod-TimeIsTime Adds experimental time-twisting mechanics suited for custom events
mod-autobalance Adjusts creature health and damage in real time to keep fights tuned for the current party size
mod-challenge-modes Implements keystone-style timed runs with leaderboards and scaling modifiers
mod-duel-reset Adds some duel reset features
mod-solocraft Automatically scales dungeon and raid encounters for solo players or small teams

NPC Services

Module Description
azerothcore-lua-multivendor Enables multiple NPC merchants with database integration
mod-assistant Spawns an all-purpose assistant NPC with heirlooms, professions, and convenience commands
mod-npc-beastmaster Adds an NPC who can teach, reset, and manage hunter pets for convenience
mod-npc-buffer Provides a ready-to-use buff NPC who hands out class buffs, food, and utility spells
mod-npc-enchanter Introduces an enchanting vendor who applies enchants directly for a fee
mod-npc-free-professions Makes a ProfessionsNPC who gives 2 free professions (full with recipes) to player
mod-npc-talent-template An NPC that allows players to instantly apply pre-configured character templates that gear up, gem, set talents, and apply glyphs for any class
mod-reagent-bank Lets players stash crafting reagents with a dedicated banker NPC
mod-transmog Adds a transmogrification vendor so players can restyle gear without changing stats

PvP

Module Description
mod-1v1-arena Creates a structured 1v1 ranked arena ladder for duel enthusiasts
mod-arena-replay Allows you to watch a replay of rated arena games
mod-gain-honor-guard Awards honor when players kill city guards, spicing up world PvP raids
mod-phased-duels Moves duelers into their own phase to block interference and griefing
mod-pvp-titles Restores classic honor titles with a configurable ranking ladder
ultimate-full-loot-pvp Spawns loot chests containing gear and gold when players die in PvP

Progression

Module Description
mod-dynamic-xp Tweaks XP gain based on population or custom rules to keep leveling flexible
mod-individual-progression Tracks each character through Vanilla → TBC → WotLK progression, unlocking content sequentially
mod-item-level-up Creates an item that allows you to level up (id = 701001)
mod-progression-system Allows for the automatic loading of scripts and SQL files based on level brackets
mod-promotion-azerothcore Allows player to receive a promotion consisting of a level 90 character, backpacks, gold, armor, and a mount
mod-quest-count-level Enables leveling exclusively through questing by awarding tokens after quest completion
mod-weekend-xp XP module that allows server owner to select how much XP players can receive on the weekend via config file
mod-zone-difficulty Support module for mod-progression-system, handles nerfs and debuffs per zone

Economy

Module Description
acore-exchangenpc Spawns a customizable NPC vendor that exchanges materials based on settings
azerothcore-global-mail-banking-auctions Allows access to bank, mailbox, and auction house from anywhere via chat commands
azerothcore-lua-ah-bot Automated auction house bot for buying and selling items
dynamic-trader Provides auction house alternative with dynamic pricing
lottery-lua Implements customizable lottery system where players can win prizes
mod-ahbot Populates the auction house with configurable buying/selling behavior to keep markets active
mod-black-market Backports the Mists-era Black Market Auction House via Eluna scripts
mod-random-enchants Rolls randomized stat bonuses on loot to add Diablo-style gear chasing

Social

Module Description
acore-discordnotifier Relays in-game chat events to Discord channels
acore-tempannouncements Allows GMs to create temporary server announcements that repeat at intervals
activechat Populates artificial world and guild chat to make servers feel more lively
mod-boss-announcer Broadcasts dramatic messages when raid bosses fall to your players
mod-breaking-news-override Replaces the client breaking-news panel with server-managed announcements
mod-global-chat Simple global chat for AzerothCore enabling worldserver-wide messaging functionality

Account-Wide

Module Description
azerothcore-eluna-accountwide Shares achievements, currency, mounts, and reputation across account characters
mod-account-achievements Shares achievements across characters on the same account for persistent milestones
mod-account-mounts Goes through the list of characters on an account to obtain playerGuids and store mount spells that all characters know

Customization

Module Description
azerothcore-transmog-3.3.5a Transmogrification system built with AIO and Eluna for changing equipment appearance
mod-arac Unlocks every race/class pairing so players can roll any combination
mod-morphsummon Change appearance of summoned permanent creatures
mod-worgoblin Enables Worgen and Goblin characters with DB/DBC adjustments

Scripting

Module Description
acore-eventscripts Lua scripts that spawn custom NPCs with scripted combat and community events
eluna-scripts Collection of Lua scripts for creating custom gameplay mechanics and features
eluna-ts Adds a TS-to-Lua workflow so Eluna scripts can be authored with modern tooling
mod-aio Pure Lua server-client communication system for bidirectional data transmission
mod-ale Adds Eluna Lua scripting engine for creating custom gameplay mechanics

Admin Tools

Module Description
acore-carboncopy Enables creating character copies at specific progression points for twinking
acore-sendandbind Allows admins to send soulbound items to players via command
acore-zonecheck Checks player zones and automatically removes players from restricted areas
mod-antifarming Port of the AntiFarming Script from SymbolixDEV's repo to AzerothCore
mod-keep-out Keeps players who are non-GM from entering a zone/map
mod-server-auto-shutdown Establishes a daily restart with configurable time, notification period, and custom messages
mod-spell-regulator Modify the percentage of the spells by regulating in the best way
mod-who-logged Outputs to the console when a player logs into the world

Premium/VIP

Module Description
mod-acore-subscriptions Handles the subscription logic, no longer requires modules or services to have subscription logic in their code
mod-premium Adds Premium account features to players
mod-system-vip System offering VIP features and benefits to players

Mini-Games

Module Description
aio-blackjack Implements a Blackjack game for players to gamble against an NPC dealer
mod-pocket-portal Gives players a portal gadget for quick travel to configured destinations
mod-tic-tac-toe Allows players to play Tic Tac Toe between players and against different AI

Content

Module Description
mod-azerothshard Bundles AzerothShard tweaks: utility NPCs, scripted events, and gameplay improvements
mod-bg-slaveryvalley Adds the Slavery Valley battleground complete with objectives and queue hooks
mod-guildhouse Phased guild house system allowing guild members to visit their private guild house
mod-war-effort Brings back the war effort of the two factions for the opening of the gates of Ahn'Qiraj
treasure-chest-system Allows GMs to create and manage treasure chests with custom loot

Rewards

Module Description
acore-levelupreward Rewards players with in-game mail when reaching certain levels
acore-recruitafriend Implements Recruit-a-Friend system with rewards for reaching level milestones
mod-resurrection-scroll Allows users to grant rested XP bonuses to players who have not logged in X days
mod-reward-played-time Adds items for players that have stayed logged in for x amount of time
prestige-and-draft-mode Enables characters to reset to level one for prestige rewards with optional spell selection

Developer Tools

Module Description
skeleton-module Provides a minimal AzerothCore module scaffold for building new features

Module Selection and Configuration

Using Setup Script

The interactive setup script allows you to easily select modules:

./setup.sh

This will present a menu for selecting individual modules or choosing from predefined module profiles.

Module Profiles

Pre-configured module combinations are available in config/module-profiles/:

  • RealmMaster - 33-module baseline used for day-to-day testing
  • suggested-modules - Light AzerothCore QoL stack without playerbots
  • playerbots-suggested-modules - Suggested QoL stack plus playerbots
  • azerothcore-vanilla - Pure AzerothCore with no optional modules
  • playerbots-only - Playerbot prerequisites only
  • all-modules - Everything in the manifest (not recommended)
  • Custom profiles - Drop new JSON files to add your own combinations

Manual Configuration

You can also enable modules by setting environment variables in your .env file:

MODULE_SOLO_LFG=1
MODULE_TRANSMOG=1
MODULE_PLAYERBOTS=1
# ... additional modules

Module Types

Modules are categorized by type:

  • C++ Modules - Require source compilation and rebuild
  • Lua Modules - Script-based, no compilation needed
  • Data Modules - Database and configuration only

Further Information

For detailed setup and deployment instructions, see the main README.md file.

For technical details about module management and the build system, refer to the Architecture Overview section.