Difference between revisions of "BGS"

From Elite Wiki
m (added CaptainBerfPilot patch)
m (v1.3.3)
Line 1: Line 1:
−
[[Image:Bgs-i_intro.jpg|200px|thumb|right|Higher res pic available]]
 +
[[Image:Bgs-i_intro.jpg|216px|thumb|right|Higher res pic available]]
 
{{Infobox OXP| title = BGS
  
{{Infobox OXP| title = BGS
 
|image =
 
|image =
 
|download = [[#Download|See Download]]
  
|download = [[#Download|See Download]]
−
|story = 2010-11-26
 +
|story = 2011-03-16
 
|ships = No
  
|ships = No
 
|stations = No
  
|stations = No
Line 10: Line 10:
 
|alternativeHUD = No
  
|alternativeHUD = No
 
|soundSet = Yes
  
|soundSet = Yes
−
|version = 1.3.2
 +
|version = 1.3.3
 
|category = Ambience OXPs
  
|category = Ambience OXPs
 
|author = Pagroove &<br>Svengali
  
|author = Pagroove &<br>Svengali
 
}}
  
}}
 
=== Overview ===
  
=== 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. 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. 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.
  
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.
Line 45: Line 45:
 
* 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].
   
−
=== Configuration ===
 +
=== Requirements ===
 
{{OXPConfig-small}}
  
{{OXPConfig-small}}
−
BGS-M (the music/FX script) can be adjusted via the following properties...
  
  +
* Latest version needs Oolite v1.75.1
−
{| border="0" style="text-align:left; width:60%"
  
−
|-
  
−
! this.logging
  
−
| Boolean || Internal logging
  
−
|-
  
−
! this.stationMusic
  
−
| Boolean || Music when docked
  
−
|-
  
−
! this.ambientSounds
  
−
| Boolean || Ambient sounds
  
−
|-
  
−
! this.fxSounds
  
−
| Boolean || FX
  
−
|-
  
−
! this.bgsDisableCrowd
  
−
| Boolean || the same as script_info bgs_nocrowd, but for all stations
  
−
|-
  
−
! this.bgsDisableJump
  
−
| Boolean || disables the timed countdown
  
−
|-
  
−
! this.bgsDelay
  
−
| Number || defines the time to wait in ms before reinit
  
−
|}
  
−  
−
==== 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+BGS-M 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. Not necessary anymore in v1.3.
  
−  
−
==== 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] (814.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.
  
−
* If you want to disable some onscreen messages BGS ships now a "_descriptions.plist" that cleans them out. Rename this file to activate it.
  
−  
−  
−
That's it .-)
  
−  
−
=== Requirements ===
  
−
* Latest version needs Oolite v1.74
  
 
* No dependencies
  
* No dependencies
   
Line 124: Line 53:
 
{{OXPLevel}}
  
{{OXPLevel}}
 
Full version<br>
  
Full version<br>
−
[http://www.box.net/shared/nolo3vv2to BGS-A1.3.2.zip] (9 MB) Updated 2010-11-26.<br><br>
 +
[http://www.box.net/shared/nolo3vv2to BGS-A1.3.3.zip] (9.1 MB) Updated 2011-03-16.<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.3.2.zip] (1.5 MB) Updated 2010-11-26.<br>
 +
[http://www.box.net/shared/jthkxbd2ps BGS-C1.3.3.zip] (1.5 MB) Updated 2011-03-16.<br>
−
[http://www.box.net/shared/qyto8r5dip BGS-I1.3.2.zip] (4 MB) Updated 2010-11-26.<br>
 +
[http://www.box.net/shared/qyto8r5dip BGS-I1.3.3.zip] (4 MB) Updated 2011-03-16.<br>
−
[http://www.box.net/shared/qmgevlsjgm BGS-M1.3.2.zip] (3.7MB) Updated 2010-11-26.
 +
[http://www.box.net/shared/qmgevlsjgm BGS-M1.3.3.zip] (3.9 MB) Updated 2011-03-16.
   
 
Alternative Soundset:<br>
  
Alternative Soundset:<br>
−
[http://www.box.net/shared/0gbs8ylljz BGS-Soundset_Pagroove2.1.zip] (6.4MB)
 +
[http://www.box.net/shared/0gbs8ylljz BGS-Soundset_Pagroove1.3.3.zip] (6.4MB) Read the included readme!
  +
  +
Additional:<br>
  +
Offline documentation:
  +
[http://www.box.net/shared/r6trz63cgr BGS1.3.3_Doc.zip] (137.9 KB)
  +
  +
Test OXP:
  +
[http://www.box.net/shared/c5rx0j2ygv BGS-Test.zip] (941.6KB)
   
 
The following patches are for other soundsets and require the original oxp and BGS-A or BGS-M:<br>
  
The following patches are for other soundsets and require the original oxp and BGS-A or BGS-M:<br>
Line 138: Line 67:
 
- [http://www.box.net/shared/ln2vzuexj0 Hawksound_BGS.zip] (224.4KB) 2010-09-23<br>
  
- [http://www.box.net/shared/ln2vzuexj0 Hawksound_BGS.zip] (224.4KB) 2010-09-23<br>
 
- [http://dl.dropbox.com/u/5747615/Crew%20Sound%20Set/Captain%20Berf%20Pilot_BGS.zip Captain Berf Pilot_BGS.zip] (207 KB) 2010-09-25<br>
  
- [http://dl.dropbox.com/u/5747615/Crew%20Sound%20Set/Captain%20Berf%20Pilot_BGS.zip Captain Berf Pilot_BGS.zip] (207 KB) 2010-09-25<br>
  +
  +
   
 
{{ambience-OXP}}
  
{{ambience-OXP}}

Revision as of 22:56, 16 March 2011

Higher res pic available
BGS
Download Link See Download
Version 1.3.3
History 2011-03-16
Stations No
Ships No
Missions No
Equipment No
Alternative HUD
Available 		No
Sound Set
Available 		Yes
Category Ambience OXPs
Author Pagroove &
Svengali

Overview

Backgroundset (or short BGS) is a framework for images, sounds and music. 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 or Hyperradio and is compatible to OXPConfig2. Patches for Captain_Berf_Pilot, CustomSounds, Halsis and Hawksound are also available. 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.

Requirements

OXPConfig compatible.png
  • Latest version needs Oolite v1.75.1
  • No dependencies

Download

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

Full version
BGS-A1.3.3.zip (9.1 MB) Updated 2011-03-16.

Single versions (you don't need them if you already have BGS-A):
BGS-C1.3.3.zip (1.5 MB) Updated 2011-03-16.
BGS-I1.3.3.zip (4 MB) Updated 2011-03-16.
BGS-M1.3.3.zip (3.9 MB) Updated 2011-03-16.

Alternative Soundset:
BGS-Soundset_Pagroove1.3.3.zip (6.4MB) Read the included readme!

Additional:
Offline documentation: BGS1.3.3_Doc.zip (137.9 KB)

Test OXP: BGS-Test.zip (941.6KB)

The following patches are for other soundsets and require the original oxp and BGS-A or BGS-M:
- CustomSounds_BGS.zip (255KB) 2010-09-23
- Halsis_BGS.zip (183KB) 2010-09-23
- Hawksound_BGS.zip (224.4KB) 2010-09-23
- Captain Berf Pilot_BGS.zip (207 KB) 2010-09-25

Retrieved from "http://backup.witchspacewiki.org/index.php?title=BGS&oldid=27407"