mirror of
https://github.com/uprightbass360/AzerothCore-RealmMaster.git
synced 2026-02-03 19:03:50 +00:00
159 lines
6.7 KiB
Markdown
159 lines
6.7 KiB
Markdown
<div align="center">
|
||
<img src="img/logo.jpg" alt="AzerothCore RealmMaster Logo">
|
||
</div>
|
||
|
||
# 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.
|
||
|
||
## Table of Contents
|
||
|
||
- [Quick Start](#quick-start)
|
||
- [What You Get](#what-you-get)
|
||
- [Getting Started](#getting-started) → **[docs/GETTING_STARTED.md](docs/GETTING_STARTED.md)**
|
||
- [Complete Module Catalog](#complete-module-catalog) → **[docs/MODULES.md](docs/MODULES.md)**
|
||
- [Management & Operations](#management--operations) → **[docs/GETTING_STARTED.md](docs/GETTING_STARTED.md)**
|
||
- [Advanced Configuration](#advanced-configuration) → **[docs/ADVANCED.md](docs/ADVANCED.md)**
|
||
- [Custom NPCs Guide](#custom-npcs-guide) → **[docs/NPCS.md](docs/NPCS.md)**
|
||
- [Script Reference](#script-reference) → **[docs/SCRIPTS.md](docs/SCRIPTS.md)**
|
||
- [Troubleshooting](#troubleshooting) → **[docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)**
|
||
- [Credits & Next Steps](#credits--next-steps)
|
||
|
||
---
|
||
|
||
## Quick Start
|
||
|
||
### Prerequisites
|
||
- **Docker** with Docker Compose
|
||
- **16GB+ RAM** and **32GB+ storage**
|
||
- **Linux/macOS/WSL2** (Windows with WSL2 recommended)
|
||
|
||
### Three Simple Steps
|
||
|
||
```bash
|
||
# 1. Get the code
|
||
git clone https://github.com/uprightbass360/AzerothCore-RealmMaster.git
|
||
cd AzerothCore-RealmMaster
|
||
|
||
# 2. Configure your server
|
||
./setup.sh
|
||
|
||
# 3. Deploy
|
||
./deploy.sh # Always required - Supports ssh remote deploy or local
|
||
./status.sh # Optional - Shows health and accesibility of all containers and current user data
|
||
```
|
||
|
||
**First deployment takes 30-60 minutes** for database setup and client data download. Subsequent starts are much faster.
|
||
|
||
See [Getting Started](#getting-started) for detailed walkthrough.
|
||
|
||
## What You Get
|
||
|
||
### ✅ Core Server Components
|
||
- **AzerothCore 3.3.5a** - WotLK server application with 93+ enhanced modules
|
||
- **MySQL 8.0** - Database with intelligent initialization and restoration
|
||
- **Smart Module System** - Automated module management and source builds
|
||
- **phpMyAdmin** - Web-based database administration
|
||
- **Keira3** - Game content editor and developer tools
|
||
|
||
### ✅ Automated Configuration
|
||
- **Intelligent Database Setup** - Smart backup detection, restoration, and conditional schema import
|
||
- **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))
|
||
- **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
|
||
- **Service Orchestration** - Profile-based deployment (standard/playerbots/modules)
|
||
|
||
---
|
||
|
||
## Getting Started
|
||
|
||
**Quick Overview:**
|
||
1. Clone repository → `./setup.sh` → `./build.sh` (if needed) → `./deploy.sh`
|
||
2. Create admin account and connect your WoW 3.3.5a client
|
||
3. Access management tools at http://localhost:8081 (phpMyAdmin) and http://localhost:4201 (Keira3)
|
||
|
||
For complete local and remote deployment guides, see **[docs/GETTING_STARTED.md](docs/GETTING_STARTED.md)**.
|
||
|
||
---
|
||
|
||
## 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.
|
||
|
||
**Popular Categories:**
|
||
- **Automation** - Playerbots, AI chat, level management
|
||
- **Quality of Life** - Solo LFG, AOE looting, auto-revive
|
||
- **Gameplay** - Autobalance, challenge modes, hardcore mode
|
||
- **Services** - Transmog, profession NPCs, talent templates
|
||
|
||
Browse the complete catalog with descriptions at **[docs/MODULES.md](docs/MODULES.md)**.
|
||
|
||
---
|
||
|
||
## 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.
|
||
|
||
**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
|
||
|
||
For common workflows, management commands, and database operations, see **[docs/GETTING_STARTED.md](docs/GETTING_STARTED.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.
|
||
|
||
---
|
||
|
||
## Advanced Configuration
|
||
|
||
For architecture details, storage structure, build system, and advanced customization, see **[docs/ADVANCED.md](docs/ADVANCED.md)**.
|
||
|
||
|
||
---
|
||
|
||
|
||
## Script Reference
|
||
|
||
For comprehensive documentation of all deployment scripts, management commands, and automation tools, see **[docs/SCRIPTS.md](docs/SCRIPTS.md)**.
|
||
|
||
---
|
||
|
||
## Troubleshooting
|
||
|
||
For diagnostic procedures, common issues, and backup system documentation, see **[docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)**.
|
||
|
||
---
|
||
|
||
## Credits & Next Steps
|
||
|
||
### Project Credits
|
||
|
||
This project builds upon:
|
||
- **[AzerothCore](https://github.com/azerothcore/azerothcore-wotlk)** - Core server application
|
||
- **[AzerothCore Module Community](https://github.com/azerothcore)** - Enhanced gameplay modules
|
||
|
||
#### Key Features
|
||
- ✅ **Fully Automated Setup** - Interactive configuration and deployment
|
||
- ✅ **Intelligent Module System** - Automatic source builds and profile selection
|
||
- ✅ **Automated Backups** - Health checks, scheduled backups, and monitoring
|
||
- ✅ **Docker-Based** - Containerized deployment for easy setup and portability
|
||
- ✅ **Comprehensive Documentation** - Clear setup and troubleshooting guides
|
||
|
||
### 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).**
|