Tutorial:Modding Music - Revision history

Imbion: Imbion moved page Modding Music to Tutorial:Modding Music

2025-10-16T15:43:57Z

Imbion moved page Modding Music to Tutorial:Modding Music

← Older revision	Revision as of 15:43, 16 October 2025
(No difference)

Rev: /* Looping Using PyMusicLooper */

2024-01-18T20:59:55Z

Looping Using PyMusicLooper

@@ Line 96: / Line 96: @@
 pipx ensurepath
 </pre>
 Now that PyMusicLooper is installed, run the following command to find loop points.

Rev: /* Looping Using PyMusicLooper */

2024-01-18T00:20:44Z

Looping Using PyMusicLooper

← Older revision		Revision as of 00:20, 18 January 2024
Line 62:		Line 62:
	First, make sure you have the Visual Studio Runtime installed. It can be downloaded here: https://aka.ms/vs/17/release/vc_redist.x64.exe		First, make sure you have the Visual Studio Runtime installed. It can be downloaded here: https://aka.ms/vs/17/release/vc_redist.x64.exe

	The next thing we need to do is open PowerShell and run the following commands:		The next thing we need to do is open PowerShell as a user and run the following commands:
	<pre>		<pre>
	# Say yes		# Say yes

Rev: /* Looping Using PyMusicLooper */

2024-01-18T00:07:20Z

Looping Using PyMusicLooper

← Older revision		Revision as of 00:07, 18 January 2024
Line 69:		Line 69:
	Invoke-RestMethod -Uri https://get.scoop.sh \| Invoke-Expression		Invoke-RestMethod -Uri https://get.scoop.sh \| Invoke-Expression
	</pre>		</pre>

	After those two commands are run, you should now be able to use Scoop from PowerShell.		After those two commands are run, you should now be able to use Scoop from PowerShell.

	Now we are going to install quite a few packages via Scoop, which includes the correct version of Python, along with FFmpeg,		Now we are going to install quite a few packages via Scoop, which includes the correct version of Python, along with FFmpeg,
	Git, and pipx.		Git, and pipx.
			If you have Python 3.12 or newer installed, make sure it is uninstalled, otherwise, pipx will use that version instead of the one that works with PyMusicLooper. That Python version is 3.11.

			If you have Git and FFmpeg already installed you can skip the first two scoop install commands.

	<pre>		<pre>

Rev: /* Looping Using PyMusicLooper */

2024-01-17T23:47:18Z

Looping Using PyMusicLooper

@@ Line 57: / Line 57: @@
 == Looping Using PyMusicLooper ==
-Looping can also be done via arkrow's PyMusicLooper Tool (Requires Python, ffmpeg, and pipx)
+Looping can also be done via arkrow's PyMusicLooper Tool
 Install PyMusicLooper using pipx:
 <pre>
@@ Line 63: / Line 89: @@
 # (follows the official releases on https://pypi.org/project/pymusiclooper/)
 pipx install pymusiclooper
 </pre>

Rev at 08:20, 17 January 2024

2024-01-17T08:20:03Z

← Older revision		Revision as of 08:20, 17 January 2024
Line 55:		Line 55:

	[[File:ModdingMusic_AutoLoopPoints.png\|frameless]]		[[File:ModdingMusic_AutoLoopPoints.png\|frameless]]

			== Looping Using PyMusicLooper ==
			Looping can also be done via arkrow's PyMusicLooper Tool (Requires Python, ffmpeg, and pipx)
			Install PyMusicLooper using pipx:
			<pre>
			# Normal install
			# (follows the official releases on https://pypi.org/project/pymusiclooper/)
			pipx install pymusiclooper
			</pre>

			Now that PyMusicLooper is installed, run the following command to find loop points.
			<pre>
			pymusiclooper -i play --path "path/to/my_song.ogg"
			</pre>
			You may be presented with multiple indexes to choose from, try out different indexes, and decide on which index is best for you.
			After deciding on the index, run the following command with the same song as before:
			<pre>
			pymusiclooper -i export-points --path "path/to/my_song.ogg"
			</pre>
			Select the index that has the same loop parameters you chose earlier. You should now get something like this:
			<pre>
			Loop points for "my_song.ogg":
			LOOP_START: XXXXXXX
			LOOP_END: XXXXXXXX
			</pre>

			LOOP_START is the start of the loop in samples. Where LOOP_END is the end of the loop in samples. To find the length of the loop, you will need to take the end of the loop and subtract the start of the loop.
			<pre>
			LOOPLENGTH = LOOP_END - LOOP_START
			</pre>

			For further documentation visit https://github.com/arkrow/PyMusicLooper

	== Additional Data ==		== Additional Data ==

IDK at 05:03, 26 June 2023

2023-06-26T05:03:09Z

← Older revision		Revision as of 05:03, 26 June 2023
Line 87:		Line 87:
	Within the song's tags, add a "RELATIVE" tag and specify the other songs in the group. This must be done for each song in the group. Also there is currently only support for one song. Ex.		Within the song's tags, add a "RELATIVE" tag and specify the other songs in the group. This must be done for each song in the group. Also there is currently only support for one song. Ex.

	Song A.ogg: RELATIVE is set to Song B.ogg		* Song A.ogg: RELATIVE is set to Song B.ogg
	Song B.ogg: RELATIVE is set to Song A.ogg		* Song B.ogg: RELATIVE is set to Song A.ogg


	[[Category:Modding Assets]]		[[Category:Modding Assets]]

IDK: relative songs

2023-06-26T05:02:52Z

relative songs

← Older revision		Revision as of 05:02, 26 June 2023
Line 82:		Line 82:
	</pre>		</pre>

			== Cross Fading ==
			Tracks can be specified as a part of a group. When switching between songs of the same group, the music will cross-fade instead of a regular fade. Support for this feature is currently TENTATIVE and the responsible tag may change in the future.

			Within the song's tags, add a "RELATIVE" tag and specify the other songs in the group. This must be done for each song in the group. Also there is currently only support for one song. Ex.

			Song A.ogg: RELATIVE is set to Song B.ogg
			Song B.ogg: RELATIVE is set to Song A.ogg


	[[Category:Modding Assets]]		[[Category:Modding Assets]]

IDK: Images and formatting

2022-10-04T00:18:16Z

Images and formatting

← Older revision		Revision as of 00:18, 4 October 2022
Line 1:		Line 1:
	This page goes through the process of how to add new music to a PMDO mod.		This page goes through the process of how to add new music to a PMDO mod.

	Adding Files		== Adding Files ==
	Add music by placing the file in the Content/Music folder of your mod. It must be an OGG file:		Add music by placing the file in the Content/Music folder of your mod. It must be an OGG file:

	~~It will appear in the music list on the next refresh~~:		[[File:ModdingMusic_Folder.png\|frameless]]

			It will appear in the music list of the Map or Ground Editor on the next refresh:

			[[File:ModdingMusic_MapEditor.png\|frameless]]

	Looping		== Looping ==
	If you added an ogg, chances are it’s not set up to loop properly. You can set the loop points by editing the tags of the file. Use an editing software like MP3Tag.		If you added an ogg, chances are it’s not set up to loop properly. You can set the loop points by editing the tags of the file. Use an editing software like [https://www.mp3tag.de/en/ MP3Tag].

			[[File:ModdingMusic_Looping.png\|frameless]]

			You will need to edit the extended tags to include a LOOPSTART and LOOPLENGTH:

			[[File:ModdingMusic_LoopPoints.png\|frameless]]

			LOOPSTART specifies the start of the song’s loop in samples. (Samples are the smallest unit of time for an OGG)

			LOOPLENGTH specifies the length of the song’s loop in samples. This is actually optional if the music file itself stops at the loop’s end.

			You can find these loop points by opening the song in [https://www.audacityteam.org/ Audacity], playing through it and carefully pinpointing the times you want to loop together.

			[[File:ModdingMusic_Audacity.png\|frameless]]









	~~You will need to edit the extended tags to include a LOOPSTART and LOOPLENGTH~~:

	~~LOOPSTART specifies the start of the song’s loop in samples. (Samples are the smallest unit of time for an OGG)~~
	~~LOOPLENGTH specifies the length of the song’s loop in samples. This is actually optional if the music file itself stops at the loop’s end.~~

	~~You can find these loop points by opening the song in Audacity, playing through it and carefully pinpointing the times you want to loop together~~.

	This can be an imperfect and laborious process. If the song you’re trying to use is popular enough, chances are it’s on Smas Custom Music. Using songs from this site makes the process much easier.		This can be an imperfect and laborious process. If the song you’re trying to use is popular enough, chances are it’s on Smas Custom Music. Using songs from this site makes the process much easier.

	Looping BRSTMs with Smash Custom Music		== Looping BRSTMs with Smash Custom Music ==
	Smash Custom Music is a site that hosts popular custom songs from various games. It’s particularly useful because it comes with loop points listed on the song page itself:		[https://smashcustommusic.net/ Smash Custom Music] is a site that hosts popular custom songs from various games. It’s particularly useful because it comes with loop points listed on the song page itself:

			[[File:ModdingMusic_SmashCustomMusic.png\|frameless]]

	What’s even more convenient is that there exists programs to convert BRSTMs to OGGs while fully preserving the loop points in the tags. One such tool is found here.		What’s even more convenient is that there exists programs to convert BRSTMs to OGGs while fully preserving the loop points in the tags. One such tool is found [https://www.lakora.us/brawl/brstm/old.html here].


			Download and run the program, and you should see the following UI:

			[[File:ModdingMusic_Converter.png\|frameless]]

			Choose to output as Looping OGG and select any downloaded BRSTM:

			[[File:ModdingMusic_BRSTM.png\|frameless]]

			Once converted, you will get a .logg file in the output folder:

			[[File:ModdingMusic_logg.png\|frameless]]
	~~Download and run the program, and you should see the following UI~~:

	~~Choose to output as Looping OGG and select any downloaded BRSTM:~~

	~~Once converted, you will get a~~ .~~logg file in the output folder:~~

	You can rename the extension to .ogg and it will work just fine.		You can rename the extension to .ogg and it will work just fine.



	If you inspect the tags, you’ll find them automatically generated:		If you inspect the tags, you’ll find them automatically generated:

			[[File:ModdingMusic_AutoLoopPoints.png\|frameless]]

	Additional Data		== Additional Data ==
	If you speak to Kriketune and open the music menu, you may find that your song is missing data for its Title, Origin, and Artist, unlike the other songs:		If you speak to Kriketune and open the music menu, you may find that your song is missing data for its Title, Origin, and Artist, unlike the other songs:

			[[File:ModdingMusic_Menu.png\|frameless]]



	In order to remedy this, simply add the data to the Title, Album, and Artist fields, respectively.		In order to remedy this, simply add the data to the Title, Album, and Artist fields, respectively.

			[[File:ModdingMusic_Metadata.png\|frameless]]

			== Spoilers ==
			Sometimes, you don’t want a song to be playable in the menu until the player has reached a certain point in the game. You can spoiler your music track by adding the SPOILER tag to the oggs, and give it a name you want to track:

	~~Spoilers~~		[[File:ModdingMusic_SpoilerTag.png\|frameless]]
	~~Sometimes, you don’t want a song to be playable in the menu until the player has reached a certain point in the game~~. ~~You can spoiler your music track by adding the SPOILER tag to the oggs, and give it a name you want to track:~~

	As a result, the track will be hidden from the music menu when accessed.		As a result, the track will be hidden from the music menu when accessed.

	To make it such that the song is unlocked, you will need to pass in the string to the function call used to open the music menu, likely by a condition checking a save variable. For example:		To make it such that the song is unlocked, you will need to pass in the string to the function call used to open the music menu, likely by a condition checking a save variable. For example:
			<pre>
	local unlocks = {}		local unlocks = {}
	if SV.temporal_pinnacle.ExpositionComplete then		if SV.temporal_pinnacle.ExpositionComplete then
Line 84:		Line 80:
	end		end
	UI:ShowMusicMenu(unlocks)		UI:ShowMusicMenu(unlocks)
			</pre>



	[[Category:Modding Assets]]		[[Category:Modding Assets]]

IDK: raw add

2022-09-12T00:39:04Z

raw add

← Older revision		Revision as of 00:39, 12 September 2022
Line 1:		Line 1:
	~~TBD~~		This page goes through the process of how to add new music to a PMDO mod.

			Adding Files
			Add music by placing the file in the Content/Music folder of your mod. It must be an OGG file:

			It will appear in the music list on the next refresh:



			Looping
			If you added an ogg, chances are it’s not set up to loop properly. You can set the loop points by editing the tags of the file. Use an editing software like MP3Tag.

















			You will need to edit the extended tags to include a LOOPSTART and LOOPLENGTH:

			LOOPSTART specifies the start of the song’s loop in samples. (Samples are the smallest unit of time for an OGG)
			LOOPLENGTH specifies the length of the song’s loop in samples. This is actually optional if the music file itself stops at the loop’s end.

			You can find these loop points by opening the song in Audacity, playing through it and carefully pinpointing the times you want to loop together.

			This can be an imperfect and laborious process. If the song you’re trying to use is popular enough, chances are it’s on Smas Custom Music. Using songs from this site makes the process much easier.

			Looping BRSTMs with Smash Custom Music
			Smash Custom Music is a site that hosts popular custom songs from various games. It’s particularly useful because it comes with loop points listed on the song page itself:


			What’s even more convenient is that there exists programs to convert BRSTMs to OGGs while fully preserving the loop points in the tags. One such tool is found here.








			Download and run the program, and you should see the following UI:

			Choose to output as Looping OGG and select any downloaded BRSTM:

			Once converted, you will get a .logg file in the output folder:

			You can rename the extension to .ogg and it will work just fine.



			If you inspect the tags, you’ll find them automatically generated:


			Additional Data
			If you speak to Kriketune and open the music menu, you may find that your song is missing data for its Title, Origin, and Artist, unlike the other songs:





			In order to remedy this, simply add the data to the Title, Album, and Artist fields, respectively.



			Spoilers
			Sometimes, you don’t want a song to be playable in the menu until the player has reached a certain point in the game. You can spoiler your music track by adding the SPOILER tag to the oggs, and give it a name you want to track:

			As a result, the track will be hidden from the music menu when accessed.

			To make it such that the song is unlocked, you will need to pass in the string to the function call used to open the music menu, likely by a condition checking a save variable. For example:
			local unlocks = {}
			if SV.temporal_pinnacle.ExpositionComplete then
			table.insert(unlocks, "FINAL_BATTLE")
			end
			UI:ShowMusicMenu(unlocks)




	[[Category:Modding Assets]]		[[Category:Modding Assets]]