Shipwright/docs/CUSTOM_MUSIC.md

Custom Music

We support importing custom Seq64 files to replace the in game music and fanfares (Sound effect and instrument replacement is currently not supported).

First you will need to prepare a folder with the desired sequences. Every sequence requires two files with the same name and different extensions - a .seq Seq64 file and a .meta plaintext file. These files can be categorically nested in folders if desired, - Retro will recursively search each subfolder it finds.

The .meta file requires two lines - the first line is the name that will be displayed in the SFX editor, and the second line is the instrument set number in base16 format. For example, if there is a sequence file Foo.seq then you need a meta file Foo.meta that could contain:

Awesome Name
C

Once you have prepared your sequences folder:

1. Download and open Retro.
2. Choose the "Create OTR" option.
3. Choose the "Custom Sequences" option.
4. Using the file selection screen, choose the sequences folder you prepared in the previous instructions.
5. Click the "Stage Files" button. (NOTE: SoH can handle 1024 custom sequence in total. This includes the original music. Keep that in mind!)
6. Click the "Finalize OTR" text in the green footer.
7. Click "Generate OTR" and, using the file selection screen, save the file to the mods folder of your SoH installation.
   • This mods folder should be in the same folder as your oot.otr file.

Assuming you have done everything correctly, boot up SoH and select the SFX Editor from the enhancements dropdown menu. You should now be able to swap out any of the in game sequences/fanfares for the sequences added in your newly generated OTR file. If you have any trouble with this process, please reach out in the support section of the Discord.