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

Extracting game files

2017-06-21T14:52:32Z

Myran: Reverted edits by Scratch (talk) to last revision by Mauritsio

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.

Main Page

2017-06-21T14:52:07Z

Myran: Reverted edits by Scratch (talk) to last revision by Myran

Welcome to the Bogus Detour wiki.

== Getting started ==
* [[Using the editor]]
** [[:Category:Editor layer|Editor layers]]
* [[Creating a scenario]]
* [[Sharing your scenario]]
* [[Adding custom sounds and music]]
* [[Scripting]]
** [[Creating a GameMode]]
** [[Creating a WorldScript]]
** [[Creating a Behavior]]
* [[:Category:File type|File types]]
* [[Console]]

== Scripting Documentation ==
* [http://ssbd.a000ff.com/docs/engine/ Engine API documentation]
* [http://ssbd.a000ff.com/docs/engine/ Script API documentation]

Creating a WorldScript

2017-04-18T14:26:12Z

Myran: Created page with "===Functions=== void Initialize() void Update(int dt) SValue@ ServerExecute() void ClientExecute(SValue@) void OnEnabledChanged(bool enabled) void Debu..."

===Functions===
void Initialize()
void Update(int dt)
SValue@ ServerExecute()
void ClientExecute(SValue@)
void OnEnabledChanged(bool enabled)
void DebugDraw(vec2, SpriteBatch&)
SValue@ Save()
void Load(SValue@ save)

Creating a Behavior

2017-04-18T14:23:59Z

Myran: Created page with "===Functions=== void Update(int dt) void QueuedPathfind(array<vec2>@ path) void QueuedFetchActors(array<UnitPtr>@ actors) void Collide(UnitPtr unit, vec2 pos,..."

===Functions===
void Update(int dt)
void QueuedPathfind(array<vec2>@ path)
void QueuedFetchActors(array<UnitPtr>@ actors)
void Collide(UnitPtr unit, vec2 pos, vec2 normal)
void Collide(UnitPtr unit, vec2 pos, vec2 normal, Fixture@ fxSelf, Fixture@ fxOther)
void EndCollision(UnitPtr unit)
void EndCollision(UnitPtr unit, Fixture@ fxSelf, Fixture@ fxOther)
void Destroyed()
vec4 GetOverlayColor()
SValue@ Save()
void Load(SValue@ save)
void PostLoad(SValue@ save)

Creating a GameMode

2017-04-18T14:21:39Z

Myran: Created page with "===Standard functions=== void Start(uint8, SValue@, StartMode) SValue@ Save() void AddPlayer(uint8) void RemovePlayer(uint8, bool) void UpdateFr..."

===Standard functions===

void Start(uint8, SValue@, StartMode)
SValue@ Save()

void AddPlayer(uint8)
void RemovePlayer(uint8, bool)

void UpdateFrame(int, GameInput&, MenuInput&)
void UpdatePausedFrame(int, GameInput&, MenuInput&)
void PreRenderFrame(int)
void RenderFrame(int, SpriteBatch&)

void ResizeWindow(int, int, float)
void Paused(bool)

vec2 GetCameraPos(int)
vec4 GetVignette(int)

===Menu functions===

void LobbyCreated(bool loadingSave)
void LobbyInviteAccepted()
void LobbyEntered()

void LobbyDataUpdate()
void LobbyMemberDataUpdate(uint8)
void LobbyList(array<uint64>@)

void SetMenuState(MenuState)
bool MenuBack()
void ShowMessage(MenuMessage)

void OnBindingInput(ControllerType, int)
void ChatMessage(uint8, string)

Main Page

2017-04-18T14:14:42Z

Myran:

Font file

2017-04-17T22:48:24Z

Myran:

.fnt

[//{{SERVERNAME}}/docs/engine/namespace_resources.html Resources::GetBitmapFont]

[http://www.angelcode.com/products/bmfont/ BMFont]

[[Category:File type]]

Script file

2017-04-17T22:47:29Z

Myran:

.as

[http://www.angelcode.com/angelscript/ AngelScript]

[[Category:File type]]

Tileset file

2017-04-17T22:46:56Z

Myran:

.tileset

[//{{SERVERNAME}}/docs/engine/namespace_resources.html Resources::GetTileset]

[[Category:File type]]

Texture file

2017-04-17T22:46:22Z

Myran:

.png/.jpg/.psd/.tga

[//{{SERVERNAME}}/docs/engine/namespace_resources.html Resources::GetTexture2D]

[[Category:File type]]

SoundBank file

2017-04-17T22:46:08Z

Myran:

.sbnk

[//{{SERVERNAME}}/docs/engine/namespace_resources.html Resources::GetSoundEvent]

[[Category:File type]]

Font file

2017-04-17T22:45:51Z

Myran:

.fnt

[//{{SERVERNAME}}/docs/engine/namespace_resources.html Resources::GetBitmapFont]

[[Category:File type]]

FMOD SoundBank file

2017-04-17T22:45:33Z

Myran:

.bank

[//{{SERVERNAME}}/docs/engine/namespace_resources.html Resources::GetSoundEvent]

[[Category:File type]]

Effect file

2017-04-17T22:45:07Z

Myran:

.effect

[//{{SERVERNAME}}/docs/engine/namespace_resources.html Resources::GetEffect]

===File format===

====Sprite====
====Light====
====Trail====

====Param====
These are values that can be sent to the effect and used in the effect expressions, for example these are used to send in an angle to most projectiles and rotate their sprites accordingly.
<param name="angle" default="0" />

====Variation====
====Data====

===Expression language===
This is a simple language for creating dynamic values that can change over time for the effect components, for example if you want a sprite to fade out during the effect you might do something like
color-a="1 - t"
or if you want it to pulse during the effect you could do
color-a="sin(t) / 2 + 0.5"

====Parameters====
There are four built in parameters for effects,
{| class="wikitable"
|t
|time
|0-1
|-
|l
|loop
|0+
|-
|u
|unit
|Not 0
|-
|i
|index
|0+
|}

The '''time''' parameter says where in the effect "timeline" you are, so it goes from 0 to 1 over the length of the effect, if the effect is looping then when '''time''' hits 1 it will reset to 0 and '''loop''' will increase by 1. So an expression like,
t + l
will simply start at 0 and go up forever until the effect is stopped.

The '''unit''' parameter simply contains the unit id for the unit that is currently playing the effect, this is fairly unique but can be reused for future effects getting played.

And the '''index''' parameter only exists inside a trail effect component and simply contains the id of the current segment in the trail.

More parameters can be added to an effect using the <param> tag and has to be filled with values by scripts.

====Functions====

{| class="wikitable"
|sin
|Simple sine function, takes radians
|-
|cos
|Simple cosine function, takes radians
|-
|abs
|The absolute value, basically just turns negative values in to positive ones
|-
|ceil
|Rounds a value up to the next or current integer
|-
|floor
|Rounds a value down to the previous or current integer
|-
|exp
|Returns e raised to the specified power
|-
|log
|Returns the natural (base e) logarithm of a specified number
|-
|saturate
|Clamps a number to 0-1
|-
|sign
|The sign of the number (-1, 0 or 1)
|-
|sqrt
|Square root
|-
|clamp
|clamp(v, min, max) - Clamps v so it is not lower than min or higher than max
|-
|lerp
|lerp(t, a, b) - Linearly interpolates from a to b using t (0-1)
|-
|smoothstep
|smoothstep(t, a, b) - Smoothly interpolates from a to b using t (0-1)
|-
|min
|Returns the smallest of two values
|-
|max
|Returns the largest of two values
|-
|pow
|pow(a, b) - Returns a to the power of b
|-
|rand
|Returns a random value based on an input value, for example rand(t) returns a new value every frame while rand(l) returns a new value every time the effect loops
|-
|wposx
|wposx(n) - Returns the x coordinate of where this unit was n frames ago relative to their current position
|-
|wposy
|wposy(n) - Returns the y coordinate of where this unit was n frames ago relative to their current position
|}

[[Category:File type]]

Unit file

2017-04-17T22:43:27Z

Myran:

.unit

[//{{SERVERNAME}}/docs/engine/namespace_resources.html Resources::GetUnitProducer]

==File format==
slot

layer

netsync

save

===Behavior===
class [[Script file]]

data [[SValue file]]

===Scenes===
Scene sets...

====Sprite====

====Shadow====

====Collision====

====Effect====
Includes an [[Effect file|Effect]] in to the scene.
<effect src="effects/weapons/projectile_laser.effect" />

====Scene====
Includes another scene from the same unit in to the current scene.
<scene src="shared" />

====Text====

====Light====

====Locator====
Defines a position that can be used in the scripts. Usually used for offsets for effects and projectile shooting.
<locator name="shoot-pos" pos="10 10" />

====Range====
Only used to visually display ranges using the [[Console]] variable "r_draw_ranges", useful in the editor for being able to see how far a unit might reach or something similar.
<range radius="16" />

====Data====
Arbitrary data using the [[SValue file|SValue]] format that can be used in scripts.
<data name="health">
<int>250</int>
</data>

[[Category:File type]]

SValue file

2017-04-17T22:42:47Z

Myran:

.sval

[//{{SERVERNAME}}/docs/engine/namespace_resources.html Resources::GetSValue]

[[Category:File type]]

Material file

2017-04-17T21:07:21Z

Myran:

.mats

shadow-mode

blend-mode

decal-mode

glow-mode

parallax

color

ignore-height

ignore-overlay-color

light-influence

xray-mask

xray

outline

alpha-expand

displacement

environment-mask

sort-bias

[[Category:File type]]

Effect file

2017-04-17T21:04:23Z

Myran:

.effect

===File format===

====Sprite====
====Light====
====Trail====

====Param====
These are values that can be sent to the effect and used in the effect expressions, for example these are used to send in an angle to most projectiles and rotate their sprites accordingly.
<param name="angle" default="0" />

====Variation====
====Data====

===Expression language===
This is a simple language for creating dynamic values that can change over time for the effect components, for example if you want a sprite to fade out during the effect you might do something like
color-a="1 - t"
or if you want it to pulse during the effect you could do
color-a="sin(t) / 2 + 0.5"

====Parameters====
There are four built in parameters for effects,
{| class="wikitable"
|t
|time
|0-1
|-
|l
|loop
|0+
|-
|u
|unit
|Not 0
|-
|i
|index
|0+
|}

The '''time''' parameter says where in the effect "timeline" you are, so it goes from 0 to 1 over the length of the effect, if the effect is looping then when '''time''' hits 1 it will reset to 0 and '''loop''' will increase by 1. So an expression like,
t + l
will simply start at 0 and go up forever until the effect is stopped.

The '''unit''' parameter simply contains the unit id for the unit that is currently playing the effect, this is fairly unique but can be reused for future effects getting played.

And the '''index''' parameter only exists inside a trail effect component and simply contains the id of the current segment in the trail.

More parameters can be added to an effect using the <param> tag and has to be filled with values by scripts.

====Functions====

{| class="wikitable"
|sin
|Simple sine function, takes radians
|-
|cos
|Simple cosine function, takes radians
|-
|abs
|The absolute value, basically just turns negative values in to positive ones
|-
|ceil
|Rounds a value up to the next or current integer
|-
|floor
|Rounds a value down to the previous or current integer
|-
|exp
|Returns e raised to the specified power
|-
|log
|Returns the natural (base e) logarithm of a specified number
|-
|saturate
|Clamps a number to 0-1
|-
|sign
|The sign of the number (-1, 0 or 1)
|-
|sqrt
|Square root
|-
|clamp
|clamp(v, min, max) - Clamps v so it is not lower than min or higher than max
|-
|lerp
|lerp(t, a, b) - Linearly interpolates from a to b using t (0-1)
|-
|smoothstep
|smoothstep(t, a, b) - Smoothly interpolates from a to b using t (0-1)
|-
|min
|Returns the smallest of two values
|-
|max
|Returns the largest of two values
|-
|pow
|pow(a, b) - Returns a to the power of b
|-
|rand
|Returns a random value based on an input value, for example rand(t) returns a new value every frame while rand(l) returns a new value every time the effect loops
|-
|wposx
|wposx(n) - Returns the x coordinate of where this unit was n frames ago relative to their current position
|-
|wposy
|wposy(n) - Returns the y coordinate of where this unit was n frames ago relative to their current position
|}

[[Category:File type]]

Effect file

2017-04-17T20:58:23Z

Myran:

.effect

===File format===

====Sprite====
====Light====
====Trail====

====Param====
These are values that can be sent to the effect and used in the effect expressions, for example these are used to send in an angle to most projectiles and rotate their sprites accordingly.
<param name="angle" default="0" />

====Variation====
====Data====

===Expression language===
====Parameters====
There are four built in parameters for effects,
{| class="wikitable"
|t
|time
|0-1
|-
|l
|loop
|0+
|-
|u
|unit
|Not 0
|-
|i
|index
|0+
|}

The '''time''' parameter says where in the effect "timeline" you are, so it goes from 0 to 1 over the length of the effect, if the effect is looping then when '''time''' hits 1 it will reset to 0 and '''loop''' will increase by 1. So an expression like,
t + l
will simply start at 0 and go up forever until the effect is stopped.

The '''unit''' parameter simply contains the unit id for the unit that is currently playing the effect, this is fairly unique but can be reused for future effects getting played.

And the '''index''' parameter only exists inside a trail effect component and simply contains the id of the current segment in the trail.

More parameters can be added to an effect using the <param> tag and has to be filled with values by scripts.

====Functions====

{| class="wikitable"
|sin
|Simple sine function, takes radians
|-
|cos
|Simple cosine function, takes radians
|-
|abs
|The absolute value, basically just turns negative values in to positive ones
|-
|ceil
|Rounds a value up to the next or current integer
|-
|floor
|Rounds a value down to the previous or current integer
|-
|exp
|Returns e raised to the specified power
|-
|log
|Returns the natural (base e) logarithm of a specified number
|-
|saturate
|Clamps a number to 0-1
|-
|sign
|The sign of the number (-1, 0 or 1)
|-
|sqrt
|Square root
|-
|clamp
|clamp(v, min, max) - Clamps v so it is not lower than min or higher than max
|-
|lerp
|lerp(t, a, b) - Linearly interpolates from a to b using t (0-1)
|-
|smoothstep
|smoothstep(t, a, b) - Smoothly interpolates from a to b using t (0-1)
|-
|min
|Returns the smallest of two values
|-
|max
|Returns the largest of two values
|-
|pow
|pow(a, b) - Returns a to the power of b
|-
|rand
|Returns a random value based on an input value, for example rand(t) returns a new value every frame while rand(l) returns a new value every time the effect loops
|-
|wposx
|wposx(n) - Returns the x coordinate of where this unit was n frames ago relative to their current position
|-
|wposy
|wposy(n) - Returns the y coordinate of where this unit was n frames ago relative to their current position
|}

[[Category:File type]]

Effect file

2017-04-17T20:41:56Z

Myran:

Effect file

2017-04-17T20:24:02Z

Myran:

Main Page

2017-04-17T20:16:22Z

Myran:

Welcome to the Bogus Detour wiki.

== Getting started ==
* [[Using the editor]]
** [[:Category:Editor layer|Editor layers]]
* [[Creating a scenario]]
* [[Sharing your scenario]]
* [[Adding custom sounds and music]]
* [[Scripting]]
** [[Scripting a Gamemode]]
** [[Scripting a WorldScript]]
** [[Scripting a Behavior]]
* [[:Category:File type|File types]]
* [[Console]]

== Scripting Documentation ==
* [http://ssbd.a000ff.com/docs/engine/ Engine API documentation]
* [http://ssbd.a000ff.com/docs/engine/ Script API documentation]

Unit file

2017-04-17T20:15:38Z

Myran:

.unit

==File format==
slot

layer

netsync

save

===Behavior===
class [[Script file]]

data [[SValue file]]

===Scenes===
Scene sets...

====Sprite====

====Shadow====

====Collision====

====Effect====
Includes an [[Effect file|Effect]] in to the scene.
<effect src="effects/weapons/projectile_laser.effect" />

====Scene====
Includes another scene from the same unit in to the current scene.
<scene src="shared" />

====Text====

====Light====

====Locator====
Defines a position that can be used in the scripts. Usually used for offsets for effects and projectile shooting.
<locator name="shoot-pos" pos="10 10" />

====Range====
Only used to visually display ranges using the [[Console]] variable "r_draw_ranges", useful in the editor for being able to see how far a unit might reach or something similar.
<range radius="16" />

====Data====
Arbitrary data using the [[SValue file|SValue]] format that can be used in scripts.
<data name="health">
<int>250</int>
</data>

[[Category:File type]]

Unit file

2017-04-17T17:14:40Z

Myran:

.unit

==File format==
slot

layer

netsync

save

===Behavior===
class [[Script file]]

data [[SValue file]]

===Scenes===
Scene sets...

====Sprite====

====Shadow====

====Collision====

====Effect====
Includes an [[Effect file|Effect]] in to the scene.
<effect src="effects/weapons/projectile_laser.effect" />

====Scene====
Includes another scene from the same unit in to the current scene.
<scene src="shared" />

====Text====

====Light====

====Locator====
Defines a position that can be used in the scripts. Usually used for offsets for effects and projectile shooting.
<locator name="shoot-pos" pos="10 10" />

====Range====
Only used to visually display ranges using the console variable "r_draw_ranges", useful in the editor for being able to see how far a unit might reach or something similar.
<range radius="16" />

====Data====
Arbitrary data using the [[SValue file|SValue]] format that can be used in scripts.
<data name="health">
<int>250</int>
</data>

[[Category:File type]]

Pen editor layer

2017-04-17T16:53:18Z

Myran:

Editor layer for quickly placing connecting units as described in a [[Pen file]]

[[Category:Editor layer]]

Tilemap editor layer

2017-04-17T16:52:32Z

Myran:

Editor layer for painting tilesets defined in a [[Tileset file]]

[[Category:Editor layer]]

Category:Unit editor layer

2017-04-17T16:51:25Z

Myran: Created page with "Editor layer for placing and manipulating units defined in a Unit file"

Editor layer for placing and manipulating units defined in a [[Unit file]]

Items editor layer

2017-04-17T16:50:35Z

Myran:

This is an editor layer for manipulating units which are tagged as being in the slot "item"

[[Category:Unit editor layer]]
[[Category:Editor layer]]

Doodads editor layer

2017-04-17T16:50:23Z

Myran:

This is an editor layer for manipulating units which are tagged as being in the slot "doodad"

[[Category:Unit editor layer]]
[[Category:Editor layer]]

Actors editor layer

2017-04-17T16:50:11Z

Myran:

This is an editor layer for manipulating units which are tagged as being in the slot "actor"

[[Category:Unit editor layer]]
[[Category:Editor layer]]

Items editor layer

2017-04-17T16:48:49Z

Myran:

[[Category:Unit editor layer]]
[[Category:Editor layer]]

Doodads editor layer

2017-04-17T16:48:43Z

Myran:

[[Category:Unit editor layer]]
[[Category:Editor layer]]

Actors editor layer

2017-04-17T16:48:34Z

Myran:

[[Category:Unit editor layer]]
[[Category:Editor layer]]

Category:File type

2017-04-17T15:53:35Z

Myran: Created blank page

Main Page

2017-04-17T15:42:59Z

Myran:

Welcome to the Bogus Detour wiki.

== Getting started ==
* [[Using the editor]]
** [[:Category:Editor layer|Editor layers]]
* [[Creating a scenario]]
* [[Sharing your scenario]]
* [[Adding custom sounds and music]]
* [[Scripting]]
** [[Scripting a Gamemode]]
** [[Scripting a WorldScript]]
** [[Scripting a Behavior]]
* [[:Category:File type|File types]]

== Scripting Documentation ==
* [http://ssbd.a000ff.com/docs/engine/ Engine API documentation]
* [http://ssbd.a000ff.com/docs/engine/ Script API documentation]

Effect file

2017-04-17T15:38:54Z

Myran: Created page with ".effect Category:File type"

.effect

[[Category:File type]]

Environment file

2017-04-17T15:38:36Z

Myran: Created page with ".env Category:File type"

.env

[[Category:File type]]

FMOD SoundBank file

2017-04-17T15:38:16Z

Myran: Created page with ".bank Category:File type"

.bank

[[Category:File type]]

Font file

2017-04-17T15:37:54Z

Myran: Created page with ".fnt Category:File type"

.fnt

[[Category:File type]]

GUI file

2017-04-17T15:37:34Z

Myran: Created page with ".gui Category:File type"

.gui

[[Category:File type]]

Level file

2017-04-17T15:37:14Z

Myran: Created page with ".lvl Category:File type"

.lvl

[[Category:File type]]

Material file

2017-04-17T15:36:54Z

Myran: Created page with ".mats Category:File type"

.mats

[[Category:File type]]

NetMessage file

2017-04-17T15:36:28Z

Myran: Created page with ".net Category:File type"

.net

[[Category:File type]]

Pen file

2017-04-17T15:36:02Z

Myran: Created page with ".pen Category:File type"

.pen

[[Category:File type]]

Script file

2017-04-17T15:35:39Z

Myran: Created page with ".as Category:File type"

.as

[[Category:File type]]

SoundBank file

2017-04-17T15:35:16Z

Myran: Created page with ".sbnk Category:File type"

.sbnk

[[Category:File type]]

Sound file

2017-04-17T15:34:25Z

Myran: Created page with ".wav/.ogg/.mp3/.mod/.it/.s3d/.xm Category:File type"

.wav/.ogg/.mp3/.mod/.it/.s3d/.xm

[[Category:File type]]

SValue file

2017-04-17T15:33:40Z

Myran: Created page with ".sval Category:File type"

.sval

[[Category:File type]]

Texture file

2017-04-17T15:33:10Z

Myran: Created page with ".png/.jpg/.psd/.tga Category:File type"

.png/.jpg/.psd/.tga

[[Category:File type]]

Tileset file

2017-04-17T15:32:12Z

Myran: Created page with ".tileset Category:File type"

.tileset

[[Category:File type]]