Skip to content

Ridderrasmus/RPVoiceChat

Repository files navigation

RPVoiceChat - A proximity voip mod for Vintage Story

Table of contents

About

RPVoiceChat is a proximity voip mod for Vintage Story. It allows players to talk to each other in-game using their microphone. The volume of the voice depends on the distance between the players.

The mod is partially inspired by TFAR for Arma 3 and Simple Voice Chat for Minecraft.

Documentation & Help
Most common questions are answered in the Wiki:
https://github.com/Ridderrasmus/RPVoiceChat/wiki

If you encounter issues, check the Troubleshooting guide:
https://github.com/Ridderrasmus/RPVoiceChat/wiki/Troubleshooting


Installation

  1. Click on the "1-click install" button or download the latest version of the mod from the mod page.
  2. If you choose the "Download" option, place the downloaded file in the Mods folder of your Vintage Story installation.
  3. Start the game and enjoy!
  4. (Optional) Double-check your keybinds in the settings menu. All keybinds start with RPVoice and are located in the HUD and Interface category.

Server Setup

  1. Start your server.
  2. Done!

For advanced setups and performance tuning, see:
https://github.com/Ridderrasmus/RPVoiceChat/wiki/Server-Administration


Usage

Talking

To talk to other players you must configure your microphone input threshold or enable push-to-talk (PTT).

  • Default config menu keybind: ;
  • Default PTT keybind: CAPS LOCK

Note: As of the current game version, keybinds cannot be assigned to mouse buttons.

Voice levels

The mod includes three voice levels:

  • Whisper
  • Normal
  • Shout

The default keybind to cycle voice levels is Shift + Tab.

More details are available in the User Guide:
https://github.com/Ridderrasmus/RPVoiceChat/wiki/User-Guide


Configuration (For users)

All user-related configuration options are documented in the wiki: https://github.com/Ridderrasmus/RPVoiceChat/wiki/User-Guide

Client configuration file location: ModConfig/rpvoicechat-client.json


Configuration (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-server.json

In-game configuration commands

World-specific /rpvc commands are documented here: https://github.com/Ridderrasmus/RPVoiceChat/wiki/Server-Administration#in-game-configuration-commands


Maintainers

Currently maintained by:

Previously maintained by:

Want to contribute? https://github.com/Ridderrasmus/RPVoiceChat/pulls


Licenses

The mod is licensed under the MIT License.

Used libraries:

Sound effects from Freesound.org:

About

Mod for Vintage Story that implements proximity VOIP

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 13

Languages