diff --git a/docker-compose-azerothcore-services.yml b/docker-compose-azerothcore-services.yml index d3a3f28..c6a5946 100644 --- a/docker-compose-azerothcore-services.yml +++ b/docker-compose-azerothcore-services.yml @@ -1062,7 +1062,7 @@ services: echo " docker compose -f /tmp/acore-dev-test/docker-compose.yml up -d" echo "" echo "3. Or use the automated rebuild script (if available):" - echo " ./rebuild-with-modules.sh" + echo " ./scripts/rebuild-with-modules.sh" echo "" echo "📋 NOTE: Source-based build will compile AzerothCore with all enabled modules" echo "⏱️ Expected build time: 15-45 minutes depending on system performance" diff --git a/MODULE_COMPATIBILITY.md b/docs/MODULE_COMPATIBILITY.md similarity index 98% rename from MODULE_COMPATIBILITY.md rename to docs/MODULE_COMPATIBILITY.md index 3ebea85..6ae9952 100644 --- a/MODULE_COMPATIBILITY.md +++ b/docs/MODULE_COMPATIBILITY.md @@ -95,7 +95,7 @@ This document tracks the compatibility status of AzerothCore modules with the au 2. **Test Compilation**: ```bash - ./rebuild-with-modules.sh + ./scripts/rebuild-with-modules.sh ``` 3. **Monitor Build**: @@ -167,7 +167,7 @@ This document tracks the compatibility status of AzerothCore modules with the au MODULE_NAME=1 # 2. Rebuild if needed -./rebuild-with-modules.sh +./scripts/rebuild-with-modules.sh # 3. Restart services docker compose -f docker-compose-azerothcore-services.yml restart diff --git a/MODULE_MANAGEMENT.md b/docs/MODULE_MANAGEMENT.md similarity index 97% rename from MODULE_MANAGEMENT.md rename to docs/MODULE_MANAGEMENT.md index 077b6a1..3b4b32d 100644 --- a/MODULE_MANAGEMENT.md +++ b/docs/MODULE_MANAGEMENT.md @@ -26,7 +26,7 @@ The module management system provides: - Automatically detects when compilation is required - Provides detailed rebuild instructions -3. **Automated Rebuild Script** (`rebuild-with-modules.sh`) +3. **Automated Rebuild Script** (`scripts/rebuild-with-modules.sh`) - Orchestrates full compilation workflow - Integrates with source-based Docker builds - Handles module synchronization @@ -132,7 +132,7 @@ Module configuration has changed. To integrate C++ modules into AzerothCore: docker compose -f /tmp/acore-dev-test/docker-compose.yml up -d 3. Or use the automated rebuild script (if available): - ./rebuild-with-modules.sh + ./scripts/rebuild-with-modules.sh ``` ### Automated Rebuild Script @@ -171,7 +171,7 @@ The `rebuild-with-modules.sh` script provides: 3. Follow rebuild instructions or run: ```bash - ./rebuild-with-modules.sh + ./scripts/rebuild-with-modules.sh ``` ### Disable Module @@ -193,7 +193,7 @@ MODULE_TRANSMOG=1 MODULE_SOLO_LFG=1 # Single rebuild handles all changes -./rebuild-with-modules.sh +./scripts/rebuild-with-modules.sh ``` ## Troubleshooting diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..2bd43b0 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,98 @@ +# AzerothCore Module Management Documentation + +This directory contains comprehensive documentation for the AzerothCore automated module management system. + +## Documentation Overview + +### 📖 [MODULE_MANAGEMENT.md](MODULE_MANAGEMENT.md) +**Complete system guide** covering: +- Architecture overview and components +- Module installation and configuration +- Database integration and SQL execution +- Rebuild detection and automation +- Usage examples and troubleshooting + +### 📋 [MODULE_COMPATIBILITY.md](MODULE_COMPATIBILITY.md) +**Module compatibility matrix** including: +- Status of all 28 analyzed modules +- Known issues and compatibility notes +- Testing procedures and best practices +- Troubleshooting guide for specific modules + +## Quick Start + +### 1. Enable a Module +```bash +# Edit environment file +vim docker-compose-azerothcore-services.env +# Set MODULE_NAME=1 + +# Rebuild if C++ compilation required +./scripts/rebuild-with-modules.sh + +# Restart services +docker compose -f docker-compose-azerothcore-services.yml restart +``` + +### 2. Check Module Status +```bash +# View current configuration +grep "^MODULE_" docker-compose-azerothcore-services.env + +# Check for rebuild requirements +docker compose -f docker-compose-azerothcore-services.yml up ac-modules +``` + +### 3. Safe Testing Approach +1. Start with all modules disabled (current state) +2. Enable one module at a time +3. Test compilation and functionality +4. Document results in compatibility matrix + +## Directory Structure + +``` +docs/ +├── README.md # This overview file +├── MODULE_MANAGEMENT.md # Complete system documentation +└── MODULE_COMPATIBILITY.md # Module compatibility matrix + +scripts/ +└── rebuild-with-modules.sh # Automated rebuild script + +docker-compose-azerothcore-services.yml # Main service configuration +docker-compose-azerothcore-services.env # Module configuration +``` + +## System Features + +- ✅ **Automatic Module Detection**: Downloads and analyzes all available modules +- ✅ **State Tracking**: Hash-based change detection triggers rebuilds automatically +- ✅ **SQL Integration**: Executes module database scripts automatically +- ✅ **Configuration Management**: Handles .conf file setup +- ✅ **Rebuild Automation**: Complete source-based compilation workflow +- ✅ **Compatibility Analysis**: Documents module requirements and issues + +## Support + +### For Module-Specific Issues +- Check the compatibility matrix in `MODULE_COMPATIBILITY.md` +- Refer to individual module GitHub repositories +- Test modules incrementally + +### For System Issues +- Review `MODULE_MANAGEMENT.md` troubleshooting section +- Check Docker logs: `docker compose logs ac-modules` +- Verify environment configuration + +## Contributing + +When testing modules: +1. Update compatibility status in `MODULE_COMPATIBILITY.md` +2. Document any special requirements or configuration +3. Report issues to module maintainers +4. Submit pull requests with compatibility findings + +--- + +**Note**: All modules are currently disabled for a stable baseline. Enable and test modules individually to ensure compatibility with your specific AzerothCore setup. \ No newline at end of file diff --git a/rebuild-with-modules.sh b/scripts/rebuild-with-modules.sh similarity index 100% rename from rebuild-with-modules.sh rename to scripts/rebuild-with-modules.sh