SkySongBuilder Tutorial: Difference between revisions

Line 23:

If any of these are zipped, they must be unzipped before use.

Optional:

=== Optional: ===

* PlayMoreBGM: https://github.com/Adex-8x/jam-patches/blob/master/strung-up-by-sketches/PlayMoreBgm.skypatch

If any of these are zipped, they must be unzipped before use.

Make a copy of your .nds before continuing.

Make a copy of your .nds file before continuing.

=== Prepwork ===

Line 38:

Line 37:

#* Drag the Fifohooks patch into the folder that opens, then close it.

#* Refresh the "Others" page, and the FifoHooks patch should be there. Apply it. The ROM should save and reload.

# ~~Downlad~~ "armips" and "SND Stream." The SND stream patch needs to be applied manually with "DSLazy" or a different DS packing program. To do so:

# Download "armips" and "SND Stream." The SND stream patch needs to be applied manually with "DSLazy" or a different DS packing program. To do so:

## ~~MAKE A COPY OF YOUR~~ .~~NDS JUST IN CASE~~

## '''Make a backup of your .nds file before continuing, in case something goes wrong!'''

## Unpack your .nds with DSLazy. Click the three dots on the top left, select your .nds, and click "nds unpack."

## Unpacking may take a minute.

Line 45:

Line 44:

## Open the folder named "Overlay". Find "overlay_0036.bin." and drag it into the folder with arm7.bin and such.

## Drag SND Stream and armips.exe into that folder as well. If done correctly, your new folder should contain the following: data (folder), overlay (folder), arm7.bin, arm9.bin, banner.bin, header.bin, y7.bin, y9.bin, overlay_0036.bin, SND_Stream, armips.exe.

## Now we need the programs to work their magic. On ~~windows~~, hold shift and right-click anywhere in the folder containing these files. Then click "Open Powershell Window here".

## Now we need the programs to work their magic. On Windows, hold shift and right-click anywhere in the folder containing these files. Then click "Open Powershell Window here".

## Type <code>./armips.exe snd_stream_arm9.asm</code> (US ROMs) or <code>./armips.exe snd_stream_arm9_eu.asm</code> (EU ROMs). If it looks like nothing happened and you got no error messages, then it worked!

## At this point, you should close Powershell, and delete armips.exe and snd_stream_arm9(_eu).asm from the folder.

## Lastly, go back into the folder and move "overlay_0036.bin" back into the overlay folder.

## Close, then go back to DSLazy and hit "nds packer." It will ask where you want to save the new .nds file it will make. If you already started a ROM hack, it would be best to save directly over the .nds you are working on. Again, MAKE SURE YOU HAVE A COPY OF THIS .NDS JUST IN CASE.

Line 54:

First, download "SkySongBuilder" and "soundtrack.yml". Create a brand new folder with only those two things, and any songs you want to put into your game.

Now we need to edit "soundtrack.yml." ~~I use notepad~~ which all ~~windows~~ computers should have. Open ~~notepad~~. Click "~~open~~" on the top left.

Now we need to edit "soundtrack.yml." For simplicity, this guide uses Notepad, which all Windows computers should have, but any text editor should work. Open Notepad. Click "Open" on the top left.

You should now be looking for a file to open with ~~notepad~~. On the bottom right, make sure you tell your computer that you are not picky. You want to search for ALL files. Not just .txt files like ~~notepad~~ is bias towards. Otherwise, you may never find the "soundtrack.yml" file we want to open. This is where we will actually be adding music for ~~SkySong~~ to translate into a format SkyTemple and your game can read.

You should now be looking for a file to open with Notepad. On the bottom right, make sure you tell your computer that you are not picky. You want to search for ALL files. Not just .txt files like Notepad is bias towards. Otherwise, you may never find the "soundtrack.yml" file we want to open. This is where we will actually be adding music for SkySongBuilder to translate into a format SkyTemple and your game can read.

"soundtrack.yml" has many different features. If you only want to play a song, you can ignore 99% of everything.

Scroll down until you find the section labeled <code>songs:</code> under the "Add songs here" comment. For ~~simpliciy~~ sake, delete everything under, but not including, <code>songs:</code>. Then you may add this template block.<syntaxhighlight lang="yaml">

Scroll down until you find the section labeled <code>songs:</code> under the "Add songs here" comment. For simplicity's sake, delete everything under, but not including, <code>songs:</code>. Then you may add this template block.<syntaxhighlight lang="yaml">

Buried_Oasis:

i: 194

Line 72:

</syntaxhighlight>There are only a few things you need to change.

* <code>i:</code> is the slot of the song. The game has several unused slots already we can use to add new music. These are slots 194-201 for a total of 7 additional songs. If you want more songs without removing existing songs you must apply Adex's PlayMoreBGM ~~.skypatch~~ which can be found above. The installation process is the same for the ~~fifohooks~~ installation. Each song you add needs it's own slot, starting at 194, just as ~~mine~~ does.

* <code>i:</code> is the slot of the song. The game has several unused slots already we can use to add new music. These are slots 194-201 for a total of 7 additional songs. If you want more songs without removing existing songs you must apply Adex's PlayMoreBGM Skypatch which can be found above. The installation process is the same for the Fifohooks installation. Each song you add needs it's own slot, starting at 194, just as the sample does.

* The name of the song above <code>i:</code>

Line 94:

Last step to translate! Inside the folder you made, you should have "SkySongBuilder", "soundtrack.yml", and the songs you want to include in your game.

# Hold shift and right-click anywhere in the file. Open up ~~powershell~~ again.

# Hold shift and right-click anywhere in the file. Open up Powershell again.

# Type <code>./skysongbuilder.exe</code>

# If everything works, you should see ~~powershell~~ freak out and do a bunch of stuff. Wait until it's done. It could take a minute, especially if you are doing multiple songs at once. After it stops, go check your folder again.

# If everything works, you should see Powershell freak out and do a bunch of stuff. Wait until it's done. It could take a minute, especially if you are doing multiple songs at once. After it stops, go check your folder again.

# You should now have a folder named "out" in there with "SkySongBuilder", "soundtrack.yml", and your songs. Open it and take a look. It should have "bgm.swd" and then a bunch of files with 194, 195, or whatever value you used for "id" in the name. If you do, then you are good to go!

@@ Line 23: / Line 23: @@
 If any of these are zipped, they must be unzipped before use.
-Optional:
+=== Optional: ===
 * PlayMoreBGM: https://github.com/Adex-8x/jam-patches/blob/master/strung-up-by-sketches/PlayMoreBgm.skypatch
 If any of these are zipped, they must be unzipped before use.
-Make a copy of your .nds before continuing.
+Make a copy of your .nds file before continuing.
 === Prepwork ===
@@ Line 38: / Line 37: @@
 #* Drag the Fifohooks patch into the folder that opens, then close it.
 #* Refresh the "Others" page, and the FifoHooks patch should be there. Apply it. The ROM should save and reload.<!-- This section on how to apply the patch should be moved to the "SkyPatch File" page once it's created. -->
-# Downlad "armips" and "SND Stream." The SND stream patch needs to be applied manually with "DSLazy" or a different DS packing program. To do so:
+# Download "armips" and "SND Stream." The SND stream patch needs to be applied manually with "DSLazy" or a different DS packing program. To do so:
-## MAKE A COPY OF YOUR .NDS JUST IN CASE
+## '''Make a backup of your .nds file before continuing, in case something goes wrong!'''
 ## Unpack your .nds with DSLazy. Click the three dots on the top left, select your .nds, and click "nds unpack."
 ## Unpacking may take a minute.
@@ Line 45: / Line 44: @@
 ## Open the folder named "Overlay". Find "overlay_0036.bin." and drag it into the folder with arm7.bin and such.
 ## Drag SND Stream and armips.exe into that folder as well. If done correctly, your new folder should contain the following: data (folder), overlay (folder), arm7.bin, arm9.bin, banner.bin, header.bin, y7.bin, y9.bin, overlay_0036.bin, SND_Stream, armips.exe.
-## Now we need the programs to work their magic. On windows, hold shift and right-click anywhere in the folder containing these files. Then click "Open Powershell Window here".
+## Now we need the programs to work their magic. On Windows, hold shift and right-click anywhere in the folder containing these files. Then click "Open Powershell Window here".
 ## Type <code>./armips.exe snd_stream_arm9.asm</code> (US ROMs) or <code>./armips.exe snd_stream_arm9_eu.asm</code> (EU ROMs). If it looks like nothing happened and you got no error messages, then it worked!
+## At this point, you should close Powershell, and delete armips.exe and snd_stream_arm9(_eu).asm from the folder.
 ## Lastly, go back into the folder and move "overlay_0036.bin" back into the overlay folder.
 ## Close, then go back to DSLazy and hit "nds packer." It will ask where you want to save the new .nds file it will make. If you already started a ROM hack, it would be best to save directly over the .nds you are working on. Again, MAKE SURE YOU HAVE A COPY OF THIS .NDS JUST IN CASE.
@@ Line 54: / Line 54: @@
 First, download "SkySongBuilder" and "soundtrack.yml". Create a brand new folder with only those two things, and any songs you want to put into    your game.
-Now we need to edit "soundtrack.yml." I use notepad which all windows computers should have. Open notepad. Click "open" on the top left.
+Now we need to edit "soundtrack.yml." For simplicity, this guide uses Notepad, which all Windows computers should have, but any text editor should work. Open Notepad. Click "Open" on the top left.
-You should now be looking for a file to open with notepad. On the bottom right, make sure you tell your computer that you are not picky. You want to search for ALL files. Not just .txt files like notepad is bias towards. Otherwise, you may never find the "soundtrack.yml" file we want to open. This is where we will actually be adding music for SkySong to translate into a format SkyTemple and your game can read.
+You should now be looking for a file to open with Notepad. On the bottom right, make sure you tell your computer that you are not picky. You want to search for ALL files. Not just .txt files like Notepad is bias towards. Otherwise, you may never find the "soundtrack.yml" file we want to open. This is where we will actually be adding music for SkySongBuilder to translate into a format SkyTemple and your game can read.
 "soundtrack.yml" has many different features. If you only want to play a song, you can ignore 99% of everything.
-Scroll down until you find the section labeled <code>songs:</code> under the "Add songs here" comment. For simpliciy sake, delete everything under, but not including, <code>songs:</code>. Then you may add this template block.<syntaxhighlight lang="yaml">
+Scroll down until you find the section labeled <code>songs:</code> under the "Add songs here" comment. For simplicity's sake, delete everything under, but not including, <code>songs:</code>. Then you may add this template block.<syntaxhighlight lang="yaml">
    Buried_Oasis:
      i: 194
@@ Line 72: / Line 72: @@
 </syntaxhighlight>There are only a few things you need to change.
-* <code>i:</code> is the slot of the song. The game has several unused slots already we can use to add new music. These are slots 194-201 for a total of 7 additional songs. If you want more songs without removing existing songs you must apply Adex's PlayMoreBGM .skypatch which can be found above. The installation process is the same for the fifohooks installation. Each song you add needs it's own slot, starting at 194, just as mine does.
+* <code>i:</code> is the slot of the song. The game has several unused slots already we can use to add new music. These are slots 194-201 for a total of 7 additional songs. If you want more songs without removing existing songs you must apply Adex's PlayMoreBGM Skypatch which can be found above. The installation process is the same for the Fifohooks installation. Each song you add needs it's own slot, starting at 194, just as the sample does.
 * The name of the song above <code>i:</code>
@@ Line 94: / Line 94: @@
 Last step to translate! Inside the folder you made, you should have "SkySongBuilder", "soundtrack.yml", and the songs you want to include in your game.
-# Hold shift and right-click anywhere in the file. Open up powershell again.
+# Hold shift and right-click anywhere in the file. Open up Powershell again.
 # Type <code>./skysongbuilder.exe</code>
-# If everything works, you should see powershell freak out and do a bunch of stuff. Wait until it's done. It could take a minute, especially if you are doing multiple songs at once. After it stops, go check your folder again.
+# If everything works, you should see Powershell freak out and do a bunch of stuff. Wait until it's done. It could take a minute, especially if you are doing multiple songs at once. After it stops, go check your folder again.
 # You should now have a folder named "out" in there with "SkySongBuilder", "soundtrack.yml", and your songs. Open it and take a look. It should have "bgm.swd" and then a bunch of files with 194, 195, or whatever value you used for "id" in the name. If you do, then you are good to go!