Difference between revisions of "Cabal Common Library OXP"
From Elite Wiki
m |
(Updating BB links) |
||
| (40 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | [[Image:CCL_logo.png|150px|right]] | |
| − | + | ==Overview== | |
| − | + | {{OXPNote|This AddOn is deprecated. Please use [[Library OXP|Library]] for new AddOns. It is still needed by the older version of BGS (the one with the glorious spiderweb effect for witchspace tunnels).}} | |
| − | + | Reinventing the wheel is not everybody's taste, so here comes a collection of useful snippets and helpers. | |
| − | + | ||
| − | + | Its main purpose is to simplify some common tasks used by OXPers and also includes a few unique features. It contains functions to check requirements, helper functions for arrays, strings, numbers and vectors, an encrypt/decrypt algorithm, and, last but not least, functions for missionscreen models, an onscreen keyboard, a comms channel, special market deals, a event driven script for music, a system description based script to coordinate OXPs actions and a tool to check the player ship and NPCs. Over time it will grow and include more functions and features. The library does not alter any native JS objects (like Array or String) in its current form to avoid clashes. | |
| − | | | ||
| − | |||
| − | |||
| − | |||
| − | }} | ||
| − | |||
| − | Reinventing the wheel is not | ||
| − | + | * [[:Category:Required_OXP-Cabal_Common_Library|List of OXPs]] which need Cabal_Common_Library - currently {{PAGESINCATEGORY:Required_OXP-Cabal_Common_Library}}. | |
| − | + | ---- | |
| + | [[File:CCL_Keyboard01.jpg|thumb|right|320px|Keyboard]] | ||
| + | [[File:CCL Briefing01.jpg|thumb|right|320px|Briefing]] | ||
| − | + | ==Features== | |
| − | + | The current internal version is {{CCL_Int}}. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | * [[Cabal_Common_Library_Doc_2DCollision|Cabal_Common_2DCollision]], 2D checks | |
| − | + | * [[Cabal_Common_Library_Doc_BinSearch|Cabal_Common_BinSearch]], binary search tree | |
| − | + | * [[Cabal_Common_Library_Doc_Briefing|Cabal_Common_Briefing]], enhance mission screens | |
| − | + | * [[Cabal_Common_Library_Doc_Comms|Cabal_Common_Comms]], inflight communication | |
| + | * [[Cabal_Common_Library_Doc_Functions|Cabal_Common_Functions]], generic function library | ||
| + | * [[Cabal_Common_Library_Doc_Keyboard|Cabal_Common_Keyboard]], user input | ||
| + | * [[Cabal_Common_Library_Doc_MissionHandling|Cabal_Common_MissionHandling]], start OXPs based on system descriptions | ||
| + | * [[Cabal_Common_Library_Doc_Music|Cabal_Common_Music]], inflight event driven music | ||
| + | * [[Cabal_Common_Library_Doc_Overlay|Cabal_Common_Overlay]], inflight overlays | ||
| + | * [[Cabal_Common_Library_Doc_PhraseGen|Cabal_Common_PhraseGen]], generator (v1.8) | ||
| + | * [[Cabal_Common_Library_Doc_SpecialMarkets|Cabal_Common_SpecialMarkets]], trading special goods | ||
| + | * [[Cabal_Common_Library_Doc_OXPStrength|Cabal_Common_Strength]], environment control | ||
| + | ---- | ||
| + | ==Credits== | ||
| + | Written by [[User:Svengali|Svengali]] | ||
With contributions from: | With contributions from: | ||
* Michael Werle (documentation), | * Michael Werle (documentation), | ||
| Line 35: | Line 36: | ||
* Commander McLane (strDateFromMinutes), | * Commander McLane (strDateFromMinutes), | ||
* Eric Walch (mapCoordsDirection), | * Eric Walch (mapCoordsDirection), | ||
| + | * Thargoid (strAddAlignedText, strAddEdgeText, strAddIndentedText, strAdd2Columns and strAdd3Columns) | ||
* Terry Yuen (en/decryption), | * Terry Yuen (en/decryption), | ||
* Dr.J R Stockton (rand, randSpan, msbPos, baseChange, strLZ, strLZZ, arrShuffle), | * Dr.J R Stockton (rand, randSpan, msbPos, baseChange, strLZ, strLZZ, arrShuffle), | ||
* Nicholas Zakas (Cabal_Common_BinSearch is based on his ideas) | * Nicholas Zakas (Cabal_Common_BinSearch is based on his ideas) | ||
| + | * Paul Bourke (pointOnLineB) | ||
| + | ---- | ||
| + | ==Requirements== | ||
| + | * Latest version needs Oolite v1.77. | ||
| + | {{OXPNote|This AddOn clashes with [[Library OXP|Library]], suppressing some of the effects of other .oxp's which modify the F2-F8 pages}} | ||
| − | + | ---- | |
| − | |||
| − | + | ==Download== | |
| − | {{ | + | * [[Media:CabalLibray-1.7.2.oxz|1.7.2 in OXZ format]] for Oolite 1.79 or later (downloaded {{#downloads:CabalLibrary-1.7.2.oxz}} times). Equivalent with 1.7 but loads a second faster! |
| − | * [http:// | + | * [http://deephorizonindustries.com/Downloads/Cabal_Common_Library1.7.zip Cabal_Common_Library1.7.zip] - (1.3 MB) |
| + | <!-- | ||
| + | * Mirror -> [https://www.dropbox.com/s/12cu2q1sm7qnu26/Cabal_Common_Library1.7.zip Cabal_Common_Library1.7.zip] - (1.3 MB) | ||
| + | * Mirror -> [https://app.box.com/s/r9faj1kmstzapou14c6z Cabal_Common_Library1.7.zip] (1.3 MB) | ||
| + | --> | ||
| + | For Oolite v1.76.1: | ||
| + | * [http://deephorizonindustries.com/Downloads/Cabal_Common_Library1.6.zip Cabal_Common_Library1.6.zip] - (1 MB) | ||
| + | <!-- | ||
| + | * Mirror -> [https://www.box.com/shared/lx7uf825e1 Cabal_Common_Library1.6.zip] - (1 MB) | ||
| + | --> | ||
| + | |||
| + | ---- | ||
| + | == Links == | ||
Documentation for OXP Developers: | Documentation for OXP Developers: | ||
* [[:Category:OXPDoc]] | * [[:Category:OXPDoc]] | ||
| − | + | Demos: | |
| − | * [ | + | * [[Cutscene]] |
| + | * [https://www.box.com/shared/v6ldutgl3l CCL_Briefing_Demo1.6.zip] - (333 KB) | ||
| + | * [https://www.box.com/s/7e73ac33970bbd2df847 CCL_Music_Demo1.5.2.zip] - (5.4 MB) | ||
| + | * [[Vector OXP]] is the only known mission OXP which uses CCL to any extent, although some elements probably support some of the Vanilla-game [[Oolite Missions|missions]] and the [[Galactic Navy OXP]]. | ||
---- | ---- | ||
| + | ==Quick Facts== | ||
| + | {{OXPLevel|0}}{{IconOXP | ||
| + | |ooVersion = "1.77" | ||
| + | |oxpCPU = "High" | ||
| + | |oxpMEM = "Average" | ||
| + | |oxpGPU = "Average" | ||
| + | |oxpIsParent = true | ||
| + | |oxpIsChild = | ||
| + | |oxpIsAPI = true | ||
| + | |oxpIsDocumented = true | ||
| + | |oxpIsConfigurable = true | ||
| + | }} | ||
| + | {{Infobox OXPb| title = Cabal_Common_Library | ||
| + | |image = [[Image:CCL_logo.png|150px]] | ||
| + | |version = 1.7.2 | ||
| + | |release = 2020-06-18 | ||
| + | |license = CC-by | ||
| + | |features = Helper for OXPs | ||
| + | |category = Misc OXPs | ||
| + | |author = Cmd.Cheyd, PhantorGorth, Svengali | ||
| + | |download = [[#Download|See Download]] | ||
| + | |feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=8839 BB-Link] | ||
| + | }} | ||
| + | |||
| + | {{Required OXP|Cabal Common Library}} | ||
| − | + | [[Category:Oolite utilities]] | |
| + | [[Category:Deprecated OXPs]] | ||
Latest revision as of 01:22, 29 February 2024
Overview
Please note: This AddOn is deprecated. Please use Library for new AddOns. It is still needed by the older version of BGS (the one with the glorious spiderweb effect for witchspace tunnels)..
Reinventing the wheel is not everybody's taste, so here comes a collection of useful snippets and helpers.
Its main purpose is to simplify some common tasks used by OXPers and also includes a few unique features. It contains functions to check requirements, helper functions for arrays, strings, numbers and vectors, an encrypt/decrypt algorithm, and, last but not least, functions for missionscreen models, an onscreen keyboard, a comms channel, special market deals, a event driven script for music, a system description based script to coordinate OXPs actions and a tool to check the player ship and NPCs. Over time it will grow and include more functions and features. The library does not alter any native JS objects (like Array or String) in its current form to avoid clashes.
- List of OXPs which need Cabal_Common_Library - currently 10.
Features
The current internal version is 15.
- Cabal_Common_2DCollision, 2D checks
- Cabal_Common_BinSearch, binary search tree
- Cabal_Common_Briefing, enhance mission screens
- Cabal_Common_Comms, inflight communication
- Cabal_Common_Functions, generic function library
- Cabal_Common_Keyboard, user input
- Cabal_Common_MissionHandling, start OXPs based on system descriptions
- Cabal_Common_Music, inflight event driven music
- Cabal_Common_Overlay, inflight overlays
- Cabal_Common_PhraseGen, generator (v1.8)
- Cabal_Common_SpecialMarkets, trading special goods
- Cabal_Common_Strength, environment control
Credits
Written by Svengali With contributions from:
- Michael Werle (documentation),
- Ahruman (pseudoRand),
- Commander McLane (strDateFromMinutes),
- Eric Walch (mapCoordsDirection),
- Thargoid (strAddAlignedText, strAddEdgeText, strAddIndentedText, strAdd2Columns and strAdd3Columns)
- Terry Yuen (en/decryption),
- Dr.J R Stockton (rand, randSpan, msbPos, baseChange, strLZ, strLZZ, arrShuffle),
- Nicholas Zakas (Cabal_Common_BinSearch is based on his ideas)
- Paul Bourke (pointOnLineB)
Requirements
- Latest version needs Oolite v1.77.
Please note: This AddOn clashes with Library, suppressing some of the effects of other .oxp's which modify the F2-F8 pages.
Download
- 1.7.2 in OXZ format for Oolite 1.79 or later (downloaded unknown times). Equivalent with 1.7 but loads a second faster!
- Cabal_Common_Library1.7.zip - (1.3 MB)
For Oolite v1.76.1:
- Cabal_Common_Library1.6.zip - (1 MB)
Links
Documentation for OXP Developers:
Demos:
- Cutscene
- CCL_Briefing_Demo1.6.zip - (333 KB)
- CCL_Music_Demo1.5.2.zip - (5.4 MB)
- Vector OXP is the only known mission OXP which uses CCL to any extent, although some elements probably support some of the Vanilla-game missions and the Galactic Navy OXP.
Quick Facts
| 0 |
| Version | Released | License | Features | Category | Author(s) | Feedback |
|---|---|---|---|---|---|---|
| 1.7.2 | 2020-06-18 | CC-by | Helper for OXPs | Misc OXPs | Cmd.Cheyd, PhantorGorth, Svengali | BB-Link |
