RiskofThunder-R2API_Sound icon

R2API Sound

API for adding custom sounds or musics

Last updated a year ago
Total downloads 1484291
Total rating 5 
Categories Libraries
Dependency string RiskofThunder-R2API_Sound-1.0.2
Dependants 769 other packages depend on this package

This mod requires the following mods to function

bbepis-BepInExPack-5.4.2109 icon
bbepis-BepInExPack

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

Preferred version: 5.4.2109
RiskofThunder-HookGenPatcher-1.2.3 icon
RiskofThunder-HookGenPatcher

MMHOOK generation at runtime.

Preferred version: 1.2.3
RiskofThunder-R2API_Core-5.0.8 icon
RiskofThunder-R2API_Core

Core R2API module

Preferred version: 5.0.8
RiskofThunder-R2API_ContentManagement-1.0.1 icon
RiskofThunder-R2API_ContentManagement

API for adding content to the game

Preferred version: 1.0.1

README

R2API.Sound - WWise Soundbank loading and MusicTrack addition

About

R2API.Sound is a submodule assembly for R2API that allows mod creators to easily load SoundBanks from WWise and implement new Music Tracks for the game.

Use Cases / Features

R2API.Sound works via two main classes, the SoundBanks class and the Music class.

SoundBanks class allows you to load your WWise SoundBanks to the game you can later use the SoundBank's event names in the game's Util.PlaySound method.

The Music class allows you to add new music tracks to the game, these new tracks can later be used for playing music in different stages, overriding music, and more. The Music class is mainly used for mods that do not have access to properly populating the Game's MusicTrackDef scriptable object, as that scriptable object requires the mod creator to have access to WWise's Unity Integration.

Related Pages

A guide on how to add your own music can be found here, the guide uses R2API.Sound's Music class.

Changelog

'1.0.2'

  • Add missing BepInDependency to R2API.ContentManagement

'1.0.1'

  • Fix the NuGet package which had a dependency on a non-existent version of R2API.Core.

'1.0.0'

  • Split from the main R2API.dll into its own submodule.