RP Voice Chat

RP Voice Chat

Shout at your enemies, talk with your friends, conspire with your allies.

This mod implements VOIP to allow people on a server together to talk using microphones in-game based on proximity.

 

BUG REPORTS OR FEATURE REQUESTS:

Please have a look at the issue tracker at the top of this page and submit them there. If a bug report has already been written about before, you don't need to write another one. It’s the same for feature requests.

Known Issues:

• Rarely, it may happen that a player is not audible or their voice gets replaced by random game sounds. A temporary fix is for the player that cannot hear the speaking player to relog.
• With high-frequency microphones, RPVC will not capture your mic. Avoid pushing it above 44,000 Hz (I’m still looking for a way to handle this better, like auto-reducing or alerting it in-game).
• Rarely, logs said a file is missing or you have old issues already resolved. Your ZIP is corrupted, you must delete it from client AN server, then re-install it.
• MacOS users : see https://github.com/Ridderrasmus/RPVoiceChat/wiki/Installation#macos-microphone-detection

Usage

To open the configuration menu, press the keybind (by default set to ";"). Make sure to check your keybinds. They’re listed under the user interface settings and have the prefix "RPVoice".

Speech Levels:

• Whispering: Reaches max 5 blocks
• Talking: Reaches max 15 blocks
• Shouting: Reaches max 25 blocks

The above distances can be set per world using chat commands. These commands require server control privileges. Type /help rpvc for more information.

Audio Threshold for Voice Activation:

There is a mod config setting that you can modify to change the max threshold. This can either be decreased slightly for more fine control or increased to catch only peaks in input. Different microphones will have different ideal settings. The standard is currently based on our testers’ setups.

For Server Owners

All server-side configuration options are documented here: https://github.com/Ridderrasmus/RPVoiceChat/wiki/Server-Administration

Server configuration file location: ModConfig/RPVoiceChat/rpvoicechat-server.json

Planned Features (“Struck through” means “finalized and available”):

• Quality of Life Improvements:
  • HUD speech indicator
  • Proximity chat configuration menu
  • Config files
  • Configurable whispering, talking, and shouting distances
  • Visual audio amplitude indicator in the configuration menu
  • Deafening (since we now have audio sliders)
  • Mute specific players client-side (thanks to the player volume list)
  • Support for Linux and Mac
  • Potential animations for speaking
  • Mono sound option
  • Minimal HUD option
  • Mute specific players server-side (server blacklist)
  • Display/hide nametag when player speaking or not (can be disabled)
  • Voice group chat (manageable by group owner and admins)
  • Mod API (not know exactly what enpoints we can create - opened to ideas)
• Audio Effects:
  • Denoiser
  • Muffling
  • Reverb
  • Effects for intoxication
  • Effects for temporal instability
• Gameplay Functions:
  • Soundproofing
  • Textual announcement system, using VTML templates
  • Bells:
    • Handbell (Item)
    • Countertop bell (Block)
    • Carillon bell (Block)
    • Large bell (Block, made from a Multiblock)
    • Bell hammer (Block, mechanical powered)
  • Horns:
    • Royal horn (Item)
    • Warhorn (Item)
  • Megaphones
    • "Classic" megaphone (Item)
    • "Admin" megaphone (Item)
  • Light-based comms devices :
    • Warning beacon (Multiblock)
    • Signal lamp (Block)
    • Portable signal lamp ? (Item, not sure if it will be done)
  • Wired comms devices:
    • Telegraph wire (Item)
    • Telegraph key (Block)
    • Telegraph printer (Block)
    • Isolator (Block)
    • Wirecutter (Item)
    • Isolated wire ? (Item, not sure if it will be done)
    • Telephone (Block)
    • Switchboard (Block, mechanical powered)
  • Wireless comms devices:
    
    • Stationary radio (Block)
    • Broadcast console (Block)
    • Radio transmitter (Block, mechanical powered)
    • Radio antenna (Multiblock)
    • Private mobile radio (Item)
• It:
  • Listens from beyond

 

Credits

Libraries used:
Concentus for opus audio encoding, RNNoise for audio denoising.

Authors:
Ridderrasmus (code), RodinPandarex (code), Purplep_ (art), Nixie (sound), Lazarius (a.ka. Dmitry221060) (code), blakdragan7 (code)

Contributors:
Tisma (testing), Alconchloe (Goblin bug hunter), YangWenLi (code: voice client/server optimizations)

Massive thanks to translators:
Azuli_Yanazake (Portuguese Brazilian translation), Kaofan (Polish translation), RodinPandarex and Vlammar (French translation), Nyuhnyash (Russian translation), Kampftroll (German translation, community mod for streamer Otz), k1llo (Belarusian translation), paipaijun (Chinese translation).