Adding custom sounds and music - Revision history

Scratch at 08:39, 31 July 2017

2017-07-31T08:39:41Z

Scratch at 08:36, 31 July 2017

2017-07-31T08:36:20Z

Mauritsio: /* Creating the .sbnk file */

2017-06-19T09:58:00Z

‎Creating the .sbnk file

Mauritsio at 09:50, 19 June 2017

2017-06-19T09:50:12Z

Scratch: Set parameters in example

2017-06-19T09:22:38Z

Set parameters in example

Mauritsio: Created page with "Adding in custom sounds and music to your scenarios requires the usage of '''.sbnk''' files. While your computer likely doesn't recognize this file type, it is really a glorif..."

2017-06-15T12:08:53Z

Created page with "Adding in custom sounds and music to your scenarios requires the usage of '''.sbnk''' files. While your computer likely doesn't recognize this file type, it is really a glorif..."

New page

Adding in custom sounds and music to your scenarios requires the usage of '''.sbnk''' files. While your computer likely doesn't recognize this file type, it is really a glorified text file and can be opened with any simple text editor, such as [https://notepad-plus-plus.org/ Notepad++].

The sound files themselves must be presented in the '''.ogg''' format. An audio editing program such as [http://www.audacityteam.org/ Audacity] can convert most common audio filetypes into the .ogg format.

== Exporting sound files to .ogg ==
If your sound file is not already in the .ogg format, follow these steps to do so. Using ''Audacity'', drag the sound file of your choice into the gray area. If successful, you will see the audio channel appear. You may now edit the sound file if you wish, otherwise, click the "File" tab and then the "Export" button. As file type, select "Ogg Vorbis" and export it to anywhere in your scenario folder, preferablly a dedicated folder called "sound". Continue to do this for all the sound files you need.

== Creating the .sbnk file ==
With all the .ogg files ready, you must now create an .sbnk file at which you can configure some parameters. Simply open a text editor like Notepad++, then copy this example code:

<pre>
<soundbank>
<sound category="sound" name="" volume="" is3d="" looping="">
<source res="sound/MySound.ogg" />
</sound>
</soundbank>
</pre>

You can edit the following parameters:

- ''name'': The name that the sound will appear in while using the editor.

- ''volume'': The volume of the sound file. 1 is the standard volume, but you can only make it quieter.

- ''is3d'': boolean. If set to true, the sound will only play in an area around the PlaySound WorldScript that it is assigned to. If false, it will play across the entire level.

- ''looping'': boolean. If set to true, the sound file will keep playing everytime it finishes. If false, it will only play once.

If you wish to add in more sound files, simply copy and paste the <sound> parameters and edit them accordingly. You can use as many as needed.
When done, save the file as .sbnk.

== Using the sound files in the editor ==
Open up a level, and navigate to the WorldScripts tab. Spawn in a PlaySound WorldScript. Select it, then in the "Sound" parameter, type in the name of your .sbnk file, or the name you gave the sound, and it will show up.

You can do the same for the PlayMusic WorldScript.

@@ Line 1: / Line 1: @@
 Adding in custom sounds and music to your scenarios requires the usage of '''.sbnk''' files. While your computer likely doesn't recognize this file type, it is really a glorified text file and can be opened with any simple text editor, such as [https://notepad-plus-plus.org/ Notepad++].
 The sound files themselves must be presented in any of the following formats: '''.wav, .ogg, .mp3, .mod, .it, .s3d, .xm'''. Each file format has its own benefits: .ogg files are relatively small, at the cost of some audio quality, while .wav files will take up more space but with good amount of quality. In the end, it is recommended to use .ogg for music, and .wav for sounds. An audio editing program such as [http://www.audacityteam.org/ Audacity] can convert most common audio filetypes into most of these formats.
 == Exporting sound files to .ogg ==
@@ Line 19: / Line 21: @@
 == Alternatively - use Fmod ==
-The game uses Fmod internally to do all of its sounds. These kinds of sound effects start with the <code>event:/</code> prefix instead of directly pointing to an .sbnk file. They are therefore found within a .bank file instead.
+The game uses Fmod internally to do all of its sounds. These kinds of sound effects start with the <code>event:/</code> prefix instead of directly pointing to an .sbnk file. They are therefore found within a .bank file instead. It is possible to create your own Fmod Studio soundbanks for your scenarios.
 Download Fmod Studio 1.09.xx from [http://www.fmod.org/download/ this page]. Then, download [http://ssbd.a000ff.com/files/fmod_framework.zip this Fmod skeleton project] to get your started. The reason this skeleton project is needed is because your settings must match ours exactly, which is what this does. Once you export your Fmod soundbank file, you will be able to play each of the sounds or music you've added in Fmod Studio, from within your scenario.

← Older revision		Revision as of 08:36, 31 July 2017
Line 17:		Line 17:
	== Using the sound files in the editor ==		== Using the sound files in the editor ==
	Open up a level, and navigate to the WorldScripts tab. Spawn in a PlaySound WorldScript. Select it, then in the "Sound" parameter, type in the name of your .sbnk file, or the name you gave the sound, and it will show up. You can do the same for the PlayMusic WorldScript.		Open up a level, and navigate to the WorldScripts tab. Spawn in a PlaySound WorldScript. Select it, then in the "Sound" parameter, type in the name of your .sbnk file, or the name you gave the sound, and it will show up. You can do the same for the PlayMusic WorldScript.
		+
		+	== Alternatively - use Fmod ==
		+	The game uses Fmod internally to do all of its sounds. These kinds of sound effects start with the <code>event:/</code> prefix instead of directly pointing to an .sbnk file. They are therefore found within a .bank file instead.
		+
		+	Download Fmod Studio 1.09.xx from [http://www.fmod.org/download/ this page]. Then, download [http://ssbd.a000ff.com/files/fmod_framework.zip this Fmod skeleton project] to get your started. The reason this skeleton project is needed is because your settings must match ours exactly, which is what this does. Once you export your Fmod soundbank file, you will be able to play each of the sounds or music you've added in Fmod Studio, from within your scenario.

@@ Line 7: / Line 7: @@
 == Creating the .sbnk file ==
-With all the .ogg files ready, you must now create an .sbnk file at which you can configure some parameters. Simply open a text editor like Notepad++, then copy the [[SoundBank file|example code on this page]]. You can edit the following parameters:
+With your sound files ready, you must now create an .sbnk file at which you can configure some parameters. Simply open a text editor like Notepad++, then copy the [[SoundBank file|example code on this page]]. You can edit the following parameters:
 *''name'': The name that the sound will appear in while using the editor.
 *''volume'': The volume of the sound file. 1 is the standard volume, but you can only make it quieter.

@@ Line 1: / Line 1: @@
 Adding in custom sounds and music to your scenarios requires the usage of '''.sbnk''' files. While your computer likely doesn't recognize this file type, it is really a glorified text file and can be opened with any simple text editor, such as [https://notepad-plus-plus.org/ Notepad++].
-The sound files themselves must be presented in the '''.ogg''' format. An audio editing program such as [http://www.audacityteam.org/ Audacity] can convert most common audio filetypes into the .ogg format.
+The sound files themselves must be presented in any of the following formats: '''.wav, .ogg, .mp3, .mod, .it, .s3d, .xm'''. Each file format has its own benefits: .ogg files are relatively small, at the cost of some audio quality, while .wav files will take up more space but with good amount of quality. In the end, it is recommended to use .ogg for music, and .wav for sounds. An audio editing program such as [http://www.audacityteam.org/ Audacity] can convert most common audio filetypes into most of these formats.
 == Exporting sound files to .ogg ==
-If your sound file is not already in the .ogg format, follow these steps to do so. Using ''Audacity'', drag the sound file of your choice into the gray area. If successful, you will see the audio channel appear. You may now edit the sound file if you wish, otherwise, click the "File" tab and then the "Export" button. As file type, select "Ogg Vorbis" and export it to anywhere in your scenario folder, preferablly a dedicated folder called "sound". Continue to do this for all the sound files you need.
+If your sound file is not already in any of the supported file formats, follow these steps to do so. Using ''Audacity'', drag the sound file of your choice into the gray area. If successful, you will see the audio channel appear. You may now edit the sound file if you wish, otherwise, click the "File" tab and then the "Export" button. Select the file type you wish to use and export it to anywhere in your scenario folder, preferablly a dedicated folder called "sound". Continue to do this for all the sound files you need.
 == Creating the .sbnk file ==
-With all the .ogg files ready, you must now create an .sbnk file at which you can configure some parameters. Simply open a text editor like Notepad++, then copy this example code:
+With all the .ogg files ready, you must now create an .sbnk file at which you can configure some parameters. Simply open a text editor like Notepad++, then copy the [[SoundBank file|example code on this page]]. You can edit the following parameters:
+*''name'': The name that the sound will appear in while using the editor.
-<pre>
+*''volume'': The volume of the sound file. 1 is the standard volume, but you can only make it quieter.
-<soundbank>
+*''is3d'': boolean. If set to true, the sound will only play in an area around the PlaySound WorldScript that it is assigned to. If false, it will play across the entire level.
-	<sound category="sound" name="mymusic" volume="1.0" is3d="false" looping="true">
+*''looping'': boolean. If set to true, the sound file will keep playing everytime it finishes. If false, it will only play once.
 If you wish to add in more sound files, simply copy and paste the <sound> parameters and edit them accordingly. You can use as many as needed.
 When done, save the file as .sbnk.
 == Using the sound files in the editor ==
-Open up a level, and navigate to the WorldScripts tab. Spawn in a PlaySound WorldScript. Select it, then in the "Sound" parameter, type in the name of your .sbnk file, or the name you gave the sound, and it will show up.
+Open up a level, and navigate to the WorldScripts tab. Spawn in a PlaySound WorldScript. Select it, then in the "Sound" parameter, type in the name of your .sbnk file, or the name you gave the sound, and it will show up. You can do the same for the PlayMusic WorldScript.

@@ Line 11: / Line 11: @@
 <pre>
 <soundbank>
-	<sound category="sound" name="" volume="" is3d="" looping="">
+	<sound category="sound" name="mymusic" volume="1.0" is3d="false" looping="true">
 		<source res="sound/MySound.ogg" />
 	</sound>