diff --git a/docs/tasks/discord-server-complete-reorganization/README.md b/docs/tasks/discord-server-complete-reorganization/README.md index f845f66..6762b46 100644 --- a/docs/tasks/discord-server-complete-reorganization/README.md +++ b/docs/tasks/discord-server-complete-reorganization/README.md @@ -3,10 +3,10 @@ **Status:** Planning **Priority:** Tier 3 - Community **Time:** 2-3 hours -**Last Updated:** 2026-02-16 +**Last Updated:** 2026-02-18 ## Overview -Complete reorganization of Firefrost Discord server. Clear channel structure, proper roles, Fire/Frost departments. +Complete reorganization of Firefrost Discord server. Clear channel structure, proper roles, Fire/Frost departments, and professional support infrastructure. ## Structure - Welcome/Rules channels @@ -15,6 +15,7 @@ Complete reorganization of Firefrost Discord server. Clear channel structure, pr - Staff channels - Game-specific channels - Community channels +- **Technical Support** (with MCLogs integration) ## Roles - Path roles (Fire/Frost) @@ -22,10 +23,24 @@ Complete reorganization of Firefrost Discord server. Clear channel structure, pr - Staff roles - Game-specific roles +## Support Infrastructure +**MCLogs Integration** - See `mclogs-integration.md` +- Technical support channel with standardized log sharing +- MCLogs (mclo.gs) for crash reports and diagnostics +- Staff training on log analysis +- Pinned instructions for players +- Optional bot commands for automation + ## Success Criteria - ✅ Clean channel structure - ✅ Roles properly configured - ✅ Fire/Frost paths clear +- ✅ MCLogs support process deployed +- ✅ Staff trained on troubleshooting - ✅ Documentation updated +## Related Documentation +- `mclogs-integration.md` - Complete MCLogs deployment guide +- `deployment-plan.md` - Full Discord reorganization steps + **Fire + Frost + Foundation** 💙🔥❄️ diff --git a/docs/tasks/discord-server-complete-reorganization/mclogs-integration.md b/docs/tasks/discord-server-complete-reorganization/mclogs-integration.md new file mode 100644 index 0000000..6ac933e --- /dev/null +++ b/docs/tasks/discord-server-complete-reorganization/mclogs-integration.md @@ -0,0 +1,384 @@ +# Discord Support - MCLogs Integration + +**Component:** Technical Support Infrastructure +**Service:** MCLogs (mclo.gs) +**Purpose:** Standardized log sharing for troubleshooting +**Created:** 2026-02-18 +**Status:** Ready to implement with Discord reorganization + +--- + +## Overview + +MCLogs (mclo.gs) is the industry-standard log sharing service for Minecraft servers. Purpose-built for Minecraft crash reports and server logs with automatic parsing, error highlighting, and common issue detection. + +**Why MCLogs:** +- ✅ Minecraft-specific parsing +- ✅ Automatic error highlighting +- ✅ Mod list detection +- ✅ Common issue identification +- ✅ Free, no account needed +- ✅ Permanent links +- ✅ Used by most major Minecraft Discord servers + +--- + +## Implementation Plan + +### Phase 1: Support Channel Setup + +**Create dedicated support channel:** +- **Name:** `#technical-support` or `#help` +- **Purpose:** Player troubleshooting and issue reporting +- **Permissions:** All members can post + +**Channel Description/Topic:** +``` +Having technical issues? Share your logs! + +📋 How to submit logs: +1. Find your log file (see pinned message) +2. Upload to https://mclo.gs +3. Share the link here +4. Staff will help diagnose! + +⚠️ DO NOT paste logs directly in chat +``` + +--- + +### Phase 2: Pinned Instructions + +**Create pinned message in #technical-support:** + +```markdown +# 🔧 How to Get Help With Technical Issues + +## Before You Ask +1. Have you restarted your game? +2. Have you restarted the server connection? +3. Is your modpack up to date? + +## Sharing Your Logs + +### Step 1: Find Your Log File + +**For Crashes:** +- Location: `.minecraft/crash-reports/` +- File: Most recent `crash-YYYY-MM-DD_HH.MM.SS-client.txt` + +**For Other Issues:** +- Location: `.minecraft/logs/` +- File: `latest.log` + +**How to find .minecraft folder:** +- Windows: Press `Win+R`, type `%appdata%\.minecraft`, press Enter +- Mac: `~/Library/Application Support/minecraft` +- Linux: `~/.minecraft` + +### Step 2: Upload to MCLogs + +1. Go to **https://mclo.gs** +2. Drag your log file onto the page (or click to browse) +3. Wait for upload to complete +4. Click **"Save"** +5. Copy the link from your browser + +### Step 3: Share Here + +Post in this channel with: +- Description of your issue +- What you were doing when it happened +- Your MCLogs link + +**Example:** +``` +Issue: Game crashes when I try to catch a Pokémon +What I was doing: Threw a Pokéball at a wild Pikachu +Log: https://mclo.gs/abc123xyz +``` + +## Staff Response Time +- Peak hours: Within 1 hour +- Off-peak: Within 6 hours +- Urgent issues: Ping @Staff + +## Common Issues & Quick Fixes +- **Low FPS:** Reduce render distance, turn off shaders +- **Connection timeout:** Check server status in #server-status +- **Missing textures:** Reinstall modpack +- **Out of memory:** Allocate more RAM (see #modpack-setup) + +--- + +⚠️ **Important:** Do NOT paste logs directly in chat +❌ Discord truncates long messages +❌ Formatting breaks and makes logs unreadable +✅ Always use https://mclo.gs instead +``` + +--- + +### Phase 3: Bot Integration (Optional - Future) + +**When Discord bot is deployed, add commands:** + +#### `/help-logs` +**Description:** Show log submission instructions +**Response:** (Same as pinned message above) + +#### `/logs` +**Alias:** Quick reminder +**Response:** +``` +📋 To share logs for troubleshooting: +1. Upload to https://mclo.gs +2. Share the link here +Staff will help! 🔧 +``` + +#### `/diagnose ` +**Description:** Staff command to analyze log +**Response:** Parse MCLogs link, extract key errors, suggest common fixes +**Example:** +``` +🔍 Log Analysis: +- Error: OutOfMemoryError +- Allocated RAM: 4GB +- Recommended: Increase to 8GB + +💡 Quick Fix: Launcher → Installations → Edit → More Options → Change -Xmx4G to -Xmx8G +``` + +--- + +### Phase 4: Staff Training + +**Train all staff on MCLogs usage:** + +**DO:** +- ✅ Always ask for MCLogs link +- ✅ Read full log before responding +- ✅ Look for highlighted errors (red text) +- ✅ Check mod list at bottom +- ✅ Identify common issues (RAM, mod conflicts) + +**DON'T:** +- ❌ Ask players to paste logs in Discord +- ❌ Guess at issues without logs +- ❌ Give generic advice without diagnostics + +**Common Error Patterns:** + +**OutOfMemoryError:** +- **Cause:** Not enough RAM allocated +- **Fix:** Increase to 8GB for modpacks + +**Missing/Incompatible Mod:** +- **Cause:** Client mod mismatch with server +- **Fix:** Reinstall modpack or update specific mod + +**Connection Timeout:** +- **Cause:** Server lag or network issue +- **Fix:** Check server TPS, player's internet + +**Ticking Entity:** +- **Cause:** Corrupted entity/block in world +- **Fix:** Delete player data or rollback chunk + +--- + +### Phase 5: Documentation Integration + +**Update these documents:** + +**#modpack-setup channel:** +Add section: "When Things Go Wrong - Getting Help" + +**Welcome/Rules:** +Add rule: "Use MCLogs for technical support (no log spam in chat)" + +**FAQ:** +Add entry: "How do I share crash logs?" + +--- + +## MCLogs Features for Staff + +### Automatic Detection + +**MCLogs automatically highlights:** +- Java exceptions (in red) +- Mod conflicts +- Memory issues +- Missing dependencies + +### Mod List + +**Bottom of every log shows:** +- All installed mods +- Mod versions +- Loader version (Forge/Fabric/NeoForge) + +**Use this to verify:** +- Player has correct modpack version +- No extra/missing mods +- Mod versions match server + +### Search Function + +**Use Ctrl+F to find:** +- Specific mod names +- Error types +- Player names +- Timestamps + +--- + +## Common Support Scenarios + +### Scenario 1: Player Crashes on Join + +**Player reports:** "I crash when I try to join the server" + +**Staff response:** +``` +Sorry to hear that! Let's diagnose: +1. Upload your crash report to https://mclo.gs +2. Share the link here +3. Also check: How much RAM do you have allocated? + (Launcher → Installations → Edit → More Options → Look for -Xmx) +``` + +**When log arrives:** +- Check for OutOfMemoryError → RAM issue +- Check for mod mismatch → Reinstall modpack +- Check for connection errors → Network/firewall + +--- + +### Scenario 2: Server Lag Reported + +**Player reports:** "Server is super laggy right now" + +**Staff response:** +``` +Thanks for the report! A few things: +1. What's your ping? (Press Tab in-game, see number next to your name) +2. Check server TPS: Type /tps or /forge tps +3. If TPS is below 18, it's server-side. If TPS is 20 but you're laggy, it's client-side. + +If client-side lag: +- Upload your latest.log to https://mclo.gs and share here +- I'll check for performance issues +``` + +--- + +### Scenario 3: Specific Feature Broken + +**Player reports:** "Pokémon menu won't open" + +**Staff response:** +``` +Let's troubleshoot: +1. Have you tried restarting your game? +2. What happens when you press R? (Nothing? Error? Crash?) +3. Upload your latest.log to https://mclo.gs + +Also check: +- Are you using any custom keybinds? +- Did you recently change any settings? +``` + +--- + +## Alternative: Self-Hosted (Future) + +**If you want DERP-compliant log hosting:** + +### MCLogs-like Self-Hosted Options + +**Gist-like services:** +- PrivateBin (self-hosted pastebin) +- Hastebin (can be self-hosted) +- Custom solution with log parsing + +**Deployment:** +- Host on TX1 or NC1 +- URL: logs.firefrostgaming.com +- Docker deployment (~1 hour setup) + +**Pros:** +- ✅ DERP-compliant +- ✅ Full control +- ✅ Branded to Firefrost +- ✅ Privacy (logs stay on your servers) + +**Cons:** +- ❌ Setup/maintenance work +- ❌ Storage costs (logs can be large) +- ❌ Need to keep updated +- ❌ Less features than MCLogs (unless you build them) + +**Recommendation:** Start with mclo.gs (free, proven), consider self-hosting later if needed + +--- + +## Success Metrics + +**After implementation, track:** + +**Response Quality:** +- % of support requests with logs provided +- Average time to resolution (with vs without logs) +- Staff satisfaction (easier troubleshooting) + +**Player Experience:** +- Fewer "can't help without logs" messages +- Faster issue resolution +- Less back-and-forth in support channel + +**Target Metrics:** +- 80%+ of support requests include MCLogs link +- Average resolution time under 15 minutes +- Staff report "much easier to diagnose" + +--- + +## Integration Checklist + +**When deploying Discord reorganization:** + +- [ ] Create #technical-support channel +- [ ] Set channel description with MCLogs link +- [ ] Create and pin detailed instructions +- [ ] Train all staff on MCLogs usage +- [ ] Update #modpack-setup with troubleshooting section +- [ ] Add FAQ entry about log sharing +- [ ] Test with sample issues +- [ ] Announce to community about new support process +- [ ] Monitor first week for confusion/questions +- [ ] Iterate on instructions based on feedback + +--- + +## Related Tasks + +- **Discord Server Complete Reorganization:** Parent task +- **Discord Bot Deployment (Future):** Bot commands integration +- **Staff Training Program:** Include MCLogs in staff onboarding + +--- + +## References + +- **MCLogs Website:** https://mclo.gs +- **MCLogs GitHub:** https://github.com/aternosorg/mclogs (for self-hosting research) +- **Alternative Services:** pastebin.com, paste.gg, hastebin.com + +--- + +**Fire + Frost + Foundation = Where Love Builds Legacy** 💙🔥❄️ + +**Professional support infrastructure = Player confidence**