summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorcoco875 <59367621+coco875@users.noreply.github.com>2025-07-29 12:55:10 +0000
committerGitHub <noreply@github.com>2025-07-29 06:55:10 -0600
commit3431d1dce0d571207ab7faf690adc22bc13ff5ea (patch)
treed2c0d329521026484cb9cdcec55a77737e1876a4 /docs
parent212436726fc5e3cc5425e8c0de1b363ccae46ee4 (diff)
add more audio documentation (#505)
Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/custom-audio.md27
1 files changed, 25 insertions, 2 deletions
diff --git a/docs/custom-audio.md b/docs/custom-audio.md
index a6da3972d..bbcfcbe68 100644
--- a/docs/custom-audio.md
+++ b/docs/custom-audio.md
@@ -1,12 +1,35 @@
# Custom Audio
-To replace a sequences you should only create a zip file with sequences to replace at the same path as mk64.o2r. Only wav, mp3, ogg and flac are supported.
+To replace a sequences you should only create a zip file with sequences to replace at the same path as mk64.o2r. Only wav, mp3, ogg and flac are supported. For define the loop you need to create a json with the same name but end with .json.
+the json look like this:
+```json
+{
+ "loop": {
+ "start": 0,
+ "end": 0
+ }
+}
+```
+The json file are optional. The unit of `start` and `end` is in pcm frames. You can use a tool like Audacity to find the correct values (it's call samples in Audacity). All properties avaible are:
+```json
+{
+ "name": "Name",
+ "author": "Author",
+ "date": "Date",
+ "loop": {
+ "start": 0,
+ "end": 0
+ }
+}
+```
+The `name`, `author` and `date` are optional. The `loop` is used to define the loop of the sequence. If you don't want to loop the sequence, you can just remove the `loop` property. `date` doesn't have any effect on the audio playback.
## Example:
You want to change sound/sequences/main_menu then you just need to create a zip file with the following structure:
```
-textures_pack.zip
+audio_pack.zip
└── sound
└── sequences
└── main_menu.mp3
+ └── main_menu.json
```
## Future plans