Difference between revisions of "BGS"

From Elite Wiki
Jump to: navigation, search
m
m (BGS 1.2)
Line 3: Line 3:
 
|image =  
 
|image =  
 
|download = [[#Download|See Download]]
 
|download = [[#Download|See Download]]
|story = 2010-09-04
+
|story = 2010-09-19
 
|ships = No
 
|ships = No
 
|stations = No
 
|stations = No
Line 17: Line 17:
 
Backgroundset (or short BGS) is a framework for images, sounds and music and takes advantage of the shiny new features in Oolite 1.74 (and higher). It is meant as a starting point and ships already a basic set - though this set is actually 3 oxps to do different jobs.  
 
Backgroundset (or short BGS) is a framework for images, sounds and music and takes advantage of the shiny new features in Oolite 1.74 (and higher). It is meant as a starting point and ships already a basic set - though this set is actually 3 oxps to do different jobs.  
  
We will release these packs as separate oxps and an all-inclusive pack that combines them, so players can pick the one (or two or three) they like to use. And other packs are currenty prepared as alternative sound packs.
+
We have released these packs as separate oxps and an all-inclusive pack that combines them, so players can pick the one (or two or three) they like to use. An alternative sound pack is also available and more will follow.
  
 
Oolite will never be the same. It feels like a whole new game.
 
Oolite will never be the same. It feels like a whole new game.
  
It also works perfectly together with OXPs like Frame's [[Random_Docking_Music_OXP|Random Docking Music]], Captain Berf's speech pack or [[Hyperradio_js_OXP|Hyperradio]] and is compatible to [[OXPConfig|OXPConfig2]].
+
It also works with OXPs like Frame's [[Random_Docking_Music_OXP|Random Docking Music]], Captain Berf's speech pack or [[Hyperradio_js_OXP|Hyperradio]] and is compatible to [[OXPConfig|OXPConfig2]].
Additionally it grabs entries from shipdata.plist. This way player-ships can have unique soundsets and stations can have specific ambient music.
+
Additionally it grabs entries from shipdata.plist and missiontext.plist. This way player-ships can have unique soundsets and stations can have specific ambient music and other soundpacks can use the mechanism in BGS.
  
 
The packs:
 
The packs:
Line 28: Line 28:
 
* BGS-A is the all-inclusive version to get a consistent pack. It includes BGS-C, BGS-I and BGS-M.
 
* BGS-A is the all-inclusive version to get a consistent pack. It includes BGS-C, BGS-I and BGS-M.
  
The following single packs have now been released:
+
The following single packs have been released:
  
 
* BGS-C is a modified version of Aegidians customsounds.oxp, based on Oolites customsounds.plist.
 
* BGS-C is a modified version of Aegidians customsounds.oxp, based on Oolites customsounds.plist.
Line 37: Line 37:
 
* Plays sounds and music when docked.
 
* Plays sounds and music when docked.
 
* Custom engine sounds. Now you can make your ship oxp unique by providing it with its own engine sound.  
 
* Custom engine sounds. Now you can make your ship oxp unique by providing it with its own engine sound.  
* Custom station music. We provided you with 2 tunes on the go but you can make your own
+
* Custom station music. We provided you with 2 tunes on the go but you can make your own.
* Custom sounds inflight (included is an easy to use customsounds.plist) to allocate your own sounds
+
* Custom sounds inflight (included is an easy to use customsounds.plist) to allocate your own sounds.
 
* Images for Intro, Load, Save, Options, Equipment, Shipyard, Status, Manifest, Charts, SystemData, Market and Contracts screen.
 
* Images for Intro, Load, Save, Options, Equipment, Shipyard, Status, Manifest, Charts, SystemData, Market and Contracts screen.
 
* Useable for other oxps to define own engine sounds or music.
 
* Useable for other oxps to define own engine sounds or music.
 
* Configurable (by editing or [[OXPConfig|OXPConfig2]]).
 
* Configurable (by editing or [[OXPConfig|OXPConfig2]]).
 +
* Timed countdowns for hyperspace jumps (and galactic jumps).
 
* Pagroove has created a nice demo video -> [http://www.youtube.com/watch?v=uZqSvpNG3Wc YouTube].
 
* Pagroove has created a nice demo video -> [http://www.youtube.com/watch?v=uZqSvpNG3Wc YouTube].
  
Line 60: Line 61:
 
! this.extraB
 
! this.extraB
 
| Boolean || FX
 
| Boolean || FX
 +
|-
 +
! this.bgsDisableCrowd
 +
| Boolean || the same as script_info bgs_nocrowd, but for all stations
 +
|-
 +
! this.bgsDisableJump
 +
| Boolean || disables the timed countdown
 
|}
 
|}
  
* To define specific engine sounds for a player-ship it needs a key in shipdata.plist:
+
==== Playerships ====
   script_info = {"engine" = "myengine.ogg"; "engineUp" = "myengineUp.ogg"; "engineDown" = "myengineDown.ogg";};
+
(script_info in shipdata.plist):
 +
   script_info = {"bgs_engine" = "myengine.ogg"; "bgs_engineUp" = "myengineUp.ogg"; "bgs_engineDown" = "myengineDown.ogg";};
 +
Defines specific engine sounds. Prefixed now with "bgs_".
 +
  script_info = {"bgs_countonly" = true;};
 +
Bypasses ambient sounds for jumping, useful if hyperspace_motor_spin_time is used.
  
* To define muisc for a specific station it needs a key in shipdata.plist:
+
==== Stations ====
   script_info = {"music" = "mymusic.ogg";};
+
(script_info in shipdata.plist):
 +
   script_info = {"bgs_music" = "mymusic.ogg";};
 +
Defines music for a specific station. Prefixed now with "bgs_".
 +
  script_info = {"bgs_nocrowd" = true;};
 +
Disables sounds for F5/F8 and switches image for F5 (switch only happens is BGS-A or BGS-I installed).
 +
  script_info = {"bgs_nomusic" = true;};
 +
Disables music for this station.
 +
 
 +
==== Multple Screens ====
 +
  worldScripts["BGS-M"].bgsOff = true;
 +
Additionally it is possible to disable it (if oxps needs silence for multiple mission screens). Changed from externalOff.
 +
 
 +
==== Further tweaks ====
 +
missiontext.plist (specially for other soundpacks):
 +
  "BGS-DISABLEJUMP" = "Yes";
 +
Same as this.bgsDisableJump (set to "No" to activate function). BGS-C activates this key!
 +
  "BGS-COUNTONLY" = "Yes";
 +
Bypasses ambient sounds for jumping, but leaves the countdown (set to "No" to activate function).
 +
  "BGS-COUNT" = "5";
 +
Spoken countdown start at second #. Valid range 1-10. BGS itself uses only the last 5 seconds.
 +
  "BGS-COUNTDOWN" = "name";
 +
Names for countdown - requires [BGS-COUNT]. Filenames will be build name+[BGS-COUNT]+".ogg" and counted down to zero!
 +
  "BGS-COUNTLAYER" = "name";
 +
Name of ambient part for jumps. Expected filenames name+[BGS-COUNTLAYER]+"g.ogg" and name+[BGS-COUNTLAYER]+"h.ogg"
 +
 
 +
All script_info keys are specific for the current playership or station, while all keys in missiontext.plist are global, but keep in mind that the loading order of Oolite defines which settings are the 'winning' ones. So choose the keys carefully. The properties have the highest priority, then comes the missiontext.plist keys and last but not least the shipdata script_infos. The configuration works only in one direction to avoid user settings (disabled features this.bgsDisableCrowd and this.bgsDisableJump) being overriden by oxp settings.
 +
 
 +
For developers we have prepared a test oxp that uses these keys above:
 +
[http://www.box.net/shared/c5rx0j2ygv BGS-Test.zip] (513.3KB)
 +
 
 +
==== Additionally ====
 +
* If you want to disable a specific customsounds sound BGS ships now a silent soundfile. By setting a customsounds key to bgs-m_silence.ogg, specific sounds can be disabled.
  
* Additionally it is possible to disable it (if oxps needs silence):
 
  worldScripts["BGS-M"].externalOff = true;
 
  
Further tweaks are possible:
 
* If you want to disable a specific ambient/FX sound (e.g when docked), simply rename the start condition in the sound pool.
 
* If you want to disable a specific customsounds sound set the key to "" in customsounds.plist.
 
 
That's it .-)
 
That's it .-)
  
Line 83: Line 120:
 
{{OXPLevel}}
 
{{OXPLevel}}
 
Full version<br>
 
Full version<br>
[http://www.box.net/shared/nolo3vv2to BGS-A1.1.zip] (9.2MB) Updated 2010-09-04.<br>
+
[http://www.box.net/shared/nolo3vv2to BGS-A1.2.zip] (9.1MB) Updated 2010-09-19.<br><br>
 
Single versions (you don't need them if you already have BGS-A):<br>
 
Single versions (you don't need them if you already have BGS-A):<br>
[http://www.box.net/shared/jthkxbd2ps BGS-C1.1.zip] (1.8MB) Updated 2010-09-04.<br>
+
[http://www.box.net/shared/jthkxbd2ps BGS-C1.2.zip] (1.5MB) Updated 2010-09-19.<br>
[http://www.box.net/shared/qyto8r5dip BGS-I1.1.zip] (3.9MB) Updated 2010-09-04.<br>
+
[http://www.box.net/shared/qyto8r5dip BGS-I1.2.zip] (4.1MB) Updated 2010-09-19.<br>
[http://www.box.net/shared/qmgevlsjgm BGS-M1.1.zip] (3.5MB) Updated 2010-09-04.
+
[http://www.box.net/shared/qmgevlsjgm BGS-M1.2.zip] (3.7MB) Updated 2010-09-19.
  
Updates for v1.0 (already included in v1.1):<br>
+
Alternative Soundset:<br>
[http://www.box.net/shared/d24quduxd9 BGS Soundpatch.zip] (376KB) 2010-08-14 - contains missing energy bomb sound and fixes digital clipping.<br>
+
[http://www.box.net/shared/0gbs8ylljz BGS-Soundset_Pagroove2.1.zip] (6.4MB)
[http://www.box.net/shared/3m1j5ciryc BGS Scriptupdate] (2.4KB) 2010-09-04 - Scriptupdate to v1.1.
 
  
Alternative Soundset:<br>
 
[http://www.box.net/shared/jjx02qkv39 BGS-PAGsoundsetv2.zip] (6.8MB)
 
  
 
{{Sound-Set-OXP}}
 
{{Sound-Set-OXP}}
 
[[Category:OXPConfig-compatible OXPs]]
 
[[Category:OXPConfig-compatible OXPs]]
 
[[Category:Oolite_expansion_packs]]
 
[[Category:Oolite_expansion_packs]]

Revision as of 00:31, 19 September 2010

Higher res pic available
BGS
Download Link See Download
Version 1.0
History 2010-09-19
Stations No
Ships No
Missions No
Equipment No
Alternative HUD
Available
No
Sound Set
Available
Yes
Category Feature OXPs
Author Pagroove &
Svengali

Overview

Backgroundset (or short BGS) is a framework for images, sounds and music and takes advantage of the shiny new features in Oolite 1.74 (and higher). It is meant as a starting point and ships already a basic set - though this set is actually 3 oxps to do different jobs.

We have released these packs as separate oxps and an all-inclusive pack that combines them, so players can pick the one (or two or three) they like to use. An alternative sound pack is also available and more will follow.

Oolite will never be the same. It feels like a whole new game.

It also works with OXPs like Frame's Random Docking Music, Captain Berf's speech pack or Hyperradio and is compatible to OXPConfig2. Additionally it grabs entries from shipdata.plist and missiontext.plist. This way player-ships can have unique soundsets and stations can have specific ambient music and other soundpacks can use the mechanism in BGS.

The packs:

  • BGS-A is the all-inclusive version to get a consistent pack. It includes BGS-C, BGS-I and BGS-M.

The following single packs have been released:

  • BGS-C is a modified version of Aegidians customsounds.oxp, based on Oolites customsounds.plist.
  • BGS-I is a set of background images, based on Oolites screenbackgrounds.plist.
  • BGS-M is a script that controls ambient music and ambient sounds plus a few special sound effects.

Features

  • Plays sounds and music when docked.
  • Custom engine sounds. Now you can make your ship oxp unique by providing it with its own engine sound.
  • Custom station music. We provided you with 2 tunes on the go but you can make your own.
  • Custom sounds inflight (included is an easy to use customsounds.plist) to allocate your own sounds.
  • Images for Intro, Load, Save, Options, Equipment, Shipyard, Status, Manifest, Charts, SystemData, Market and Contracts screen.
  • Useable for other oxps to define own engine sounds or music.
  • Configurable (by editing or OXPConfig2).
  • Timed countdowns for hyperspace jumps (and galactic jumps).
  • Pagroove has created a nice demo video -> YouTube.

Configuration

OXPConfig compatible.png

BGS-M (the music/FX script) can be adjusted via the following properties...

this.logging Boolean Internal logging
this.audio Boolean Music when docked
this.extraA Boolean Ambient sounds
this.extraB Boolean FX
this.bgsDisableCrowd Boolean the same as script_info bgs_nocrowd, but for all stations
this.bgsDisableJump Boolean disables the timed countdown

Playerships

(script_info in shipdata.plist):

 script_info = {"bgs_engine" = "myengine.ogg"; "bgs_engineUp" = "myengineUp.ogg"; "bgs_engineDown" = "myengineDown.ogg";};

Defines specific engine sounds. Prefixed now with "bgs_".

 script_info = {"bgs_countonly" = true;};

Bypasses ambient sounds for jumping, useful if hyperspace_motor_spin_time is used.

Stations

(script_info in shipdata.plist):

 script_info = {"bgs_music" = "mymusic.ogg";};

Defines music for a specific station. Prefixed now with "bgs_".

 script_info = {"bgs_nocrowd" = true;};

Disables sounds for F5/F8 and switches image for F5 (switch only happens is BGS-A or BGS-I installed).

 script_info = {"bgs_nomusic" = true;};

Disables music for this station.

Multple Screens

 worldScripts["BGS-M"].bgsOff = true;

Additionally it is possible to disable it (if oxps needs silence for multiple mission screens). Changed from externalOff.

Further tweaks

missiontext.plist (specially for other soundpacks):

 "BGS-DISABLEJUMP" = "Yes";

Same as this.bgsDisableJump (set to "No" to activate function). BGS-C activates this key!

 "BGS-COUNTONLY" = "Yes";

Bypasses ambient sounds for jumping, but leaves the countdown (set to "No" to activate function).

 "BGS-COUNT" = "5";

Spoken countdown start at second #. Valid range 1-10. BGS itself uses only the last 5 seconds.

 "BGS-COUNTDOWN" = "name";

Names for countdown - requires [BGS-COUNT]. Filenames will be build name+[BGS-COUNT]+".ogg" and counted down to zero!

 "BGS-COUNTLAYER" = "name";

Name of ambient part for jumps. Expected filenames name+[BGS-COUNTLAYER]+"g.ogg" and name+[BGS-COUNTLAYER]+"h.ogg"

All script_info keys are specific for the current playership or station, while all keys in missiontext.plist are global, but keep in mind that the loading order of Oolite defines which settings are the 'winning' ones. So choose the keys carefully. The properties have the highest priority, then comes the missiontext.plist keys and last but not least the shipdata script_infos. The configuration works only in one direction to avoid user settings (disabled features this.bgsDisableCrowd and this.bgsDisableJump) being overriden by oxp settings.

For developers we have prepared a test oxp that uses these keys above: BGS-Test.zip (513.3KB)

Additionally

  • If you want to disable a specific customsounds sound BGS ships now a silent soundfile. By setting a customsounds key to bgs-m_silence.ogg, specific sounds can be disabled.


That's it .-)

Requirements

  • Latest version needs Oolite v1.74
  • No dependencies

Download

Levelindicator0.png
0-{{{2}}}

Full version
BGS-A1.2.zip (9.1MB) Updated 2010-09-19.

Single versions (you don't need them if you already have BGS-A):
BGS-C1.2.zip (1.5MB) Updated 2010-09-19.
BGS-I1.2.zip (4.1MB) Updated 2010-09-19.
BGS-M1.2.zip (3.7MB) Updated 2010-09-19.

Alternative Soundset:
BGS-Soundset_Pagroove2.1.zip (6.4MB)