BGS2 Doc - Revision history

Cholmondely: /* Docking FX */ Added link

2025-07-19T23:50:59Z

‎Docking FX: Added link

Cholmondely: Added another couple of tunnel effect pictures

2024-02-07T18:14:42Z

Added another couple of tunnel effect pictures

Cholmondely: /* Docking FX */ Tweaks!

2023-12-31T15:19:12Z

‎Docking FX: Tweaks!

Cholmondely: /* Docking FX */ Added more

2023-12-31T14:11:23Z

‎Docking FX: Added more

Cholmondely: /* User settings */ Added comments, added "Old Hyperspace" setting, added picture

2023-12-31T12:16:39Z

‎User settings: Added comments, added "Old Hyperspace" setting, added picture

Cholmondely: Added another picture

2023-12-31T11:34:46Z

Added another picture

Cholmondely: /* Docking FX */ Added examples of docking tunnel textures

2023-12-31T02:16:07Z

‎Docking FX: Added examples of docking tunnel textures

Cholmondely: Retagged!

2023-09-20T13:42:42Z

Retagged!

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''

← Older revision		Revision as of 23:50, 19 July 2025
Line 81:		Line 81:

	*[[Behemoth]] has the military tunnel texture also used in Anarchies		*[[Behemoth]] has the military tunnel texture also used in Anarchies
		+
		+	=== Links ===
		+	*Docking effect analysis: [http://adrianboeing.blogspot.com/2011/01/webgl-tunnel-effect-explained.html Tunnel effect explained in WebGL] (Adrian Boeing, 2011)

	== User settings ==		== User settings ==

@@ Line 55: / Line 55: @@
 [[File:Taxi docking tunnel01.png|thumb|250px|right|Taxi Galactica (taxi_docking_tunnel01.png)]]
 [[File:WildShips bgs.png|thumb|250px|right|WildShips (Kiota stations: wildShips_bgs.png)]]
 <gallery widths="100px" heights="100px" perrow="5">
 File:Bgs docking effect 1.jpg|1.1<br>bgs_docking_tunnel01

@@ Line 56: / Line 56: @@
 [[File:WildShips bgs.png|thumb|250px|right|WildShips (Kiota stations: wildShips_bgs.png)]]
 <gallery widths="100px" heights="100px" perrow="5">
-File:Bgs docking effect 1.jpg|1.1
+File:Bgs docking effect 1.jpg|1.1<br>bgs_docking_tunnel01
 File:Bgs docking effect 2.jpg|1.2
 File:Bgs docking effect 3.jpg|1.3
@@ Line 67: / Line 67: @@
 === Examples ===
-BGS itself has 3 basic textures (bgs_docking_tunnel01.png, bgs_docking_tunnel02.png & bgs_docking_tunnel03.png)
+BGS itself has 3 basic textures (bgs_docking_tunnel01.png - ''shown above at 1.1'', bgs_docking_tunnel02.png & bgs_docking_tunnel03.png)
 *[[Anarchies]] has another 4 - two based on bgs_docking_tunnel02.png, the military tunnel texture and a variant on it.

@@ Line 52: / Line 52: @@
 == Docking FX ==
 [[File:Rescue Stations- Rrsfl hq bgs tunnel.png|thumb|250px|right|Rescue Stations (rrsfl_hq_bgs_tunnel.png)]]
 [[File:WildShips bgs.png|thumb|250px|right|WildShips (Kiota stations: wildShips_bgs.png)]]
 <gallery widths="100px" heights="100px" perrow="5">
 File:Bgs docking effect 1.jpg|1.1
@@ Line 66: / Line 67: @@
 === Examples ===
-*[[Rescue Stations]] has two BGS tunnel textures, one for the Rescue Stations and another for Rock Hermits.
+BGS itself has 3 basic textures (bgs_docking_tunnel01.png, bgs_docking_tunnel02.png & bgs_docking_tunnel03.png)
-*[[Wildships]] has the one for the various Kiota stations
-*[[Anarchies]] has another 4 - mostly variations on a theme
+*[[Anarchies]] has another 4 - two based on bgs_docking_tunnel02.png, the military tunnel texture and a variant on it.
-*[[Taxi Galactica]] has yet another which is a little different
+*[[Feudal States]] has the unique and unexciting lodge-tunnel.png
 == User settings ==

@@ Line 72: / Line 72: @@
 == User settings ==
-BGS can be configured through Librarys [[Lib_Config|Lib_Config]]. None of them should be touched by other AddOns. The options are
+BGS can be configured through Library.oxp's [[Lib_Config|"Lib_Config"]]. None of them should be touched by other AddOns. The options are
-:;jitter:Joystick jitter adjustment. Float, Def 0.002.
+:;jitter:Joystick jitter adjustment. Float, Def 0.002. For inhibiting jitter in a faulty joystick
-:;cntAdd:Countdown offset. Float, Def -0.3.
+:;cntAdd:Countdown offset. Float, Def -0.3. For tweaking the hyperspace jump countdown to match that in the console messages.
-:;chatPause:Random pause for Aegis chatter in range 14...chatPause. Integer, Def 26.
+:;chatPause:Random pause for BGS's Aegis chatter in range 14...chatPause. Integer, Def 26.
-:;Chatter:Switch for Aegis chatter. Bool, Def true.
+:;Chatter:Switch for BGS's Aegis chatter. Bool, Def true.
-:;ChatExpand:Allow chatter for secondary stations. Ruled by Chatter setting. Bool, Def false. {{AV|2.5.1}}
+:;ChatExpand:Allow BGS chatter for secondary stations. Ruled by Chatter setting. Bool, Def false. {{AV|2.5.1}}
 :;Countdown:Timed countdown. Bool, Def true.
 :;Engine:Engine sounds. Bool, Def true.
@@ Line 88: / Line 88: @@
 :;Dock FX:Launching and docking visual effect. Bool, Def true.
 :;FX Redux:Reduced shaders for Hyperspace and launching. Bool, Def false.
+:;Old Hyperspace:Selects old (BGS v.1.10.9) spiderweb effect. Bool, Def false.
 [[Category:OXP API's]]

← Older revision		Revision as of 13:42, 20 September 2023
Line 82:		Line 82:


−	[[Category:~~OXPDoc~~]]	+	[[Category:OXP API's]]

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