BGS

Higher res pic available

BGS
Download Link	See Download
Version	1.3.2
History	2010-11-26
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 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.

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

Configuration

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

Download

0-{{{2}}}

Full version
BGS-A1.3.2.zip (9 MB) Updated 2010-11-26.

Single versions (you don't need them if you already have BGS-A):
BGS-C1.3.2.zip (1.5 MB) Updated 2010-11-26.
BGS-I1.3.2.zip (4 MB) Updated 2010-11-26.
BGS-M1.3.2.zip (3.7MB) Updated 2010-11-26.

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

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