Installation

Installation Guide

This guide will help you install RPVoiceChat on your Vintage Story client and server.

System Requirements

Minimum Requirements

• Vintage Story: Version 1.21.5 or higher
• Operating System: Windows 10+, macOS 10.15+, or Linux (Ubuntu 18.04+)
• RAM: 4GB minimum (8GB recommended)
• Microphone: Any USB or built-in microphone
• Network: Stable internet connection for multiplayer

Recommended Requirements

• RAM: 8GB or more
• CPU: Multi-core processor (voice processing is CPU-intensive)
• Audio: Dedicated sound card or high-quality integrated audio
• Network: Low-latency connection (<100ms ping)

Client Installation

Step 1: Download the Mod

1. Visit the RPVoiceChat mod page

2. Choose your download method:

   Option A: One-Click Install (Recommended)

   • Click the "1-Click Install" button
   • This will automatically launch Vintage Story and install the mod
   • The mod will be ready to use immediately
   • Note: Requires Vintage Story to be installed and running

   Option B: Manual Download

   • Click the "Download" button to get the latest version
   • Save the .zip file to your computer
   • Proceed to Step 2 for manual installation

3. If you chose Option B, continue with the manual installation steps below.

Step 2: Install the Mod (manually)

1. Locate your Vintage Story Mods folder:

   • Windows: %APPDATA%\VintagestoryData\Mods\
   • macOS: ~/Library/Application Support/VintagestoryData/Mods/
   • Linux: ~/.config/VintagestoryData/Mods/

2. Install the mod:

   • Simply copy the downloaded .zip file directly into your Mods folder
   • Vintage Story will automatically extract and load the mod
   • No need to extract the zip file manually

3. Verify installation:

   • Start Vintage Story
   • Check the mod list in the main menu
   • RPVoiceChat should appear in the list

Step 3: Configure Audio Settings

1. Launch the game and join a world

2. First-time setup with Audio Wizard:

   • On first launch, RPVoiceChat will automatically show the Audio Wizard
   • This guided setup will help you configure your microphone automatically
   • Follow the wizard's instructions to test and optimize your audio settings
   • The wizard will automatically detect your microphone and set optimal levels

3. Manual configuration (if needed):

   • Press ; (default keybind) to open the config menu
   • Re-run Audio Wizard: Click the "Audio Wizard" button in the config menu to restart the guided setup

4. Manual microphone setup (alternative to wizard):

   • Select your microphone device
   • Adjust input gain and threshold
   • Test your microphone using the built-in test

5. Configure audio output:

   • Adjust voice volume levels
   • Set up push-to-talk if desired
   • Configure voice levels (whisper, normal, shout)

Server Installation

For Dedicated Servers

1. Download and install the mod on your server

2. Configure server settings:

   • Edit rpvoicechat-server.json in your server's ModConfig folder
   • Set appropriate port forwarding (default port: 52525)
   • Configure server-specific settings

3. Port Forwarding:

   • Automatic: Enable UPnP in your router (recommended)
   • Manual: Forward port 52525 to your server's IP address

For Self-Hosted Servers

1. Install RPVoiceChat on your local machine
2. The mod will automatically handle port forwarding using UPnP
3. Configure settings through the in-game menu

Post-Installation Setup

First-Time Configuration

When you first launch RPVoiceChat, you'll be guided through:

1. Audio Wizard: Automatic microphone setup and testing
2. Keybind Configuration: Set up your preferred keybinds
3. Voice Level Setup: Configure whisper, normal, and shout ranges

Default Keybinds

• Config Menu: ;
• Push-to-Talk: CAPS LOCK
• Voice Level Toggle: Shift + Tab
• Mute/Unmute: N

Note: Mouse buttons cannot be used for keybinds in current Vintage Story versions

MacOS microphone detection

Vintage Story MacOS version is not built by Anego Studios to allow microphone usage. You must edit the app.

1. Open applications in finder, right click vintagestory and show package contents.

2. Modify Info.plist in a text editor adding these lines and save (lines use tab indentation): `NSMicrophoneUsageDescription` `This app needs access to the microphone to record audio. ` 3. Relaunch Vintage Story and load RPVoiceChat ingame, MacOS will request microphone permissions. Your microphone should now work.

BEWARE: you must do this each time you install OR UPDATE your Vintage Story app.

Verification

Test Your Installation

1. Join a multiplayer server with RPVoiceChat enabled

2. Test voice chat:

   • Press your push-to-talk key or speak above threshold
   • Check if other players can hear you
   • Verify you can hear other players

3. Test voice levels:

   • Try whispering, normal speech, and shouting
   • Verify distance-based volume changes

Troubleshooting Installation Issues

If you encounter problems:

1. Check the logs:

   • Look for RPVoiceChat entries in the game logs
   • Check for error messages

2. Verify mod compatibility:

   • Ensure you have Vintage Story 1.21.5+
   • Check for conflicting mods

3. Audio device issues:

   • Verify your microphone is working in other applications
   • Check Windows/macOS/Linux audio permissions

4. Network issues:

   • Test with a different server
   • Check firewall settings
   • Verify port forwarding

Uninstallation

To remove RPVoiceChat:

1. Delete the mod folder from your Mods directory
2. Remove configuration files (optional):
   • rpvoicechat-client.json from ModConfig folder
   • rpvoicechat-server.json from ModConfig folder
3. Restart Vintage Story

Next Steps

After successful installation:

1. Read the User Guide to learn how to use voice chat effectively
2. Explore Configuration options to customize your experience
3. Check out Troubleshooting if you encounter any issues

Support

If you need help with installation:

• Check the Troubleshooting guide
• Search GitHub Issues