Cabal Common Library OXP

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.

Keyboard

Briefing

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:

Category:OXPDoc

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.