XenonUI

From Elite Wiki
Revision as of 01:15, 16 June 2015 by Phkb (talk | contribs) (Quick Facts)
XenonUI sample.png

Overview

This OXP replaces all background UI screens with a new look and feel, based on the assumption that the Oolite UI screens are accessed through some form of computer terminal. The layout will change based on whether the HUD is on or off, in the ship is in space or docked, and (if in space), is in a red alert condition or not. The "Sub-Commands" section will show some important key codes and descriptions that are relevant on that page.

The method used to add the backgrounds will mean that the background images of most other OXP's, if they set a background, will be overridden with the Xenon UI images. This is by design.

If an OXP uses background images to convey important information to the player, and the "mission.runScreen" command in the OXP has a "screenID" parameter attached, it is possible to add exceptions to the override by adding the following code to a worldScript:

 var w = worldScripts.XenonUI;
 if (w) w.$addMissionScreenException("mymissionscreenid");

The OXP is made up of two parts: the main XenonUI.oxz, which holds all the config and code, and one of the resource packs that hold all the images and music: Pack A for 16:9 screens, and Pack B for 16:10 screens. This will allow fast updates to the code section, which is small, without having to download the large resources file regularly.

For narrower screens, there is a "Redux" version, which removes all the sidebars, leaving only

Also provided in this OXP is some new title screen theme music.

Compatibility with BackGroundSet (BGS)

Xenon UI is compatible with BGS, but depending on where each one is installed, one OXP may end up taking priority over the other when backgrounds are selected and displayed. When BGS has priority, its images will be displayed ahead of the Xenon UI images. This will be particular apparent on screens like the title page or the load/save page.

If both OXP's (Xenon UI and BGS) are installed in the Addons folder, Xenon UI will normally take priority over BGS.

If both OXP's are installed via the download manager, again, Xenon UI will normally take priority over BGS.

If BGS is installed via the download manager, and Xenon UI is installed in the AddOns folder, Xenon UI will take priority over BGS.

If Xenon UI is installed via the download manager, and BGS is installed in the AddOns folder, BGS will take priority over Xenon UI.

To ensure the Xenon UI backgrounds appear, the best approach is to make sure they are both installed in the same location.

If you encounter issues where the BGS backgrounds are being displayed rather than the Xenon UI ones, you will need to open the BGS OXP folder, then open the Config folder. Inside Config you will find a 'screenbackgrounds.plist' file. Either remove this or re-name it - perhaps re-name it to 'screenbackgrounds.Xplist' - and the Xenon UI backgrounds will be used without affecting any other aspect of BGS. By re-naming 'screenbackgrounds.plist' rather than removing it you have the option of switching back easily if required.

Licence/Author

This work is licensed under the Creative Commons Attribution-Noncommercial-Share Alike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/4.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA.
The expansion pack was developed by phkb.

Installation

Main Version

There are two components to the installation: The first part contains all the config and code. The second part contains all the image and music resources. Place the 'XenonUI.oxz' and either 'XenonUIResources.oxz' or 'XenonUIResourcesB.oxz' into your 'AddOns' folder and when you start the game, hold down 'Shift' until you see the spinning Cobra.
Alternatively, you can download the expansion using the expansion pack manager in the game itself.

Redux Version (for narrower eg 4:3 screens)

There are two components to the installation: The first part contains all the config and code. The second part contains all the image and music resources. Place the 'XenonReduxUI.oxz' and 'XenonReduxUIResources.oxz' into your 'AddOns' folder and when you start the game, hold down 'Shift' until you see the spinning Cobra.
Alternatively, you can download the expansion using the expansion pack manager in the game itself.

Note: The "Redux" version is incompatible with the main version. If both are installed, the 16:9 version will take precedence.

Download

Main Version

Download config v1.1.3 XenonUI.oxz (downloaded 4462 times).
Download resources pack A (16:9 screens) v1.1.3 XenonUIResources.oxz (downloaded 2046 times).
Download resources pack B (16:10 screens) v1.0.1 XenonUIResourcesB.oxz (downloaded 1164 times).

Redux Version (for narrower eg 4:3 screens)

Download config v1.1.2 XenonReduxUI.oxz (downloaded 1915 times).
Download resources v1.1.1 XenonReduxUIResources.oxz (downloaded 2121 times).
Alternative download for config from box.com
Alternative download for resources from box.com

Version History

Version 1.1.3

  • Updated manifest to remove required OXP, as there are now two different resource packs available.

Version 1.1.2

  • Changed manifest identifier to try and position the OXP at the bottom of the install list

Version 1.1.1

  • Fixed bug where "." is missing before "indexOf".

Version 1.1.0

  • Split OXZ into two, one for resources (music and images), one for the code and config.
  • Fixed file name issue for one of the files.
  • Code improvements as suggested by Wildeblood.
  • Added exception for Norby's forthcoming OXP (HDBG)
  • Added some BGS override exceptions

Version 1.0

  • Initial release

Quick Facts

Version Released License Features Category Author(s) Feedback
1.1.3 2015-06-08 CC BY-NC-SA 4.0 Backgrounds Music Ambience phkb Oolite BB

Gameplay and Balance indicator

Tag-colour-green.png