Files
SpaghettiKart/docs/custom-audio.md
JDJG cb172d1399 Adds information about what each sequence file does. (#500)
* Adds the sequence information i.e. what each file does.

* Removed not used mario circuit(accidently added from the wiki) - just generic name for every mario course.
Links to mario raceway :)

* update value to be more accurate.

* Update sequences-information.md

* updates seq_00 to be sound player.

* update references of seq_16 to make more sense.

* remove the note on it.

* Update the seq_16 to be the better name of it.

* Update sequences-information.md

* updates each section to have a name.

* Changes The name to make more sense gramatically.

* add new note

* Update sequences-information.md

* Update sequences-information.md

* Fixes the weird change to clrf. Replaces it to be lf instead.

* Update custom-audio.md

* Update TrackProperties.cpp

* Update TrackProperties.cpp

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-07-29 07:07:29 -06:00

38 lines
1.3 KiB
Markdown

# Custom Audio
Replacing music tracks (sequences) requires a zip file that contains audio tracks in the same path/naming as in the original mk64.o2r. Only wav, mp3, ogg and flac are supported. To 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 available 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:
```
audio_pack.zip
└── sound
└── sequences
└── main_menu.mp3
└── main_menu.json
```
## Future plans
* Support samples.
* Create a tool to convert sequences and samples.