Info

This tool can be used to convert MML syntax into raw SFX hex bytes. While AddmusicK technically supports MML for sound effects, historically, it's been prone to being super buggy, so it's better to write raw hex, which is also incredibly tedious and hard-to-parse for anything remotely complex. This tool bridges that gap; you can write MML, which is then converted into hex bytes you can paste into AMK directly, without having to go through the tedium of raw hex.

The following subset of MML syntax is accepted. Do note that SFX has some additional restrictions, which are noted in red.

• Notes (abcdefg), sharps and flats (+ and -, respectively), and note lengths (both regular and in ticks (=)). SFX note lengths cannot be longer than $7F (127) ticks. Ties (^ and .) are unsupported.
• The o, <, and > commands. Valid range: o1c-o6a.
• The @ command. See the SFXInstrumentTable label in asm\InstrumentData.asm for instrument listings. Valid range: @0-@127. Note that this is an AddmusicK restriction.
• The n command. This command sets a noise instrument, and can take one or two values (separated by a comma (,)). The first parameter is the pitch of noise to use, with the valid range being n00-n1F. The optional second parameter defines an instrument number to get ADSR values from.
• The l command. Note that, unlike AMK's regular parser, this tool supports tick values for this command (ex. l=24, which would be equivalent to l8).
• The h command, with positive and negative decimal values. This will shift all notes by the given amount of semitones. For example: h2, h0, or h-3. Do note that the shift will also apply to any notes in pitch bend commands.
• The v command. This command sets volume, and can take one or two values (separated by a comma (,)). If one value is provided, both the left and right channels are set to this volume (ex. v35 will set both the left and right volumes to 35 ($23)). If two values are provided, the left channel's volume is set to the first value, and the right channel's volume is set to the second value (ex. v65,100 sets the left volume to 65 ($41), and the right volume to 100 ($64)). This effectively replaces panning, and so there is no separate y command. Valid range: v0-v127
• Pitch bends, denoted with $DD$WW$XX$YY$ZZ and $EB$XX$YY$ZZ. See this thread for information on these commands. Note that, like in regular MML syntax, you can replace the bytes in these commands with notes alongside < and >. However, you cannot mix and match hex bytes and notes/octave changes, nor use the o command for octave changes. Examples of valid syntax: $DD $A4 $03 $03 $A8, $DD c $03 $03 >b, $DD >e- $03 $12 <<g+, $EB $00 $06 g+, $EB $12 $0C $B9.

Other commands available in regular AMK MML, such as t, w, y, q, or p, do not work in sound effects.

You can also set priority for the sound effect by inputting a number between 0 and 255. The higher the value, the higher priority the sound effect has compared to other sound effects; i.e., if two sound effects are to play over each other, the one with higher priority takes precedence. This command is only supported in AddmusicK 1.0.9 and up.

By design, any values that are out of bounds for a given range (ex. an octave being too high, or an invalid volume value) throw a warning (which appears at the bottom), and are then clamped to be within the correct range (ex. a note in o7 would be rounded down to o6) before the hex bytes are generated.
If the parser otherwise encounters something it can't decipher, it'll be returned as a ? in the output, which should hopefully help pinpoint where the mistake is.