altV yaca js

yaca.systems for alt:V

This is a example implementation for alt:V. Feel free to report bugs via issues or contribute via pull requests.

Join our Discord to get help or make suggestions and start using yaca.systems today!

Setup Steps

1. Download and install the latest release of this resource.
2. Add 'yaca-voice' into the ressource section of your server.toml.
3. Rename server.config.json.example to server.config.json and adjust the variables to your needs.
4. Rename config/config.json.example to config.json and adjust the variables to your needs.
5. Rename shared.json.example to shared.json and adjust the variables to your needs.

Server Config

Variable	Type	Description
YACA_UNIQUE_SERVER_ID	string	The unique Server Identifier of the Teamspeak-Server
YACA_CHANNEL_ID	number	The ID of the Ingame Channel
YACA_CHANNEL_PASSWORD	string	The Password used to join the Ingame Channel
YACA_DEFAULT_CHANNEL_ID	number	The ID of the Channel where a players should be moved to when leaving Ingame

Client Config

Variable	Type	Description
VehicleMufflingWhitelist	string[]	Whitelist of vehicle models that should not be muffled when sitting inside a car without a window/door open.
UseLocalLipsync	boolean	Sync lips via server or client, UseLocalLipsync false is suggested in the most cases
EnableDebug	boolean	Enable Debug Mode for the Plugin, skip the version check
ExcludedChannels	number[]	The player will not be moved into ingame if he is in one of these channels. Needs to be the channelid.
UnmuteDelay	number	Delay in milliseconds, how long it should take that teamspeak mutes other player when he is not in range anymore. Improves the performance for the teamspeakserver. Note: He is still not hearable while he is unmuted
MufflingRange	number	If the value is set to -1, the player voice range is taken. If the value is >= 0, you can set the max muffling range before it gets completely cut off
MaxDistanceToRadioTower	number	The max distance to the radio tower in meters. Used for the quality calculation of the radio.
RadioTowers	object[]	The radio towers used for the quality calculation. If empty, the quality is always good.
MaxPhoneSpeakerRange	number	The max range for the phone speaker in meters.
Keybinds	object	The keybinds for the plugin. If the value is a empty string, then keybind is not used. You can find the keycodes here https://www.toptal.com/developers/keycode/table

Shared Config

Variable	Type	Description
UseWhisper	boolean	Enable Whisper Functionality, if set to false it mutes and unmutes the players - suggested for 500 and more Players
PhoneSpeakerHearBothDirections	boolean	If set to true, the player can hear people which are near the person, who has enabled the phone speaker.

API

Client

General

client:yaca:useMegaphone(state: boolean)

Start or stop talking on the megaphone.

Parameter	Type	Description
state	boolean	Start or stop talking

client:yaca:changeVoiceRange(higher: boolean)

Change the voice range of the player.

Parameter	Type	Description
higher	boolean	true if the range should be increased, false if it should be decreased

Radio

client:yaca:radioTalking(state: boolean)

Start or stop talking on the radio.

Parameter	Type	Description
state	boolean	Start or stop talking

client:yaca:canOpenRadio(state: boolean)

Enables or disables the radio for the player - default its allowed.

Parameter	Type	Description
state	boolean	Change the state

client:yaca:enableRadio(state: boolean)

Enables or disables the radio for the player.

Parameter	Type	Description
state	boolean	Change the state

client:yaca:changeRadioFrequency(frequency: string)

Change the radio frequency from the current radiochannel

Parameter	Type	Description
frequency	string	The frequency in format "xx,xx"

client:yaca:muteRadioChannel()

Mute the current radiochannel.

client:yaca:changeActiveRadioChannel(channel: number)

Change the active radio channel to the given channel.

Parameter	Type	Description
channel	number	The channel id

client:yaca:changeRadioChannelVolume(higher: boolean)

Change the volume of the current radio channel.

Parameter	Type	Description
higher	boolean	true if the volume should be increased, false if it should be decreased

client:yaca:changeRadioChannelStereo()

Change the stereomode of the current radio channel.

Server

General

server:yaca:connect(player: alt.Player)

Connects the player to the YACA system.

Parameter	Type	Description
player	alt.Player	the player object

server:yaca:changePlayerAliveStatus(player: alt.Player, alive: bool)

Changes the alive status of a player. Used to forcemute player

Parameter	Type	Description
player	alt.Player	the player object
alive	boolean	the alive status

Phone

server:yaca:callPlayer(player: alt.Player, target: alt.Player, state: bool)

Creates a phone call between two players.

Parameter	Type	Description
player	alt.Player	the player source
target	alt.Player	the target player source
state	boolean	the state of the call

server:yaca:callPlayerOldEffect(player: alt.Player, target: alt.Player, state: boolean)

Creates a phone call between two players with the old effect.

Parameter	Type	Description
player	alt.Player	the player source
target	alt.Player	the target player source
state	boolean	the state of the call

server:yaca:muteOnPhone(player: alt.Player, state: bool, onCallstop: bool)

Mutes the player when using the phone.

Parameter	Type	Description
player	number	the player source
state	boolean	the mute state
onCallstop	boolean	is it on call stop

server:yaca:enablePhoneSpeaker(player: alt.Player, state: bool)

Enable or disable the phone speaker for a player.

Parameter	Type	Description
player	number	the player source
state	boolean	the phone speaker state

Events

Client

YACA:DISCONNECTED_FROM_WEBSOCKET

Emits when the player disabled the plugin.

YACA:CONNECTED_TO_WEBSOCKET

Emits when the player enabled the plugin.

YACA:JOINED_INGAME_CHANNEL

Emits when the player joined the ingamechannel.

YACA:MOVED_CHANNEL

Emits when the own player moved into a channel.

Parameter	Type	Description
Type	string	INGAME_CHANNEL, EXCLUDED_CHANNEL

YACA:SOUND_STATE_CHANGED

Emits when the own player changed the microphone or speaker state.

Parameter	Type	Description
States	string	Represents the current state of microphone and speaker as json (microphoneMuted, microphoneDisabled, soundMuted, soundDisabled)

YACA:VOICE_RANGE_CHANGED

Emits when the own player changed the voice range.

Parameter	Type	Description
Range	number	Represents the current voice range

YACA:IS_PLAYER_TALKING

Emits when the own player is talking.

Parameter	Type	Description
IsTalking	boolean	Represents if the player is talking

YACA:IS_OTHER_PLAYER_TALKING

Emits when another player is talking.

Parameter	Type	Description
remoteId	number	Represents the player id
IsTalking	boolean	Represents if the player is talking

Server

tbc

Developers

If you want to contribute to this project, feel free to do so. We are happy about every contribution. If you have any questions, feel free to ask in our Discord.