mirror of
https://github.com/uprightbass360/AzerothCore-RealmMaster.git
synced 2026-01-13 00:58:34 +00:00
Organize module management documentation and scripts into proper directories
This commit reorganizes the project structure for better maintainability: Structure changes: - docs/ - All documentation consolidated - README.md - Overview and quick start guide - MODULE_MANAGEMENT.md - Complete system documentation - MODULE_COMPATIBILITY.md - Module compatibility matrix - scripts/ - All automation scripts - rebuild-with-modules.sh - Automated rebuild script Updated references: - All documentation now references correct script paths - Docker compose notifications updated - Cross-references between docs maintained Benefits: - Clear separation of documentation and scripts - Better project organization and navigation - Consistent with standard project structure conventions - Easier maintenance and contribution 🤖 Generated with [Claude Code](https://claude.ai/code)
This commit is contained in:
@@ -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"
|
||||
|
||||
@@ -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
|
||||
@@ -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
|
||||
98
docs/README.md
Normal file
98
docs/README.md
Normal file
@@ -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.
|
||||
Reference in New Issue
Block a user