mirror of
https://github.com/uprightbass360/AzerothCore-RealmMaster.git
synced 2026-01-13 00:58:34 +00:00
docs
This commit is contained in:
46
README.md
46
README.md
@@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
# AzerothCore RealmMaster
|
# AzerothCore RealmMaster
|
||||||
|
|
||||||
A complete containerized deployment of AzerothCore WoW 3.3.5a (Wrath of the Lich King) private server with 93+ enhanced modules and intelligent automation.
|
A complete containerized deployment of AzerothCore WoW 3.3.5a (Wrath of the Lich King) private server with **hundreds** of supported modules and intelligent automations to allow for easy setup, deployment and management.
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
@@ -23,10 +23,10 @@ A complete containerized deployment of AzerothCore WoW 3.3.5a (Wrath of the Lich
|
|||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
### Prerequisites
|
### Reccomendations
|
||||||
- **Docker** with Docker Compose
|
- **Docker** with Docker Compose 2
|
||||||
- **16GB+ RAM** and **32GB+ storage**
|
- **16GB+ RAM** and **64GB+ storage**
|
||||||
- **Linux/macOS/WSL2** (Windows with WSL2 recommended)
|
- **Linux/macOS/WSL2** Fully tested with Ubuntu 24.04 and Debian 12
|
||||||
|
|
||||||
### Three Simple Steps
|
### Three Simple Steps
|
||||||
|
|
||||||
@@ -50,17 +50,15 @@ See [Getting Started](#getting-started) for detailed walkthrough.
|
|||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
### ✅ Core Server Components
|
### ✅ Core Server Components
|
||||||
- **AzerothCore 3.3.5a** - WotLK server application with 93+ enhanced modules
|
- **AzerothCore 3.3.5a** - WotLK server application with 348 modules in the manifest (221 currently supported)
|
||||||
- **MySQL 8.0** - Database with intelligent initialization and restoration
|
- **MySQL 8.0** - Database with intelligent initialization and restoration
|
||||||
- **Smart Module System** - Automated module management and source builds
|
- **Smart Module System** - Automated module management and source builds
|
||||||
- **phpMyAdmin** - Web-based database administration
|
- **phpMyAdmin** - Web-based database administration
|
||||||
- **Keira3** - Game content editor and developer tools
|
- **Keira3** - Game content editor and developer tools
|
||||||
|
|
||||||
### ✅ Automated Configuration
|
### ✅ Automated Configuration
|
||||||
- **Intelligent Database Setup** - Smart backup detection, restoration, and conditional schema import
|
- **Intelligent Database Setup** - Smart backup detection, restoration, and conditional schema import (details in [docs/DATABASE_MANAGEMENT.md](docs/DATABASE_MANAGEMENT.md))
|
||||||
- **Restore Safety Checks** - The import job now validates the live MySQL runtime before honoring restore markers so stale tmpfs volumes can’t trick automation into skipping a needed restore (see [docs/DATABASE_MANAGEMENT.md](docs/DATABASE_MANAGEMENT.md))
|
- **Restore-Aware Backups & SQL** - Restore-aware SQL staging and snapshot safety checks keep modules in sync after restores ([docs/DATABASE_MANAGEMENT.md](docs/DATABASE_MANAGEMENT.md))
|
||||||
- **Backup Management** - Automated hourly/daily backups with intelligent restoration
|
|
||||||
- **Restore-Aware Module SQL** - After a backup restore the ledger snapshot from that backup is synced into shared storage and `stage-modules.sh` recopies every enabled SQL file into `/azerothcore/data/sql/updates/*` so the worldserver’s built-in updater reapplies anything the database still needs (see [docs/DATABASE_MANAGEMENT.md](docs/DATABASE_MANAGEMENT.md))
|
|
||||||
- **Module Integration** - Automatic source builds when C++ modules are enabled
|
- **Module Integration** - Automatic source builds when C++ modules are enabled
|
||||||
- **Service Orchestration** - Profile-based deployment (standard/playerbots/modules)
|
- **Service Orchestration** - Profile-based deployment (standard/playerbots/modules)
|
||||||
|
|
||||||
@@ -79,7 +77,9 @@ For complete local and remote deployment guides, see **[docs/GETTING_STARTED.md]
|
|||||||
|
|
||||||
## Complete Module Catalog
|
## Complete Module Catalog
|
||||||
|
|
||||||
Choose from **93+ enhanced modules** spanning automation, quality-of-life improvements, gameplay enhancements, PvP features, and more. All modules are automatically downloaded, configured, and integrated during deployment.
|
Choose from **hundreds of enhanced modules** spanning automation, quality-of-life improvements, gameplay enhancements, PvP features, and more. The manifest contains 348 modules (221 marked supported/active); the default RealmMaster preset enables 33 that are exercised in testing. All modules are automatically downloaded, configured, and integrated during deployment when selected.
|
||||||
|
|
||||||
|
Want a shortcut? Use a preset (RealmMaster, suggested QoL, playerbot variants, all-modules) from `config/module-profiles/`—see [docs/GETTING_STARTED.md#module-presets](docs/GETTING_STARTED.md#module-presets).
|
||||||
|
|
||||||
**Popular Categories:**
|
**Popular Categories:**
|
||||||
- **Automation** - Playerbots, AI chat, level management
|
- **Automation** - Playerbots, AI chat, level management
|
||||||
@@ -93,23 +93,13 @@ Browse the complete catalog with descriptions at **[docs/MODULES.md](docs/MODULE
|
|||||||
|
|
||||||
## Custom NPCs Guide
|
## Custom NPCs Guide
|
||||||
|
|
||||||
The server includes **14 custom NPCs** providing enhanced functionality including profession training, enchantments, arena services, and more. All NPCs are spawnable through GM commands and designed for permanent placement.
|
The server includes **14 custom NPCs** spanning services, buffs, PvP, and guild support. Full spawn commands, coordinates, and functions are in **[docs/NPCS.md](docs/NPCS.md)**.
|
||||||
|
|
||||||
**Available NPCs:**
|
|
||||||
- **Service NPCs** - Profession training, reagent banking, instance resets
|
|
||||||
- **Enhancement NPCs** - Enchanting, buffing, pet management, transmog
|
|
||||||
- **PvP NPCs** - 1v1 arena battlemaster
|
|
||||||
- **Guild House NPCs** - Property management and services
|
|
||||||
|
|
||||||
For complete spawn commands, coordinates, and functionality details, see **[docs/NPCS.md](docs/NPCS.md)**.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Management & Operations
|
## Management & Operations
|
||||||
|
|
||||||
For common workflows, management commands, and database operations, see **[docs/GETTING_STARTED.md](docs/GETTING_STARTED.md)**.
|
For common workflows, management commands, and database operations, see **[docs/GETTING_STARTED.md](docs/GETTING_STARTED.md)**. For script details (including module manifest auto-sync), see **[docs/SCRIPTS.md](docs/SCRIPTS.md)**.
|
||||||
|
|
||||||
- Keep the module catalog current with `scripts/python/update_module_manifest.py` or trigger the scheduled **Sync Module Manifest** GitHub Action to auto-open a PR with the latest AzerothCore topic repos.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -149,10 +139,8 @@ This project builds upon:
|
|||||||
- ✅ **Comprehensive Documentation** - Clear setup and troubleshooting guides
|
- ✅ **Comprehensive Documentation** - Clear setup and troubleshooting guides
|
||||||
|
|
||||||
### Next Steps After Installation
|
### Next Steps After Installation
|
||||||
|
|
||||||
**Essential First Steps:**
|
|
||||||
1. **Create admin account**: `docker attach ac-worldserver` → `account create admin password` → `account set gmlevel admin 3 -1`
|
|
||||||
2. **Test your setup**: Connect with WoW 3.3.5a client using `set realmlist 127.0.0.1`
|
|
||||||
3. **Access web tools**: phpMyAdmin (port 8081) and Keira3 (port 4201)
|
|
||||||
|
|
||||||
**For detailed server administration, monitoring, backup configuration, and performance tuning, see [docs/GETTING_STARTED.md](docs/GETTING_STARTED.md).**
|
**For detailed server administration, monitoring, backup configuration, and performance tuning, see [docs/GETTING_STARTED.md](docs/GETTING_STARTED.md).**
|
||||||
|
|
||||||
|
- **Create admin account** - Attach to worldserver and create a GM user (commands in **[docs/GETTING_STARTED.md#post-installation-steps](docs/GETTING_STARTED.md#post-installation-steps)**).
|
||||||
|
- **Point your client** - Update `realmlist.wtf` to your host/ports (defaults in the same section above).
|
||||||
|
- **Open services** - phpMyAdmin and Keira3 URLs/ports are listed in **[docs/GETTING_STARTED.md#post-installation-steps](docs/GETTING_STARTED.md#post-installation-steps)**.
|
||||||
261
docker-server.env
Normal file
261
docker-server.env
Normal file
@@ -0,0 +1,261 @@
|
|||||||
|
# Generated by azerothcore-rm/setup.sh
|
||||||
|
|
||||||
|
# Compose overrides (set to 1 to include matching file under compose-overrides/)
|
||||||
|
# mysql-expose.yml -> exposes MySQL externally via COMPOSE_OVERRIDE_MYSQL_EXPOSE_ENABLED
|
||||||
|
# worldserver-debug-logging.yml -> raises log verbosity via COMPOSE_OVERRIDE_WORLDSERVER_DEBUG_LOGGING_ENABLED
|
||||||
|
COMPOSE_OVERRIDE_MYSQL_EXPOSE_ENABLED=0
|
||||||
|
COMPOSE_OVERRIDE_WORLDSERVER_DEBUG_LOGGING_ENABLED=0
|
||||||
|
|
||||||
|
COMPOSE_PROJECT_NAME=azerothcore-stack
|
||||||
|
|
||||||
|
STORAGE_PATH=/nfs/azerothcore
|
||||||
|
STORAGE_PATH_LOCAL=./local-storage
|
||||||
|
BACKUP_PATH=${STORAGE_PATH}/backups
|
||||||
|
TZ=America/New_York
|
||||||
|
|
||||||
|
# Database
|
||||||
|
MYSQL_IMAGE=mysql:8.0
|
||||||
|
MYSQL_ROOT_PASSWORD=azerothcore123
|
||||||
|
MYSQL_ROOT_HOST=%
|
||||||
|
MYSQL_USER=root
|
||||||
|
MYSQL_PORT=3306
|
||||||
|
MYSQL_EXTERNAL_PORT=64306
|
||||||
|
MYSQL_DISABLE_BINLOG=1
|
||||||
|
MYSQL_CONFIG_DIR=${STORAGE_PATH}/config/mysql/conf.d
|
||||||
|
MYSQL_CHARACTER_SET=utf8mb4
|
||||||
|
MYSQL_COLLATION=utf8mb4_unicode_ci
|
||||||
|
MYSQL_MAX_CONNECTIONS=1000
|
||||||
|
MYSQL_INNODB_BUFFER_POOL_SIZE=256M
|
||||||
|
MYSQL_INNODB_LOG_FILE_SIZE=64M
|
||||||
|
MYSQL_INNODB_REDO_LOG_CAPACITY=512M
|
||||||
|
MYSQL_RUNTIME_TMPFS_SIZE=8G
|
||||||
|
MYSQL_HOST=ac-mysql
|
||||||
|
DB_WAIT_RETRIES=60
|
||||||
|
DB_WAIT_SLEEP=10
|
||||||
|
DB_AUTH_NAME=acore_auth
|
||||||
|
DB_WORLD_NAME=acore_world
|
||||||
|
DB_CHARACTERS_NAME=acore_characters
|
||||||
|
DB_PLAYERBOTS_NAME=acore_playerbots
|
||||||
|
AC_DB_IMPORT_IMAGE=azerothcore-stack:db-import-playerbots
|
||||||
|
|
||||||
|
# Services (images)
|
||||||
|
AC_AUTHSERVER_IMAGE=acore/ac-wotlk-authserver:master
|
||||||
|
AC_WORLDSERVER_IMAGE=acore/ac-wotlk-worldserver:master
|
||||||
|
AC_AUTHSERVER_IMAGE_PLAYERBOTS=azerothcore-stack:authserver-playerbots
|
||||||
|
AC_WORLDSERVER_IMAGE_PLAYERBOTS=azerothcore-stack:worldserver-playerbots
|
||||||
|
AC_AUTHSERVER_IMAGE_MODULES=azerothcore-stack:authserver-modules-latest
|
||||||
|
AC_WORLDSERVER_IMAGE_MODULES=azerothcore-stack:worldserver-modules-latest
|
||||||
|
|
||||||
|
# Client data images
|
||||||
|
AC_CLIENT_DATA_IMAGE=acore/ac-wotlk-client-data:master
|
||||||
|
AC_CLIENT_DATA_IMAGE_PLAYERBOTS=azerothcore-stack:client-data-playerbots
|
||||||
|
CLIENT_DATA_CACHE_PATH=${STORAGE_PATH_LOCAL}/client-data-cache
|
||||||
|
CLIENT_DATA_PATH=${STORAGE_PATH}/client-data
|
||||||
|
|
||||||
|
# Build artifacts
|
||||||
|
DOCKER_IMAGE_TAG=master
|
||||||
|
AC_AUTHSERVER_IMAGE_BASE=acore/ac-wotlk-authserver
|
||||||
|
AC_WORLDSERVER_IMAGE_BASE=acore/ac-wotlk-worldserver
|
||||||
|
AC_DB_IMPORT_IMAGE_BASE=acore/ac-wotlk-db-import
|
||||||
|
AC_CLIENT_DATA_IMAGE_BASE=acore/ac-wotlk-client-data
|
||||||
|
|
||||||
|
# Container user
|
||||||
|
CONTAINER_USER=1001:1000
|
||||||
|
|
||||||
|
# Containers
|
||||||
|
CONTAINER_MYSQL=ac-mysql
|
||||||
|
CONTAINER_DB_IMPORT=ac-db-import
|
||||||
|
CONTAINER_DB_INIT=ac-db-init
|
||||||
|
CONTAINER_BACKUP=ac-backup
|
||||||
|
CONTAINER_MODULES=ac-modules
|
||||||
|
CONTAINER_POST_INSTALL=ac-post-install
|
||||||
|
|
||||||
|
# Ports
|
||||||
|
AUTH_EXTERNAL_PORT=3784
|
||||||
|
AUTH_PORT=3724
|
||||||
|
WORLD_EXTERNAL_PORT=8215
|
||||||
|
WORLD_PORT=8085
|
||||||
|
SOAP_EXTERNAL_PORT=7778
|
||||||
|
SOAP_PORT=7878
|
||||||
|
|
||||||
|
# Realm
|
||||||
|
SERVER_ADDRESS=192.168.0.179
|
||||||
|
REALM_PORT=8215
|
||||||
|
|
||||||
|
# Backups
|
||||||
|
BACKUP_RETENTION_DAYS=3
|
||||||
|
BACKUP_RETENTION_HOURS=6
|
||||||
|
BACKUP_DAILY_TIME=09
|
||||||
|
BACKUP_HEALTHCHECK_MAX_MINUTES=1440
|
||||||
|
BACKUP_HEALTHCHECK_GRACE_SECONDS=4500
|
||||||
|
|
||||||
|
|
||||||
|
# Modules
|
||||||
|
MODULE_PLAYERBOTS=1
|
||||||
|
MODULE_AOE_LOOT=0
|
||||||
|
MODULE_LEARN_SPELLS=1
|
||||||
|
MODULE_FIREWORKS=1
|
||||||
|
MODULE_INDIVIDUAL_PROGRESSION=0
|
||||||
|
MODULE_AHBOT=0
|
||||||
|
MODULE_AUTOBALANCE=0
|
||||||
|
MODULE_TRANSMOG=1
|
||||||
|
MODULE_NPC_BUFFER=1
|
||||||
|
MODULE_DYNAMIC_XP=0
|
||||||
|
MODULE_SOLO_LFG=1
|
||||||
|
MODULE_1V1_ARENA=1
|
||||||
|
MODULE_PHASED_DUELS=0
|
||||||
|
MODULE_BREAKING_NEWS=1
|
||||||
|
MODULE_BOSS_ANNOUNCER=1
|
||||||
|
MODULE_ACCOUNT_ACHIEVEMENTS=1
|
||||||
|
MODULE_AUTO_REVIVE=1
|
||||||
|
MODULE_GAIN_HONOR_GUARD=1
|
||||||
|
MODULE_ELUNA=1
|
||||||
|
MODULE_TIME_IS_TIME=1
|
||||||
|
MODULE_POCKET_PORTAL=0
|
||||||
|
MODULE_RANDOM_ENCHANTS=1
|
||||||
|
MODULE_SOLOCRAFT=1
|
||||||
|
MODULE_PVP_TITLES=0
|
||||||
|
MODULE_NPC_BEASTMASTER=1
|
||||||
|
MODULE_NPC_ENCHANTER=1
|
||||||
|
MODULE_INSTANCE_RESET=1
|
||||||
|
MODULE_LEVEL_GRANT=0
|
||||||
|
MODULE_ARAC=1
|
||||||
|
MODULE_ASSISTANT=1
|
||||||
|
MODULE_REAGENT_BANK=1
|
||||||
|
MODULE_BLACK_MARKET_AUCTION_HOUSE=1
|
||||||
|
MODULE_CHALLENGE_MODES=0
|
||||||
|
MODULE_OLLAMA_CHAT=0
|
||||||
|
MODULE_PLAYER_BOT_LEVEL_BRACKETS=0
|
||||||
|
MODULE_STATBOOSTER=0
|
||||||
|
MODULE_DUNGEON_RESPAWN=0
|
||||||
|
MODULE_SKELETON_MODULE=0
|
||||||
|
MODULE_BG_SLAVERYVALLEY=0
|
||||||
|
MODULE_AZEROTHSHARD=0
|
||||||
|
MODULE_WORGOBLIN=0
|
||||||
|
MODULE_ELUNA_TS=1
|
||||||
|
MODULE_AIO=1
|
||||||
|
MODULE_ELUNA_SCRIPTS=1
|
||||||
|
MODULE_TRANSMOG_AIO=0
|
||||||
|
MODULE_EVENT_SCRIPTS=1
|
||||||
|
MODULE_LEVEL_UP_REWARD=0
|
||||||
|
MODULE_ACCOUNTWIDE_SYSTEMS=0
|
||||||
|
MODULE_EXCHANGE_NPC=0
|
||||||
|
MODULE_RECRUIT_A_FRIEND=0
|
||||||
|
MODULE_PRESTIGE_DRAFT_MODE=0
|
||||||
|
MODULE_LUA_AH_BOT=0
|
||||||
|
MODULE_HARDCORE_MODE=0
|
||||||
|
MODULE_NPCBOT_EXTENDED_COMMANDS=0
|
||||||
|
MODULE_MULTIVENDOR=0
|
||||||
|
MODULE_TREASURE_CHEST_SYSTEM=0
|
||||||
|
MODULE_ACTIVE_CHAT=1
|
||||||
|
MODULE_ULTIMATE_FULL_LOOT_PVP=0
|
||||||
|
MODULE_HORADRIC_CUBE=0
|
||||||
|
MODULE_CARBON_COPY=0
|
||||||
|
MODULE_TEMP_ANNOUNCEMENTS=0
|
||||||
|
MODULE_ZONE_CHECK=0
|
||||||
|
MODULE_AIO_BLACKJACK=0
|
||||||
|
MODULE_SEND_AND_BIND=0
|
||||||
|
MODULE_DYNAMIC_TRADER=0
|
||||||
|
MODULE_LOTTERY_LUA=0
|
||||||
|
MODULE_DISCORD_NOTIFIER=0
|
||||||
|
MODULE_GLOBAL_MAIL_BANKING_AUCTIONS=0
|
||||||
|
MODULE_GUILDHOUSE=1
|
||||||
|
MODULE_PROGRESSION_SYSTEM=0
|
||||||
|
MODULE_NPC_FREE_PROFESSIONS=1
|
||||||
|
MODULE_DUEL_RESET=0
|
||||||
|
MODULE_ZONE_DIFFICULTY=0
|
||||||
|
MODULE_MORPHSUMMON=1
|
||||||
|
MODULE_SPELL_REGULATOR=0
|
||||||
|
MODULE_WEEKEND_XP=0
|
||||||
|
MODULE_REWARD_PLAYED_TIME=0
|
||||||
|
MODULE_RESURRECTION_SCROLL=0
|
||||||
|
MODULE_ITEM_LEVEL_UP=1
|
||||||
|
MODULE_NPC_TALENT_TEMPLATE=0
|
||||||
|
MODULE_GLOBAL_CHAT=1
|
||||||
|
MODULE_PREMIUM=0
|
||||||
|
MODULE_SYSTEM_VIP=0
|
||||||
|
MODULE_ACORE_SUBSCRIPTIONS=0
|
||||||
|
MODULE_KEEP_OUT=0
|
||||||
|
MODULE_SERVER_AUTO_SHUTDOWN=0
|
||||||
|
MODULE_WHO_LOGGED=0
|
||||||
|
MODULE_ACCOUNT_MOUNTS=0
|
||||||
|
MODULE_ANTIFARMING=0
|
||||||
|
MODULE_ARENA_REPLAY=0
|
||||||
|
MODULE_TIC_TAC_TOE=0
|
||||||
|
MODULE_WAR_EFFORT=0
|
||||||
|
MODULE_PROMOTION_AZEROTHCORE=0
|
||||||
|
|
||||||
|
# Client data
|
||||||
|
CLIENT_DATA_VERSION=
|
||||||
|
|
||||||
|
# Server configuration
|
||||||
|
SERVER_CONFIG_PRESET=none
|
||||||
|
|
||||||
|
# Playerbot runtime
|
||||||
|
PLAYERBOT_ENABLED=1
|
||||||
|
PLAYERBOT_MIN_BOTS=2000
|
||||||
|
PLAYERBOT_MAX_BOTS=4000
|
||||||
|
STACK_IMAGE_MODE=playerbots
|
||||||
|
STACK_SOURCE_VARIANT=playerbots
|
||||||
|
MODULES_ENABLED_LIST=MODULE_PLAYERBOTS,MODULE_LEARN_SPELLS,MODULE_FIREWORKS,MODULE_TRANSMOG,MODULE_NPC_BUFFER,MODULE_SOLO_LFG,MODULE_1V1_ARENA,MODULE_BREAKING_NEWS,MODULE_BOSS_ANNOUNCER,MODULE_ACCOUNT_ACHIEVEMENTS,MODULE_AUTO_REVIVE,MODULE_GAIN_HONOR_GUARD,MODULE_ELUNA,MODULE_TIME_IS_TIME,MODULE_RANDOM_ENCHANTS,MODULE_SOLOCRAFT,MODULE_NPC_BEASTMASTER,MODULE_NPC_ENCHANTER,MODULE_INSTANCE_RESET,MODULE_ARAC,MODULE_ASSISTANT,MODULE_REAGENT_BANK,MODULE_BLACK_MARKET_AUCTION_HOUSE,MODULE_STATBOOSTER,MODULE_ELUNA_TS,MODULE_AIO,MODULE_ELUNA_SCRIPTS,MODULE_EVENT_SCRIPTS,MODULE_ACTIVE_CHAT,MODULE_GUILDHOUSE,MODULE_NPC_FREE_PROFESSIONS,MODULE_MORPHSUMMON,MODULE_ITEM_LEVEL_UP,MODULE_GLOBAL_CHAT
|
||||||
|
MODULES_CPP_LIST=MODULE_LEARN_SPELLS,MODULE_FIREWORKS,MODULE_TRANSMOG,MODULE_NPC_BUFFER,MODULE_SOLO_LFG,MODULE_1V1_ARENA,MODULE_BREAKING_NEWS,MODULE_BOSS_ANNOUNCER,MODULE_ACCOUNT_ACHIEVEMENTS,MODULE_AUTO_REVIVE,MODULE_GAIN_HONOR_GUARD,MODULE_ELUNA,MODULE_TIME_IS_TIME,MODULE_RANDOM_ENCHANTS,MODULE_SOLOCRAFT,MODULE_NPC_BEASTMASTER,MODULE_NPC_ENCHANTER,MODULE_INSTANCE_RESET,MODULE_ARAC,MODULE_ASSISTANT,MODULE_REAGENT_BANK,MODULE_STATBOOSTER,MODULE_AIO,MODULE_GUILDHOUSE,MODULE_NPC_FREE_PROFESSIONS,MODULE_MORPHSUMMON,MODULE_ITEM_LEVEL_UP,MODULE_GLOBAL_CHAT
|
||||||
|
MODULES_REQUIRES_CUSTOM_BUILD=1
|
||||||
|
MODULES_REQUIRES_PLAYERBOT_SOURCE=1
|
||||||
|
|
||||||
|
# Rebuild automation
|
||||||
|
AUTO_REBUILD_ON_DEPLOY=0
|
||||||
|
MODULES_REBUILD_SOURCE_PATH=./local-storage/source/azerothcore-playerbots
|
||||||
|
|
||||||
|
# Eluna
|
||||||
|
AC_ELUNA_ENABLED=1 # Power users may set to 0 to turn off bundled Eluna runtime
|
||||||
|
AC_ELUNA_TRACE_BACK=1
|
||||||
|
AC_ELUNA_AUTO_RELOAD=1
|
||||||
|
AC_ELUNA_BYTECODE_CACHE=1
|
||||||
|
AC_ELUNA_SCRIPT_PATH=lua_scripts
|
||||||
|
AC_ELUNA_REQUIRE_PATHS=
|
||||||
|
AC_ELUNA_REQUIRE_CPATHS=
|
||||||
|
AC_ELUNA_AUTO_RELOAD_INTERVAL=1
|
||||||
|
|
||||||
|
# Tools
|
||||||
|
PMA_HOST=ac-mysql
|
||||||
|
PMA_PORT=3306
|
||||||
|
PMA_USER=root
|
||||||
|
PMA_EXTERNAL_PORT=8081
|
||||||
|
PMA_ARBITRARY=1
|
||||||
|
PMA_ABSOLUTE_URI=
|
||||||
|
PMA_UPLOAD_LIMIT=300M
|
||||||
|
PMA_MEMORY_LIMIT=512M
|
||||||
|
PMA_MAX_EXECUTION_TIME=600
|
||||||
|
KEIRA3_EXTERNAL_PORT=4201
|
||||||
|
KEIRA_DATABASE_HOST=ac-mysql
|
||||||
|
KEIRA_DATABASE_PORT=3306
|
||||||
|
|
||||||
|
# Health checks
|
||||||
|
MYSQL_HEALTHCHECK_INTERVAL=20s
|
||||||
|
MYSQL_HEALTHCHECK_TIMEOUT=15s
|
||||||
|
MYSQL_HEALTHCHECK_RETRIES=25
|
||||||
|
MYSQL_HEALTHCHECK_START_PERIOD=120s
|
||||||
|
AUTH_HEALTHCHECK_INTERVAL=30s
|
||||||
|
AUTH_HEALTHCHECK_TIMEOUT=10s
|
||||||
|
AUTH_HEALTHCHECK_RETRIES=3
|
||||||
|
AUTH_HEALTHCHECK_START_PERIOD=60s
|
||||||
|
WORLD_HEALTHCHECK_INTERVAL=30s
|
||||||
|
WORLD_HEALTHCHECK_TIMEOUT=10s
|
||||||
|
WORLD_HEALTHCHECK_RETRIES=3
|
||||||
|
WORLD_HEALTHCHECK_START_PERIOD=120s
|
||||||
|
BACKUP_HEALTHCHECK_INTERVAL=60s
|
||||||
|
BACKUP_HEALTHCHECK_TIMEOUT=30s
|
||||||
|
BACKUP_HEALTHCHECK_RETRIES=3
|
||||||
|
BACKUP_HEALTHCHECK_START_PERIOD=120s
|
||||||
|
|
||||||
|
# Networking
|
||||||
|
NETWORK_NAME=azerothcore
|
||||||
|
NETWORK_SUBNET=172.20.0.0/16
|
||||||
|
NETWORK_GATEWAY=172.20.0.1
|
||||||
|
|
||||||
|
# Storage helpers
|
||||||
|
HOST_ZONEINFO_PATH=/usr/share/zoneinfo
|
||||||
|
|
||||||
|
# Helper images
|
||||||
|
ALPINE_GIT_IMAGE=alpine/git:latest
|
||||||
|
ALPINE_IMAGE=alpine:latest
|
||||||
@@ -3,6 +3,8 @@
|
|||||||
**Last Updated:** 2025-11-14
|
**Last Updated:** 2025-11-14
|
||||||
**Status:** ✅ All blocked modules properly disabled
|
**Status:** ✅ All blocked modules properly disabled
|
||||||
|
|
||||||
|
**Note:** This summary is historical. The authoritative block list lives in `config/module-manifest.json` (currently 94 modules marked `status: "blocked"`). This file and `docs/DISABLED_MODULES.md` should be reconciled during the next blocklist refresh.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|||||||
@@ -4,6 +4,8 @@ This document tracks modules that have been disabled due to compilation errors o
|
|||||||
|
|
||||||
**Last Updated:** 2025-11-14
|
**Last Updated:** 2025-11-14
|
||||||
|
|
||||||
|
**Note:** Historical snapshot. The current authoritative status for disabled/blocked modules is `status: "blocked"` in `config/module-manifest.json` (94 entries as of now). Align this file with the manifest during the next maintenance pass.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Disabled Modules
|
## Disabled Modules
|
||||||
@@ -111,7 +113,7 @@ These modules are blocked in the manifest with known issues:
|
|||||||
|
|
||||||
## Current Working Module Count
|
## Current Working Module Count
|
||||||
|
|
||||||
**Total in Manifest:** ~93 modules
|
**Total in Manifest:** ~93 modules (historical; current manifest: 348 total / 221 supported / 94 blocked)
|
||||||
**Enabled:** 89 modules
|
**Enabled:** 89 modules
|
||||||
**Disabled (Build Issues):** 4 modules
|
**Disabled (Build Issues):** 4 modules
|
||||||
**Blocked (Manifest):** 3 modules
|
**Blocked (Manifest):** 3 modules
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ This guide provides a complete walkthrough for deploying AzerothCore RealmMaster
|
|||||||
|
|
||||||
Before you begin, ensure you have:
|
Before you begin, ensure you have:
|
||||||
- **Docker** with Docker Compose
|
- **Docker** with Docker Compose
|
||||||
- **16GB+ RAM** and **32GB+ storage**
|
- **16GB+ RAM** and **64GB+ storage**
|
||||||
- **Linux/macOS/WSL2** (Windows with WSL2 recommended)
|
- **Linux/macOS/WSL2** (Windows with WSL2 recommended)
|
||||||
|
|
||||||
## Quick Overview
|
## Quick Overview
|
||||||
@@ -40,7 +40,7 @@ cd AzerothCore-RealmMaster
|
|||||||
|
|
||||||
The setup wizard will guide you through:
|
The setup wizard will guide you through:
|
||||||
- **Server Configuration**: IP address, ports, timezone
|
- **Server Configuration**: IP address, ports, timezone
|
||||||
- **Module Selection**: Choose from 30+ available modules or use presets
|
- **Module Selection**: Choose from hundreds of official modules (348 in manifest; 221 currently supported) or use presets
|
||||||
- **Module Definitions**: Customize defaults in `config/module-manifest.json` and optional presets under `config/module-profiles/`
|
- **Module Definitions**: Customize defaults in `config/module-manifest.json` and optional presets under `config/module-profiles/`
|
||||||
- **Storage Paths**: Configure NFS/local storage locations
|
- **Storage Paths**: Configure NFS/local storage locations
|
||||||
- **Playerbot Settings**: Max bots, account limits (if enabled)
|
- **Playerbot Settings**: Max bots, account limits (if enabled)
|
||||||
@@ -199,8 +199,6 @@ The remote deployment process transfers:
|
|||||||
|
|
||||||
### Module Presets
|
### Module Presets
|
||||||
|
|
||||||
> **⚠️ Warning:** Module preset support is still in progress. The bundled presets have not been fully tested yet—please share issues or suggestions via Discord (`uprightbass360`).
|
|
||||||
|
|
||||||
- Define JSON presets in `config/module-profiles/*.json`. Each file contains:
|
- Define JSON presets in `config/module-profiles/*.json`. Each file contains:
|
||||||
- `modules` (array, required) – list of `MODULE_*` identifiers to enable.
|
- `modules` (array, required) – list of `MODULE_*` identifiers to enable.
|
||||||
- `label` (string, optional) – text shown in the setup menu (emoji welcome).
|
- `label` (string, optional) – text shown in the setup menu (emoji welcome).
|
||||||
@@ -218,11 +216,11 @@ The remote deployment process transfers:
|
|||||||
```
|
```
|
||||||
- `setup.sh` automatically adds these presets to the module menu and enables the listed modules when selected or when `--module-config <name>` is provided.
|
- `setup.sh` automatically adds these presets to the module menu and enables the listed modules when selected or when `--module-config <name>` is provided.
|
||||||
- Built-in presets:
|
- Built-in presets:
|
||||||
- `config/module-profiles/suggested-modules.json` – default solo-friendly QoL stack.
|
- - `config/module-profiles/RealmMaster.json` – 33-module baseline used for testing.
|
||||||
- `config/module-profiles/playerbots-suggested-modules.json` – suggested stack plus playerbots.
|
- - `config/module-profiles/suggested-modules.json` – default solo-friendly QoL stack.
|
||||||
- `config/module-profiles/playerbots-only.json` – playerbot-focused profile (adjust `--playerbot-max-bots`).
|
- - `config/module-profiles/playerbots-suggested-modules.json` – suggested stack plus playerbots.
|
||||||
- Custom example:
|
- - `config/module-profiles/playerbots-only.json` – playerbot-focused profile (adjust `--playerbot-max-bots`).
|
||||||
- `config/module-profiles/sam.json` – Sam's playerbot-focused profile (set `--playerbot-max-bots 3000` when using this preset).
|
- - `config/module-profiles/all-modules.json` – enable everything currently marked supported/active.
|
||||||
- Module metadata lives in `config/module-manifest.json`; update that file if you need to add new modules or change repositories/branches.
|
- Module metadata lives in `config/module-manifest.json`; update that file if you need to add new modules or change repositories/branches.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ This document provides a comprehensive overview of all available modules in the
|
|||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
AzerothCore RealmMaster includes **93 modules** that are automatically downloaded, configured, and SQL scripts executed when enabled. All modules are organized into logical categories for easy browsing and selection.
|
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
|
## How Modules Work
|
||||||
|
|
||||||
@@ -261,4 +261,4 @@ Modules are categorized by type:
|
|||||||
|
|
||||||
For detailed setup and deployment instructions, see the main [README.md](../README.md) file.
|
For detailed setup and deployment instructions, see the main [README.md](../README.md) file.
|
||||||
|
|
||||||
For technical details about module management and the build system, refer to the [Architecture Overview](../README.md#architecture-overview) section.
|
For technical details about module management and the build system, refer to the [Architecture Overview](../README.md#architecture-overview) section.
|
||||||
|
|||||||
@@ -6,6 +6,8 @@ This document tracks all modules that have been disabled due to compilation fail
|
|||||||
|
|
||||||
**Total Blocked Modules:** 93
|
**Total Blocked Modules:** 93
|
||||||
|
|
||||||
|
**Note:** Historical snapshot from 2025-11-22 validation. The current authoritative count lives in `config/module-manifest.json` (94 modules marked `status: "blocked"`). Update this file when reconciling the manifest.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Compilation Errors
|
## Compilation Errors
|
||||||
|
|||||||
@@ -3,6 +3,8 @@
|
|||||||
**Date:** 2025-11-14
|
**Date:** 2025-11-14
|
||||||
**Status:** ✅ PRE-DEPLOYMENT TESTS PASSED
|
**Status:** ✅ PRE-DEPLOYMENT TESTS PASSED
|
||||||
|
|
||||||
|
**Note:** Historical record for the 2025-11-14 run. Counts here reflect that test set (93 modules). The current manifest contains 348 modules, 221 marked supported/active, and the RealmMaster preset exercises 33 modules.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Test Execution Summary
|
## Test Execution Summary
|
||||||
@@ -31,7 +33,7 @@
|
|||||||
**Verified:**
|
**Verified:**
|
||||||
- Environment file present
|
- Environment file present
|
||||||
- Module configuration loaded
|
- Module configuration loaded
|
||||||
- 93 modules enabled for testing
|
- 93 modules enabled for testing in this run (current manifest: 348 total / 221 supported; RealmMaster preset: 33)
|
||||||
|
|
||||||
### Test 2: Module Manifest Validation ✅
|
### Test 2: Module Manifest Validation ✅
|
||||||
```bash
|
```bash
|
||||||
@@ -139,7 +141,7 @@ MODULES_ENABLED="mod-playerbots mod-aoe-loot ..."
|
|||||||
|
|
||||||
**What Gets Built:**
|
**What Gets Built:**
|
||||||
- AzerothCore with playerbots branch
|
- AzerothCore with playerbots branch
|
||||||
- 93 modules compiled and integrated
|
- 93 modules compiled and integrated in this run (current manifest: 348 total / 221 supported)
|
||||||
- Custom Docker images: `acore-compose:worldserver-modules-latest` etc.
|
- Custom Docker images: `acore-compose:worldserver-modules-latest` etc.
|
||||||
|
|
||||||
### Deployment Status: READY TO DEPLOY 🚀
|
### Deployment Status: READY TO DEPLOY 🚀
|
||||||
@@ -261,7 +263,7 @@ docker exec ac-mysql mysql -uroot -p[password] acore_world \
|
|||||||
- **Bash:** 5.0+
|
- **Bash:** 5.0+
|
||||||
- **Python:** 3.x
|
- **Python:** 3.x
|
||||||
- **Docker:** Available
|
- **Docker:** Available
|
||||||
- **Modules Enabled:** 93
|
- **Modules Enabled:** 93 (historical run)
|
||||||
- **Test Date:** 2025-11-14
|
- **Test Date:** 2025-11-14
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ Interactive `.env` generator with module selection, server configuration, and de
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
./setup.sh # Interactive configuration
|
./setup.sh # Interactive configuration
|
||||||
./setup.sh --module-config sam # Use predefined module profile, check profiles directory
|
./setup.sh --module-config RealmMaster # Use predefined module profile, check profiles directory
|
||||||
./setup.sh --playerbot-max-bots 3000 # Set playerbot limits
|
./setup.sh --playerbot-max-bots 3000 # Set playerbot limits
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user