-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
1 changed file
with
30 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,33 @@ | ||
# SM-DLM | ||
A dll that adds custom audio support for Scrap Mechanic mods | ||
|
||
# Goals | ||
- Add a sound config file for each mod | ||
- Make sounds reloadable | ||
# How to use | ||
- Create `sm_dlm_config.json` in the root directory of your mod. | ||
- An example of how `sm_dlm_config.json` structure should look like. | ||
```jsonc | ||
{ | ||
//Make the names more unique to avoid name collisions with other mods | ||
"soundList": { | ||
//You can reference the same sound multiple times, but configure them differently | ||
"ExampleSoundName": { | ||
"path": "$CONTENT_DATA/CustomAudio/1_2_Oatmeal.mp3", | ||
"is3D": true | ||
}, | ||
"ExampleSoundName2": { | ||
"path": "$CONTENT_DATA/CustomAudio/1_2_Oatmeal.mp3", | ||
"is3D": false | ||
} | ||
} | ||
} | ||
``` | ||
- The names specified in `sm_dlm_config.json` can then be used in effects! | ||
```json | ||
"ExampleEffect": { | ||
"effectList": [ | ||
{ | ||
"type": "audio", | ||
"name": "ExampleSoundName1" | ||
} | ||
] | ||
} | ||
``` |