LordAshes-SoundboardPlugin icon

SoundboardPlugin

Trigger music and ambient sounds from a toolbar.

Last updated a month ago
Total downloads 116
Total rating 0 
Categories Tweaks Networked Tools Integration Assets
Dependency string LordAshes-SoundboardPlugin-1.0.0
Dependants 0 other mods depend on this mod

This mod requires the following mods to function

bbepisTaleSpire-BepInExPack-5.4.10 icon
bbepisTaleSpire-BepInExPack

Unified BepInEx all-in-one modding pack - plugin framework, detour library

Preferred version: 5.4.10
brcoding-SetInjectionFlagPlugin-2.3.0 icon
brcoding-SetInjectionFlagPlugin

Allows players to flag mods are installed

Preferred version: 2.3.0
LordAshes-FileAccessPlugin-1.4.1 icon
LordAshes-FileAccessPlugin

Provides standardized methods for accessing both local file and url resources. Automatically handles searching local folders for assets.

Preferred version: 1.4.1

README

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: http://LordAshes.ca/TalespireDonate/Donate.php

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.

Available versions

Please note that the install buttons only work if you have compatible client software installed, such as the Thunderstore Mod Manager. Otherwise use the zip download links instead.

Upload date Version number Downloads Download link  
2022-10-27 1.0.0 116 Version 1.0.0 Install