Serious Sam's Bogus Detour - User contributions [en]

Adding custom sounds and music

2017-06-19T09:58:00Z

Mauritsio: /* Creating the .sbnk file */

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 ==
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 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.
*''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.

Talk:Adding custom sounds and music

2017-06-19T09:53:43Z

Mauritsio:

This currently talks only about the ogg format, while wav is also supported. [[User:Scratch|Scratch]] ([[User talk:Scratch|talk]]) 11:25, 19 June 2017 (CEST)

Edited. [[User:Mauritsio|Mauritsio]] ([[User talk:Mauritsio|talk]]) 11:53, 19 June 2017 (CEST)

Adding custom sounds and music

2017-06-19T09:50:12Z

Mauritsio:

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 ==
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 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.
*''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.

User:Mauritsio

2017-06-15T12:21:24Z

Mauritsio: Created page with "== Who are you? == I am '''Mauritsio'''. I'm a modder, gamer and occassional writer. I'm a beta tester for Bogus Detour and currently hard at work making modifications for Bog..."

== Who are you? ==
I am '''Mauritsio'''. I'm a modder, gamer and occassional writer. I'm a beta tester for Bogus Detour and currently hard at work making modifications for Bogus Detour.

I hail from the Netherlands (not Holland!) and my birthday is September the 1st. I am currently studying in Amsterdam.

[http://steamcommunity.com/id/mighty-stache/ Here's my Steam profile.]

== SSBD modding portfolio ==
#[http://steamcommunity.com/sharedfiles/filedetails/?id=912645865 The Four Keys], a single-level campaign of about two hours playtime. Created using only standard game assets.
#More coming soon, I promise.

Adding custom sounds and music

2017-06-15T12:08:53Z

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..."

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.

Extracting game files

2017-06-15T10:22:00Z

Mauritsio: /* On Windows */

The packager tool allows you to [[Sharing your scenario|package a scenario]], but it also allows you to unpack or extract scenarios, as well as base the content from the <code>res/assets.bin</code> file. This is useful if you want to use any of our base resources such as units and scripts, in your mod, or use them as reference material.

== On Windows ==
First, navigate to your Bogus Detour installation folder. In this folder, hold down Shift and F10 at the same time to open the advanced shortcut menu. From here, select "Open command prompt here." You should now see the Windows command prompt in front of you, in the current folder. Then, run the following command, which will extract all files from <code>res/assets.bin</code> into the <code>assets</code> folder.

<pre>
PACKAGER.exe /u res/assets.bin /d assets
</pre>

== On Linux ==
It's roughly the same process as on Windows, except you pass the parameters a little bit differently to the Packager tool:

<pre>
./PACKAGER -u res/assets.bin -d assets
</pre>

== Scenarios ==
The same process works for scenarios, except you pass the .bds file to the /u parameter. For example:

<pre>
PACKAGER.exe /u scenarios/payload.bds /d scenarios/payload
</pre>

Note that this currently does not extract the info.xml.