diff --git a/docs/guides/server-side-mod-deployment-guide.md b/docs/guides/server-side-mod-deployment-guide.md index 0a6c423..afbadec 100644 --- a/docs/guides/server-side-mod-deployment-guide.md +++ b/docs/guides/server-side-mod-deployment-guide.md @@ -156,24 +156,39 @@ Michael will store the MySQL credentials in Vaultwarden so you can access them s --- #### 4. **FTB Library** (Dependency) -**What it does:** Required library for FTB Chunks and FTB Essentials to work. +**What it does:** Required library for FTB Chunks, FTB Essentials, and FTB Teams to work. **Why we need it:** FTB mods won't run without this. +**Dependency for:** FTB Chunks, FTB Essentials, FTB Teams + **Download:** https://www.curseforge.com/minecraft/mc-mods/ftb-library-forge --- -#### 5. **FTB Teams** +#### 5. **Architectury API** (Dependency) +**What it does:** Required library for many cross-platform mods (works with both Forge and Fabric). + +**Why we need it:** Required by FTB Library and some other mods. + +**Dependency for:** FTB Library (and transitively, all FTB mods) + +**Download:** https://www.curseforge.com/minecraft/mc-mods/architectury-api + +--- + +#### 6. **FTB Teams** **What it does:** Team system that integrates with FTB Chunks. Players can form teams and share chunk claims. **Why we need it:** Better than solo chunk claiming - teams can build together. +**Dependency for:** FTB Chunks (required) + **Download:** https://www.curseforge.com/minecraft/mc-mods/ftb-teams-forge --- -#### 6. **WorldEdit** +#### 7. **WorldEdit** **What it does:** Powerful building and editing tool. Copy/paste structures, fill areas, replace blocks, etc. **Why we need it:** Essential for builders (like you!). Staff rank gets full WorldEdit access. @@ -187,18 +202,20 @@ Michael will store the MySQL credentials in Vaultwarden so you can access them s --- -#### 7. **YAWP (Yet Another World Protector)** +#### 8. **YAWP (Yet Another World Protector)** **What it does:** Advanced world protection and region management. Protect spawn areas, create safe zones, etc. **Why we need it:** Protects important areas like spawn, prevents griefing in public spaces. +**Note:** May require additional dependencies depending on version - check mod page. + **Download:** https://www.curseforge.com/minecraft/mc-mods/yawp (check version availability) --- ### Performance & Optimization Mods (Highly Recommended) -#### 8. **ServerCore** +#### 9. **ServerCore** **What it does:** Server-side performance optimizations. Reduces lag, improves TPS (ticks per second). **Why we need it:** Running 13 servers requires good performance. This helps. @@ -207,7 +224,7 @@ Michael will store the MySQL credentials in Vaultwarden so you can access them s --- -#### 9. **FerriteCore** +#### 10. **FerriteCore** **What it does:** Reduces memory usage significantly (up to 30-40% in some cases). **Why we need it:** Less RAM per server = more stable operation across all 13 servers. @@ -216,7 +233,7 @@ Michael will store the MySQL credentials in Vaultwarden so you can access them s --- -#### 10. **Spark** +#### 11. **Spark** **What it does:** Performance profiling and monitoring. Helps diagnose lag. **Why we need it:** When a server lags, Spark tells us why (which mod, which chunk, etc.). @@ -227,7 +244,7 @@ Michael will store the MySQL credentials in Vaultwarden so you can access them s ### Protection & Rollback Mods -#### 11. **Prism** (if available for your version) +#### 12. **Prism** (if available for your version) **What it does:** Block logging and rollback protection. Records who placed/broke what blocks. **Why we need it:** If someone griefs a subscriber's build, we can roll it back and prove who did it. @@ -240,29 +257,35 @@ Michael will store the MySQL credentials in Vaultwarden so you can access them s ### Quality of Life Mods (Optional but Recommended) -#### 12. **Waystones** +#### 13. **Waystones** **What it does:** Fast travel between waystone structures. Players place waystones and teleport between them. **Why we might use it:** Nice QoL feature. Could tie cooldowns to subscriber tiers (like /rtp). **Status:** Optional - only install if the modpack doesn't already include it. -**Download:** https://www.curseforge.com/minecraft/mc-mods/waystones +**Dependencies:** Balm (Forge/NeoForge) - required library for Waystones + +**Download:** +- Waystones: https://www.curseforge.com/minecraft/mc-mods/waystones +- Balm: https://www.curseforge.com/minecraft/mc-mods/balm --- -#### 13. **Corpse** or **You're In Grave Danger** +#### 14. **Corpse** or **You're In Grave Danger** **What it does:** When you die, your items are stored in a grave/corpse instead of scattering. **Why we might use it:** Much better death experience for subscribers. Items protected, easy to retrieve. +**Status:** Optional - check if modpack already has death management + **Download:** Search CurseForge for your version --- ### Discord Integration (Version-Dependent) -#### 14. **Discord Integration Mod** +#### 15. **Discord Integration Mod** **What it does:** Connects Minecraft server to Discord. Shows in-game chat in Discord channel, and vice versa. @@ -284,24 +307,93 @@ Michael will store the MySQL credentials in Vaultwarden so you can access them s ### Monitoring & Analytics -#### 15. **Plan** (Optional) +#### 16. **Plan** (Optional) **What it does:** Player analytics dashboard. Track playtime, most active players, server performance over time. **Why we might use it:** Helps Michael/Meg understand player engagement and server health. +**Status:** Optional - adds overhead, use if analytics are important + **Download:** https://www.playeranalytics.net/ --- ### Voice Chat (Optional, if modpack includes it) -#### 16. **Simple Voice Chat** +#### 17. **Simple Voice Chat** **What it does:** Proximity voice chat in-game. Talk to players near you. **Status:** Only configure if the modpack already has it installed. Don't add it separately. **If present:** Configure permissions via LuckPerms (which tiers can use voice). +**Download:** https://www.curseforge.com/minecraft/mc-mods/simple-voice-chat + +--- + +#### 13. **Corpse** or **You're In Grave Danger** +**What it does:** When you die, your items are stored in a grave/corpse instead of scattering. + +**Why we might use it:** Much better death experience for subscribers. Items protected, easy to retrieve. + +**Download:** Search CurseForge for your version + +--- + +## 📋 DEPENDENCY SUMMARY + +**Before installing mods, understand the dependency chain:** + +### Critical Dependencies (Install These First) + +1. **Architectury API** → Required by FTB Library +2. **FTB Library** → Required by FTB Chunks, FTB Essentials, FTB Teams +3. **FTB Teams** → Required by FTB Chunks + +### Installation Order (Required Mods) + +**Step 1: Install Dependencies** +1. Architectury API +2. FTB Library +3. FTB Teams + +**Step 2: Install Core Functionality Mods** +4. LuckPerms (no dependencies) +5. FTB Chunks (requires: FTB Library, FTB Teams, Architectury API) +6. FTB Essentials (requires: FTB Library, Architectury API) +7. WorldEdit (no dependencies) +8. YAWP (check mod page for dependencies - varies by version) + +**Step 3: Install Performance Mods** +9. ServerCore (no dependencies) +10. FerriteCore (no dependencies) +11. Spark (no dependencies) + +**Step 4: Install Optional Mods (if desired)** +12. Prism (if available - check dependencies on mod page) +13. Balm (if installing Waystones) +14. Waystones (requires: Balm) +15. Corpse/Grave mod (check dependencies) +16. Discord integration mod (varies by version) +17. Plan (if using analytics) +18. Simple Voice Chat (if modpack includes it) + +### Quick Dependency Reference + +| Mod | Requires | Required By | +|-----|----------|-------------| +| Architectury API | None | FTB Library | +| FTB Library | Architectury API | FTB Chunks, FTB Essentials, FTB Teams | +| FTB Teams | FTB Library, Architectury API | FTB Chunks | +| FTB Chunks | FTB Library, FTB Teams, Architectury API | None | +| FTB Essentials | FTB Library, Architectury API | None | +| LuckPerms | None | None | +| WorldEdit | None | None | +| Balm | None | Waystones | +| Waystones | Balm | None | + +**If a mod won't load:** Check server console for "missing dependency" errors and install the required mod(s). + --- ## 🚀 INSTALLATION PROCESS