From 67a7bae5fb648bf207779a77e4b06ab2e805258e Mon Sep 17 00:00:00 2001 From: The Chronicler #21 Date: Sun, 22 Feb 2026 11:56:44 +0000 Subject: [PATCH] docs: Simple Voice Chat port configuration procedure Created comprehensive procedure for configuring Simple Voice Chat mod on Minecraft servers. Issue identified: Log shows voice chat server attempting to start on port 24454 but port may not be exposed through firewall/Pterodactyl, preventing players from using voice chat functionality. Procedure includes: - Discovery: Identify servers with Simple Voice Chat installed - Port allocation strategy (24454-24464 for 11 servers) - Pterodactyl configuration (UDP port allocation) - Server config file updates (voicechat-server.toml) - Firewall configuration (ufw rules for TX1/NC1) - Client-side instructions for players - Troubleshooting guide (connection issues, audio problems) - Port allocation tracking table Technical details: - Protocol: UDP (not TCP - critical for voice chat) - Port range: 24454-24464 (one unique port per server) - Firewall rules for both TX1 Dallas and NC1 Charlotte - Configuration file location: config/voicechat-server.toml Time estimate: 4-6 hours total implementation (30 min per server) Priority: Medium (quality of life enhancement, not critical) Success criteria: - Server logs show voice chat started successfully - Players see green connection icon (not red) - Proximity voice chat functions in-game - No port conflicts between servers Created by: The Blueprint Status: Ready to implement when resources available --- .../simple-voice-chat-port-configuration.md | 388 ++++++++++++++++++ 1 file changed, 388 insertions(+) create mode 100644 docs/procedures/simple-voice-chat-port-configuration.md diff --git a/docs/procedures/simple-voice-chat-port-configuration.md b/docs/procedures/simple-voice-chat-port-configuration.md new file mode 100644 index 0000000..51a3789 --- /dev/null +++ b/docs/procedures/simple-voice-chat-port-configuration.md @@ -0,0 +1,388 @@ +# Simple Voice Chat - Port Configuration Procedure + +**Document ID:** FFG-PROC-001 +**Created:** February 22, 2026 +**Created By:** The Blueprint (Chronicler #21) +**Status:** READY TO IMPLEMENT +**Priority:** MEDIUM (Quality of Life Enhancement) + +--- + +## 🎯 ISSUE IDENTIFIED + +**Log Entry Found:** +``` +[11:50:22] [VoiceChatServerThread/INFO] [voicechat/]: [voicechat] Voice chat server started at 0.0.0.0:24454 +``` + +**What This Means:** +- Simple Voice Chat mod is installed on a Minecraft server +- Voice chat server attempting to start on port 24454 +- Port may not be exposed through firewall/Pterodactyl +- Players cannot use voice chat functionality + +**Impact:** +- Voice chat feature non-functional for players +- Reduced gameplay experience (communication via text only) +- Mod installed but not working = player confusion + +--- + +## 📊 AFFECTED SERVERS + +**Identify which servers have Simple Voice Chat installed:** + +**Step 1: Check server mods list** +```bash +# SSH into TX1 or NC1 +# Navigate to each server's mods directory +cd /var/lib/pterodactyl/volumes/{server-uuid}/mods/ + +# Search for Simple Voice Chat +ls -la | grep -i voice +# Look for: voicechat-*.jar or simplevoicechat-*.jar +``` + +**Step 2: Check server logs** +```bash +# In Pterodactyl Panel, check each server's console logs +# Search for: "voicechat" or "Voice chat server started" +``` + +**Likely candidates:** +- Modded servers with heavy mod packs (ATM, FTB, etc.) +- Servers where players requested voice chat +- Newer modpack installations (voice chat is popular) + +**Action:** Document which servers need port configuration + +--- + +## 🔧 CONFIGURATION PROCEDURE + +### Part 1: Determine Port Requirements + +**Default Simple Voice Chat port:** 24454 (UDP) + +**Check mod configuration:** +```bash +# Location: server/config/voicechat-server.toml +cat /var/lib/pterodactyl/volumes/{server-uuid}/config/voicechat-server.toml +``` + +**Look for:** +```toml +[voicechat] +# The port of the voice chat server +port = 24454 +# The binding address (0.0.0.0 = all interfaces) +bind_address = "0.0.0.0" +``` + +**Important:** Each server needs a UNIQUE port (cannot all use 24454) + +**Port allocation strategy:** +- Server 1: 24454 +- Server 2: 24455 +- Server 3: 24456 +- etc. + +--- + +### Part 2: Configure Pterodactyl Egg Variables + +**For each affected server:** + +1. **Access Pterodactyl Panel** + - Navigate to server + - Go to "Startup" tab + +2. **Add Port Allocation** + - Click "Network" or "Allocations" + - Add new allocation: Port 24454 (or next available in sequence) + - Protocol: UDP (CRITICAL - voice chat uses UDP, not TCP) + +3. **Update Egg Variable (if available)** + - Some eggs have VOICECHAT_PORT variable + - Set to allocated port number + - Otherwise, manual config file edit required + +--- + +### Part 3: Update Server Configuration + +**Edit voicechat-server.toml:** + +```bash +# SSH into server node (TX1 or NC1) +nano /var/lib/pterodactyl/volumes/{server-uuid}/config/voicechat-server.toml +``` + +**Update port to match Pterodactyl allocation:** + +```toml +[voicechat] +port = 24454 # Change to your allocated port +bind_address = "0.0.0.0" # Leave as 0.0.0.0 +``` + +**Save and exit** + +--- + +### Part 4: Firewall Configuration + +**On TX1 Dallas (38.68.14.26):** + +```bash +# Allow UDP port range for voice chat +sudo ufw allow 24454:24464/udp comment "Simple Voice Chat (Minecraft)" + +# Verify rule added +sudo ufw status numbered +``` + +**On NC1 Charlotte (216.239.104.130):** + +```bash +# Same command +sudo ufw allow 24454:24464/udp comment "Simple Voice Chat (Minecraft)" +sudo ufw status numbered +``` + +**Note:** Opening 24454-24464 allows 11 servers to have voice chat (one per port) + +--- + +### Part 5: Restart Servers + +**For each configured server:** + +1. Stop server in Pterodactyl +2. Wait 10 seconds +3. Start server +4. Monitor console for: + ``` + [voicechat] Voice chat server started at 0.0.0.0:24454 + ``` +5. Verify port is listening: + ```bash + sudo netstat -tulpn | grep 24454 + ``` + +--- + +### Part 6: Client-Side Instructions (For Players) + +**Players need Simple Voice Chat mod installed:** + +1. **Install mod client-side** + - Download from CurseForge or Modrinth + - Must match server version + - Place in client mods folder + +2. **Configure in-game** + - Press `V` key (default) to open voice chat GUI + - Select input/output device + - Adjust volume levels + - Test microphone + +3. **Verify connection** + - Green icon in corner = connected + - Red icon = not connected (port issue) + +**If red icon persists:** +- Check firewall allows UDP port +- Verify server port in F3 debug screen matches allocation +- Ensure client mod version matches server + +--- + +## 📋 IMPLEMENTATION CHECKLIST + +### Discovery Phase +- [ ] Identify all servers with Simple Voice Chat installed +- [ ] Document current port configurations (if any) +- [ ] Check if ports are already allocated in Pterodactyl +- [ ] Determine port allocation sequence (24454-24464) + +### Configuration Phase (Per Server) +- [ ] Allocate UDP port in Pterodactyl Panel +- [ ] Update voicechat-server.toml configuration +- [ ] Open firewall port on respective node (TX1 or NC1) +- [ ] Restart server +- [ ] Verify voice chat server starts successfully + +### Testing Phase +- [ ] Connect to server with client +- [ ] Install Simple Voice Chat mod client-side +- [ ] Press V key and verify voice chat GUI opens +- [ ] Test microphone and audio output +- [ ] Verify green connection icon appears +- [ ] Test proximity voice chat with another player + +### Documentation Phase +- [ ] Document which servers have voice chat enabled +- [ ] Update server descriptions (mention voice chat available) +- [ ] Create player guide for installing client mod +- [ ] Add to server troubleshooting documentation + +--- + +## 🚨 TROUBLESHOOTING + +### Issue: Voice chat server won't start + +**Check logs for:** +``` +Address already in use +``` + +**Solution:** Port conflict - another server using same port. Assign different port. + +--- + +### Issue: Players see red icon (not connected) + +**Possible causes:** +1. **Firewall blocking UDP port** + - Verify: `sudo ufw status | grep 24454` + - Fix: Open port as shown in Part 4 + +2. **Wrong port in config** + - Check: `voicechat-server.toml` port matches Pterodactyl allocation + - Fix: Update config to correct port + +3. **Client mod not installed** + - Players need mod client-side too + - Fix: Provide installation instructions + +4. **Version mismatch** + - Client mod version must match server mod version + - Fix: Update client or server mod to match + +--- + +### Issue: Voice chat works but audio is choppy + +**Possible causes:** +1. **Server performance issues** + - Check TPS (should be 20) + - Fix: Reduce server load or upgrade resources + +2. **Player internet connection** + - Voice chat uses UDP (real-time) + - Fix: Player-side network issue + +3. **Codec settings** + - Check voicechat-server.toml codec configuration + - Fix: Try different codec (opus vs voip) + +--- + +## 📊 PORT ALLOCATION TRACKING + +**Maintain this table for reference:** + +| Server Name | UUID (first 8) | Allocated Port | Node | Status | +|-------------|----------------|----------------|------|--------| +| [TBD] | [TBD] | 24454 | TX1/NC1 | [TBD] | +| [TBD] | [TBD] | 24455 | TX1/NC1 | [TBD] | +| [TBD] | [TBD] | 24456 | TX1/NC1 | [TBD] | + +**Update this table as servers are configured** + +--- + +## 🎯 SUCCESS CRITERIA + +**Voice chat is properly configured when:** + +✅ Server logs show: `Voice chat server started at 0.0.0.0:[PORT]` +✅ Firewall allows UDP traffic on allocated port +✅ Players with client mod see GREEN icon +✅ Players can hear each other in proximity +✅ No port conflicts with other servers +✅ Configuration survives server restart + +--- + +## 📝 MAINTENANCE NOTES + +### When adding new modpack servers: + +1. Check if modpack includes Simple Voice Chat +2. Allocate next available port (24454+) +3. Configure before first player connection +4. Update port tracking table +5. Inform players about voice chat feature + +### When updating Simple Voice Chat mod: + +1. Check changelog for config changes +2. Backup existing voicechat-server.toml +3. Update mod file +4. Verify config still valid +5. Restart and test + +--- + +## 🔗 RELATED DOCUMENTATION + +- **Pterodactyl Port Allocation:** `docs/infrastructure/pterodactyl-network-config.md` (if exists) +- **Firewall Management:** `docs/infrastructure/firewall-rules.md` (if exists) +- **Server Mods List:** `docs/game-servers/installed-mods.md` (if exists) + +--- + +## 📅 IMPLEMENTATION TIMELINE + +**Suggested approach:** + +**Week 1: Discovery** +- Identify affected servers (2 hours) +- Plan port allocations (30 min) + +**Week 2: Configuration** +- Configure servers one by one (30 min per server) +- Test each server after configuration + +**Week 3: Player Communication** +- Announce voice chat availability +- Provide client installation guide +- Monitor for issues + +**Total time estimate:** 4-6 hours (depending on number of servers) + +--- + +## 💡 OPTIONAL ENHANCEMENTS + +**Future considerations:** + +1. **Discord Integration** + - Some voice chat mods can bridge to Discord + - Allows Discord users to hear in-game players + +2. **Proximity Chat Recording** + - Some servers enable recording for moderation + - Requires additional storage planning + +3. **Custom Voice Chat Groups** + - Players can create private voice channels + - Useful for teams/factions + +4. **Voice Chat Metrics** + - Track usage statistics + - Optimize based on player feedback + +--- + +**Created:** February 22, 2026 +**By:** The Blueprint (Chronicler #21) +**Status:** Ready for implementation when resources available +**Priority:** Medium (enhances gameplay but not critical) + +💙🔥❄️ + +**Fire + Frost + Foundation = Where Players Communicate Clearly**