Tutorial - loaforcsSoundAPI/loaforcsSoundAPI GitHub Wiki

Setup

Important

This page assumes you have BepInEx and SoundAPI installed and have loaded the game at least twice

It is also HEAVILY recommended you enable all types of logging in BepInEx' console through its config(uration) file

If you end up struggling to follow this guide, there's no shame in downloading someone else's mod to learn from it

Tools

All you really need is a text editor - like Windows Notepad - but should you want to create something more complicated the following are recommended

For editing Json files

  • Notepad ++ | A more capable version of Windows' default Notepad, with an emphasis on coding related functionality.
  • Visual Studio Code | A program meant for coding, but has many useful features even for json editing

For audio creation/manipulation

  • Audacity | A simple, free, easy to understand audio editor. Good for beginners.
  • Reaper | A more complex, general purpose audio workstation. Can be used for free, but purchase of a license is recommended.
  • Ableton | A professional audio workstation with a focus on music production
  • FL Studio | A professional audio workstation with a focus on music production. Can be used for free, but purchase of a license is recommended.

For getting original assets of games via dissassembly

For easier modding of games

Folder Structure

The following folders and files need to be created, and then placed into the Plugins folder created by BepInEx.

   BepInEx/ 
    ├── plugins/ 
    │   └──── <Mod Name Here>/  
    │          ├── replacers/ 
    │          │     └── examplereplacer.json 
    │          ├── sounds/ 
    │          │     └── <Sound Files Here> 
    │          └── sound_pack.json 
    └── ...

If you plan on uploading your mod to Thunderstore, see the Lethal Company Wiki for an in-depth guide on how to do so.

Getting the mod to load

LoaforcsSoundAPI automatically scans the BepInEx/plugins folder for any files named sound_pack.json.

The sound_pack.json will contain basic information about the mod, but all you need is the following.

{
    "name": "MySoundMod"
}

The name value is required, but can be different to the folder name.
If you now run the game, the following should appear in the BepInEx console:

[Info   :me.loaforc.soundapi] Starting Sound-pack loading pipeline
[Info   :me.loaforc.soundapi] (Step 1) Loading Sound-pack definitions took 59ms
[Info   :me.loaforc.soundapi] (Step 2) Loading Sound-pack mappings ('0') took 1ms
[Info   :me.loaforc.soundapi] (Step 3) Skipped 0 collection(s), 0 replacement(s), 0 sound(s)
[Info   :me.loaforc.soundapi] (Step 3) Loading sound replacement collections took 5ms
[Info   :me.loaforc.soundapi] (Step 4) Started loading 0 audio file(s)
[Info   :me.loaforc.soundapi] Starting AudioManager.
[Warning:me.loaforc.soundapi] The game will freeze for a moment!
[Info   :me.loaforc.soundapi] (Step 5) All file reads are done, waiting for the audio clips conversions.
[Info   :me.loaforc.soundapi] (Step 6) Took 3ms to finish loading audio clips from files
[Info   :me.loaforc.soundapi] Entire load process took an effective 78ms

If there are no "Error" messages related to SoundAPI in the log, you've done it correctly! (Or you've disabled logging Errors in BepInEx' console)

Let's move on to the basics of writing replacer files next. (Next Page)

⚠️ **GitHub.com Fallback** ⚠️