DapperNPals-AudioLoader icon

AudioLoader

Utility library to load custom sounds into Timberborn's SoundSystem

Last updated 3 months ago
Total downloads 177
Total rating 1 
Categories Mods Libraries
Dependency string DapperNPals-AudioLoader-1.0.1
Dependants 1 other mod depends on this mod

This mod requires the following mods to function

BepInEx-BepInExPack_Timberborn-5.4.15 icon
BepInEx-BepInExPack_Timberborn

BepInEx pack for Timberborn. Preconfigured and ready to use.

Preferred version: 5.4.15

README

A simple library that will shoehorn an audio file into Unity + Timberborn's AudioClip system. The way to play that clip varies, but Timberborn essentially has a list of AudioClips and it accesses them in various ways using a string as ID. This Library allows you to load your own sound files/data into that system, and add it to that list.

There is also some kind of Audio grouping system, and if your sound's clipName doesn't conform correctly, it crashes the game. I don't understand the group system super well, but I've been able to put different sounds in different groups by altering its ID string/clipName. If the clipName string begins with 'UI.<clipName>', then it will end up in the UI group ¯\(°_o)/¯

Clips in the UI group can be played with the Timberborn.UISound.UISoundController::PlaySound2D() object method, probably by other means too. Have fun!

Example/Usage:

AudioLoader.I.Load(string filePath, string clipName, UnityEngine.AudioType.MPEG); //mp3 from a file AudioLoader.Instance.Load(byte[] rawData, string clipName, AudioType.OGG); //ogg from the raw bytes (writes the file to temp, then uses the above. For techincal reasons.)

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  
2021-9-26 1.0.1 154 Version 1.0.1 Install
2021-9-25 1.0.0 23 Version 1.0.0 Install