feat: add Task #34 - Simple Voice Chat setup for Mayview
Created complete task package for proximity voice chat on Mayview server. **New Task:** #34 - Simple Voice Chat Setup for Mayview - Tier: 3 (Documentation & Optimization) - Time: 1-2 hours - Status: READY **Task Package Includes:** - README.md: Complete task overview with configuration options - deployment-plan.md: Step-by-step installation and testing procedures **Key Features:** - Proximity-based voice chat (48 block default range) - Whisper mode (crouch for quieter, shorter range) - Group chat system - Client and server installation guides - Firewall configuration (UDP port 24454) - Player rollout communication templates - Testing plan (single + multi-client) - 30-day adoption review criteria **Technical Details:** - Mod: Simple Voice Chat by henkelmax - Platform: NeoForge 1.21.1 - Server: Mayview (NC1 Charlotte) - Requirements: Server + client installation, firewall rule - Codec: OPUS recommended (quality over VOIP performance) **Deployment Phases:** 1. Preparation (verify version, backup) 2. Server installation (mod + config + firewall) 3. Client testing (single player + multi-player proximity) 4. Player rollout (guide, announcement, monitoring) **Rollback Plan:** 5 minutes (remove mod, close port, restart) **Success Criteria:** - Server starts with no errors - Proximity detection works (volume changes with distance) - >50% player adoption (30-day review) - Positive feedback, stable performance Player experience enhancement - optional feature, doesn't replace Discord. Updated tasks.md: Total tasks now 34 (was 32) Signed-off-by: Chronicler #22
This commit is contained in:
@@ -765,7 +765,7 @@ Add custom "Modpack Version" field to Pterodactyl panel for version tracking vis
|
||||
|
||||
## 📊 QUICK STATS
|
||||
|
||||
**Total Tasks:** 32 (including Firefrost Codex)
|
||||
**Total Tasks:** 34 (including Firefrost Codex + Simple Voice Chat)
|
||||
**Completed:** 3 (NC1 cleanup, Command Center cleanup, Whitelist Manager)
|
||||
**In Progress:** 2 (Vaultwarden, Terraria Arc)
|
||||
**Ready to Build:** 19+ (including Firefrost Codex!)
|
||||
@@ -846,3 +846,57 @@ Small improvements to Whitelist Manager:
|
||||
**Impact:** Cosmetic only - does not affect functionality
|
||||
|
||||
---
|
||||
|
||||
### 34. Simple Voice Chat Setup for Mayview
|
||||
**Time:** 1-2 hours
|
||||
**Status:** READY
|
||||
**Priority:** Tier 3 - Documentation & Optimization
|
||||
**Server:** Mayview (NC1 Charlotte)
|
||||
**Documentation:** `docs/tasks/simple-voice-chat-mayview/`
|
||||
|
||||
Install Simple Voice Chat mod on Mayview to enable proximity-based in-game voice communication.
|
||||
|
||||
**Features:**
|
||||
- Proximity voice chat (hear players based on distance)
|
||||
- Group chat system
|
||||
- Whisper mode (crouch for quieter voice, shorter range)
|
||||
- Adjustable distance and volume controls
|
||||
- No external server required
|
||||
|
||||
**Requirements:**
|
||||
- Server-side: Install mod on Mayview
|
||||
- Client-side: All players must install mod
|
||||
- Firewall: Open UDP port 24454 on NC1
|
||||
- Configuration: Set voice distance, codec, settings
|
||||
|
||||
**Benefits:**
|
||||
- Enhanced immersion (spatial audio)
|
||||
- Better role-playing experience
|
||||
- Optional (players can still use Discord)
|
||||
- Low performance overhead
|
||||
|
||||
**Deployment:**
|
||||
1. Research compatible version for NeoForge 1.21.1
|
||||
2. Install mod on server
|
||||
3. Configure settings (voice distance 48 blocks, OPUS codec)
|
||||
4. Open firewall port 24454/UDP
|
||||
5. Test with small group (2-3 players)
|
||||
6. Create player installation guide
|
||||
7. Announce to Mayview players
|
||||
8. Monitor feedback and adoption
|
||||
|
||||
**Testing Plan:**
|
||||
- Phase 1: Server installation and startup verification
|
||||
- Phase 2: Single client test (connection, audio)
|
||||
- Phase 3: Multi-client test (proximity, whisper, performance)
|
||||
- Phase 4: Player rollout and monitoring
|
||||
|
||||
**Rollback:** Remove mod, close firewall port, restart server (5 minutes)
|
||||
|
||||
**Decision Point (30 days):**
|
||||
- Keep if >50% adoption + positive feedback
|
||||
- Remove if <30% adoption or major issues
|
||||
|
||||
**See task directory for:** Complete deployment plan, configuration options, troubleshooting guide, player communication templates
|
||||
|
||||
---
|
||||
|
||||
382
docs/tasks/simple-voice-chat-mayview/README.md
Normal file
382
docs/tasks/simple-voice-chat-mayview/README.md
Normal file
@@ -0,0 +1,382 @@
|
||||
# Task: Simple Voice Chat Setup for Mayview
|
||||
|
||||
**Task ID:** #34
|
||||
**Tier:** 3 (Documentation & Optimization)
|
||||
**Status:** READY
|
||||
**Priority:** Low (Player experience enhancement)
|
||||
**Estimated Time:** 1-2 hours
|
||||
**Server:** Mayview (NC1 Charlotte)
|
||||
**Created:** February 22, 2026
|
||||
|
||||
---
|
||||
|
||||
## OVERVIEW
|
||||
|
||||
Install Simple Voice Chat mod on Mayview server to enable proximity-based in-game voice communication for players.
|
||||
|
||||
**What it provides:**
|
||||
- Proximity voice chat (hear players based on distance)
|
||||
- Group chat system
|
||||
- Adjustable voice distance and volume
|
||||
- Whisper mode (lower volume, shorter range)
|
||||
- No external server required (runs through Minecraft server)
|
||||
|
||||
---
|
||||
|
||||
## CURRENT STATE
|
||||
|
||||
**Mayview Server:**
|
||||
- **Platform:** NeoForge
|
||||
- **Version:** 1.21.1
|
||||
- **Location:** NC1 Charlotte
|
||||
- **Modpack:** Custom (Cobblemon-focused)
|
||||
- **Active Players:** [To be confirmed]
|
||||
|
||||
**Current voice solution:** Players use Discord (assumed)
|
||||
|
||||
---
|
||||
|
||||
## WHY THIS TASK
|
||||
|
||||
**Benefits:**
|
||||
- Enhanced immersion (proximity-based, not global Discord)
|
||||
- Better role-playing experience
|
||||
- Spatial awareness (know where voices come from)
|
||||
- Optional for players (Discord still available)
|
||||
- Low overhead performance
|
||||
|
||||
**Use cases:**
|
||||
- Cooperative Cobblemon hunts
|
||||
- Trading negotiations
|
||||
- In-game socializing
|
||||
- Events and gatherings
|
||||
|
||||
---
|
||||
|
||||
## PREREQUISITES
|
||||
|
||||
### Technical Requirements
|
||||
- [ ] Verify Mayview is 1.21.1 NeoForge
|
||||
- [ ] Confirm Simple Voice Chat has 1.21.1 NeoForge version
|
||||
- [ ] NC1 firewall access (open UDP port)
|
||||
- [ ] Pterodactyl panel access for Mayview
|
||||
|
||||
### Player Requirements
|
||||
- [ ] All players must install client-side mod
|
||||
- [ ] Players need microphones
|
||||
- [ ] Players need to configure voice settings
|
||||
|
||||
### Decision Requirements
|
||||
- [ ] Confirm with players they want in-game voice
|
||||
- [ ] Determine if Discord will still be used (hybrid approach)
|
||||
- [ ] Choose voice chat settings (distance, volume limits)
|
||||
|
||||
---
|
||||
|
||||
## DEPLOYMENT PLAN
|
||||
|
||||
See `deployment-plan.md` for step-by-step installation instructions.
|
||||
|
||||
---
|
||||
|
||||
## CONFIGURATION OPTIONS
|
||||
|
||||
### Server Settings (config/voicechat/voicechat-server.toml)
|
||||
|
||||
**Key settings to configure:**
|
||||
- `port` - UDP port (default 24454, configurable)
|
||||
- `voice_distance` - Max distance to hear voices (default 48 blocks)
|
||||
- `crouch_distance_multiplier` - Whisper distance when crouching (default 0.5)
|
||||
- `codec` - Audio codec (VOIP or OPUS, recommend OPUS for quality)
|
||||
- `max_voice_distance` - Hard limit on voice distance
|
||||
- `allow_recording` - Allow players to record voice (default false)
|
||||
|
||||
**Example config:**
|
||||
```toml
|
||||
[voice]
|
||||
port = 24454
|
||||
voice_distance = 48.0
|
||||
crouch_distance_multiplier = 0.5
|
||||
max_voice_distance = 120.0
|
||||
codec = "OPUS"
|
||||
mtu_size = 1024
|
||||
keep_alive = 1000
|
||||
allow_recording = false
|
||||
```
|
||||
|
||||
### Client Settings (Players configure in-game)
|
||||
|
||||
Players can adjust:
|
||||
- Input device (microphone)
|
||||
- Output device (speakers/headphones)
|
||||
- Voice activation threshold
|
||||
- Push-to-talk keybind (default V)
|
||||
- Output volume
|
||||
- Microphone amplification
|
||||
|
||||
---
|
||||
|
||||
## FIREWALL REQUIREMENTS
|
||||
|
||||
**NC1 Charlotte firewall:**
|
||||
- **Port:** 24454 (UDP, configurable)
|
||||
- **Direction:** Inbound
|
||||
- **Source:** Any (players connecting)
|
||||
- **Destination:** NC1 IP
|
||||
|
||||
**UFW command:**
|
||||
```bash
|
||||
sudo ufw allow 24454/udp comment 'Simple Voice Chat - Mayview'
|
||||
```
|
||||
|
||||
**Verification:**
|
||||
```bash
|
||||
sudo ufw status | grep 24454
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ROLLBACK PLAN
|
||||
|
||||
**If issues occur:**
|
||||
|
||||
1. **Stop the server** (Pterodactyl panel)
|
||||
2. **Remove mod files:**
|
||||
```bash
|
||||
rm /path/to/server/mods/voicechat-*.jar
|
||||
rm -rf /path/to/server/config/voicechat/
|
||||
```
|
||||
3. **Close firewall port:**
|
||||
```bash
|
||||
sudo ufw delete allow 24454/udp
|
||||
```
|
||||
4. **Restart server**
|
||||
|
||||
**Time to rollback:** 5 minutes
|
||||
|
||||
**Data loss:** None (voice chat is realtime, no persistent data)
|
||||
|
||||
---
|
||||
|
||||
## TESTING PLAN
|
||||
|
||||
### Phase 1: Server Installation (15 minutes)
|
||||
1. Install mod on server
|
||||
2. Configure settings
|
||||
3. Open firewall port
|
||||
4. Start server
|
||||
5. Verify no errors in logs
|
||||
|
||||
### Phase 2: Single Client Test (15 minutes)
|
||||
1. Install mod on test client
|
||||
2. Connect to Mayview
|
||||
3. Verify voice settings menu appears
|
||||
4. Test microphone detection
|
||||
5. Verify no connection errors
|
||||
|
||||
### Phase 3: Multi-Client Test (30 minutes)
|
||||
1. Get 2-3 players with mod installed
|
||||
2. Test proximity chat (walking toward/away)
|
||||
3. Test whisper mode (crouching)
|
||||
4. Test group chat system
|
||||
5. Test volume controls
|
||||
6. Verify performance (lag check)
|
||||
|
||||
### Success Criteria
|
||||
- ✅ Server starts with no errors
|
||||
- ✅ Players can connect normally
|
||||
- ✅ Voice chat menu accessible in-game
|
||||
- ✅ Proximity detection works (volume changes with distance)
|
||||
- ✅ Audio quality acceptable
|
||||
- ✅ No performance degradation
|
||||
- ✅ Push-to-talk works reliably
|
||||
|
||||
---
|
||||
|
||||
## PLAYER COMMUNICATION
|
||||
|
||||
### Pre-Installation Notice
|
||||
|
||||
**Discord announcement template:**
|
||||
|
||||
```
|
||||
📢 New Feature Coming to Mayview: In-Game Voice Chat!
|
||||
|
||||
We're adding Simple Voice Chat to enhance your Cobblemon experience.
|
||||
|
||||
**What is it?**
|
||||
Proximity-based voice chat - you'll hear players based on distance in-game!
|
||||
|
||||
**Why add it?**
|
||||
- More immersive than Discord
|
||||
- Know WHERE voices come from
|
||||
- Whisper mode for sneaky trades
|
||||
- Optional - Discord still available
|
||||
|
||||
**What you need:**
|
||||
- Download the mod (link below)
|
||||
- Install in your mods folder
|
||||
- Restart Minecraft
|
||||
- Configure your mic in-game (Settings → Voice Chat)
|
||||
|
||||
**Installation Guide:** [Link to guide]
|
||||
**Mod Download:** [CurseForge/Modrinth link]
|
||||
|
||||
**Testing Date:** [TBD]
|
||||
Questions? Ask in #support!
|
||||
```
|
||||
|
||||
### Post-Installation Guide
|
||||
|
||||
**Create player guide covering:**
|
||||
- Where to download the mod
|
||||
- How to install (copy to mods folder)
|
||||
- How to configure microphone
|
||||
- Keybinds (V for push-to-talk)
|
||||
- Volume adjustment
|
||||
- Troubleshooting common issues
|
||||
|
||||
---
|
||||
|
||||
## KNOWN ISSUES & SOLUTIONS
|
||||
|
||||
### Issue: "Voice chat not connected"
|
||||
**Cause:** Firewall blocking UDP port
|
||||
**Solution:** Verify port 24454 open, check player's router/firewall
|
||||
|
||||
### Issue: "No audio heard from other players"
|
||||
**Cause:** Output device not selected
|
||||
**Solution:** Check Settings → Voice Chat → Audio Output
|
||||
|
||||
### Issue: "Can't transmit voice"
|
||||
**Cause:** Microphone permissions or input device
|
||||
**Solution:** Check Settings → Voice Chat → Audio Input, verify mic permissions
|
||||
|
||||
### Issue: "Choppy/laggy audio"
|
||||
**Cause:** High latency or packet loss
|
||||
**Solution:** Reduce voice distance, check player's connection, consider codec change
|
||||
|
||||
### Issue: "Mod won't load"
|
||||
**Cause:** Version mismatch (Forge vs NeoForge)
|
||||
**Solution:** Download correct NeoForge version, verify compatibility
|
||||
|
||||
---
|
||||
|
||||
## MAINTENANCE
|
||||
|
||||
**Ongoing:**
|
||||
- Monitor server logs for voice chat errors
|
||||
- Update mod when new versions release
|
||||
- Gather player feedback on audio quality
|
||||
- Adjust settings based on player count/feedback
|
||||
|
||||
**Monthly:**
|
||||
- Check for Simple Voice Chat updates
|
||||
- Verify firewall rule still active
|
||||
- Review player feedback
|
||||
|
||||
**Quarterly:**
|
||||
- Evaluate usage (are players using it?)
|
||||
- Consider removing if unused
|
||||
- Update player guide if needed
|
||||
|
||||
---
|
||||
|
||||
## SUCCESS METRICS
|
||||
|
||||
**Adoption:**
|
||||
- What % of active players install the mod?
|
||||
- How many players use it regularly?
|
||||
|
||||
**Experience:**
|
||||
- Player feedback (survey or Discord poll)
|
||||
- Audio quality acceptable?
|
||||
- Performance impact noticed?
|
||||
|
||||
**Technical:**
|
||||
- Server stability maintained?
|
||||
- Logs show errors?
|
||||
- Firewall rule working?
|
||||
|
||||
**Decision point (1 month after install):**
|
||||
- If <30% adoption → Consider removing
|
||||
- If >50% adoption and positive feedback → Keep and promote
|
||||
- If technical issues → Troubleshoot or rollback
|
||||
|
||||
---
|
||||
|
||||
## ALTERNATIVE OPTIONS
|
||||
|
||||
**If Simple Voice Chat doesn't work:**
|
||||
|
||||
### Option 1: Plasmo Voice
|
||||
- Similar features
|
||||
- Less popular but comparable
|
||||
- Try if Simple Voice Chat has issues
|
||||
|
||||
### Option 2: Discord + Voice Channels
|
||||
- No mod required
|
||||
- Proximity plugin available (bot-based)
|
||||
- Less immersive but zero setup for players
|
||||
|
||||
### Option 3: No in-game voice
|
||||
- Keep Discord as primary
|
||||
- Players already familiar
|
||||
- No additional setup
|
||||
|
||||
---
|
||||
|
||||
## COST
|
||||
|
||||
**Financial:** $0 (free mod)
|
||||
**Time:** 1-2 hours setup + testing
|
||||
**Player time:** 10 minutes per player (mod install)
|
||||
|
||||
---
|
||||
|
||||
## DEPENDENCIES
|
||||
|
||||
**Blocks:** None
|
||||
**Blocked by:** None
|
||||
**Related tasks:** Mayview mod compatibility analysis (completed)
|
||||
|
||||
---
|
||||
|
||||
## NOTES
|
||||
|
||||
- Test with small group first (2-3 players)
|
||||
- Get feedback before announcing to all players
|
||||
- Consider making optional (don't force installation)
|
||||
- Keep Discord available as fallback
|
||||
- Monitor first week closely for issues
|
||||
|
||||
**Player comfort matters:** Some players prefer Discord, don't force the change.
|
||||
|
||||
---
|
||||
|
||||
## REFERENCES
|
||||
|
||||
**Mod pages:**
|
||||
- CurseForge: [Search "Simple Voice Chat NeoForge 1.21.1"]
|
||||
- Modrinth: [Search "Simple Voice Chat NeoForge 1.21.1"]
|
||||
- GitHub: henkelmax/simple-voice-chat
|
||||
|
||||
**Documentation:**
|
||||
- Official wiki: [Check mod page for docs link]
|
||||
- Configuration guide: [In mod files after download]
|
||||
|
||||
---
|
||||
|
||||
## STATUS LOG
|
||||
|
||||
**2026-02-22:** Task created, research phase complete
|
||||
|
||||
---
|
||||
|
||||
**Fire + Frost + Foundation = Where Love Builds Legacy** 💙🔥❄️
|
||||
|
||||
---
|
||||
|
||||
**Created:** February 22, 2026
|
||||
**By:** Chronicler #22
|
||||
**Status:** Ready for deployment when approved
|
||||
768
docs/tasks/simple-voice-chat-mayview/deployment-plan.md
Normal file
768
docs/tasks/simple-voice-chat-mayview/deployment-plan.md
Normal file
@@ -0,0 +1,768 @@
|
||||
# Simple Voice Chat - Deployment Plan
|
||||
|
||||
**Task:** #34 - Simple Voice Chat Setup for Mayview
|
||||
**Server:** Mayview (NC1 Charlotte)
|
||||
**Estimated Time:** 1-2 hours
|
||||
**Created:** February 22, 2026
|
||||
|
||||
---
|
||||
|
||||
## PHASE 0: PREPARATION (15 minutes)
|
||||
|
||||
### Step 1: Verify Mayview Details
|
||||
|
||||
**SSH to NC1:**
|
||||
```bash
|
||||
ssh root@216.239.104.130
|
||||
```
|
||||
|
||||
**Verify Mayview is running and get details:**
|
||||
```bash
|
||||
# Use Pterodactyl panel to check:
|
||||
# - Minecraft version
|
||||
# - NeoForge version
|
||||
# - Current mod count
|
||||
# - Server performance
|
||||
```
|
||||
|
||||
**Confirm:**
|
||||
- [ ] Mayview is 1.21.1
|
||||
- [ ] NeoForge version confirmed
|
||||
- [ ] Server is stable
|
||||
- [ ] No recent crashes
|
||||
|
||||
---
|
||||
|
||||
### Step 2: Research Compatible Version
|
||||
|
||||
**Find Simple Voice Chat version for NeoForge 1.21.1:**
|
||||
|
||||
**CurseForge search:**
|
||||
1. Go to https://www.curseforge.com/minecraft/mc-mods/simple-voice-chat
|
||||
2. Click "Files" tab
|
||||
3. Filter: Game Version = 1.21.1, Mod Loader = NeoForge
|
||||
4. Download latest stable version
|
||||
|
||||
**Modrinth search (alternative):**
|
||||
1. Go to https://modrinth.com/plugin/simple-voice-chat
|
||||
2. Click "Versions" tab
|
||||
3. Filter: Game Version = 1.21.1, Mod Loader = NeoForge
|
||||
4. Download latest version
|
||||
|
||||
**Verify dependencies:**
|
||||
- Check mod page for required dependencies
|
||||
- Most likely: None (standalone mod)
|
||||
|
||||
**Record version details:**
|
||||
```
|
||||
Mod: Simple Voice Chat
|
||||
Version: [X.X.X]
|
||||
Minecraft: 1.21.1
|
||||
Loader: NeoForge [version]
|
||||
File: voicechat-neoforge-[version].jar
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Step 3: Backup Mayview
|
||||
|
||||
**Create backup before making changes:**
|
||||
|
||||
**Via Pterodactyl panel:**
|
||||
1. Navigate to Mayview server
|
||||
2. Go to "Backups" tab
|
||||
3. Click "Create Backup"
|
||||
4. Name: `pre-voicechat-[date]`
|
||||
5. Wait for completion
|
||||
|
||||
**Verify backup:**
|
||||
- [ ] Backup created successfully
|
||||
- [ ] Backup size reasonable (check against previous backups)
|
||||
- [ ] Backup downloadable (test download if paranoid)
|
||||
|
||||
---
|
||||
|
||||
## PHASE 1: SERVER INSTALLATION (20 minutes)
|
||||
|
||||
### Step 4: Upload Mod to Server
|
||||
|
||||
**Method 1: Via Pterodactyl File Manager**
|
||||
1. Navigate to Mayview server in Pterodactyl
|
||||
2. Go to "Files" tab
|
||||
3. Navigate to `/mods/` directory
|
||||
4. Click "Upload" button
|
||||
5. Select downloaded voicechat-neoforge-[version].jar
|
||||
6. Wait for upload to complete
|
||||
|
||||
**Method 2: Via SFTP (if Pterodactyl upload fails)**
|
||||
```bash
|
||||
# Use FileZilla or similar SFTP client
|
||||
# Host: 216.239.104.130
|
||||
# Port: 2022 (or Pterodactyl SFTP port)
|
||||
# Upload to: /mods/
|
||||
```
|
||||
|
||||
**Verify upload:**
|
||||
```bash
|
||||
# Via Pterodactyl file manager, verify file exists:
|
||||
# /mods/voicechat-neoforge-[version].jar
|
||||
```
|
||||
|
||||
- [ ] Mod file uploaded
|
||||
- [ ] File size matches download (verify not corrupted)
|
||||
|
||||
---
|
||||
|
||||
### Step 5: Configure Voice Chat Settings
|
||||
|
||||
**Access server files via Pterodactyl:**
|
||||
1. Go to "Files" tab
|
||||
2. Navigate to `/config/voicechat/`
|
||||
- If directory doesn't exist: It will be created on first server start
|
||||
- Proceed to Step 6, then return here after first start
|
||||
|
||||
**If config exists, edit voicechat-server.toml:**
|
||||
|
||||
**Via Pterodactyl editor:**
|
||||
```toml
|
||||
[voice]
|
||||
# UDP port for voice chat (must be opened in firewall)
|
||||
port = 24454
|
||||
|
||||
# Maximum voice distance in blocks
|
||||
voice_distance = 48.0
|
||||
|
||||
# Distance multiplier when crouching (whisper mode)
|
||||
crouch_distance_multiplier = 0.5
|
||||
|
||||
# Maximum allowed voice distance (prevents abuse)
|
||||
max_voice_distance = 120.0
|
||||
|
||||
# Audio codec (OPUS recommended for quality, VOIP for performance)
|
||||
codec = "OPUS"
|
||||
|
||||
# MTU size (usually don't change)
|
||||
mtu_size = 1024
|
||||
|
||||
# Keep alive interval in ms
|
||||
keep_alive = 1000
|
||||
|
||||
# Allow players to record voice (privacy concern - recommend false)
|
||||
allow_recording = false
|
||||
|
||||
# Voice chat enabled (true to enable)
|
||||
enabled = true
|
||||
```
|
||||
|
||||
**Save the file.**
|
||||
|
||||
**Recommended settings for Mayview:**
|
||||
- Port: 24454 (default, unless conflicts exist)
|
||||
- Voice distance: 48 blocks (good balance)
|
||||
- Codec: OPUS (better quality)
|
||||
- Recording: false (privacy protection)
|
||||
|
||||
- [ ] Configuration file edited
|
||||
- [ ] Settings match recommendations (or custom choices documented)
|
||||
|
||||
---
|
||||
|
||||
### Step 6: Open Firewall Port on NC1
|
||||
|
||||
**SSH to NC1:**
|
||||
```bash
|
||||
ssh root@216.239.104.130
|
||||
```
|
||||
|
||||
**Add UFW rule for voice chat:**
|
||||
```bash
|
||||
sudo ufw allow 24454/udp comment 'Simple Voice Chat - Mayview'
|
||||
```
|
||||
|
||||
**Verify rule added:**
|
||||
```bash
|
||||
sudo ufw status | grep 24454
|
||||
```
|
||||
|
||||
**Expected output:**
|
||||
```
|
||||
24454/udp ALLOW Anywhere # Simple Voice Chat - Mayview
|
||||
```
|
||||
|
||||
**Test port is open (from external machine):**
|
||||
```bash
|
||||
# From your local machine (not NC1):
|
||||
nc -zvu 216.239.104.130 24454
|
||||
# Should show connection attempt (may timeout, but proves port reachable)
|
||||
```
|
||||
|
||||
- [ ] UFW rule added
|
||||
- [ ] Rule appears in ufw status
|
||||
- [ ] Port externally reachable (optional test)
|
||||
|
||||
---
|
||||
|
||||
### Step 7: Start Mayview Server
|
||||
|
||||
**Via Pterodactyl panel:**
|
||||
1. Navigate to Mayview server
|
||||
2. Click "Console" tab
|
||||
3. Click "Start" button
|
||||
4. Watch console for errors
|
||||
|
||||
**Monitor startup:**
|
||||
```
|
||||
Watch for:
|
||||
✅ "Simple Voice Chat" initialization messages
|
||||
✅ "Voice chat server started on port 24454"
|
||||
✅ Server reaches "Done" state
|
||||
❌ Any error messages containing "voicechat"
|
||||
❌ Crashes or failures to start
|
||||
```
|
||||
|
||||
**Check logs specifically for voice chat:**
|
||||
```
|
||||
# In Pterodactyl console, search for:
|
||||
"voicechat"
|
||||
"Simple Voice Chat"
|
||||
"Voice chat server"
|
||||
```
|
||||
|
||||
**If server fails to start:**
|
||||
1. Check console for specific error
|
||||
2. Verify mod file not corrupted (re-download if needed)
|
||||
3. Check for dependency errors
|
||||
4. See troubleshooting section
|
||||
|
||||
- [ ] Server started successfully
|
||||
- [ ] Voice chat initialized
|
||||
- [ ] No errors in console
|
||||
- [ ] Server fully loaded
|
||||
|
||||
---
|
||||
|
||||
### Step 8: Verify Configuration Generated
|
||||
|
||||
**After first start, config should be created:**
|
||||
|
||||
**Via Pterodactyl file manager:**
|
||||
1. Navigate to `/config/voicechat/`
|
||||
2. Verify files exist:
|
||||
- `voicechat-server.toml` (server config)
|
||||
- Other config files may be present
|
||||
|
||||
**If config wasn't manually edited in Step 5:**
|
||||
- Edit now using recommended settings
|
||||
- Restart server after editing
|
||||
|
||||
- [ ] Config directory exists
|
||||
- [ ] Config files generated
|
||||
- [ ] Settings verified/updated
|
||||
|
||||
---
|
||||
|
||||
## PHASE 2: CLIENT TESTING (30 minutes)
|
||||
|
||||
### Step 9: Install Client Mod (Test Client)
|
||||
|
||||
**On your test Minecraft client:**
|
||||
|
||||
1. **Download same version as server:**
|
||||
- Use same file: voicechat-neoforge-[version].jar
|
||||
- Or download from CurseForge/Modrinth (client version)
|
||||
|
||||
2. **Install mod:**
|
||||
```
|
||||
# Copy jar file to:
|
||||
%appdata%\.minecraft\mods\ (Windows)
|
||||
~/Library/Application Support/minecraft/mods/ (Mac)
|
||||
~/.minecraft/mods/ (Linux)
|
||||
```
|
||||
|
||||
3. **Start Minecraft:**
|
||||
- Launch Minecraft with NeoForge 1.21.1 profile
|
||||
- Verify mod loads (check Mods menu)
|
||||
|
||||
4. **Verify mod appears:**
|
||||
- Main menu → Mods
|
||||
- Search for "Simple Voice Chat"
|
||||
- Should appear in list
|
||||
|
||||
- [ ] Client mod installed
|
||||
- [ ] Minecraft starts successfully
|
||||
- [ ] Mod appears in mod list
|
||||
|
||||
---
|
||||
|
||||
### Step 10: Configure Client Settings
|
||||
|
||||
**Connect to Mayview:**
|
||||
```
|
||||
Server: 216.239.104.130 (or Mayview's address)
|
||||
```
|
||||
|
||||
**Access voice chat settings:**
|
||||
- Press ESC (in-game)
|
||||
- Click "Options"
|
||||
- Click "Voice Chat Settings" (new button)
|
||||
|
||||
**Configure audio:**
|
||||
|
||||
**Input (Microphone):**
|
||||
- Select your microphone
|
||||
- Adjust activation threshold (test by speaking)
|
||||
- Choose push-to-talk or voice activation
|
||||
- Set push-to-talk key (default: V)
|
||||
|
||||
**Output (Speakers/Headphones):**
|
||||
- Select output device
|
||||
- Adjust voice chat volume
|
||||
- Test with another player if available
|
||||
|
||||
**Other settings:**
|
||||
- Enable voice chat: ON
|
||||
- Noise suppression: Recommended
|
||||
- Microphone amplification: Adjust as needed
|
||||
|
||||
- [ ] Voice chat settings accessible
|
||||
- [ ] Microphone detected
|
||||
- [ ] Output device selected
|
||||
- [ ] Push-to-talk key set
|
||||
|
||||
---
|
||||
|
||||
### Step 11: Single Player Test
|
||||
|
||||
**Test alone first:**
|
||||
|
||||
**Verify connection:**
|
||||
- Join Mayview server
|
||||
- Press TAB to see player list
|
||||
- Look for voice chat icon next to your name
|
||||
- Should show microphone status
|
||||
|
||||
**Test microphone:**
|
||||
- Hold push-to-talk key (V)
|
||||
- Speak into microphone
|
||||
- Should see voice indicator (visual feedback)
|
||||
|
||||
**Test in-game menu:**
|
||||
- Access voice chat menu (check mod docs for keybind)
|
||||
- Verify settings save
|
||||
- Adjust volume if needed
|
||||
|
||||
**Check console for errors:**
|
||||
```
|
||||
# In Minecraft console (F3+D to open)
|
||||
# Look for voice chat connection messages
|
||||
# Should show "Connected to voice chat server"
|
||||
```
|
||||
|
||||
- [ ] Connected to voice chat server
|
||||
- [ ] Microphone activates on push-to-talk
|
||||
- [ ] Visual feedback visible
|
||||
- [ ] No connection errors
|
||||
|
||||
---
|
||||
|
||||
### Step 12: Multi-Player Proximity Test
|
||||
|
||||
**Get 2-3 test players:**
|
||||
- Other staff members
|
||||
- Willing players from Discord
|
||||
- Alt accounts if available
|
||||
|
||||
**Test proximity mechanics:**
|
||||
|
||||
**Test 1: Distance detection**
|
||||
1. Start near each other (within 10 blocks)
|
||||
2. One player speaks (push-to-talk)
|
||||
3. Others verify they hear clearly
|
||||
4. Walk away slowly while speaking
|
||||
5. Verify volume decreases with distance
|
||||
6. At 48 blocks, voice should be very quiet/silent
|
||||
|
||||
**Test 2: Whisper mode (crouch)**
|
||||
1. Stand 20 blocks apart
|
||||
2. Speaker crouches and speaks
|
||||
3. Verify whisper is quieter than normal
|
||||
4. Test that whisper distance is reduced
|
||||
|
||||
**Test 3: Multiple speakers**
|
||||
1. Have 2+ people speak simultaneously
|
||||
2. Verify audio doesn't clip/distort
|
||||
3. Check that multiple voices are audible
|
||||
|
||||
**Test 4: Volume controls**
|
||||
1. Each player adjusts output volume
|
||||
2. Verify independent control works
|
||||
3. Test mute function
|
||||
|
||||
**Test 5: Performance check**
|
||||
1. Monitor FPS while voice chatting
|
||||
2. Check for lag or stuttering
|
||||
3. Verify server TPS remains stable (check Pterodactyl)
|
||||
|
||||
- [ ] Proximity detection works (volume changes with distance)
|
||||
- [ ] Whisper mode functions correctly
|
||||
- [ ] Multiple simultaneous voices work
|
||||
- [ ] Volume controls effective
|
||||
- [ ] No performance degradation
|
||||
|
||||
---
|
||||
|
||||
## PHASE 3: PLAYER ROLLOUT (Ongoing)
|
||||
|
||||
### Step 13: Create Player Installation Guide
|
||||
|
||||
**Write guide covering:**
|
||||
|
||||
```markdown
|
||||
# How to Install Simple Voice Chat for Mayview
|
||||
|
||||
## Download the Mod
|
||||
|
||||
1. Download from: [CurseForge link]
|
||||
OR
|
||||
Download from: [Modrinth link]
|
||||
|
||||
2. Make sure you download the **NeoForge 1.21.1** version!
|
||||
|
||||
## Install the Mod
|
||||
|
||||
1. Locate your Minecraft mods folder:
|
||||
- Windows: Press Win+R, type %appdata%\.minecraft\mods
|
||||
- Mac: ~/Library/Application Support/minecraft/mods
|
||||
- Linux: ~/.minecraft/mods
|
||||
|
||||
2. Copy the downloaded .jar file into the mods folder
|
||||
|
||||
3. Restart Minecraft
|
||||
|
||||
## Configure Voice Chat
|
||||
|
||||
1. Launch Minecraft with your Mayview profile
|
||||
2. Connect to Mayview server
|
||||
3. Press ESC → Options → Voice Chat Settings
|
||||
4. Select your microphone (Input Device)
|
||||
5. Select your speakers/headphones (Output Device)
|
||||
6. Set Push-to-Talk key (default: V)
|
||||
7. Test your microphone by speaking
|
||||
|
||||
## Using Voice Chat
|
||||
|
||||
- **Talk:** Hold V (or your chosen key)
|
||||
- **Whisper:** Crouch while talking (quieter, shorter range)
|
||||
- **Mute:** [Check in-game menu for mute keybind]
|
||||
- **Adjust Volume:** Voice Chat Settings → Output Volume
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**"Voice chat not connected"**
|
||||
- Check that Simple Voice Chat mod is installed
|
||||
- Verify you're on Mayview server
|
||||
- Try restarting Minecraft
|
||||
|
||||
**"Can't hear anyone"**
|
||||
- Check Output Device in settings
|
||||
- Increase Output Volume
|
||||
- Ask others to speak (push-to-talk)
|
||||
|
||||
**"Others can't hear me"**
|
||||
- Check Input Device (microphone) selected
|
||||
- Hold push-to-talk key while speaking
|
||||
- Adjust microphone amplification
|
||||
|
||||
**Need help?** Ask in Discord #support!
|
||||
```
|
||||
|
||||
**Save guide to:**
|
||||
- Discord (pinned message in #mayview channel)
|
||||
- Firefrost wiki (if available)
|
||||
- Pastebin/Google Doc (shareable link)
|
||||
|
||||
- [ ] Player guide written
|
||||
- [ ] Guide reviewed for clarity
|
||||
- [ ] Guide posted in accessible location
|
||||
|
||||
---
|
||||
|
||||
### Step 14: Announce to Players
|
||||
|
||||
**Discord announcement:**
|
||||
|
||||
See README.md for announcement template.
|
||||
|
||||
**Post in:**
|
||||
- #announcements
|
||||
- #mayview
|
||||
- @Mayview role mention
|
||||
|
||||
**Include:**
|
||||
- What it is
|
||||
- Why it's cool
|
||||
- How to install (link to guide)
|
||||
- Testing date/time
|
||||
- Optional (don't force)
|
||||
|
||||
- [ ] Announcement posted
|
||||
- [ ] Installation guide linked
|
||||
- [ ] Questions answered
|
||||
|
||||
---
|
||||
|
||||
### Step 15: Scheduled Testing Session
|
||||
|
||||
**Plan group testing event:**
|
||||
|
||||
**Announce:**
|
||||
```
|
||||
🎙️ Voice Chat Testing Event!
|
||||
|
||||
Date: [TBD]
|
||||
Time: [TBD]
|
||||
Location: Mayview server
|
||||
|
||||
Come test the new proximity voice chat!
|
||||
- Cobblemon hunts with voice coordination
|
||||
- Hide and seek with whisper mode
|
||||
- Just hang out and chat naturally
|
||||
|
||||
Bring your microphone!
|
||||
Install guide: [link]
|
||||
```
|
||||
|
||||
**During testing:**
|
||||
- Be online to troubleshoot
|
||||
- Gather feedback
|
||||
- Note any issues
|
||||
- Adjust settings if needed
|
||||
|
||||
- [ ] Testing event scheduled
|
||||
- [ ] Event announced
|
||||
- [ ] Participated in testing
|
||||
- [ ] Feedback collected
|
||||
|
||||
---
|
||||
|
||||
## PHASE 4: MONITORING & OPTIMIZATION (Ongoing)
|
||||
|
||||
### Step 16: Monitor First Week
|
||||
|
||||
**Check daily:**
|
||||
- Server logs for voice chat errors
|
||||
- Player feedback in Discord
|
||||
- Server performance (TPS)
|
||||
- Any crashes related to voice chat
|
||||
|
||||
**Gather feedback:**
|
||||
- Ask players about audio quality
|
||||
- Check if they're using it
|
||||
- Note any complaints or issues
|
||||
|
||||
**Common adjustments:**
|
||||
- Voice distance (too far/too short?)
|
||||
- Codec (quality vs performance)
|
||||
- Volume limits (too loud/quiet?)
|
||||
|
||||
- [ ] Daily log checks complete
|
||||
- [ ] Player feedback positive
|
||||
- [ ] No major issues
|
||||
- [ ] Settings optimized
|
||||
|
||||
---
|
||||
|
||||
### Step 17: One-Month Review
|
||||
|
||||
**After 30 days, evaluate:**
|
||||
|
||||
**Adoption rate:**
|
||||
- How many players installed?
|
||||
- How many actively use it?
|
||||
- Do players prefer it over Discord?
|
||||
|
||||
**Technical performance:**
|
||||
- Any crashes or errors?
|
||||
- Server performance impact?
|
||||
- Audio quality acceptable?
|
||||
|
||||
**Player sentiment:**
|
||||
- Positive feedback?
|
||||
- Complaints or requests?
|
||||
- Worth keeping?
|
||||
|
||||
**Decision:**
|
||||
- **Keep:** >50% adoption, positive feedback, no issues
|
||||
- **Modify:** Issues but fixable (adjust settings)
|
||||
- **Remove:** <30% adoption or major problems
|
||||
|
||||
- [ ] Metrics gathered
|
||||
- [ ] Feedback reviewed
|
||||
- [ ] Decision made
|
||||
- [ ] Action taken (keep/modify/remove)
|
||||
|
||||
---
|
||||
|
||||
## ROLLBACK PROCEDURE
|
||||
|
||||
**If you need to remove Simple Voice Chat:**
|
||||
|
||||
### Step 1: Stop Mayview
|
||||
```
|
||||
# Via Pterodactyl panel: Stop server
|
||||
```
|
||||
|
||||
### Step 2: Remove Mod Files
|
||||
```
|
||||
# Via Pterodactyl file manager:
|
||||
# Delete: /mods/voicechat-neoforge-[version].jar
|
||||
# Delete: /config/voicechat/ (entire directory)
|
||||
```
|
||||
|
||||
### Step 3: Close Firewall Port
|
||||
```bash
|
||||
ssh root@216.239.104.130
|
||||
sudo ufw delete allow 24454/udp
|
||||
sudo ufw status # Verify removed
|
||||
```
|
||||
|
||||
### Step 4: Restart Server
|
||||
```
|
||||
# Via Pterodactyl panel: Start server
|
||||
```
|
||||
|
||||
### Step 5: Notify Players
|
||||
```
|
||||
Discord announcement:
|
||||
"We've removed Simple Voice Chat from Mayview due to [reason].
|
||||
Players can remove the mod from their mods folder.
|
||||
We're sticking with Discord for voice communication."
|
||||
```
|
||||
|
||||
**Rollback time:** 10 minutes
|
||||
**Data loss:** None (voice chat is realtime only)
|
||||
|
||||
---
|
||||
|
||||
## TROUBLESHOOTING
|
||||
|
||||
### Server won't start after mod install
|
||||
|
||||
**Check:**
|
||||
- Mod version matches server version (1.21.1 NeoForge)
|
||||
- File not corrupted (re-download)
|
||||
- No conflicting mods (check crash log)
|
||||
|
||||
**Solution:**
|
||||
```
|
||||
1. Remove mod temporarily
|
||||
2. Start server (verify works without mod)
|
||||
3. Re-download mod from official source
|
||||
4. Install again
|
||||
5. Check console for specific error
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### "Voice chat server failed to start"
|
||||
|
||||
**Check:**
|
||||
- Port 24454 not already in use
|
||||
- Firewall allows UDP 24454
|
||||
- Config file syntax correct
|
||||
|
||||
**Solution:**
|
||||
```bash
|
||||
# Check if port in use:
|
||||
sudo netstat -tulpn | grep 24454
|
||||
|
||||
# Try different port in config:
|
||||
port = 24455 # In voicechat-server.toml
|
||||
|
||||
# Update firewall:
|
||||
sudo ufw allow 24455/udp
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Players can't connect to voice chat
|
||||
|
||||
**Check:**
|
||||
- Client mod installed and same version as server
|
||||
- Firewall not blocking on player's end
|
||||
- Voice chat enabled in client settings
|
||||
|
||||
**Solution:**
|
||||
```
|
||||
1. Verify client mod version matches server
|
||||
2. Check client firewall/antivirus
|
||||
3. Have player restart Minecraft
|
||||
4. Test with different player (isolate issue)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Audio quality poor/choppy
|
||||
|
||||
**Check:**
|
||||
- Player's internet connection
|
||||
- Server TPS (performance issue?)
|
||||
- Codec setting (try VOIP instead of OPUS)
|
||||
|
||||
**Solution:**
|
||||
```toml
|
||||
# In voicechat-server.toml:
|
||||
codec = "VOIP" # Lower quality, better performance
|
||||
|
||||
# Or reduce voice distance:
|
||||
voice_distance = 32.0 # Reduce from 48
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## SUCCESS CRITERIA
|
||||
|
||||
**Phase 1 (Server Installation):**
|
||||
- ✅ Server starts with voice chat mod
|
||||
- ✅ No errors in console
|
||||
- ✅ Firewall port open
|
||||
- ✅ Config generated/verified
|
||||
|
||||
**Phase 2 (Client Testing):**
|
||||
- ✅ Client mod installs successfully
|
||||
- ✅ Connection to voice server works
|
||||
- ✅ Proximity detection functions
|
||||
- ✅ Audio quality acceptable
|
||||
- ✅ No performance impact
|
||||
|
||||
**Phase 3 (Player Rollout):**
|
||||
- ✅ Installation guide clear
|
||||
- ✅ Players can install without help
|
||||
- ✅ >3 players test successfully
|
||||
- ✅ Positive feedback
|
||||
|
||||
**Phase 4 (Long-term):**
|
||||
- ✅ >50% adoption rate
|
||||
- ✅ Stable performance
|
||||
- ✅ Players prefer it or use alongside Discord
|
||||
- ✅ No major issues
|
||||
|
||||
---
|
||||
|
||||
## DOCUMENTATION UPDATES
|
||||
|
||||
**After completion, update:**
|
||||
- [ ] tasks.md (mark task complete)
|
||||
- [ ] infrastructure-manifest.md (if voice chat is significant addition)
|
||||
- [ ] Mayview server documentation
|
||||
- [ ] Player handbook/wiki
|
||||
|
||||
---
|
||||
|
||||
**Fire + Frost + Foundation = Where Love Builds Legacy** 💙🔥❄️
|
||||
|
||||
---
|
||||
|
||||
**Created:** February 22, 2026
|
||||
**By:** Chronicler #22
|
||||
**Status:** Ready for execution when approved
|
||||
Reference in New Issue
Block a user