Skip to content

tydoo/saltychat-docs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Salty Chat

Salty Chat is a TeamSpeak voice plugin which adds more realism to your gamemode (like GTA 5 FiveM/RAGEMP). In order to serve a wide range of mods, the plugin provides a WebSocket server, which allows bidirectional communication. Due to the possibility of communication in both directions, the plugin can also send "State Trigger" (player speaks, microphone muted/unmuted, sound muted/unmuted and more).

We provide resources for some mods and also maintain them. Since it is impossible for us to provide a resource for every mod and every framework, we need your help. If you write resources for certain mods or frameworks that we haven't covered, you are welcome to add them to our resources list through a pull request.

You can help us to improve our docs by contributing via pull requests - we appreciate any contribution.

Join our Discord and start with Salty Chat!

Features

Proximity

  • 3D audio
  • Adjustable ranges (for e.g. whispering and screaming)
  • Distance-based flattening of the volume
  • Multiple audio streams for one player (in combination with phone and radio)
  • Voice effects (e.g. echo and megaphone)

Radio

  • Realistic voice distortion
  • Distortion based on distance
  • Different ranges
    • Ultra Short Range (1.8km)
    • Short Range (3km)
    • Long Range (8km)
  • Communication from radio to radio, or distributed via radio towers
  • Loudspeaker (players can listen to the radio traffic)
  • Customizable audio mode for playback (left, right or stereo)

Phone

  • Realistic voice distortion
  • Distortion based on signal strength
  • Loudspeaker (players can hear the conversation partners)
  • Customizable audio mode for playback (left, right or stereo)

Audio Player

  • Sounds in the respective sound pack (%appdata%\TS3Client\plugins\SaltyChat) can be played and stopped
  • Play multiple sounds at the same time (e.g. a ringtone and vibration)
  • Clean looping of sounds
  • Global overwriting of sounds (%appdata%\TS3Client\plugins\SaltyChat\override)
  • Fallback if a file is missing (override > specified sound pack > default sound pack)

Configuration file

When the plugin is starting, the configuration file under %appdata%\TS3Client\plugins\SaltyChat\settings.json will be loaded an applied. Here are various options that can be customized:

Parameter Description
WebSocketAddress Address and port on which the WebSocket server binds
UpdateBranch Update branch which is queried for a new version through our version API
OriginExceptions Exceptions for the source of a WebSocket connection - e.g. you surf on saltmine.de, locally executed JavaScript can connect to the WebSocket, whereby the source would then be https://saltmine.de
InstanceTimeout Time in seconds after which the instance will reset without a pong
Is3dEnabled Enables/disables 3D audio
IsDebugLoggingEnabled Enables/disables simple debug logging - should only be switched on when needed
IsExtensiveLoggingEnabled Enables/disables extensive debug logging - should only be turned on when needed
PhoneOffset Audio mode for phone playback (Stereo, LeftOnly or RightOnly)
RadioOffset Audio mode for radio playback (Stereo, LeftOnly or RightOnly)
SecondaryRadioOffset Audio mode for secondary radio playback (Stereo, LeftOnly or RightOnly)

Versioning and Update Branches

With version 0.4.0 we introduce a new versioning schema for Salty Chat.
Versions within the same major version will be compatible with each other, even if there are changes like new features or fixes.

0.4.0
| | |
| | --- Patch (fixes and changes)
| --- Minor (new features)
--- Major (incompatible changes)

Any update will be tested in our multi-stage release process:

Branch Description
Stable Any change is tested in the previous branches and was found to be stable.
Testing Public testing branch, where all changes can be tested. We recommend that this branch is only used by developers, who are familiar with the plugin and can debug any issues.
PreBuild Private testing branch, where untested changes are made. Versions using this branch are distributed by Salty Chat developers and are meant to test specific changes, before releasing them to the testing branch.

TeamSpeak Server Settings

To avoid issues with your TeamSpeak server, we recommend the following settings:

  • Manage Virtual Server --> Misc tab --> Min clients in channel before silence: More then your server slots
  • Adjust anti-flood
    • Method 1: Manage Virtual Server --> Anti-Flood tab --> adjust values as needed
    • Method 2: Set b_client_ignore_antiflood permission flag to the group your users are in

Available resources

Mod Language Maintainer Link Comment
FiveM C# saltmine.de repo -
RedM C# saltmine.de repo -
RAGEMP C# saltmine.de repo -
RAGEMP TypeScript saltmine.de repo clientside only
alt:V C#/JS WhishN repo -

Credits

We are using code from the following open source projects:

Sounds we ship in the default sound pack are made by BeatbaronTV, except from the radio sounds, these are recorded from two Motorola Talkabout T82 Extreme we bought for this.

About

Documentation for Salty Chat (TeamSpeak 3 based Voice Plugin)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published