SoundboardPlugin
Trigger music and ambient sounds from a toolbar.
About this mod Author’s original text
Soundboard Plugin
This unofficial TaleSpire dependency plugin for triggering atmosphere music and ambient audio from a toolbar.
This plugin, like all others, is free but if you want to donate, use:
Change Log
1.0.0: Initial release
Install
Use R2ModMan or similar installer to install this plugin.
Usage
Click the button on the toolbar to trigger the audio.
Configuration
Toolbar
The plugin uses a single configuration files called `Soundboard.json` which has the following format:
{
"position": {"x": 30, "y": 35},
"delta": {"x": 65, "y": 0},
"width": 60,
"size": 12,
"entries":
[
{
"title": "Heros",
"audioName": "Call for Heroes",
"length": 60.0,
},
{
"title": "Mystery",
"audioName": "Mysterious Place",
"length": 60.0,
},
{
"title": "Battle",
"audioName": "Battle - Cultists",
"length": 60.0,
},
{
"title": "Tavern",
"audioName": "Tavern, Busy",
"length": 0.0,
}
]
}
The _position_ property determines the starting point of the toolar.
The _delta_ property is the toolbar offset for each entry. By using a x offset, the toolbar becomes
horizontal. By using a y offset the toolbar becomes a vertical offset.
The _width_ property is used to determine the width of the text area.
The _size_ property is used to determine the size of the button font.
The _entries_ is a list of audio buttons. Each entry has the following:
The _title_ is the text that appears on the button.
The _audioName_ is the name of the audio to be played.
The _length_ is duration, in seconds, that the audio will play for. If set to 0 then the audio is not stopped.
When audio is requested to play, it will automatically detect if the audio was registered as music or ambient
and play it using that method. The selection will be changed in the Atmosphere menu. If a positive length value
is provided, the audio will be stopped after the length of time has expired. Only audio of the appropriate kind
will be stopped. This means, for example, playing an ambient audio for a few seconds will not affect any music
that is playing. After the audio is stopped, the previous playing audio (if any) is not restored.
If you are not sure what the registered name of a specific audio is, just add an entry with a dummy audioName.
When you trigger this audio, nothing will play but the list of registered audio will be dumped to the log.
Go through the log to find the exact name of the desired audio.
Button
The background of the button can be customized by replacing the `Soundboard.Button.png` file.
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide.
Install these first, or the mod will not work: