Difference between revisions of "Library.OXP"

From Elite Wiki
m (→‎Features)
m (sm aid)
 
(25 intermediate revisions by 3 users not shown)
Line 1: Line 1:
  +
''This page is about the OXP helper expansion pack, Library, for other uses, see [[Library (disambiguation)]].''
  +
 
[[Image:IconLib.png|100px|right]]
  
[[Image:IconLib.png|100px|right]]
  +
[[Image:Lib_Animator01.png|320px|thumb|right|Animator]]
  +
[[Image:Sv pad03.jpg|320px|thumb|right|PAD: GalCop]]
  +
[[Image:Lib_PAD01.png|320px|thumb|right|PAD: Persons]]
  +
[[File:Sv pad08.jpg|320px|thumb|right|PAD: Player data]]
  +
[[Image:Lib_Starmap02.png|320px|thumb|right|Starmap]]
 
==Overview==
  
==Overview==
−
Reinventing the wheel is not everybodys taste, so here comes a collection of useful snippets and helpers.
 +
Reinventing the wheel is not everybody's taste, so here comes a collection of useful snippets and helpers.
 
Its main purpose is to simplify or unify some common tasks used by OXPers. Library is the successor to [[CCL]], [[Hyperradio]] and [[OXPConfig]]. The library does not alter any native JS objects (like Array or String) to avoid clashes and does not clutter the global namespace.
  
Its main purpose is to simplify or unify some common tasks used by OXPers. Library is the successor to [[CCL]], [[Hyperradio]] and [[OXPConfig]]. The library does not alter any native JS objects (like Array or String) to avoid clashes and does not clutter the global namespace.
   
  +
This oxp also adds the following items to the F4 ship-station interface page
  +
*'''Config for AddOns''' (AddOns category) - for tweaking OXPs
  +
*[[Lib PAD|PAD]] (Captain's Log category) - a personal assistance device with details of naval career, people met, ''etc''.
  +
  +
The P.A.D. (or Personal Assistance Device) ships functionality to display different sorts of data, sorted by categories. Every category may contain several pages (or subcategories) - which can also be implemented by AddOns. What I do have right now are categories for
  +
: GALCOP: A standard entry, but after doing specific jobs it will contain an entry for the Navy as well. Other AddOns may add more.
  +
: GUILDS: An empty entry at the moment. Could be used e.g. by RandomHits, Feudal States and other AddOns which do have a membership.
  +
: INFOS: A category for special events, news, etc. Could be useful e.g. for BloombergMarkets, ''etc''.
  +
: LOGBOOK: A category for standard events like rescued escape pods, bailed out, fined, etc. Could be used for contracts as well.
  +
: PERSONS: A category for characters you have met.
  +
: SYSTEMS: A category for special systems like Tianve, Tionisla, ''etc''.
  +
: SEARCH
  +
: PLAYER DATA
  +
The PAD also ships with search functionality and some categories do allow the player to add custom notes. The display of these pages is based on templates, so all pages in a category will have the same layout. AddOns can add data easily to existing pages or add a new page in existing categories. Another feature is to set player specific data, like origin, species, gender, age and a custom picture.
  +
  +
Note: there are several oxp's that allow for configuring other oxp's:
  +
*Library (the most recent, done via the F4 page when docked) by Svengali
  +
*[[OXPConfig]] (done via the F2 page - press F7 when told to) by Svengali
  +
*[http://www.aegidian.org/bb/viewtopic.php?f=4&t=19650 Station Options] by cag: this one is comprehensible, but alas, only a beta version (2018)
   
 
==Features==
  
==Features==
  +
For Documentation just follow the links.
 
* ''Lib_2DCollision.js'' - Methods for checking if point is in bounding-box, on line or in poly.
  
* ''Lib_2DCollision.js'' - Methods for checking if point is in bounding-box, on line or in poly.
 
* ''Lib_Animator.js'' - Tool to create animations on missionscreens (see [[#Demos|Demos]]).
  
* ''Lib_Animator.js'' - Tool to create animations on missionscreens (see [[#Demos|Demos]]).
Line 14: Line 41:
 
* ''Lib_Main.js'' - Generic functions for various tasks.
  
* ''Lib_Main.js'' - Generic functions for various tasks.
 
* ''[[Lib_Music|Lib_Music.js]]'' - Unified event driven and generic music handling (see [[#Demos|Demos]]).
  
* ''[[Lib_Music|Lib_Music.js]]'' - Unified event driven and generic music handling (see [[#Demos|Demos]]).
  +
* ''[[Lib_PAD|Lib_PAD.js]]'' - Unified logbook, mission-log, diary and interface. {{AV|1.7}}
  +
* ''[[Lib_Starmap|Lib_Starmap.js]]'' - In-System-Maps in 3D (docked and inflight) (see [[#Demos|Demos]]). {{AV|1.7}}
   
−
==Requirements==
  
  +
== ID ==
−
* Latest version needs Oolite v1.84.
  
  +
identifier = "oolite.oxp.Svengali.Library";
   
  +
==Requirements==
  +
* Latest version needs Oolite v1.88.
   
 
==Download==
  
==Download==
 
Install like any other [[OXP]].
  
Install like any other [[OXP]].
−
* [https://app.box.com/s/z4zk0ny5mh6oxjywg3rtqkiwgplx8i2b Release candidate] (zip, 806.7 KB)
 +
* [https://app.box.com/s/gqfc5nxse0k9yipm93wrjra7nqjzy89y Library 1.7.1] (oxz, 4.9 MiB)
  +
  +
==== Music ====
  +
Music for playing the game to (these three need [[Library]] to function):
  +
*[https://app.box.com/s/xd9hnscxrjlb0p5suz8t00e7m5qo743d Lib Music Orchestral Demo]: [[User:Svengali|Svengali]]'s original music .oxp (2016: 22Mb)
  +
*[https://app.box.com/s/453g1khs7a9uephfjglsq6zu4kd2grsu Contextual Jukebox OXP] by Arquebus of [http://www.aegidian.org/bb/viewtopic.php?f=2&t=21111 YouTube fame] (2021: 115Mb)
  +
*[http://www.aegidian.org/bb/viewtopic.php?f=4&t=21127 Dangerous Background Music OXP]: Tsoj's DIY kit! (2021)
   
 
===Demos===
  
===Demos===
 
Install like any other [[OXP]].
  
Install like any other [[OXP]].
−
* [https://app.box.com/s/59vqswqh0wxiccerk7wgxerl0m0wmx20 Animator Demo] (zip, 2.8 MB)
 +
* [https://app.box.com/s/59vqswqh0wxiccerk7wgxerl0m0wmx20 Animator Demo] (zip, 2.8 MiB)
−
* [https://app.box.com/s/xd9hnscxrjlb0p5suz8t00e7m5qo743d Music Demo] (zip, 22.2 MB)
 +
* [https://app.box.com/s/0enjeiuyzjkyg36yxc5j04sdjhx9s7aa Starmap Demo] (oxz, 2.4 KB) - see [http://aegidian.org/bb/viewtopic.php?p=264969#p264969 explanation]
  +
  +
===Tools===
  +
  +
There are two tools tucked away in diverse locations:
  +
  +
* [https://app.box.com/s/pwttg9nrqvvpqzya0wcpqpc4ly9bov1r Lib_MatFinder 1.1] (oxz, 39.7 KB) - A developer-tool to work out materials entries.
  +
:See [http://aegidian.org/bb/viewtopic.php?p=265566#p265566 here] for description ''re'' shaders ''etc''. (2 pages, 2018).
  +
  +
::On your F4 screen (if you have Library running too) under "Developer":
  +
[[File:Lib MatFinder Pos01.png|150px]]
  +
[[File:Lib MatFinder Pos02.png|150px]]
  +
[[File:Lib MatFinder.png|150px]]
  +
  +
  +
  +
* [https://app.box.net/s/h78y01lg9b Library_devtools.oxp] (look in Test OXP's) - Something peculiar
  +
  +
::On starting a game (if you have Library running too):
  +
[[File:Library_devtools_switches.png|150px]]
  +
[[File:Library_devtools.png|150px]]
  +
[[File:Library_devtools.values.png|150px]]
  +
  +
::On your F4 screen (if you have Library running too) under "Lib_MatEditor":
  +
[[File:Lib_MatEditor_%281%29.png|150px]]
  +
[[File:Lib_MatEditor_%282%29.png|150px]]
  +
  +
[[File:Keeper's Library images pack.png|thumb|right|450px|Keeper's alternative images]]
  +
  +
===Alternatives===
  +
[[Keeper]] produced his own set of tailored images & sounds for Library.
  +
  +
"The screens have a bit of the "legend" icons showing the relative order of government and economy types, as well as a function key menu with English labels (the old menu from the previous BGS set but with text added by myself -- now blended over the new backgrounds nicely). Here's a 16:10 screenshot: http://www.keeper1st.com/Oolite/bgsexample.png
  +
  +
For the sounds, I replaced the "Item Sold" and "Item Bort" (?!) with nice little chimes (can't remember where they came from -- original Oolite?), changed things like "Ortopilot activated" into "Autopilot activated", trimmed some dead air (e.g. so instead of "missile......armed" it's "missile armed"), removed all instances of Majel Barrett from Star Trek (nothing against the late Ms Barrett or Star Trek; I just think the second voice is unnecessary), and greatly changed the extremely long and drawn-out game-over sound into a rather rapid explosion then sudden expulsion of air into silence, which is rather more shocking and realistic."
  +
  +
*http://www.keeper1st.com/Oolite/bgs2changedimages.zip
  +
*http://www.keeper1st.com/Oolite/bgs-editedsounds.zip
   
  +
=== Tweaks ===
  +
*[http://aegidian.org/bb/viewtopic.php?p=252499#p252499 To add a radio channel]
   
 
==Quick Facts==
  
==Quick Facts==
 
{{OXPLevel|0}}{{IconOXP
  
{{OXPLevel|0}}{{IconOXP
−
|ooVersion = "1.84"
 +
|ooVersion = "1.88"
 
|oxpCPU = "Medium"
  
|oxpCPU = "Medium"
 
|oxpMEM = "Average"
  
|oxpMEM = "Average"
Line 43: Line 76:
 
{{Infobox OXPb| title = Library
  
{{Infobox OXPb| title = Library
 
|image = [[Image:IconLib.png|100px]]
  
|image = [[Image:IconLib.png|100px]]
−
|version = 1.0
 +
|version = 1.7.1
−
|release = 2016-08-14
 +
|release = 2018-11-19
 
|license = CC-by-nc-sa-4.0
  
|license = CC-by-nc-sa-4.0
 
|features = Helper for OXPs
  
|features = Helper for OXPs
 
|category = Misc OXPs
  
|category = Misc OXPs
−
|author = Svengali
 +
|author = BlackWolf & Svengali
 
|download = [[#Download|See Download]]
  
|download = [[#Download|See Download]]
 
|feedback = [http://aegidian.org/bb/viewtopic.php?f=4&t=18248 BB-Link]
  
|feedback = [http://aegidian.org/bb/viewtopic.php?f=4&t=18248 BB-Link]

Latest revision as of 19:42, 18 January 2022

This page is about the OXP helper expansion pack, Library, for other uses, see Library (disambiguation).

IconLib.png
Animator
PAD: GalCop
PAD: Persons
PAD: Player data
Starmap

Overview

Reinventing the wheel is not everybody's taste, so here comes a collection of useful snippets and helpers. Its main purpose is to simplify or unify some common tasks used by OXPers. Library is the successor to CCL, Hyperradio and OXPConfig. The library does not alter any native JS objects (like Array or String) to avoid clashes and does not clutter the global namespace.

This oxp also adds the following items to the F4 ship-station interface page

  • Config for AddOns (AddOns category) - for tweaking OXPs
  • PAD (Captain's Log category) - a personal assistance device with details of naval career, people met, etc.

The P.A.D. (or Personal Assistance Device) ships functionality to display different sorts of data, sorted by categories. Every category may contain several pages (or subcategories) - which can also be implemented by AddOns. What I do have right now are categories for

GALCOP: A standard entry, but after doing specific jobs it will contain an entry for the Navy as well. Other AddOns may add more.
GUILDS: An empty entry at the moment. Could be used e.g. by RandomHits, Feudal States and other AddOns which do have a membership.
INFOS: A category for special events, news, etc. Could be useful e.g. for BloombergMarkets, etc.
LOGBOOK: A category for standard events like rescued escape pods, bailed out, fined, etc. Could be used for contracts as well.
PERSONS: A category for characters you have met.
SYSTEMS: A category for special systems like Tianve, Tionisla, etc.
SEARCH
PLAYER DATA

The PAD also ships with search functionality and some categories do allow the player to add custom notes. The display of these pages is based on templates, so all pages in a category will have the same layout. AddOns can add data easily to existing pages or add a new page in existing categories. Another feature is to set player specific data, like origin, species, gender, age and a custom picture.

Note: there are several oxp's that allow for configuring other oxp's:

  • Library (the most recent, done via the F4 page when docked) by Svengali
  • OXPConfig (done via the F2 page - press F7 when told to) by Svengali
  • Station Options by cag: this one is comprehensible, but alas, only a beta version (2018)

Features

For Documentation just follow the links.

  • Lib_2DCollision.js - Methods for checking if point is in bounding-box, on line or in poly.
  • Lib_Animator.js - Tool to create animations on missionscreens (see Demos).
  • Lib_BinSearch.js - Instantiated search tree.
  • Lib_Config.js - Configuration interface for AddOns.
  • Lib_Crypt.js - De-/Encryption for strings.
  • Lib_GUI.js - Unified GUI image, sound and music handling.
  • Lib_Main.js - Generic functions for various tasks.
  • Lib_Music.js - Unified event driven and generic music handling (see Demos).
  • Lib_PAD.js - Unified logbook, mission-log, diary and interface. Added in v1.7
  • Lib_Starmap.js - In-System-Maps in 3D (docked and inflight) (see Demos). Added in v1.7

ID

identifier = "oolite.oxp.Svengali.Library";

Requirements

  • Latest version needs Oolite v1.88.

Download

Install like any other OXP.

Music

Music for playing the game to (these three need Library to function):

Demos

Install like any other OXP.

Tools

There are two tools tucked away in diverse locations:

See here for description re shaders etc. (2 pages, 2018).
On your F4 screen (if you have Library running too) under "Developer":

Lib MatFinder Pos01.png Lib MatFinder Pos02.png Lib MatFinder.png


On starting a game (if you have Library running too):

Library devtools switches.png Library devtools.png Library devtools.values.png

On your F4 screen (if you have Library running too) under "Lib_MatEditor":

Lib MatEditor (1).png Lib MatEditor (2).png

Keeper's alternative images

Alternatives

Keeper produced his own set of tailored images & sounds for Library.

"The screens have a bit of the "legend" icons showing the relative order of government and economy types, as well as a function key menu with English labels (the old menu from the previous BGS set but with text added by myself -- now blended over the new backgrounds nicely). Here's a 16:10 screenshot: http://www.keeper1st.com/Oolite/bgsexample.png

For the sounds, I replaced the "Item Sold" and "Item Bort" (?!) with nice little chimes (can't remember where they came from -- original Oolite?), changed things like "Ortopilot activated" into "Autopilot activated", trimmed some dead air (e.g. so instead of "missile......armed" it's "missile armed"), removed all instances of Majel Barrett from Star Trek (nothing against the late Ms Barrett or Star Trek; I just think the second voice is unnecessary), and greatly changed the extremely long and drawn-out game-over sound into a rather rapid explosion then sudden expulsion of air into silence, which is rather more shocking and realistic."

Tweaks

Quick Facts

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

Minimum Oolite versionCPU usage mediumMemory usage averageGPU usage averageisParentisAPIisDocumentedisConfigurable

Version Released License Features Category Author(s) Feedback
1.7.1 2018-11-19 CC-by-nc-sa-4.0 Helper for OXPs Misc OXPs BlackWolf & Svengali BB-Link
Retrieved from "http://backup.witchspacewiki.org/index.php?title=Library.OXP&oldid=71953"