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>
This commit is contained in:
JDJG
GitHub
parent
2cc051fbe1
commit
cb172d1399
|
|
@ -1,5 +1,5 @@
|
|||
# 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. For define the loop you need to create a json with the same name but end with .json.
|
||||
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
|
||||
{
|
||||
|
|
@ -9,7 +9,7 @@ the json look like this:
|
|||
}
|
||||
}
|
||||
```
|
||||
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:
|
||||
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",
|
||||
|
|
@ -33,6 +33,5 @@ audio_pack.zip
|
|||
```
|
||||
|
||||
## Future plans
|
||||
* Make name more meaningful and uniform. (example: change `seq_16`). You can suggest name or make a PR to help rename them/organise them.
|
||||
* Support samples.
|
||||
* Create a tool to convert sequences and samples.
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
# Sequence Information (Music)
|
||||
|
||||
## Race Tracks
|
||||
|
||||
| Track Name | Audio Filename |
|
||||
| --------------------- | --------------------------- |
|
||||
| Banshee Boardwalk | `banshee_boardwalk` |
|
||||
| Bowser's Castle (N64) | `bowsers_castle` |
|
||||
| Choco Mountain | `choco_mountain` |
|
||||
| D.K.'s Jungle Parkway | `dk_jungle` |
|
||||
| Frappe Snowland | `frappe_snowland` |
|
||||
| Kalimari Desert | `kalimari_desert` |
|
||||
| Koopa Troopa Beach | `koopa_troopa_beach` |
|
||||
| Luigi Raceway | `luigi_raceway` |
|
||||
| Mario Raceway | `mario_raceway` |
|
||||
| Moo Moo Farm | `moo_moo_farm` |
|
||||
| N64 Rainbow Road | `rainbow_road` |
|
||||
| N64 Wario Stadium | `wario_stadium` |
|
||||
| Royal Raceway | `royal_raceway` |
|
||||
| Sherbet Land (N64) | `frappe_snowland` |
|
||||
| Toad's Turnpike | `toads_turnpike` |
|
||||
| Yoshi Valley | `yoshi_valley` |
|
||||
|
||||
## Battle Courses
|
||||
|
||||
|
||||
| Battle Course Name | Audio Filename |
|
||||
| ------------------ | --------------- |
|
||||
| Big Donut | `battle_arenas` |
|
||||
| Block Fort | `block_fort` |
|
||||
| Double Deck | `double_deck` |
|
||||
| Skyscraper | `battle_arenas` |
|
||||
|
||||
## General
|
||||
|
||||
|
||||
| Description | Audio Filename |
|
||||
| --------------------------- | ------------------------ |
|
||||
| Special command for sound fx | `sound_player` |
|
||||
| Title Screen | `title_screen` |
|
||||
| Main Screen / Select Screen | `main_menu` |
|
||||
| Start Grid GP/VS | `start_grid_gp_vs` |
|
||||
| Final Lap Fanfare | `final_lap_fanfare` |
|
||||
| Finish 1st Place | `finish_1st_place` |
|
||||
| Finish 2nd–4th Place | `finish_2nd_4th_place` |
|
||||
| Finish 5th–8th Place | `finish_5th_8th_place` |
|
||||
| Winning Results | `winning_results` |
|
||||
| Star Jingle | `star_jingle` |
|
||||
| Game Over | `game_over` |
|
||||
| Start Grid Time Attack | `start_gird_time_attack` |
|
||||
| VS Battle Results | `vs_battle_results` |
|
||||
| Losing Results | `losing_results` |
|
||||
| Award Ceremony Buildup | `award_ceremony_buildup` |
|
||||
| Award Ceremony 1st–3rd | `award_ceremony_1st_3rd` |
|
||||
| Award Ceremony 4th–8th | `award_ceremony_4th_8th` |
|
||||
| Staff Roll | `staff_roll` |
|
||||
|
||||
Refer to Custom Audio on how to use this information.
|
||||
|
|
@ -117,7 +117,7 @@
|
|||
|
||||
enum MusicSeq {
|
||||
MUSIC_SEQ_UNKNOWN = -1,
|
||||
MUSIC_SEQ_00,
|
||||
MUSIC_SEQ_SOUND_PLAYER,
|
||||
MUSIC_SEQ_TITLE_SCREEN,
|
||||
MUSIC_SEQ_MAIN_MENU,
|
||||
MUSIC_SEQ_WARIO_STADIUM,
|
||||
|
|
@ -133,7 +133,7 @@ enum MusicSeq {
|
|||
MUSIC_SEQ_FINISH_1ST_PLACE,
|
||||
MUSIC_SEQ_FINISH_2ND_4TH_PLACE,
|
||||
MUSIC_SEQ_FINISH_5TH_8TH_PLACE,
|
||||
MUSIC_SEQ_16,
|
||||
MUSIC_SEQ_WINNING_RESULTS,
|
||||
MUSIC_SEQ_STAR_JINGLE,
|
||||
MUSIC_SEQ_RAINBOW_ROAD,
|
||||
MUSIC_SEQ_DK_JUNGLE,
|
||||
|
|
|
|||
|
|
@ -202,7 +202,7 @@ namespace Editor {
|
|||
// Enum to string conversion
|
||||
const char* TrackPropertiesWindow::MusicSeqToString(MusicSeq seq) {
|
||||
switch (seq) {
|
||||
case MUSIC_SEQ_00: return "None";
|
||||
case MUSIC_SEQ_SOUND_PLAYER: return "Sound FX Player (Don't use)";
|
||||
case MUSIC_SEQ_TITLE_SCREEN: return "Title Screen";
|
||||
case MUSIC_SEQ_MAIN_MENU: return "Main Menu";
|
||||
case MUSIC_SEQ_WARIO_STADIUM: return "Wario Stadium";
|
||||
|
|
@ -218,7 +218,7 @@ namespace Editor {
|
|||
case MUSIC_SEQ_FINISH_1ST_PLACE: return "Finish 1st Place";
|
||||
case MUSIC_SEQ_FINISH_2ND_4TH_PLACE: return "Finish 2nd-4th Place";
|
||||
case MUSIC_SEQ_FINISH_5TH_8TH_PLACE: return "Finish 5th-8th Place";
|
||||
case MUSIC_SEQ_16: return "16";
|
||||
case MUSIC_SEQ_WINNING_RESULTS: return "Winning Results";
|
||||
case MUSIC_SEQ_STAR_JINGLE: return "Star Jingle";
|
||||
case MUSIC_SEQ_RAINBOW_ROAD: return "Rainbow Road";
|
||||
case MUSIC_SEQ_DK_JUNGLE: return "DK Jungle";
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
seq_00:
|
||||
sound_player:
|
||||
type: NAUDIO:V0:SEQUENCE
|
||||
id: 0
|
||||
size: 0x2830
|
||||
|
|
@ -174,7 +174,7 @@ finish_5th_8th_place:
|
|||
banks:
|
||||
- sound/banks/bank_11
|
||||
|
||||
seq_16:
|
||||
winning_results:
|
||||
type: NAUDIO:V0:SEQUENCE
|
||||
id: 16
|
||||
size: 0x1410
|
||||
|
|
|
|||
Loading…
Reference in New Issue