SM64Decomp Wiki - User contributions [en]

Music sequence

2025-12-05T18:08:24Z

Tenry: Add example melody script.

dasdasdasdMusic in Super Mario 64 is controlled by sequence files. They are in .m64 format, which is similar to [[wikipedia:MIDI|MIDI]]. A sequence file has a sequence script, that can spawn channels, which have channel scripts, that can spawn layers (also known as tracks), which have layer scripts that can play notes. Each note is performed using an instrument from a sound bank. A sequence file can use multiple banks. The mapping from sequences to sound banks is described in '''sound/sequences.json'''. Channels can switch between banks using a command. However, in practice most sequences limit themselves to a single sound bank. The main exception is sequence 0, which is responsible for sound effects.

A sequence may play up to 16 channels with up to 4 layers per channel. Several notes can be played simultaneously on a single layer.

A sequence is played as long as the sequence script is not ended. A channel (including layers) is active as long as the channel script is not ended.

== Note properties ==
A note can be played by the commands <code>layer_note0</code>, <code>layer_note1</code> and <code>layer_note2</code> (only valid if <code>chan_largenoteson</code> has been called on the layer's channel) or <code>layer_smallnote0</code>, <code>layer_smallnote1</code> and <code>layer_smallnote2</code> (only valid if <code>chan_largenotesoff</code> has been called on the layer's channel; default state). A note is defined by the following properties:

=== Pitch ===
Also known as '''note'''. The pitch defines the frequency in which the instrument is to be played. See list of notes below for available pitches.

=== Play percentage ===
Also known as '''timestamp'''. This defines the note value, such as half or quarter note. This also implies a layer delay of the same amount. See note values below for possible values.

=== Velocity ===
This is the volume of the note.

=== Duration ===
Also known as '''gate''' or '''gate time'''. A value of 0 menas the note is heard during the whole percentage, 128 is half of the percentage and 255 almost none.

== List of notes ==
This is a list of notes as used by the ''layer_note#'' and ''layer_smallnote#'' commands.
{| class="wikitable"
!Octave
!Note
!Decimal
!Hex (note0)
!Hex (note1)
!Hex (note2)
|-
! rowspan="3" |0
!A
|0
|0x00
|0x40
|0x80
|-
!A♯/B♭
|1
|0x01
|0x41
|0x81
|-
!B
|2
|0x02
|0x42
|0x82
|-
! rowspan="12" |1
!C
|3
|0x03
|0x43
|0x83
|-
!C♯/D♭
|4
|0x04
|0x44
|0x84
|-
!D
|5
|0x05
|0x45
|0x85
|-
!D♯/E♭
|6
|0x06
|0x46
|0x86
|-
!E
|7
|0x07
|0x47
|0x87
|-
!F
|8
|0x08
|0x48
|0x88
|-
!F♯/G♭
|9
|0x09
|0x49
|0x89
|-
!G
|10
|0x0A
|0x4A
|0x8A
|-
!G♯/A♭
|11
|0x0B
|0x4B
|0x8B
|-
!A
|12
|0x0C
|0x4C
|0x8C
|-
!A♯/B♭
|13
|0x0D
|0x4D
|0x8D
|-
!B
|14
|0x0E
|0x4E
|0x8E
|-
! rowspan="12" |2
!C
|15
|0x0F
|0x4F
|0x8F
|-
!C♯/D♭
|16
|0x10
|0x50
|0x90
|-
!D
|17
|0x11
|0x51
|0x91
|-
!D♯/E♭
|18
|0x12
|0x52
|0x92
|-
!E
|19
|0x13
|0x53
|0x93
|-
!F
|20
|0x14
|0x54
|0x94
|-
!F♯/G♭
|21
|0x15
|0x55
|0x95
|-
!G
|22
|0x16
|0x56
|0x96
|-
!G♯/A♭
|23
|0x17
|0x57
|0x97
|-
!A
|24
|0x18
|0x58
|0x98
|-
!A♯/B♭
|25
|0x19
|0x59
|0x99
|-
!B
|26
|0x1A
|0x5A
|0x9A
|-
! rowspan="12" |3
!C
|27
|0x1B
|0x5B
|0x9B
|-
!C♯/D♭
|28
|0x1C
|0x5C
|0x9C
|-
!D
|29
|0x1D
|0x5D
|0x9D
|-
!D♯/E♭
|30
|0x1E
|0x5E
|0x9E
|-
!E
|31
|0x1F
|0x5F
|0x9F
|-
!F
|32
|0x20
|0x60
|0xA0
|-
!F♯/G♭
|33
|0x21
|0x61
|0xA1
|-
!G
|34
|0x22
|0x62
|0xA2
|-
!G♯/A♭
|35
|0x23
|0x63
|0xA3
|-
!A
|36
|0x24
|0x64
|0xA4
|-
!A♯/B♭
|37
|0x25
|0x65
|0xA5
|-
!B
|38
|0x26
|0x66
|0xA6
|-
! rowspan="12" |4
!C
|39
|0x27
|0x67
|0xA7
|-
!C♯/D♭
|40
|0x28
|0x68
|0xA8
|-
!D
|41
|0x29
|0x69
|0xA9
|-
!D♯/E♭
|42
|0x2A
|0x6A
|0xAA
|-
!E
|43
|0x2B
|0x6B
|0xAB
|-
!F
|44
|0x2C
|0x6C
|0xAC
|-
!F♯/G♭
|45
|0x2D
|0x6D
|0xAD
|-
!G
|46
|0x2E
|0x6E
|0xAE
|-
!G♯/A♭
|47
|0x2F
|0x6F
|0xAF
|-
!A
|48
|0x30
|0x70
|0xB0
|-
!A♯/B♭
|49
|0x31
|0x71
|0xB1
|-
!B
|50
|0x32
|0x72
|0xB2
|-
! rowspan="12" |5
!C
|51
|0x33
|0x73
|0xB3
|-
!C♯/D♭
|52
|0x34
|0x74
|0xB4
|-
!D
|53
|0x35
|0x75
|0xB5
|-
!D♯/E♭
|54
|0x36
|0x76
|0xB6
|-
!E
|55
|0x37
|0x77
|0xB7
|-
!F
|56
|0x38
|0x78
|0xB8
|-
!F♯/G♭
|57
|0x39
|0x79
|0xB9
|-
!G
|58
|0x3A
|0x7A
|0xBA
|-
!G♯/A♭
|59
|0x3B
|0x7B
|0xBB
|-
!A
|60
|0x3C
|0x7C
|0xBC
|-
!A♯/B♭
|61
|0x3D
|0x7D
|0xBD
|-
!B
|62
|0x3E
|0x7E
|0xBE
|-
!6
!C
|63
|0x3F
|0x7F
|0xBF
|}

== Note durations ==
The effective duration of a note and the delay commands is based on the currently set sequence tempo. The duration of a single tick in seconds can be calculated using the following formula: <code>time = 1.25 / tempo</code>.
{| class="wikitable"
!Note
!Ticks
!Duration (120 BPM)
|-
|whole
|192
|2s
|-
|half dotted (2nd + 4th)
|144
|1.5s
|-
|half
|96
|1s
|-
|quarter dottet (4th + 8th)
|72
|0.75s
|-
|quarter (4th)
|48
|0.5s
|-
|eighth dottet (8th + 16th)
|36
|0.375s
|-
|quarter tuplet
|32
|0.333s
|-
|eighth (8th)
|24
|0.25s
|-
|sixteenth dottet (16th + 32th)
|18
|0.1875s
|-
|eigthth tuplet
|16
|0.1666s
|-
|sixteenth (16th)
|12
|0.125s
|-
|32th dottet (32th + 64th)
|9
|0.09375s
|-
|sixteenth tuplet (16th)
|8
|0.08333s
|-
|32th
|6
|0.0625s
|-
|32th tuplet
|4
|0.041666s
|-
|64th
|3
|0.03125s
|-
|64th tuplet
|2
|0.0208333s
|}

== Create sequences ==
There are several ways for creating new sequence files.

=== Seq64 ===
Seq64 is a GUI program for editing sequence files for Super Mario 64 and other Nintendo games. It also features full MIDI importing and exporting.

https://github.com/sauraen/seq64

=== Manually ===
Sequence files can also be created manually in a textual format. Create a new assembly file in the sequences directory, for example '''sound/sequences/us/23_custom_sequence.s'''. This file should have the following anatomy:<syntaxhighlight lang="asm" line="1">
#include "seq_macros.inc"
.section .rodata
.align 0

################################################################################
# This label is required at the beginning of the sequence.
sequence_start:

# Sequence commands like seq_settempo, seq_initchannels, seq_startchannel here
seq_startchannel 0, channel0

# If your sequence loops, put this here
seq_jump sequence_start

# End of sequence script
seq_end

################################################################################
# Any label you want, so you can refer to this section when starting a channel.
channel0:

# Channel commands like chan_setvol, chan_setinstr, chan_setlayer here
chan_largenoteson
chan_setlayer 0, layer_melody

# End of channel script
chan_end

################################################################################
layer_melody:

# Layer commands here like layer_note0, layer_note1 etc.

# End of layer script
layer_end
</syntaxhighlight>Next you can write down a series of commands. See '''include/seq_macros.inc''' or https://hackmd.io/opEB-OmxRa26P8h8pA-x7w for a list of available commands.

=== Example melody "Transposition" ===
The following example script plays a melody of 69 notes and repeats it over at varying transposition (hence the name).<syntaxhighlight lang="asm" line="1">
#include "seq_macros.inc"
.section .rodata
.align 0

.eqv EIGHTH, 24
.eqv SEQ_LEN, EIGHTH * (9 + 11 + 10 + 12 + 12 + 7 + 8)

# This label is required at the beginning of the sequence.
sequence_start:

seq_setmutebhv 0x20
seq_settempo 125
seq_setvol 127

seq_initchannels 0x01
seq_startchannel 0, channel0

# Note: the maximum delay is 32767 (0x7fff) ticks, so we just do multiple delays.
seq_delay SEQ_LEN * 5
seq_delay SEQ_LEN * 5
seq_delay SEQ_LEN * 5
seq_delay SEQ_LEN * 5
seq_delay SEQ_LEN * 5
seq_jump sequence_start

seq_end

channel0:
chan_largenoteson
chan_setvol 127
chan_setinstr 4
chan_setreverb 127

chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose -11
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose -8
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose -2
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose -6
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose 9
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose 1
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose -7
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose 10
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose 12
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose 2
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose 4
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose 5
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose 3
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose -5
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose -12
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose -9
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose 7
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose 6
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose -10
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose 11
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose -4
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose -1
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose 8
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_transpose -3
chan_setlayer 0, layer_melody
chan_delay SEQ_LEN

chan_end

layer_melody:
layer_note1 40, EIGHTH, 100 # c#4
layer_note1 42, EIGHTH, 100 # d#4
layer_note1 43, EIGHTH, 100 # e-4
layer_note1 35, EIGHTH, 100 # ab3
layer_note1 42, EIGHTH, 100 # d#4
layer_note1 33, EIGHTH, 100 # gb3
layer_note1 31, EIGHTH, 100 # e-3
layer_note1 30, EIGHTH, 100 # d#3
layer_note1 28, EIGHTH, 100 # c#3

layer_note1 35, EIGHTH, 100 # ab3
layer_note1 40, EIGHTH, 100 # c#4
layer_note1 43, EIGHTH, 100 # e-4
layer_note1 42, EIGHTH, 100 # d#4
layer_note1 43, EIGHTH, 100 # e-4
layer_note1 45, EIGHTH, 100 # gb4
layer_note1 35, EIGHTH, 100 # ab3
layer_note1 38, EIGHTH, 100 # b-3
layer_note1 43, EIGHTH, 100 # e-4
layer_note1 42, EIGHTH, 100 # d#4
layer_note1 40, EIGHTH, 100 # c#4

layer_note1 35, EIGHTH, 100 # ab3
layer_note1 40, EIGHTH, 100 # c#4
layer_note1 44, EIGHTH, 100 # f-4
layer_note1 40, EIGHTH, 100 # c#4
layer_note1 45, EIGHTH, 100 # gb4
layer_note1 40, EIGHTH, 100 # c#4
layer_note1 47, EIGHTH, 100 # ab4
layer_note1 40, EIGHTH, 100 # c#4
layer_note1 48, EIGHTH, 100 # a-4
layer_note1 40, EIGHTH, 100 # c#4

layer_note1 42, EIGHTH, 100 # d#4
layer_note1 38, EIGHTH, 100 # b-3
layer_note1 33, EIGHTH, 100 # gb3
layer_note1 38, EIGHTH, 100 # b-3
layer_note1 42, EIGHTH, 100 # d#4
layer_note1 38, EIGHTH, 100 # b-3
layer_note1 43, EIGHTH, 100 # e-4
layer_note1 38, EIGHTH, 100 # b-3
layer_note1 45, EIGHTH, 100 # gb4
layer_note1 38, EIGHTH, 100 # b-3
layer_note1 47, EIGHTH, 100 # ab4
layer_note1 38, EIGHTH, 100 # b-3

layer_note1 40, EIGHTH, 100 # c#4
layer_note1 36, EIGHTH, 100 # a-3
layer_note1 35, EIGHTH, 100 # ab3
layer_note1 36, EIGHTH, 100 # a-3
layer_note1 40, EIGHTH, 100 # c#4
layer_note1 43, EIGHTH, 100 # e-4
layer_note1 38, EIGHTH, 100 # b-3
layer_note1 35, EIGHTH, 100 # ab3
layer_note1 33, EIGHTH, 100 # gb3
layer_note1 35, EIGHTH, 100 # ab3
layer_note1 38, EIGHTH, 100 # b-3
layer_note1 43, EIGHTH, 100 # e-4

layer_note1 33, EIGHTH, 100 # gb3
layer_note1 35, EIGHTH, 100 # ab3
layer_note1 36, EIGHTH, 100 # a-3
layer_note1 31, EIGHTH, 100 # e-3
layer_note1 30, EIGHTH, 100 # d#3
layer_note1 31, EIGHTH, 100 # e-3
layer_note1 33, EIGHTH, 100 # gb3

layer_note1 30, EIGHTH, 100 # d#3
layer_note1 26, EIGHTH, 100 # b-2
layer_note1 24, EIGHTH, 100 # a-2
layer_note1 23, EIGHTH, 100 # ab2
layer_note1 31, EIGHTH, 100 # e-3
layer_note1 24, EIGHTH, 100 # a-2
layer_note1 31, EIGHTH, 100 # e-3
layer_note1 23, EIGHTH, 100 # ab2

layer_end
</syntaxhighlight>

== Commands ==

=== Sequence commands ===
{| class="wikitable"
!Mnemonic
!Param 1
!Param 2
!Bytecode (US)
!Description
|-
!seq_end
|
|
|0xff
|End of script, loop or function
|-
!seq_delay1
|
|
|0xfe
|Delay for 1 tick
|-
!seq_delay
|ticks
|
|0xfd, var
|Delay for X ticks
|-
!seq_call
|address
|
|0xfc, addr
|Call a function
|-
!seq_jump
|address
|
|0xfb, addr
|Jump to a point in the sequence script
|-
!seq_beqz
|address
|
|0xfa, addr
|Jump if Q == 0, where Q is an s8 used to hold temporary sequence script state
|-
!seq_bltz
|address
|
|0xf9, addr
|Jump if Q < 0
|-
!seq_loop
|iterations
|
|0xf8, u8
|Repeat until <code>loopend</code> for X iterations (256 if X = 0)
|-
!seq_loopend
|
|
|0xf7
|Loop end marker
|-
!seq_bgez
|address
|
|0xf5, addr
|Jump if Q >= 0
|-
!seq_reservenotes
|numNotes
|
|0xf2, u8
|Reserve X notes for exclusive use by this sequence (dropping earlier reservations). A limited number of notes can be played at once (configurable per level, usually 16); if more than that are played, an existing one will be stopped and reused. This command can prevent that from happening across sequences.
|-
!seq_unreservenotes
|
|
|0xf1
|Drop all earlier reservations made by this sequence.
|-
!seq_transpose
|semitones
|
|0xdf, s8
|Set transposition in semitones.
|-
!seq_transposerel
|semitones
|
|0xde, s8
|Change transposition by some delta.
|-
!seq_settempo
|tempo
|
|0xdd, u8
|Set tempo in BPM.
|-
!seq_addtempo
|tempo
|
|0xdc, s8
|Change tempo by some delta.
|-
!seq_setvol
|volume
|
|0xdb, u8
|Set volume scale (0…255 = none to twice normal).
|-
!seq_changevol
|volume
|
|0xda, s8
|Change volume scale by some delta.
|-
!seq_initchannels
|channelMask
|
|0xd7, u16
|Initialize channels (bitmask). This copies mute behavior and note allocation policy.
|-
!seq_disablechannels
|channelMask
|
|0xd6, u16
|Uninitialize channels (bitmask).
|-
!seq_setmutescale
|mulitplier
|
|0xd5, s8
|Set volume multiplier for muted mode (0…127).
|-
!seq_mute
|
|
|0xd4
|Set sequence to muted mode. Depending on what behavior has been set this will do different things; from lowering volume to not running scripts.
|-
!seq_setmutebhv
|bitmask
|
|0xd3, u8
|Set mute behavior (bitmask). Bit 0x20 lowers volume, bit 0x40 does something to layers, and bit 0x80 pauses the sequence script. Default mute behavior is to have all of those bits set.
|-
!seq_setshortnotevelocitytable
|address
|
|0xd2, addr
|Set velocity table for short notes (see further down). Target should be an array of bytes in the sequence data of length 16.
|-
!seq_setshortnotedurationtable
|address
|
|0xd1, addr
|Set duration table for short notes (see further down). Target should be an array of bytes in the sequence data of length 16.
|-
!seq_setnoteallocationpolicy
|policyMask
|
|0xd0, u8
|Set note allocation policy (bitmask). If bit 0x1 is set, it will try to steal notes back from what was previously played on the same layer. If bit 0x2 is set, notes will be allocated exclusively from the channel’s reserved notes, else if 0x4 is set, from the channel’s or sequence’s reserved notes, else if 0x8 is set, from unreserved notes, otherwise from all sources. Not used by the game.
|-
!seq_setval
|value
|
|0xcc, u8
|Set Q to a constant.
|-
!seq_bitand
|value
|
|0xc9, u8
|Bitand Q by a constant.
|-
!seq_subtract
|value
|
|0xc8, u8
|Subtract a constant from Q.
|-
!seq_startchannel
|channel
|address
|0x90-0x9f, addr
|Start channel N, with a given channel script.
|-
!seq_getvariation
|
|
|0x80-0x8f
|Set Q to the variation bit, which is initially either 0 or 0x80 (i.e. -128, since Q is s8). This bit comes from the sequence load command. For instance, to play the Koopa shell music, the game plays sequence 0x8E, which is the same as sequence 0xE but with the variation bit set.
|-
!seq_setvariation
|
|
|0x70-0x7f
|Set the variation bit to Q.
|-
!seq_subvariation
|
|
|0x50-0x5f
|Subtract the variation bit from Q.
|-
!seq_testchdisabled
|channel
|
|0x00-0x0f
|Set Q to 1 or 0, depending on whether channel N has been disabled by channel script.
|}

=== Channel commands ===
{| class="wikitable"
!Mnemonic
!Param 1
!Param 2
!Param 3
!Bytecode (US)
!Description
|-
!chan_end
|
|
|
|0xff
|End of script, loop or function
|-
!chan_delay1
|
|
|
|0xfe
|Delay for 1 tick
|-
!chan_delay
|ticks
|
|
|0xfd, var
|Delay for X ticks
|-
!chan_call
|address
|
|
|0xfc, addr
|Call a function
|-
!chan_jump
|address
|
|
|0xfb, addr
|Jump to a point in the channel script
|-
!chan_beqz
|address
|
|
|0xfa, addr
|Jump if Q == 0, where Q is an s8 used to hold temporary channel script state
|-
!chan_bltz
|address
|
|
|0xf9, addr
|Jump if Q < 0
|-
!chan_loop
|iterations
|
|
|0xf8, u8
|Repeat until <code>loopend</code> for X iterations (256 if X = 0)
|-
!chan_loopend
|
|
|
|0xf7
|Loop end marker
|-
!chan_break
|
|
|
|0xf6
|Decrease loop/function stack depth by 1. Combine with a jump to break out of a loop.
|-
!chan_bgez
|address
|
|
|0xf5, addr
|Jump if Q >= 0
|-
!chan_hang
|
|
|
|0xf3
|Infinite delay.
|-
!chan_reservenotes
|numNotes
|
|
|0xf2, u8
|Reserve X notes for exclusive use by this channel (dropping earlier reservations).
|-
!chan_unreservenotes
|numNotes
|
|
|0xf1
|Drop all earlier reservations made by this channel.
|-
!chan_dyncall
|
|
|
|0xe4
|If Q != -1, make a function call to position dyntable[Q], where dyntable is a channel-specific u16 array which can set by <code>setdyntable</code>/<code>dynsetdyntable</code>.
|-
!chan_setvibratodelay
|
|
|
|0xe3, u8
|Set delay until vibrato starts for each note.
|-
!chan_setvibratoextentlinear
|
|
|
|0xe2, u8, u8, u8
|Set vibrato extent for each note as a function that starts at X, goes up linearly to Y over a time span given by Z, then stays there.
|-
!chan_setvibratoratelinear
|
|
|
|0xe1, u8, u8, u8
|Like above except for vibrato rate.
|-
!chan_setvolscale
|volume
|
|
|0xe0, u8
|Set scale factor for volume (0…255 = none to twice normal).
|-
!chan_setvol
|volume
|
|
|0xdf, u8
|Set scale factor #2 for volume (0…255 = none to twice normal). The two scale factors are separately controlled by outer audio logic, e.g. when changing between rooms, when playing sound effects, etc. The game almost exclusively uses setvol, so that should probably be preferred, but setvolscale shows up in a few locations in the sound effect sequence.
|-
!chan_freqscale
|value
|
|
|0xde, u16
|Pitch bend using a raw frequency multiplier X/2^15.
|-
!chan_setpan
|pan
|
|
|0xdd, u8
|Set the pan for this channel (0…128)
|-
!chan_setpanchanweight
|
|
|
|0xdc, u8
|The pan for each note will be computed as W * channel pan + (1 - W) * note pan. This sets W (0…128 maps to 0…1). W defaults to 1.0.
|-
!chan_transpose
|semitones
|
|
|0xdb, s8
|Set transposition in semitones.
|-
!chan_setenvelope
|address
|
|
|0xda, addr
|Set ADSR envelope. See below for format.
|-
!chan_setdecayrelease
|rate
|
|
|0xd9, u8
|Set ADSR decay/release rate.
|-
!chan_setvibratoextent
|extent
|
|
|0xd8, u8
|Set vibrato extent.
|-
!chan_setvibratorate
|rate
|
|
|0xd7, u8
|Set vibrato rate.
|-
!chan_setupdatesperframe
|
|
|
|0xd6, u8
|Seems like it was meant to set the number of updates per frame? But it doesn’t actually do anything.
|-
!chan_setreverb
|reverb
|
|
|0xd4, u8
|Set amount of reverb (or “dry/wet mix”?).
|-
!chan_pitchbend
|bend
|
|
|0xd3, s8
|Pitch bend by <= 1 octave in either direction (-127…127).
|-
!chan_setsustain
|volume
|
|
|0xd2, u8
|Set ADSR sustain volume.
|-
!chan_setnoteallocationpolicy
|policyMask
|
|
|0xd1, u8
|Set note allocation policy for channel. See the description for sequence scripts.
|-
!chan_stereoheadseteffects
|enable
|
|
|0xd0, u8
|Enable (1) or disable (0) some pan/volume effects related to stereo/headset. I don’t know which ones precisely – pan ''is'' still taken into account even with this disabled. With this disabled, stereo/headset gets the same output.
|-
!chan_setval
|value
|
|
|0xcc, u8
|Set Q to a constant.
|-
!chan_readseq
|address
|
|
|0xcb, addr
|Set Q to sequenceData[X + Q].
|-
!chan_setmutebhv
|
|
|
|0xca, u8
|Set mute behavior for this channel.
|-
!chan_bitand
|value
|
|
|0xc9, u8
|Bitand Q by a constant.
|-
!chan_subtract
|value
|
|
|0xc8, u8
|Subtract a constant from Q.
|-
!chan_writeseq
|
|address
|
|0xc7, u8, addr
|Overwrite the byte at the given position in the sequence script by (Q + X).
|-
!chan_setbank
|bank
|
|
|0xc6, u8
|Switch bank within instrument bank sets, to the X’th bank, 0-indexed, counting from the end.
|-
!chan_dynsetdyntable
|
|
|
|0xc5
|If Q != -1, set dyntable to point to position dyntable[Q] in the sequence data.
|-
!chan_largenoteson
|
|
|
|0xc4
|Set notes for this channel to use “large notes” format. SM64 does this for all channels. (See <code>note</code> vs. <code>shortnote</code> in the layer section below.)
|-
!chan_largenotesoff
|
|
|
|0xc3
|Set notes for this channel to use “short notes” format.
|-
!chan_setdyntable
|address
|
|
|0xc2, addr
|Set dyntable to point to a given u16 array from the sequence data.
|-
!chan_setinstr
|instrument
|
|
|0xc1, u8
|Set instrument (program?) within bank. 0x80-0x83 set raw waves (sawtooth, triangle, sine, square), 0x7f is special, otherwise 0-indexed.
|-
!chan_dynsetlayer
|
|
|
|0xb0-0xbf
|If Q != -1, start layer N, with layer script given by dyntable[Q].
|-
!chan_freelayer
|layer
|
|
|0xa0-0xaf
|Stop layer N.
|-
!chan_setlayer
|layer
|address
|
|0x90-0x9f, addr
|Start layer N, with layer script starting at address X.
|-
!chan_ioreadval
|
|
|
|0x80-0x8f
|Set Q to IO[N], where IO is an array of bytes that can be read/written by both the game and the channel script. If N < 4, IO[N] is then set to -1.
|-
!chan_iowriteval
|
|
|
|0x70-0x7f
|Set IO[N] to Q.
|-
!chan_setnotepriority
|
|
|
|0x60-0x6f
|Set note priority for later notes played on this channel to N. When the game wants to play a note and there aren’t any free notes available, a note with smaller or equal priority is discarded. Should be >= 2; 0 and 1 have internal meaning. Defaults to 3.
|-
!chan_ioreadvalsub
|
|
|
|0x50-0x5f
|Decrease Q by IO[N].
|-
!chan_ioreadval2
|
|
|
|0x40-0x4f, u8
|Set Q to IO2[X], where IO2 is the IO array for channel N.
|-
!chan_iowriteval2
|
|
|
|0x30-0x3f, u8
|Set IO2[X] to Q, where IO2 is the IO array for channel N.
|-
!chan_disablechannel
|channel
|
|
|0x20-0x2f
|Disable channel N for the parent sequence.
|-
!chan_startchannel
|channel
|address
|
|0x10-0x1f, addr
|Start channel N for the parent sequence, with channel script starting at address X.
|-
!chan_testlayerfinished
|layer
|
|
|0x00-0x0f
|Set Q to 1 or 0, depending on whether layer N has been disabled (either forcibly or by finishing its script).
|}

=== Layer commands ===
{| class="wikitable"
!Mnemonic
!Param 1
!Param 2
!Param 3
!Param 4
!Bytecode (US)
!Description
|-
!layer_end
|
|
|
|
|0xff
|End of script, loop or function
|-
!layer_call
|address
|
|
|
|0xfc, addr
|Call a function
|-
!layer_jump
|address
|
|
|
|0xfb, addr
|Jump to a point in the layer script
|-
!layer_loop
|iterations
|
|
|
|0xf8, u8
|Repeat until <code>loopend</code> for X iterations (256 if X = 0)
|-
!layer_loopend
|
|
|
|
|0xf7
|Loop end marker
|-
!layer_setshortnotedurationfromtable
|
|
|
|
|0xe0-0xef
|Set the duration for future short notes to table[N], where table defaults to <code>{229, 203, 177, 151, 139, 126, 113, 100, 87, 74, 61, 48, 36, 23, 10, 0}</code> and can be set by <code>setshortnotedurationtable</code>.
|-
!layer_setshortnotevelocityfromtable
|
|
|
|
|0xd0-0xdf
|Set the velocity for future short notes to table[N], where table defaults to <code>{12, 25, 38, 51, 57, 64, 71, 76, 83, 89, 96, 102, 109, 115, 121, 127}</code> and can be set by <code>setshortnotevelocitytable</code>.
|-
!layer_setpan
|pan
|
|
|
|0xca, u8
|Set the pan for this layer (0…128).
|-
!layer_setshortnoteduration
|duration
|
|
|
|0xc9, u8
|Set the duration for future short notes.
|-
!layer_disableportamento
|
|
|
|
|0xc8
|Disable portamento for later notes.
|-
!layer_portamento
|
|
|
|
|0xc7, u8, u8, u8/var
|Enable portamento (aka glissando; continuously sliding pitch). X describes the mode of operation somehow using its 0x80 bit and a value 0-5 in its lower-order bits. Y describes the target pitch. Z gives the duration, and is a u8 if the 0x80 bit is set, otherwise a var.
|-
!layer_setinstr
|instrument
|
|
|
|0xc6, u8
|Set instrument/program. Similar to the channel command, except arguments 0x7f and above are not supported.
|-
!layer_somethingoff
|
|
|
|
|0xc5
|Turn off some bool related to how notes decay somehow? (This is the default.)
|-
!layer_somethingon
|
|
|
|
|0xc4
|Turn on the same thing.
|-
!layer_setshortnotedefaultplaypercentage
|percentage
|
|
|
|0xc3, var
|Set the default play percentage for short notes (see below).
|-
!layer_transpose
|semitones
|
|
|
|0xc2, u8
|Set transposition in semitones.
|-
!layer_setshortnotevelocity
|velocity
|
|
|
|0xc1, u8
|Set velocity for future short notes.
|-
!layer_delay
|ticks
|
|
|
|0xc0, var
|Delay for N ticks
|-
!layer_note0
|pitch
|percentage
|velocity
|duration
|0x00-0x3f, var, u8, u8
|Play note with specified pitch, percentage, velocity and duration. Only valid if channel is set to “large notes”.
|-
!layer_note1
|pitch
|percentage
|velocity
|
|0x40-0x7f, var, u8
|Play note with specified pitch, percentage and velocity and duration of 0. Only valid if channel is set to “large notes”.
|-
!layer_note2
|pitch
|velocity
|duration
|
|0x80-0xbf, u8, u8
|Play note with specified pitch, velocity and duration. Only valid if channel is set to “large notes”.
|-
!layer_smallnote0
|pitch
|percentage
|
|
|0x00-0x3f, var
|Play note with specified pitch and percentage and velocity and duration set with layer_setshortnotevelocity and layer_setshortnoteduration. Only valid if channel is set to “small notes”.
|-
!layer_smallnote1
|pitch
|
|
|
|0x40-0x7f
|Play note with specified pitch and the default play percentage, as set by layer_setshortnotedefaultplaypercentage (there is no built-in default; using it without that command will read uninitialized memory). Velocity and duration is set like in layer_smallnote0. Only valid if channel is set to “small notes”.
|-
!layer_smallnote2
|pitch
|
|
|
|0x80-0xbf
|Play note with specified pitch and the previous play percentage. Velocity and duration is set like in layer_smallnote0. Only valid if channel is set to “small notes”.
|}

== See also ==

* [https://www.smwcentral.net/?p=section&s=sm64music Custom music] for SM64 on SMW Central
* [https://hackmd.io/opEB-OmxRa26P8h8pA-x7w m64 format] posted on HackMD
[[Category:Audio]]

Warp

2025-11-22T21:12:11Z

Tenry: More details on how to connect places.

Warps are used to teleport Mario from one location to another in the same area, a different area or different level. They can be connected to each other within a level, between different areas or levels.

Warps are defined per area by the following properties:

* '''Warp type''': one of Warp, Painting, Instant
* '''Warp ID''', also known as source ID: value from 0x00 to 0xFF unique per area
** Commonly set to 0x0A for the area starting location
** IDs 0xF0 - 0xF3, 0xF8, 0xF9 and 0xFA have special meanings
*** 0xF0 is used on level success (after Mario grabbed a star)
*** 0xF1 is used on level failure
* '''Destination level'''
* '''Destination area'''
* '''Destination node''': ID given to the warp object (param 2) that's placed in the target area.
In order to connect two places with each other, you would need to:

# Place a ''warps'' object in the destination area (e.g. "Warps 60 (Instant Active)").
## Give the warp object an ID (param 2) unique in the destination area, for example 0xB1.
# Define the warp node in the source area.
## Give it an ID unique to the current area and not reserved for special purposes (see above), for example 0xA1.
## For the destination node, select the warp object ID, for example 0xB1.
# Place a "Warp" object in the source area that shall trigger the warp.
## Set param 2 to the warp node to trigger (as defined in the source area), for example 0xA1.
## Optionally set param 1 to specify the radius of the warp (in 10 units). Default (0x00) is 50 units, 0xFF is 10,000 units. The height is always 50 units.

Using the example values above, a warp object may trigger the warp node 0xA1 in the source area, teleporting Mario to the warp object 0xB1 in the destination.

In order to create a warp to the other direction, simple follow the same steps again, with source and destination areas reversed.
[[Category:Level]]

Music sequence

2025-11-21T20:01:18Z

Tenry: Use #include syntax for manual sequence format

dasdasdasdMusic in Super Mario 64 is controlled by sequence files. They are in .m64 format, which is similar to [[wikipedia:MIDI|MIDI]]. A sequence file has a sequence script, that can spawn channels, which have channel scripts, that can spawn layers (also known as tracks), which have layer scripts that can play notes. Each note is performed using an instrument from a sound bank. A sequence file can use multiple banks. The mapping from sequences to sound banks is described in '''sound/sequences.json'''. Channels can switch between banks using a command. However, in practice most sequences limit themselves to a single sound bank. The main exception is sequence 0, which is responsible for sound effects.

A sequence may play up to 16 channels with up to 4 layers per channel. Several notes can be played simultaneously on a single layer.

A sequence is played as long as the sequence script is not ended. A channel (including layers) is active as long as the channel script is not ended.

== Note properties ==
A note can be played by the commands <code>layer_note0</code>, <code>layer_note1</code> and <code>layer_note2</code> (only valid if <code>chan_largenoteson</code> has been called on the layer's channel) or <code>layer_smallnote0</code>, <code>layer_smallnote1</code> and <code>layer_smallnote2</code> (only valid if <code>chan_largenotesoff</code> has been called on the layer's channel; default state). A note is defined by the following properties:

=== Pitch ===
Also known as '''note'''. The pitch defines the frequency in which the instrument is to be played. See list of notes below for available pitches.

=== Play percentage ===
Also known as '''timestamp'''. This defines the note value, such as half or quarter note. This also implies a layer delay of the same amount. See note values below for possible values.

=== Velocity ===
This is the volume of the note.

=== Duration ===
Also known as '''gate''' or '''gate time'''. A value of 0 menas the note is heard during the whole percentage, 128 is half of the percentage and 255 almost none.

== List of notes ==
This is a list of notes as used by the ''layer_note#'' and ''layer_smallnote#'' commands.
{| class="wikitable"
!Octave
!Note
!Decimal
!Hex (note0)
!Hex (note1)
!Hex (note2)
|-
! rowspan="3" |0
!A
|0
|0x00
|0x40
|0x80
|-
!A♯/B♭
|1
|0x01
|0x41
|0x81
|-
!B
|2
|0x02
|0x42
|0x82
|-
! rowspan="12" |1
!C
|3
|0x03
|0x43
|0x83
|-
!C♯/D♭
|4
|0x04
|0x44
|0x84
|-
!D
|5
|0x05
|0x45
|0x85
|-
!D♯/E♭
|6
|0x06
|0x46
|0x86
|-
!E
|7
|0x07
|0x47
|0x87
|-
!F
|8
|0x08
|0x48
|0x88
|-
!F♯/G♭
|9
|0x09
|0x49
|0x89
|-
!G
|10
|0x0A
|0x4A
|0x8A
|-
!G♯/A♭
|11
|0x0B
|0x4B
|0x8B
|-
!A
|12
|0x0C
|0x4C
|0x8C
|-
!A♯/B♭
|13
|0x0D
|0x4D
|0x8D
|-
!B
|14
|0x0E
|0x4E
|0x8E
|-
! rowspan="12" |2
!C
|15
|0x0F
|0x4F
|0x8F
|-
!C♯/D♭
|16
|0x10
|0x50
|0x90
|-
!D
|17
|0x11
|0x51
|0x91
|-
!D♯/E♭
|18
|0x12
|0x52
|0x92
|-
!E
|19
|0x13
|0x53
|0x93
|-
!F
|20
|0x14
|0x54
|0x94
|-
!F♯/G♭
|21
|0x15
|0x55
|0x95
|-
!G
|22
|0x16
|0x56
|0x96
|-
!G♯/A♭
|23
|0x17
|0x57
|0x97
|-
!A
|24
|0x18
|0x58
|0x98
|-
!A♯/B♭
|25
|0x19
|0x59
|0x99
|-
!B
|26
|0x1A
|0x5A
|0x9A
|-
! rowspan="12" |3
!C
|27
|0x1B
|0x5B
|0x9B
|-
!C♯/D♭
|28
|0x1C
|0x5C
|0x9C
|-
!D
|29
|0x1D
|0x5D
|0x9D
|-
!D♯/E♭
|30
|0x1E
|0x5E
|0x9E
|-
!E
|31
|0x1F
|0x5F
|0x9F
|-
!F
|32
|0x20
|0x60
|0xA0
|-
!F♯/G♭
|33
|0x21
|0x61
|0xA1
|-
!G
|34
|0x22
|0x62
|0xA2
|-
!G♯/A♭
|35
|0x23
|0x63
|0xA3
|-
!A
|36
|0x24
|0x64
|0xA4
|-
!A♯/B♭
|37
|0x25
|0x65
|0xA5
|-
!B
|38
|0x26
|0x66
|0xA6
|-
! rowspan="12" |4
!C
|39
|0x27
|0x67
|0xA7
|-
!C♯/D♭
|40
|0x28
|0x68
|0xA8
|-
!D
|41
|0x29
|0x69
|0xA9
|-
!D♯/E♭
|42
|0x2A
|0x6A
|0xAA
|-
!E
|43
|0x2B
|0x6B
|0xAB
|-
!F
|44
|0x2C
|0x6C
|0xAC
|-
!F♯/G♭
|45
|0x2D
|0x6D
|0xAD
|-
!G
|46
|0x2E
|0x6E
|0xAE
|-
!G♯/A♭
|47
|0x2F
|0x6F
|0xAF
|-
!A
|48
|0x30
|0x70
|0xB0
|-
!A♯/B♭
|49
|0x31
|0x71
|0xB1
|-
!B
|50
|0x32
|0x72
|0xB2
|-
! rowspan="12" |5
!C
|51
|0x33
|0x73
|0xB3
|-
!C♯/D♭
|52
|0x34
|0x74
|0xB4
|-
!D
|53
|0x35
|0x75
|0xB5
|-
!D♯/E♭
|54
|0x36
|0x76
|0xB6
|-
!E
|55
|0x37
|0x77
|0xB7
|-
!F
|56
|0x38
|0x78
|0xB8
|-
!F♯/G♭
|57
|0x39
|0x79
|0xB9
|-
!G
|58
|0x3A
|0x7A
|0xBA
|-
!G♯/A♭
|59
|0x3B
|0x7B
|0xBB
|-
!A
|60
|0x3C
|0x7C
|0xBC
|-
!A♯/B♭
|61
|0x3D
|0x7D
|0xBD
|-
!B
|62
|0x3E
|0x7E
|0xBE
|-
!6
!C
|63
|0x3F
|0x7F
|0xBF
|}

== Note durations ==
The effective duration of a note and the delay commands is based on the currently set sequence tempo. The duration of a single tick in seconds can be calculated using the following formular: <code>time = 1.25 / tempo</code>.
{| class="wikitable"
!Note
!Ticks
!Duration (120 BPM)
|-
|whole
|192
|2s
|-
|half dotted (2nd + 4th)
|144
|1.5s
|-
|half
|96
|1s
|-
|quarter dottet (4th + 8th)
|72
|0.75s
|-
|quarter (4th)
|48
|0.5s
|-
|eighth dottet (8th + 16th)
|36
|0.375s
|-
|quarter tuplet
|32
|0.333s
|-
|eighth (8th)
|24
|0.25s
|-
|sixteenth dottet (16th + 32th)
|18
|0.1875s
|-
|eigthth tuplet
|16
|0.1666s
|-
|sixteenth (16th)
|12
|0.125s
|-
|32th dottet (32th + 64th)
|9
|0.09375s
|-
|sixteenth tuplet (16th)
|8
|0.08333s
|-
|32th
|6
|0.0625s
|-
|32th tuplet
|4
|0.041666s
|-
|64th
|3
|0.03125s
|-
|64th tuplet
|2
|0.0208333s
|}

== Create sequences ==
There are several ways for creating new sequence files.

=== Seq64 ===
Seq64 is a GUI program for editing sequence files for Super Mario 64 and other Nintendo games. It also features full MIDI importing and exporting.

https://github.com/sauraen/seq64

=== Manually ===
Sequence files can also be created manually in a textual format. Create a new assembly file in the sequences directory, for example '''sound/sequences/us/23_custom_sequence.s'''. This file should begin with the following header:<syntaxhighlight lang="asm">
#include "seq_macros.inc"
.section .rodata
.align 0
</syntaxhighlight>Next you can write down a series of commands. See '''include/seq_macros.inc''' or https://hackmd.io/opEB-OmxRa26P8h8pA-x7w for a list of available commands.

== Commands ==

=== Sequence commands ===
{| class="wikitable"
!Mnemonic
!Param 1
!Param 2
!Bytecode (US)
!Description
|-
!seq_end
|
|
|0xff
|End of script, loop or function
|-
!seq_delay1
|
|
|0xfe
|Delay for 1 tick
|-
!seq_delay
|ticks
|
|0xfd, var
|Delay for X ticks
|-
!seq_call
|address
|
|0xfc, addr
|Call a function
|-
!seq_jump
|address
|
|0xfb, addr
|Jump to a point in the sequence script
|-
!seq_beqz
|address
|
|0xfa, addr
|Jump if Q == 0, where Q is an s8 used to hold temporary sequence script state
|-
!seq_bltz
|address
|
|0xf9, addr
|Jump if Q < 0
|-
!seq_loop
|iterations
|
|0xf8, u8
|Repeat until <code>loopend</code> for X iterations (256 if X = 0)
|-
!seq_loopend
|
|
|0xf7
|Loop end marker
|-
!seq_bgez
|address
|
|0xf5, addr
|Jump if Q >= 0
|-
!seq_reservenotes
|numNotes
|
|0xf2, u8
|Reserve X notes for exclusive use by this sequence (dropping earlier reservations). A limited number of notes can be played at once (configurable per level, usually 16); if more than that are played, an existing one will be stopped and reused. This command can prevent that from happening across sequences.
|-
!seq_unreservenotes
|
|
|0xf1
|Drop all earlier reservations made by this sequence.
|-
!seq_transpose
|semitones
|
|0xdf, s8
|Set transposition in semitones.
|-
!seq_transposerel
|semitones
|
|0xde, s8
|Change transposition by some delta.
|-
!seq_settempo
|tempo
|
|0xdd, u8
|Set tempo in BPM.
|-
!seq_addtempo
|tempo
|
|0xdc, s8
|Change tempo by some delta.
|-
!seq_setvol
|volume
|
|0xdb, u8
|Set volume scale (0…255 = none to twice normal).
|-
!seq_changevol
|volume
|
|0xda, s8
|Change volume scale by some delta.
|-
!seq_initchannels
|channelMask
|
|0xd7, u16
|Initialize channels (bitmask). This copies mute behavior and note allocation policy.
|-
!seq_disablechannels
|channelMask
|
|0xd6, u16
|Uninitialize channels (bitmask).
|-
!seq_setmutescale
|mulitplier
|
|0xd5, s8
|Set volume multiplier for muted mode (0…127).
|-
!seq_mute
|
|
|0xd4
|Set sequence to muted mode. Depending on what behavior has been set this will do different things; from lowering volume to not running scripts.
|-
!seq_setmutebhv
|bitmask
|
|0xd3, u8
|Set mute behavior (bitmask). Bit 0x20 lowers volume, bit 0x40 does something to layers, and bit 0x80 pauses the sequence script. Default mute behavior is to have all of those bits set.
|-
!seq_setshortnotevelocitytable
|address
|
|0xd2, addr
|Set velocity table for short notes (see further down). Target should be an array of bytes in the sequence data of length 16.
|-
!seq_setshortnotedurationtable
|address
|
|0xd1, addr
|Set duration table for short notes (see further down). Target should be an array of bytes in the sequence data of length 16.
|-
!seq_setnoteallocationpolicy
|policyMask
|
|0xd0, u8
|Set note allocation policy (bitmask). If bit 0x1 is set, it will try to steal notes back from what was previously played on the same layer. If bit 0x2 is set, notes will be allocated exclusively from the channel’s reserved notes, else if 0x4 is set, from the channel’s or sequence’s reserved notes, else if 0x8 is set, from unreserved notes, otherwise from all sources. Not used by the game.
|-
!seq_setval
|value
|
|0xcc, u8
|Set Q to a constant.
|-
!seq_bitand
|value
|
|0xc9, u8
|Bitand Q by a constant.
|-
!seq_subtract
|value
|
|0xc8, u8
|Subtract a constant from Q.
|-
!seq_startchannel
|channel
|address
|0x90-0x9f, addr
|Start channel N, with a given channel script.
|-
!seq_getvariation
|
|
|0x80-0x8f
|Set Q to the variation bit, which is initially either 0 or 0x80 (i.e. -128, since Q is s8). This bit comes from the sequence load command. For instance, to play the Koopa shell music, the game plays sequence 0x8E, which is the same as sequence 0xE but with the variation bit set.
|-
!seq_setvariation
|
|
|0x70-0x7f
|Set the variation bit to Q.
|-
!seq_subvariation
|
|
|0x50-0x5f
|Subtract the variation bit from Q.
|-
!seq_testchdisabled
|channel
|
|0x00-0x0f
|Set Q to 1 or 0, depending on whether channel N has been disabled by channel script.
|}

=== Channel commands ===
{| class="wikitable"
!Mnemonic
!Param 1
!Param 2
!Param 3
!Bytecode (US)
!Description
|-
!chan_end
|
|
|
|0xff
|End of script, loop or function
|-
!chan_delay1
|
|
|
|0xfe
|Delay for 1 tick
|-
!chan_delay
|ticks
|
|
|0xfd, var
|Delay for X ticks
|-
!chan_call
|address
|
|
|0xfc, addr
|Call a function
|-
!chan_jump
|address
|
|
|0xfb, addr
|Jump to a point in the channel script
|-
!chan_beqz
|address
|
|
|0xfa, addr
|Jump if Q == 0, where Q is an s8 used to hold temporary channel script state
|-
!chan_bltz
|address
|
|
|0xf9, addr
|Jump if Q < 0
|-
!chan_loop
|iterations
|
|
|0xf8, u8
|Repeat until <code>loopend</code> for X iterations (256 if X = 0)
|-
!chan_loopend
|
|
|
|0xf7
|Loop end marker
|-
!chan_break
|
|
|
|0xf6
|Decrease loop/function stack depth by 1. Combine with a jump to break out of a loop.
|-
!chan_bgez
|address
|
|
|0xf5, addr
|Jump if Q >= 0
|-
!chan_hang
|
|
|
|0xf3
|Infinite delay.
|-
!chan_reservenotes
|numNotes
|
|
|0xf2, u8
|Reserve X notes for exclusive use by this channel (dropping earlier reservations).
|-
!chan_unreservenotes
|numNotes
|
|
|0xf1
|Drop all earlier reservations made by this channel.
|-
!chan_dyncall
|
|
|
|0xe4
|If Q != -1, make a function call to position dyntable[Q], where dyntable is a channel-specific u16 array which can set by <code>setdyntable</code>/<code>dynsetdyntable</code>.
|-
!chan_setvibratodelay
|
|
|
|0xe3, u8
|Set delay until vibrato starts for each note.
|-
!chan_setvibratoextentlinear
|
|
|
|0xe2, u8, u8, u8
|Set vibrato extent for each note as a function that starts at X, goes up linearly to Y over a time span given by Z, then stays there.
|-
!chan_setvibratoratelinear
|
|
|
|0xe1, u8, u8, u8
|Like above except for vibrato rate.
|-
!chan_setvolscale
|volume
|
|
|0xe0, u8
|Set scale factor for volume (0…255 = none to twice normal).
|-
!chan_setvol
|volume
|
|
|0xdf, u8
|Set scale factor #2 for volume (0…255 = none to twice normal). The two scale factors are separately controlled by outer audio logic, e.g. when changing between rooms, when playing sound effects, etc. The game almost exclusively uses setvol, so that should probably be preferred, but setvolscale shows up in a few locations in the sound effect sequence.
|-
!chan_freqscale
|value
|
|
|0xde, u16
|Pitch bend using a raw frequency multiplier X/2^15.
|-
!chan_setpan
|pan
|
|
|0xdd, u8
|Set the pan for this channel (0…128)
|-
!chan_setpanchanweight
|
|
|
|0xdc, u8
|The pan for each note will be computed as W * channel pan + (1 - W) * note pan. This sets W (0…128 maps to 0…1). W defaults to 1.0.
|-
!chan_transpose
|semitones
|
|
|0xdb, s8
|Set transposition in semitones.
|-
!chan_setenvelope
|address
|
|
|0xda, addr
|Set ADSR envelope. See below for format.
|-
!chan_setdecayrelease
|rate
|
|
|0xd9, u8
|Set ADSR decay/release rate.
|-
!chan_setvibratoextent
|extent
|
|
|0xd8, u8
|Set vibrato extent.
|-
!chan_setvibratorate
|rate
|
|
|0xd7, u8
|Set vibrato rate.
|-
!chan_setupdatesperframe
|
|
|
|0xd6, u8
|Seems like it was meant to set the number of updates per frame? But it doesn’t actually do anything.
|-
!chan_setreverb
|reverb
|
|
|0xd4, u8
|Set amount of reverb (or “dry/wet mix”?).
|-
!chan_pitchbend
|bend
|
|
|0xd3, s8
|Pitch bend by <= 1 octave in either direction (-127…127).
|-
!chan_setsustain
|volume
|
|
|0xd2, u8
|Set ADSR sustain volume.
|-
!chan_setnoteallocationpolicy
|policyMask
|
|
|0xd1, u8
|Set note allocation policy for channel. See the description for sequence scripts.
|-
!chan_stereoheadseteffects
|enable
|
|
|0xd0, u8
|Enable (1) or disable (0) some pan/volume effects related to stereo/headset. I don’t know which ones precisely – pan ''is'' still taken into account even with this disabled. With this disabled, stereo/headset gets the same output.
|-
!chan_setval
|value
|
|
|0xcc, u8
|Set Q to a constant.
|-
!chan_readseq
|address
|
|
|0xcb, addr
|Set Q to sequenceData[X + Q].
|-
!chan_setmutebhv
|
|
|
|0xca, u8
|Set mute behavior for this channel.
|-
!chan_bitand
|value
|
|
|0xc9, u8
|Bitand Q by a constant.
|-
!chan_subtract
|value
|
|
|0xc8, u8
|Subtract a constant from Q.
|-
!chan_writeseq
|
|address
|
|0xc7, u8, addr
|Overwrite the byte at the given position in the sequence script by (Q + X).
|-
!chan_setbank
|bank
|
|
|0xc6, u8
|Switch bank within instrument bank sets, to the X’th bank, 0-indexed, counting from the end.
|-
!chan_dynsetdyntable
|
|
|
|0xc5
|If Q != -1, set dyntable to point to position dyntable[Q] in the sequence data.
|-
!chan_largenoteson
|
|
|
|0xc4
|Set notes for this channel to use “large notes” format. SM64 does this for all channels. (See <code>note</code> vs. <code>shortnote</code> in the layer section below.)
|-
!chan_largenotesoff
|
|
|
|0xc3
|Set notes for this channel to use “short notes” format.
|-
!chan_setdyntable
|address
|
|
|0xc2, addr
|Set dyntable to point to a given u16 array from the sequence data.
|-
!chan_setinstr
|instrument
|
|
|0xc1, u8
|Set instrument (program?) within bank. 0x80-0x83 set raw waves (sawtooth, triangle, sine, square), 0x7f is special, otherwise 0-indexed.
|-
!chan_dynsetlayer
|
|
|
|0xb0-0xbf
|If Q != -1, start layer N, with layer script given by dyntable[Q].
|-
!chan_freelayer
|layer
|
|
|0xa0-0xaf
|Stop layer N.
|-
!chan_setlayer
|layer
|address
|
|0x90-0x9f, addr
|Start layer N, with layer script starting at address X.
|-
!chan_ioreadval
|
|
|
|0x80-0x8f
|Set Q to IO[N], where IO is an array of bytes that can be read/written by both the game and the channel script. If N < 4, IO[N] is then set to -1.
|-
!chan_iowriteval
|
|
|
|0x70-0x7f
|Set IO[N] to Q.
|-
!chan_setnotepriority
|
|
|
|0x60-0x6f
|Set note priority for later notes played on this channel to N. When the game wants to play a note and there aren’t any free notes available, a note with smaller or equal priority is discarded. Should be >= 2; 0 and 1 have internal meaning. Defaults to 3.
|-
!chan_ioreadvalsub
|
|
|
|0x50-0x5f
|Decrease Q by IO[N].
|-
!chan_ioreadval2
|
|
|
|0x40-0x4f, u8
|Set Q to IO2[X], where IO2 is the IO array for channel N.
|-
!chan_iowriteval2
|
|
|
|0x30-0x3f, u8
|Set IO2[X] to Q, where IO2 is the IO array for channel N.
|-
!chan_disablechannel
|channel
|
|
|0x20-0x2f
|Disable channel N for the parent sequence.
|-
!chan_startchannel
|channel
|address
|
|0x10-0x1f, addr
|Start channel N for the parent sequence, with channel script starting at address X.
|-
!chan_testlayerfinished
|layer
|
|
|0x00-0x0f
|Set Q to 1 or 0, depending on whether layer N has been disabled (either forcibly or by finishing its script).
|}

=== Layer commands ===
{| class="wikitable"
!Mnemonic
!Param 1
!Param 2
!Param 3
!Param 4
!Bytecode (US)
!Description
|-
!layer_end
|
|
|
|
|0xff
|End of script, loop or function
|-
!layer_call
|address
|
|
|
|0xfc, addr
|Call a function
|-
!layer_jump
|address
|
|
|
|0xfb, addr
|Jump to a point in the layer script
|-
!layer_loop
|iterations
|
|
|
|0xf8, u8
|Repeat until <code>loopend</code> for X iterations (256 if X = 0)
|-
!layer_loopend
|
|
|
|
|0xf7
|Loop end marker
|-
!layer_setshortnotedurationfromtable
|
|
|
|
|0xe0-0xef
|Set the duration for future short notes to table[N], where table defaults to <code>{229, 203, 177, 151, 139, 126, 113, 100, 87, 74, 61, 48, 36, 23, 10, 0}</code> and can be set by <code>setshortnotedurationtable</code>.
|-
!layer_setshortnotevelocityfromtable
|
|
|
|
|0xd0-0xdf
|Set the velocity for future short notes to table[N], where table defaults to <code>{12, 25, 38, 51, 57, 64, 71, 76, 83, 89, 96, 102, 109, 115, 121, 127}</code> and can be set by <code>setshortnotevelocitytable</code>.
|-
!layer_setpan
|pan
|
|
|
|0xca, u8
|Set the pan for this layer (0…128).
|-
!layer_setshortnoteduration
|duration
|
|
|
|0xc9, u8
|Set the duration for future short notes.
|-
!layer_disableportamento
|
|
|
|
|0xc8
|Disable portamento for later notes.
|-
!layer_portamento
|
|
|
|
|0xc7, u8, u8, u8/var
|Enable portamento (aka glissando; continuously sliding pitch). X describes the mode of operation somehow using its 0x80 bit and a value 0-5 in its lower-order bits. Y describes the target pitch. Z gives the duration, and is a u8 if the 0x80 bit is set, otherwise a var.
|-
!layer_setinstr
|instrument
|
|
|
|0xc6, u8
|Set instrument/program. Similar to the channel command, except arguments 0x7f and above are not supported.
|-
!layer_somethingoff
|
|
|
|
|0xc5
|Turn off some bool related to how notes decay somehow? (This is the default.)
|-
!layer_somethingon
|
|
|
|
|0xc4
|Turn on the same thing.
|-
!layer_setshortnotedefaultplaypercentage
|percentage
|
|
|
|0xc3, var
|Set the default play percentage for short notes (see below).
|-
!layer_transpose
|semitones
|
|
|
|0xc2, u8
|Set transposition in semitones.
|-
!layer_setshortnotevelocity
|velocity
|
|
|
|0xc1, u8
|Set velocity for future short notes.
|-
!layer_delay
|ticks
|
|
|
|0xc0, var
|Delay for N ticks
|-
!layer_note0
|pitch
|percentage
|velocity
|duration
|0x00-0x3f, var, u8, u8
|Play note with specified pitch, percentage, velocity and duration. Only valid if channel is set to “large notes”.
|-
!layer_note1
|pitch
|percentage
|velocity
|
|0x40-0x7f, var, u8
|Play note with specified pitch, percentage and velocity and duration of 0. Only valid if channel is set to “large notes”.
|-
!layer_note2
|pitch
|velocity
|duration
|
|0x80-0xbf, u8, u8
|Play note with specified pitch, velocity and duration. Only valid if channel is set to “large notes”.
|-
!layer_smallnote0
|pitch
|percentage
|
|
|0x00-0x3f, var
|Play note with specified pitch and percentage and velocity and duration set with layer_setshortnotevelocity and layer_setshortnoteduration. Only valid if channel is set to “small notes”.
|-
!layer_smallnote1
|pitch
|
|
|
|0x40-0x7f
|Play note with specified pitch and the default play percentage, as set by layer_setshortnotedefaultplaypercentage (there is no built-in default; using it without that command will read uninitialized memory). Velocity and duration is set like in layer_smallnote0. Only valid if channel is set to “small notes”.
|-
!layer_smallnote2
|pitch
|
|
|
|0x80-0xbf
|Play note with specified pitch and the previous play percentage. Velocity and duration is set like in layer_smallnote0. Only valid if channel is set to “small notes”.
|}

== See also ==

* [https://www.smwcentral.net/?p=section&s=sm64music Custom music] for SM64 on SMW Central
* [https://hackmd.io/opEB-OmxRa26P8h8pA-x7w m64 format] posted on HackMD
[[Category:Audio]]

Limitation

2020-11-15T13:56:04Z

Tenry: Redirected page to Level limitations

#REDIRECT [[Level limitations]]

Sound

2020-11-11T18:27:26Z

Tenry: Redirected page to Sound effect

#REDIRECT [[Sound effect]]
[[Category:Audio]]

Music

2020-11-11T18:26:59Z

Tenry: Redirected page to Music sequence

#REDIRECT [[Music sequence]]
[[Category:Audio]]

Coordinate system

2020-11-11T16:38:02Z

Tenry: Created page with "In a 3D coordinate system, you have three axes to define a location or direction: '''X''', '''Y''' and '''Z'''. While in 2D X is (almost) universally from left (negative) to r..."

In a 3D coordinate system, you have three axes to define a location or direction: '''X''', '''Y''' and '''Z'''. While in 2D X is (almost) universally from left (negative) to right (positive) and Y is always vertically (sometimes from top to bottom, sometomes vice versa), in 3D games and engines the definition and relation of these coordinates differ. Super Mario 64 uses the right hand rule:

* '''+X''' points right
* '''+Y''' points up
* '''+Z''' points out of the screen

== Rotation ==
Super Mario 64 uses Euler angles '''pitch''', '''yaw''' and '''roll''' for rotation.

* '''pitch''' is the rotation about the '''X-axis''', measured from +Y
** unlike yaw and roll, pitch is bounded in '''±0x4000''' (90 degrees)
* '''yaw''' is the rotation about the '''Y-axis''', measured from (absolute) +Z
** positive yaw rotates clockwise, towards +X
* '''roll''' is the rotation about the '''Z-axis''', measured from +X

Levels

2020-11-11T16:14:15Z

Tenry: Redirected page to List of levels

#REDIRECT [[List of levels]]

Sound effect

2020-11-11T07:17:01Z

Tenry:

Sound effects in Super Mario 64 are played through the special [[Music sequence|sequence]] ''00_sound_player.s''. Although this seems to be an assembly file, assembly macros are used to actually output M64 sequence data, a proprietary format developed for Nintendo games.

Many sound effects are not plain wave data being played back, but use some simple coding for dynamically changing the pitch or playing two sounds simultaneously or sequentially.

The sample IDs that can be found in sound/samples do not relate to the IDs used in the code to play sound effect. Instead, you have to check for which channel the desired sound effect is set up to (see below) and check its table in ''00_sound_player.s'', such as <code>.channel59_table</code>. The first entry per table has the ID <code>0x00</code>.

== Channels ==
The sound player sequence uses 10 channels for sound playback. Each channel is purposed for a category of sound effect, hence specific sound effects are available for that channel only.
{| class="wikitable"
!Channel
!Description
|-
!0
|Jump, step, Mario actions etc.
|-
!1
|Moving, riding, coin
|-
!2
|Mario's voice
|-
!3 and 8
|Door, water, coin, chest, platform, cannon, key, yoshi and more
|-
!4
|Environmental sounds such as waterfall, elevator and wind
|-
!5 and 9
|Used for object sounds such as enemies, Bowser and cannon
|-
!6
|Air sounds
|-
!7
|Menu sounds including camera zoom and power meter
|}
[[Category:Audio]]

Sound effect

2020-11-11T07:16:47Z

Tenry: Created page with "Sound effects in Super Mario 64 are played through the special sequence ''00_sound_player.s''. Although this seems to be an assembly file, assembly macros a..."

Sound effects in Super Mario 64 are played through the special [[Music sequence|sequence]] ''00_sound_player.s''. Although this seems to be an assembly file, assembly macros are used to actually output M64 sequence data, a proprietary format developed for Nintendo games.

Many sound effects are not plain wave data being played back, but use some simple coding for dynamically changing the pitch or playing two sounds simultaneously or sequentially.

The sample IDs that can be found in sound/samples do not relate to the IDs used in the code to play sound effect. Instead, you have to check for which channel the desired sound effect is set up to (see below) and check its table in ''00_sound_player.s'', such as <code>.channel59_table</code>. The first entry per table has the ID <code>0x00</code>.

== Channels ==
The sound player sequence uses 10 channels for sound playback. Each channel is purposed for a category of sound effect, hence specific sound effects are available for that channel only.
{| class="wikitable"
!Channel
!Description
|-
|0
|Jump, step, Mario actions etc.
|-
|1
|Moving, riding, coin
|-
|2
|Mario's voice
|-
|3 and 8
|Door, water, coin, chest, platform, cannon, key, yoshi and more
|-
|4
|Environmental sounds such as waterfall, elevator and wind
|-
|5 and 9
|Used for object sounds such as enemies, Bowser and cannon
|-
|6
|Air sounds
|-
|7
|Menu sounds including camera zoom and power meter
|}
[[Category:Audio]]

Profiling

2020-11-11T07:04:08Z

Tenry: update explanation on reference bars

The game has a builtin profiler which can be enabled by setting <code>gShowProfiler</code> to ''TRUE'' in '''src/game/main.c'''. When enabled, colored bars are shown at the bottom of the screen. Pressing L switches from mode 0 and 1.

In mode 0, the colors of the top profilers have the following meanings:

* Red: sound duration
* Yellow: level script execution
* Orange: render duration

In mode 1, the colors of the top profilers have the following meanings:

* Red (left): sound update times
* Yellow: gfx time related
* Orange: gfx time related
* Red (right): vblank time related

The bottom line (blue, yellow, orange, red) are reference bars. Each one marks 1/60 of a second (NTSC). Since Super Mario 64 runs at 30 frames per second in the NTSC versions, two bars are available before the game starts to lag.

== See also ==

* [https://tcrf.net/Super_Mario_64_(Nintendo_64)/Debug_Content Debug Content] on The Cutting Room Floor

Profiling

2020-11-11T07:01:11Z

Tenry: add link to tcrf.net

The game has a builtin profiler which can be enabled by setting <code>gShowProfiler</code> to ''TRUE'' in '''src/game/main.c'''. When enabled, colored bars are shown at the bottom of the screen. Pressing L switches from mode 0 and 1.

In mode 0, the colors of the top profilers have the following meanings:

* Red: sound duration
* Yellow: level script execution
* Orange: render duration

In mode 1, the colors of the top profilers have the following meanings:

* Red (left): sound update times
* Yellow: gfx time related
* Orange: gfx time related
* Red (right): vblank time related

The bottom line (blue, yellow, orange, red) are reference bars for the maximum length.

== See also ==

* [https://tcrf.net/Super_Mario_64_(Nintendo_64)/Debug_Content Debug Content] on The Cutting Room Floor

Debugging

2020-11-11T07:00:32Z

Tenry: Redirected page to Profiling

#REDIRECT [[Profiling]]

Music sequence

2020-11-10T12:44:45Z

Tenry: add formular for calculating tick length

dasdasdasdMusic in Super Mario 64 is controlled by sequence files. They are in .m64 format, which is similar to [[wikipedia:MIDI|MIDI]]. A sequence file has a sequence script, that can spawn channels, which have channel scripts, that can spawn layers (also known as tracks), which have layer scripts that can play notes. Each note is performed using an instrument from a sound bank. A sequence file can use multiple banks. The mapping from sequences to sound banks is described in '''sound/sequences.json'''. Channels can switch between banks using a command. However, in practice most sequences limit themselves to a single sound bank. The main exception is sequence 0, which is responsible for sound effects.

A sequence may play up to 16 channels with up to 4 layers per channel. Several notes can be played simultaneously on a single layer.

A sequence is played as long as the sequence script is not ended. A channel (including layers) is active as long as the channel script is not ended.

== Note properties ==
A note can be played by the commands <code>layer_note0</code>, <code>layer_note1</code> and <code>layer_note2</code> (only valid if <code>chan_largenoteson</code> has been called on the layer's channel) or <code>layer_smallnote0</code>, <code>layer_smallnote1</code> and <code>layer_smallnote2</code> (only valid if <code>chan_largenotesoff</code> has been called on the layer's channel; default state). A note is defined by the following properties:

=== Pitch ===
Also known as '''note'''. The pitch defines the frequency in which the instrument is to be played. See list of notes below for available pitches.

=== Play percentage ===
Also known as '''timestamp'''. This defines the note value, such as half or quarter note. This also implies a layer delay of the same amount. See note values below for possible values.

=== Velocity ===
This is the volume of the note.

=== Duration ===
Also known as '''gate''' or '''gate time'''. A value of 0 menas the note is heard during the whole percentage, 128 is half of the percentage and 255 almost none.

== List of notes ==
This is a list of notes as used by the ''layer_note#'' and ''layer_smallnote#'' commands.
{| class="wikitable"
!Octave
!Note
!Decimal
!Hex (note0)
!Hex (note1)
!Hex (note2)
|-
! rowspan="3" |0
!A
|0
|0x00
|0x40
|0x80
|-
!A♯/B♭
|1
|0x01
|0x41
|0x81
|-
!B
|2
|0x02
|0x42
|0x82
|-
! rowspan="12" |1
!C
|3
|0x03
|0x43
|0x83
|-
!C♯/D♭
|4
|0x04
|0x44
|0x84
|-
!D
|5
|0x05
|0x45
|0x85
|-
!D♯/E♭
|6
|0x06
|0x46
|0x86
|-
!E
|7
|0x07
|0x47
|0x87
|-
!F
|8
|0x08
|0x48
|0x88
|-
!F♯/G♭
|9
|0x09
|0x49
|0x89
|-
!G
|10
|0x0A
|0x4A
|0x8A
|-
!G♯/A♭
|11
|0x0B
|0x4B
|0x8B
|-
!A
|12
|0x0C
|0x4C
|0x8C
|-
!A♯/B♭
|13
|0x0D
|0x4D
|0x8D
|-
!B
|14
|0x0E
|0x4E
|0x8E
|-
! rowspan="12" |2
!C
|15
|0x0F
|0x4F
|0x8F
|-
!C♯/D♭
|16
|0x10
|0x50
|0x90
|-
!D
|17
|0x11
|0x51
|0x91
|-
!D♯/E♭
|18
|0x12
|0x52
|0x92
|-
!E
|19
|0x13
|0x53
|0x93
|-
!F
|20
|0x14
|0x54
|0x94
|-
!F♯/G♭
|21
|0x15
|0x55
|0x95
|-
!G
|22
|0x16
|0x56
|0x96
|-
!G♯/A♭
|23
|0x17
|0x57
|0x97
|-
!A
|24
|0x18
|0x58
|0x98
|-
!A♯/B♭
|25
|0x19
|0x59
|0x99
|-
!B
|26
|0x1A
|0x5A
|0x9A
|-
! rowspan="12" |3
!C
|27
|0x1B
|0x5B
|0x9B
|-
!C♯/D♭
|28
|0x1C
|0x5C
|0x9C
|-
!D
|29
|0x1D
|0x5D
|0x9D
|-
!D♯/E♭
|30
|0x1E
|0x5E
|0x9E
|-
!E
|31
|0x1F
|0x5F
|0x9F
|-
!F
|32
|0x20
|0x60
|0xA0
|-
!F♯/G♭
|33
|0x21
|0x61
|0xA1
|-
!G
|34
|0x22
|0x62
|0xA2
|-
!G♯/A♭
|35
|0x23
|0x63
|0xA3
|-
!A
|36
|0x24
|0x64
|0xA4
|-
!A♯/B♭
|37
|0x25
|0x65
|0xA5
|-
!B
|38
|0x26
|0x66
|0xA6
|-
! rowspan="12" |4
!C
|39
|0x27
|0x67
|0xA7
|-
!C♯/D♭
|40
|0x28
|0x68
|0xA8
|-
!D
|41
|0x29
|0x69
|0xA9
|-
!D♯/E♭
|42
|0x2A
|0x6A
|0xAA
|-
!E
|43
|0x2B
|0x6B
|0xAB
|-
!F
|44
|0x2C
|0x6C
|0xAC
|-
!F♯/G♭
|45
|0x2D
|0x6D
|0xAD
|-
!G
|46
|0x2E
|0x6E
|0xAE
|-
!G♯/A♭
|47
|0x2F
|0x6F
|0xAF
|-
!A
|48
|0x30
|0x70
|0xB0
|-
!A♯/B♭
|49
|0x31
|0x71
|0xB1
|-
!B
|50
|0x32
|0x72
|0xB2
|-
! rowspan="12" |5
!C
|51
|0x33
|0x73
|0xB3
|-
!C♯/D♭
|52
|0x34
|0x74
|0xB4
|-
!D
|53
|0x35
|0x75
|0xB5
|-
!D♯/E♭
|54
|0x36
|0x76
|0xB6
|-
!E
|55
|0x37
|0x77
|0xB7
|-
!F
|56
|0x38
|0x78
|0xB8
|-
!F♯/G♭
|57
|0x39
|0x79
|0xB9
|-
!G
|58
|0x3A
|0x7A
|0xBA
|-
!G♯/A♭
|59
|0x3B
|0x7B
|0xBB
|-
!A
|60
|0x3C
|0x7C
|0xBC
|-
!A♯/B♭
|61
|0x3D
|0x7D
|0xBD
|-
!B
|62
|0x3E
|0x7E
|0xBE
|-
!6
!C
|63
|0x3F
|0x7F
|0xBF
|}

== Note durations ==
The effective duration of a note and the delay commands is based on the currently set sequence tempo. The duration of a single tick in seconds can be calculated using the following formular: <code>time = 1.25 / tempo</code>.
{| class="wikitable"
!Note
!Ticks
!Duration (120 BPM)
|-
|whole
|192
|2s
|-
|half dotted (2nd + 4th)
|144
|1.5s
|-
|half
|96
|1s
|-
|quarter dottet (4th + 8th)
|72
|0.75s
|-
|quarter (4th)
|48
|0.5s
|-
|eighth dottet (8th + 16th)
|36
|0.375s
|-
|quarter tuplet
|32
|0.333s
|-
|eighth (8th)
|24
|0.25s
|-
|sixteenth dottet (16th + 32th)
|18
|0.1875s
|-
|eigthth tuplet
|16
|0.1666s
|-
|sixteenth (16th)
|12
|0.125s
|-
|32th dottet (32th + 64th)
|9
|0.09375s
|-
|sixteenth tuplet (16th)
|8
|0.08333s
|-
|32th
|6
|0.0625s
|-
|32th tuplet
|4
|0.041666s
|-
|64th
|3
|0.03125s
|-
|64th tuplet
|2
|0.0208333s
|}

== Create sequences ==
There are several ways for creating new sequence files.

=== Seq64 ===
Seq64 is a GUI program for editing sequence files for Super Mario 64 and other Nintendo games. It also features full MIDI importing and exporting.

https://github.com/sauraen/seq64

=== Manually ===
Sequence files can also be created manually in a textual format. Create a new assembly file in the sequences directory, for example '''sound/sequences/us/23_custom_sequence.s'''. This file should begin with the following header:<syntaxhighlight>
.include "seq_macros.inc"
.section .rodata
.align 0
</syntaxhighlight>Next you can write down a series of commands. See '''include/seq_macros.inc''' or https://hackmd.io/opEB-OmxRa26P8h8pA-x7w for a list of available commands.

== Commands ==

=== Sequence commands ===
{| class="wikitable"
!Mnemonic
!Param 1
!Param 2
!Bytecode (US)
!Description
|-
!seq_end
|
|
|0xff
|End of script, loop or function
|-
!seq_delay1
|
|
|0xfe
|Delay for 1 tick
|-
!seq_delay
|ticks
|
|0xfd, var
|Delay for X ticks
|-
!seq_call
|address
|
|0xfc, addr
|Call a function
|-
!seq_jump
|address
|
|0xfb, addr
|Jump to a point in the sequence script
|-
!seq_beqz
|address
|
|0xfa, addr
|Jump if Q == 0, where Q is an s8 used to hold temporary sequence script state
|-
!seq_bltz
|address
|
|0xf9, addr
|Jump if Q < 0
|-
!seq_loop
|iterations
|
|0xf8, u8
|Repeat until <code>loopend</code> for X iterations (256 if X = 0)
|-
!seq_loopend
|
|
|0xf7
|Loop end marker
|-
!seq_bgez
|address
|
|0xf5, addr
|Jump if Q >= 0
|-
!seq_reservenotes
|numNotes
|
|0xf2, u8
|Reserve X notes for exclusive use by this sequence (dropping earlier reservations). A limited number of notes can be played at once (configurable per level, usually 16); if more than that are played, an existing one will be stopped and reused. This command can prevent that from happening across sequences.
|-
!seq_unreservenotes
|
|
|0xf1
|Drop all earlier reservations made by this sequence.
|-
!seq_transpose
|semitones
|
|0xdf, s8
|Set transposition in semitones.
|-
!seq_transposerel
|semitones
|
|0xde, s8
|Change transposition by some delta.
|-
!seq_settempo
|tempo
|
|0xdd, u8
|Set tempo in BPM.
|-
!seq_addtempo
|tempo
|
|0xdc, s8
|Change tempo by some delta.
|-
!seq_setvol
|volume
|
|0xdb, u8
|Set volume scale (0…255 = none to twice normal).
|-
!seq_changevol
|volume
|
|0xda, s8
|Change volume scale by some delta.
|-
!seq_initchannels
|channelMask
|
|0xd7, u16
|Initialize channels (bitmask). This copies mute behavior and note allocation policy.
|-
!seq_disablechannels
|channelMask
|
|0xd6, u16
|Uninitialize channels (bitmask).
|-
!seq_setmutescale
|mulitplier
|
|0xd5, s8
|Set volume multiplier for muted mode (0…127).
|-
!seq_mute
|
|
|0xd4
|Set sequence to muted mode. Depending on what behavior has been set this will do different things; from lowering volume to not running scripts.
|-
!seq_setmutebhv
|bitmask
|
|0xd3, u8
|Set mute behavior (bitmask). Bit 0x20 lowers volume, bit 0x40 does something to layers, and bit 0x80 pauses the sequence script. Default mute behavior is to have all of those bits set.
|-
!seq_setshortnotevelocitytable
|address
|
|0xd2, addr
|Set velocity table for short notes (see further down). Target should be an array of bytes in the sequence data of length 16.
|-
!seq_setshortnotedurationtable
|address
|
|0xd1, addr
|Set duration table for short notes (see further down). Target should be an array of bytes in the sequence data of length 16.
|-
!seq_setnoteallocationpolicy
|policyMask
|
|0xd0, u8
|Set note allocation policy (bitmask). If bit 0x1 is set, it will try to steal notes back from what was previously played on the same layer. If bit 0x2 is set, notes will be allocated exclusively from the channel’s reserved notes, else if 0x4 is set, from the channel’s or sequence’s reserved notes, else if 0x8 is set, from unreserved notes, otherwise from all sources. Not used by the game.
|-
!seq_setval
|value
|
|0xcc, u8
|Set Q to a constant.
|-
!seq_bitand
|value
|
|0xc9, u8
|Bitand Q by a constant.
|-
!seq_subtract
|value
|
|0xc8, u8
|Subtract a constant from Q.
|-
!seq_startchannel
|channel
|address
|0x90-0x9f, addr
|Start channel N, with a given channel script.
|-
!seq_getvariation
|
|
|0x80-0x8f
|Set Q to the variation bit, which is initially either 0 or 0x80 (i.e. -128, since Q is s8). This bit comes from the sequence load command. For instance, to play the Koopa shell music, the game plays sequence 0x8E, which is the same as sequence 0xE but with the variation bit set.
|-
!seq_setvariation
|
|
|0x70-0x7f
|Set the variation bit to Q.
|-
!seq_subvariation
|
|
|0x50-0x5f
|Subtract the variation bit from Q.
|-
!seq_testchdisabled
|channel
|
|0x00-0x0f
|Set Q to 1 or 0, depending on whether channel N has been disabled by channel script.
|}

=== Channel commands ===
{| class="wikitable"
!Mnemonic
!Param 1
!Param 2
!Param 3
!Bytecode (US)
!Description
|-
!chan_end
|
|
|
|0xff
|End of script, loop or function
|-
!chan_delay1
|
|
|
|0xfe
|Delay for 1 tick
|-
!chan_delay
|ticks
|
|
|0xfd, var
|Delay for X ticks
|-
!chan_call
|address
|
|
|0xfc, addr
|Call a function
|-
!chan_jump
|address
|
|
|0xfb, addr
|Jump to a point in the channel script
|-
!chan_beqz
|address
|
|
|0xfa, addr
|Jump if Q == 0, where Q is an s8 used to hold temporary channel script state
|-
!chan_bltz
|address
|
|
|0xf9, addr
|Jump if Q < 0
|-
!chan_loop
|iterations
|
|
|0xf8, u8
|Repeat until <code>loopend</code> for X iterations (256 if X = 0)
|-
!chan_loopend
|
|
|
|0xf7
|Loop end marker
|-
!chan_break
|
|
|
|0xf6
|Decrease loop/function stack depth by 1. Combine with a jump to break out of a loop.
|-
!chan_bgez
|address
|
|
|0xf5, addr
|Jump if Q >= 0
|-
!chan_hang
|
|
|
|0xf3
|Infinite delay.
|-
!chan_reservenotes
|numNotes
|
|
|0xf2, u8
|Reserve X notes for exclusive use by this channel (dropping earlier reservations).
|-
!chan_unreservenotes
|numNotes
|
|
|0xf1
|Drop all earlier reservations made by this channel.
|-
!chan_dyncall
|
|
|
|0xe4
|If Q != -1, make a function call to position dyntable[Q], where dyntable is a channel-specific u16 array which can set by <code>setdyntable</code>/<code>dynsetdyntable</code>.
|-
!chan_setvibratodelay
|
|
|
|0xe3, u8
|Set delay until vibrato starts for each note.
|-
!chan_setvibratoextentlinear
|
|
|
|0xe2, u8, u8, u8
|Set vibrato extent for each note as a function that starts at X, goes up linearly to Y over a time span given by Z, then stays there.
|-
!chan_setvibratoratelinear
|
|
|
|0xe1, u8, u8, u8
|Like above except for vibrato rate.
|-
!chan_setvolscale
|volume
|
|
|0xe0, u8
|Set scale factor for volume (0…255 = none to twice normal).
|-
!chan_setvol
|volume
|
|
|0xdf, u8
|Set scale factor #2 for volume (0…255 = none to twice normal). The two scale factors are separately controlled by outer audio logic, e.g. when changing between rooms, when playing sound effects, etc. The game almost exclusively uses setvol, so that should probably be preferred, but setvolscale shows up in a few locations in the sound effect sequence.
|-
!chan_freqscale
|value
|
|
|0xde, u16
|Pitch bend using a raw frequency multiplier X/2^15.
|-
!chan_setpan
|pan
|
|
|0xdd, u8
|Set the pan for this channel (0…128)
|-
!chan_setpanchanweight
|
|
|
|0xdc, u8
|The pan for each note will be computed as W * channel pan + (1 - W) * note pan. This sets W (0…128 maps to 0…1). W defaults to 1.0.
|-
!chan_transpose
|semitones
|
|
|0xdb, s8
|Set transposition in semitones.
|-
!chan_setenvelope
|address
|
|
|0xda, addr
|Set ADSR envelope. See below for format.
|-
!chan_setdecayrelease
|rate
|
|
|0xd9, u8
|Set ADSR decay/release rate.
|-
!chan_setvibratoextent
|extent
|
|
|0xd8, u8
|Set vibrato extent.
|-
!chan_setvibratorate
|rate
|
|
|0xd7, u8
|Set vibrato rate.
|-
!chan_setupdatesperframe
|
|
|
|0xd6, u8
|Seems like it was meant to set the number of updates per frame? But it doesn’t actually do anything.
|-
!chan_setreverb
|reverb
|
|
|0xd4, u8
|Set amount of reverb (or “dry/wet mix”?).
|-
!chan_pitchbend
|bend
|
|
|0xd3, s8
|Pitch bend by <= 1 octave in either direction (-127…127).
|-
!chan_setsustain
|volume
|
|
|0xd2, u8
|Set ADSR sustain volume.
|-
!chan_setnoteallocationpolicy
|policyMask
|
|
|0xd1, u8
|Set note allocation policy for channel. See the description for sequence scripts.
|-
!chan_stereoheadseteffects
|enable
|
|
|0xd0, u8
|Enable (1) or disable (0) some pan/volume effects related to stereo/headset. I don’t know which ones precisely – pan ''is'' still taken into account even with this disabled. With this disabled, stereo/headset gets the same output.
|-
!chan_setval
|value
|
|
|0xcc, u8
|Set Q to a constant.
|-
!chan_readseq
|address
|
|
|0xcb, addr
|Set Q to sequenceData[X + Q].
|-
!chan_setmutebhv
|
|
|
|0xca, u8
|Set mute behavior for this channel.
|-
!chan_bitand
|value
|
|
|0xc9, u8
|Bitand Q by a constant.
|-
!chan_subtract
|value
|
|
|0xc8, u8
|Subtract a constant from Q.
|-
!chan_writeseq
|
|address
|
|0xc7, u8, addr
|Overwrite the byte at the given position in the sequence script by (Q + X).
|-
!chan_setbank
|bank
|
|
|0xc6, u8
|Switch bank within instrument bank sets, to the X’th bank, 0-indexed, counting from the end.
|-
!chan_dynsetdyntable
|
|
|
|0xc5
|If Q != -1, set dyntable to point to position dyntable[Q] in the sequence data.
|-
!chan_largenoteson
|
|
|
|0xc4
|Set notes for this channel to use “large notes” format. SM64 does this for all channels. (See <code>note</code> vs. <code>shortnote</code> in the layer section below.)
|-
!chan_largenotesoff
|
|
|
|0xc3
|Set notes for this channel to use “short notes” format.
|-
!chan_setdyntable
|address
|
|
|0xc2, addr
|Set dyntable to point to a given u16 array from the sequence data.
|-
!chan_setinstr
|instrument
|
|
|0xc1, u8
|Set instrument (program?) within bank. 0x80-0x83 set raw waves (sawtooth, triangle, sine, square), 0x7f is special, otherwise 0-indexed.
|-
!chan_dynsetlayer
|
|
|
|0xb0-0xbf
|If Q != -1, start layer N, with layer script given by dyntable[Q].
|-
!chan_freelayer
|layer
|
|
|0xa0-0xaf
|Stop layer N.
|-
!chan_setlayer
|layer
|address
|
|0x90-0x9f, addr
|Start layer N, with layer script starting at address X.
|-
!chan_ioreadval
|
|
|
|0x80-0x8f
|Set Q to IO[N], where IO is an array of bytes that can be read/written by both the game and the channel script. If N < 4, IO[N] is then set to -1.
|-
!chan_iowriteval
|
|
|
|0x70-0x7f
|Set IO[N] to Q.
|-
!chan_setnotepriority
|
|
|
|0x60-0x6f
|Set note priority for later notes played on this channel to N. When the game wants to play a note and there aren’t any free notes available, a note with smaller or equal priority is discarded. Should be >= 2; 0 and 1 have internal meaning. Defaults to 3.
|-
!chan_ioreadvalsub
|
|
|
|0x50-0x5f
|Decrease Q by IO[N].
|-
!chan_ioreadval2
|
|
|
|0x40-0x4f, u8
|Set Q to IO2[X], where IO2 is the IO array for channel N.
|-
!chan_iowriteval2
|
|
|
|0x30-0x3f, u8
|Set IO2[X] to Q, where IO2 is the IO array for channel N.
|-
!chan_disablechannel
|channel
|
|
|0x20-0x2f
|Disable channel N for the parent sequence.
|-
!chan_startchannel
|channel
|address
|
|0x10-0x1f, addr
|Start channel N for the parent sequence, with channel script starting at address X.
|-
!chan_testlayerfinished
|layer
|
|
|0x00-0x0f
|Set Q to 1 or 0, depending on whether layer N has been disabled (either forcibly or by finishing its script).
|}

=== Layer commands ===
{| class="wikitable"
!Mnemonic
!Param 1
!Param 2
!Param 3
!Param 4
!Bytecode (US)
!Description
|-
!layer_end
|
|
|
|
|0xff
|End of script, loop or function
|-
!layer_call
|address
|
|
|
|0xfc, addr
|Call a function
|-
!layer_jump
|address
|
|
|
|0xfb, addr
|Jump to a point in the layer script
|-
!layer_loop
|iterations
|
|
|
|0xf8, u8
|Repeat until <code>loopend</code> for X iterations (256 if X = 0)
|-
!layer_loopend
|
|
|
|
|0xf7
|Loop end marker
|-
!layer_setshortnotedurationfromtable
|
|
|
|
|0xe0-0xef
|Set the duration for future short notes to table[N], where table defaults to <code>{229, 203, 177, 151, 139, 126, 113, 100, 87, 74, 61, 48, 36, 23, 10, 0}</code> and can be set by <code>setshortnotedurationtable</code>.
|-
!layer_setshortnotevelocityfromtable
|
|
|
|
|0xd0-0xdf
|Set the velocity for future short notes to table[N], where table defaults to <code>{12, 25, 38, 51, 57, 64, 71, 76, 83, 89, 96, 102, 109, 115, 121, 127}</code> and can be set by <code>setshortnotevelocitytable</code>.
|-
!layer_setpan
|pan
|
|
|
|0xca, u8
|Set the pan for this layer (0…128).
|-
!layer_setshortnoteduration
|duration
|
|
|
|0xc9, u8
|Set the duration for future short notes.
|-
!layer_disableportamento
|
|
|
|
|0xc8
|Disable portamento for later notes.
|-
!layer_portamento
|
|
|
|
|0xc7, u8, u8, u8/var
|Enable portamento (aka glissando; continuously sliding pitch). X describes the mode of operation somehow using its 0x80 bit and a value 0-5 in its lower-order bits. Y describes the target pitch. Z gives the duration, and is a u8 if the 0x80 bit is set, otherwise a var.
|-
!layer_setinstr
|instrument
|
|
|
|0xc6, u8
|Set instrument/program. Similar to the channel command, except arguments 0x7f and above are not supported.
|-
!layer_somethingoff
|
|
|
|
|0xc5
|Turn off some bool related to how notes decay somehow? (This is the default.)
|-
!layer_somethingon
|
|
|
|
|0xc4
|Turn on the same thing.
|-
!layer_setshortnotedefaultplaypercentage
|percentage
|
|
|
|0xc3, var
|Set the default play percentage for short notes (see below).
|-
!layer_transpose
|semitones
|
|
|
|0xc2, u8
|Set transposition in semitones.
|-
!layer_setshortnotevelocity
|velocity
|
|
|
|0xc1, u8
|Set velocity for future short notes.
|-
!layer_delay
|ticks
|
|
|
|0xc0, var
|Delay for N ticks
|-
!layer_note0
|pitch
|percentage
|velocity
|duration
|0x00-0x3f, var, u8, u8
|Play note with specified pitch, percentage, velocity and duration. Only valid if channel is set to “large notes”.
|-
!layer_note1
|pitch
|percentage
|velocity
|
|0x40-0x7f, var, u8
|Play note with specified pitch, percentage and velocity and duration of 0. Only valid if channel is set to “large notes”.
|-
!layer_note2
|pitch
|velocity
|duration
|
|0x80-0xbf, u8, u8
|Play note with specified pitch, velocity and duration. Only valid if channel is set to “large notes”.
|-
!layer_smallnote0
|pitch
|percentage
|
|
|0x00-0x3f, var
|Play note with specified pitch and percentage and velocity and duration set with layer_setshortnotevelocity and layer_setshortnoteduration. Only valid if channel is set to “small notes”.
|-
!layer_smallnote1
|pitch
|
|
|
|0x40-0x7f
|Play note with specified pitch and the default play percentage, as set by layer_setshortnotedefaultplaypercentage (there is no built-in default; using it without that command will read uninitialized memory). Velocity and duration is set like in layer_smallnote0. Only valid if channel is set to “small notes”.
|-
!layer_smallnote2
|pitch
|
|
|
|0x80-0xbf
|Play note with specified pitch and the previous play percentage. Velocity and duration is set like in layer_smallnote0. Only valid if channel is set to “small notes”.
|}

== See also ==

* [https://www.smwcentral.net/?p=section&s=sm64music Custom music] for SM64 on SMW Central
* [https://hackmd.io/opEB-OmxRa26P8h8pA-x7w m64 format] posted on HackMD
[[Category:Audio]]

List of sound banks

2020-11-10T09:02:31Z

Tenry:

{| class="wikitable"
!Sound bank
!Usage
!Sample bank
!Instrument no.
!Samples
!Description
|-
! rowspan="6" |00
| rowspan="6" |
| rowspan="6" |sfx_1
|1
|00_twirl
|
|-
|2
|01_brushing
|
|-
|3
|02_hand_touch
|
|-
|4
|03_yoshi
|
|-
|5
|04_plop
|
|-
|6
|05_heavy_landing
|
|-
! rowspan="9" |01
| rowspan="9" |
| rowspan="9" |sfx_terrain
|1
|00_step_default
|
|-
|2
|01_step_grass
|
|-
|3
|N/A
|
|-
|4
|02_step_stone
|
|-
|5
|03_step_spooky
|
|-
|6
|04_step_snow
|
|-
|7
|05_step_ice
|
|-
|8
|06_step_metal
|
|-
|9
|07_step_sand
|
|-
! rowspan="3" |02
| rowspan="3" |
| rowspan="3" |sfx_water
|1
|00_plunge
|
|-
|2
|01_splash
|
|-
|3
|02_swin
|
|-
! rowspan="10" |03
| rowspan="10" |
| rowspan="10" |sfx_4
|1
|00
|
|-
|2
|01
|
|-
|3
|02
|
|-
|4
|03
|
|-
|5
|04
|
|-
|6
|05
|
|-
|7
|06
|
|-
|8
|07
|
|-
|9
|08
|
|-
|10
|09
|
|-
! rowspan="16" |04
| rowspan="16" |
| rowspan="16" |sfx_5
|1
|00
|warp sound (hole/pipe)
|-
|2
|01
|door knob
|-
|3
|02
|opening door
|-
|4
|03
|opening metal door
|-
|5
|04
|door closing
|-
|6
|05
|flowing water
|-
|7
|06
|bubble
|-
|8
| colspan="2" |N/A
|-
|9
|07
|
|-
|10
|08
|door knob
|-
|11
|09
|
|-
|12
|0A
|
|-
|13
| colspan="2" |N/A
|-
|14
|0B
|thrown out of painting
|-
|15
|0C
|star catch/warp
|-
|16
|0D
|
|-
! rowspan="16" |05
| rowspan="16" |
| rowspan="16" |sfx_5
|1
|0E
|gunshot (Koopa the Quick race start)
|-
|2
|0F
|
|-
|3
|10
|
|-
|4
|11
|
|-
|5
|02
|opening door
|-
|6
|12
|
|-
|7
|13
|wind
|-
|8
|14
|destroyed box
|-
|9
|15
|bird chirp 1
|-
|10
|16
|bird chirp 2
|-
|11
|17
|bird chirp 3
|-
|12
|18
|bird chirp 4
|-
|13
|19
|bird chirp 5
|-
|14
|1A
|
|-
|15
|1B
|jumping box
|-
|16
|1C
|
|-
! rowspan="16" |06
| rowspan="16" |
| rowspan="16" |sfx_6
|1
|00
|Mips the bunny
|-
|2
|01
|
|-
|3
|02
|rawr (Bowser)
|-
|4
| colspan="2" |N/A
|-
|5
|03
|Bowser death
|-
|6
|04
|swoosh
|-
|7
|05
|Bowser inhale
|-
|8
|06
|baby penguin
|-
|9
|07
|
|-
|10
|08
|Boo
|-
|11
|09
|cannon moving sound 1
|-
|12
|0A
|cannon moving sound 2
|-
|13
|0B
|door knob
|-
|14
| colspan="2" |N/A
|-
|15
|0C
|Piranha Plant dying
|-
|16
|0D
|pushing box
|-
! rowspan="15" |07
| rowspan="15" |
| rowspan="15" |sfx_7
|1
|00
|
|-
|2
|01
|
|-
|3
|02
|scuttlebug step
|-
|4
|03
|
|-
|5
| colspan="2" |N/A
|-
|6
|04
|
|-
|7
|05
|
|-
|8
|06
|Ukiki
|-
|9
|07
|
|-
|10
|08
|
|-
|11
|09
|
|-
|12
|0A
|cowbell
|-
|13
|0B
|Whomp/Thwomp
|-
|14
|0C
|piano chomping sound
|-
|15
|0D
|Chain Chomp
|-
! rowspan="27" |08
| rowspan="27" |
| rowspan="27" |sfx_mario
|1
|00
|
|-
|2
|01
|
|-
|3
|02
|
|-
|4
|03
|
|-
|5
|04
|
|-
|6
|05
|
|-
|7
|06
|
|-
|8
|07
|
|-
|9
|08
|
|-
|10
|09
|
|-
|11
|0A
|
|-
|12
|0B
|
|-
|13
|0C
|
|-
|14
|0D
|
|-
|15
|0E
|
|-
|16
|0F
|
|-
|17
|10
|
|-
|18
|11
|
|-
|19
|12
|
|-
|20
|13
|
|-
|21
|14
|
|-
|22
|15
|
|-
|23
|16
|
|-
|24
|17
|
|-
|25
|18
|
|-
|26
|19
|
|-
|27
|1A
|
|-
! rowspan="7" |09
| rowspan="7" |
| rowspan="7" |sfx_9
|1
|00, 01
|
|-
|2
|02
|
|-
|3
|00
|
|-
|4
|03
|
|-
|5
|04
|
|-
|6
|05
|
|-
|7
|06
|
|-
! rowspan="24" |0A
| rowspan="24" |
| rowspan="24" |sfx_mario_peach
|1
|00
|
|-
|2
|01
|
|-
|3
|02
|
|-
|4
|N/A
|
|-
|5
|03
|
|-
|6
|04
|
|-
|7
|05
|
|-
|8
|06
|
|-
|9
|07
|
|-
|10
|08
|
|-
|11
|09
|
|-
|12
|0A
|
|-
|13
|0B
|
|-
|14
|0C
|
|-
|15
|0D
|
|-
|16
|0E
|
|-
|17
|0F
|
|-
|18
|10
|
|-
|19
|11
|
|-
|20
|12
|
|-
|21
|13
|
|-
|22
|14
|
|-
|23
|15
|
|-
|24
|16
|
|-
! rowspan="12" |0B
| rowspan="12" |08_level_snow
| rowspan="12" |instruments
|1
|3B, 3C, 3D
|acoustic guitar
|-
|2
|2E
|accordion
|-
|3
|2E
|accordion
|-
|4
| colspan="2" rowspan="3" |N/A
|-
|5
|-
|6
|-
|7
|16
|French horn
|-
|8
|16
|French horn
|-
|9
| colspan="2" rowspan="2" |N/A
|-
|10
|-
|11
|0F
|cymbal
|-
|12
|2F
|jingles
|-
! rowspan="16" |0C
| rowspan="16" |''unused''
| rowspan="16" |instruments
|1
|3B, 3C, 3D
|acoustic guitar
|-
|2
|3B, 3C, 3D
|acoustic guitar
|-
|3
|3B, 3C, 3D
|acoustic guitar
|-
|4
|3B, 3C, 3D
|acoustic guitar
|-
|5
|3B, 3C, 3D
|acoustic guitar
|-
|6
|3B, 3C, 3D
|acoustic guitar
|-
|7
|21
|bass
|-
|8
|34
|recorder
|-
|9
|34
|recorder
|-
|10
|(percussion)
|
|-
|11
| colspan="2" |N/A
|-
|12
|10, 11
|crash cymbal
|-
|13
|12, 13
|snare drum
|-
|14
|1E, 1F, 20
|triangle and cabasa
|-
|15
| colspan="2" |N/A
|-
|16
|42
|celesta
|-
! rowspan="13" |0D
| rowspan="13" |09_level_slide
| rowspan="13" |instruments
|1
|00, 01
|banjo
|-
|2
|00, 01
|banjo
|-
|3
|02
|fiddle
|-
|4
|02
|fiddle
|-
|5
|03
|whistle with vibrato
|-
|6
|04
|harpischord
|-
|7
|05
|acoustic bass
|-
|8
| colspan="2" rowspan="2" |N/A
|-
|9
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|cymbal
|-
|12
|10, 11
|crash cymbal
|-
|13
|12, 13
|hand clap and snare drum
|-
! rowspan="7" |0E
| rowspan="7" |04_level_inside_casle
15_cutscene_star_spawn
| rowspan="7" |instruments
|1
|23, 24, 25
|strings
|-
|2
|23, 24, 25
|strings
|-
|3
|23, 24, 25
|strings
|-
|4
|46, 47
|pizzicato strings
|-
|5
|2D
|cello
|-
|6
|26
|electric piano (main water instrument)
|-
|7
|26
|electric piano (main water instrument)
|-
! rowspan="4" |0F
| rowspan="4" |06_water_hot
| rowspan="4" |instruments
|1
|2A, 2B, 2C
|percussion loop
|-
|2
|22
|choir (known from Bowser stages)
|-
|3
|28
|sitar
|-
|4
|39
|sitar
|-
! rowspan="10" |10
| rowspan="10" |0A_level_spooky
| rowspan="10" |instruments
|1
|3E
|dark ambience (known from ghost state)
|-
|2
|3E
|dark ambience (known from ghost state)
|-
|3
|3F
|low cowbell
|-
|4
| colspan="2" |N/A
|-
|5
|40
|high cowbell
|-
|6
|40
|high cowbell
|-
|7
|40
|high cowbell
|-
|8
| colspan="2" rowspan="2" |N/A
|-
|9
|-
|10
|(percussion)
|
|-
! rowspan="14" |11
| rowspan="14" |02_menu_title_screen
| rowspan="14" |instruments
|1
|08, 38
|drum machine kick / snare split
|-
|2
|21
|lead 8 (bass+lead)
|-
|3
| colspan="2" |N/A
|-
|4
|35
|percussive organ
|-
|5
|48
|steel drums
|-
|6
|19
|brass
|-
|7
|1A
|slap bass
|-
|8
|1B
|synth voice
|-
|9
|1C
|electric guitar (clean)
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|closed/open hi-hat
|-
|12
|10, 11
|crash cymbal and ride cymbal
|-
|13
|12, 13
|snare drum
|-
|14
|1E, 1F, 20
|triangle and cabasa
|-
! rowspan="12" |12
| rowspan="12" |07_level_boss_koopa
10_event_koopa_message
| rowspan="12" |instruments
|1
|30
|charang (lead 5)
|-
|2
|31
|overdriven guitar
|-
|3
|31
|overdriven guitar
|-
|4
|32, 33
|drum sample
|-
|5
|0E, 0F
|recorder
|-
|6
| colspan="2" |N/A
|-
|7
|10, 11
|strings
|-
|8
| colspan="2" |N/A
|-
|9
|29
|orchestra hit
|-
|10
| colspan="2" |N/A
|-
|11
|34
|closed/open hi-hat
|-
|12
|23, 24, 25
|crash cymbal and ride cymbal
|-
! rowspan="16" |13
| rowspan="16" |05_level_water
| rowspan="16" |instruments
|1
|23, 24, 25
|strings
|-
|2
|23, 24, 25
|strings
|-
|3
| colspan="2" rowspan="4" |N/A
|-
|4
|-
|5
|-
|6
|-
|7
|21
|electric bass
|-
|8
| colspan="2" rowspan="2" |N/A
|-
|9
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|closed/open hi-hat
|-
|12
|10, 11
|crash cymbal and ride cymbal
|-
|13
| colspan="2" rowspan="2" |N/A
|-
|14
|-
|15
|26
|electric piano (main water instrument)
|-
|16
|26
|electric piano (main water instrument)
|-
! rowspan="5" |14
| rowspan="5" |0B_event_piranha_plant
1B_event_solve_puzzle
| rowspan="5" |piranha_music_box
|1
|00
|music box
|-
|2
|00
|music box
|-
|3
|00
|music box
|-
|4
|00
|music box
|-
|5
|00
|music box
|-
! rowspan="10" |15
| rowspan="10" |0C_level_underground
| rowspan="10" |instruments
|1
|1D
|melodic tom
|-
|2
|1E, 1F, 20
|triangle
|-
|3
|21
|electric bass
|-
|4
|1A
|slap bass
|-
|5
|21
|electric bass
|-
|6
|04
|acoustic steel guitar
|-
|7
|1D
|melodic tom
|-
|8
|22
|choir (known from Bowser stages)
|-
|9
|22
|choir (known from Bowser stages)
|-
|10
|(percussion)
|
|-
! rowspan="2" |16
| rowspan="2" |0D_menu_star_select
| rowspan="2" |course_start
|1
|00
|
|-
|2
|00
|
|-
! rowspan="13" |17
| rowspan="13" |0E_event_powerup
| rowspan="13" |instruments
|1
|3B, 3C, 3D
|acoustic bass
|-
|2
|05
|banjo
|-
|3
|23, 24, 25
|strings
|-
|4
|23, 24, 25
|strings
|-
|5
|26
|electric piano (main water instrument)
|-
|6
| colspan="2" rowspan="4" |N/A
|-
|7
|-
|8
|-
|9
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|crash cymbal
|-
|12
|10, 11
|cymbal
|-
|13
|1E, 1F, 20
|triangle and cabasa
|-
! rowspan="15" |18
| rowspan="15" |0F_event_metal_cap
| rowspan="15" |instruments
|1
|35
|organ
|-
|2
|36
|synth bass
|-
|3
|37
|saw wave
|-
|4
|29
|orchestra hit
|-
|5
| colspan="2" rowspan="5" |N/A
|-
|6
|-
|7
|-
|8
|-
|9
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|cymbal
|-
|12
| colspan="2" |N/A
|-
|13
|1E, 1F, 20
|triangle and cabasa
|-
|14
|12, 13
|orchestral percussion
|-
|15
|08, 38
|drum machine kick and snare split
|-
! rowspan="13" |19
| rowspan="13" |11_level_koopa_road
| rowspan="13" |instruments
|1
|22
|choir (known from Bowser stages)
|-
|2
|19
|trumpet
|-
|3
|23, 24, 25
|strings
|-
|4
|28
|sitar
|-
|5
|29
|orchestra hit
|-
|6
|2A, 2B, 2C
|percussion loop
|-
|7
|19
|trumpet
|-
|8
|22
|choir (known from Bowser stages)
|-
|9
| colspan="2" |N/A
|-
|10
|(percussion)
|
|-
|11
|12, 13
|drum sample
|-
|12
|10, 11
|crash cymbal
|-
|13
|18
|timpani
|-
! rowspan="13" |1A
| rowspan="13" |14_event_race
17_cutscene_collect_key

1F_cutscene_victory
| rowspan="13" |instruments
|1
|17
|trumpet
|-
|2
|2D
|cello or low woodwind
|-
|3
|16
|French horn
|-
|4
|14, 15
|strings
|-
|5
|19
|trumpet
|-
|6
|26
|electric piano (main water instrument)
|-
|7
| colspan="2" rowspan="4" |N/A
|-
|8
|-
|9
|-
|10
|-
|11
|18
|timpani
|-
|12
|10, 11
|crash cymbal
|-
|13
|12, 13
|drum sampel
|-
! rowspan="12" |1B
| rowspan="12" |16_event_boss
1E_cutscene_intro

22_cutscene_lakitu
| rowspan="12" |instruments
|1
|14, 15
|strings
|-
|2
|14, 15
|strings
|-
|3
|16
|French horn
|-
|4
|17
|trumpet
|-
|5
|15
|strings
|-
|6
| colspan="2" rowspan="2" |N/A
|-
|7
|-
|8
|18
|timpani
|-
|9
|12, 13
|drum sample
|-
|10
|(percussion)
|
|-
|11
| colspan="2" |N/A
|-
|12
|10, 11
|crash cymbal
|-
! rowspan="7" |1C
| rowspan="7" |18_event_endless_stairs
| rowspan="7" |instruments
|1
|3A
|xylophone
|-
|2
|3A
|xylophone
|-
|3
|3A
|xylophone
|-
|4
| colspan="2" |N/A
|-
|5
|14, 15
|strings
|-
|6
|14, 15
|strings
|-
|7
|14, 15
|strings
|-
! rowspan="6" |1D
| rowspan="6" |19_level_boss_koopa_final
| rowspan="6" |instruments
|1
|00, 01
|church organ
|-
|2
|00, 01
|church organ
|-
|3
|00, 01
|church organ
|-
|4
|00, 01
|church organ
|-
|5
|00, 01
|church organ
|-
|6
|02
|choir
|-
! rowspan="4" |1E
| rowspan="4" |1D_event_peach_message
| rowspan="4" |instruments
|1
|27
|acoustic guitar
|-
|2
|27
|acoustic guitar
|-
|3
|23, 24, 25
|strings
|-
|4
|23, 24, 25
|strings
|-
! rowspan="13" |1F
| rowspan="13" |12_event_high_score
| rowspan="13" |instruments
|1
|2E
|accordion
|-
|2
| colspan="2" |N/A
|-
|3
|2E
|accordion
|-
|4
| colspan="2" rowspan="8" |N/A
|-
|5
|-
|6
|-
|7
|-
|8
|-
|9
|-
|10
|-
|11
|-
|12
|2F
|bells
|-
|13
|12, 13
|snaare drum
|-
! rowspan="9" |20
| rowspan="9" |1C_event_toad_message
| rowspan="9" |instruments
|1
|16
|French horn
|-
|2
| colspan="2" rowspan="6" |N/A
|-
|3
|-
|4
|-
|5
|-
|6
|-
|7
|-
|8
|16
|French horn
|-
|9
|23, 24, 25
|strings
|-
! rowspan="4" |21
| rowspan="4" |0A_level_spooky
event_merry_go_round
| rowspan="4" |instruments
|1
|2E
|accordion
|-
|2
| colspan="2" |N/A
|-
|3
|2E
|accordion
|-
|4
|26
|electric piano (main water instrument)
|-
! rowspan="12" |22
| rowspan="12" |01_cutscene_collect_star
03_level_grass
| rowspan="12" |instruments
|1
|19
|brass
|-
|2
| colspan="2" rowspan="5" |N/A
|-
|3
|-
|4
|-
|5
|-
|6
|-
|7
|1A
|slap bass
|-
|8
|1B
|synth voice
|-
|9
|1C
|electric guitar (muted)
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|open/closed hi-hat
|-
|12
|10, 11
|crash cymbal and ride cymbal
|-
! rowspan="8" |23
| rowspan="8" |20_cutscene_ending
| rowspan="8" |instruments
|1
|23, 24, 25
|strings
|-
|2
|23, 24, 25
|strings
|-
|3
|23, 24, 25
|strings
|-
|4
| colspan="2" rowspan="2" |N/A
|-
|5
|-
|6
|26
|electric piano (main water instrument)
|-
|7
|26
|electric piano (main water instrument)
|-
|8
|27
|acoustic guitar
|-
! rowspan="10" |24
| rowspan="10" |21_menu_file_select
| rowspan="10" |instruments
|1
|41
|pan flute
|-
|2
|41
|pan flute
|-
|3
|14, 15
|strings
|-
|4
|22
|choir (known from Bowser stages)
|-
|5
| colspan="2" rowspan="5" |N/A
|-
|6
|-
|7
|-
|8
|-
|9
|-
|10
|(percussion)
|
|-
! rowspan="16" |25
| rowspan="16" |1A_cutscene_credits
| rowspan="16" |instruments
|1
|43
|accordion
|-
|2
|1A
|slap bass
|-
|3
|1C
|electric guitar (jazz)
|-
|4
|26
|electric piano (main water instrument)
|-
|5
|44
|grand piano
|-
|6
|16, 45
|French horn
|-
|7
|41
|pan flute
|-
|8
|23, 24, 25
|strings
|-
|9
|26
|electric piano (main water instrument)
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|closed/open hi-hat
|-
|12
|10, 11
|crash cymbal and ride cymbal
|-
|13
|1E, 1F, 20
|triangle and cabasa
|-
|14
| colspan="2" |N/A
|-
|15
|43
|accordion
|-
|16
|44
|grand piano
|}

== See also ==

* [[List of instruments|List of Instruments]]

[[Category:Audio]]

Object

2020-11-09T09:22:23Z

Tenry:

An object is defined by various properties.

== Behavior parameters ==
When an object is placed in a world, 4 bytes representing 4 behavior parameters can be set individually. These bytes are available as a signed integer (s32) in the field <code>oBehParams</code>. Since the second byte is the most frequently used one by objects, this is also copied to a special field <code>oBehParams2ndByte</code>. The value 0xFF for the second byte has a special meaning and indicates that the object shall not respawn.

When the first bit of the first parameter is set, this indicates that this object is Mario.

== Position and velocity ==
The object's position is stored in <code>oPosX</code>, <code>oPosY</code> and <code>oPosZ</code>. The velocity is available in <code>oVelX</code>, <code>oVelY</code> and <code>oVelZ</code>.

The rotation can be changed by setting <code>oMoveAnglePitch</code>, <code>oMoveAngleYaw</code> and <code>oMoveAngleRoll</code>.

== Object flags ==
Object flags are set in <code>oFlags</code>. The following flags are available:
{| class="wikitable"
!Flag
!Description
|-
!<code>OBJ_FLAG_UPDATE_GFX_POS_AND_ANGLE</code>
|Indicate that object position or angle will be changed.
|-
!<code>OBJ_FLAG_MOVE_XZ_USING_FVEL</code>
|
|-
!<code>OBJ_FLAG_MOVE_Y_WITH_TERMINAL_VEL</code>
|
|-
!<code>OBJ_FLAG_SET_FACE_YAW_TO_MOVE_YAW</code>
|
|-
!<code>OBJ_FLAG_SET_FACE_ANGLE_TO_MOVE_ANGLE</code>
|
|-
!<code>OBJ_FLAG_COMPUTE_DIST_TO_MARIO</code>
|Compute distance to Mario. It is stored in <code>oDistanceToMario</code>.
|-
!<code>OBJ_FLAG_ACTIVE_FROM_AFAR</code>
|
|-
!<code>OBJ_FLAG_TRANSFORM_RELATIVE_TO_PARENT</code>
|
|-
!<code>OBJ_FLAG_HOLDABLE</code>
|Mark this object as holdable.
|-
!<code>OBJ_FLAG_SET_THROW_MATRIX_FROM_TRANSFORM</code>
|
|-
!<code>OBJ_FLAG_COMPUTE_ANGLE_TO_MARIO</code>
|Compute angle to Mario. It is stored in <code>oAngleToMario</code>.
|-
!<code>OBJ_FLAG_PERSISTENT_RESPAWN</code>
|
|}

== Collision data ==
The collision data is defined by <code>collisionData</code>. It can be used to dynamically change the collision of a surface object.

== Interaction ==
An object's interaction is defined in <code>oInteractType</code>. For some interaction types a sub type can be specified in <code>oInteractionSubtype</code>.The following interaction types are available:
{| class="wikitable"
!Type
!Subtype
!Description
|-
!<code>INTERACT_HOOT</code>
!
|
|-
! rowspan="6" |<code>INTERACT_GRABBABLE</code>
!
|
|-
!<code>INT_SUBTYPE_GRABS_MARIO</code>
|Also makes the object heavy
|-
!<code>INT_SUBTYPE_HOLDABLE_NPC</code>
|Allows the object to be gently dropped. Sets vertical speed to 0 when dropped with no forwards velocity.
|-
!<code>INT_SUBTYPE_DROP_IMMEDIATELY</code>
|This gets set by grabbable NPCs that talk to Mario to make him drop them after the dialog is finished.
|-
!<code>INT_SUBTYPE_KICKABLE</code>
|
|-
!<code>INT_SUBTYPE_NOT_GRABBABLE</code>
|Used by Heavy-Ho to allow it to throw Mario, without Mario being able to pick it up.
|-
! rowspan="2" |<code>INTERACT_DOOR</code>
!
|
|-
!<code>INT_SUBTYPE_STAR_DOOR</code>
|
|-
!<code>INTERACT_DAMAGE</code>
!
|Mario takes damage on colllision
|-
!<code>INTERACT_COIN</code>
!
|Coin counter increases on collision
|-
!<code>INTERACT_CAP</code>
!
|Gives Mario a cap
|-
!<code>INTERACT_POLE</code>
!
|
|-
!<code>INTERACT_KOOPA</code>
!
|
|-
!<code>INTERACT_BREAKABLE</code>
!
|
|-
!<code>INTERACT_STRONG_WIND</code>
!
|
|-
!<code>INTERACT_WARP_DOOR</code>
!
|
|-
! rowspan="3" |<code>INTERACT_STAR_OR_KEY</code>
!
|Star or key
|-
!<code>INT_SUBTYPE_NO_EXIT</code>
|
|-
!<code>INT_SUBTYPE_GRAND_STAR</code>
|
|-
! rowspan="2" |<code>INTERACT_WARP</code>
!
|
|-
!<code>INT_SUBTYPE_FADING_WARP</code>
|
|-
!<code>INTERACT_CANNON_BASE</code>
!
|
|-
! rowspan="2" |<code>INTERACT_BOUNCE_TOP</code>
!
|
|-
!<code>INT_SUBTYPE_TWIRL_BOUNCE</code>
|
|-
!<code>INTERACT_WATER_RING</code>
!
|
|-
!<code>INTERACT_BULLY</code>
!
|
|-
!<code>INTERACT_FLAME</code>
!
|
|-
!<code>INTERACT_KOOPA_SHELL</code>
!
|
|-
!<code>INTERACT_BOUNCE_TOP2</code>
!
|
|-
!<code>INTERACT_MR_BLIZZARD</code>
!
|
|-
!<code>INTERACT_HIT_FROM_BELOW</code>
!
|
|-
! rowspan="3" |<code>INTERACT_TEXT</code>
!
|
|-
!<code>INT_SUBTYPE_SIGN</code>
|
|-
!<code>INT_SUBTYPE_NPC</code>
|
|-
!<code>INTERACT_TORNADO</code>
!
|
|-
!<code>INTERACT_WHIRLPOOL</code>
!
|
|-
! rowspan="2" |<code>INTERACT_CLAM_OR_BUBBA</code>
!
|
|-
!<code>INT_SUBTYPE_EATS_MARIO</code>
|
|-
!<code>INTERACT_BBH_ENTRANCE</code>
!
|
|-
!<code>INTERACT_SNUFIT_BULLET</code>
!
|
|-
!<code>INTERACT_SHOCK</code>
!
|
|-
!<code>INTERACT_IGLOO_BARRIER</code>
!
|
|}

== Action and timer ==
The object has a timer <code>oTimer</code> which starts at 0 and is increased by 1 per frame (if game is not paused). The integer property <code>oAction</code> is commonly used to change an object current action. It's usually checked in a behavior's loop script. When changing the action to a different value, <code>oTimer</code> will be reset to 0 on the next loop.

== Misc. properties ==
{| class="wikitable"
!Property
!Description
|-
!<code>oFloorHeight</code>
|Distance to floor (?)
|-
!<code>oGravity</code>
|Gravity
|}

== See also ==

* [[Custom object]]
* [[Object list]]

[[Category:Level]]

Behavior

2020-11-09T09:00:14Z

Tenry:

A behavior basically is a [[Scripting|script]] describing how an object shall behave. The original behavior scripts can be found in '''data/behavior_data.c'''.

== Native code ==
Behavior script can do a lot with the object they are attached to. Additional code can be added natively in [[C]]. Original behavior code is located in '''src/game/behaviors'''.

== Actors ==
Actors basically describe the appearance of an object, including 3D models, textures and animations. Original actors are located in sub-folders in '''actors'''.

An actor usual contains the following data:

* Unique [[texture]] files (might be hardcoded in C if exported from an editor)
* model.inc.c file describing 3D models including UV coordinates and vertex colors
* [[Geometry layout|geo.inc.c]] file
* anims sub-folder

== Behavior script commands ==
{| class="wikitable sortable"
!Command
!Parameters
!Description
|-
!<code>BEGIN</code>
|objList
|Defines the start of the behavior script as well as the object list the object belongs to. Has some special behavior for certain objects.
|-
!<code>DELAY</code>
|num
|Delays the behavior script for a certain number of frames.
|-
!<code>CALL</code>
|addr
|Jumps to a new behavior command and stores the return address in the object's stack.
|-
!<code>RETURN</code>
|
|Jumps back to the behavior command stored in the object's stack.
|-
!<code>GOTO</code>
|addr
|Jumps to a new behavior script without saving anything.
|-
!<code>BEGIN_REPEAT</code>
|count
|Marks the start of a loop that will repeat a certain number of times.
|-
!<code>END_REPEAT</code>
|
|Marks the end of a repeating loop.
|-
!<code>END_REPEAT_CONTINUE</code>
|
|Also marks the end of a repeating loop, but continues executing commands following the loop on the same frame.
|-
!<code>BEGIN_LOOP</code>
|
|Marks the beginning of an infinite loop.
|-
!<code>END_LOOP</code>
|
|Makrs the end of an infinite loop.
|-
!<code>BREAK</code>
|
|Exits the behavior script. Often used to end behavior scripts that do not contain an infinite loop.
|-
!<code>CALL_NATIVE</code>
|func
|Executes a native game function.
|-
!<code>ADD_FLOAT</code>
|field, value
|Adds a float to the specified field.
|-
!<code>SET_FLOAT</code>
|field, value
|Sets the specified field to a float.
|-
!<code>ADD_INT</code>
|field, value
|Adds an integer to the specified field.
|-
!<code>SET_INT</code>
|field, value
|Sets the specified field to an integer.
|-
!<code>OR_INT</code>
|field, value
|Performs a bitwise OR with the specified field and the given itneger. Usually used to set an object's flags.
|-
!<code>BIT_CLEAR</code>
|field, value
|Performs a bit clear with the specified short. Unused in favor of the 32-bit version.
|-
!<code>SET_INT_RAND_RSHIFT</code>
|field, min, rshift
|Gets a random short, right shifts it the specified amoutn and adds min to it, then sets the specified field to that value.
|-
!<code>SET_RANDOM_FLOAT</code>
|field, min, range
|Sets the specified field to a random float in the given range.
|-
!<code>SET_RANDOM_INT</code>
|field, min, range
|Sets the specified field to a random integer in the given range.
|-
!<code>ADD_RANDOM_FLOAT</code>
|field, min, range
|Adds a random float in the given range to the specified field.
|-
!<code>ADD_INT_RAND_RSHIFT</code>
|field, min, rshift
|Gets a random short, right shifts it the specified amount and adds min to it, then adds the value to the specified field.
|-
!<code>SET_MODEL</code>
|modelID
|Sets the current model ID of the object.
|-
!<code>DEACTIVATE</code>
|
|Exits the behavior script and despawns the object. Often used to end behavior scripts that do not contain an infinite loop.
|-
!<code>DROP_TO_FLOOR</code>
|
|Finds the floor triangle directly under the object and moves the object down to it.
|-
!<code>SUM_FLOAT</code>
|fieldDst, fieldSrc1, fieldSrc2
|Sets the destination float field to the sum of the values of the given float fields.
|-
!<code>SUM_INT</code>
|fieldDst, fieldSrc1, fieldSrc2
|Sets the destination integer field to the sum of the values of the given integer fields.
|-
!<code>BILLBOARD</code>
|
|Billboards the current object, making it always face the camera.
|-
!<code>HIDE</code>
|
|Hides the current object.
|-
!<code>SET_HITBOX</code>
|radius, height
|Sets the size of the object's cylindrical hitbox.
|-
!<code>DELAY_VAR</code>
|field
|Delays the behavior script for the number of frames given by the value of the specified field.
|-
!<code>LOAD_ANIMATIONS</code>
|field, anims
|Loads the animations for the object. field is always set to oAnimations.
|-
!<code>ANIMATE</code>
|animIndex
|Begins animation and sets the object's current animation index to the specified value.
|-
!<code>SPAWN_CHILD_WITH_PARAM</code>
|bhvParam, modelID, behavior
|Spawns a child object with the specified model and behavior, plus a behavior param.
|-
!<code>LOAD_COLLISION_DATA</code>
|collisionData
|Loads collision data for the object.
|-
!<code>SET_HITBOX_WITH_OFFSET</code>
|radius, height, downOffset
|Sets the size of the object's cylindrical hitbox, and applies a downwards offset.
|-
!<code>SPAWN_OBJ</code>
|modelID, behavior
|Spawns a new object with the specified model and behavior.
|-
!<code>SET_HOME</code>
|
|Sets the home position of the object to its current position.
|-
!<code>SET_HURTBOX</code>
|radius, height
|Sets the size of the object's cylindrical hurtbox.
|-
!<code>SET_INTERACT_TYPE</code>
|type
|Sets the object's interaction type.
|-
!<code>SET_OBJ_PHYSICS</code>
|wallHitboxRadius, gravity, bounciness,
dragStrength, friction, buoyancy,

unused1, unused2
|Sets various parameters that the object uses for calculating physincs.
|-
!<code>SET_INTERACT_SUBTYPE</code>
|subtype
|Sets the object's interaction subtype.
|-
!<code>SCALE</code>
|unused, percent
|Sets the object's size to the specified percentage.
|-
!<code>PARENT_BIT_CLEAR</code>
|field, flags
|Performs a bit clear on the object's parent's field with the specified value. Used for clearing active particle flags from Mario's object.
|-
!<code>ANIMATE_TEXTURE</code>
|field, rate
|Animates an object using texture animation. field is always set to oAnimState.
|-
!<code>DISABLE_RENDERING</code>
|
|Disables rendering for the object.
|-
!<code>SPAWN_WATER_DROPLET</code>
|dropletParams
|Spawns a water droplet with the given parameters.
|}

== See also ==

* [[Custom behavior]]
* [[Geometry layout]]
[[Category:Level]]

Object

2020-11-09T07:27:24Z

Tenry:

An object is defined by various properties.

== Position and velocity ==
The object's position is stored in <code>oPosX</code>, <code>oPosY</code> and <code>oPosZ</code>. The velocity is available in <code>oVelX</code>, <code>oVelY</code> and <code>oVelZ</code>.

The rotation can be changed by setting <code>oMoveAnglePitch</code>, <code>oMoveAngleYaw</code> and <code>oMoveAngleRoll</code>.

== Object flags ==
Object flags are set in <code>oFlags</code>. The following flags are available:
{| class="wikitable"
!Flag
!Description
|-
!<code>OBJ_FLAG_UPDATE_GFX_POS_AND_ANGLE</code>
|Indicate that object position or angle will be changed.
|-
!<code>OBJ_FLAG_MOVE_XZ_USING_FVEL</code>
|
|-
!<code>OBJ_FLAG_MOVE_Y_WITH_TERMINAL_VEL</code>
|
|-
!<code>OBJ_FLAG_SET_FACE_YAW_TO_MOVE_YAW</code>
|
|-
!<code>OBJ_FLAG_SET_FACE_ANGLE_TO_MOVE_ANGLE</code>
|
|-
!<code>OBJ_FLAG_COMPUTE_DIST_TO_MARIO</code>
|Compute distance to Mario. It is stored in <code>oDistanceToMario</code>.
|-
!<code>OBJ_FLAG_ACTIVE_FROM_AFAR</code>
|
|-
!<code>OBJ_FLAG_TRANSFORM_RELATIVE_TO_PARENT</code>
|
|-
!<code>OBJ_FLAG_HOLDABLE</code>
|Mark this object as holdable.
|-
!<code>OBJ_FLAG_SET_THROW_MATRIX_FROM_TRANSFORM</code>
|
|-
!<code>OBJ_FLAG_COMPUTE_ANGLE_TO_MARIO</code>
|Compute angle to Mario. It is stored in <code>oAngleToMario</code>.
|-
!<code>OBJ_FLAG_PERSISTENT_RESPAWN</code>
|
|}

== Collision data ==
The collision data is defined by <code>collisionData</code>. It can be used to dynamically change the collision of a surface object.

== Interaction ==
An object's interaction is defined in <code>oInteractType</code>. For some interaction types a sub type can be specified in <code>oInteractionSubtype</code>.The following interaction types are available:
{| class="wikitable"
!Type
!Subtype
!Description
|-
!<code>INTERACT_HOOT</code>
!
|
|-
! rowspan="6" |<code>INTERACT_GRABBABLE</code>
!
|
|-
!<code>INT_SUBTYPE_GRABS_MARIO</code>
|Also makes the object heavy
|-
!<code>INT_SUBTYPE_HOLDABLE_NPC</code>
|Allows the object to be gently dropped. Sets vertical speed to 0 when dropped with no forwards velocity.
|-
!<code>INT_SUBTYPE_DROP_IMMEDIATELY</code>
|This gets set by grabbable NPCs that talk to Mario to make him drop them after the dialog is finished.
|-
!<code>INT_SUBTYPE_KICKABLE</code>
|
|-
!<code>INT_SUBTYPE_NOT_GRABBABLE</code>
|Used by Heavy-Ho to allow it to throw Mario, without Mario being able to pick it up.
|-
! rowspan="2" |<code>INTERACT_DOOR</code>
!
|
|-
!<code>INT_SUBTYPE_STAR_DOOR</code>
|
|-
!<code>INTERACT_DAMAGE</code>
!
|Mario takes damage on colllision
|-
!<code>INTERACT_COIN</code>
!
|Coin counter increases on collision
|-
!<code>INTERACT_CAP</code>
!
|Gives Mario a cap
|-
!<code>INTERACT_POLE</code>
!
|
|-
!<code>INTERACT_KOOPA</code>
!
|
|-
!<code>INTERACT_BREAKABLE</code>
!
|
|-
!<code>INTERACT_STRONG_WIND</code>
!
|
|-
!<code>INTERACT_WARP_DOOR</code>
!
|
|-
! rowspan="3" |<code>INTERACT_STAR_OR_KEY</code>
!
|Star or key
|-
!<code>INT_SUBTYPE_NO_EXIT</code>
|
|-
!<code>INT_SUBTYPE_GRAND_STAR</code>
|
|-
! rowspan="2" |<code>INTERACT_WARP</code>
!
|
|-
!<code>INT_SUBTYPE_FADING_WARP</code>
|
|-
!<code>INTERACT_CANNON_BASE</code>
!
|
|-
! rowspan="2" |<code>INTERACT_BOUNCE_TOP</code>
!
|
|-
!<code>INT_SUBTYPE_TWIRL_BOUNCE</code>
|
|-
!<code>INTERACT_WATER_RING</code>
!
|
|-
!<code>INTERACT_BULLY</code>
!
|
|-
!<code>INTERACT_FLAME</code>
!
|
|-
!<code>INTERACT_KOOPA_SHELL</code>
!
|
|-
!<code>INTERACT_BOUNCE_TOP2</code>
!
|
|-
!<code>INTERACT_MR_BLIZZARD</code>
!
|
|-
!<code>INTERACT_HIT_FROM_BELOW</code>
!
|
|-
! rowspan="3" |<code>INTERACT_TEXT</code>
!
|
|-
!<code>INT_SUBTYPE_SIGN</code>
|
|-
!<code>INT_SUBTYPE_NPC</code>
|
|-
!<code>INTERACT_TORNADO</code>
!
|
|-
!<code>INTERACT_WHIRLPOOL</code>
!
|
|-
! rowspan="2" |<code>INTERACT_CLAM_OR_BUBBA</code>
!
|
|-
!<code>INT_SUBTYPE_EATS_MARIO</code>
|
|-
!<code>INTERACT_BBH_ENTRANCE</code>
!
|
|-
!<code>INTERACT_SNUFIT_BULLET</code>
!
|
|-
!<code>INTERACT_SHOCK</code>
!
|
|-
!<code>INTERACT_IGLOO_BARRIER</code>
!
|
|}

== Action and timer ==
The object has a timer <code>oTimer</code> which starts at 0 and is increased by 1 per frame (if game is not paused). The integer property <code>oAction</code> is commonly used to change an object current action. It's usually checked in a behavior's loop script. When changing the action to a different value, <code>oTimer</code> will be reset to 0 on the next loop.

== Misc. properties ==
{| class="wikitable"
!Property
!Description
|-
!<code>oFloorHeight</code>
|Distance to floor (?)
|-
!<code>oGravity</code>
|Gravity
|}

== See also ==

* [[Custom object]]
* [[Object list]]

[[Category:Level]]

Object list

2020-11-09T07:12:30Z

Tenry:

Every object is categorized into an object list, which controls the order they are processed and which objects they can collide with. In behavior scripts, the <code>BEGIN</code> command is used to specify the list for this object, such as <code>BEGIN(OBJ_LIST_DEFAULT)</code>.

== Available lists ==
The following lists are available:
{| class="wikitable"
!List
!ID
!Description
|-
!Player
|OBJ_LIST_PLAYER
|Mario
|-
!Destructive
|OBJ_LIST_DESTRUCTIVE
|Things that can be used to destroy other objects, like bob-ombs and corkboxes.
|-
!General actors
|OBJ_LIST_GENACTOR
|Most normal "enemies" or actors are on this list, such as Mips, Bullet Bill or Bully.
|-
!Level
|OBJ_LIST_LEVEL
|General level objects such as heart or star.
|-
!Default
|OBJ_LIST_DEFAULT
|Objects that didn't start with a 00 command are put here, so this is treated as a default.
|-
!Surface
|OBJ_LIST_SURFACE
|Objects that specifically have surface collision and not object collision, such as thwomp and whomp.
|-
!Polelike
|OBJ_LIST_POLELIKE
|Objects that attract or otherwise "cling" Mario similar to a pole action, such as hoot, whirlpool, trees or poles.
|-
!Spawner
|OBJ_LIST_SPAWNER
|Spawners
|-
!Unimportant
|OBJ_LIST_UNIMPORTANT
|Objects that will not load if there are not enough object slots: they will also be manuall unloaded to make room for slots if the list gets exhaustet.
|}

== See also ==

* [[Object]]

[[Category:Level]]

Object

2020-11-09T07:11:59Z

Tenry: Created page with "An object is defined by various properties. == Position and velocity == The object's position is stored in <code>oPosX</code>, <code>oPosY</code> and <code>oPosZ</code>. The..."

An object is defined by various properties.

== Position and velocity ==
The object's position is stored in <code>oPosX</code>, <code>oPosY</code> and <code>oPosZ</code>. The velocity is available in <code>oVelX</code>, <code>oVelY</code> and <code>oVelZ</code>.

The rotation can be changed by setting <code>oMoveAnglePitch</code>, <code>oMoveAngleYaw</code> and <code>oMoveAngleRoll</code>.

== Object flags ==
Object flags are set in <code>oFlags</code>. The following flags are available:
{| class="wikitable"
!Flag
!Description
|-
!<code>OBJ_FLAG_UPDATE_GFX_POS_AND_ANGLE</code>
|Indicate that object position or angle will be changed.
|-
!<code>OBJ_FLAG_MOVE_XZ_USING_FVEL</code>
|
|-
!<code>OBJ_FLAG_MOVE_Y_WITH_TERMINAL_VEL</code>
|
|-
!<code>OBJ_FLAG_SET_FACE_YAW_TO_MOVE_YAW</code>
|
|-
!<code>OBJ_FLAG_SET_FACE_ANGLE_TO_MOVE_ANGLE</code>
|
|-
!<code>OBJ_FLAG_COMPUTE_DIST_TO_MARIO</code>
|Compute distance to Mario.
|-
!<code>OBJ_FLAG_ACTIVE_FROM_AFAR</code>
|
|-
!<code>OBJ_FLAG_TRANSFORM_RELATIVE_TO_PARENT</code>
|
|-
!<code>OBJ_FLAG_HOLDABLE</code>
|Mark this object as holdable.
|-
!<code>OBJ_FLAG_SET_THROW_MATRIX_FROM_TRANSFORM</code>
|
|-
!<code>OBJ_FLAG_COMPUTE_ANGLE_TO_MARIO</code>
|Compute angle to Mario.
|-
!<code>OBJ_FLAG_PERSISTENT_RESPAWN</code>
|
|}

== Collision data ==
The collision data is defined by <code>collisionData</code>. It can be used to dynamically change the collision of a surface object.

== Interaction ==
An object's interaction is defined in <code>oInteractType</code>. For some interaction types a sub type can be specified in <code>oInteractionSubtype</code>.The following interaction types are available:
{| class="wikitable"
!Type
!Subtype
!Description
|-
!<code>INTERACT_HOOT</code>
!
|
|-
! rowspan="6" |<code>INTERACT_GRABBABLE</code>
!
|
|-
!<code>INT_SUBTYPE_GRABS_MARIO</code>
|Also makes the object heavy
|-
!<code>INT_SUBTYPE_HOLDABLE_NPC</code>
|Allows the object to be gently dropped. Sets vertical speed to 0 when dropped with no forwards velocity.
|-
!<code>INT_SUBTYPE_DROP_IMMEDIATELY</code>
|This gets set by grabbable NPCs that talk to Mario to make him drop them after the dialog is finished.
|-
!<code>INT_SUBTYPE_KICKABLE</code>
|
|-
!<code>INT_SUBTYPE_NOT_GRABBABLE</code>
|Used by Heavy-Ho to allow it to throw Mario, without Mario being able to pick it up.
|-
! rowspan="2" |<code>INTERACT_DOOR</code>
!
|
|-
!<code>INT_SUBTYPE_STAR_DOOR</code>
|
|-
!<code>INTERACT_DAMAGE</code>
!
|Mario takes damage on colllision
|-
!<code>INTERACT_COIN</code>
!
|Coin counter increases on collision
|-
!<code>INTERACT_CAP</code>
!
|Gives Mario a cap
|-
!<code>INTERACT_POLE</code>
!
|
|-
!<code>INTERACT_KOOPA</code>
!
|
|-
!<code>INTERACT_BREAKABLE</code>
!
|
|-
!<code>INTERACT_STRONG_WIND</code>
!
|
|-
!<code>INTERACT_WARP_DOOR</code>
!
|
|-
! rowspan="3" |<code>INTERACT_STAR_OR_KEY</code>
!
|Star or key
|-
!<code>INT_SUBTYPE_NO_EXIT</code>
|
|-
!<code>INT_SUBTYPE_GRAND_STAR</code>
|
|-
! rowspan="2" |<code>INTERACT_WARP</code>
!
|
|-
!<code>INT_SUBTYPE_FADING_WARP</code>
|
|-
!<code>INTERACT_CANNON_BASE</code>
!
|
|-
! rowspan="2" |<code>INTERACT_BOUNCE_TOP</code>
!
|
|-
!<code>INT_SUBTYPE_TWIRL_BOUNCE</code>
|
|-
!<code>INTERACT_WATER_RING</code>
!
|
|-
!<code>INTERACT_BULLY</code>
!
|
|-
!<code>INTERACT_FLAME</code>
!
|
|-
!<code>INTERACT_KOOPA_SHELL</code>
!
|
|-
!<code>INTERACT_BOUNCE_TOP2</code>
!
|
|-
!<code>INTERACT_MR_BLIZZARD</code>
!
|
|-
!<code>INTERACT_HIT_FROM_BELOW</code>
!
|
|-
! rowspan="3" |<code>INTERACT_TEXT</code>
!
|
|-
!<code>INT_SUBTYPE_SIGN</code>
|
|-
!<code>INT_SUBTYPE_NPC</code>
|
|-
!<code>INTERACT_TORNADO</code>
!
|
|-
!<code>INTERACT_WHIRLPOOL</code>
!
|
|-
! rowspan="2" |<code>INTERACT_CLAM_OR_BUBBA</code>
!
|
|-
!<code>INT_SUBTYPE_EATS_MARIO</code>
|
|-
!<code>INTERACT_BBH_ENTRANCE</code>
!
|
|-
!<code>INTERACT_SNUFIT_BULLET</code>
!
|
|-
!<code>INTERACT_SHOCK</code>
!
|
|-
!<code>INTERACT_IGLOO_BARRIER</code>
!
|
|}

== Misc. properties ==
{| class="wikitable"
!Property
!Description
|-
!<code>oFloorHeight</code>
|Distance to floor (?)
|-
!<code>oGravity</code>
|Gravity
|}

== See also ==

* [[Custom object]]
* [[Object list]]

[[Category:Level]]

Custom object

2020-11-09T06:39:16Z

Tenry: add link to object list

This page describes how to create a custom object with custom 3D model and custom [[behavior]] for Super Mario 64.

== Export 3D model (Fast64) ==
In [[Blender]], install the [[Fast64]] plugin, select your object you want to export, open the Fast64 menu and expand '''SM64 Geolayout Exporter'''. Ensure to select [[C]] as the export.

Choose '''Actor Data''' as the export type.

Choose a group name you want to add your actor to, such as '''common0'''.

Choose a unique folder name. It's recommended to add the word ''custom'' to the name, for example '''custom_platform'''.

Choose a unique [[Geometry layout|geolayout]] name, such as '''custom_platform_geo'''.

Ensure the newly created '''model.inc.c''' file is included in actors/''<group>''.c file, such as in '''actors/common0.c''' (should be done by Fast64 exporter).

Ensure the newly created '''geo_header.h''' file is included in actors/''<group>''.h file, such as in '''actors/common0.h''' (should be done by Fast64 exporter).

Ensure the newly created '''geo.inc.c''' file is included in actors/''<group>''_geo.c file, such as in '''actors/common0_geo.c''' (should be done by Fast64 exporter).

=== Collision data ===
If the object shall become a solid object, such as a moving platform, you also need to export the collision data. Expand '''SM64 Collision Exporter''' for that and select C.

Export type is '''Actor Data'''. For the name, you should use the same you previously chose for the folder, such as '''custom_platform'''. The group name should also be the same as above.

== Load custom model ==
It's a good idea to give your 3D model a unique name, such as '''MODEL_CUSTOM_COIN''', and an ID from 0x00 to 0xFF. Define it in '''include/model_ids.h'''. Ensure it does not share an ID with another model that might be loaded in the same level.

In your level script file (such as '''levels/bob/script.c''') or in a global script located in '''levels/scripts.c''', add a ''LOAD_MODEL_FROM_GEO'' command, such as '''LOAD_MODEL_FROM_GEO(MODEL_CUSTOM_COIN, custom_coin_geo)'''.

== Create behavior script ==
Open '''data/behavior_data.c''' in your favorite code editor. You may want to add a dedicated file, such as '''data/custom_coin.inc.c''' and include this in data/behavior_data.c. Also add your new behavior name to '''include/behavior_data.h'''.

The easiest way to create your own behavior script is to copy an existing one that's most closely to what you want. Copy the related lines and rename the variable accordingly. Example:<syntaxhighlight lang="c" line="1">
// original yellow coin (for reference)
const BehaviorScript bhvYellowCoin[] = {
BEGIN(OBJ_LIST_LEVEL),
BILLBOARD(),
OR_INT(oFlags, (OBJ_FLAG_COMPUTE_DIST_TO_MARIO | OBJ_FLAG_UPDATE_GFX_POS_AND_ANGLE)),
CALL_NATIVE(bhv_yellow_coin_init), // defined in src/game/behaviors/coin.inc.c
BEGIN_LOOP(),
CALL_NATIVE(bhv_yellow_coin_loop), // defined in src/game/behaviors/coin.inc.c
END_LOOP(),
};

// your own copy
const BehaviorScript bhvCustomCoin[] = {
BEGIN(OBJ_LIST_LEVEL),
BILLBOARD(),
OR_INT(oFlags, (OBJ_FLAG_COMPUTE_DIST_TO_MARIO | OBJ_FLAG_UPDATE_GFX_POS_AND_ANGLE)),
CALL_NATIVE(bhv_custom_coin_init), // define your own in src/game/behaviors/custom_coin.inc.c
BEGIN_LOOP(),
CALL_NATIVE(bhv_custom_coin_loop), // define your own in src/game/behaviors/custom_coin.inc.c
END_LOOP(),
};
</syntaxhighlight>

=== Solid object ===
If the object shall be a solid object, such as a moving platform, the collision data must also be loaded in the script. Call <code>LOAD_COLLISION_DATA(custom_platform_collision)</code> before initialization and <code>CALL_NATIVE(load_object_collision_model)</code> at the end inside the loop.

== Create native code ==
If you need new native [[C]] code, create a new code file in src/game/behaviors, such as '''src/game/behaviors/custom_coin.inc.c''', and include that file in '''src/game/obj_behaviors.c'''. You might want to copy an existing behavior code for reference. However, make sure all variables and function names are unique in the source code. For example, rename '''bhv_yelow_coin_loop''' to '''bhv_custom_coin_loop'''. Declare your custom functions in a suitable header file, such as in '''src/game/obj_behaviors.h''' or '''src/game/behavior_actions.h'''.

== Add object to level (Fast64) ==
In your level inside [[Blender]], add an ''Empty''. Set object type to '''Object'''.

Set model to '''Custom''' and model ID to your defined ID from include/model_ids.h, such as '''MODEL_CUSTOM_COIN'''.

Set behavior to '''Custom''' and behavior name to your defined name in data/behavior_data.c, such as '''bhvCustomCoin'''.

== See also ==

* [[Fast64]]
* [[Behavior]]
* [[Object list]]
* [[Geometry layout]]
[[Category:Level]]

Level limitations

2020-11-09T06:38:40Z

Tenry: add maximum number of objects

When creating or editing a custom level, certain limitations have to be kept in mind:

* Maximum number of triangles is '''6500''' (to be verified)
* Level playing field is limited in X and Z from '''-8192 to +8192''', but can be [[Extended bounds|extended]]
* Texture can not be repeated more than '''32''' times on a single polygon (to be verified)
* Maximum number of objects that can be loaded at once is '''240''' (defined by <code>OBJECT_POOL_CAPACITY</code>)

[[Category:Level]]

Object list

2020-11-09T06:37:45Z

Tenry: Created page with "Every object is categorized into an object list, which controls the order they are processed and which objects they can collide with. In behavior scripts, the <code>BEGIN</cod..."

Every object is categorized into an object list, which controls the order they are processed and which objects they can collide with. In behavior scripts, the <code>BEGIN</code> command is used to specify the list for this object, such as <code>BEGIN(OBJ_LIST_DEFAULT)</code>.

== Available lists ==
The following lists are available:
{| class="wikitable"
!List
!ID
!Description
|-
|Player
|OBJ_LIST_PLAYER
|Mario
|-
|Destructive
|OBJ_LIST_DESTRUCTIVE
|Things that can be used to destroy other objects, like bob-ombs and corkboxes.
|-
|General actors
|OBJ_LIST_GENACTOR
|Most normal "enemies" or actors are on this list, such as Mips, Bullet Bill or Bully.
|-
|Level
|OBJ_LIST_LEVEL
|General level objects such as heart or star.
|-
|Default
|OBJ_LIST_DEFAULT
|Objects that didn't start with a 00 command are put here, so this is treated as a default.
|-
|Surface
|OBJ_LIST_SURFACE
|Objects that specifically have surface collision and not object collision, such as thwomp and whomp.
|-
|Polelike
|OBJ_LIST_POLELIKE
|Objects that attract or otherwise "cling" Mario similar to a pole action, such as hoot, whirlpool, trees or poles.
|-
|Spawner
|OBJ_LIST_SPAWNER
|Spawners
|-
|Unimportant
|OBJ_LIST_UNIMPORTANT
|Objects that will not load if there are not enough object slots: they will also be manuall unloaded to make room for slots if the list gets exhaustet.
|}
[[Category:Level]]

Custom object

2020-11-09T06:30:40Z

Tenry:

Main Page

2020-11-09T05:59:32Z

Tenry:

SM64Decomp Wiki:Contribution guidelines

2020-11-09T05:58:34Z

Tenry: Created page with "When contributing to this wiki, please follow the guidelines on this page. * Do ''not'' provide uploads or link to ROM images or provide information on how to illegally obtai..."

When contributing to this wiki, please follow the guidelines on this page.

* Do ''not'' provide uploads or link to ROM images or provide information on how to illegally obtain them
* Do ''not'' post leaked source code

== Page name policy ==
'''Use sentence case.''' Titles are written in sentence case. The initial letter of a title is almost always capitalized by default; otherwise, words are not capitalized unless they would be so in running text.

'''Use singular form.''' Exceptions include nouns that are always in plural form.

== Category name policy ==
'''Page name policy applies.'''

Names of ''topic categories'' should be singular. Examples: "Health", "HUD". A category named "Behavior" should include pages dedicated to how behaviors work or how to create one.

Names of ''set categories'' should be plural. Examples: "Hacks", "Editors". A category named "Behaviors" should include individual existing behaviors.

== File name policy ==
'''Avoid very generic filenames.''' For example, a screenshot of a hack should not be given the name "File:Hack.jpg".

Examples of good file names are:

* "Screenshot of Super Mario 64 Intro Screen.jpg"
* "SM64 Beta Screenshot.png"
* "Star Icon.png"

Examples of bad file names:

* "Image01.png"
* "Mario.jpg"

Color combiner

2020-11-09T04:47:41Z

Tenry: Created page with "The color combiner basically performs this equation: <code>color = (A - B) × C + D</code> A, B, C and D can come from many different sources. {| class="wikitable" !Value !A..."

The color combiner basically performs this equation: <code>color = (A - B) × C + D</code>

A, B, C and D can come from many different sources.
{| class="wikitable"
!Value
!A
!B
!C
!D
!A alpha
!B alpha
!C alpha
!D alpha
|-
!0
|Y
|Y
|Y
|Y
|Y
|Y
|Y
|Y
|-
!1
|Y
|
|
|Y
|Y
|
|
|Y
|-
!Texture 0
|Y
|Y
|Y
|Y
|
|
|
|
|-
!Texture 1
|Y
|Y
|Y
|Y
|
|
|
|
|-
!Primitive color
|Y
|Y
|Y
|Y
|
|
|
|
|-
!Shade color
|Y
|Y
|Y
|Y
|
|
|
|
|-
!Environment color
|Y
|Y
|Y
|Y
|
|
|
|
|-
!Combined color
|Y
|Y
|Y
|Y
|
|
|
|
|-
!Texture 0 alpha
|
|
|Y
|
|Y
|Y
|Y
|Y
|-
!Texture 1 alpha
|
|
|Y
|
|Y
|Y
|Y
|Y
|-
!Primitive color alpha
|
|
|Y
|
|Y
|Y
|Y
|Y
|-
!Shade color alpha
|
|
|Y
|
|Y
|Y
|Y
|Y
|-
!Environment color alpha
|
|
|Y
|
|Y
|Y
|Y
|Y
|-
!Combined color alpha
|
|
|Y
|
|Y
|Y
|
|Y
|-
!Noise
|Y
|
|
|
|
|
|
|
|-
!Chroma key center
|
|Y
|
|
|
|
|
|
|-
!Chroma key scale
|
|
|Y
|
|
|
|
|
|-
!YUV convert K4
|
|Y
|
|
|
|
|
|
|-
!YUV convert K5
|
|
|Y
|
|
|
|
|
|-
!LOD fraction
|
|
|Y
|
|
|
|Y
|
|-
!Primitive LOD fraction
|
|
|Y
|
|
|
|Y
|
|}

== Presets (Fast64) ==
{| class="wikitable"
!Preset
!A
!B
!C
!D
!A alpha
!B alpha
!C alpha
!D alpha
|-
!Unlit Texture
|0
|0
|0
|Texture 0
|0
|0
|0
|Environment color alpha
|-
!Unlit Texture Cutout
|0
|0
|0
|Texture 0
|Texture 0 alpha
|0
|Environment color alpha
|0
|-
!Shaded Solid
|0
|0
|0
|Shade color
|0
|0
|0
|Environment color alpha
|-
!Decal On Shaded Solid
|Texture 0
|Shade color
|Texture 0 alpha
|Shade color
|0
|0
|0
|Environment color alpha
|-
!Shaded Texture
|Texture 0
|0
|Shade color
|0
|0
|0
|0
|Environment color
|-
!Shaded Texture Cutout
|Texture 0
|0
|Shade color
|0
|Texture 0 alpha
|0
|Environment color alpha
|0
|-
!Shaded Texture Cutout Transparent (Prim Alpha)
|Texture 0
|0
|Shade color
|0
|Texture 0 alpha
|0
|Primitive color alpha
|0
|-
!Vertex Colored Texture
|Texture 0
|0
|Shade color
|0
|Environment color alpha
|0
|Shade color alpha
|0
|-
!Environment Mapped
|0
|0
|0
|Texture 0
|0
|0
|0
|Environment color alpha
|-
!Fog Shaded Texture
|
|
|
|
|
|
|
|
|-
!Fog Shaded Texture Cutout
|
|
|
|
|
|
|
|
|-
!Fog Shaded Texture Cutout Transparent (Prim Alpha)
|
|
|
|
|
|
|
|
|-
!Vertex Colored Texture Transparent
|Texture 0
|0
|Shade color
|0
|Texture 0 alpha
|0
|Shade color alpha
|0
|-
!Shaded Noise
|Noise
|0
|Shade color
|0
|0
|0
|0
|Environment color alpha
|-
!Vertex Colored Texture (No Vertex Alpha)
|Texture 0
|0
|Shade color
|0
|0
|0
|0
|Texture 0 alpha
|}

== See also ==

* [http://ultra64.ca/files/documentation/online-manuals/man/pro-man/pro12/index12.6.html Color Combiner] in the RDP Programming manual on ultra64.ca

[[Category:Graphics]]

Profiling

2020-11-09T01:29:35Z

Tenry: Created page with "The game has a builtin profiler which can be enabled by setting <code>gShowProfiler</code> to ''TRUE'' in '''src/game/main.c'''. When enabled, colored bars are shown at the bo..."

Main Page

2020-11-09T00:55:44Z

Tenry:

Welcome to SM64Decomp project wiki! This website is meant to help people working on the [https://github.com/n64decomp/sm64 Super Mario 64 Decompilation] project, especially on customizing the code for creating individual hacks.

Please note that editing is currently restricted to a few selected users.

This wiki is maintainted by [[User:Tenry|Tenry]] and is not associated with the decomp organization.

== Categories ==

* [[:Category:Level|Level]] - everything you need if you want to create or modify a level or objects
* [[:Category:Coding|Coding]] - if you want to do custom coding or general enhancements
* [[:Category:Graphics|Graphics]] - if you want to change graphics or how they are displayed
* [[:Category:Audio|Audio]] - if you want to work with the sound effects or music

== External resources ==

* [[List of Discord servers]]
* [https://www.mariowiki.com/Super_Mario_64 Game overview on mariowiki.com]
* [https://ukikipedia.net/wiki/Main_Page Ukikipedia]
* [https://hack64.net/wiki/doku.php?id=start Hack64]
* [https://docs.google.com/document/d/1pSYR91UiMVKnP3PyvJiCdwRF5wNS_nZzMe-r2WPQUJk/edit?usp=sharing SM64 ROM Hacking Tools and Resources] (Google Docs)

== Contribution guidelines ==

* Do ''not'' provide uploads or link to ROM images or provide information on how to illegally obtain them
* Do ''not'' post leaked source code

=== Page name policy ===
'''Use sentence case.''' Titles are written in sentence case. The initial letter of a title is almost always capitalized by default; otherwise, words are not capitalized unless they would be so in running text.

'''Use singular form.''' Exceptions include nouns that are always in plural form.

=== Category name policy ===
'''Page name policy applies.'''

Names of ''topic categories'' should be singular. Examples: "Health", "HUD". A category named "Behavior" should include pages dedicated to how behaviors work or how to create one.

Names of ''set categories'' should be plural. Examples: "Hacks", "Editors". A category named "Behaviors" should include individual existing behaviors.

=== File name policy ===
'''Avoid very generic filenames.''' For example, a screenshot of a hack should not be given the name "File:Hack.jpg".

Examples of good file names are:

* "Screenshot of Super Mario 64 Intro Screen.jpg"
* "SM64 Beta Screenshot.png"
* "Star Icon.png"

Examples of bad file names:

* "Image01.png"
* "Mario.jpg"

Main Page

2020-11-09T00:55:20Z

Tenry: add link to mariowiki.com

Welcome to SM64Decomp project wiki! This website is meant to help people working on the [https://github.com/n64decomp/sm64 Super Mario 64 Decompilation] project, especially on customizing the code for creating individual hacks.

Please note that editing is currently restricted to a few selected users.

This wiki is maintainted by [[User:Tenry|Tenry]] and is not associated with the decomp organization.

== Categories ==

* [[:Category:Level|Level]] - everything you need if you want to create or modify a level or objects
* [[:Category:Coding|Coding]] - if you want to do custom coding or general enhancements
* [[:Category:Graphics|Graphics]] - if you want to change graphics or how they are displayed
* [[:Category:Audio|Audio]] - if you want to work with the sound effects or music

== External resources ==

* [[List of Discord servers]]
* [https://www.mariowiki.com/Super_Mario_64 Overview on mariowiki.com]
* [https://ukikipedia.net/wiki/Main_Page Ukikipedia]
* [https://hack64.net/wiki/doku.php?id=start Hack64]
* [https://docs.google.com/document/d/1pSYR91UiMVKnP3PyvJiCdwRF5wNS_nZzMe-r2WPQUJk/edit?usp=sharing SM64 ROM Hacking Tools and Resources] (Google Docs)

== Contribution guidelines ==

* Do ''not'' provide uploads or link to ROM images or provide information on how to illegally obtain them
* Do ''not'' post leaked source code

=== Page name policy ===
'''Use sentence case.''' Titles are written in sentence case. The initial letter of a title is almost always capitalized by default; otherwise, words are not capitalized unless they would be so in running text.

'''Use singular form.''' Exceptions include nouns that are always in plural form.

=== Category name policy ===
'''Page name policy applies.'''

Names of ''topic categories'' should be singular. Examples: "Health", "HUD". A category named "Behavior" should include pages dedicated to how behaviors work or how to create one.

Names of ''set categories'' should be plural. Examples: "Hacks", "Editors". A category named "Behaviors" should include individual existing behaviors.

=== File name policy ===
'''Avoid very generic filenames.''' For example, a screenshot of a hack should not be given the name "File:Hack.jpg".

Examples of good file names are:

* "Screenshot of Super Mario 64 Intro Screen.jpg"
* "SM64 Beta Screenshot.png"
* "Star Icon.png"

Examples of bad file names:

* "Image01.png"
* "Mario.jpg"

Level limitations

2020-11-09T00:54:42Z

Tenry: Created page with "When creating or editing a custom level, certain limitations have to be kept in mind: * Maximum number of triangles is 6500 (to be verified) * Level playing field is limited..."

When creating or editing a custom level, certain limitations have to be kept in mind:

* Maximum number of triangles is 6500 (to be verified)
* Level playing field is limited in X and Z from -8192 to +8192, but can be [[Extended bounds|extended]]
* Texture can not be repeated more than 32 times on a single polygon (to be verified)

[[Category:Level]]

Instruments

2020-11-08T22:11:46Z

Tenry: Redirected page to List of instruments

#REDIRECT [[List of instruments]]
[[Category:Audio]]

List of sound banks

2020-11-08T21:09:59Z

Tenry:

{| class="wikitable"
!Sound bank
!Usage
!Sample bank
!Instrument no.
!Samples
!Description
|-
! rowspan="6" |00
| rowspan="6" |
| rowspan="6" |sfx_1
|1
|00_twirl
|
|-
|2
|01_brushing
|
|-
|3
|02_hand_touch
|
|-
|4
|03_yoshi
|
|-
|5
|04_plop
|
|-
|6
|05_heavy_landing
|
|-
! rowspan="9" |01
| rowspan="9" |
| rowspan="9" |sfx_terrain
|1
|00_step_default
|
|-
|2
|01_step_grass
|
|-
|3
|N/A
|
|-
|4
|02_step_stone
|
|-
|5
|03_step_spooky
|
|-
|6
|04_step_snow
|
|-
|7
|05_step_ice
|
|-
|8
|06_step_metal
|
|-
|9
|07_step_sand
|
|-
! rowspan="3" |02
| rowspan="3" |
| rowspan="3" |sfx_water
|1
|00_plunge
|
|-
|2
|01_splash
|
|-
|3
|02_swin
|
|-
! rowspan="10" |03
| rowspan="10" |
| rowspan="10" |sfx_4
|1
|00
|
|-
|2
|01
|
|-
|3
|02
|
|-
|4
|03
|
|-
|5
|04
|
|-
|6
|05
|
|-
|7
|06
|
|-
|8
|07
|
|-
|9
|08
|
|-
|10
|09
|
|-
! rowspan="16" |04
| rowspan="16" |
| rowspan="16" |sfx_5
|1
|00
|warp sound (hole/pipe)
|-
|2
|01
|door knob
|-
|3
|02
|opening door
|-
|4
|03
|opening metal door
|-
|5
|04
|door closing
|-
|6
|05
|flowing water
|-
|7
|06
|bubble
|-
|8
| colspan="2" |N/A
|-
|9
|07
|
|-
|10
|08
|door knob
|-
|11
|09
|
|-
|12
|0A
|
|-
|13
| colspan="2" |N/A
|-
|14
|0B
|thrown out of painting
|-
|15
|0C
|star catch/warp
|-
|16
|0D
|
|-
! rowspan="16" |05
| rowspan="16" |
| rowspan="16" |sfx_5
|1
|0E
|gunshot (Koopa the QUick race start)
|-
|2
|0F
|
|-
|3
|10
|
|-
|4
|11
|
|-
|5
|02
|opening door
|-
|6
|12
|
|-
|7
|13
|wind
|-
|8
|14
|destroyed box
|-
|9
|15
|bird chirp 1
|-
|10
|16
|bird chirp 2
|-
|11
|17
|bird chirp 3
|-
|12
|18
|bird chirp 4
|-
|13
|19
|bird chirp 5
|-
|14
|1A
|
|-
|15
|1B
|jumping box
|-
|16
|1C
|
|-
! rowspan="16" |06
| rowspan="16" |
| rowspan="16" |sfx_6
|1
|00
|Mips the bunny
|-
|2
|01
|
|-
|3
|02
|rawr (Bowser)
|-
|4
| colspan="2" |N/A
|-
|5
|03
|Bowser death
|-
|6
|04
|swoosh
|-
|7
|05
|Bowser inhale
|-
|8
|06
|baby penguin
|-
|9
|07
|
|-
|10
|08
|Boo
|-
|11
|09
|cannon moving sound 1
|-
|12
|0A
|cannon moving sound 2
|-
|13
|0B
|door knob
|-
|14
| colspan="2" |N/A
|-
|15
|0C
|Piranha Plant dying
|-
|16
|0D
|pushing box
|-
! rowspan="15" |07
| rowspan="15" |
| rowspan="15" |sfx_7
|1
|00
|
|-
|2
|01
|
|-
|3
|02
|scuttlebug step
|-
|4
|03
|
|-
|5
| colspan="2" |N/A
|-
|6
|04
|
|-
|7
|05
|
|-
|8
|06
|Ukiki
|-
|9
|07
|
|-
|10
|08
|
|-
|11
|09
|
|-
|12
|0A
|cowbell
|-
|13
|0B
|Whomp/Thwomp
|-
|14
|0C
|piano chomping sound
|-
|15
|0D
|Chain Chomp
|-
! rowspan="27" |08
| rowspan="27" |
| rowspan="27" |sfx_mario
|1
|00
|
|-
|2
|01
|
|-
|3
|02
|
|-
|4
|03
|
|-
|5
|04
|
|-
|6
|05
|
|-
|7
|06
|
|-
|8
|07
|
|-
|9
|08
|
|-
|10
|09
|
|-
|11
|0A
|
|-
|12
|0B
|
|-
|13
|0C
|
|-
|14
|0D
|
|-
|15
|0E
|
|-
|16
|0F
|
|-
|17
|10
|
|-
|18
|11
|
|-
|19
|12
|
|-
|20
|13
|
|-
|21
|14
|
|-
|22
|15
|
|-
|23
|16
|
|-
|24
|17
|
|-
|25
|18
|
|-
|26
|19
|
|-
|27
|1A
|
|-
! rowspan="7" |09
| rowspan="7" |
| rowspan="7" |sfx_9
|1
|00, 01
|
|-
|2
|02
|
|-
|3
|00
|
|-
|4
|03
|
|-
|5
|04
|
|-
|6
|05
|
|-
|7
|06
|
|-
! rowspan="24" |0A
| rowspan="24" |
| rowspan="24" |sfx_mario_peach
|1
|00
|
|-
|2
|01
|
|-
|3
|02
|
|-
|4
|N/A
|
|-
|5
|03
|
|-
|6
|04
|
|-
|7
|05
|
|-
|8
|06
|
|-
|9
|07
|
|-
|10
|08
|
|-
|11
|09
|
|-
|12
|0A
|
|-
|13
|0B
|
|-
|14
|0C
|
|-
|15
|0D
|
|-
|16
|0E
|
|-
|17
|0F
|
|-
|18
|10
|
|-
|19
|11
|
|-
|20
|12
|
|-
|21
|13
|
|-
|22
|14
|
|-
|23
|15
|
|-
|24
|16
|
|-
! rowspan="12" |0B
| rowspan="12" |08_level_snow
| rowspan="12" |instruments
|1
|3B, 3C, 3D
|acoustic guitar
|-
|2
|2E
|accordion
|-
|3
|2E
|accordion
|-
|4
| colspan="2" rowspan="3" |N/A
|-
|5
|-
|6
|-
|7
|16
|French horn
|-
|8
|16
|French horn
|-
|9
| colspan="2" rowspan="2" |N/A
|-
|10
|-
|11
|0F
|cymbal
|-
|12
|2F
|jingles
|-
! rowspan="16" |0C
| rowspan="16" |''unused''
| rowspan="16" |instruments
|1
|3B, 3C, 3D
|acoustic guitar
|-
|2
|3B, 3C, 3D
|acoustic guitar
|-
|3
|3B, 3C, 3D
|acoustic guitar
|-
|4
|3B, 3C, 3D
|acoustic guitar
|-
|5
|3B, 3C, 3D
|acoustic guitar
|-
|6
|3B, 3C, 3D
|acoustic guitar
|-
|7
|21
|bass
|-
|8
|34
|recorder
|-
|9
|34
|recorder
|-
|10
|(percussion)
|
|-
|11
| colspan="2" |N/A
|-
|12
|10, 11
|crash cymbal
|-
|13
|12, 13
|snare drum
|-
|14
|1E, 1F, 20
|triangle and cabasa
|-
|15
| colspan="2" |N/A
|-
|16
|42
|celesta
|-
! rowspan="13" |0D
| rowspan="13" |09_level_slide
| rowspan="13" |instruments
|1
|00, 01
|banjo
|-
|2
|00, 01
|banjo
|-
|3
|02
|fiddle
|-
|4
|02
|fiddle
|-
|5
|03
|whistle with vibrato
|-
|6
|04
|harpischord
|-
|7
|05
|acoustic bass
|-
|8
| colspan="2" rowspan="2" |N/A
|-
|9
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|cymbal
|-
|12
|10, 11
|crash cymbal
|-
|13
|12, 13
|hand clap and snare drum
|-
! rowspan="7" |0E
| rowspan="7" |04_level_inside_casle
15_cutscene_star_spawn
| rowspan="7" |instruments
|1
|23, 24, 25
|strings
|-
|2
|23, 24, 25
|strings
|-
|3
|23, 24, 25
|strings
|-
|4
|46, 47
|pizzicato strings
|-
|5
|2D
|cello
|-
|6
|26
|electric piano (main water instrument)
|-
|7
|26
|electric piano (main water instrument)
|-
! rowspan="4" |0F
| rowspan="4" |06_water_hot
| rowspan="4" |instruments
|1
|2A, 2B, 2C
|percussion loop
|-
|2
|22
|choir (known from Bowser stages)
|-
|3
|28
|sitar
|-
|4
|39
|sitar
|-
! rowspan="10" |10
| rowspan="10" |0A_level_spooky
| rowspan="10" |instruments
|1
|3E
|dark ambience (known from ghost state)
|-
|2
|3E
|dark ambience (known from ghost state)
|-
|3
|3F
|low cowbell
|-
|4
| colspan="2" |N/A
|-
|5
|40
|high cowbell
|-
|6
|40
|high cowbell
|-
|7
|40
|high cowbell
|-
|8
| colspan="2" rowspan="2" |N/A
|-
|9
|-
|10
|(percussion)
|
|-
! rowspan="14" |11
| rowspan="14" |02_menu_title_screen
| rowspan="14" |instruments
|1
|08, 38
|drum machine kick / snare split
|-
|2
|21
|lead 8 (bass+lead)
|-
|3
| colspan="2" |N/A
|-
|4
|35
|percussive organ
|-
|5
|48
|steel drums
|-
|6
|19
|brass
|-
|7
|1A
|slap bass
|-
|8
|1B
|synth voice
|-
|9
|1C
|electric guitar (clean)
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|closed/open hi-hat
|-
|12
|10, 11
|crash cymbal and ride cymbal
|-
|13
|12, 13
|snare drum
|-
|14
|1E, 1F, 20
|triangle and cabasa
|-
! rowspan="12" |12
| rowspan="12" |07_level_boss_koopa
10_event_koopa_message
| rowspan="12" |instruments
|1
|30
|charang (lead 5)
|-
|2
|31
|overdriven guitar
|-
|3
|31
|overdriven guitar
|-
|4
|32, 33
|drum sample
|-
|5
|0E, 0F
|recorder
|-
|6
| colspan="2" |N/A
|-
|7
|10, 11
|strings
|-
|8
| colspan="2" |N/A
|-
|9
|29
|orchestra hit
|-
|10
| colspan="2" |N/A
|-
|11
|34
|closed/open hi-hat
|-
|12
|23, 24, 25
|crash cymbal and ride cymbal
|-
! rowspan="16" |13
| rowspan="16" |05_level_water
| rowspan="16" |instruments
|1
|23, 24, 25
|strings
|-
|2
|23, 24, 25
|strings
|-
|3
| colspan="2" rowspan="4" |N/A
|-
|4
|-
|5
|-
|6
|-
|7
|21
|electric bass
|-
|8
| colspan="2" rowspan="2" |N/A
|-
|9
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|closed/open hi-hat
|-
|12
|10, 11
|crash cymbal and ride cymbal
|-
|13
| colspan="2" rowspan="2" |N/A
|-
|14
|-
|15
|26
|electric piano (main water instrument)
|-
|16
|26
|electric piano (main water instrument)
|-
! rowspan="5" |14
| rowspan="5" |0B_event_piranha_plant
1B_event_solve_puzzle
| rowspan="5" |piranha_music_box
|1
|00
|music box
|-
|2
|00
|music box
|-
|3
|00
|music box
|-
|4
|00
|music box
|-
|5
|00
|music box
|-
! rowspan="10" |15
| rowspan="10" |0C_level_underground
| rowspan="10" |instruments
|1
|1D
|melodic tom
|-
|2
|1E, 1F, 20
|triangle
|-
|3
|21
|electric bass
|-
|4
|1A
|slap bass
|-
|5
|21
|electric bass
|-
|6
|04
|acoustic steel guitar
|-
|7
|1D
|melodic tom
|-
|8
|22
|choir (known from Bowser stages)
|-
|9
|22
|choir (known from Bowser stages)
|-
|10
|(percussion)
|
|-
! rowspan="2" |16
| rowspan="2" |0D_menu_star_select
| rowspan="2" |course_start
|1
|00
|
|-
|2
|00
|
|-
! rowspan="13" |17
| rowspan="13" |0E_event_powerup
| rowspan="13" |instruments
|1
|3B, 3C, 3D
|acoustic bass
|-
|2
|05
|banjo
|-
|3
|23, 24, 25
|strings
|-
|4
|23, 24, 25
|strings
|-
|5
|26
|electric piano (main water instrument)
|-
|6
| colspan="2" rowspan="4" |N/A
|-
|7
|-
|8
|-
|9
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|crash cymbal
|-
|12
|10, 11
|cymbal
|-
|13
|1E, 1F, 20
|triangle and cabasa
|-
! rowspan="15" |18
| rowspan="15" |0F_event_metal_cap
| rowspan="15" |instruments
|1
|35
|organ
|-
|2
|36
|synth bass
|-
|3
|37
|saw wave
|-
|4
|29
|orchestra hit
|-
|5
| colspan="2" rowspan="5" |N/A
|-
|6
|-
|7
|-
|8
|-
|9
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|cymbal
|-
|12
| colspan="2" |N/A
|-
|13
|1E, 1F, 20
|triangle and cabasa
|-
|14
|12, 13
|orchestral percussion
|-
|15
|08, 38
|drum machine kick and snare split
|-
! rowspan="13" |19
| rowspan="13" |11_level_koopa_road
| rowspan="13" |instruments
|1
|22
|choir (known from Bowser stages)
|-
|2
|19
|trumpet
|-
|3
|23, 24, 25
|strings
|-
|4
|28
|sitar
|-
|5
|29
|orchestra hit
|-
|6
|2A, 2B, 2C
|percussion loop
|-
|7
|19
|trumpet
|-
|8
|22
|choir (known from Bowser stages)
|-
|9
| colspan="2" |N/A
|-
|10
|(percussion)
|
|-
|11
|12, 13
|drum sample
|-
|12
|10, 11
|crash cymbal
|-
|13
|18
|timpani
|-
! rowspan="13" |1A
| rowspan="13" |14_event_race
17_cutscene_collect_key

1F_cutscene_victory
| rowspan="13" |instruments
|1
|17
|trumpet
|-
|2
|2D
|cello or low woodwind
|-
|3
|16
|French horn
|-
|4
|14, 15
|strings
|-
|5
|19
|trumpet
|-
|6
|26
|electric piano (main water instrument)
|-
|7
| colspan="2" rowspan="4" |N/A
|-
|8
|-
|9
|-
|10
|-
|11
|18
|timpani
|-
|12
|10, 11
|crash cymbal
|-
|13
|12, 13
|drum sampel
|-
! rowspan="12" |1B
| rowspan="12" |16_event_boss
1E_cutscene_intro

22_cutscene_lakitu
| rowspan="12" |instruments
|1
|14, 15
|strings
|-
|2
|14, 15
|strings
|-
|3
|16
|French horn
|-
|4
|17
|trumpet
|-
|5
|15
|strings
|-
|6
| colspan="2" rowspan="2" |N/A
|-
|7
|-
|8
|18
|timpani
|-
|9
|12, 13
|drum sample
|-
|10
|(percussion)
|
|-
|11
| colspan="2" |N/A
|-
|12
|10, 11
|crash cymbal
|-
! rowspan="7" |1C
| rowspan="7" |18_event_endless_stairs
| rowspan="7" |instruments
|1
|3A
|xylophone
|-
|2
|3A
|xylophone
|-
|3
|3A
|xylophone
|-
|4
| colspan="2" |N/A
|-
|5
|14, 15
|strings
|-
|6
|14, 15
|strings
|-
|7
|14, 15
|strings
|-
! rowspan="6" |1D
| rowspan="6" |19_level_boss_koopa_final
| rowspan="6" |instruments
|1
|00, 01
|church organ
|-
|2
|00, 01
|church organ
|-
|3
|00, 01
|church organ
|-
|4
|00, 01
|church organ
|-
|5
|00, 01
|church organ
|-
|6
|02
|choir
|-
! rowspan="4" |1E
| rowspan="4" |1D_event_peach_message
| rowspan="4" |instruments
|1
|27
|acoustic guitar
|-
|2
|27
|acoustic guitar
|-
|3
|23, 24, 25
|strings
|-
|4
|23, 24, 25
|strings
|-
! rowspan="13" |1F
| rowspan="13" |12_event_high_score
| rowspan="13" |instruments
|1
|2E
|accordion
|-
|2
| colspan="2" |N/A
|-
|3
|2E
|accordion
|-
|4
| colspan="2" rowspan="8" |N/A
|-
|5
|-
|6
|-
|7
|-
|8
|-
|9
|-
|10
|-
|11
|-
|12
|2F
|bells
|-
|13
|12, 13
|snaare drum
|-
! rowspan="9" |20
| rowspan="9" |1C_event_toad_message
| rowspan="9" |instruments
|1
|16
|French horn
|-
|2
| colspan="2" rowspan="6" |N/A
|-
|3
|-
|4
|-
|5
|-
|6
|-
|7
|-
|8
|16
|French horn
|-
|9
|23, 24, 25
|strings
|-
! rowspan="4" |21
| rowspan="4" |0A_level_spooky
event_merry_go_round
| rowspan="4" |instruments
|1
|2E
|accordion
|-
|2
| colspan="2" |N/A
|-
|3
|2E
|accordion
|-
|4
|26
|electric piano (main water instrument)
|-
! rowspan="12" |22
| rowspan="12" |01_cutscene_collect_star
03_level_grass
| rowspan="12" |instruments
|1
|19
|brass
|-
|2
| colspan="2" rowspan="5" |N/A
|-
|3
|-
|4
|-
|5
|-
|6
|-
|7
|1A
|slap bass
|-
|8
|1B
|synth voice
|-
|9
|1C
|electric guitar (muted)
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|open/closed hi-hat
|-
|12
|10, 11
|crash cymbal and ride cymbal
|-
! rowspan="8" |23
| rowspan="8" |20_cutscene_ending
| rowspan="8" |instruments
|1
|23, 24, 25
|strings
|-
|2
|23, 24, 25
|strings
|-
|3
|23, 24, 25
|strings
|-
|4
| colspan="2" rowspan="2" |N/A
|-
|5
|-
|6
|26
|electric piano (main water instrument)
|-
|7
|26
|electric piano (main water instrument)
|-
|8
|27
|acoustic guitar
|-
! rowspan="10" |24
| rowspan="10" |21_menu_file_select
| rowspan="10" |instruments
|1
|41
|pan flute
|-
|2
|41
|pan flute
|-
|3
|14, 15
|strings
|-
|4
|22
|choir (known from Bowser stages)
|-
|5
| colspan="2" rowspan="5" |N/A
|-
|6
|-
|7
|-
|8
|-
|9
|-
|10
|(percussion)
|
|-
! rowspan="16" |25
| rowspan="16" |1A_cutscene_credits
| rowspan="16" |instruments
|1
|43
|accordion
|-
|2
|1A
|slap bass
|-
|3
|1C
|electric guitar (jazz)
|-
|4
|26
|electric piano (main water instrument)
|-
|5
|44
|grand piano
|-
|6
|16, 45
|French horn
|-
|7
|41
|pan flute
|-
|8
|23, 24, 25
|strings
|-
|9
|26
|electric piano (main water instrument)
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|closed/open hi-hat
|-
|12
|10, 11
|crash cymbal and ride cymbal
|-
|13
|1E, 1F, 20
|triangle and cabasa
|-
|14
| colspan="2" |N/A
|-
|15
|43
|accordion
|-
|16
|44
|grand piano
|}

== See also ==

* [[List of instruments|List of Instruments]]

[[Category:Audio]]

List of instruments

2020-11-08T20:48:56Z

Tenry:

{| class="wikitable"
! Instrument !! Sound bank/instrument !! Envelope !! Release rate !! Normal range !! Samples
|-
! church organ
| 1D/00, 1D/01, 1D/02, 1D/03, 1D/04 || 2: 32700, 1: 32700, 32700: 29430, hang || 19 || 0; 50 || bowser_organ: 00, 01 (hi)
|-
! church organ
| 1D/05 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || bowser_organ: 02
|-
!
| 16/00, 16/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || course_start: 00_la
|-
! banjo
| 0D/00, 0D/01 || 2: 32700, 130: 4954, 523: 0, hang || 100 || 41; 127 || instruments: 00 (lo), 01
|-
! fiddle
| 0D/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 180 || 0; 127 || rowspan="2" | instruments: 02
|-
! fiddle
| 0D/03 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127
|-
! whistle with vibrato
| 0D/04 || 2: 32700, 1: 32700, 32700: 29430, hang || 76 || 0; 127 || instruments: 03
|-
! harpischord
| 0D/05, 15/05 || 2: 32700, 205: 0, 1: 0, hang || 53 || 0; 127 || instruments: 04
|-
! acoustic bass
| 0D/06, 17/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 05
|-
! drum machine kick / snare split
| 11/00, 18/0E || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 19; 19 || instruments: 38 (lo), 08 (tuning: 2.121321), 38 (hi)
|-
! cymbal, closed/open hi-hat
| 0B/0A, 0D/0A, 11/0A, 12/0A, 13/0A, 17/0A, 18/0A, 22/0A, 25/0A || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 24; 127 || instruments: 0E (lo), 0F
|-
! crash cymbal
| 0C/0B, 0D/0B, 11/0B, 12/0B, 13/0B, 17/0B, 19/0B, 1A/0B, 1B/0B, 22/0B, 25/0B || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 28; 28 || instruments: 10 (lo), 11, 10 (hi)
|-
! hand clap and snare drum
| 0C/0C, 0D/0C, 11/0C, 18/0D, 19/0A, 1A/0C, 1B/08, 1F/0C || 2: 32700, 55: 32700, 127: 0, hang || 10 || 18; 127 || instruments: 12 (lo), 13
|-
! strings
| 1A/03, 1B/00, 1B/01, 1B/04, 1C/04, 1C/05, 1C/06, 24/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 24 || 42; 127 || instruments: 14 (lo), 15
|-
! French horn
| 0B/06, 0B/07, 1A/02, 1B/02, 20/00, 20/07 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 16
|-
! French horn
| 25/05 || 2: 32700, 1: 32700, 32700: 29430, hang || 53 || 0; 50 || instruments: 16, 45 (hi)
|-
! trumpet
| 1A/00, 1B/03 || 2: 32700, 1: 32700, 32700: 29430, hang || 67 || 0; 127 || instruments: 17
|-
! timpani
| 19/0C, 1A/0A, 1B/07 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 18
|-
! brass
| 11/05, 19/01, 19/06, 1A/04, 22/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 19
|-
! slap bass
| 11/06, 15/03, 22/06, 25/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 1A
|-
! synth voice
| 11/07, 22/07 || 2: 32700, 205: 19818, 535: 0, hang || 128 || 0; 127 || instruments: 1B
|-
! electric guitar (clean)
| 11/08, 22/08, 25/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 1C
|-
! melodic tom
| 15/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 34 || 0; 127 || rowspan="2" | instruments: 1D
|-
! melodic tom
| 15/06 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127
|-
! triangle and cabasa
| 0C/0D, 11/0D, 15/01, 17/0C, 18/0C, 25/0C || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 60; 60 || instruments: 1E (lo), 1F, 20 (hi)
|-
! lead 8 (bass+lead)
| 0C/06, 11/01, 13/06 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || rowspan="3" | instruments: 21
|-
! lead 8 (bass+lead)
| 15/02 || 2: 32700, 205: 18167, 205: 0, hang || 10 || 0; 127
|-
! lead 8 (bass+lead)
| 15/04 || 2: 32700, 205: 18167, 205: 0, hang || 114 || 0; 127
|-
! choir
| 0F/01, 15/07, 15/08, 19/00, 19/07, 24/03 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 22
|-
! strings
| 0E/00, 0E/01, 0E/02, 12/06, 13/00, 13/01, 17/02, 17/03, 19/02, 1E/02, 1E/03, 20/08, 23/00, 23/01, 23/02, 25/07 || 6: 32700, 1: 32700, 32700: 29430, hang || 15 || 27; 46 || instruments: 23 (lo), 24, 25 (hi)
|-
! electric piano
| 0E/05, 13/0E, 17/04, 1A/05, 21/03, 23/05, 25/03 || 6: 32700, 298: 0, 1: 0, hang || 10 || 0; 127 || rowspan="2" | instruments: 26
|-
! electric piano
| 0E/06, 13/0F, 23/06, 25/08 || 3: 32700, 298: 0, 1: 0, hang || 10 || 0; 127
|-
! acoustic guitar
| 1E/00, 23/07 || 2: 32700, 202: 0, 1: 0, hang || 255 || 0; 127 || rowspan="2" | instruments: 27
|-
! acoustic guitar
| 1E/01 || 2: 32700, 82: 0, 1: 0, hang || 255 || 0; 127
|-
! sitar
| 0F/02, 19/03 || 2: 32700, 1: 32700, 32700: 29430, hang || 90 || 0; 127 || instruments: 28
|-
! orchestra hit
| 12/03, 18/03, 19/04 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 29
|-
! percussion loop
| 0F/00, 19/05 || 2: 32700, 187: 0, 32700: 0, hang || 100 || 55; 56 || instruments: 2A (lo), 2B, 2C (hi)
|-
! cello
| 0E/04, 1A/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 119 || 0; 127 || instruments: 2D
|-
! accordion
| 0B/01, 0B/02, 1F/00, 1F/02, 21/00, 21/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 2E
|-
! jingles
| 0B/0B, 1F/0B || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 2F
|-
! charang (lead 5)
| 12/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 30
|-
! overdriven guitar
| 12/01, 12/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 31
|-
! drum sample
| 12/08 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 14; 15 || instruments: 32 (tuning: 2.244924) (lo), 33, 32 (tuning: 2.828428) (hi)
|-
! recorder
| 0C/07, 12/04 || 2: 32700, 1: 32700, 32700: 29430, hang || 114 || 0; 127 || rowspan="2" | instruments: 34
|-
! recorder
| 0C/08 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127
|-
! percussive organ
| 11/03, 18/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 35
|-
! synth bass
| 18/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 36
|-
! saw wave
| 18/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 37
|-
! sitar
| 0F/03 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 39
|-
! xylophone
| 1C/00, 1C/01, 1C/02 || 6: 32700, 298: 32700, 32700: 29430, hang || 119 || 0; 127 || instruments: 3A
|-
! acoustic guitar
| 0B/00, 0C/00, 17/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 19 || 29; 63 || rowspan="3" | instruments: 3B (lo), 3C, 3D (hi)
|-
! acoustic guitar
| 0C/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 24 || 29; 61
|-
! acoustic guitar
| 0C/02, 0C/03, 0C/04, 0C/05 || 2: 32700, 205: 1651, 211: 0, hang || 38 || 29; 61
|-
! dark ambience
| 10/00, 10/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 3E
|-
! low cowbell
| 10/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 3F
|-
! high cowbell
| 10/04 || 2: 32700, 145: 7597, 343: 0, hang || 10 || 0; 127 || rowspan="3" | instruments: 40
|-
! high cowbell
| 10/05 || 2: 32700, 154: 7597, 295: 0, hang || 10 || 0; 127
|-
! high cowbell
| 10/06 || 2: 32700, 145: 8257, 325: 0, hang || 10 || 0; 127
|-
! pan flute
| 24/00, 25/06 || 2: 32700, 1: 32700, 32700: 29430, hang || 43 || 0; 127 || rowspan="2" | instruments: 41
|-
! pan flute
| 24/01 || 26: 32700, 1: 32700, 32700: 29430, hang || 43 || 0; 127
|-
! celesta
| 0C/0F || 2: 32700, 103: 24112, 409: 0, hang || 10 || 0; 127 || instruments: 42
|-
! accordion
| 25/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 19 || 0; 127 || rowspan="2" | instruments: 43
|-
! accordion
| 25/0E || 11: 32700, 1: 32700, 32700: 29430, hang || 34 || 0; 127
|-
! grand piano
| 25/04 || 2: 32700, 205: 0, 1: 0, hang || 34 || 0; 127 || rowspan="2" | instruments: 44
|-
! grand piano
| 25/0F || 2: 32700, 205: 0, 1: 0, hang || 10 || 0; 127
|-
! pizzicato strings
| 0E/03 || 2: 32700, 136: 0, 32700: 0, hang || 43 || 0; 47 || instruments: 46, 47 (hi)
|-
! steel drums
| 11/04 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 48
|-
! music box
| 14/00, 14/01, 14/02, 14/03, 14/04 || 6: 32700, 298: 32700, 32700: 29430, hang || 119 || 0; 127 || piranha_music_box: 00_pling
|}

== See also ==

* [[List of sound banks]]

[[Category:Audio]]

List of sound banks

2020-11-08T20:48:37Z

Tenry:

{| class="wikitable"
!Sound bank
!Sample bank
!Instrument no.
!Samples
!Description
|-
| rowspan="6" |00
| rowspan="6" |sfx_1
|1
|00_twirl
|
|-
|2
|01_brushing
|
|-
|3
|02_hand_touch
|
|-
|4
|03_yoshi
|
|-
|5
|04_plop
|
|-
|6
|05_heavy_landing
|
|-
| rowspan="9" |01
| rowspan="9" |sfx_terrain
|1
|00_step_default
|
|-
|2
|01_step_grass
|
|-
|3
|N/A
|
|-
|4
|02_step_stone
|
|-
|5
|03_step_spooky
|
|-
|6
|04_step_snow
|
|-
|7
|05_step_ice
|
|-
|8
|06_step_metal
|
|-
|9
|07_step_sand
|
|-
| rowspan="3" |02
| rowspan="3" |sfx_water
|1
|00_plunge
|
|-
|2
|01_splash
|
|-
|3
|02_swin
|
|-
| rowspan="10" |03
| rowspan="10" |sfx_4
|1
|00
|
|-
|2
|01
|
|-
|3
|02
|
|-
|4
|03
|
|-
|5
|04
|
|-
|6
|05
|
|-
|7
|06
|
|-
|8
|07
|
|-
|9
|08
|
|-
|10
|09
|
|-
| rowspan="16" |04
| rowspan="16" |sfx_5
|1
|00
|warp sound (hole/pipe)
|-
|2
|01
|door knob
|-
|3
|02
|opening door
|-
|4
|03
|opening metal door
|-
|5
|04
|door closing
|-
|6
|05
|flowing water
|-
|7
|06
|bubble
|-
|8
| colspan="2" |N/A
|-
|9
|07
|
|-
|10
|08
|door knob
|-
|11
|09
|
|-
|12
|0A
|
|-
|13
| colspan="2" |N/A
|-
|14
|0B
|thrown out of painting
|-
|15
|0C
|star catch/warp
|-
|16
|0D
|
|-
| rowspan="16" |05
| rowspan="16" |sfx_5
|1
|0E
|gunshot (Koopa the QUick race start)
|-
|2
|0F
|
|-
|3
|10
|
|-
|4
|11
|
|-
|5
|02
|opening door
|-
|6
|12
|
|-
|7
|13
|wind
|-
|8
|14
|destroyed box
|-
|9
|15
|bird chirp 1
|-
|10
|16
|bird chirp 2
|-
|11
|17
|bird chirp 3
|-
|12
|18
|bird chirp 4
|-
|13
|19
|bird chirp 5
|-
|14
|1A
|
|-
|15
|1B
|jumping box
|-
|16
|1C
|
|-
| rowspan="16" |06
| rowspan="16" |sfx_6
|1
|00
|Mips the bunny
|-
|2
|01
|
|-
|3
|02
|rawr (Bowser)
|-
|4
| colspan="2" |N/A
|-
|5
|03
|Bowser death
|-
|6
|04
|swoosh
|-
|7
|05
|Bowser inhale
|-
|8
|06
|baby penguin
|-
|9
|07
|
|-
|10
|08
|Boo
|-
|11
|09
|cannon moving sound 1
|-
|12
|0A
|cannon moving sound 2
|-
|13
|0B
|door knob
|-
|14
| colspan="2" |N/A
|-
|15
|0C
|Piranha Plant dying
|-
|16
|0D
|pushing box
|-
| rowspan="15" |07
| rowspan="15" |sfx_7
|1
|00
|
|-
|2
|01
|
|-
|3
|02
|scuttlebug step
|-
|4
|03
|
|-
|5
| colspan="2" |N/A
|-
|6
|04
|
|-
|7
|05
|
|-
|8
|06
|Ukiki
|-
|9
|07
|
|-
|10
|08
|
|-
|11
|09
|
|-
|12
|0A
|cowbell
|-
|13
|0B
|Whomp/Thwomp
|-
|14
|0C
|piano chomping sound
|-
|15
|0D
|Chain Chomp
|-
| rowspan="27" |08
| rowspan="27" |sfx_mario
|1
|00
|
|-
|2
|01
|
|-
|3
|02
|
|-
|4
|03
|
|-
|5
|04
|
|-
|6
|05
|
|-
|7
|06
|
|-
|8
|07
|
|-
|9
|08
|
|-
|10
|09
|
|-
|11
|0A
|
|-
|12
|0B
|
|-
|13
|0C
|
|-
|14
|0D
|
|-
|15
|0E
|
|-
|16
|0F
|
|-
|17
|10
|
|-
|18
|11
|
|-
|19
|12
|
|-
|20
|13
|
|-
|21
|14
|
|-
|22
|15
|
|-
|23
|16
|
|-
|24
|17
|
|-
|25
|18
|
|-
|26
|19
|
|-
|27
|1A
|
|-
| rowspan="7" |09
| rowspan="7" |sfx_9
|1
|00, 01
|
|-
|2
|02
|
|-
|3
|00
|
|-
|4
|03
|
|-
|5
|04
|
|-
|6
|05
|
|-
|7
|06
|
|-
| rowspan="24" |0A
| rowspan="24" |sfx_mario_peach
|1
|00
|
|-
|2
|01
|
|-
|3
|02
|
|-
|4
|N/A
|
|-
|5
|03
|
|-
|6
|04
|
|-
|7
|05
|
|-
|8
|06
|
|-
|9
|07
|
|-
|10
|08
|
|-
|11
|09
|
|-
|12
|0A
|
|-
|13
|0B
|
|-
|14
|0C
|
|-
|15
|0D
|
|-
|16
|0E
|
|-
|17
|0F
|
|-
|18
|10
|
|-
|19
|11
|
|-
|20
|12
|
|-
|21
|13
|
|-
|22
|14
|
|-
|23
|15
|
|-
|24
|16
|
|-
| rowspan="12" |0B
| rowspan="12" |instruments
|1
|3B, 3C, 3D
|acoustic guitar
|-
|2
|2E
|accordion
|-
|3
|2E
|accordion
|-
|4
| colspan="2" rowspan="3" |N/A
|-
|5
|-
|6
|-
|7
|16
|French horn
|-
|8
|16
|French horn
|-
|9
| colspan="2" rowspan="2" |N/A
|-
|10
|-
|11
|0F
|cymbal
|-
|12
|2F
|jingles
|-
| rowspan="16" |0C
| rowspan="16" |instruments
|1
|3B, 3C, 3D
|acoustic guitar
|-
|2
|3B, 3C, 3D
|acoustic guitar
|-
|3
|3B, 3C, 3D
|acoustic guitar
|-
|4
|3B, 3C, 3D
|acoustic guitar
|-
|5
|3B, 3C, 3D
|acoustic guitar
|-
|6
|3B, 3C, 3D
|acoustic guitar
|-
|7
|21
|bass
|-
|8
|34
|recorder
|-
|9
|34
|recorder
|-
|10
|(percussion)
|
|-
|11
| colspan="2" |N/A
|-
|12
|10, 11
|crash cymbal
|-
|13
|12, 13
|snare drum
|-
|14
|1E, 1F, 20
|triangle and cabasa
|-
|15
| colspan="2" |N/A
|-
|16
|42
|celesta
|-
| rowspan="13" |0D
| rowspan="13" |instruments
|1
|00, 01
|banjo
|-
|2
|00, 01
|banjo
|-
|3
|02
|fiddle
|-
|4
|02
|fiddle
|-
|5
|03
|whistle with vibrato
|-
|6
|04
|harpischord
|-
|7
|05
|acoustic bass
|-
|8
| colspan="2" rowspan="2" |N/A
|-
|9
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|cymbal
|-
|12
|10, 11
|crash cymbal
|-
|13
|12, 13
|hand clap and snare drum
|-
| rowspan="7" |0E
| rowspan="7" |instruments
|1
|23, 24, 25
|strings
|-
|2
|23, 24, 25
|strings
|-
|3
|23, 24, 25
|strings
|-
|4
|46, 47
|pizzicato strings
|-
|5
|2D
|cello
|-
|6
|26
|electric piano (main water instrument)
|-
|7
|26
|electric piano (main water instrument)
|-
| rowspan="4" |0F
| rowspan="4" |instruments
|1
|2A, 2B, 2C
|percussion loop
|-
|2
|22
|choir (known from Bowser stages)
|-
|3
|28
|sitar
|-
|4
|39
|sitar
|-
| rowspan="10" |10
| rowspan="10" |instruments
|1
|3E
|dark ambience (known from ghost state)
|-
|2
|3E
|dark ambience (known from ghost state)
|-
|3
|3F
|low cowbell
|-
|4
| colspan="2" |N/A
|-
|5
|40
|high cowbell
|-
|6
|40
|high cowbell
|-
|7
|40
|high cowbell
|-
|8
| colspan="2" rowspan="2" |N/A
|-
|9
|-
|10
|(percussion)
|
|-
| rowspan="14" |11
| rowspan="14" |instruments
|1
|08, 38
|drum machine kick / snare split
|-
|2
|21
|lead 8 (bass+lead)
|-
|3
| colspan="2" |N/A
|-
|4
|35
|percussive organ
|-
|5
|48
|steel drums
|-
|6
|19
|brass
|-
|7
|1A
|slap bass
|-
|8
|1B
|synth voice
|-
|9
|1C
|electric guitar (clean)
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|closed/open hi-hat
|-
|12
|10, 11
|crash cymbal and ride cymbal
|-
|13
|12, 13
|snare drum
|-
|14
|1E, 1F, 20
|triangle and cabasa
|-
| rowspan="12" |12
| rowspan="12" |instruments
|1
|30
|charang (lead 5)
|-
|2
|31
|overdriven guitar
|-
|3
|31
|overdriven guitar
|-
|4
|32, 33
|drum sample
|-
|5
|0E, 0F
|recorder
|-
|6
| colspan="2" |N/A
|-
|7
|10, 11
|strings
|-
|8
| colspan="2" |N/A
|-
|9
|29
|orchestra hit
|-
|10
| colspan="2" |N/A
|-
|11
|34
|closed/open hi-hat
|-
|12
|23, 24, 25
|crash cymbal and ride cymbal
|-
| rowspan="16" |13
| rowspan="16" |instruments
|1
|23, 24, 25
|strings
|-
|2
|23, 24, 25
|strings
|-
|3
| colspan="2" rowspan="4" |N/A
|-
|4
|-
|5
|-
|6
|-
|7
|21
|electric bass
|-
|8
| colspan="2" rowspan="2" |N/A
|-
|9
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|closed/open hi-hat
|-
|12
|10, 11
|crash cymbal and ride cymbal
|-
|13
| colspan="2" rowspan="2" |N/A
|-
|14
|-
|15
|26
|electric piano (main water instrument)
|-
|16
|26
|electric piano (main water instrument)
|-
| rowspan="5" |14
| rowspan="5" |piranha_music_box
|1
|00
|music box
|-
|2
|00
|music box
|-
|3
|00
|music box
|-
|4
|00
|music box
|-
|5
|00
|music box
|-
| rowspan="10" |15
| rowspan="10" |instruments
|1
|1D
|melodic tom
|-
|2
|1E, 1F, 20
|triangle
|-
|3
|21
|electric bass
|-
|4
|1A
|slap bass
|-
|5
|21
|electric bass
|-
|6
|04
|acoustic steel guitar
|-
|7
|1D
|melodic tom
|-
|8
|22
|choir (known from Bowser stages)
|-
|9
|22
|choir (known from Bowser stages)
|-
|10
|(percussion)
|
|-
| rowspan="2" |16
| rowspan="2" |course_start
|1
|00
|
|-
|2
|00
|
|-
| rowspan="13" |17
| rowspan="13" |instruments
|1
|3B, 3C, 3D
|acoustic bass
|-
|2
|05
|banjo
|-
|3
|23, 24, 25
|strings
|-
|4
|23, 24, 25
|strings
|-
|5
|26
|electric piano (main water instrument)
|-
|6
| colspan="2" rowspan="4" |N/A
|-
|7
|-
|8
|-
|9
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|crash cymbal
|-
|12
|10, 11
|cymbal
|-
|13
|1E, 1F, 20
|triangle and cabasa
|-
| rowspan="15" |18
| rowspan="15" |instruments
|1
|35
|organ
|-
|2
|36
|synth bass
|-
|3
|37
|saw wave
|-
|4
|29
|orchestra hit
|-
|5
| colspan="2" rowspan="5" |N/A
|-
|6
|-
|7
|-
|8
|-
|9
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|cymbal
|-
|12
| colspan="2" |N/A
|-
|13
|1E, 1F, 20
|triangle and cabasa
|-
|14
|12, 13
|orchestral percussion
|-
|15
|08, 38
|drum machine kick and snare split
|-
| rowspan="13" |19
| rowspan="13" |instruments
|1
|22
|choir (known from Bowser stages)
|-
|2
|19
|trumpet
|-
|3
|23, 24, 25
|strings
|-
|4
|28
|sitar
|-
|5
|29
|orchestra hit
|-
|6
|2A, 2B, 2C
|percussion loop
|-
|7
|19
|trumpet
|-
|8
|22
|choir (known from Bowser stages)
|-
|9
| colspan="2" |N/A
|-
|10
|(percussion)
|
|-
|11
|12, 13
|drum sample
|-
|12
|10, 11
|crash cymbal
|-
|13
|18
|timpani
|-
| rowspan="13" |1A
| rowspan="13" |instruments
|1
|17
|trumpet
|-
|2
|2D
|cello or low woodwind
|-
|3
|16
|French horn
|-
|4
|14, 15
|strings
|-
|5
|19
|trumpet
|-
|6
|26
|electric piano (main water instrument)
|-
|7
| colspan="2" rowspan="4" |N/A
|-
|8
|-
|9
|-
|10
|-
|11
|18
|timpani
|-
|12
|10, 11
|crash cymbal
|-
|13
|12, 13
|drum sampel
|-
| rowspan="12" |1B
| rowspan="12" |instruments
|1
|14, 15
|strings
|-
|2
|14, 15
|strings
|-
|3
|16
|French horn
|-
|4
|17
|trumpet
|-
|5
|15
|strings
|-
|6
| colspan="2" rowspan="2" |N/A
|-
|7
|-
|8
|18
|timpani
|-
|9
|12, 13
|drum sample
|-
|10
|(percussion)
|
|-
|11
| colspan="2" |N/A
|-
|12
|10, 11
|crash cymbal
|-
| rowspan="7" |1C
| rowspan="7" |instruments
|1
|3A
|xylophone
|-
|2
|3A
|xylophone
|-
|3
|3A
|xylophone
|-
|4
| colspan="2" |N/A
|-
|5
|14, 15
|strings
|-
|6
|14, 15
|strings
|-
|7
|14, 15
|strings
|-
| rowspan="6" |1D
| rowspan="6" |instruments
|1
|00, 01
|church organ
|-
|2
|00, 01
|church organ
|-
|3
|00, 01
|church organ
|-
|4
|00, 01
|church organ
|-
|5
|00, 01
|church organ
|-
|6
|02
|choir
|-
| rowspan="4" |1E
| rowspan="4" |instruments
|1
|27
|acoustic guitar
|-
|2
|27
|acoustic guitar
|-
|3
|23, 24, 25
|strings
|-
|4
|23, 24, 25
|strings
|-
| rowspan="13" |1F
| rowspan="13" |instruments
|1
|2E
|accordion
|-
|2
| colspan="2" |N/A
|-
|3
|2E
|accordion
|-
|4
| colspan="2" rowspan="8" |N/A
|-
|5
|-
|6
|-
|7
|-
|8
|-
|9
|-
|10
|-
|11
|-
|12
|2F
|bells
|-
|13
|12, 13
|snaare drum
|-
| rowspan="9" |20
| rowspan="9" |instruments
|1
|16
|French horn
|-
|2
| colspan="2" rowspan="6" |N/A
|-
|3
|-
|4
|-
|5
|-
|6
|-
|7
|-
|8
|16
|French horn
|-
|9
|23, 24, 25
|strings
|-
| rowspan="4" |21
| rowspan="4" |instruments
|1
|2E
|accordion
|-
|2
| colspan="2" |N/A
|-
|3
|2E
|accordion
|-
|4
|26
|electric piano (main water instrument)
|-
| rowspan="12" |22
| rowspan="12" |instruments
|1
|19
|brass
|-
|2
| colspan="2" rowspan="5" |N/A
|-
|3
|-
|4
|-
|5
|-
|6
|-
|7
|1A
|slap bass
|-
|8
|1B
|synth voice
|-
|9
|1C
|electric guitar (muted)
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|open/closed hi-hat
|-
|12
|10, 11
|crash cymbal and ride cymbal
|-
| rowspan="8" |23
| rowspan="8" |instruments
|1
|23, 24, 25
|strings
|-
|2
|23, 24, 25
|strings
|-
|3
|23, 24, 25
|strings
|-
|4
| colspan="2" rowspan="2" |N/A
|-
|5
|-
|6
|26
|electric piano (main water instrument)
|-
|7
|26
|electric piano (main water instrument)
|-
|8
|27
|acoustic guitar
|-
| rowspan="10" |24
| rowspan="10" |instruments
|1
|41
|pan flute
|-
|2
|41
|pan flute
|-
|3
|14, 15
|strings
|-
|4
|22
|choir (known from Bowser stages)
|-
|5
| colspan="2" rowspan="5" |N/A
|-
|6
|-
|7
|-
|8
|-
|9
|-
|10
|(percussion)
|
|-
| rowspan="16" |25
| rowspan="16" |instruments
|1
|43
|accordion
|-
|2
|1A
|slap bass
|-
|3
|1C
|electric guitar (jazz)
|-
|4
|26
|electric piano (main water instrument)
|-
|5
|44
|grand piano
|-
|6
|16, 45
|French horn
|-
|7
|41
|pan flute
|-
|8
|23, 24, 25
|strings
|-
|9
|26
|electric piano (main water instrument)
|-
|10
|(percussion)
|
|-
|11
|0E, 0F
|closed/open hi-hat
|-
|12
|10, 11
|crash cymbal and ride cymbal
|-
|13
|1E, 1F, 20
|triangle and cabasa
|-
|14
| colspan="2" |N/A
|-
|15
|43
|accordion
|-
|16
|44
|grand piano
|}

== See also ==

* [[List of instruments|List of Instruments]]

[[Category:Audio]]

List of sound banks

2020-11-08T20:47:41Z

Tenry:

List of instruments

2020-11-08T20:46:05Z

Tenry:

List of instruments

2020-11-08T20:45:11Z

Tenry:

{| class="wikitable"
! Instrument !! Sound bank/instrument !! Envelope !! Release rate !! Normal range !! Samples
|-
! church organ
| 1D/00, 1D/01, 1D/02, 1D/03, 1D/04 || 2: 32700, 1: 32700, 32700: 29430, hang || 19 || 0; 50 || bowser_organ: 00, 01 (hi)
|-
! church organ
| 1D/05 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || bowser_organ: 02
|-
!
| 16/00, 16/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || course_start: 00_la
|-
! banjo
| 0D/00, 0D/01 || 2: 32700, 130: 4954, 523: 0, hang || 100 || 41; 127 || instruments: 00 (lo), 01
|-
! fiddle
| 0D/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 180 || 0; 127 || instruments: 02
|-
! fiddle
| 0D/03 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 02
|-
! whistle with vibrato
| 0D/04 || 2: 32700, 1: 32700, 32700: 29430, hang || 76 || 0; 127 || instruments: 03
|-
! harpischord
| 0D/05, 15/05 || 2: 32700, 205: 0, 1: 0, hang || 53 || 0; 127 || instruments: 04
|-
! acoustic bass
| 0D/06, 17/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 05
|-
! drum machine kick / snare split
| 11/00, 18/0E || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 19; 19 || instruments: 38 (lo), 08 (tuning: 2.121321), 38 (hi)
|-
! cymbal, closed/open hi-hat
| 0B/0A, 0D/0A, 11/0A, 12/0A, 13/0A, 17/0A, 18/0A, 22/0A, 25/0A || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 24; 127 || instruments: 0E (lo), 0F
|-
! crash cymbal
| 0C/0B, 0D/0B, 11/0B, 12/0B, 13/0B, 17/0B, 19/0B, 1A/0B, 1B/0B, 22/0B, 25/0B || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 28; 28 || instruments: 10 (lo), 11, 10 (hi)
|-
! hand clap and snare drum
| 0C/0C, 0D/0C, 11/0C, 18/0D, 19/0A, 1A/0C, 1B/08, 1F/0C || 2: 32700, 55: 32700, 127: 0, hang || 10 || 18; 127 || instruments: 12 (lo), 13
|-
! strings
| 1A/03, 1B/00, 1B/01, 1B/04, 1C/04, 1C/05, 1C/06, 24/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 24 || 42; 127 || instruments: 14 (lo), 15
|-
! French horn
| 0B/06, 0B/07, 1A/02, 1B/02, 20/00, 20/07 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 16
|-
! French horn
| 25/05 || 2: 32700, 1: 32700, 32700: 29430, hang || 53 || 0; 50 || instruments: 16, 45 (hi)
|-
! trumpet
| 1A/00, 1B/03 || 2: 32700, 1: 32700, 32700: 29430, hang || 67 || 0; 127 || instruments: 17
|-
! timpani
| 19/0C, 1A/0A, 1B/07 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 18
|-
! brass
| 11/05, 19/01, 19/06, 1A/04, 22/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 19
|-
! slap bass
| 11/06, 15/03, 22/06, 25/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 1A
|-
! synth voice
| 11/07, 22/07 || 2: 32700, 205: 19818, 535: 0, hang || 128 || 0; 127 || instruments: 1B
|-
! electric guitar (clean)
| 11/08, 22/08, 25/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 1C
|-
! melodic tom
| 15/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 34 || 0; 127 || instruments: 1D
|-
! melodic tom
| 15/06 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 1D
|-
! triangle and cabasa
| 0C/0D, 11/0D, 15/01, 17/0C, 18/0C, 25/0C || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 60; 60 || instruments: 1E (lo), 1F, 20 (hi)
|-
! lead 8 (bass+lead)
| 0C/06, 11/01, 13/06 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 21
|-
! lead 8 (bass+lead)
| 15/02 || 2: 32700, 205: 18167, 205: 0, hang || 10 || 0; 127 || instruments: 21
|-
! lead 8 (bass+lead)
| 15/04 || 2: 32700, 205: 18167, 205: 0, hang || 114 || 0; 127 || instruments: 21
|-
! choir
| 0F/01, 15/07, 15/08, 19/00, 19/07, 24/03 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 22
|-
! strings
| 0E/00, 0E/01, 0E/02, 12/06, 13/00, 13/01, 17/02, 17/03, 19/02, 1E/02, 1E/03, 20/08, 23/00, 23/01, 23/02, 25/07 || 6: 32700, 1: 32700, 32700: 29430, hang || 15 || 27; 46 || instruments: 23 (lo), 24, 25 (hi)
|-
! electric piano
| 0E/05, 13/0E, 17/04, 1A/05, 21/03, 23/05, 25/03 || 6: 32700, 298: 0, 1: 0, hang || 10 || 0; 127 || instruments: 26
|-
! electric piano
| 0E/06, 13/0F, 23/06, 25/08 || 3: 32700, 298: 0, 1: 0, hang || 10 || 0; 127 || instruments: 26
|-
! acoustic guitar
| 1E/00, 23/07 || 2: 32700, 202: 0, 1: 0, hang || 255 || 0; 127 || instruments: 27
|-
! acoustic guitar
| 1E/01 || 2: 32700, 82: 0, 1: 0, hang || 255 || 0; 127 || instruments: 27
|-
! sitar
| 0F/02, 19/03 || 2: 32700, 1: 32700, 32700: 29430, hang || 90 || 0; 127 || instruments: 28
|-
! orchestra hit
| 12/03, 18/03, 19/04 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 29
|-
! percussion loop
| 0F/00, 19/05 || 2: 32700, 187: 0, 32700: 0, hang || 100 || 55; 56 || instruments: 2A (lo), 2B, 2C (hi)
|-
! cello
| 0E/04, 1A/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 119 || 0; 127 || instruments: 2D
|-
! accordion
| 0B/01, 0B/02, 1F/00, 1F/02, 21/00, 21/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 2E
|-
! jingles
| 0B/0B, 1F/0B || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 2F
|-
! charang (lead 5)
| 12/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 30
|-
! overdriven guitar
| 12/01, 12/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 31
|-
! drum sample
| 12/08 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 14; 15 || instruments: 32 (tuning: 2.244924) (lo), 33, 32 (tuning: 2.828428) (hi)
|-
! recorder
| 0C/07, 12/04 || 2: 32700, 1: 32700, 32700: 29430, hang || 114 || 0; 127 || instruments: 34
|-
! recorder
| 0C/08 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 34
|-
! percussive organ
| 11/03, 18/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 35
|-
! synth bass
| 18/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 36
|-
! saw wave
| 18/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 37
|-
! sitar
| 0F/03 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 39
|-
! xylophone
| 1C/00, 1C/01, 1C/02 || 6: 32700, 298: 32700, 32700: 29430, hang || 119 || 0; 127 || instruments: 3A
|-
! acoustic guitar
| 0B/00, 0C/00, 17/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 19 || 29; 63 || instruments: 3B (lo), 3C, 3D (hi)
|-
! acoustic guitar
| 0C/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 24 || 29; 61 || instruments: 3B (lo), 3C, 3D (hi)
|-
! acoustic guitar
| 0C/02, 0C/03, 0C/04, 0C/05 || 2: 32700, 205: 1651, 211: 0, hang || 38 || 29; 61 || instruments: 3B (lo), 3C, 3D (hi)
|-
! dark ambience
| 10/00, 10/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 3E
|-
! low cowbell
| 10/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 3F
|-
! high cowbell
| 10/04 || 2: 32700, 145: 7597, 343: 0, hang || 10 || 0; 127 || instruments: 40
|-
! high cowbell
| 10/05 || 2: 32700, 154: 7597, 295: 0, hang || 10 || 0; 127 || instruments: 40
|-
! high cowbell
| 10/06 || 2: 32700, 145: 8257, 325: 0, hang || 10 || 0; 127 || instruments: 40
|-
! pan flute
| 24/00, 25/06 || 2: 32700, 1: 32700, 32700: 29430, hang || 43 || 0; 127 || instruments: 41
|-
! pan flute
| 24/01 || 26: 32700, 1: 32700, 32700: 29430, hang || 43 || 0; 127 || instruments: 41
|-
! celesta
| 0C/0F || 2: 32700, 103: 24112, 409: 0, hang || 10 || 0; 127 || instruments: 42
|-
! accordion
| 25/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 19 || 0; 127 || instruments: 43
|-
! accordion
| 25/0E || 11: 32700, 1: 32700, 32700: 29430, hang || 34 || 0; 127 || instruments: 43
|-
! grand piano
| 25/04 || 2: 32700, 205: 0, 1: 0, hang || 34 || 0; 127 || instruments: 44
|-
! grand piano
| 25/0F || 2: 32700, 205: 0, 1: 0, hang || 10 || 0; 127 || instruments: 44
|-
! pizzicato strings
| 0E/03 || 2: 32700, 136: 0, 32700: 0, hang || 43 || 0; 47 || instruments: 46, 47 (hi)
|-
! steel drums
| 11/04 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 48
|-
! music box
| 14/00, 14/01, 14/02, 14/03, 14/04 || 6: 32700, 298: 32700, 32700: 29430, hang || 119 || 0; 127 || piranha_music_box: 00_pling
|}

[[Category:Audio]]

List of instruments

2020-11-08T20:37:49Z

Tenry: Removed redirect to List of sound banks

{| class="wikitable"
! Instrument !! Sound bank/instrument !! Envelope !! Release rate !! Normal range !! Samples
|-
| church organ || 1D/00, 1D/01, 1D/02, 1D/03, 1D/04 || 2: 32700, 1: 32700, 32700: 29430, hang || 19 || 0; 50 || bowser_organ: 00, 01 (hi)
|-
| church organ || 1D/05 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || bowser_organ: 02
|-
| || 16/00, 16/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || course_start: 00_la
|-
| banjo || 0D/00, 0D/01 || 2: 32700, 130: 4954, 523: 0, hang || 100 || 41; 127 || instruments: 00 (lo), 01
|-
| fiddle || 0D/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 180 || 0; 127 || instruments: 02
|-
| fiddle || 0D/03 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 02
|-
| whistle with vibrato || 0D/04 || 2: 32700, 1: 32700, 32700: 29430, hang || 76 || 0; 127 || instruments: 03
|-
| harpischord || 0D/05, 15/05 || 2: 32700, 205: 0, 1: 0, hang || 53 || 0; 127 || instruments: 04
|-
| acoustic bass || 0D/06, 17/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 05
|-
| drum machine kick / snare split || 11/00, 18/0E || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 19; 19 || instruments: 38 (lo), 08 (tuning: 2.121321), 38 (hi)
|-
| cymbal, closed/open hi-hat || 0B/0A, 0D/0A, 11/0A, 12/0A, 13/0A, 17/0A, 18/0A, 22/0A, 25/0A || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 24; 127 || instruments: 0E (lo), 0F
|-
| crash cymbal || 0C/0B, 0D/0B, 11/0B, 12/0B, 13/0B, 17/0B, 19/0B, 1A/0B, 1B/0B, 22/0B, 25/0B || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 28; 28 || instruments: 10 (lo), 11, 10 (hi)
|-
| hand clap and snare drum || 0C/0C, 0D/0C, 11/0C, 18/0D, 19/0A, 1A/0C, 1B/08, 1F/0C || 2: 32700, 55: 32700, 127: 0, hang || 10 || 18; 127 || instruments: 12 (lo), 13
|-
| strings || 1A/03, 1B/00, 1B/01, 1B/04, 1C/04, 1C/05, 1C/06, 24/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 24 || 42; 127 || instruments: 14 (lo), 15
|-
| French horn || 0B/06, 0B/07, 1A/02, 1B/02, 20/00, 20/07 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 16
|-
| French horn || 25/05 || 2: 32700, 1: 32700, 32700: 29430, hang || 53 || 0; 50 || instruments: 16, 45 (hi)
|-
| trumpet || 1A/00, 1B/03 || 2: 32700, 1: 32700, 32700: 29430, hang || 67 || 0; 127 || instruments: 17
|-
| timpani || 19/0C, 1A/0A, 1B/07 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 18
|-
| brass || 11/05, 19/01, 19/06, 1A/04, 22/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 19
|-
| slap bass || 11/06, 15/03, 22/06, 25/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 1A
|-
| synth voice || 11/07, 22/07 || 2: 32700, 205: 19818, 535: 0, hang || 128 || 0; 127 || instruments: 1B
|-
| electric guitar (clean) || 11/08, 22/08, 25/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 1C
|-
| melodic tom || 15/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 34 || 0; 127 || instruments: 1D
|-
| melodic tom || 15/06 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 1D
|-
| triangle and cabasa || 0C/0D, 11/0D, 15/01, 17/0C, 18/0C, 25/0C || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 60; 60 || instruments: 1E (lo), 1F, 20 (hi)
|-
| lead 8 (bass+lead) || 0C/06, 11/01, 13/06 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 21
|-
| lead 8 (bass+lead) || 15/02 || 2: 32700, 205: 18167, 205: 0, hang || 10 || 0; 127 || instruments: 21
|-
| lead 8 (bass+lead) || 15/04 || 2: 32700, 205: 18167, 205: 0, hang || 114 || 0; 127 || instruments: 21
|-
| choir || 0F/01, 15/07, 15/08, 19/00, 19/07, 24/03 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 22
|-
| strings || 0E/00, 0E/01, 0E/02, 12/06, 13/00, 13/01, 17/02, 17/03, 19/02, 1E/02, 1E/03, 20/08, 23/00, 23/01, 23/02, 25/07 || 6: 32700, 1: 32700, 32700: 29430, hang || 15 || 27; 46 || instruments: 23 (lo), 24, 25 (hi)
|-
| electric piano || 0E/05, 13/0E, 17/04, 1A/05, 21/03, 23/05, 25/03 || 6: 32700, 298: 0, 1: 0, hang || 10 || 0; 127 || instruments: 26
|-
| electric piano || 0E/06, 13/0F, 23/06, 25/08 || 3: 32700, 298: 0, 1: 0, hang || 10 || 0; 127 || instruments: 26
|-
| acoustic guitar || 1E/00, 23/07 || 2: 32700, 202: 0, 1: 0, hang || 255 || 0; 127 || instruments: 27
|-
| acoustic guitar || 1E/01 || 2: 32700, 82: 0, 1: 0, hang || 255 || 0; 127 || instruments: 27
|-
| sitar || 0F/02, 19/03 || 2: 32700, 1: 32700, 32700: 29430, hang || 90 || 0; 127 || instruments: 28
|-
| orchestra hit || 12/03, 18/03, 19/04 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 29
|-
| percussion loop || 0F/00, 19/05 || 2: 32700, 187: 0, 32700: 0, hang || 100 || 55; 56 || instruments: 2A (lo), 2B, 2C (hi)
|-
| cello || 0E/04, 1A/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 119 || 0; 127 || instruments: 2D
|-
| accordion || 0B/01, 0B/02, 1F/00, 1F/02, 21/00, 21/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 2E
|-
| jingles || 0B/0B, 1F/0B || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 2F
|-
| charang (lead 5) || 12/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 30
|-
| overdriven guitar || 12/01, 12/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 31
|-
| drum sample || 12/08 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 14; 15 || instruments: 32 (tuning: 2.244924) (lo), 33, 32 (tuning: 2.828428) (hi)
|-
| recorder || 0C/07, 12/04 || 2: 32700, 1: 32700, 32700: 29430, hang || 114 || 0; 127 || instruments: 34
|-
| recorder || 0C/08 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 34
|-
| percussive organ || 11/03, 18/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 35
|-
| synth bass || 18/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 36
|-
| saw wave || 18/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 37
|-
| sitar || 0F/03 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 39
|-
| xylophone || 1C/00, 1C/01, 1C/02 || 6: 32700, 298: 32700, 32700: 29430, hang || 119 || 0; 127 || instruments: 3A
|-
| acoustic guitar || 0B/00, 0C/00, 17/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 19 || 29; 63 || instruments: 3B (lo), 3C, 3D (hi)
|-
| acoustic guitar || 0C/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 24 || 29; 61 || instruments: 3B (lo), 3C, 3D (hi)
|-
| acoustic guitar || 0C/02, 0C/03, 0C/04, 0C/05 || 2: 32700, 205: 1651, 211: 0, hang || 38 || 29; 61 || instruments: 3B (lo), 3C, 3D (hi)
|-
| dark ambience || 10/00, 10/01 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 3E
|-
| low cowbell || 10/02 || 2: 32700, 1: 32700, 32700: 29430, hang || 208 || 0; 127 || instruments: 3F
|-
| high cowbell || 10/04 || 2: 32700, 145: 7597, 343: 0, hang || 10 || 0; 127 || instruments: 40
|-
| high cowbell || 10/05 || 2: 32700, 154: 7597, 295: 0, hang || 10 || 0; 127 || instruments: 40
|-
| high cowbell || 10/06 || 2: 32700, 145: 8257, 325: 0, hang || 10 || 0; 127 || instruments: 40
|-
| pan flute || 24/00, 25/06 || 2: 32700, 1: 32700, 32700: 29430, hang || 43 || 0; 127 || instruments: 41
|-
| pan flute || 24/01 || 26: 32700, 1: 32700, 32700: 29430, hang || 43 || 0; 127 || instruments: 41
|-
| celesta || 0C/0F || 2: 32700, 103: 24112, 409: 0, hang || 10 || 0; 127 || instruments: 42
|-
| accordion || 25/00 || 2: 32700, 1: 32700, 32700: 29430, hang || 19 || 0; 127 || instruments: 43
|-
| accordion || 25/0E || 11: 32700, 1: 32700, 32700: 29430, hang || 34 || 0; 127 || instruments: 43
|-
| grand piano || 25/04 || 2: 32700, 205: 0, 1: 0, hang || 34 || 0; 127 || instruments: 44
|-
| grand piano || 25/0F || 2: 32700, 205: 0, 1: 0, hang || 10 || 0; 127 || instruments: 44
|-
| pizzicato strings || 0E/03 || 2: 32700, 136: 0, 32700: 0, hang || 43 || 0; 47 || instruments: 46, 47 (hi)
|-
| steel drums || 11/04 || 2: 32700, 1: 32700, 32700: 29430, hang || 10 || 0; 127 || instruments: 48
|-
| music box || 14/00, 14/01, 14/02, 14/03, 14/04 || 6: 32700, 298: 32700, 32700: 29430, hang || 119 || 0; 127 || piranha_music_box: 00_pling
|}

[[Category:Audio]]

Main Page

2020-11-08T18:22:16Z

Tenry:

Welcome to SM64Decomp project wiki! This website is meant to help people working on the [https://github.com/n64decomp/sm64 Super Mario 64 Decompilation] project, especially on customizing the code for creating individual hacks.

Please note that editing is currently restricted to a few selected users.

This wiki is maintainted by [[User:Tenry|Tenry]] and is not associated with the decomp organization.

== Categories ==

* [[:Category:Level|Level]] - everything you need if you want to create or modify a level or objects
* [[:Category:Coding|Coding]] - if you want to do custom coding or general enhancements
* [[:Category:Graphics|Graphics]] - if you want to change graphics or how they are displayed
* [[:Category:Audio|Audio]] - if you want to work with the sound effects or music

== External resources ==

* [[List of Discord servers]]
* [https://ukikipedia.net/wiki/Main_Page Ukikipedia]
* [https://hack64.net/wiki/doku.php?id=start Hack64]
* [https://docs.google.com/document/d/1pSYR91UiMVKnP3PyvJiCdwRF5wNS_nZzMe-r2WPQUJk/edit?usp=sharing SM64 ROM Hacking Tools and Resources] (Google Docs)

== Contribution guidelines ==

* Do ''not'' provide uploads or link to ROM images or provide information on how to illegally obtain them
* Do ''not'' post leaked source code

=== Page name policy ===
'''Use sentence case.''' Titles are written in sentence case. The initial letter of a title is almost always capitalized by default; otherwise, words are not capitalized unless they would be so in running text.

'''Use singular form.''' Exceptions include nouns that are always in plural form.

=== Category name policy ===
'''Page name policy applies.'''

Names of ''topic categories'' should be singular. Examples: "Health", "HUD". A category named "Behavior" should include pages dedicated to how behaviors work or how to create one.

Names of ''set categories'' should be plural. Examples: "Hacks", "Editors". A category named "Behaviors" should include individual existing behaviors.

=== File name policy ===
'''Avoid very generic filenames.''' For example, a screenshot of a hack should not be given the name "File:Hack.jpg".

Examples of good file names are:

* "Screenshot of Super Mario 64 Intro Screen.jpg"
* "SM64 Beta Screenshot.png"
* "Star Icon.png"

Examples of bad file names:

* "Image01.png"
* "Mario.jpg"

Category:Graphics

2020-11-08T18:20:14Z

Tenry: Created page with "Here you will find everything related to graphics in Super Mario 64, including working with the textures, billboards or HUDs."

Here you will find everything related to graphics in Super Mario 64, including working with the textures, billboards or HUDs.

Main Page

2020-11-08T18:19:44Z

Tenry:

Welcome to SM64Decomp project wiki! This website is meant to help people working on the [https://github.com/n64decomp/sm64 Super Mario 64 Decompilation] project, especially on customizing the code for creating individual hacks.

Please note that editing is currently restricted to a few selected users.

This wiki is maintainted by [[User:Tenry|Tenry]] and is not associated with the decomp organization.

== Categories ==

* [[:Category:Level|Level]] - everything you need if you want to create or modify a level or objects
* [[:Category:Coding|Coding]] - if you want to do custom coding or general enhancements
* [[:Category:Graphics|Graphics]] - if you want to change graphics or how they are displayed
* [[:Category:Audio|Audio]] - if you want to work with the sound effects or music

== External resources ==

* [[List of Discord servers]]
* [https://ukikipedia.net/wiki/Main_Page Ukikipedia]
* [https://hack64.net/wiki/doku.php?id=start Hack64]

== Contribution guidelines ==

* Do ''not'' provide uploads or link to ROM images or provide information on how to illegally obtain them
* Do ''not'' post leaked source code

=== Page name policy ===
'''Use sentence case.''' Titles are written in sentence case. The initial letter of a title is almost always capitalized by default; otherwise, words are not capitalized unless they would be so in running text.

'''Use singular form.''' Exceptions include nouns that are always in plural form.

=== Category name policy ===
'''Page name policy applies.'''

Names of ''topic categories'' should be singular. Examples: "Health", "HUD". A category named "Behavior" should include pages dedicated to how behaviors work or how to create one.

Names of ''set categories'' should be plural. Examples: "Hacks", "Editors". A category named "Behaviors" should include individual existing behaviors.

=== File name policy ===
'''Avoid very generic filenames.''' For example, a screenshot of a hack should not be given the name "File:Hack.jpg".

Examples of good file names are:

* "Screenshot of Super Mario 64 Intro Screen.jpg"
* "SM64 Beta Screenshot.png"
* "Star Icon.png"

Examples of bad file names:

* "Image01.png"
* "Mario.jpg"

Texture

2020-11-08T18:18:53Z

Tenry: Created page with "Textures are 2D graphics that are either displayed directly on screen, such as in the HUD, mapped onto 3D models, for example to give a character eyes, or used as billboar..."

Textures are 2D graphics that are either displayed directly on screen, such as in the [[HUD]], mapped onto 3D models, for example to give a character eyes, or used as billboard graphics, such as for trees or coins.

== Texture cache ==
The texture cache of the Nintendo 64 is 4 KiB (4096 bytes).

== Texture formats ==
The Nintendo 64 has many different texture formats. When rendering, any format is converted to 32-bit RGBA as the output format.

The identifier in the following table is used in the filename's extension, such as ''hmc_textures.00000.'''rgba16'''.png''.
{| class="wikitable"
!Format
!Identifier
!Max resolution
!Red
!Green
!Blue
!Alpha
!Description
|-
!32-bit RGBA
|rgba32
|32x32
|256
|256
|256
|256
|This is the most versatile format. It contains the same amount of data you might alreay be used to from PNG files on your PC.
|-
!16-bit RGBA
|rgba16
|64x32 or 32x64
|32
|32
|32
|2
|This format uses less memory than 32-bit RGBA and also has less levels of color intensity. Alpha is binary, i.e. a pixel is either fully visible or transparent.
|-
!8-bit color index
|ci8
|
|
|
|
|
|
|-
!4-bit color index
|ci4
|
|
|
|
|
|
|-
!16-bit IA (intensity alpha)
|ia16
|64x32 or 32x64
| colspan="3" |256
|256
|
|-
!8-bit IA (intensity alpha)
|ia8
|64x64
| colspan="3" |16
|16
|
|-
!4-bit IA (intensity alpha)
|ia4
|128x64 or 64x128
| colspan="3" |8
|2
|
|-
!8-bit I (intensity)
|i8
|64x64
| colspan="3" |256
|0
|
|-
!4-bit I (intensity)
|i4
|128x64 or 64x128
| colspan="3" |16
|0
|
|}

== See also ==

* [https://n64squid.com/homebrew/n64-sdk/textures/image-formats/ Color and image format types for the N64] on n64squid.com

[[Category:Graphics]]

Main Page

2020-11-08T17:48:48Z

Tenry: add list of categories

Welcome to SM64Decomp project wiki! This website is meant to help people working on the [https://github.com/n64decomp/sm64 Super Mario 64 Decompilation] project, especially on customizing the code for creating individual hacks.

Please note that editing is currently restricted to a few selected users.

This wiki is maintainted by [[User:Tenry|Tenry]] and is not associated with the decomp organization.

== Categories ==

* [[:Category:Level|Level]] - everything you need if you want to create or modify a level or objects
* [[:Category:Coding|Coding]] - if you want to do custom coding or general enhancements
* [[:Category:Audio|Audio]] - if you want to work with the sound effects or music

== External resources ==

* [[List of Discord servers]]
* [https://ukikipedia.net/wiki/Main_Page Ukikipedia]
* [https://hack64.net/wiki/doku.php?id=start Hack64]

== Contribution guidelines ==

* Do ''not'' provide uploads or link to ROM images or provide information on how to illegally obtain them
* Do ''not'' post leaked source code

=== Page name policy ===
'''Use sentence case.''' Titles are written in sentence case. The initial letter of a title is almost always capitalized by default; otherwise, words are not capitalized unless they would be so in running text.

'''Use singular form.''' Exceptions include nouns that are always in plural form.

=== Category name policy ===
'''Page name policy applies.'''

Names of ''topic categories'' should be singular. Examples: "Health", "HUD". A category named "Behavior" should include pages dedicated to how behaviors work or how to create one.

Names of ''set categories'' should be plural. Examples: "Hacks", "Editors". A category named "Behaviors" should include individual existing behaviors.

=== File name policy ===
'''Avoid very generic filenames.''' For example, a screenshot of a hack should not be given the name "File:Hack.jpg".

Examples of good file names are:

* "Screenshot of Super Mario 64 Intro Screen.jpg"
* "SM64 Beta Screenshot.png"
* "Star Icon.png"

Examples of bad file names:

* "Image01.png"
* "Mario.jpg"

Category:Level

2020-11-08T17:44:22Z

Tenry: Created page with "If you want to create your own level or overworld, you should find almost everything you need here. This includes creating the level model, placing objects or even creating cu..."

If you want to create your own level or overworld, you should find almost everything you need here. This includes creating the level model, placing objects or even creating custom objects.

Category:Coding

2020-11-08T17:43:01Z

Tenry: Created page with "Pages related to coding in the Super Mario 64 decompilation project. Most of it deals with the C code, but some may also refer to the MIPS assembly code, linker script or Make..."

Pages related to coding in the Super Mario 64 decompilation project. Most of it deals with the C code, but some may also refer to the MIPS assembly code, linker script or Makefile.

If you don't have any prior experience with C or the other languages, you might want to learn the basics somewhere else before proceeding here.

Category:Audio

2020-11-08T17:40:39Z

Tenry: Created page with "This is a collection of pages related to the audio in Super Mario 64. That includes sound effects and music."

This is a collection of pages related to the audio in Super Mario 64. That includes sound effects and music.

Global variables

2020-11-08T17:34:09Z

Tenry:

{| class="wikitable"
|+
!Name
!Type
!File
!Description
|-
|gCurrCourseNum
|s16
|src/game/area.c
|
|-
|gCurrActNum
|s16
|src/game/area.c
|
|-
|gCurrAreaIndex
|s16
|src/game/area.c
|
|-
|gSavedCourseNum
|s16
|src/game/area.c
|
|-
|gPauseScreenMode
|s16
|src/game/area.c
|
|-
|gSaveOptSelectIndex
|s16
|src/game/area.c
|
|-
|gCameraMovementFlags
|s16
|
|
|-
|gCamera
|struct Camera
|
|
|-
|gControllers
|struct Controller[3]
|src/game/game_init.c
|
|-
|gGlobalTimer
|u32
|src/game/game_init.c
|
|-
|gPlayer1Controller
|struct Controller
|src/game/game_init.c
|
|-
|gPlayer2Controller
|struct Controller
|src/game/game_init.c
|
|-
|gPlayer3Controller
|struct Controller
|src/game/game_init.c
|
|-
|gMarioStates
|struct MarioState[1]
|src/game/level_update.c
|
|-
|gHudDisplay
|struct HudDisplay
|src/game/level_update.c
|
|-
|gNeverEnteredCastle
|s8
|src/game/level_update.c
|
|-
|gCurrentObject
|?
|
|
|-
|gMarioState
|struct MarioState*
|src/game/level_update.c
|Contains data about Mario's current state including position and velocity as well as coutner for coins, stars, health and more.
|-
|gMarioState->numCoins
|s16
|
|
|-
|gMarioState->numStars
|s16
|
|
|-
|gMarioState->numLives
|s8
|
|
|-
|gMarioState->health
|s16
|
|[[Health]]
|}
[[Category:Coding]]

Health

2020-11-08T17:33:57Z

Tenry:

''Health'', also known as ''Power'', is what keeps Mario alive. On screen, the player only sees up to 8 units of health. Technically however, there are more values underneath.

Mario's current health is stored as a 2-byte value in <code>gMarioState->health</code> and usually ranges from <code>0x0FF</code> (dead) to <code>0x880</code> (full live). The upper byte is used as the number of health units that's shown in the [[HUD]]. For example, <code>0x'''3'''60</code> corresponds to 3 units of health, <code>0x'''5'''20</code> corresponds to 5 units of health.

== Where health is modified ==
There are a few occasions in which Mario's health is modified.

=== Water ===
While underwater, Mario continously loses health. It's restored when he's on the surface. If the level terrain is set to snow, Mario loses three times health, even on surface.

Mario's health, when in water, is updated in '''src/game/mario.c''' in the function <code>update_mario_health()</code>.

== Where health is checked ==
There are several locations in code where health is checked for various actions, such as showing or hiding health in the HUD, changing Mario's animation or to make him die or drown.

== See also ==

* [https://ukikipedia.net/wiki/HP HP] on Ukikipedia
[[Category:Coding]]

Warp

2020-11-08T17:32:54Z

Tenry: