SkySongBuilder Tutorial - Revision history

RRad: Slot 201 is filled by an alternative version of Team Charm's Theme, which is used in 2 SE4 cutscenes

2025-09-20T08:45:26Z

Slot 201 is filled by an alternative version of Team Charm's Theme, which is used in 2 SE4 cutscenes

← Older revision		Revision as of 08:45, 20 September 2025
Line 72:		Line 72:
	</syntaxhighlight>There are only a few things you need to change.		</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 the sample 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-200 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>		* The name of the song above <code>i:</code>

Chesyon: Formatting improvements, as well as an additional step that wasn't mentioned before

2024-07-06T18:05:40Z

Formatting improvements, as well as an additional step that wasn't mentioned before

Chesyon: Updated links to latest version (as well as adding link to EU version)

2024-07-06T17:57:08Z

Updated links to latest version (as well as adding link to EU version)

← Older revision		Revision as of 17:57, 6 July 2024
Line 16:		Line 16:
	* Fifohooks: https://github.com/adakite1/Asm-patches		* Fifohooks: https://github.com/adakite1/Asm-patches
	* DSLazy: https://www.romhacking.net/utilities/793/		* DSLazy: https://www.romhacking.net/utilities/793/
	* SND Stream: https://discord.com/channels/710190644152369162/799584781225820210/~~1172750070710534244~~ (SkyTemple Discord ~~Server~~)		* SND Stream (for US ROMs): https://discord.com/channels/710190644152369162/799584781225820210/1233371683860250654 (SkyTemple Discord server)
			* SND Stream (for EU ROMs): https://discord.com/channels/710190644152369162/799584781225820210/1257506329963266060 (SkyTemple Discord server)

	* soundtrack.yml: https://github.com/adakite1/skysongbuilder/blob/master/soundtrack.yml		* soundtrack.yml: https://github.com/adakite1/skysongbuilder/blob/master/soundtrack.yml

Line 44:		Line 46:
	## 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.		## 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~~.asm</code>. If it looks like nothing happened and you got no error messages, then it worked!		## 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!
	## Lastly, go back into the folder and move "overlay_0036.bin" back into the overlay 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.		## 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.

Adakite: Use spaces instead of tabs (required by yaml)

2024-04-23T22:20:01Z

Use spaces instead of tabs (required by yaml)

← Older revision		Revision as of 22:20, 23 April 2024
Line 59:		Line 59:

	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 simpliciy sake, delete everything under, but not including, <code>songs:</code>. Then you may add this template block.<syntaxhighlight lang="yaml">
	Buried_Oasis:		Buried_Oasis:
	i: 194		i: 194
	raw: Buried_Oasis.wav		raw: Buried_Oasis.wav
	loop_point: 846720		loop_point: 846720
	formats: [Wav4BitAdpcmNDSPlanarStereoLooped]		formats: [Wav4BitAdpcmNDSPlanarStereoLooped]
	dsp:		dsp:
	adpcm_block_size: 16377		adpcm_block_size: 16377
	adpcm_encoder_lookahead: 4		adpcm_encoder_lookahead: 4
	flags: SND_STREAM		flags: SND_STREAM
	</syntaxhighlight>There are only a few things you need to change.		</syntaxhighlight>There are only a few things you need to change.

Okami at 23:05, 16 April 2024

2024-04-16T23:05:54Z

← Older revision		Revision as of 23:05, 16 April 2024
Line 42:		Line 42:
	## A folder should open containing files such as arm7.bin, arm9.bin, banner.bin, etc.		## A folder should open containing files such as arm7.bin, arm9.bin, banner.bin, etc.
	## Open the folder named "Overlay". Find "overlay_0036.bin." and drag it into the folder with arm7.bin and such.		## Open the folder named "Overlay". Find "overlay_0036.bin." and drag it into the folder with arm7.bin and such.
	## Drag SND Stream 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.		## 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.asm</code>. If it looks like nothing happened and you got no error messages, then it worked!		## Type <code>./armips.exe snd_stream.asm</code>. If it looks like nothing happened and you got no error messages, then it worked!

Chesyon: /* Prepwork */Fixed link to skypatch page

2024-04-16T22:59:54Z

Prepwork: Fixed link to skypatch page

← Older revision		Revision as of 22:59, 16 April 2024
Line 32:		Line 32:

	# Apply [[ExtraSpace]] ASM patch in SkyTemple.		# Apply [[ExtraSpace]] ASM patch in SkyTemple.
	# Download "Fifohooks." It comes in the form of a [[~~SkyPatch~~ File\|.skypatch file]].		# Download "Fifohooks." It comes in the form of a [[Skypatch File\|.skypatch file]].
	#* To apply, open your .nds in SkyTemple. Go to "ASM" -> "Others" -> "Open Patch Directory..."		#* To apply, open your .nds in SkyTemple. Go to "ASM" -> "Others" -> "Open Patch Directory..."
	#* Drag the Fifohooks patch into the folder that opens, then close it.		#* Drag the Fifohooks patch into the folder that opens, then close it.

Frostbyte: Fix heading

2024-04-16T22:44:19Z

Fix heading

← Older revision		Revision as of 22:44, 16 April 2024
Line 102:		Line 102:
	Open Data/Sound/BGM. This folder contains all the music in the game. Copy all the files in the "out" folder and paste them into "BGM". Repack your .nds as before.		Open Data/Sound/BGM. This folder contains all the music in the game. Copy all the files in the "out" folder and paste them into "BGM". Repack your .nds as before.

	==== Playing music ====		=== Playing music ===
	Use <code>bgm_Play(194);</code> on a script to play your song! Just change the number to whatever ID you used for each song. You are now streaming music!		Use <code>bgm_Play(194);</code> on a script to play your song! Just change the number to whatever ID you used for each song. You are now streaming music!

Frostbyte: Add bullet list of required programs

2024-04-16T22:42:25Z

Add bullet list of required programs

← Older revision		Revision as of 22:42, 16 April 2024
Line 11:		Line 11:

	=== Required programs and files ===		=== Required programs and files ===
	~~SkySongBuilder: https://github.com/adakite1/skysongbuilder/releases~~

	Armips: https://github.com/Kingcom/armips/releases		* SkySongBuilder: https://github.com/adakite1/skysongbuilder/releases
			* Armips: https://github.com/Kingcom/armips/releases
	Fifohooks: https://github.com/adakite1/Asm-patches		* Fifohooks: https://github.com/adakite1/Asm-patches
			* DSLazy: https://www.romhacking.net/utilities/793/
	DSLazy: https://www.romhacking.net/utilities/793/		* SND Stream: https://discord.com/channels/710190644152369162/799584781225820210/1172750070710534244 (SkyTemple Discord Server)
			* soundtrack.yml: https://github.com/adakite1/skysongbuilder/blob/master/soundtrack.yml
	SND Stream: https://discord.com/channels/710190644152369162/799584781225820210/1172750070710534244 (SkyTemple Discord Server)

	soundtrack.yml: https://github.com/adakite1/skysongbuilder/blob/master/soundtrack.yml

	If any of these are zipped, they must be unzipped before use.		If any of these are zipped, they must be unzipped before use.
Line 27:		Line 23:
	Optional:		Optional:

	PlayMoreBGM: https://github.com/Adex-8x/jam-patches/blob/master/strung-up-by-sketches/PlayMoreBgm.skypatch		* 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.		If any of these are zipped, they must be unzipped before use.

Frostbyte: Add missing period

2024-04-16T22:41:20Z

Add missing period

← Older revision		Revision as of 22:41, 16 April 2024
Line 5:		Line 5:
	'''This guide is for Windows use. There may be some issues if you are using macOS or Linux.'''		'''This guide is for Windows use. There may be some issues if you are using macOS or Linux.'''

	'''WARNING''': This guide is under the assumption that you have not applied any other .skypatches aside from the ones listed inside. If you already have applied .skypatches, there may be conflicts that prevent it from working. You may wish to ask someone knowledgable about ASM to adjust the .skypatches required accordingly		'''WARNING''': This guide is under the assumption that you have not applied any other .skypatches aside from the ones listed inside. If you already have applied .skypatches, there may be conflicts that prevent it from working. You may wish to ask someone knowledgable about ASM to adjust the .skypatches required accordingly.

	== Streamed music ==		== Streamed music ==

Frostbyte: Add to tutorials category

2024-04-16T22:34:44Z

Add to tutorials category

← Older revision		Revision as of 22:34, 16 April 2024
Line 128:		Line 128:

	When creating sequenced music, it should be noted that Explorers of Sky cannot play more than a certain number of voices at the same time. The number of voices is roughly equal to the number of instruments playing at any given time. The exact limit is currently unknown, but it's likely between 10 and 16.		When creating sequenced music, it should be noted that Explorers of Sky cannot play more than a certain number of voices at the same time. The number of voices is roughly equal to the number of instruments playing at any given time. The exact limit is currently unknown, but it's likely between 10 and 16.
			[[Category:Tutorials]]

← Older revision		Revision as of 18:05, 6 July 2024
Line 23:		Line 23:
	If any of these are zipped, they must be unzipped before use.		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		* 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.		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 ===		=== Prepwork ===
Line 38:		Line 37:
	#* Drag the Fifohooks patch into the folder that opens, then close it.		#* 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. -->		#* 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."		## 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.		## 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.		## 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.		## 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!		## 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.		## 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.		## 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.		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.		"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:		Buried_Oasis:
	i: 194		i: 194
Line 72:		Line 72:
	</syntaxhighlight>There are only a few things you need to change.		</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>		* 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.		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>		# 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!		# 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!