BGS2 Doc - Revision history

Cholmondely: Added note & link to older documentation

2021-06-03T08:18:07Z

Added note & link to older documentation

Svengali: Added script_info key ''bgs_chatExpand'' and user setting ''ChatExpand''

2018-11-20T18:54:50Z

Added script_info key ''bgs_chatExpand'' and user setting ''ChatExpand''

Svengali: Changed bgs_tunnel_brightness to bgs_tunnel_contrast

2018-10-22T09:46:50Z

Changed bgs_tunnel_brightness to bgs_tunnel_contrast

Svengali: Added bgs_tunnel_brightness

2018-10-21T22:31:48Z

Added bgs_tunnel_brightness

Svengali: Added user settings overview

2018-02-28T00:15:03Z

Added user settings overview

Svengali at 22:05, 13 February 2018

2018-02-13T22:05:28Z

Svengali: v2.x doc

2018-02-13T22:00:25Z

v2.x doc

New page

== Autoconfiguration ==
=== Countdown ===
BGS checks the keys in customsounds.plist (<code>[galactic-hyperspace-countdown-begun]</code> and <code>[hyperspace-countdown-begun]</code>) to see if another soundpack is using them. If so BGS disables its own countdown.

=== Effects ===
On <code>startUp</code> BGS checks the shader support level. If it's switched off or no shader support is available all effects are disabled.

== Properties ==
'''$pub''' - Holds various entries for customization via other AddOns.
:;chat: Array. Holds filenames for aegis chatter.
:;engineAmbi: String. Ambient sound while engine is running.
:;engineDown: String. Sound for decelerating.
:;engineUp: String. Sound for accelerating.
:;witch: Array. Countdown sounds starting with zero.
:;witchCNT: Number. Start countdown at +1.
:;witchG: String. Sound for galactic jump.
:;witchH: String. Sound for standard jump.

== shipdata.plist ==
Additional keys for specific entities are available and can be specified via script_info dictionary.

'''Keys'''
:;bgs_engineAmbi:String/Filename. Playership - engine mumble sound.
:;bgs_engineUp:String/Filename. Playership - engine acceleration sound.
:;bgs_engineDown:String/Filename. Playership - engine deceleration sound.
:;bgs_tunnel_off:Boolean. Station - disables the tunnel effect.
:;bgs_tunnel_shape:Number. Station - range 0.38 - 5.0. If not specified the script takes the ratio of the first found dock bounding box x/y to get the shape.
::0.5 - square 45 degrees rotated with aspect ratio
::1 - circle with aspect ratio
::>1 - squircle...rectangle (>1.1 with decreased aspect ratio to get a wider tunnel)
:;bgs_tunnel_texture:String/Filename. Station.
:;bgs_tunnel_tint:Array. Color for lines in docking effect.

Examples:

Playership (without preloaded sounds):
script_info = {bgs_engineAmbi = "myEngine.ogg"; bgs_engineUp = "myEngineUp.ogg"; bgs_engineDown = "myEngineDown.ogg";};

Station:
script_info = {bgs_tunnel_texture = "myOwnTexture.png";};

== Docking FX ==
<gallery widths="100px" heights="100px" perrow="5">
File:Bgs docking effect 1.jpg|1.1
File:Bgs docking effect 2.jpg|1.2
File:Bgs docking effect 3.jpg|1.3
</gallery>
The effect is done via VisualEffect entity. The model is a plane and gets scaled to fullscreen (with z = -1).

The input texture (figure 1.1) gets wrapped around via abs(atan(y,x)) (figure 1.2). You can imagine this as a cylinder with infinite length and you are looking into it, with a mirror axis along x. As the shape can be adjusted we can reach square, circle and squircle (figure 1.3).

The shader applies some glowing lines and adds a opening door. Artists don't have to care much about it - the shaders does it on it's own. The interesting bit though is the coloring of the door. It's taken from the input image and gets mixed with the glowing lines to some extend to get a smoother transition between tunnel and door and the tint (bgs_tunnel_tint, default rgb: 0.2824, 0.171, 0.0507) gets applied.

[[Category:OXPDoc]]

← Older revision		Revision as of 08:18, 3 June 2021
Line 1:		Line 1:
		+	{{OXPNote\|This documentation reflects the state since v1.10 (2016). For the older documentation see [[BGS Doc]]}}
		+
	== Console usage ==		== Console usage ==
	{{CodeEx\|codeex=worldScripts.BGS._Help();}}		{{CodeEx\|codeex=worldScripts.BGS._Help();}}

@@ Line 13: / Line 13: @@
 == Properties ==
 '''$pub''' - Holds various entries for customization via other AddOns.
-:;chat: Array. Holds filenames for aegis chatter.
+:;chat: Array. Holds filenames for aegis chatter. To expand push your files in it.
 :;engineAmbi: String. Ambient sound while engine is running.
 :;engineDown: String. Sound for decelerating.
@@ Line 30: / Line 30: @@
 :;bgs_engineUp:String/Filename. Playership - engine acceleration sound.
 :;bgs_engineDown:String/Filename. Playership - engine deceleration sound.
 :;bgs_tunnel_off:Boolean. Station - disables the tunnel effect.
 :;bgs_tunnel_contrast:Number. Station - adjusts the texture contrast. Default 0.4. {{AV|2.5}}
@@ Line 67: / Line 68: @@
 :;chatPause:Random pause for Aegis chatter in range 14...chatPause. Integer, Def 26.
 :;Chatter:Switch for Aegis chatter. Bool, Def true.
 :;Countdown:Timed countdown. Bool, Def true.
 :;Engine:Engine sounds. Bool, Def true.

← Older revision		Revision as of 22:05, 13 February 2018
Line 1:		Line 1:
		+	== Console usage ==
		+	{{CodeEx\|codeex=worldScripts.BGS._Help();}}
		+
		+
	== Autoconfiguration ==		== Autoconfiguration ==
	=== Countdown ===		=== Countdown ===

@@ Line 31: / Line 31: @@
 :;bgs_engineDown:String/Filename. Playership - engine deceleration sound.
 :;bgs_tunnel_off:Boolean. Station - disables the tunnel effect.
-:;bgs_tunnel_brightness:Number. Station - adjusts the tunnel brightness. Default 0.4. {{AV|2.5}}
+:;bgs_tunnel_contrast:Number. Station - adjusts the texture contrast. Default 0.4. {{AV|2.5}}
 :;bgs_tunnel_shape:Number. Station - range 0.38 - 5.0. If not specified the script takes the ratio of the first found dock bounding box x/y to get the shape.
 ::0.5 - square 45 degrees rotated with aspect ratio
 ::1 - circle with aspect ratio
 ::>1 - squircle...rectangle (>1.1 with decreased aspect ratio to get a wider tunnel)
-:;bgs_tunnel_texture:String/Filename. Station.
+:;bgs_tunnel_texture:String/Filename. Station. Default bgs_docking_tunnel01.png.
-:;bgs_tunnel_tint:Array. Station. Color for lines in docking effect.
+:;bgs_tunnel_tint:Array. Station. Color for lines in docking effect. Default 0.2824,0.171,0.0507.
 Examples:

@@ Line 5: / Line 5: @@
 == Autoconfiguration ==
 === Countdown ===
-BGS checks the keys in customsounds.plist (<code>[galactic-hyperspace-countdown-begun]</code> and <code>[hyperspace-countdown-begun]</code>) to see if another soundpack is using them. If so BGS disables its own countdown.
+[[BGS]] checks the keys in customsounds.plist (<code>[galactic-hyperspace-countdown-begun]</code> and <code>[hyperspace-countdown-begun]</code>) to see if another soundpack is using them. If so BGS disables its own countdown.
 === Effects ===
@@ Line 36: / Line 36: @@
 ::>1 - squircle...rectangle (>1.1 with decreased aspect ratio to get a wider tunnel)
 :;bgs_tunnel_texture:String/Filename. Station.
-:;bgs_tunnel_tint:Array. Color for lines in docking effect.
+:;bgs_tunnel_tint:Array. Station. Color for lines in docking effect.
 Examples:
@@ Line 57: / Line 57: @@
 The shader applies some glowing lines and adds a opening door. Artists don't have to care much about it - the shaders does it on it's own. The interesting bit though is the coloring of the door. It's taken from the input image and gets mixed with the glowing lines to some extend to get a smoother transition between tunnel and door and the tint (bgs_tunnel_tint, default rgb: 0.2824, 0.171, 0.0507) gets applied.