logo

Ventrilo - Events Setup

Ventrilo can inform the User by playing a wave file or generating a Text-to-speech sound whenever certain events occur within the program. This allows the User to control how each of the events is handled. All of the following items in the Events setup page have one of several possible choices, but not all of them apply to every event type.

You connect to server

This event is played whenever you connect to the server. Having a sound generated by this event is very handy when you are having connection problems and you would like to know when the program has auto-reconnected (auto-reconnect is enabled in the Network settings of the program).

You disconnect from server

This event is played whenever you disconnect from the server or if you are having network problems, in which case the program will automatically disconnect from the server. It is also possible the server was taken down or restarted in which case the connection would be broken as well. Having a sound generated by this event is useful if you are busy doing something else and don't have time to look at the programs status, or if you are unable to view it at the current time.

Users connect to server

This event is played when someone else connects to the same server you are connected to. Setting this option to Text-To-Speech is very useful when you do not have direct access to the program. The sound generated would be the name of the User connecting to the server.

Setting this option to ‘Custom Wave’ will force the program to look for a custom file: wav\<Username>\Userconnect.wav  Click here for more details.

Users disconnect from server

Similar to the Users Connect to Server option this event will inform you when another User has disconnected from the same server. Setting this option to Text-to-speech will generate a sound announcing the name of the User who has disconnected.

Setting this option to Custom Wave will force the program to look for a custom file: wav\<Username>\Userdisconnect.wav   Click here for more details.

Comments

This event is played whenever you or another User sends a comment to be displayed next to the Users name. Setting this option to Text-To-Speech will generate a sound announcing the Users name and the comment that was sent.

You switch channels

This event is played whenever you switch to a different channel or back out to the lobby. Setting this option to Text-To-Speech will generate a sound announcing the name of the channel you have just moved into.

Users switch channels

This event is played whenever another User enters or leaves the channel you are currently in.

Setting this option to Custom Wave will force the program to look for a custom file: wav\<Username>\UserChannelJoin.wav or wav\<Username>\UserChannelLeave.wav Click here for more details.

Toggle mute sound

This event is played whenever you press a key that you have bound to toggle the "Mute Sound" on the main window of the program. Setting this option to Text-To-Speech will generate a sound informing you of the actual state of the "Mute Sound" setting.

Toggle mute microphone

This event is played whenever you press a key that you have bound to toggle the "Mute Microphone" on the main window of the program. Setting this option to Text-To-Speech will generate a sound informing you of the actual state of the "Mute Microphone" setting.

Toggle Binds

This event is played whenever you press a key that you have bound to toggle the active binds on and off. Setting this option to Text-To-Speech will generate a sound informing you of the actual state of the your active binds settings.

Switch Bindings

This event is played when you activate a function bind that switches your current active bindings to a new set of bindings. See the ‘Bindings Editor’ help pages for more info about configuring bind switching.

Private chat open

This event is played when another User initiates a private chat session with you. Setting this option to Text-To-Speech will play a sound informing who started the session.

Private chat message

This event is played when the other User of an existing private chat session sends you a text message. Setting this option to Text-To-Speech will play the text received.

Pending message

This event is played when you receive a file transfer notification or a deferred message from another User. Setting this option to Text-To-Speech will notify you the files are available for download.

Ventrilo Event Text file

This option lets you choose the Ventrilo Event Text (VET) file that is used for generating the Text-To-Speech audio messages when certain events occur. Basically, if you or anyone else has generated other VET files you can choose which one to use. They will be based on themes just like your system sounds are based on themes. Ventrilo only comes with the "default.vet" file.


How to setup custom wav files:

The default Application event sounds used to be installed with the application. The files themselves were in the same directory as the binary and were placed there by the installer. We even documented the files being there and if you wanted to change what the sound was you changed it in there.

However, if you have more than one person logging into this machine that meant that every person was forced to use the same customized sounds. On newer platforms the User might not have the right to override these files unless they had Admin rights.

This is now different. The files are now stored in the $(MyDocuments)\VentriloData\Wav\AppEvents folder which is always unique to each system login account.
Each time the program starts it will check this folder for any missing files and install a default version of each file name. If the file already exists it will NOT be refreshed from the program. This way the User can create their own version of each event sound.

First it's important to understand where the "wav\" directory should be located. Right-click in the main window, select the View option and then select the Working Directory option. This will open the File Explorer window and will automatically display the working directory for the program. If the "wav" directory does not exist then the previous step will automatically create it for you.

The wav directory is just a place holder for more specific directory names. This is where we get involved with the custom wave files.

Let's assume that you have custom wave files for people with login names like Joe and Mary. Two directory names need to be created using the following example:

$(MyDocuments)\VentriloData\Wav\Joe
$(MyDocuments)\VentriloData\Wav\Mary

In each of these directories you would place the custom wave files that use hard-coded names like Userconnect.wav, Userdisconnect.wav, Userchanneljoin.wav and Userchannelleave.wav

If you have your client configured to play a custom wav file when someone connects to the server, Ventrilo will determine your current User's working directory, tack on the wav\ and then tack on the connecting Users name Joe\. It will then tack on the Userconnect.wav because that is the event being generated.

Note: If you assign bind keys to play wave files then the location of the "wav\" directory shown in the above examples is the same but with one difference. Wave file binds are more generic and should be broken down into themes where each theme has its own directory. For example, if you had 4 wave files that are part of a theme called Fun_Fragger you would have a directory structure that looks similar to the following:

$(MyDocuments)\VentriloData\Wav\Fun_Fragger

This directory will contain the four files that you would like to bind to. Wave files should not be placed directly into the \Wav directory. They must always be in subdirectories below it.