mirror of
https://github.com/uprightbass360/AzerothCore-RealmMaster.git
synced 2026-01-13 00:58:34 +00:00
docs
This commit is contained in:
uprightbass360
@@ -3,6 +3,8 @@
|
||||
**Last Updated:** 2025-11-14
|
||||
**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
|
||||
|
||||
@@ -4,6 +4,8 @@ This document tracks modules that have been disabled due to compilation errors o
|
||||
|
||||
**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
|
||||
@@ -111,7 +113,7 @@ These modules are blocked in the manifest with known issues:
|
||||
|
||||
## 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
|
||||
**Disabled (Build Issues):** 4 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:
|
||||
- **Docker** with Docker Compose
|
||||
- **16GB+ RAM** and **32GB+ storage**
|
||||
- **16GB+ RAM** and **64GB+ storage**
|
||||
- **Linux/macOS/WSL2** (Windows with WSL2 recommended)
|
||||
|
||||
## Quick Overview
|
||||
@@ -40,7 +40,7 @@ cd AzerothCore-RealmMaster
|
||||
|
||||
The setup wizard will guide you through:
|
||||
- **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/`
|
||||
- **Storage Paths**: Configure NFS/local storage locations
|
||||
- **Playerbot Settings**: Max bots, account limits (if enabled)
|
||||
@@ -199,8 +199,6 @@ The remote deployment process transfers:
|
||||
|
||||
### 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:
|
||||
- `modules` (array, required) – list of `MODULE_*` identifiers to enable.
|
||||
- `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.
|
||||
- Built-in presets:
|
||||
- `config/module-profiles/suggested-modules.json` – default solo-friendly QoL stack.
|
||||
- `config/module-profiles/playerbots-suggested-modules.json` – suggested stack plus playerbots.
|
||||
- `config/module-profiles/playerbots-only.json` – playerbot-focused profile (adjust `--playerbot-max-bots`).
|
||||
- Custom example:
|
||||
- `config/module-profiles/sam.json` – Sam's playerbot-focused profile (set `--playerbot-max-bots 3000` when using this preset).
|
||||
- - `config/module-profiles/RealmMaster.json` – 33-module baseline used for testing.
|
||||
- - `config/module-profiles/suggested-modules.json` – default solo-friendly QoL stack.
|
||||
- - `config/module-profiles/playerbots-suggested-modules.json` – suggested stack plus playerbots.
|
||||
- - `config/module-profiles/playerbots-only.json` – playerbot-focused profile (adjust `--playerbot-max-bots`).
|
||||
- - `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.
|
||||
|
||||
---
|
||||
|
||||
@@ -4,7 +4,7 @@ This document provides a comprehensive overview of all available modules in the
|
||||
|
||||
## 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
|
||||
|
||||
@@ -261,4 +261,4 @@ Modules are categorized by type:
|
||||
|
||||
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
|
||||
|
||||
**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
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
**Date:** 2025-11-14
|
||||
**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
|
||||
@@ -31,7 +33,7 @@
|
||||
**Verified:**
|
||||
- Environment file present
|
||||
- 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 ✅
|
||||
```bash
|
||||
@@ -139,7 +141,7 @@ MODULES_ENABLED="mod-playerbots mod-aoe-loot ..."
|
||||
|
||||
**What Gets Built:**
|
||||
- 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.
|
||||
|
||||
### Deployment Status: READY TO DEPLOY 🚀
|
||||
@@ -261,7 +263,7 @@ docker exec ac-mysql mysql -uroot -p[password] acore_world \
|
||||
- **Bash:** 5.0+
|
||||
- **Python:** 3.x
|
||||
- **Docker:** Available
|
||||
- **Modules Enabled:** 93
|
||||
- **Modules Enabled:** 93 (historical run)
|
||||
- **Test Date:** 2025-11-14
|
||||
|
||||
---
|
||||
|
||||
@@ -23,7 +23,7 @@ Interactive `.env` generator with module selection, server configuration, and de
|
||||
|
||||
```bash
|
||||
./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
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user