chatsounds-anywhere

Contents

• How does it work?
  • Basic functionality
  • Modifiers
    • "#" - Selection modifier
    • Sound effects
• Configuration
• Setup for development
  • Example code

Example project for chat inside Counter-Strike Global Offensive

How does it work?

Basic functionality

The program generates list of sound file names and its paths from selected root dir path (the one where you keep your sounds), and whatever you type will be scanned for phrases from that list.

If any phrase matches it's counterpart from the list, it's going to be played. It is designed so that any other garbage in the message isn't going to disturb final output in any way.

Modifiers

In the future there will be more of them.

"#" - Selection modifier

Example: multiple variant chatsound#2 in root dir example is multiple variant chatsound/2.ogg

If a chatsound has multiple variants or there is another chatsound in another category with the same name, you can choose exact one using this modifier.

Sound effects

":echo", ":reverb", ":robotize", ":fft", ":flanger"

Example: garbage:echo

They have fixed arguments for now. In the future, ability to pass parameters into them will be added. For example: :echo(3.1,2.5) (decay, delay)

Modifiers can be stacked

Example: multiple variant chatsound#2:echo:flanger

Configuration

At first run, the configuration file will be generated where you can edit the root path to your sound files, change name of the json sound list file and audio input device.

Contents of the config:

# This path will be used when generating list of audio files and its paths. Use "/" slashes.
root_dir_path = X:/my-example/path

# This is name of the list
chatsound_paths_file_name = chatsound-paths.json

# This is name of the input device
audio_input = default

If you would like to change input device, use Chatsounds::PrintAvailableInputDevices(bool exit_after_print) to list them and then copy one from that list without quotes and paste it to audio_input value.

Example: After calling Chatsounds::PrintAvailableInputDevices

Available input devices:
 Default: "default"
Audio device 0: "PL2766H (NVIDIA High Definition Audio)"
Audio device 1: "G³oœniki (Realtek High Definition Audio)"
Audio device 2: "CABLE Input (VB-Audio Virtual Cable)"            <- for example i choose this one
Audio device 3: "VoiceMeeter Input (VB-Audio VoiceMeeter VAIO)"
Audio device 4: "G³oœniki (Steam Streaming Speakers)"
Audio device 5: "G³oœniki (Steam Streaming Microphone)"

Then in the config: audio_input = CABLE Input (VB-Audio Virtual Cable)

In case of examples related to root directory that will be shown below, the root_dir_path will be X:/root-dir

What is a root directory?

Inside root directory there are other folders (categories). You can name them whatever you want.

There needs to be at least one category folder that will contain .ogg files.

Example

  X:/
    |
    root-dir/                   <- root directory
        |
        category1/              <- one of the categories
            |
            somesound.ogg
            test.ogg
            sound.ogg
            multiple variant chatsound/
                |
                1.ogg
                2.ogg
                3.ogg
                4.ogg
            another chatsound.ogg
            and another.ogg
            etc.ogg
        some other category/    <- another category
            |
            you name it.ogg

From this tree, program will generate this list:

"somesound" : "X:/root-dir/category1/somesound.ogg",
"test" : "X:/root-dir/category1/test.ogg",
"sound" : "X:/root-dir/category1/sound.ogg",
"multiple variant chatsound" : 
[
    "X:/root-dir/category1/multiple variant chatsound/1.ogg",
    "X:/root-dir/category1/multiple variant chatsound/2.ogg",
    "X:/root-dir/category1/multiple variant chatsound/3.ogg",
    "X:/root-dir/category1/multiple variant chatsound/4.ogg",
],
"another chatsound" : "X:/root-dir/category1/another chatsound.ogg",
"and another" : "X:/root-dir/category1/and another.ogg",
"etc" : "X:/root-dir/category1/etc.ogg"
"you name it" : "X:/root-dir/some other category/you name it.ogg"

The multiple variant chatsound is an ordinary chatsound too. It just has multiple variants. If you type it out, random one will be played. To play exact one you need to use "#" - Selection modifier

In case of chatsound having the same name across categories, it will be handled the same way.

Example directory structure based on the first image

 .../
    |
    autoadd/                          <- root directory
        |
        ...
        bill_wurtz_history_of_japan/  <- the one of many categories
            |
            ...
            open the country.ogg      <- first chatsound
            ...
        ...
        its_always_sunny/             <- another category
            |
            ...
            garbage.ogg               <- second chatsound
            ...

Setup for development

Visual Studio 2019

1.

2. Download SDL2 win32 dll - Simple Directmedia Layer

3. Download SoX - Sound eXchange

4. Put these files in the same directory as your executable

• chatsounds-anywhere.dll
• SDL2.dll
• sox-14.4.2/ <- if you execute directly from Visual Studio, put this folder also next to the folder with your executable i.e. before "Release" or "Debug" folder inside solution folder

Example code after setup

This code gets user input and sends it into chatsound parser

#include <iostream>
#include <string>

#include "Chatsounds.h"

int main()
{
    Chatsounds::PrintAvailableInputDevices(false); // print available input devices without exitting program
    Chatsounds s;
    while (true)
    {
        std::cout << "Input:\n> ";
        std::string input;
        std::getline(std::cin, input);

        s.Parse(input);
    }
}