Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added a little guide
  • Loading branch information
QuestionableM authored Jul 14, 2023
1 parent f09296c commit be9ca23
Showing 1 changed file with 30 additions and 3 deletions.
33 changes: 30 additions & 3 deletions README.md
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"
}
]
}
```

0 comments on commit be9ca23

Please sign in to comment.