ChatSounds

ChatSounds

Source code on GitHub | Report an issue |

A BepInEx mod for On Together that plays a sound when a chat message arrives, with separate settings for the global chat, the local chat and messages that mention you.

Features

• Sounds for other players' messages in the global and local chat, plus a separate sound when a message mentions your name or one of your keywords.
• Each of the three has its own on/off switch, sound, volume, play condition (always / only when you can't see that chat tab / only while the game is in the background) and a cooldown against spam.
• 8 built-in sounds (Ping, Chime, Bubble, Drop, Marimba, Bell, Soft, Alert), the game's own sound effects and pomodoro bells, or your own.wav.ogg.mp3 files.
• In-game settings window (F9 or /chatsound) that plays each sound as you pick it. The same settings are in the mod manager's config editor, and edits made there apply while the game is running.
• Optional quiet mode for focus sessions: only mentions make a sound while you focus.
• Follows the game's Master volume (can be turned off).
• Only messages that actually appear in your chat make a sound. Your own messages, ignored or muted players and local messages from players too far away stay silent.
• Client-side only: nothing is sent to other players.
• English and Russian interface (follows the game's language).

Usage

| Action | How |

|---|---|

| Settings window | F9 or /chatsound |

| All sounds on / off | Left Shift + F9, /chatsound on, /chatsound off |

| One kind on / off | /chatsound global off, /chatsound local on, /chatsound mentions off |

| Volume | /chatsound volume 70 (master), /chatsound volume local 50 |

| Pick a sound | /chatsound sound global Chime, /chatsound sound mentions file:ding.ogg |

| List all sounds | /chatsound sounds |

| Listen | /chatsound test (all three), /chatsound test local, /chatsound test Bell |

| When to play | /chatsound when global notviewing (always, notviewing, unfocused) |

| Mention keywords | /chatsound keyword add mark, markus, keyword remove mark, keyword list, keyword clear |

| Rescan your sound files | /chatsound reload |

| Current settings | /chatsound status |

| Command list | /chatsound help |

/csnd is a short alias for /chatsound. Commands are handled on your side and are never posted to the chat. If CommandAPI is installed, the command is also listed by its /help and suggested by CommandTypeahead.

When a sound plays

| Setting | Plays |

|---|---|

| Always | for every message |

| NotViewing | only when you can't see the message's chat tab right now: the other tab is selected, the chat is hidden or the game window is in the background |

| Unfocused | only while the game window is in the background (for example, while you work in another window) |

A mention plays the mention sound instead of the global/local sound. If the mention sound does not play (because of its condition, cooldown or zero volume), the message gets the normal global/local sound.

The cooldown is the minimum time between two sounds of the same kind: messages that arrive sooner stay silent.

Your own sounds

Put.wav,.ogg or.mp3 files into BepInEx/config/ChatSounds. The folder is created on first launch, and the Sounds folder button in the settings window opens it. Press Rescan and pick your file with the arrows next to the sound name, or write file: into a Sound setting. The folder is in the config directory, so your files survive mod updates. Short sounds (under 2 seconds) work best.

Configuration

BepInEx/config/ontogether.chatsounds.cfg (created on first launch; editable from the mod manager's Config editor, also while the game is running).

| Section | Key | Default | Description |

|---|---|---|---|

| General | Enabled | true | Play sounds for new chat messages. |

| General | MasterVolume | 80 | Volume of all chat sounds, in percent. |

| General | FollowGameVolume | true | Also scale by the game's Master volume. |

| General | QuietDuringFocus | false | During a foc