Requirements

This guide assumes that:

• Arcropolis is installed & working for latest version of SSBU: https://github.com/Raytwo/ARCropolis
• A dump or data.arc of SSBU (latest version) was made and you know how to use CrossArc to extract files
• You have a backup of all the mods, all the files that are interacting with this tool.
• If important to you: You have a backup of your game save data. I cannot stress this enough: There is still a lot to figure out and we don't yet know if adding more songs can have an impact on your save data.
• Also important: This mod is not safe online!

Download Release

• Download latest release. This release is made to work with version 12.X of SSBU.

Game files

In order to work, you need to extract some files from the game.

MSBT Files (localization files)

• Extract the msbt files from the game directory (location: ui/message/) using CrossArc. For MSBT files make sure to select "Language: All" to get all the files named like "msg_title+{locale}.msbt".
• Copy the extracted files to resources/game/ui/message/ in Sm5shMusic.
• At least msg_bgm+{locale}.msbt and msg_title+{locale}.msbt must be present.

PRC files

• Extract ui_bgm_db.prc, ui_gametitle_db.prc, ui_stage_db.prc and ui_series_db.prc from the game directory (location: ui/param/database/) using CrossArc.
• Copy the extracted files to resources/game/ui/param/database/ in Sm5shMusic.

Audio files

• Extract nus3bank bgm_j48_fsg_konosekainoitadakide.nus3bank from the game directory (location: stream;/sound/bgm) using CrossArc.
• Copy the extracted file to resources/ in Sm5shMusic and rename it template.nus3bank.
• Note that any nus3bank file should work, but in case of issues with playback in-game please try this specific file first.
• [Optional] Extract all nus3audio songs from from the game directory (location: stream;/sound/bgm) using CrossArc.
• Copy the extracted files to resources/game/stream;/sound/bgm/. This is needed if you want to listen to core songs.

Launching the program

If you did everything right, the program should launch without error. If you have an error make sure all the files are where they should be and check the troubleshooting section

• If your resolution is under 1920x1080, you may want to use small fonts. Click "Settings" > "Global Settings" > "UI Scale" and select "Small". You will need to restart after that.

Creating a mod

This step is necessary to start adding songs.

• After launching the program, click "Manage..." > "Create a Mod". Doing so will create a mod under mods/musicmods
• If you wish to rename the mod folder later, you must do so by first closing the program, rename the folder, and then reopening the program. Issues may happen otherwise.

Adding a new song

Before adding a song, you need to create a new mod. Songs can only be imported within mods. Please notice that adding a new song is not enough for it to be playable in a stage. You will need to add it in a playlist (Check below)

• Click "Import Songs to..." and select which mod you wish to import a song to.
• Supporteds format are: IDSP, LOPUS (with Namco header), NUS3AUDIO and BRSTM (through conversion)
• Once a song is selected, you need to provide a "tone id", it's the id of the song. This ID must be unique and the maximum length seems to be 47 characters.

Edit song properties

After adding a song, the BGM Properties menu opens and you can configure some properties for the song. There is a lot more that you can do, but not everything is figured out yet or has a specific UI for it. If you wish to tweak the settings manually, enable "Advanced" mode and edit a song property, this will show new tabs with a lot more fields.

• Game: This is the game the song will be attached too. This property is mandatory. If you need a default value, enter "ui_gametitle_none".
• Series: This field is linked to a game and cannot be edited here
• Record Type: "Original", "Remix" and "New Remix" are the options.
• Title: Title of the song as it appears in game. Make sure that the right locale is selected for your game.
• Author: Author of the song. This field is sometimes left empty. Make sure that the right locale is selected for your game.
• Copyright: Copyright for the song. This field is sometimes left empty. Make sure that the right locale is selected for your game.
• Volume: If you don't want to manually increase the volume of a song, the game has an internal volume setting per song. If the song sounds too quiet in game, try to tweak this setting.
• Sound Test: Uncheck if you wish the song to not appear in Sound Test. Typically used for pinch songs
• Special Category: Some specific commands to apply on songs. Note that the game supports more than what is currently available. The most notable one is "pinch songs", which will play another song at last stock or last minute (like the SF stage).

Add game

You can add new game entries to go with your songs. For example "Perfect Dark".

• Click "Manage..." > Create game
• Enter a game title. The name must be unique.
• Pick a series. At this time, it isn't possible to add a new series. The Series "etc" is usually the default series.

Reorder songs

Songs that are set up to appear in Sound Test can be reordered. In order to do so, just drag & drop songs before or after another song to move it. This can get pretty tedious, but is thankfully easier when combined with filters. For example, if you add Final Fantasy songs, filter the series "Final Fantasy, and then you can move the new songs around the existing indexes for final fantasy songs.

Add a song in a playlist

Once the songs were added, you need to add your songs to a playlist.

• On the top right corner, click "Playlists"
• Click "Select a playlist..." and pick the playlist you wish to edit. If you need to know which playlist plays on which stage, check "Assign a playlist to a stage" below.
• From there, you only need to drag & drop songs from the left datagrid to the right.
• "Incidence" is the likely of a song to be played. The value ranges from 0 to 10000. The default value can be edited in "Global Settings".
• Each playlist has 16 different "order" sequences. For example, the "Mario" playlist is played on multiple stages, but songs are ordered differently.

Create a playlist / Assign a stage to playlist

This step is completely optional, but is a create tool if you want to add a completely new playlist for a specific stage. For example, if you want the Luigi Mansion stage to only have ghost/mansion themed songs, you can now do so.

• On the top right corner, click "Playlists"
• Click "Manage..." above the playlist datagrid, then Create a Playlist
• Once your done adding songs, click "Manage..." again and "Assign a Stage to playlist"
• Pick a stage you want, and select the playlist and order ID you want. Save your changes

Building

This last step will build a mod compatible with Arcropolis. The game files resources/game will not be modified.

• Click "Project" > "Build" if you wish to build the mod with cache off. This will create nus3audio and nus3bank files of all your songs and add entries in the prc files, msbt files and bgm_property.bin.
• [OR] Click "Project" > "Build [with cache]" if you wish to build the mod with cache on. Cache on means that nus3audio files will be generated and cached in a "Cache" folder to be reused for future builds to improve performance. It also means that if you go around and change tone ids manually or rename songs, you might need to wipe the cache. If you're unsure, pick "Build" without cache.
• Finally, move all the files from the output folder (by default "ArcOutput" to your sd card in ultimate/mods/[nameofmod]