Super Mario Bros. X Forums

- place the library in the base of your episode. you can place it elsewhere if you know what your doing, but this guide assumes your unfamiliar with this process
- you place down a musicbox and take note of it's coordinates. you can get those by either holding ctrl while placing or right clicking the musicbox an going to - copy preference > position: X, Y (in PGE)
-from there, use this code load, register, and use the system in a map.lua file: jukebox.setTrack() - this sets the track of the specified track ID to the "path to music file", it only needs to be done once per ID. using 0 or lower for the ID will return an error

track ID - the ID used by the system to determine the track to play. this can technically be anything. i'd recommend using the custom range (751-1000) when registering just for sake of keeping things in-line with base game systems. if one wants to replace the default 16 via lua, use the desired IDs with this.

"path to music file with extension" - this is a string and does as the name implies. if your unfamiliar with lua, strings need backslashes to be escaped to be properly used. (like "music\\smb3-world1.spc" or something akin to that). alternatively, something like "music/smb3-world1.spc"also works. i recommend jukebox.resolveMusicFile(string) if you don't know the file extension. certain extensions can use path arguments. this may be necessary for things like .spc, which play very quietly by default. for those you'd do something like "my song.spc|0;g=2.7;". you can find a full list of music path args here. if using in conjunction with jukebox.resolveMusicFile(string), then it'd be like so: jukebox.resolveMusicFile("my song") .. "|0;g=2.7;"

jukebox.setMusicBox - transforms the musicbox at the specified X/Y's ID to the track ID supplied. thus you'd use one of the IDs you used in a setTrack if using a custom one. this needs to be done for as many musicboxes as you want for the custom track ID your using.

as of 1.2, an alias was added for jukebox.setMusicBox. jukebox.setMusicBoxTrack. it functions the same but was added because i felt the name for the former was a bit obtuse but didn't want to break compatibility.

here are some additional functions you can use to control the system a bit
jukebox.autoPlayMusic = bool - whether or not the system will auto play music upon start/touching a music box. can be used to call your own music changes
jukebox.getTrack(id) - returns the filename/path of the track of the ID given
jukebox.getPlayingTrack() - returns the filename/path of the track currently playing. will return nil if nothing is playing
jukebox.getPlayingTrackID() - returns the ID of the track currently playing. will return 0 or -1 if nothing is playing
jukebox.playTrack(trackID) - plays the track of the ID supplied. can use 0 to make it not play anything.
jukebox.resolveMusicFile(path) - like Misc.resolveSoundFile(string), but can get any usable music format from this page