Elite Wiki - User contributions [en]

Elite Trader OXZ

2026-05-12T12:39:04Z

Phkb: /* Download */

[[File:ETLaveGeckManifest-1.jpg|thumb|right|550px|Here you are at Lave, a Grocer (Grade 0) - destination: Zaonce, with furs. Your ship, this time, is a [[FE Ships OXZ|Gecko]].]]

== Welcome to the Guild! ==
[[Image:Griff_krait.jpg|thumb|right|200px|[[FE Ships OXZ|The Krait]] is an excellent little craft - shockingly expandable with [[Goods Container OXZ|4 Containers]] - to initiate your advance in Grade. Buying one nets you nearly 40,000 cr for essential upgrades.]]
<blockquote>
''Esteemed Commander,''

''The Galactic Guild of Elite Traders (G.E.T.) has studiously considered your application and is pleased to inform you of your admittance to our Order. We maintain Guild Houses in all systems of the Eight Charts, and you can be assured of a hearty welcome wherever your voyages now take you.''

''May the '''GET'''TING exceed the Taking! - Eschew murder and assume our gentle mantle, and reward will be equally forthcoming.''

''Yours most Truly,''

''Grand Master Exoloön of Inera.''
</blockquote>

Brother Guilder,

The storied intergalactic [[Elite Rating|'''Elite ranking''']] is attainable for ship Captains of ''every'' disposition, peaceful or warlike. Engage anti-masslock systems on Station approach and watch your Grade soar as you dock with our Markets, trade skillfully, and doggedly ply the celestial Milk Run.

Note well that Station Guild Masters do not countenance the recondite practices of many of today's free traders. We are traditionalists. Contracts are frowned upon, as is opportunistic scooping and the sale of mined minerals and the dealing in precious stones and metals. Though a Brother is never penalized for supplementing his private income in this manner, your Assessors will not credit you for such sales. We'll meet you on the Market floor or nowhere else. As one of our crasser pooker-playing Brothers once coined: if it ain't paid, the score's not made. We're about buying and selling.

You may note with a sardonic smile that G.E.T. cares little whether Galcop deems your bought goods illegal... We have small truck with that legislative body but our stance is one of mutual tolerance. In brief, their police do not see us. Your record is always clean, and '''all trades legitimate''' in our eyes.

Trade well! One day we'll meet for a toast in the Halls of Inera with the Exalted.

Your friend and mentor,

[[User:Reval|'''Dor Reval of Xexedi''']], Supreme, Serendipitous & Serene Space Grocer, Master Trader (Grade 3).

----

[[File:CargoWreckBarrels.png|right|550px]]

== The Galactic Guild of Elite Traders (GET) ==

From [[Other fictitious magazines#SPACE|'''SPACE''']] magazine's '''THE GUILD - THE HIDDEN FACTS''':

The strict and solemn vows of secrecy to which all Guild members adhere mean that rumours concerning their domination of various Corporate worlds, GalCop, and not a few seedier systems, abound in increasing number. '''Real facts''' are in short supply: But we have a few...

An incoherently inebriated Guild-member, Cholmondeley the Craven, told me that there are '''Seven Strictures''' which all but the most senior Guild ''fratres'' are sworn to the death to follow:

* 1) Brother! Keep double-entry ledgers using Darthavian Ixian-mode programming systems
* 2) Brother! Sign all entries with a Quoquivian quill using violet-tinged ink
* 3) Brother! Never fire missiles wantonly at miscreants
* 4) Brother! Use lasers only for defence: to warn off, not to kill
* 5) Brother! Should thou by chance kill a miscreant, slit thine own throat with an envenomed obsidian knife
* 6) Brother! Worship of [[Slang|Randomius Factoria]] must involve meaningful sacrifice
* 7) Brother! Obey without question every command of your Guild Superiors

<blockquote>This compares with the Partial List of Commandments as divulged by renegade Guild heavyweight Contratius Phlebor:

* Thou shalt keep double-entry ledgers using the Ixian programmes
* Thou shalt sign all entries with a sharpened quill loaded with purple ink
* Thou shalt only fire lasers in defence
* Obey your betters completely</blockquote>

The death of the senior Guild member Karachick Obolomov in a pirate raid some seven years ago in Galaxy 3 yielded the following '''list of membership grades''', badly smudged and singed, on a print-out in the wreckage of his personal cabin:

*"Apprentice",
*"Trader",
*"Traveller",
*"Perfected Master",
*"Master of Brass and Bronze",
*"Judge",
*"Warden of the Orbital",
*"Master of the Guild",
*"Master Elect",
*"Lord of Mercy",
*"Master of the Seventh Gate,
*"Grand Master",
*"Knight of the East",
*"Prince of I… ''At this point the print-out was torn.''

The ''Wardens of the Orbital'' would seem to be Masters of system Guild Houses (except in Corporate States, where a more senior figure has that position) and ''Mastery of the Seventh Gate'' is rumoured to involve the sacrifice of three Lobstoids of different genders (ejected from the Seventh Gate of Guild-controlled orbital stations), whilst the ''Grand Masters'' lord it over their separate Galactic Sectors, or Charts.

According to Tea Mereso, G.E.T. apostate Contratius Phlebor said that a Guild splinter group - which he supports - styling themselves '''Galactic Overlords''', have the sector police in their pockets.

Rumours continue to proliferate that senior Police officials are in cahoots with the Guild (or its splinter group), hence the complete lack of court cases with Guild members as defendants (except in the system of [[Sector1/Teorge|Teorge]], where the local clones have wrested back control from the Guild and their flunkies).

Phlebor claims that the better [[Slang|Quarksmen]] are now Guild flunkies (hence the superior performance of their ships) and that they have also seduced the Supreme and Appellate Court Justices as well as most of the media (but '''not''' SPACE magazine).

It is muttered over Anlian gin in the seedier space-bars that the '''Guild Princes''' have signed a secret contract with the Thargoids where they back down when Guild ships are present. This involves the capture of ordinary GalCop citizens, their enslavement and their sale to interstellar insectoid forces.

''Adalbert the Argument, SPACE intra-system editor-in-chief.''

== Confessions of a Guild Quisling ==
Contratius Phlebor of the Gerete systems, notorious and much-sought bounty hunter, once of elevated Grade in the Guild but now its bane, has let it be known that to the highest Grades is entrusted a secret of Galactic import. Phlebor implies that it takes the form of an object or tool, with a source of infinite energy.

To this secret, he has stated, is owed the G.E.T.'s power, wealth, technical prowess, and present ascendancy throughout the Eight Charts. Phlebor has spoken gnomically of a 'Ninth Arch' (or Ark), upon which he refuses to elaborate.
[[Image:Griff_asp_mk2.jpg|thumb|right|200px|[[FE Ships OXZ|The Asp II]] - Phlebor's still-deadly interdictor, he tells me. Capable and capacious too, some have called it 'The Explorer'. I learned later that this trader's chariot is also [[User:Reval|'Grocer' Dor's]] first and only(?) love.]]
"What is nearly certain is that the Guild traces a lineage back through myth to the Templar Order of the fabled Terra. It is recorded in their ''scriptoria''," he hints, "that Templars once held sway on that near-forgotten planet, over its rulers and would-be hegemonites, in similar fashion to G.E.T. over Galcop and the Lawless Worlds. It is, they say, both Trust and Continuum."

Contratius is widely ridiculed (by those who dare, including the Guild itself) for these and further claims...

The now ageing whistleblower of scarred and burned visage offered quite freely to this reporter that 'the Brothers' pay homage to a forgotten deity whose prime directive was: Do not kill.

"Terra again," he comments, "A philosophy I came to find I couldn't quite square myself with. The money was nice, though. And their miraculous ship upgrades, some of which my old Asp still has. Got away with a few of those still in place, though most 'bad Brothers' are stripped of everything. The true Brothers really won't kill, you know - won't press the trigger for that final burst. Some are galactic Elite rated too..."

Persisting respect for his erstwhile masters written in his remaining eye, Contratius cut short our chat with the words: "I'd never betray them full-out. And they leave me alone."

No Guild representative could be reached, or located, for comment. They seem to have no PR.

Seeking expertise, I found confirmation of one of Phlebor's claims. Hild Fenwith of Xexe University:

"Mythohistorians would not deny that such proto-chivalric Orders, blooming out of monasticism in ancient epochs, owning their own fleets, fortresses, and preceptories, did indeed count trading and banking among their keys to power, holding money and their arcane treasures over the heads of kings and Pontifs like edged weapons."

Identically so with the G.E.T. today, Phlebor contends.

On shaking hands and parting, Hild urged me to remember what befell the Templars. I leave that as a research project for my tuners...

Mild-mannered keepers of lost secrets, with an edge hard as military lasers. ''And they're everywhere'', my sometimes reticent source told me.

Is the Galaxy the better for the Guild?

You tell me.

'''--Tea Mereso, Xexedi Enquirer'''.

== On the Lane with a Master Traveller ==
''' and Tea Mereso, ''Xexedi Enquirer'' '''

Fens Buber's holds are seldom empty.

Except, as of this hauler's break of less than an hour, between the unloading of stack upon stack of odorous pods stuffed with Laeninian Erebear pelts and a supplement of their prized (at least on Lerelace) Mauve Gentian ''Cassis'' and the piling in of tech.
[[Image:Griff_NoShaders_Cobra3.png|thumb|right|200px|A massively stalwart ride, favoured by Master Traveller Fens Buber, the [[FE Ships OXZ|Cobra III FE]] carried him to where he is now - ascending the Grade ladder by leaps and bounds, not at all hindered by his vessel's expanded [[Goods Container OXZ|150-ton capacity]].]]
His (her? their? - for Fens, gender-states are bi-volitional) return load will be pristine hyperdrives. We are for a lightning stop-and-dock at the G.E.T.'s Octahedron, geostationary over Lerelace Prime - whose russet seas and impossible peaks have fast become a conundrum to a little-travelled Xexedian. (What must their sky be like? she wonders, querulous and witch-sick - for, yea, it is your faithful correspondent.)

Perhaps this snub by the Guild Master of the establishment, who after nary a blink my way followed up with fulsome usherings-in of Master Traveller Fens to an inner sanctum, is to be forgiven. It is coldly apparent rather quickly that my last piece has not gone unremarked by Brotherhood nabobs.

Apparently, we are being shown now what the Guild ''really'' does: and for a tour-guide one of my own (who by their frequent pulsations might even like to wed me). You're getting this only here, exclusive, with the Enquirer.

Fens Buber emerges, seemingly refreshed, out into dock, across whose cavernous spaces they proceed to skip and float, while three Guild mechanics (technicians) bustle mysteriously about the craft's hull, wielding... what exactly? Fens arrives, touches a limb to one of mine, says, "We fly faster now, just a touch."

"And you're just", I press opportunely, "teamsters. With nothing up the ceremonial sleeve?"

"Grocers. Spacehaulers. Buyers and sellers. Travellers in goods. Pick your term."

"OK," I fire back so as not to lose the impetus, "I pick very ''odd'' traders with an impossibly long - like ancient Terran - pedigree." At which Fens throws some glances at the Lerelacean leopardine attendants (now slinking away), plus several more, disquietingly, at me. "You really met that... arsehole Phlebor?"

We are forced to concede that we did, yes, confer in holopersons with Contratius Phlebor.

"And you know ''they'' fobbed me onto you, as being of my kind, to feed you the down-and-dirty on his fabrications... his fantasies."

"I thought we met by chance in the bar."

Sent a triple wink, I allow that it seems ''they'' did, adding, "But wasn't he a much higher Grade than you, Fens? Can you be certain he is fantasizing? Are you not taught more of the Guild's inner workings the further up you rise?"

Fens offers me endearing shrugs and we push through the Mark Three's drive-packed aisles into cabin-space. "Time to be off. Witch it to Laenin, and then it's home again for pretty old yous," they simper, they try to make light. But your correspondent is not to be sidetracked.

We launch and, something unusual, Fens engages J-drive immediately. Not a masslock siren to be heard nor a Viper in sight - they are left behind with the perplexing vermilion of Lerelace receding on rear viewscreens. I forbear to ask if this is an unconventional exit, well aware that it is. Instead, I say, "Tell us about your first run as a GETter, a Guilder..."

"Glad to, Tea - after witch. Brace and breathe - remember how you forgot to last time?" Tuners-in, I can tell you that was a bodily event your reporter will not soon forget.

We burst, silent and sober, into Laenina's gravity-well, all my questions and purposes whirling in the purple void our wake makes. What is the Guild doing with these ships?

"Grocer, in the before-time, Grade zero, probationer, acolyte, what you will. Made the run in this Cob--"

"''Flare of Xexe'' (for our tuners). Nice name."

"The same. Unmodified then: drove the long-haul through Lave, Zaonce, Isinor, Qutiri, Aronar, Beusrior, Uscela, trading on route. Spaceway One. Those days were hard, before the Guild's perks kicked in, before rich milk began squirting from the Xexedi-Laenin-Lerelace teat. The three-skip we're doing now, Tea."

"And what a treat it's turning out to be."

"Hmm. Reaching this cluster for the first time, Qutirians had already fitted a Large Cargo Bay, and we were at 70 tons. Now she's 110 with four Goods Containers instead of missiles. But before any of that, before the Guild took note of us, hot hull every run, you know, shields gone, goods spoiled, locked and harried and menaced at the witchpoint by the likes of..."

"Contratius?" I prompt.
[[Image:Griff_mamba.jpg|thumb|right|200px|[[FE Ships OXZ|Mamba]] - a little thing; a pesky insect. But we shudder when we call the word to mind. Yes, tuners, even now.]]
"His ilk. Miscreants - they who take life and living away without a thought. Like these here..." Fens flutters some digitals over five convergent red dots on our scanner. "Mambas. See, we're targetted, missiles about to fly."

"Do something!" your intrepid journo hears herselves squeak.

"No, listen - " Unruffled, Buber is shoving a comms plug into one of my auriculars. He - for I'm sure it is that for the moment - mimes comically along with the raspy Galspeak synth-voc: ''"Forty barrels and we let you live, Xexedian pond-scum. Ten pulses and missiles away. Drop 'em!"''

"He means our auxiliary containers."

Buber is in paroxysms as I screech. "Just do what the... what are they?"

Species-incompatible, he soothes, patting a flailing limb I seem to have no control over. "Does not bode well slavery-wise, if they scoop us after."

"After...?"

"After they melt us." Fens giggles.

"Dump the cargo," I implore. (But you hear all this, gentle tuner; you are with us... goodbye from your...)

''"Time's up frogoids. Eat quirium."''

Klaxons wail.

"Ahh, indeed it is, such a shame to leave the panto..." He drops a digit onto a blue button and scanners suddenly empty, are black. He doesn't need to say we are in J again, flitting toward rosy crescent Laenin to offload hardware at hefty profit and take on more furs and mauve Cassis for Xexedi - for we crave the sweet beverage now and could down a quart and sleep the sleep of...

"Nothing locks us you see, this is what the Guild does for me, and I'm happy to pay my dues."

We pass the Laenin loading hour in silence, Buber turned a little sullen. We depart for home, and matters from there are swift.

"You're Grade Four, a Master Traveller, Fens - you can leave the milk and skim off the cream. Our tuners have watched you. Back to Contratius a moment - he was a long way up the ladder you're climbing when he went bad."

Buber's skin-hues begin a rapid cycle, alerting me at last to his inner state.

"I know what you want from me. We all know what you want: Phlebor was a Knight - of the Rosy Star, I believe. 18th Grade - a level most scarcely see themselves reaching. They say he was a paragon, until whatever happened happened to him. I'm authorised to say this: he still knows little. And we're very happy about that. Til we meet again, ''Sor'' Mereso."

Nonplussed, we take leave of ''Fra'' Buber with more questions than we started out with.

Relieved but unsatisfied, I'm able to say I've been co-opted as unofficial spokesperson for the Guild of Elite Traders. Alive and speaking to you from the Virgin Torus spacedock, G.E.T. aegis, this is Tea Mereso of the Xexedi Enquirer, at Xexedi, signing off until next time.

== Overview: The Fat and the Skinny ==

[[File:ET-Guild-Lodge-Docking-1.jpg|thumb|right|500px|What is this mysterious stellate pyramid? - Whatever it is, it has a docking port... Could this be the fabled Ninth Gate hinted at by Contratius? Tuners, you tell me.]]
On a subsequent meeting, Fens agreed, with Grand Master Exoloön's indulgence, to allay all "[[Elite Trader OXZ#The_Galactic_Guild_of_Elite_Traders_(GET)|'''grossly inflated rumour''']]" by allowing me to set down in succinct terms what the Guild offers its lower-echelon inductees.

So to lay it out in plain Common Galspeak... The accomplished and non-belligerent G.E.T. Brother will witness various astrogational marvels in respect to his, her, its, or their spacecraft, to wit:

A continual upward evolution in

* [[Elite Rating|Elite ranking]]

* Speed
* Shield strength
* Shield recharge rate
* Energy recharge rate
* Energy levels

In addition to

* A ship forever in good repair
* Free fuelling (at the witchpoint too for good Brothers above the 3 Apprentice grades)
* Free fast-dock facilities at every station
* A permanently 'clean' Galcop record - the Guild refuses to divulge how they swing this but it's clear that in the face of all G.E.T. infractions, Galcop authorities just look the other way.
* A Trade Advisory, messaged from the system's Guild orbital to the witchpoint (to all initiates beyond probationary Grades)...
* An inscrutable device to counter Mass-lock, programmed to work on all objects except a Main Station. ''Weapons must be offline'' before hyperspace countdown, warns Fens, otherwise conventional mass-lock pertains. (he tells me that, due to a ballooning volume in Guild applications - of precipitating which he accuses yours truly - the devices are now reserved for Grade 1 Apprentices and upward).
* G.E.T. - in all its beneficence (I can scarcely believe I'm saying this, tuners) - will pay to every Guilder except Grocers a regular and periodic Bonus. Guild bonuses are in gratitude, says Fens, for "service, devotion, and fortitude." When asked to elaborate, he would only say, "Our Bonuses are time-, Grade-, and performance-dependant." From which I surmise, the higher you are in Grade and the more credits you have banked, the larger will be your Bonus when it comes. But, tuners, don't quote me!

''Unless'' the Brother strays - in which event none of the above apply, and he is, as Phlebor pithily put it, "stripped of everything".

The Guild's '''single''' Rule: '''Do not kill'''.

If there are any other commandments, and according to Fens Buber, none are set down in writing, those are to act as friend and support to fellow Brothers by coming to their aid, and to revere and aspire earnestly to the Elevated and Exalted Grades - that is Grades above level 14.

Divisions in what Fens calls "the ladder to the top" run as follows:

* 0 : Probationary
* 1-2 : Apprentice
* 3-14 : Master
* 15-18 : Elevated
* 19-22 : Exalted

He notes that Guild potentates of the Elevated and Exalted Grades never refer to themselves by their true (secret) Grade Titles, but simply as 'Grand Master'. Thus he - as a mere Master - is unable to tell us G.M. Exoloön's real Grade. So now we know one of their 'secrets of success' - I always wondered why the likes of Phlebor hadn't done away with the entity at the top. The Top Grades are not only Exalted, but elusive.

Guild protocols are taught - orally, ceremonially, and by example. Secrecy, an oath to which is sworn, is considered a necessity in politically volatile times and, says Buber, since conditions are invariably unstable, "generally always." (a partial exception being made, it seems, for your intrepid correspondent).

'''There are no injunctions against inflicting damage by laser''' on a miscreant's ship, even to the extreme of forcing him to abandon it. "The imperative, as ever, is to survive without killing," says Buber. "You already know how we do that."

Unstated but willingly complied with is an obligation to support the Guild financially, to ensure its continued existence and ascendancy. Buber says this is accomplished through donations - any non-Guilder would call that a 'tax' but Fens feigns outrage when I suggest it - plus gifts: the former debited from the Brother's ship-account after every profitable trade and the latter a voluntary contribution.

"Donations, above all, secure our upward progress within the Order: and gifts freely given, along with good deeds, earn special merit. Gifts always speed advancement."

"And no hidden agendas? No aspirations to Galactic domination? Trade is all there is to it?" I ask for the seventeenth time.

"Not perhaps all. But all that is important, Tea. It will have to serve."

"But you do guard certain secrets?"

Fens Buber shakes their head, shrugs, presents me a hopeless smile.

"Tea - as a lowly Traveller, I couldn't possibly comment."

''-- Tea Mereso, Xexedi Enquirer.''

== Milk or Cream? - Buber's Beats ==

Upon parting from what was to be a last encounter onstation, Fens Buber thrust into my surprised hands a paper penned in purple ink, apparently endorsed, annotated, undersigned and sealed by none other than G.M. Exoloön:

<blockquote>''Salutations from the Hidden Halls!''

''First, a word to our burgeoning cadre--and here we must acknowledge the digging of a certain persistent reporter--of Probationers (or might we more respectfully call you Neophytes?): If you are but a Grocer, remain with us - you merely have to prove to us your ingenuity. There is no reason, at this delicate stage, why you must stay in the Lane!''

''Our appointed liaison functionary will now continue:''

I, your Friend and Brother, Perfect Master & Scribe Fens Buber, offer you these notes with our exalted Grand Master's benison:

Talk in the Halls of Inera has circled around what most might aid and further an initiate's progress. The Masters' consensus was 'solid guidance'. So I here present six starter Milk Runs to low-grade commanders leaving Lave with 1000 cr.


Spaceway L1/L2, Sector One, Galaxy One

* 0. (Lave-->Zaonce-->Isinor-->)
* 1. Qutiri-->Isinor-->Ensoreus-->Ararus
* 2. Zarece-->Isence
* 3. Tiinlebi-->Anlama-->Begeabi
* 4. Xexedi-->Laenin-->Lerelace
* 5. Inera-->Sotiera
* 6. Razaar-->Zadies-->Anarlaqu-->Vetitice


Of these six remunerative runs, Zarece-->Isence is without doubt 'the cream'. But I must admit to bias - Zarece Prime has long been my adoptive home. However, my logs for these two stars usually show higher profits.

Repeat and vary at will, or make the whole tour of these 18 systems. Buy Computers (+luxuries) in Rich Industrials and Furs (+liquor-wines) in Poor Agriculturals.

By Qutiri, there'll be enough for a Large Cargo Bay, and after hitting Xexedi and plying this my own favoured triple beat, 10 or 20 ton [[Goods Container OXZ|'''Goods Containers''']] will start gracing your pylons.

(An Elite Trader--and I view all Guild membership such--taking business to our [[FE Ships OXZ|'''FE Shipyard''']] will find that the [[FE Ships OXZ|Cobra III FE]] can attain a capacity of 110 or 150 TC, depending which container tonnage was fitted).

''Detecting, with our technical aid, [[Additional_Planets|Extra Planets]], [[Stations_for_Extra_Planets|Stations for Extra Planets]], seeking a [[TorusToSun|Torus to Sun Drive]], the [[Market_Inquirer|Market Inquirer]] and [[Market_Observer|Market Observer]], will accrue to every acolyte's advantage. Picking among the several orbitals and outposts insystem, excavating lucrative deals, and maximizing profits for rapid advancement then becomes not only gratifying, but also an engaging challenge. A Quest, might we even say, for the Sacred Payout.''

"Lave with 1000 credits? How?" a Grocer might ask. Why, sell your first Cobra! Exchange it for a 'standard customer model/clone' at the lowest price you can find; then sell its laser and 'unmount all pylon weapons'. A thousand cr is now yours to load pelts and alcoholic beverages. Head straight out for Zaonce and Isinor, buying cheap and selling dear as you go.

A strategy some Grocers have adopted with success is to buy a [[FE Ships OXZ|''Krait'']]. This agile craft's capacity is 17 tons, but with over 30,000 credits to your account, you are able straight away to fit all [[Elite Trader OXZ#Essential OXPs|'''primary upgrades''']] at Lave and Zaonce, notably the [[Goods Container OXZ|20-ton Goods container]], leaving you three pylons to add more when funds permit.

Trade Well!

Blessings and clear lanes, Brothers -

Fra Fens Buber of Zarece,
''Grand Master Sigfrid Exoloön of Inera''
</blockquote>

Heavens! - another turnout for the investigative books. It's obvious they wish to be perceived in a favourable light. They want us to like them.

We progress, we prosper... So, tuners, this gives your own ''freelance'' informer an idea: we'll secure a G.E.T. loan, finance ourselves a [[FE Ships OXZ|'''Viper II FE''']] Special (this darling jumped right out of the catalogue at me), christen her "Buber's Bane", and light out on the Spaceway.

Can it really be this easy? (and innocent)

You'll be hearing.

--Tea Mereso of Lerelace, Guild Mouthpiece, late of the Xexedi Enquirer, now soror & Grocer (Grade 0)
[[Image:Griff_viper_interceptor.jpg|thumb|right|200px|Our very own [[FE Ships OXZ|Viper II FE]] - still on Special Offer... Yours truly sprinted to the FE Shipyards up at Xexedi Prime's Virgin Torus to claim this baby!]]

== Recommendations ==
[[File:Anarlaqu_Tea_Front-1.jpg|thumb|right|500px|And here we are at Anarlaqu in "Buber's Bane" after our 30th run! - Viper II and GETter HUD have done us sterling service. Tuners, we pack three 20-ton Containers... and that's our limit.]]
[[File:ManifestAnarlaquTM-1.jpg|thumb|right|500px|Oh and... our Anarlaqu Manifest, should any of you be waxing incredulous. See the byline of yours truly at the top! ... This is a new holo, after the delightful Ladiv's 'persuasion' to upgrade. (see the shot of her own F5, below).]]
[[File:TMAnarlaquGender-1.jpg|thumb|right|500px|Oops... tuners, we forgot to register our species-gender - and as of course you know, your devoted informant is bi-volitional, so we shall become a 'Sibling' of the Guild...]]
=== Auxiliary Pylon ===
[[Auxiliary Pylon OXZ]] - [https://wiki.alioth.net/img_auth.php/2/26/Auxiliary_Pylon.oxz '''Auxiliary Pylon download'''] - adds in a pylon to pylon-less ships. For [[Cargo Pods OXZ|cargo pods]] only - not missiles! Full details [[Auxiliary Pylon OXZ|HERE]].

=== GETter HUD ===
[[File:GuildLodgeET-1.jpg|thumb|right|500px|Guild Lodges! Tuners, I had no idea, not even an inkling, that such things existed - until new BFF (with benefits) Erog Ladiv found one and holo'd it for my records. May the Guild's single deity bless her a millionfold!]][[File:ManifestIsinorLavid-1.jpg|thumb|right|500px|Our third Isinor-Qutiri run and we meet a fan - racy Lereloid leopardine Erog Ladiv in her nifty Krait "Purple Cloud". She holo's me a shot of her newly updated G.E.T. Manifest (1.19)... she is enthusiastic, urging me to upgrade. We must admit, it's tempting, tuners, as in fact is Ladiv.]]
[[File:ETDorRevalManifest-1.jpg|thumb|right|500px|Dor Reval followed me to Anarlaqu - was it just to holo me his 1.19b Manifest, showing off his last (and first) huge Bonus payment from G.E.T.? Why haven't I had any? Perhaps I should upgrade, tuners.]]
[[Image:Griff_constrictor.jpg|thumb|right|300px|Tuners, I will confess I wasn't ignorant of this super-capable ship - Phlebor revealed its existence to me during our lengthy holo-chat. For those who don't know - and that's everyone outside the Guild's higher echelons, apparently - what you see here for the first time is FE Shipyards' very 'black' project - the Constrictor II. I want one!]]
[http://wiki.alioth.net/index.php/File:GETter_HUD.oxz '''GETter HUD download'''] - the only HUD in the inventory designed ''by'' Guilders ''for'' Guilders, showing digital speed and cargo hold contents in place of missiles. [https://bb.oolite.space/viewtopic.php?f=4&t=20813 BB thread].

Full details and illustrations [[GETter HUD OXZ|HERE]].

=== FE Ships ===
[http://wiki.alioth.net/index.php/File:FE_Ships.oxz '''FE Ships download'''] ([https://bb.oolite.space/viewtopic.php?f=4&t=20786 BB Thread]) and
=== FE Ships Player ===
[http://wiki.alioth.net/index.php/File:FE_Ships_Player.oxz '''FE Ships Player download'''] ([https://bb.oolite.space/viewtopic.php?f=4&t=20787 BB thread]) favour the Trader/Explorer and bring core ships into line with those of [[Frontier First Encounters]], expanding cargo-capacities across the board.

=== Goods Containers 10-50 TC ===
[[Goods Container OXZ#I-2 Trials|'''Goods Containers download''']], externally mounted 10-, 20-, 30-, 40- or 50-ton cargo cannisters, fitted to any spare missile pylons, will speed your course to riches and larger ships. [https://bb.oolite.space/viewtopic.php?f=4&t=20810 BB Thread].

=== More Moolah Market ===

[[More Moolah OXZ|'''More Moolah''']] is an enhanced and extended Market for the zealous merchanter. 5 (five) new commodities for industrial and agricultural economies; 9 (nine) recast display aliases for the Oolite goods. More variety, more realism, more trade possibilities, more moolah.

=== Merchanter's Zeal ===

Join the [[Merchanter's Zeal OXZ|'''Merchanters' League''']] for free, accurate, and succinct advice on buy- and sell-prices at every station in every system you visit. Advisories via the F4 Interface as well as witchpoint in-flight comms. MZ uses your trading history as its basis for buy-advice, and for sell-advice your own hold's manifest. It makes an ideal pairing with the lucrative More Moolah Market (MZ + MM = $$$)

=== Essential OXPs ===
[[MarketObserver|'''Market Observer''']], it goes without saying, enhances the E.T. experience greatly. Running with ''weapons offline'' is always to your advantage.

For all-round good spacegrocership, G.E.T. regards the following basic upgrades as primary:

* [[Cargo Bay Expansion]] (if available)
* [[Cargo Space Refit OXZ|'''Cargo Space Refit''']]
* [[Cargo Pods OXZ|'''Cargo Pod''']]
* [[Goods Container OXZ|'''Goods Containers''']] (pylons permitting)
* [[Overdrive OXZ|'''Overdrive''']]
* [[Teleportation Drive OXZ|'''Teleportation Drive''']]
* [[Auto S.O.S OXZ|'''Auto S.O.S.''']]
* [[Little Friends OXZ|'''Little Friends''']]
* [[Laser Reflector Shield OXZ|'''Laser Reflector Shields''']]: Arcane G.E.T. technology once again achieves its goal of keeping the innocent and honest trader safe.
* [[Advanced Space Compass]]
* and a [[Beam Laser|beam laser]]: not for its destructive potential, but for the quality of its '''reticle'''!

The Guild provides all other necessary systems and facilities.



== Versions ==

'''NEW IN VERSION 1.19'''

* Upon docking at a Lodge, G.E.T. will pay a Boon of 100 cr in appreciation of your patronage of the system's principal Guild Home.
* A new F4 Interface exclusive to the Lodge: the "G.E.T. Guild Lodge Sales Advisory", showing sell prices for the two most traded goods at all stations insystem. Those above the Apprentice grade may go on availing themselves of the Witchpoint Trade Advisory (giving only the single most-traded commodity prices), still a somewhat quicker option for the impatient trader.
* NPC traffic will now be encountered going into and out of the Guild Lodge - assume most of these ships are Elite Traders!
* Lodge Guardian Constrictor IIg craft will now respond to S.O.S. signals from beleaguered vessels, along with any Galcop police present.
* Lodge-tailored welcome messages appear at the Guild Lodge after docking there.
* G.E.T. has done away with Arrivals Screen refuel/repair/enhancement summaries in favour of more succinct console messages, facilitating swifter passage to the Market. The Guilder is directed now to the F4 Interfaces for fuller data on recent ship enhancements under "G.E.T. Ship Status Report".
* Various persistent - and perhaps annoying - ET behavioural glitches have been remedied.
* At every system's witchpoint you will find a Guild Lodge. In keeping with G.E.T.'s arcane and esoteric Order, these are small pyramidal stations offering welcome, ceremonial, cameraderie, and a trading floor - but no shipyard. One of the Lodge's external faces sports Galcop insignia for obfuscatory purposes and to assure a small police presence. Games may not be saved from inside a Lodge. The Guild Lodge flashes green and orange on your scanner.
* An ancient Guild tradition is the deployment of three guardian ships. Today, these are well-equipped Constrictor IIg models. A guardian will do nothing but patrol near the Lodge, unless disturbed. Guardians, in addition to the small (suborned) police presence which all Lodges attract, make a Guild Lodge's vicinity one of the safest - if not the safest - in the entire system. Guardian ships flash blue and orange on your scanner.
* The Guild accounts as a gift the rescuing of any escape pod, be its occupant of the innocent or the guilty. Saving the helplessly adrift will gain a Guilder not only merit, but also, as befits a gift of this nature, a 5-point ship enhancement plus a real Gift to the Guild of 1000 credits to further Grade advancement. This of course on top of any bounty that Galcop deems you worthy of.
* "Cloaking technology" - that 'Galcop advance' much rumoured and whispered about - was, in fact, long ago an invention of the Guild. They called their device the Hull Shroud. Needless to say, you, as a Guilder, can have it - at a price. Seek it at Stations with a high technological index.
* The Constrictor II - FE Shipyards' 'black project' - is no longer the restricted perk only of Grand Masters. You, as a lowly Master will now find it available, if you look hard. And it's not at all expensive! [nominal specs: thrust = 26; speed = 350; pylons = 4; capacity = 80 TC. Please note: this exclusive ET ship is designed for parity with FE Ships, not vanilla Oolite ships.]
* G.E.T. will pay to all Guilders except Grocers a regular and periodic Bonus. Guild bonuses are in gratitude for service, devotion, and fortitude. They are time-, Grade-, and performance-dependant: the higher you are in Grade and the more credits you have banked, the larger will be your Bonus when it comes.
* Total Bonuses paid by G.E.T. (and their number) are displayed on the F5F5 Manifest.
* G.E.T. owns to a new sensitivity to their Guilders' species-gender - you can be addressed now as "Sister", "Brother", "Sibling" (bi-, tri- or null-sexed persons), or just 'Guilder' (the default).
* As well as speedier Grade advancement, your gifts to the Guild bring with them 3-point ship enhancements.
* Practical console advisories onstation for Grocers who have not yet made 4 runs.
* G.E.T. begins to take account of time...
* Time spent as a Good Guilder is recorded on your F5F5 Manifest in Lave days (and Lave years).
* System-to-System Runs as a Good Guilder are numerically displayed on the F5F5 Manifest.
* Main Station no longer mass-locks your ship on approach (so please take care you don't slam into it!) (Grade 1 and above)

'''NEW IN VERSION 1.18'''

* In spite of the addition of the new F4 page 'Gift to Guild' (which speeds advancement in Grade), progression to the Elevated and Exalted Grades (10-22) has been made more arduous.
* Donations are no longer limited to one per system: they are cumulative within the system.
* "Buber's Beats" Milk Run guide for inductees on the F4 Interfaces screen.
* 'Milk or Cream? - Buber's Beats' - a comprehensive Wiki section with solid guidance, a truncated version of which appears in-game.
* Owing to a ballooning volume of Guild applications (blame TM!), the 'black box' anti-Masslock device is now reserved for Probationary Grade 1 and above. The result: a rougher ride for Grocers, but this should be mercifully brief if they follow Buber's 'beats' and her/his/its/their (really must invent a new pronoun) Lave advice.
* Buying and selling from and to multiple stations insystem is facilitated.
* More data now appears on the G.E.T. F5 Mission screen.
* Gifts and Last Trade (with Star, Station, and Goods) added to F5 Mission screen.
* Since space allows it, a station's secondary legal commodity is now listed by the F4 Master Advisory along with the primary, for all stations insystem.
* Much revision of the F4 Interfaces texts.
* More immersive comms messages geared to Grocers.
* Witchpoint Trade Advisory messages made more succinct.
* A slight re-ordering and renaming of the G.E.T. Grades.



== ELITE TRADER META! ==

Finally available, the all-inclusive E.T. package brings you:


* Elite Trader
* [[Auxiliary Pylon OXZ|Auxiliary Pylon]]
* [[Cargo Pods OXZ|Cargo Pods 10-50 TC]]
* [[Cargo Space Refit OXZ|Cargo Space Refit]]
* [[FE Ships OXZ|FE Ships Complete]]
* [[GETter HUD OXZ|GETter HUD]]
* [[Goods Container OXZ|Goods Containers 10-50 TC]]
* [[Overdrive OXZ|Overdrive]]


OXZ Version

Available for download now through your Oolite in-game Expansions Manager.

Or unzip to Oolite->AddOns.

[https://wiki.alioth.net/img_auth.php/4/40/Elite_Trader_Meta.oxz Download Elite Trader Meta 1.19.2 OXZ]

== Dependencies ==

Oolite v1.82 or later.

Required for the Guild Lodge to be present at the witchpoint:

* Stations for Extra Planets Base
* Stations for Extra Planets - Stations

If you are downloading via the Expansions Manager in-game, these dependencies are flagged and can be installed along with Elite Trader.

Optional are extra planets (unless you are content with precious few trading opportunities):

* Additional Planets SR Base
* Additional Planets SR Redux Pack

Look for these two excellent Ambience packages in the Expansions Manager in-game.

== Download ==

OXZ Version

Download via the in-game Expansions Manager ''or'' below. Do not unzip the .oxz file, just move or copy the OXZ to

Oolite->AddOns

[[Media:Elite_Trader.oxz | '''Download Elite Trader 1.19.3 OXZ''']]

== License ==
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.

''If you are re-using any piece of this OXP, please send a PM to [https://bb.oolite.space/memberlist.php?mode=viewprofile&u=40711 '''Reval'''] at the Oolite Bulletin board.

== Links ==
[https://bb.oolite.space/viewtopic.php?f=4&t=20784 Bulletin Board Discussion]

== Quick Facts ==
{{IconOXP|ooVersion="1.82"|oxpCPU="Low"|oxpMEM="Average"|oxpGPU="Low"}}

[[File:Tag-colour-blue.png]]
{{OXPLevel|1}}{{Infobox OXPb| title = Elite Trader
|version = 1.19.2
|release = 2022-12-06
|features = Enhances Trading
|license = CC BY-NC-SA 4
|category = Mechanics OXPs
|author = [[User:Reval|Reval]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=20784 BB-Link]
}}

{{Mechanics-OXP}}
[[Category:Galactic Guild of Elite Traders (GET)| ]]

== Appendices ==

These are texts not expressly part of the Elite Trader 'Manual' but which may, nevertheless, throw some additional (entertaining) light on the Guild's meta-reality and the background and history of its sundry protagonists and antagonists.

=== First Run ===

by Tea Mereso

I didn't know they would send me an instructor.

Lerelace Prime - new homeworld - floats, a child's ball of ochre, white, and crimson, in my forward viewscreen. I have been down there. Now I know all. Xexedi's overcast sheltered too much. It's high time now, tuners, and we feel ready.

Lounging beside us is a very odd fish indeed. No, no, my own kind, but who of you could sort piscine from ranine? Dor Reval has a quirkish turn of phrase, and he is (for I suspect he 'dressed' just so for me) of a far from unpleasing aspect. A stark contrast with his friend and Brother Fens Buber.

"I imagined you'd be disappointed after that one," Dor had said diffidently, as we rode the brief ascent from umbilicals.

I decided to say nothing - Buber is still a conundrum. Far, far away now.

"He's a climber. And they promoted him because of you."

"So glad", I murmured, "to have been of help. May I ask why exactly you're here?"

Another's turn for silence.

We made the Viper Two's cabin - ample, all gleam, and angled-back. He indicated the seat I was to take - the left. "Fresh out of the FE shipyards, this jewel," he commented. "Superb." And, tuners, Reval should know - he's their Director.

"Leapt right out from the catalogue, Dor. And your people are so free with the money."

Dor's head bobbed several times. "My Asp was financed. I started just like you. Well, no, I stole mine. Later I came clean and got it on a G.E.T. stipend."

"They gave it to you?"

He chuckled. "Hardly! But... in a way they did. Now, something vital: this button - yes, the red - will stream an encrypted S.O.S. on a G.E.T. frequency - an all-station relay. None but Guild vessels and others in sympathy can receive it ungarbled - even Merchanters' League. Use it. Don't hesitate. But only when every instinct tells you you must."

I try a steady laugh, unsure if I'm succeeding. "Understood. I'll sticky it - tattoo it on my wrist. Such a positive beginning! Are you even going to tell me if these things are easy to fly?"

"Oh. Fully automatic if you want. But I'm here to show you... a few tricks."

"It's like being young again - my first sally out on the highway."

"The Lane. But another first sally. Nervous, Tea?"

"You'll find out. I will too, I suppose." Why, tuners, am I avoiding his eyes?

"Welcome aboard 'Buber's Bane' - what did you call yours?"

"No need to be, really. And 'Laenina's Flux' is her name - truly my first love. But she's in dry while I perform instructional duties."

"Ahh, that's what you are."

"For now, Tea. Where shall we go?"

Tuners, this is something your born-again journo does not have to ponder. Reval indicates my galactic chart and, having seen Buber do it, I press a digit onto my sun of desire. "Laenina - we must see Laenina again."

"Quite a star," he agrees, with a strange gaze at me. "An equal first with Lerelace in the beauty stakes."

I feel my skin cycling through several nuances of red, mirroring the star we see and the star we will see, as Dor sets himself to fiddling with my attitude controls.

"Set to yaw only," he explains, "the roll function cancelled. Yaw to turn this darling, so she responds better to your wishes. Roll is a throwback to atmospheric flight, retained in new ships only as a respectful bow to history."

"Good to know." (tuners, are you paying attention?)

"Not that we'll be doing any manoevring - no acrobatics and definitely no ship-ship tangles. We leave that to those who don't trade."

"Like handling a land-skimmer, then?" we say. "I drove a lot downworld on Xexedi." I test the give in the stick and we buck a little sideways, rectify smoothly.

"Correct! Us spacehaulers are nothing if not expert drivers. Quickest path from point A to point B."

"And am I your 'Sister' as well as your 'Soror'?"

"If you like, Sor Mereso. Sister, you are warmly welcomed to the Guild."

"And if I switch?" I switch.

"I understand the Masters are working on pronoun protocol for us volitionals and the non-permanently gendered." He shrugs and laughs, Buber-like, almost switching. "And the non-gendered - though I've never met one."

"Lobstoids?"

"Tri-gendered."

"Just call me Brother, Brother."

We drift out from Station in the absolute silence. Lonely silence, I catch myself thinking. Inconsequential system chatter scrolls on a small screen in front of us. Hands free, we let 'Buber's Bane' follow her coded course. Why, tuners, can I quite not relax? Dor Reval starts humming a soft melody beside me, studiously intent on scanners.

"If we're... attacked?" The words escape my lips reflexively. "Those Mambas in Laenin's outer reaches. They couldn't lock our mass because Fens had a black box - a device of some kind."

"And you're thinking we don't? And you're quite right."

"Dor, my laser, am I allowed to use it? Maybe as a warning that I've got one?"

He quirks his lips - a sort of smile. "What laser, Tea?"

"What do you mean, 'what laser'? All Vipers have lasers don't they?"

"Only if your order specified one."

I let that sink in; it does after a few minutes. "And why in the nth random factor can't I hear anything? Are our drives even running? Are we even moving?"

Dor swivels to me and leans closer. Holding my eyes with his, he carefully - lightly - places the hands of his two main limbs on the tops of mine. He explains in calming tones that we can't hear our engines because they are situated far back behind the cargo holds - which, being packed tight now with pods jammed with unrecognizable tech under the general rubric 'computers', bought only because my Lerelacean Assessor told me to, her lichen eyes hosting inscrutable slits - insulate any and all sound in their otherwise vacuous spaces. He reminds me how massive, by terrestrial measure, my ship really is; how perched high up here in our skimmer-like cockpit, everything feels deceptive. And how easy it is to panic.

"And this is only your second time seeing the controls of a powerful space vehicle. Feelings of disorientation are not in any way unusual. Everything is fine, and I'm here beside you."

"But... for how long?"

"A few days, a week maybe. Enough time to get you on the beat."

"And then? - it's a lonely life isn't it?"

"Tea, our life is station-to-station. Only the empty bits in between will tax you."

An eerie annunciator winds down its gamut, puncturing the quiet. I shiver, though it's not at all cold. Dor seems to collect himself, a new tenseness about him. "Now we jump - hyperspace. You've been through it before, I think."

"I survived it twice. Yes."

"So you know what you have to do."

"Brace and breathe."

"Exactly. And you know what probably awaits us as we come in. Tea, you will watch carefully what I do, and you will do whatever I tell you, quickly, ok? And you will not panic, because I'm here. And you will never forget this day."

Dor waits a few seconds for my confirmatory nod. Then points at the black button. "Your ship," he says.

"Viper out of witch - stop or we fire."

Galspeak rasps and crackles in Laenina's stellar wind. Dor had inserted my plug for me, and now inserts his.

"Don't stop," he says, "We'll make them work. Full speed. They won't use lasers yet..."

"You seem very sure."

"Risk of damaging cargo, which is what they're going to want. Not us, we hope."

"What have we here - a Lereloid pussycat? We'll pod her out and have some fun, 'mates'."

Heavens to blazes, tuners, we don't want melting and scooping and... selling. Time to call the helpline.

"Transmit our ID and... your registration," Dor instructs. I do so, quickly.

"Kittycat, are you there - or have you fainted away? We'll revive you..."

Their own IDs bounce back at us - Mambas out of Reorte. Their comms fall silent for a stretch.

"We don't try to run," says Dor, "their ships have an edge on yours for the moment. And there are too many."

"So--"

Comms cuts me off.

"Fifty barrels, tuney girl. Now. Lose 'em!"

"Do what they say, Tea."

My eyes scan the board, frantic for the Dump switch. I find it, about to press, but Reval stays my hand. "Give them our least valuable items. Hit 'cycle' until Alloys come up. No, better, toss them some firearms cases. They'll like those more."

Cannisters leave our hold, readouts tell us. But we feel nothing, tuners. No movement. No sound of their going.

"Oh won't you look at that, 'me hearties' - the famed stacked frogoid throws us a tip!"

If I expected them to swarm to the 'catch', I am mistaken. "Dor, why aren't they--"

"Manifest, sweetness."

"That's hold contents, systems status, credits, crew. Go on, send it."

Dor has to show me how, but I comply. Another deaf pause that feels like an hour.

"Bang-up ship - I think we'll... ooh naughty naughty - what'll the Laenin constabulary say?"

Reval punches 'transmit'. "Exactly nothing, arsehole. Now let's get on with it."

For Nova's sake, don't provoke them, I'm thinking. Comms preludes again with stellar static. Tuners, are your hearts pounding as hard as mine? - Dor looks almost... nonchalant.

"Babes - what say I drag you here to my snug ride and ransom you? ... after a time... Pod out quietly now and we won't incinerate your friend."

Laser flashes slice across our bow, glancing off shields with some interesting sparkles.

"Just teasing with the fireworks, candybuns - but you'll be wise to stop. You're wasting quirium, ours and yours."

"Dor, why is it I'm feeling your last instruction lacked merit?"

"I will get us out of it."

"Oh you think?"

"Kill the drives."

I pull the lever full back. No sensation, except a faint churning in my innards. All stars still and in their eternal positions, Laenina more beautiful than ever in her bright indifference. Tuners, I'm realizing too late that it was all an error. Laenin system, it has dawned on me, is not a 'stable' one.

"All right friends - sensible. Thirty Lave seconds: if I don't see a womanned escape pod, it's out of my hands - my crew, you twig? ... We've decided we don't need your goods offering after all..."

"Dor, Tuners," I mutter, "I vow I'll deep-switch. Whoever, whatever... it is, they will not be charmed by your devoted informant's un-womany side."

"Second best idea you've had all day," he says, rising abruptly. He goes aft and points at where I would never have imagined an escape hatch to be. That is, 'tastefully hidden', tuners.

"Tea - they do mean business."

"And what about you?"

"I won't lose you."

"Oh I just love playing along. How d'you like my full Brother look?"

He pulls open the hatch for me. But I stay where I am.

"Time's up stubborn tasty ranoid. Munch some laser!"

Searing rays lance in from all sides. No more pretty glitters over our shields. I feel dense fire boring through, shivering our Viper's carapace.

Reval sprints back, wrenches the stick from my grasp, accelerates, shoves me out of my chair and yaws us hard left, so hard that I am propelled by the force into and against the back of the seat he had occupied. The yaw is followed by a vicious dive as my head hits the padded ceiling of the cabin. All this still, tuners, in utter silence. Not even the laser streaks, now mostly missing us, are heard.

"Are you hurt? - Strap in and stay buckled."

While scanners show Mambas re-forming their five-point attack, a sixth ship flashes into range. Absent, and now here, almost grazing our flanks. Out of witchspace, a mere ten minutes behind us.

"Asp," mutters Dor. "Or Asp II. But this one's no trader either."

I stammer, "Is it Guild?"

"More... ex-Guild if I'm not wrong. They all know we have no weapons."

"So they're--"

"Toying with us, yes. Deciding what to do with us. Calling friends."

To scrap over the spoils, tuners - me.

"Is 'toying' Guild-slang for 'frying'?"

"He... it... won't let them go that far."

"You do have the oddest faith, Reval."

"Faith, yes - we all have Faith. It's what has been lost."

"And you keep it safe?"

Dor gifts me with a smile of what I keenly sense as true affection.

"So you do know our Secret."

"What's this now, Miss Delectable - trying to even the odds?"

This time I key 'talk'.

"One day, one day," I say, "I will have lasers - a big laser aft, an even bigger one front, a laser on each side. And I'll be fast and I'll be strong - faster and stronger than any of you, because that's what the Masters give me. And now I have your ID, Mamba-entity, you will one day wish you hadn't sent or spoken the way you have. This I swear."

Do I only imagine crackled laughter under the static?

"If. Think you're getting off, spunky Guild-girl? It's looking less and less likely every Lave second. Come on, just pod over and stop all the fuel waste - we'll talk. We'll both finish well. Me weller, but you alive and free."

After a swift silence, comms and mine, the mechanical words "So be it. Time to die. Tea - such a loss..."

Reval anticipates the firestorm with a crippling yawed climb. They get in more hits and I watch our shield-strength take a sudden fall into red. Somewhere the acrid smell of scorched circuitry. Do I feel warmer? What is it like, tuners, to burn? - You know I'll be with you every second until...

The Asp II - I'd almost forgotten it - is no longer close. It starts manoeuvring. So rapid and snake-like its path that scanners lose it, find it, lose it, until I can't see it onscreen any more.

"Is it joining... them?" I say.

"Watch," is all Dor answers.

So I watch the Mambas blink out, one by one.

"All stop. Tea - stupendous. You did us proud."

We exchange seats again - tuners, mine feels almost comfortable.

"I did nothing. It was all you and--"

"Don't sell yourself short. Never do that. You're a treasure."

The yellow blip several times unseen by scan reappears, approaching.

"What in the Random Void is it?" I say, still stunned. "Who is it?"

Dor treats me to a grin that I fancy is rare. "Don't you know? I thought you and he were pals. I have your holo - intriguing interview. Certainly hooked you."

Trying and failing to visualize in close-up the quick eradication of five Mambas, I watch the grimmer mass of the Asp shroud Laenina again. Too close again - isn't this dangerous? "Won't he--"

"No. You saw the way he moves. You think he'd misjudge a hundred metres?"

I slam my palm down on 'transmit', the Asp's band.

"Contratius - Tea Mereso of 'Buber's Bane': you certainly give us our money's worth every time."

A deep, hoarse chuckle comes back over. "Always thrilled to be of service, Ms Mereso. Or must I call you Sor? - and he is rather a bane isn't he? - or more, I think you'll agree, of a bind. Or a bore."

"Fens is that, true, but his heart's in the right place, as is Dor's."

"Verily. Verily. I miss them sometimes, my 'Brothers'. Which is why I've come to you."

Reval is shaking his head vehemently while I speak, lips pressed tight, skin cycling worlds of colour. He pulls my hand off 'transmit'. "Tea, people don't banter with Phlebor. Not any more. Don't 'let him in'. Leave it. Say goodbye and we go our way, offload our tech, and then to the bar or get a room and... really talk."

Contratius has turned his interdictor to face us flank-on. It happened in an instant, almost unnoted. Tuners, we are now able to make out her name - metallic grey symbols on matte black hull: Continuum. If anyone has lasers, he does.

"I've been following", says Phlebor, as if the aforementioned hasn't taken place, "your... progress. And you could say I've developed quite a crush - after our delightful chat over holo and re-viewing your subsequent journalistic 'coups'. For now I take Dor. He will stay with me as my guest. My Asp's a small palace, you wouldn't believe."

"No! Why Reval, why take him? Take me. I can... help."

"You, sweetheart, are doing just fine as you are. Stick at it now - rise high. Make many holocasts. And I'll be in touch again. Later, you'll put in a good word for me with the Perfect Master. I think you know who I mean."

"You'll do whatever you like, Phlebor. How can we possibly prevent you? My ship is unarmed."

"Then you should arm yourself, dear! If only for show..."

I watch the shadow of his Asp inch in so close it obscures my right viewscreen.

"To the pod now, Grocer - I look forward to many a stimulating conversation on... technical matters."

I glance at Dor. He looks back at me with that expression I still can't quite read. Then he presses my arm and goes to the hatch again. He steps inside, closes the seals. And, like the containers, is gone without sound or sensation.

"Treat him well, or I swear..."

"Oh have no fear, we are old acquaintances. He was once my protégé, as you have been his."

It is not long, tuners, before I can no longer see my... flight tutor of one day. And after a few minutes more, the black ship called Continuum pulls far out into an even blacker starscape.

=== The Bond ===

by Tea Mereso

The instant I saw her holo I knew this would be another face-to-face.

I ran across her ship - an ageing but well-kept Cob III - on the famous Qutiri-Isinor neophyte beat... (are there any traders who don't start earning there, tuners? - I've never met one.)

And after glimpsing said vessel and hurriedly enquiring after her owner and if her regular on-station goto was Qutiri's Queer Lodge Grill, the inn I happen to find myself at whenever here - well, the rest, as they say, tuners, is history...

This young, rather comely, humanoid native of Bemaera - not a stone's throw from Lave - does not hold back! But she made no demurral as I plonked a ranoid rear upon a seat in front of her without so much as a 'hello sister'. She did give me a quirkish and questioning smile, however, a smile that held in addition something of the knowing and familiar.

"I watch your stuff, Tea - and that's the honest. I'm a fan and an addict."

Oh Random Gods! - another Grocer Dor!

"Super," I simper, as I sip at my Anlian Rickey and do not unfix her with my gaze. "So you know me, but do I know you?"

"Zita," she says, "Zita Lavre of 'Bemaera's Bond'."

"Enchanting! Of "Buber's Bane", we - a Viper II, and loving it."

"The 'Bond' was my Dad's and I grew up on her."

"A home in every sense then?"

Zita nods and takes half of her Sotieran screwdriver at a gulp.

"You and me, of BB and BB - off to a strong start... delighting in our B's."

I try a wider smile and she mirrors it, encouraging. I run my pinking tongue over my teeth, begin to feel my skin cycling into worlds of the same.

And then I just let Zita talk.

She drains her tumbler and signals for another.

"When Gavros - that's my Dad - was taken, I did what any trader's daughter does - took over the 'Bond' as if she were mine: I have no sisters or brothers and never knew my mother... from another family's ship on route to the far edge of Galaxy One. These old trading ships are nothing complicated, unlike yours, and in any case I had watched Gav handle her from babyhood. The 'Bond' fits me like a glove and I fit her. We are truly one. I will never give her up, never abandon her - there is not even an escape pod because that's the one Gav closed the day they took him. They said it was either him, or me."

Her screwdriver arrives and she twiddles its stirrer a moment, eyes lost in the bitterweet drink. Her other hand is on the table so I lay one of mine over it and leave it there.

"Tea..." She lets out far-off sighing breath. "He's gone. And I play and re-play your holocast, the one where Dor Reval of Xexedi was made to leave you alone on your new ship to face the dark and the stars without him."

I nod, increase my finger pressure on Zita's warm and very un-ranoid skin. Tuners, you'll know that there are times when the only thing to say is nothing.

"I hate the Guild and I hate the League. I just do. I feel that one or the other was involved in what happened two Lave years ago."

Our own turn to let go a breath. "Why?"

"Why, Tea? - because I saw the ship's name in the star-shadow through viewscreen. The black Asp: Continuum. But unlike you, I could hear nothing its master said to Gav. And I have not heard of that vessel since. Until your holocast."

I take her other hand in my other because she has forgotten about her drink. "That was only a week ago! I'm still not over it, Zita. My hearts fly out to you. Let's leave," I say, "this is not the place."

She needs no prompting to rise with me, her soft human hands still in mine, strong slim digits gripping and twining.

We make spacedock - our ships tethered not too many berths apart - and I tell her that I have an idea. When did I ever not, Tuners?

"I need to take you somewhere, Zita."

Zita drifts her body gently into mine and I feel the odorous mammalian warmth. "I'm yours," she murmurs.

Tuners, was it trite to say that I somehow knew that from the start? - But I did.

"Just follow me through witch then, jewel, and we'll be close again when we reach where we're going."

"You know I don't want to pull away don't you?"

I say I do know. But she does anyway. We float apart, growing further apart, until we reach our hatches on the cold Qutirian dock, interstellar space a mere Lave meter from us both.

Esconced quickly in the Viper's cabin, softly leather-embraced in de-luxe pilot-seat upholstery, I lose not a second getting on holo with Zita. Is it pure chance, tuners, that she lets my good selves and your good selves catch her at the tail-end of a zero-G dry body shower, light-brown gossamer tresses drifting around her face and neck and shoulders? You should not be watching!

Catching my thoughts, she emits a low giggle, mimes for us the eons-old gesture of modesty with both hands and forearm. "Tea, I know you are recording. When aren't you? - Your tuners want something to keep them 'hooked', and Zita Lavre wants them hooked, wants you hooked, so you will pursue what there is to pursue with me..."

"Oh believe me love," I give back, "You are not the only one. The worlds are with us and will stay with us until we no longer want them to."

"Good." Making a firm little nod, she reaches for the grey hauler's catsuit she had abandoned on a hook and slithers with some effort back into it. Zita sweeps fingers of both hands through her hair - no brush or comb for this trader's child. We follow her enticing motions forward into her own cabin space. Viewcreens and scanner, hers and mine, illuminate and we are glimmered now in muted orange flight-glow.

Our holds are packed with cannisters of unspecified tech going under the general rubric 'computers', our manifests tell us. We catch one another smiling comfortably, both now back where we know we belong.

"Sending you the witch-jump sequence I want you to take with me," I say.

She chuckles. "And here is me thinking I know it all, Tea."

"Oh there's always something else beyond scanner-range. What would life be otherwise?"

"Easier." But she smirks as she says it.

We unclamp in near-unison: The only loud noise we will hear until we dock again. The rest is silence.

Safely on auto for a time, and under Galcop vigil, flank on flank the Bond and the Bane, Zita and Tea, drift out from station toward their assigned jump-point. This is the time-honoured hour to take stock, the hour when some wonder why they are here and how they got to be here. The stories are so different, tuners, and I will tell them if the Random Void permits. With us, you know how it came to pass - you were with us, my dears.

Zita has turned pensive and a little sullen, almost too Buber- or Dor-like, un-human, we feel and want to alleviate it. Is this a sign of something? The sign that I could begin to care just a touch too much for another being? Tuners, you tell me. I am a space virgin. Nearly.

I ask this girl of an hour's acquaintance how she can be a 'native of Bemaera' while averring she was born and raised on the Cob.

"Oh," she comes back, "I didn't express that very well. I am of Bemaeran ancestry - my Grandad was born planetside, but both Gav and I grew up on the 'Bond'."

"Two generations on-ship!"

"There are a thousand families with more, Tea."

"Real generation-ships."

"I meant in a Merchanter sense. Merchanters' lives are aboard. We are born and we die on our ships, all too often with our ships. But we are not trying to reach any place special like the great ones the stories tell of. The Terrans and all that. I guess I am one of them."

"Indeed you are. I have heard there are no others like you in this Galaxy. And that Terra is or was a far far planet on a chart we no longer possess knowledge of..."

"Oh Guild-dung Tea!" Zita forms as near a snarl as she is able and then pouts.

"So let's leave that one aside. We have time in the between to hammer it out. Just you and me."

"The only entity", she avers, "this woman wants to take a hammer to is Contratius Phlebor."

I throw her a dour grin, nodding agreement. "And don't we have lasers for that?"

"I do," she says, "but on your holo Dor said you don't."

"Mine are Military, fore and aft - I took Phlebor's parting words of counsel and 'armed myself'."

"I've fired mine many times," Zita says as the eerie Jump klaxon keens. "Have you?"

"Never. And hope not to."

"Leave it to me then."

Zita waits for me to start Hyperspace count. I hit the black button.

We have got the trick of 'bracing and breathing' down as near a fine art as a planet-born amphibioid ever will. Like to try it for yourselves, tuners? - Give soror Tea Mereso of Lerelace a giggle for a change...

Time folds itself over multiply when we enter witchspace and no scientist has ever fathomed, nor likely ever will fathom, how much real time 'passes' in the between during Jump. It is all relative, in any case, tuners - and though our bodies feel the effects, we do not seem to age and the Universe is as it was for us when we emerge, witch-sick, back into real space.

And all I need right at this moment is to pod over to "Bemaera's Bond" and curl up in Zita's body-warm berth. Groggily I tell her so and she woozily replies, "come right over!"

Instead comm crackles and growls, "Give us your cargo, darlings, or we immolate you."

Nothing we didn't expect.

"All in a day's work, my Tea," soothes Zita and radiates the starlight of one of her smiles.

"So we're running?"

"You bet we are!"

And this is only Isinor, tuners. And I have 'miles to go before I sleep', did not a near-forgotten poet once quietly intone in enwrapping snow among trees?

"You have an account full of cash, if I'm not wrong?"

"You might put it that way, if you were coarse," I say.

"If we make Isinor Prime Aegis alive, you are hiring us some robot-driven escorts..."

Comm preludes with more static from Isinora's stellar wind. Then the rasp of the pirate-entity's Galspeak synth-voc assails our auriculars. "We're counting the Lave seconds, sweetnesses... You have 30 until our first missiles come a-calling... Let's see those tech goodies popping out of your holds! Now!"

"Dump a quarter of it," Zita commands. "I'm doing likewise. We'll break even. The quest - whatever that is - comes first. We're not on a trade-run, correct?"

"Correct, my soror."

"Don't call me that! It's Guild-smoke. Have a little respect, or at least sympathy."

"Baby, if Contratius wanted your Dad - your Gav - then your Gav was not at all what you thought he was. I'm inferring, but isn't it obvious?"

"Gav was Guild?" I hear her gasp behind the words. "It never occurred to me to ask myself why what happened that day happened."

We feel nothing as a dozen containers of what in a planet's gravity would be tons-heavy leave our holds. Neither do we see them on viewscreens. We have only the reduced manifest readouts to assure us we've lost costly items that would have brought impressive profit on Isinor.

"Full speed now dear," she orders, "We shoot offlane and angle straight in to the Station buoy. We refuel and sell our three-quarters cargo, then take a nap together in a pleasant and fragrant room with the softest bed we can find. And you will go off air for that part!"

Zita Lavre, only daughter of Gavros Lavre, has spoken.

So this is Tea Mereso, long ago of the Xexedi Enquirer, en route to Isinorean bliss, signing off until next time.

FE Ships OXZ

2026-05-12T12:37:01Z

Phkb: /* Downloads */

[[Image:Griff_mamba.jpg|thumb|right|200px|Mamba in Griff's colours - fly it with FE Ships Player...]] [[Image:Griff_sidewinder.jpg|thumb|right|200px|Sidewinder in Griff's colours - fly it with FE Ships Player...]] [[Image:Griff_krait.jpg|thumb|right|200px|Krait in Griff's colours - fly it with FE Ships Player...]] [[Image:Griff_viper.jpg|thumb|right|200px|Viper in Griff's colours - fly it with FE Ships Player...]] [[Image:Griff_viper_interceptor.jpg|thumb|right|200px|Viper II in Griff's colours - fly it with FE Ships Player...]]
==FE Shipyards==

The last major project of [[Elite Trader OXZ|G.E.T.'s]] Transport Arm, FE Ships transforms the core Oolite craft into their [[Frontier First Encounters]] equivalents and makes all of them flyable. The result: Larger hull capacities and an altered speed scale across the board. Every non-player (AI) ship is replaced by an FE ship, so that no 'unfair advantage' on either side occurs.

Here's the breakdown:

<code>1.SHIP CLASS, 2. FE Thrust, 3. LM (speed), 4. TC (tonnage)</code>

Adder 18.1 0.240 15
Anaconda 6.0 0.080 400
Asp 22.2 0.294 75
Boa 8.0 0.106 700
Cobra 1 16.1 0.213 35
Cobra 3 20.1 0.267 55
Constrictor 22.0 0.292 65
Fer-de-Lance 22.5 0.298 10
Gecko 16.0 0.212 9
Krait 20.1 0.267 17
Mamba 20.5 0.272 20
Moray 14.0 0.186 45
Python 10.0 0.133 320
Sidewinder 23.2 0.308 15
Viper 24.2 0.321 25
Viper 2 25.2 0.334 30

Frontier:FE ships' original prices have also been taken into account.

== Benefits ==
FE Ships will, above all, be of benefit to traders and explorers, since Frontier and First Encounters increased the cargo capacity of all the original Elite ships.

For example, the Adder FE can boast a base 15 TC cargo hold, expandable to 30 TC with Oolite's cargo-bay extension. You will find this enhancement with FE ships across the board, including the now playable Gecko, Krait, Mamba, Sidewinder and Vipers.

To fly the new lightweight ships, you will need to install FE Ships Player alongside FE Ships.

For the full FE experience, use Normal Start and sell your Cobra III pronto!

At Lave, you will find available the Gecko, Krait, Sidewinder, Adder, and Cobra I. All will have the 'FE' suffix in-game.

Recommended upgrade paths for FE Ships Player:

Hunter: Gecko, Krait, Sidewinder, Mamba, Fer-de-Lance, Viper.

Trader: Gecko, Adder, Krait, Cobra I, Cobra III, Asp Explorer, and onward...

Geckos, Kraits, and Sidewinders have no docking computers, no military upgrades, no extra cargo holds, and all except the Krait no missiles. Their successful operation will prove a challenge. Enjoy!

== Downloads ==

Once downloaded, just move or copy the two OXZs to

Oolite->AddOns

They will then appear as installed on your OXZ list in-game.

The easiest way by far of getting FE Ships is via your Oolite Expansions Manager. Both components will be downloaded and installed together straight away.

=== FE Ships ===
[http://wiki.alioth.net/index.php/File:FE_Ships.oxz '''FE Ships download'''] ([https://bb.oolite.space/viewtopic.php?f=4&t=20786 BB Thread]) and
=== FE Ships Player ===
[http://wiki.alioth.net/index.php/File:FE_Ships_Player.oxz '''FE Ships Player download'''] ([https://bb.oolite.space/viewtopic.php?f=4&t=20787 BB thread]) Fly the Gecko, Krait, Sidewinder, Mamba, Viper I, Viper II, and several more Frontier FE ships unflyable in 'vanilla' Oolite and Elite.

== Quick Facts ==

{{IconOXP|ooVersion="1.82"|oxpCPU="Low"|oxpMEM="Average"|oxpGPU="Low"}}

[[File:Tag-colour-blue.png]]
{{OXPLevel|1}}{{Infobox OXPb| title = FE Ships
|version = 1.2
|release = 2020-12-16
|features = Enhances Trading
|license = CC BY-NC-SA 4
|category = Ships
|author = [[User:Reval|Reval]]
|feedback = see above
}}

{{Ship-OXP}}
[[Category:Galactic Guild of Elite Traders (GET)]]

Talk:NPB Neutralizer OXZ

2026-05-11T21:50:59Z

Phkb:

Some points:
* Getting a "kill" using this weapon won't count for most mission OXP's - you will still need to keep firing until the ship is destroyed.
* Every weapon will end up working as an NPB Neutralizer, as long as you have one installed, as the code doesn't check which view is being used and what weapon is installed there.
* Info says you need to be clean, but code doesn't prevent an Offender/Fugitive install.
* Info also says Police have these retro fitted, but there's no code granting it specifically to police ships, and "available_to_NPCs = false;" in the equipment.plist
* Given the uber-ness of this weapon, I'm curious as to why you've rated it "Neutral". I think this should be "Some bias in the players favour/Makes the game a little easier".

phkb

Yes, mostly valid comments (and thanks for making them!)

The first thing by way of response is that Oolite pirate NPCs already have a vastly '''unfair advantage''' over the player and most of my OXPs are attempts to balance this core game failing out.

I say 'most', because NPB Neutralizer is NOT one of these! It is no 'uber weapon', requiring, as it does, players to engage in normal combat, to keep an evading opponent in their sights and to fire a sustained burst to disable it. This burst amounts to '''at least 3 seconds''' for a weak-shielded and relatively low-energy Transporter, and substantially longer for a higher-energy ship. Thus my 'green' rating. It makes nothing in combat any easier.

Your other points were already on my To Do list for version 1.1. This is merely an initial release - only the basic functional elements implemented. That's the way I work.

First priority is the Clean record - prohibiting installation for Offenders, as included already in Defence Rider Drones (and to be fully fixed for version 1.3).

Because of their existing unfair advantage, NPCs will never be given this piece of equipment! Not that it would necessarily make _their_ life any easier... In fact, it could make their operations more difficult, given the comparatively low hull damage inflicted by the Neutralizer (damage=3, compared to damage=12 for a standard Military Laser.)

But it might indeed be a nice experiment to give some Police SDD Mambitas the Neutralizer NPB. Perhaps you can offer some suggestions as to how to allot the weapon _selectively_ for NPC Police ships like the Viper too, because I have no idea how this might be achieved during system population.

This OXP is not intended for those who play missions - which would vastly complicate coding. Anyway, there is nothing to prevent you from 'keeping on firing' until the derelict explodes (you have already collected any bounty and had your score increased).

Most players play with a forward laser. I have never used a Port, Starboard, or Rear one. But I suppose something could be worked out to satisfy those rare eccentrics who put beam weapons on all their facings!

[[User:Reval|Reval]] ([[User talk:Reval|talk]]) 17:42, 11 May 2026 (BST)

Re: Giving weapon to NPC's. The difficulty you face, as with any specialised weapon, is what happens to the player when they're hit by it. Will all the same criteria apply? And how will a player feel if they get a game over screen when they still had 90% of their shields? Will it feel like satisfying gameplay, or a bug? My recommendation is to leave it as a player-only weapon, rather than go down that rabbit hole.

It's fine for it to be player-only. Just don't suggest the player will be coming up against it by saying it's being retro-fitted on Vipers. Don't say something that isn't true.

Re: Most players play with a forward weapon only. In my experience, and from what I've read of other players methods, forward and rear lasers are actually quite common. Port and starboard are rarer. As a test, install the Neutralizer in the rear position, install a Military laser in the forward position, and see how the game play feels. One good solid hit by the military laser will quickly be converted into a kill by the Neutraliser, sub 1 second.

Re: Not being intended for missions. That's fine - but it needs to be stated up front that using this weapon as designed is incompatible with all missions that require ship destruction. See the [[Railgun OXP]] where a similar problem is declared.

As an aside, it might be worth testing the [[Derelicts don't count OXP]]. Your weapon is doing similar things and it's likely to be incompatible.

[[User:phkb|phkb]] 7:52, 12 May 2026 (AEST)

== Theory ==

"... Neutral Particle Beam weapon that works by accelerating hydrogen atoms to near-light speed and then neutralizing their charge. Upon hitting a target, the high-energy particles penetrate deep into a ship's structure, depositing their energy inside critical systems like electronics and power conduits."

Umm... neither hydrogen molecules or hydrogen atoms have a charge, as far as I know. Hydrogen ions ''do'' - either anions (for hydrogen: a proton with two electrons) or cations (for hydrogen: protons on their tod).

See https://en.wikipedia.org/wiki/Ion#Anions_and_cations which talks about hydrogen in particular

:''Cholmondeley 10:44, 11 May 2026 (BST)''

"Particle Beam Weapons Theory

**Neutral particle beam (NPB) weapons** are directed-energy systems that accelerate subatomic particles, typically hydrogen ions, to near-light speed and neutralize them before firing to prevent deflection by magnetic fields. Unlike lasers that burn surfaces, NPBs penetrate deep into a target’s interior, causing catastrophic damage through **kinetic penetration, thermal superheating, and ionization** that destroys electronics or triggers nuclear fission.

The theoretical mechanics involve three key stages:
* **Acceleration and Neutralization:** Charged particles (like negative hydrogen ions) are accelerated to high energies (100–1000+ MeV) using particle accelerators. Before leaving the device, they pass through a neutralizer cell or gas stripper to remove an electron, creating a beam of electrically neutral atoms. This neutrality allows the beam to travel in a straight line without being deflected by the Earth’s magnetic field.
* **Target Interaction:** Upon impact, the neutral particles capture electrons from the target material, becoming charged ions. This allows them to penetrate deeply into the vehicle’s shell or exterior, depositing their kinetic energy internally.
* **Destructive Effects:** The energy deposition causes **near-instantaneous superheating** of the target material, potentially melting it, igniting fuel supplies, or frying onboard electronics. For nuclear warheads, the particles can induce fission processes and neutron generation, leading to premature detonation or structural failure.

Historically, the U.S. Strategic Defense Initiative explored NPBs as **anti-satellite** and **anti-ballistic missile** weapons capable of intercepting targets in their boost phase. While the Beam Experiments Aboard Rocket (BEAR) project successfully tested a prototype in space in 1989, significant technical hurdles remain, including the need for **lightweight, high-power accelerators** and methods to maintain beam coherence over long distances. Despite recent interest in testing space-based variants, NPBs remain largely in the research stage due to the immense power requirements and engineering challenges involved in miniaturizing the necessary accelerator technology."

(from Brave AI search)

Learning the ins-and-outs of this form of potential space weaponry was in fact the inspiration for attempting to code it as an OXP. Even in embryonic 'version 1.0' form, NPB Neutralizer does what an NPB beam would do.

But I concede your point that Hydrogen 'atoms' was somewhat inexact and even misleading. I will change it to 'ions'.

The correct sequence is:

* Hydrogen atoms are ionized to create negative hydrogen ions (H⁻).

* These ions are accelerated to near-light speed using a particle accelerator.

* The accelerated ions are then neutralized (by stripping away the extra electron) to form a beam of neutral hydrogen atoms for firing.

So, the beam is accelerated as charged '''ions''', not neutral atoms. The neutralization happens after acceleration to allow the beam to travel in a straight line. (clarification via Brave AI Search).

[[User:Reval|Reval]] ([[User talk:Reval|talk]]) 16:45, 11 May 2026 (BST)

Wireframe Ship Images

2026-05-11T12:55:14Z

Phkb:

[[image:wsi_cobra3.png|thumb|right|200px|Sample image of a Cobra Mark III]][[image:wsi_coriolis.png|thumb|right|200px|Sample image of a Coriolis Station]][[image:wsi_thargoid.png|thumb|right|200px|Sample image of a Thargoid Warship]]
==Overview==
This OXP contains a repository of almost 700 different ship images, linked to almost 2000 different ship entities, in wireframe form, that can be utilised by other OXP's. Each of the images is 512x512 pixels in size.

It is a necessity for the [[Vimana-X HUD]].

==Methodology==
The following example demonstrates how to use the OXP:

var wsi = worldScripts.WireFrameShipImages;
var file = wsi.$getShipImage(ship);

This function will return a filename, which will be the wireframe image of the ship. "ship" in this instance refers to an in-game ship object (for instance, using "player.ship.target", or even "player.ship").

If no ship image is found, the function will return wsi_blank.png, which is a valid file but contains no image.

==Download==
Download [[Media:WireframeShipImages.oxz|WireframeShipImages.oxz]] (v1.11)

==License==
Creative Commons Attribution Non-Commercial Share-Alike 4.0 (https://creativecommons.org/licenses/by-nc-sa/4.0/)

==Version History==
1.11
* Added ships from Small Ships OXP.
* Added ships from Defence Rider Drones OXP.

1.10
* Added new ships from Feudal States.
* Added ships from Nephthys (alternate).

1.9
* Added extra station from Assassins Guild.

1.8
* Added "Dual Torus Station" entry.
* Added extra ships from Feudal States.
* Updated Hydra images.
* Added extra ships from Military Fiasco.
* Added ships from Oo-Haul.

1.7
* Updated Taxi Station.

1.6
* Added missing pirate cove key.

1.5
* Added image for PlanetFall2 Ground Control Interface points.

1.4
* Added more images.

1.3
* Added more images.

1.2
* Added new images and references for Assassins Guild Rebooted OXP.

1.1
* Cargo containers now have unique images.
* Metal fragments now have unique images.
* Wreckage now have unique images.
* Various other ship updates and tweaks.

1.0
* Initial release

== Links ==
*[https://bb.oolite.space/viewtopic.php?p=42386#p42386 First Wireframe ship] in Oolite ([[User:Griff|Griff]], 2007)
*[https://bb.oolite.space/viewtopic.php?t=3975 Wireframe Oolite]: Discussion about incorporation in the Vanilla game code (2007).

==Quick Facts==
{{OXPLevel|0}}{{IconOXP|ooVersion="1.80"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Low"|oxpIsAPI=true|oxpIsDocumented=true}}
{{Infobox OXPb| title = WireframeShipImages.oxz
|version = 1.11
|release = 2026-05-11
|license = CC BY-NC-SA 4.0
|features = Ship images
|category = Misc OXPs‏‎
|author = [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?t=21828 Oolite BB]
}}

File:WireframeShipImages.oxz

2026-05-11T12:54:37Z

Phkb: Phkb uploaded a new version of File:WireframeShipImages.oxz

Expanded Weapon Info

2026-05-11T12:53:39Z

Phkb:

[[File:Expanded Weapon Info OXP.png|right|thumb|400px|This OXP adds in the second green line at the bottom]]
==Overview==
This expansion pack aims to help players in search of a new laser, by putting core specification information on the F3 Ship Outfitting screen. This allows the player to compare lasers and make more informed decisions.

==Download==
Download [[Media:ExpandedWeaponInfo.oxz|ExpandedWeaponInfo.oxz]] v1.2 (downloaded {{#downloads:ExpandedWeaponInfo.oxz}} times).

==License==
Creative Commons Attribution Non-Commercial Share-Alike 4.0 (https://creativecommons.org/licenses/by-nc-sa/4.0/)

==Version History==
1.2
* Added extra weapons.

1.1
* Updated specifications based on user feedback.

1.0
* Initial release

== Quick Facts ==
{{OXPLevel}}{{IconOXP|ooVersion = "1.90"|oxpCPU = "Low"|oxpMEM = "Low"|oxpGPU = "Low"}}
{{Infobox OXPb| title = ExpandedWeaponInfo.oxz
|version = 1.2
|release = 2026-05-11
|license = CC BY-NC-SA 4.0
|features = Weapon Info
|category = Misc OXPs
|author = [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=21504 Oolite BB]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-green.png]]
[[Category:Oolite expansion packs]]
[[Category:Weapons OXPs‏‎]]

File:ExpandedWeaponInfo.oxz

2026-05-11T12:52:57Z

Phkb: Phkb uploaded a new version of File:ExpandedWeaponInfo.oxz

Ship Configuration OXP

2026-05-11T12:28:38Z

Phkb:

[[File:Ship Configuration F5 page.png|thumb|right|400px|F5 ''ship details'' screen showing extended list of ship equipment]]
[[File:Ship Configuration F3 page (1).png|thumb|right|400px|F3 screen (top level - white line at top enables access to configuration)]]
[[File:Ship Configuration F3 page (2).png|thumb|right|400px|F3 screen (second level - showing equipment categories) "Engines" from the third level are detailed in the next screen shot]]

==Special Notice==
''' This OXP makes significant changes to how the game works. ''' Please take the time to read the documentation before you install it.

==Overview==
This OXP aims to make the process of configuring your ship more deliberate. Instead of just adding more and more equipment without any implications, equipment will now use space, and the total weight of all equipment and cargo will have a bearing on performance. Decisions can now be made about how to best configure your ship for the role you want to play. If you want to configure your ship for trading, do you sacrifice engine performance or energy for cargo space? If you want to be a bounty hunter, what equipment do you swap out to make room for better shields, or do you change down to a beam laser to lighten the ship? Almost all equipment (including OXP equipment items) have space and weight considerations, and it is up to you to work out the best balance for the role you want to take.

===Factors===
*'''Space''': there is only so much space in your space-ship!

*'''Weight''': Weight increases result in slower turning rates (pitch, roll and yaw), and reduces the maximum speed.

*'''Heat''' also plays a more important role in gameplay. Firing your lasers continually will slowly heat up your ship, as will using your injectors, using the cloaking device, and being hit with a laser blast when your shields are down. Care needs to be taken so that your ship doesn't overheat.

:For instance, attempting to run away from an enemy ship on full injectors will heat up your ship to the point where you will begin to take damage.

*'''Breakability''': Note that almost all of this equipment apart from Electricity buses is now '''breakable'''.

==Important Note for New Players==
When you first load a saved game with this OXP installed, the calculated space for your installed equipment may require cargo space allocation. In this situation, any cargo in your hold may be removed. If the cargo needs to be removed to make way for equipment, it will be sold and the credits refunded to you.

==Equipment Space and Cargo Space==
Each ship has a standard amount of equipment space available to it, with a maximum of 40t in the largest ships. Once that space is filled, some cargo space can be re-allocated as equipment space. In ships with small cargo holds (less than 10t) all the cargo space can be reallocated as equipment space. For larger vessels, up to 75% of their cargo hold can be allocated, to a maximum of 40t. The process of allocating cargo space to equipment space is automatic - when you install a piece of equipment that exceeds the standard equipment space, cargo space will automatically be allocated. The following table provides details on how much equipment space is available:

<table><tr><td width="150">'''Ship type'''</td><td>'''Standard Equipment Space'''</td><td>'''Reallocated Cargo Space'''</td><td>'''Total'''</td></tr>
<tr><td>[[Adder_(Oolite)|Adder]]</td><td>15t</td><td>2t</td><td>17t</td></tr>
<tr><td>[[Anaconda_(Oolite)|Anaconda]]</td><td>40t</td><td>40t</td><td>80t</td></tr>
<tr><td>[[Asp_(Oolite)|Asp Mark II]]</td><td>30t</td><td>0t</td><td>30t</td></tr>
<tr><td>[[Boa_(Oolite)|Boa]]</td><td>30t</td><td>40t</td><td>70t</td></tr>
<tr><td>[[Boa_2_Class_Cruiser|Boa Class Cruiser]]</td><td>35t</td><td>40t</td><td>75t</td></tr>
<tr><td>[[Cobra_Mk.1_(Oolite)|Cobra Mark I]]</td><td>15t</td><td>10t</td><td>25t</td></tr>
<tr><td>[[Cobra_Mk.3_(Oolite)|Cobra Mark III]]1</td><td>20t</td><td>15t</td><td>35t</td></tr>
<tr><td>[[Cobra_Mk.3_(Oolite)|Cobra Mark III]]2</td><td>20t</td><td>26t</td><td>46t</td></tr>
<tr><td>[[Fer_de_Lance_(Oolite)|Fer-de-Lance]]</td><td>18t</td><td>12t</td><td>30t</td></tr>
<tr><td>[[Gecko_(Oolite)|Gecko]]</td><td>15t</td><td>3t</td><td>18t</td></tr>
<tr><td>[[Krait_(Oolite)|Krait]]</td><td>15t</td><td>2t</td><td>17t</td></tr>
<tr><td>[[Mamba_(Oolite)|Mamba]]</td><td>15t</td><td>4t</td><td>19t</td></tr>
<tr><td>[[Moray_Star_Boat_(Oolite)|Moray Star Boat]]</td><td>15t</td><td>7t</td><td>22t</td></tr>
<tr><td>[[Moray Medical Boat (Oolite)|Moray Medical Boat]]2</td><td>15t</td><td>11t</td><td>26t</td></tr>
<tr><td>[[Python_(Oolite)|Python]]</td><td>24t</td><td>40t</td><td>64t</td></tr>
<tr><td>[[Shuttle_(Oolite)|Orbital Shuttle]]</td><td>15t</td><td>22t</td><td>37t</td></tr>
<tr><td>[[Sidewinder_(Oolite)|Sidewinder]]</td><td>15t</td><td>0t</td><td>15t</td></tr>
<tr><td>[[Transporter_(Oolite)|Transporter]]</td><td>15t</td><td>12t</td><td>27t</td></tr>
<tr><td>[[Worm_(Oolite)|Worm]]</td><td>15t</td><td>5t</td><td>20t</td></tr></table>

1 Note: without cargo bay extension installed 
2 Note: with cargo bay extension installed.

The [[Ship_Comparison|Ship Comparison OXP]] will display the equipment space and convertible cargo space values for most ships in the game.

==Ship Configuration Screen==
To make changes to the configuration of your ship, go to the F3 Equip Ship screen and select the "Ship Configuration" item from the list.
[[File:Shipconfig_sample.png|500px|center|An example screenshot showing engine configuration options]]
At the top of the screen are a number of values which will change as you make configuration choices via the menus:

<table><tr><td width="200">'''Cash'''</td><td>This is your current credit balance</td></tr>
<tr><td>'''Equipment space'''</td><td>The first number is the total amount of equipment space currently in use. The amount in brackets is the total amount of equipment space currently available on the ship.</td></tr>
<tr><td>'''Cargo space allocation'''</td><td>The first number is the amount of cargo space currently being partitioned for equipment use. The amount in brackets is how much of the cargo hold can be partitioned for equipment use.</td></tr>
<tr><td>'''Total equipment weigh'''t</td><td>This is the total weight of all installed equipment items plus cargo.
<tr><td>'''Bus overload chance'''</td><td>This is the chance of encountering a bus overload situation with your current equipment loadout.</td></tr>
<tr><td></td><td></td></tr>
<tr><td>'''Thrust'''</td><td>This is the estimated maximum thrust your ship can achieve based on the current weight profile of your ship. The number in brackets is the standard thrust value for this ship as declared by the manufacturer.</td></tr>
<tr><td>'''Speed'''</td><td>This is the estimated maximum speed your ship can achieve based on the current weight profile of your ship. The number in brackets is the standard maximum speed value for this ship as declared by the manufacturer.</td></tr>
<tr><td>'''Pitch'''</td><td>This is the estimated maximum pitch value your ship can achieve based on the current weight profile of your ship. The number in brackets is the standard pitch value for this ship as declared by the manufacturer.</td></tr>
<tr><td>'''Roll'''</td><td>This is the estimated maximum roll value your ship can achieve based on the current weight profile of your ship. The number in brackets is the standard roll value for this ship as declared by the manufacturer.</td></tr></table>

As you make changes to various parts of your ship the values at the top of the screen will change to reflect the estimated performance.

The configuration of your ship is divided up into 13 main areas: Engines, Hyperdrive, Thrusters, Boosters, Energy, Shields (forward and aft), Fuel Injection, Fuel Scoops, Heat Shields, Armour (forward and aft) and Electrical. The electrical system comprises of the main electrical bus, plus couplings for engines, hyperdrive, thrusters, boosters, energy banks, and forward and aft shields. Weapons are still installed via the F3 Equip Ship interfaces, but as you will see, your weapon choices will have a bearing on the performance of your ship.

* Items in the list colored orange can be installed.
* Items in the list colored green are the ones currently installed. The negative value in the "Cost" column indicates the refund you will receive when this item is swapped out for another.
* Items in the list colored red are the ones currently installed, but are damaged. You should get this item repaired as soon as possible. You will only get 50% of the cost of the item if you replace it.
* Items in the list colored light grey can be installed, but are above the class level of the electrical coupling currently installed for that subsystem. There would be a risk of bus * overload by installing this item.
* Items in the list colored dark grey can be installed only when the electrical coupling for that subsystem is upgraded.

Please note that you must have sufficient credit to purchase a new item before any refund for existing equipment can be applied. The purchase happens before the refund, so you need to have enough credit for the purchase.

Note that some configurations are not possible at some stations. The techlevel for each configuration item is noted below.

===Engines===
Your engines control how fast your ship flies in normal space. Your level of thrust and maximum speed are dependant on your engines. When damaged, your thrust and speed will be reduced.

Your engines are linked to the fuel injector system - if your engines are damaged, your fuel injectors will not function.

There are 42 different classes of engine:
<table><tr><td width="100">'''Class 1A'''</td><td>-20% thrust, -7% speed below manufacturers specs, but only uses 1t of space, weighs 1t. (TL1)</td></tr>
<tr><td>'''Class 1B'''</td><td>-30% thrust, -3% speed below manufacturers specs, but only uses 1t of space, weighs 1t. (TL1)</td></tr>
<tr><td>'''Class 1C'''</td><td>-10% thrust, -10% speed below manufacturers specs, but only uses 1t of space, weighs 1t. (TL1)</td></tr>
<tr><td>'''Class 1D'''</td><td>-20% thrust, -7% speed below manufacturers specs, but only uses 0.5t of space, weighs 1t. (TL3)</td></tr>
<tr><td>'''Class 1E'''</td><td>-30% thrust, -3% speed below manufacturers specs, but only uses 0.5t of space, weighs 1t. (TL3)</td></tr>
<tr><td>'''Class 1F'''</td><td>-10% thrust, -10% speed below manufacturers specs, but only uses 0.5t of space, weighs 1t. (TL3)</td></tr>
<tr><td>'''Class 2A'''</td><td>Standard factory-fitted engines, achieves published levels of speed and thrust, uses 2t of space, weighs 2t. (TL1)</td></tr>
<tr><td>'''Class 2B'''</td><td>-10% thrust, +4% speed over manufacturers specs, uses 2t of space, weighs 2t. (TL1)</td></tr>
<tr><td>'''Class 2C'''</td><td>+10% thrust, -4% speed on manufacturers specs, uses 2t of space, weighs 2t. (TL1)</td></tr>
<tr><td>'''Class 2D'''</td><td>Standard factory-fitted engines, achieves published levels of speed and thrust, uses 1t of space, weighs 1t. (TL5)</td></tr>
<tr><td>'''Class 2E'''</td><td>-10% thrust, +4% speed over manufacturers specs, uses 1t of space, weighs 1t. (TL5)</td></tr>
<tr><td>'''Class 2F'''</td><td>+10% thrust, -4% speed on manufacturers specs, uses 1t of space, weighs 1t. (TL5)</td></tr>
<tr><td>'''Class 3A'''</td><td>Standard levels of thrust, +7% speed over manufacturers specs, uses 3t of space, weighs 3t. (TL4)</td></tr>
<tr><td>'''Class 3B'''</td><td>-10% thrust, +12% speed over manufacturers specs, uses 3t of space, weighs 3t. (TL4)</td></tr>
<tr><td>'''Class 3C'''</td><td>+10% thrust, +3% speed over manufacturers specs, uses 3t of space, weighs 3t. (TL4)</td></tr>
<tr><td>'''Class 3D'''</td><td>Standard levels of thrust, +7% speed over manufacturers specs, uses 1.5t of space, weighs 2t. (TL6)</td></tr>
<tr><td>'''Class 3E'''</td><td>-10% thrust, +12% speed over manufacturers specs, uses 1.5t of space, weighs 2t. (TL6)</td></tr>
<tr><td>'''Class 3F'''</td><td>+10% thrust, +3% speed over manufacturers specs, uses 1.5t of space, weighs 2t. (TL6)</td></tr>
<tr><td>'''Class 4A'''</td><td>+20% thrust, +10% speed over manufacturers specs, uses 4t of space, weighs 4t. (TL5)</td></tr>
<tr><td>'''Class 4B'''</td><td>+10% thrust, +15% speed over manufacturers specs, uses 4t of space, weighs 4t. (TL5)</td></tr>
<tr><td>'''Class 4C'''</td><td>+30% thrust, +5% speed over manufacturers specs, uses 4t of space, weighs 4t. (TL5)</td></tr>
<tr><td>'''Class 4D'''</td><td>+20% thrust, +10% speed over manufacturers specs, uses 2t of space, weighs 3t. (TL8)</td></tr>
<tr><td>'''Class 4E'''</td><td>+10% thrust, +15% speed over manufacturers specs, uses 2t of space, weighs 3t. (TL8)</td></tr>
<tr><td>'''Class 4F'''</td><td>+30% thrust, +5% speed over manufacturers specs, uses 2t of space, weighs 3t. (TL8)</td></tr>
<tr><td>'''Class 5A'''</td><td>+20% thrust, +15% speed over manufacturers specs, uses 6t of space, weighs 6t. (TL6)</td></tr>
<tr><td>'''Class 5B'''</td><td>+10% thrust, +20% speed over manufacturers specs, uses 6t of space, weighs 6t. (TL6)</td></tr>
<tr><td>'''Class 5C'''</td><td>+30% thrust, +10% speed over manufacturers specs, uses 6t of space, weighs 6t. (TL6)</td></tr>
<tr><td>'''Class 5D'''</td><td>+20% thrust, +15% speed over manufacturers specs, uses 3t of space, weighs 5t. (TL10)</td></tr>
<tr><td>'''Class 5E'''</td><td>+10% thrust, +20% speed over manufacturers specs, uses 3t of space, weighs 5t. (TL10)</td></tr>
<tr><td>'''Class 5F'''</td><td>+30% thrust, +10% speed over manufacturers specs, uses 3t of space, weighs 5t. (TL10)</td></tr>
<tr><td>'''Class 6A'''</td><td>+40% thrust, +20% speed over manufacturers specs, uses 8t of space, weighs 8t. (TL7)</td></tr>
<tr><td>'''Class 6B'''</td><td>+30% thrust, +25% speed over manufacturers specs, uses 8t of space, weighs 8t. (TL7)</td></tr>
<tr><td>'''Class 6C'''</td><td>+50% thrust, +15% speed over manufacturers specs, uses 8t of space, weighs 8t. (TL7)</td></tr>
<tr><td>'''Class 6D'''</td><td>+40% thrust, +20% speed over manufacturers specs, uses 4t of space, weighs 6t. (TL12)</td></tr>
<tr><td>'''Class 6E'''</td><td>+30% thrust, +25% speed over manufacturers specs, uses 4t of space, weighs 6t. (TL12)</td></tr>
<tr><td>'''Class 6F'''</td><td>+50% thrust, +15% speed over manufacturers specs, uses 4t of space, weighs 6t. (TL12)</td></tr>
<tr><td>'''Class 7A'''</td><td>+40% thrust, +30% speed over manufacturers specs, uses 10t of space, weighs 10t. (TL9)</td></tr>
<tr><td>'''Class 7B'''</td><td>+30% thrust, +35% speed over manufacturers specs, uses 10t of space, weighs 10t. (TL9)</td></tr>
<tr><td>'''Class 7C'''</td><td>+50% thrust, +25% speed over manufacturers specs, uses 10t of space, weighs 10t. (TL9)</td></tr>
<tr><td>'''Class 7D'''</td><td>+40% thrust, +30% speed over manufacturers specs, uses 5t of space, weighs 8t. (TL14)</td></tr>
<tr><td>'''Class 7E'''</td><td>+30% thrust, +35% speed over manufacturers specs, uses 5t of space, weighs 8t. (TL14)</td></tr>
<tr><td>'''Class 7F'''</td><td>+50% thrust, +25% speed over manufacturers specs, uses 5t of space, weighs 8t. (TL14)</td></tr></table>

Engines of class D, E and F will also contribute to cabin heat.

===Hyperdrive===
Hyperdrives control your ability to jump to other systems. When damaged the hyperdrive might start leaking fuel, or it may fail to engage, or if it does engage it might cause a mis-jump.

There are 4 different classes of hyperdrive:
<table><tr><td width="100">'''Class 1'''</td><td>Takes only 1t of space, but takes 30 seconds to initiate a jump. (TL1)</td></tr>
<tr><td>'''Class 2'''</td><td>Standard issue hyperdrive. Takes 2t of space, and takes 15 seconds to jump. (TL1)</td></tr>
<tr><td>'''Class 3'''</td><td>Takes 5t of space, and takes 10 seconds to jump. (TL7)</td></tr>
<tr><td>'''Class 4'''</td><td>Takes 8t of space, but only takes 5 seconds to jump. (TL13)</td></tr></table>

===Thrusters===
Your thrusters control your manoeuvrability, how fast your ship can pitch and roll. When damaged, your pitch and roll rates will be reduced.

There are 39 different classes of thrusters:
<table><tr><td width="100">'''Class 1'''</td><td>-5% pitch, -3% roll below manufacturers specs, but uses no space and only weighs 1t. (TL1)</td></tr>
<tr><td>'''Class 2A'''</td><td>Standard factory-fitted thrusters, uses 1t of space, weighs 2t. (TL1)</td></tr>
<tr><td>'''Class 2B'''</td><td>+2% pitch, -2% roll on manufacturers specs, uses 1t of space, weighs 2t. (TL1)</td></tr>
<tr><td>'''Class 2C'''</td><td>-2% pitch, +2% roll on manufacturers specs, uses 1t of space, weighs 2t. (TL1)</td></tr>
<tr><td>'''Class 2D'''</td><td>Standard factory-fitted thrusters, uses 0.5t of space, weighs 2t. (TL3)</td></tr>
<tr><td>'''Class 2E'''</td><td>+2% pitch, -2% roll on manufacturers specs, uses 0.5t of space, weighs 2t. (TL3)</td></tr>
<tr><td>'''Class 2F'''</td><td>-2% pitch, +2% roll on manufacturers specs, uses 0.5t of space, weighs 2t. (TL3)</td></tr>
<tr><td>'''Class 3A'''</td><td>+5% pitch, +5% roll over manufacturers specs, uses 2t of space, weighs 3t. (TL5)</td></tr>
<tr><td>'''Class 3B'''</td><td>+7% pitch, +3% roll over manufacturers specs, uses 2t of space, weighs 3t. (TL5)</td></tr>
<tr><td>'''Class 3C'''</td><td>+3% pitch, +7% roll over manufacturers specs, uses 2t of space, weighs 3t. (TL5)</td></tr>
<tr><td>'''Class 3D'''</td><td>+5% pitch, +5% roll over manufacturers specs, uses 1t of space, weighs 3t. (TL7)</td></tr>
<tr><td>'''Class 3E'''</td><td>+7% pitch, +3% roll over manufacturers specs, uses 1t of space, weighs 3t. (TL7)</td></tr>
<tr><td>'''Class 3F'''</td><td>+3% pitch, +7% roll over manufacturers specs, uses 1t of space, weighs 3t. (TL7)</td></tr>
<tr><td>'''Class 4A'''</td><td>+8% pitch, +8% roll over manufacturers specs, uses 3t of space, weighs 4t. (TL7)</td></tr>
<tr><td>'''Class 4B'''</td><td>+10% pitch, +6% roll over manufacturers specs, uses 3t of space, weighs 4t. (TL7)</td></tr>
<tr><td>'''Class 4C'''</td><td>+6% pitch, +10% roll over manufacturers specs, uses 3t of space, weighs 4t. (TL7)</td></tr>
<tr><td>'''Class 4D'''</td><td>+8% pitch, +8% roll over manufacturers specs, uses 1.5t of space, weighs 4t. (TL9)</td></tr>
<tr><td>'''Class 4E'''</td><td>+10% pitch, +6% roll over manufacturers specs, uses 1.5t of space, weighs 4t. (TL9)</td></tr>
<tr><td>'''Class 4F'''</td><td>+6% pitch, +10% roll over manufacturers specs, uses 1.5t of space, weighs 4t. (TL9)</td></tr>
<tr><td>'''Class 5A'''</td><td>+12% pitch, +12% roll over manufacturers specs, uses 4t of space, weighs 5t. (TL8)</td></tr>
<tr><td>'''Class 5B'''</td><td>+14% pitch, +10% roll over manufacturers specs, uses 4t of space, weighs 5t. (TL8)</td></tr>
<tr><td>'''Class 5C'''</td><td>+10% pitch, +14% roll over manufacturers specs, uses 4t of space, weighs 5t. (TL8)</td></tr>
<tr><td>'''Class 5D'''</td><td>+12% pitch, +12% roll over manufacturers specs, uses 2t of space, weighs 5t. (TL10)</td></tr>
<tr><td>'''Class 5E'''</td><td>+14% pitch, +10% roll over manufacturers specs, uses 2t of space, weighs 5t. (TL10)</td></tr>
<tr><td>'''Class 5F'''</td><td>+10% pitch, +14% roll over manufacturers specs, uses 2t of space, weighs 5t. (TL10)</td></tr>
<tr><td>'''Class 6A'''</td><td>+18% pitch, +18% roll over manufacturers specs, uses 6t of space, weighs 8t. (TL9)</td></tr>
<tr><td>'''Class 6B'''</td><td>+20% pitch, +16% roll over manufacturers specs, uses 6t of space, weighs 8t. (TL9)</td></tr>
<tr><td>'''Class 6C'''</td><td>+16% pitch, +20% roll over manufacturers specs, uses 6t of space, weighs 8t. (TL9)</td></tr>
<tr><td>'''Class 6D'''</td><td>+18% pitch, +18% roll over manufacturers specs, uses 3t of space, weighs 8t. (TL12)</td></tr>
<tr><td>'''Class 6E'''</td><td>+20% pitch, +16% roll over manufacturers specs, uses 3t of space, weighs 8t. (TL12)</td></tr>
<tr><td>'''Class 6F'''</td><td>+16% pitch, +20% roll over manufacturers specs, uses 3t of space, weighs 8t. (TL12)</td></tr>
<tr><td>'''Class 7A'''</td><td>+24% pitch, +24% roll over manufacturers specs, uses 8t of space, weighs 10t. (TL11)</td></tr>
<tr><td>'''Class 7B'''</td><td>+26% pitch, +22% roll over manufacturers specs, uses 8t of space, weighs 10t. (TL11)</td></tr>
<tr><td>'''Class 7C'''</td><td>+22% pitch, +26% roll over manufacturers specs, uses 8t of space, weighs 10t. (TL11)</td></tr>
<tr><td>'''Class 7D'''</td><td>+24% pitch, +24% roll over manufacturers specs, uses 4t of space, weighs 10t. (TL14)</td></tr>
<tr><td>'''Class 7E'''</td><td>+26% pitch, +22% roll over manufacturers specs, uses 4t of space, weighs 10t. (TL14)</td></tr>
<tr><td>'''Class 7F'''</td><td>+22% pitch, +26% roll over manufacturers specs, uses 4t of space, weighs 10t. (TL14)</td></tr></table>

Thrusters of class D, E and F will also contribute to cabin heat.

===Boosters===
Boosters provide a performance increase to both your engines and thrusters. The downside is that you risk overheating your ship if you run over a certain percentage of your maximum speed. For instance, if you have Class 2 boosters installed, which build up heat from 93% of your throttle, then running your engines at more than 93% of their maximum speed will result in your cabin temperature rising. A warning tone will sound and a console message will be displayed when your reach this point during acceleration. When damaged any increase to engine or thruster performance will be lost.

Boosters are only available from hi-tech worlds, and their cost is considerable.

There are 7 different classes of boosters:
<table><tr><td width="100">'''Class 1'''</td><td>+3% to speed, roll and pitch, uses 1t of space, heat buildup from 97% of throttle. (TL9)</td></tr>
<tr><td>'''Class 2'''</td><td>+6% to speed, roll and pitch, uses 2t of space, heat buildup from 93% of throttle. (TL10)</td></tr>
<tr><td>'''Class 3'''</td><td>+9% to speed, roll and pitch, uses 3t of space, heat buildup from 90% of throttle. (TL11)</td></tr>
<tr><td>'''Class 4'''</td><td>+12% to speed, roll and pitch, uses 4t of space, heat buildup from 87% of throttle. (TL12)</td></tr>
<tr><td>'''Class 5'''</td><td>+15% to speed, roll and pitch, uses 5t of space, heat buildup from 83% of throttle. (TL13)</td></tr>
<tr><td>'''Class 6'''</td><td>+18% to speed, roll and pitch, uses 6t of space, heat buildup from 80% of throttle. (TL14)</td></tr>
<tr><td>'''Class 7'''</td><td>+20% to speed, roll and pitch, uses 7t of space, heat buildup from 77% of throttle. (TL15)</td></tr></table>

===Energy===
Your ship uses energy to fire lasers, operate the ECM system, and powers a number of other systems on your ship. When your energy falls to zero and your ship is hit by an unshielded laser or missile, your ship will be destroyed. More energy means the ability to absorb more damage before destruction. If your energy banks are damaged, items like the naval energy unit and the extra energy unit (both of which control how fast your energy banks are recharged) will not function. When your energy banks are damaged they will begin to drain until you have only emergency reserves remaining. You should dock immediately for repairs.

Because energy banks are just additional energy storage compartments, and there are few complications with the technology, they can be installed and repaired at any station.

You can install up to 25 energy banks in your ship, if you have space. Each bank of energy uses 1t of space and weighs 1t.

Class "A" energy banks are available at TL13 stations or higher, for around double the cost of their standard class cousins. These energy banks utilise high-yield components to reduce the space required for each energy bank by half. That is, if a Class 9 energy bank uses 9t of space, a Class 9A energy bank will only use 4.5. The units will have the same weight, however.

Also, cabin heat will be increased when using Class "A" energy banks.

It is not possible to "mix-and-match" energy banks. You cannot have 1 set of class 4 energy banks, and another set of class 4A energy banks. They must all be of one type.

The [[Extra_Energy_Unit|Extra Energy Unit]] equipment item increases the rate at which your energy banks recharge. It uses 3t of space. 
The [[Naval_Energy_Unit|Naval Energy Unit]] equipment item also increases the rate at which your energy banks recharge. It uses 5t of space.

===Shields (Forward and Aft)===
Shields absorb energy from lasers and missiles. Without shields lasers and missiles can damage and cripple your ship. Stronger shields means you can deflect more attacks, but stronger shields take more space. If your shields are damaged, the shield booster or military shield enhancement will not function, and the benefits they supply (stronger shields that recharge faster) will be lost. If your shield is damaged, the energy will drain away until there is no shield strength at all.

However, you may decide to forgo the protection shields provide and remove them entirely. THIS IS NOT RECOMMENDED! GalCop advises all pilots to install shields as part of their standard setup. If you have either of the shield boosting equipment items installed, you will not be able to remove your shields. If you decide to remove your shields it is highly recommended that some form of armour is installed to compensate.

Apart from the option of removing your shields entirely, there are 5 different classes of shields:
<table><tr><td width="100">'''Class 1'''</td><td>Takes 64 points off the standard level of shields, but also reduces space to just 1t. (TL1)</td></tr>
<tr><td>'''Class 2'''</td><td>Standard, factory-fitted shields, uses 2t of space. (TL1)</td></tr>
<tr><td>'''Class 3'''</td><td>Adds 64 points to standard level of shields, uses 3t of space. (TL6)</td></tr>
<tr><td>'''Class 4'''</td><td>Adds 128 points to standard level of shields, uses 4t of space. (TL9)</td></tr>
<tr><td>'''Class 5'''</td><td>Adds 192 points to standard level of shields, uses 5t of space. (TL12)</td></tr></table>

The [[Shield_Boosters|Shield Booster]] equipment item adds 128 points to the shield strength. It uses 4t of space. 
The [[Military_Shield_Enhancement|Military Shield Enhancement]] equipment item adds a further 128 points to the shields, and increases the rate at which they recharge. It uses 6t of space.

Note that while the [[Shield_Boosters|Shield Booster]] and [[Military_Shield_Enhancement|Military Shield Enhancement]] have a cumulative effect (that is, if both are installed the total increase to the shields is 256 points), the various shield classes provide a single increase.

===Fuel Injection===
Fuel injection systems dump unused Quirium fuel into your engines, giving you a massive boost in speed. If your engines are damaged any fuel injection system will not function.

There are 4 different classes of fuel injection systems:
<table><tr><td width="100">'''Class 1'''</td><td>Burns 50% more fuel per second, and only provides half the speed boost of Class 2 injectors. Uses 0.5t of space. (TL5)</td></tr>
<tr><td>'''Class 2'''</td><td>Achieves manufacturers declared specifications with regard to fuel burn rate and speed boost. Uses 1t of space. (TL11)</td></tr>
<tr><td>'''Class 3'''</td><td>Burns 40% less fuel per second, and gives a 20% speed improvement over standard Class 2 injectors. Uses 2t of space. (TL12)</td></tr>
<tr><td>'''Class 4'''</td><td>Burns 60% less fuel per second, and gives a 40% speed improvement over standard Class 2 injectors. But uses 4t of space. (TL13)</td></tr></table>

===Fuel Scoops===
Fuel scoops give pilots a means of replenishing their fuel supply by scooping fuel gasses from the corona of the sun. Each fuel scoop contains an 'accumulator'. The fuel scoop accumulator is the storage area inside the scoop where gasses are held prior to being converted into fuel. The larger the accumulator, the faster fuel is scooped.

There are 4 classes of fuel scoop available, each one having a different accumulator size:
<table><tr><td width="100">'''Class 1'''</td><td>0.10 ly accumulator. Weighs 2t. This is the standard type of fuel scoop. (TL6)</td></tr>
<tr><td>'''Class 2'''</td><td>0.15 ly accumulator. Weigh6 4t. (TL7)</td></tr>
<tr><td>'''Class 3'''</td><td>0.20 ly accumulator. Weighs 6t. (TL9)</td></tr>
<tr><td>'''Class 4'''</td><td>0.25 ly accumulator. Weight 8t. (TL11)</td></tr></table>

===Heat Shields===
Heat shielding protects your ship when flying close to the sun when skimming fuel. Without shielding your ship will heat up quickly and equipment and cargo can be damaged. Heat shielding will keep your ship cooler for longer, allowing you to easily skim fuel without needing to retreat to a safe distance too often. If your heat shield is damaged your ship will be unprotected from the heat of the sun.

There are 4 different classes of heat shielding, none of which provide any protection from laser or missile attacks, but all of which add weight to your ship.
<table><tr><td width="100">'''Class 1'''</td><td>Adds 0.5 points to the ships base level of protection, but only adds 1t of weight. (TL3)</td></tr>
<tr><td>'''Class 2'''</td><td>Adds 1.0 point to the ships base level of protection. This is the general standard level of heat shielding. Adds 3t of weight. (TL5)</td></tr>
<tr><td>'''Class 3'''</td><td>Adds 1.5 points to the ships base level of protection. Adds 6t of weight. (TL8)</td></tr>
<tr><td>'''Class 4'''</td><td>Adds 2.0 points to the ships base level of protection. Adds 9t of weight. (TL11)</td></tr>
<tr><td>'''Class 5'''</td><td>Adds 2.5 points to the ships base level of protection. Adds 12t of weight. (TL12)</td></tr>
<tr><td>'''Class 6'''</td><td>Adds 3.0 points to the ships base level of protection. Adds 16t of weight. (TL13)</td></tr></table>

Note: If your ship comes equipped with manufacturer-fitted heat insulation above the industry standard level of 1.0, then installing additional heat shielding will effectively increase your total value. For instance, if your ship comes with a standard level of 6, and you install class 4 heat shields, your effective heat insulation rating is 10.

===Armour (Forward and Aft)===
Adding armour to your ship can help protect the sensitive equipment contained within when your shields have fallen. Armour can be added to either the front or aft sections of your ship, and you can install different classes of armour in each section.

In total, there are 7 classes of armour you can add to your ship, each with difference weight, strength and damage points.
<table><tr><td width="100">'''Class 1'''</td><td>Lightweight carbon-polymer coating. Armour strength of 100, damage point 85%. Weighs only 2t. (TL3)</td></tr>
<tr><td>'''Class 2'''</td><td>Lightweight aluminium plating. Armour strength 125, damage point 80%. Weighs 7t. (TL5)</td></tr>
<tr><td>'''Class 3'''</td><td>Polycarbonate casing. Armour strength 150, damage point 75%. Weighs 15t. (TL6)</td></tr>
<tr><td>'''Class 4'''</td><td>Composite material. Armour strength 175, damage point 70%. Weighs 25t. (TL8)</td></tr>
<tr><td>'''Class 5'''</td><td>Plasteel plating. Armour strength 200, damage point 60%. Weighs 40t. (TL9)</td></tr>
<tr><td>'''Class 6'''</td><td>Durasteel plating. Armour strength 300, damage point 50%. Weighs 52t. (TL11)</td></tr>
<tr><td>'''Class 7'''</td><td>Titanium plating. Armour strength 400, damage point 40%. Weighs 70t. (TL13)</td></tr></table>

The strength of the armour defines how well the armour will stand up to attack. When lasers strike unshielded armour, the strength value defines how much of the armour will be depleted. Higher strength values will mean less armour is removed.

The damage point of the armour is the point at which damage to internal components will potentially start to occur. A rating of 85% means that the armour can withstand 15% of damage with no chance that damage will be passed on to equipment. When damage falls below 85%, the chance that equipment will be damaged increases.

===Electrical===
The electrical subsystem of your ship consists of a main electrical bus, onto which each secondary system connects via a coupling. There are 7 classes of main bus, and different classes of coupling for each secondary system.

High class level electrical buses are expensive and weigh a considerable amount. Most ships come equipped with at least class 2 electrical buses as standard.

Electrical bus items cannot be damaged. If inappropriate couplings and buses are used and bus overload occurs, damage is instead passed through to any equipment using the bus.

Fuel injectors are powered through the main engine, the engine's power coupling applies to the fuel injectors. 
Heat shields are not powered, so do not require a coupling to the electrical system.

====Main Electrical Bus====
<table><tr><td width="100">'''Class 1'''</td><td>Can service class 1 couplings. No additional space requirements, and weighs only 1t. (TL1)</td></tr>
<tr><td>'''Class 2'''</td><td>Can service up to class 2 couplings. No additional space requirements, weighs 4t. (TL1)</td></tr>
<tr><td>'''Class 3'''</td><td>Can service up to class 3 couplings. Uses 2t of space, weighs 7t. (TL5)</td></tr>
<tr><td>'''Class 4'''</td><td>Can service up to class 4 couplings. Uses 4t of space, weighs 12t. (TL7)</td></tr>
<tr><td>'''Class 5'''</td><td>Can service up to class 5 couplings. Uses 6t of space, weighs 20t. (TL9)</td></tr>
<tr><td>'''Class 6'''</td><td>Can service up to class 6 couplings. Uses 8t of space, weighs 30t. (TL11)</td></tr>
<tr><td>'''Class 7'''</td><td>Can service up to class 7/8 couplings. Uses 10t of space, weighs 42t. (TL13)</td></tr></table>

====Engine Power Couplings:====
<table><tr><td width="100">'''Class 1'''</td><td>Can service class 1 engines. Weighs 0.1t. (TL1)</td></tr>
<tr><td>'''Class 2'''</td><td>Can service up to class 2 engines. Weighs 0.2t. (TL1)</td></tr>
<tr><td>'''Class 3'''</td><td>Can service up to class 3 engines. Weighs 0.3t. (TL4)</td></tr>
<tr><td>'''Class 4'''</td><td>Can service up to class 4 engines. Weighs 0.4t. (TL5)</td></tr>
<tr><td>'''Class 5'''</td><td>Can service up to class 5 engines. Weighs 0.5t. (TL6)</td></tr>
<tr><td>'''Class 6'''</td><td>Can service up to class 6 engines. Weighs 0.6t. (TL7)</td></tr>
<tr><td>'''Class 7'''</td><td>Can service up to class 7 engines. Weighs 0.7t. (TL9)</td></tr></table>

====Hyperdrive Power Couplings:====
<table><tr><td width="100">'''Class 1'''</td><td>Can service class 1 hyperdrives. Weighs 0.1t. (TL1)</td></tr>
<tr><td>'''Class 2'''</td><td>Can service up to class 2 hyperdrives. Weighs 0.2t. (TL1)</td></tr>
<tr><td>'''Class 3'''</td><td>Can service up to class 3 hyperdrives. Weighs 0.3t. (TL7)</td></tr>
<tr><td>'''Class 4'''</td><td>Can service up to class 4 hyperdrives. Weighs 0.4t. (TL12)</td></tr></table>

====Thruster Power Couplings:====
<table><tr><td width="100">'''Class 1'''</td><td>Can service class 1 thrusters. Weighs 0.1t. (TL1)</td></tr>
<tr><td>'''Class 2'''</td><td>Can service up to class 2 thrusters. Weighs 0.2t. (TL1)</td></tr>
<tr><td>'''Class 3'''</td><td>Can service up to class 3 thrusters. Weighs 0.3t. (TL5)</td></tr>
<tr><td>'''Class 4'''</td><td>Can service up to class 4 thrusters. Weighs 0.4t. (TL7)</td></tr>
<tr><td>'''Class 5'''</td><td>Can service up to class 5 thrusters. Weighs 0.5t. (TL8)</td></tr>
<tr><td>'''Class 6'''</td><td>Can service up to class 6 thrusters. Weighs 0.6t. (TL9)</td></tr>
<tr><td>'''Class 7'''</td><td>Can service up to class 7 thrusters. Weighs 0.7t. (TL11)</td></tr></table>

====Booster Power Couplings:====
<table><tr><td width="100">'''Class 1'''</td><td>Can service class 1 boosters. Weighs 0.1t. (TL1)</td></tr>
<tr><td>'''Class 2'''</td><td>Can service up to class 2 boosters. Weighs 0.2t. (TL1)</td></tr>
<tr><td>'''Class 3'''</td><td>Can service up to class 3 boosters. Weighs 0.3t. (TL5)</td></tr>
<tr><td>'''Class 4'''</td><td>Can service up to class 4 boosters. Weighs 0.4t. (TL7)</td></tr>
<tr><td>'''Class 5'''</td><td>Can service up to class 5 boosters. Weighs 0.5t. (TL8)</td></tr>
<tr><td>'''Class 6'''</td><td>Can service up to class 6 boosters. Weighs 0.6t. (TL9)</td></tr>
<tr><td>'''Class 7'''</td><td>Can service up to class 7 boosters. Weighs 0.7t. (TL11)</td></tr></table>

====Energy Bank Power Couplings:====
<table><tr><td width="100">'''Class 1'''</td><td>Can service up to class 4 energy banks. Weighs 0.1t. (TL1)</td></tr>
<tr><td>'''Class 2'''</td><td>Can service up to class 7 energy banks. Weighs 0.2t. (TL1)</td></tr>
<tr><td>'''Class 3'''</td><td>Can service up to class 10 energy banks. Weighs 0.3t. (TL1)</td></tr>
<tr><td>'''Class 4'''</td><td>Can service up to class 13 energy banks. Weighs 0.4t. (TL1)</td></tr>
<tr><td>'''Class 5'''</td><td>Can service up to class 16 energy banks. Weighs 0.5t. (TL1)</td></tr>
<tr><td>'''Class 6'''</td><td>Can service up to class 19 energy banks. Weighs 0.6t. (TL1)</td></tr>
<tr><td>'''Class 7'''</td><td>Can service up to class 22 energy banks. Weighs 0.7t. (TL1)</td></tr>
<tr><td>'''Class 8'''</td><td>Can service up to class 25 energy banks. Weighs 0.8t. (TL1)</td></tr></table>

====Forward/Aft Shield Power Couplings:====
<table><tr><td width="100">'''Class 1'''</td><td>Can service class 1 shields. Weighs 0.1t. (TL1)</td></tr>
<tr><td>'''Class 2'''</td><td>Can service up to class 2 shields. Weighs 0.2t. (TL1)</td></tr>
<tr><td>'''Class 3'''</td><td>Can service up to class 3 shields. Weighs 0.3t. (TL6)</td></tr>
<tr><td>'''Class 4'''</td><td>Can service up to class 4 shields. Weighs 0.4t. (TL9)</td></tr>
<tr><td>'''Class 5'''</td><td>Can service up to class 5 shields. Weighs 0.5t. (TL12)</td></tr></table>

====Bus Overload====
You can install equipment at +1 class level over the level of the coupling, which in turn can be +1 class level over your main bus. However, running equipment over the coupling or bus class levels runs the risk of energy damage being passed through to equipment, even with full shield strength. If a bus overload occurs, damage can be passed on to '''any''' equipment item, not just the core systems.

==Equipment Space Extensions==
In high-tech worlds you can purchase an equipment space extension that does not use cargo space. This involves some reconfiguration of existing equipment racks to allow the extension to be fitted. Only small-to-medium-sized ships can have these extensions fitted, and while more than one can be fitted, there is a maximum allowance of two extensions in any ship.

The extensions come in the following sizes:
<table><tr><td width="70">1t</td><td>Adds 3t of weight (TL11)</td></tr>
<tr><td>2t</td><td>Adds 5t of weight (TL12)</td></tr>
<tr><td>5t</td><td>Adds 10t of weight (TL13)</td></tr></table>

Note: Because equipment extensions result in a more tightly arranged configuration of your equipment, there will be a noticeable increase in cabin temperature when these items are installed.

==Selling Equipment==
An interface has been provided where all equipment that takes space or weight can be sold and removed from your ship. Only equipment items that do not have dependant items can be sold (eg. you can't sell the Extra Energy Unit if you have the Naval Energy Unit installed, you can't sell a passenger berth if you have a passenger inside it). Selling equipment can reduce the equipment space required as well as reducing weight profile of your ship. The sale price of equipment is 85% of the original price.

==Storing Equipment and Cargo==
As an alternative to selling the equipment, every main station has a self-storage facility into which your excess equipment can be transferred. If you choose to store equipment, an F4 interface screen, "Storage facility management", will be available that will show you all the equipment you have stored at this station or any other station. Equipment stored in the current station can be either sold or reinstalled. Equipment stored in other stations can be sold or transferred to the current station, after paying a transfer fee, but depending on the length of the trip and the number of dangerous systems the transfer ship must take to reach the current system, you may end up losing the equipment.

Most cargo can also be stored in the facilities, and transferred between them. After selecting "Storage facility management", you will have an option to transfer cargo from your hold into the facility.

Note: Storage facilities are only available at the main station in each system. If you dock at any other station the F4 interface screen will instead read "Storage facility information" and will provide details of what equipment and cargo you have in storage at the main station.

Note: It is not possible to store upgrades to engines, thrusters, boosters, hyperdrive, shields, or any electrical equipment. Storage of these items is prohibited by station authorities due to safety considerations, as some untrained and unskilled pilots have taken it upon themselves to reinstall their equipment outside of station oversight with unfortunate results.

Note: Slaves, firearms and narcotics cannot be stored in any facility, by GalCop law.

==Current Equipment List==
This option lists all items installed in your ship that have either a space or weight requirement on your ship. The list is ordered with the largest items at the top, so you can always see what equipment is taking up the most space.

==Equipment Specifications==
A new interface is now available on the F4 screen, entitled "View equipment specifications". This interface screen lists all possible equipment items available to the player, and the tech level, space and weight requirements of each item. Note, however, these items may or may not be available for purchase at your station, or indeed even in the system. These items are purely available somewhere in the galaxy, and the list explains what you can expect in terms of space and weight.

The following table lists all the standard equipment and the space/weight requirements for each:

<table><tr><td width="200">'''Equipment Item'''</td><td width="70">'''Space'''</td><td>'''Weight'''</td></tr>
<tr><td>[[Missile|Standard Missile]]</td><td>0.0t</td><td>0.1t</td></tr>
<tr><td>[[ECM_Hardened_Missile|ECM-Hardened Missile]]</td><td>0.0t</td><td>0.3t</td></tr>
<tr><td>[[Quirium_Cascade_Mine|Quirium Cascade Mine]]</td><td>0.0t</td><td>0.2t</td></tr>
<tr><td>[[Pulse_Laser|Pulse Laser]]</td><td>0.0t</td><td>1.0t</td></tr>
<tr><td>[[Beam_Laser|Beam Laser]]</td><td>0.0t</td><td>2.0t</td></tr>
<tr><td>[[Mining_Laser|Mining Laser]]</td><td>0.0t</td><td>1.5t</td></tr>
<tr><td>[[Military_Laser|Military Laser]]</td><td>0.0t</td><td>3.0t</td></tr>
<tr><td>[[E.C.M._System|E.C.M. System]]</td><td>1.0t</td><td>1.0t</td></tr>
<tr><td>[[Cargo_Bay_Expansion|Large Cargo Bay]]</td><td>0.0t</td><td>5.0t</td></tr>
<tr><td>[[Fuel_Scoops|Fuel Scoops]]</td><td>0.0t</td><td>2.0t</td></tr>
<tr><td>[[Escape_Pod|Escape Pod]]</td><td>0.0t</td><td>1.0t</td></tr>
<tr><td>[[Extra_Energy_Unit|Extra Energy Unit]]</td><td>3.0t</td><td>3.0t</td></tr>
<tr><td>[[Naval_Energy_Unit|Naval Energy Unit]]</td><td>5.0t</td><td>5.0t</td></tr>
<tr><td>[[Docking_Computers|Docking Computer]]</td><td>1.0t</td><td>1.0t</td></tr>
<tr><td>[[Galactic_Hyperdrive|Galactic Hyperdrive]]</td><td>1.0t</td><td>1.0t</td></tr>
<tr><td>[[Cloaking_device|Cloaking Device]]</td><td>1.0t</td><td>1.0t</td></tr>
<tr><td>[[Advanced_Space_Compass|Advanced Space Compass]]</td><td>0.0t</td><td>1.0t</td></tr>
<tr><td>[[Wormhole_Scanner|Wormhole Scanner]]</td><td>0.0t</td><td>1.0t</td></tr>
<tr><td>[[Shield_Boosters|Shield Boosters]]</td><td>4.0t</td><td>4.0t</td></tr>
<tr><td>[[Military_Shield_Enhancement|Military Shield Enhancement]]</td><td>6.0t</td><td>6.0t</td></tr></table>

Any standard equipment item not in this list will have zero space and weight requirements.

Most OXP equipment has been categorised individually. If an item is not recognised by the system, it will assume a value of 1t of space, and 1t of weight. The spreadsheet file provided with the game package, "EquipmentSpecifications.ods" (OpenDocument format) contains a list of all known OXP equipment item keys and related space/weight requirements, as well as a list of all equipment keys that are considered to have no space/weight factor at all.

==Cabin Temperature and Heat Sinks==
A number of different activities and events will now impact on cabin temperature. These are:
* Use of your hyperdrive
* Laser temperature
* Use of fuel injectors
* Use of cloaking device
* Laser hits on an unshielded hull
* Running your ship with an overloaded electrical bus

Each of these things on their own probably won't cook your ship, but if you combine two or three of them at the same time you can expect to see your cabin temperature reach dangerous levels quickly.

Therefore care must be taken to (a) select appropriate lasers, engines and thrusters for the roles you want to perform, and (b) be careful how you use your lasers, fuel injectors and the cloaking device to avoid overheating your cabin and potentially causing catastrophic damage to your ship.

Note: Entering hyperspace with high levels of heat increases your chance of having a misjump.

To help with controlling cabin temperature, heat sinks can be purchased at all tech level 2 systems and above. You can purchase several heat sinks, but each one takes up 1t of cargo space, and adds 2t of weight.

To deploy a heat sink, first prime the "Heat Sink Control" item by using the Shift-N key sequence, then press "N" to activate it. Up to approximately 25% of your cabin temperature can be jettisoned in this way, dependant on the size of your ship. For larger ships this value will be closer to 10%.

You can also set the heat sink control to automatically deploy heat sinks whenever your cabin temperature reaches 75% of maximum. To do this, prime the "Heat Sink Control" and then select "B" to change the mode from "Manual control" to "Automatic control".

Heat sinks can be damaged, and cannot be used when in a damaged state.

Heat Shields also help with cabin heat. Higher levels of heat shield will slow the rate at which cabin temperature builds up.

===Heat Sink Availability===
Techlevel: 2
Price: 30 cr.
==3rd Party Interfaces==
===Ships===
====Equipment Space and Power to Weight Ratio====
Overriding the calculation of equipment space and the power to weight ratio for a particular ship can be done in two ways.

'''1. Via Javascript''' 
To add an override for a particular ship type, add the code to a "startUp" script similar to the following:

var sc = worldScripts.ShipConfiguration_Core;
if (sc) {
sc._shipSpaceExceptions["Fer-de-Lance"] = [18];
sc._shipPowerToWeight["Fer-de-Lance"] = [1.5];
}

'''2. Via scriptInfo in shipdata.plist''' 
To add an override directly in the shipdata.plist file, add the following lines to the "script_info" section:

"script_info" = {
"equipment_space" = 18; // how much default equipment space the ship has
"power_to_weight" = 1.5; // how powerful is the ship compared to its weight?
// default of 1, values of 2 or above will mean weight doesn't have as much effect
};

(You can change the "18" and "1.5" to whatever value is appropriate for the ship).

====Non-standard primary roles====
If your ship is only ever spawned with a non-standard role (ie. your ship doesn't have one of the core roles attached to it when it is spawned), by default the ship will be given the standard, default level of equipment. However, you can still have the appropriate level of equipment for your ship by adding your unique ship role to the translation list in either of the following ways:

'''1. Via Javascript''' 
To add a translation for your primary role, add this code to a "startUp" script similar to the following:

var sc = worldScripts.ShipConfiguration_Core;
if (sc) {
// make the primary role "my_ship_role" be equivalent to the core role "trader"
sc._NPCEquivalents["my_ship_role"] = "trader";
}

'''2. Via scriptInfo in shipdata.plist''' 
To add an override directly in the shipdata.plist file, add the following lines to the "script_info" section:

"script_info" = {
// make the primary role "my_ship_role" be equivalent to the core role "trader"
"role_translation" = "my_ship_role|trader";
};

===Equipment===
Overriding the definition of equipment space and weight for a particular piece of equipment can be done in two ways.

'''1. Via Javascript''' 
Add the following code to a "startUp" script:

var sc = worldScripts.ShipConfiguration_Core;
if (sc) sc._equipmentMatrix["EQ_MY_EQUIPMENT_KEY"] = [2.0,2.0];

The first value is space, the second is weight, both in tons.

'''2. Via scriptInfo in equipment.plist''' 
To add an override directly in the equipment.plist file, add the following lines to the "script_info" section:

"script_info" = {
"equipment_space" = 2.0; // value in tons
"equipment_weight" = 2.0; // value in tons
};

Setting both values to zero will mean the equipment is ignored by the system.

Standard logic:
* Missiles take no space, but weigh at least 0.1t.
* Pylon mounted items take no space, but add weight.
* Equipment that uses cargo space won't use equipment space, but weight might not be 1:1. That is, a 5t cargo spot might weigh 8t.
* Weapons (lasers) generally take no space, but increasing power and/or range means more weight. Uber weapons (designed for capital ships) may actually use equipment space.

===Equipment Heat===
It is possible to add a heat value into the heat calculation for when OXP equipment is in operation by using the "player.ship.script.$addHeat" and player.ship.script.$removeHeat" methods. The following script should be used as a template for OXP equipment scripts:

"use strict";
this.name = "MyEquipmentOXP_ScriptName";
this.description = "Activation and control script for equipment with heat properties.";
this.licence = "CC BY-NC-SA 3.0";

this._inOperation = false;
// the equipment may use a different method for determining when it is engaged or not.
this._heatAmount = 0.8;
// centralised value for heat exchange
// 0.8 will make the cabin temp rise very slowly.
// lower numbers may not be visible on their own.
// ie if this is the only piece of equipment generating heat.
// higher numbers will make heat rise more quickly.

this.playerWillEnterWitchspace = function() {
// assuming the equipment will cease operation during a jump
if (this._inOperation == true) {
this._inOperation = false;
if (player.ship.script.thirdPartyHeat > 0)
player.ship.script.$removeHeat(this._heatAmount);
}
}

this.equipmentDamaged = function(equipKey) {
if (equipKey == "EQ_MY_EQUIPMENT_KEY" && this._inOperation == true &&
player.ship.script.thirdPartyHeat > 0) {
this._inOperation = false;
if (player.ship.script.thirdPartyHeat > 0)
player.ship.script.$removeHeat(this._heatAmount);
}
}

this.activated = function() {
// assuming the equipment is started and stopped by the "n" Activate key
if (this._InOperation == true) {
this._inOperation = false;
if (player.ship.script.thirdPartyHeat > 0)
player.ship.script.$removeHeat(this._heatAmount);
return;
}
this._inOperation = true;
if (player.ship.script.thirdPartyHeat >= 0)
player.ship.script.$addHeat(this._heatAmount);
}

==Special Note==
Parts of this OXP borrows heavily from Capt Murphy's set of [[Breakable_'Standard'_Equipment_OXPs|Breakable equipment OXP's]], specifically:
* Breakable Energy Unit
* Breakable Engines
* Breakable Shield Generators
* Breakable Witchdrive
Most of the logic from those OXP's is incorporated in this OXP, and therefore those OXP's have been flagged as incompatible with this one. To use this OXP you must remove those OXP's from your AddOns folder, or via the in-game manager.

==Requirements==
The [[Equipment Storage OXP]] is a requirement for this pack. 
The Ship's Library OXP is also a requirement, so the Handbook can be viewed in game.

==Download==
Download [[Media:ShipConfiguration.oxz|ShipConfiguration.oxz]] v1.5.5 (downloaded {{#downloads:ShipConfiguration.oxz}} times). 
Download [https://app.box.com/s/h2ryncdmcjlt5vndkf88k94swmlcwpp0 ShipConfiguration.zip] v1.5.5 (extract OXP folder to AddOns)

==License==
This OXP is released under the Creative Commons Attribution - Non-Commercial - Share Alike 3.0 license. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/

Thanks to Redspear, Norby, Devium, Venator Dha, Day, Ngalo, Astrobe and tsoj for their excellent suggestions and testing reports. 
Special thanks to Capt Murphy for his excellent set of Breakable equipment OXP's, the logic for which I have incorporated in this OXP. 
Also thanks go to Thargoid for his IronHide armour code, which I've borrowed code from, as well as CommonSenseOTB's Custom Shields. You guys rock!

Rocket image from http://simpleicon.com/rocket.html 
Themometer image from http://simpleicon.com/temperature_3.html 
Chat image from http://simpleicon.com/chat-2.html 
Grating image courtesy of Milosh Andrich (Iratemus@yahoo.com) from http://milosh--andrich.deviantart.com/art/Sci-fi-Texure-pack-05-335817650 
Heat sink deployed sound from "Big Door Closed" MP3, sourced from http://soundbible.com/1586-Big-Door-Closed.html Public Domain. 
Booster heat warning sound from "School Fire Alarm" MP3, sourced from http://soundbible.com/2022-School-Fire-Alarm.html Attribution 3.0

==Other Relevant OXPs==
*The [[Vimana-X HUD]] has been modified to easily manage the heat sink

==Version History==
1.5.5
* Extra protection against NaN values when determining direction of attack on NPC's.
* Fixed conflict with Manual Witchspace Alignment, where heat build up could increase continually if a witchspace jump is manually cancelled when not aligned.

1.5.4
* Darkened overlay images for better compatibility with Oolite 1.92.

1.5.3
* Fixed reference error in equipment damage process.
* Update overlay images for 1.91.

1.5.2
* Added some additional equipment items.
* Added option to suppress/hide the Equipment Specifications F4 interface screen.
* Fixed issue where older HUD's that don't define certain HUD elements would have the comms log and console log positions changed on launch after visiting the F3 Equip Ship screen.

1.5.1
* Fixed bug where damage to heat shielding would make the cabin temperature zero degrees (brrrr).
* Fixed issue where yaw performance was not being impacted by the type of thruster installed.

1.5
* Added "Ship Configuration Handbook" to the Ship's Library (which is now a requirement).
* Moved all text into descriptions.plist or missiontext.plist for easier localisation.
* Sound now plays when a fuel leak occurs.
* Improved method of turning HUD on/off.
* Fixed issue where sometimes equipment of the same type isn't removed when purchasing new items.

1.4.4
* Small improvements to application of armour and booster variables to ship object.
<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">
1.4.3
* Fixed invalid JS function name.

1.4.2
* Added some additional items to the ignore equipment list.

1.4.1
* Fixed issue for ships of mass > 500000, where dumping heat sinks would increase cabin temp instead of reducing it.

1.4.0
* Added check for situation where the heat sync control mode becomes out of sync with the associate equipment item.
* Added two missing flags from config options to save game, so they will be restored on game load.
* Overridden default equipment items (Fuel Scoops, Heat Shields and Fuel Injectors), when added by other means, were not getting the additional Ship Configuration item at the same time.
* Fix for code that calculates the weight of weapons when no predefined weight is set (Oolite 1.90 now required).
* Moved core equipment overrides into defined plist.
* Added interface to allow 3rd party functions to be called back when Ship Config equipment is purchased.
* Bug fixes.

1.3.8
* Added ShipVersion equipment items to exclusion lists.
* Fixed some issues where JS errors could occur if the player ship was destroyed.

1.3.7
* Corrected compatibility issue with Email system and armour repair items being recorded as equipment removals.

1.3.6
* Deploying the last heatsink was causing Oolite to crash.
* Fixed issue where HUD was not being restored after viewing the Ship Configuration screen.

1.3.5
* Tweaks to the control of the F3 HUD for simpler integration with Xenon HUD (and any other HUD that might want to integrate with Ship Config).
* Identified "Masslock Compensators", "Power to Engines" and "Hard Way" OXP's as conflicting, and marked them in the manifest.

1.3.4
* Better use of new functions available in later versions of Oolite.

1.3.3
* Correction to cabin heat buildup calculation broken by update 1.3.2 :(

1.3.2
* Adjusted what happens to cabin heat in a nova system, to make it less deadly.
* More fixes for improved compatibility with Coluber CH01 HUD.

1.3.1
* Fixed issue with the F3 HUD occasionally causing issues with Xenon UI and the Coluber CH01 HUD.
* Tweaks to some equipment item names to prevent text overlapping on the F5 screen.

1.3.0
* Equipment storage system made into [[Equipment_Storage_OXP|separate OXP]], which is required by this one.

1.2.8
* Bug fixes.

1.2.7
* Ship energy is set to ship max energy whenever this value is updated.
* Tweaks to info string for settings in Library Config, to prevent text truncation.
* Updates to some zoom override values.
* Improved script protection for when the player ejects.
* Improved compatibility with [[Fuel Injection Cruise Control]] OXP.

1.2.6
* Starting the docking computer while a hyperspace countdown is active will now successfully disengage the heat buildup.
* Cancelling and then restarting a jump countdown will now display the correct restart time value immediately when restarted.
* Fixed issue with current page number on equipment specifications screen.
* Fixed issue where selling equipment from storage was giving player a credit bonus in some circumstances.
* Fixed issue with "%%" appearing in messages relating to transferred equipment being lost to pirates.
* Fixed issue where selling equipment was not applying correct refund percentage.
* Added missing "+heat" notice for Class 19A energy banks.
* Location of stored equipment was not being displayed correctly after equipment transferred to local system.
* Added flag to Library Config to control whether restrictions will be applied to NPC ships.

1.2.5
* Specialised HUD for the F3 screen will now only update the two custom HUD properties when the F3 screen is displayed.

1.2.4
* Equipment that cannot be sold at a station because of its equivalent tech level will now be displayed in the sell equipment list, but unselectable and with "Low TL" in the cost column.
* Equipment that cannot be sold because other equipment depends on it will now be displayed in the sell equipment list, but unselectable and with "Required" in the cost column.
* Fixed bug with assessing cargo space of unknown equipment items that take up cargo space.
* More script protection for when the player ship is destroyed.
* Code refactoring.

1.2.3
* Adjusted equipment space of Night Adder.

1.2.1
* Removed debug message when selling equipment.
* Fixed HUD switching issue when using HUD Selector.

1.2.0
* Improved handling of player ship death scenarios.
* Added extra equipment items to the ignore equipment list.
* Added specialised HUD for the F3 screen to show equipment and cargo space remaining. Can be disabled via Library Config.
* Updated EquipmentSpecifications.ods file with all current equipment keys specifically recognised.
* Value for "Disable booster sound" setting now saved between sessions.

1.1.3
* Fixed transmit date on Storage Facility payment emails.
* Bug fixes.

1.1.2
* Fixed issue with missing header text on Ship Configuration main menu.
* Adjusted default equipment space for Fer-de-Lance.
* Fixed some invalid ship reference errors during an escape pod sequence.
* Extended the length of time cabin heat warning messages are displayed for.
* Storing equipment for the first time at a station will now incur a deposit fee.
* Fixed issue with cargo weight/space not being including in storage costs.
* Fixed issue with incorrect/misleading labels on cargo storage menu items.
* Code refactoring.

1.1.1
* Fixed bug that was preventing weapon in a starboard mount from being sold.

1.1.0
* Fixed bugs with incorrect amounts being refunded to the player when equipment is sold.
* Fixed issue with incorrect refund amounts being displayed to the player on the "Sell Equipment" page.
* Fixed issue where the ship size price factor was being incorrectly applied to fuel scoops, injectors and heat shields, and all other standard or OXP equipment items on the "Sell Equipment" page.
* Equipment items can only be sold at stations where the can actually be bought as well.
* Non-removable Ship Config equipment (eg Engines, Thrusters), when swapped for another unit, will only refund the price of that unit at the main station, to prevent exploitation.
* Station equipment price factor was not being correctly applied to equipment buy/sell prices.
* Better handling of player ship destruction.
* Tweaks to weight values of engines, thrusters and electrical bus.
* Corrected equipment space values for Adder and Krait in readme and on Wiki page.
* Changed default equipment refund percentage back to 85%.

1.0.0
* Scripted equipment damage was being aggressively repaired by the armour.
* Bus overload timer was being reset while running.

0.9.2
* New equipment items (ie. equipment purchased but not yet exposed to space travel) that are sold/exchanged will now be refunded at 100% of their cost, rather than the default 90%. This means you can swap items in and out to see the impact on ship stats, without having to take a loss on every exchange.
* When setting a course to a target system, F7 screen will now display the new destination.
* Equipment specification interface screen now includes TL required for purchasing equipment, and all equipment items are now being shown (not just the ones available in the current system). Also removed some unnecessary items from the list.

0.9.1
* Adjustment to Ore Processor equipment space requirements.
* Added missing equipment items from Ore Processor OXP.
* Added additional equipment items to the ignore list.
* Code refactoring.

0.9.0
* Forward and aft armour can now be different classes.
* Fixed issue with the armour equipment item not being removed when 100% damaged.
* Purchasing other ship armour (eg IronHide) will now refund the cost of any existing Ship Config armour before removing it.
* Improved code for processing expended heat sinks.
* Bug fixes.

0.8.2
* Corrected minor issue with equipment.plist and fuel scoops.
* Fixed issue with heat not being applied to NPC ships correctly.
* Consistency adjustments to equipment.plist.
* Added "display_color" property to some equipment items (Oolite v1.85/86 only).
* Bug fixes.

0.8.1
* Fixed issue with cargo not being able to be scooped.

0.8.0
* Added fuel scoop classes 1-4 to configuration menu.
* Armour repairs now won't generate an "Equipment removed" email.
* Code refactoring.
* Bug fixes.

0.7.2
* Custom scripts will now be attached correctly when a new ship is purchased.

0.7.1
* Fixed faulty LMSS integration.

0.7.0
* Added ability to sell laser weapons from the "Sell Equipment" page.
* Added ability to put laser weapons into storage.
* Fixed script error that could occur when player ejects.
* Tweaked the amount of heat dumped with a heat sink.
* Fixed an issue with large player ships where heat could be added, rather than dumped, when a heat sink is deployed.

0.6.7
* Fixed issue where the core "EQ_HEAT_SHIELD" equipment item was not being added to the ship, meaning that any equipment item that required a heat shield was not able to be installed via the F3 screen (eg PlanetFall Landing Capability).
* Adjusted the heat insulation factors for the heat shielding equipment.

0.6.6
* Updated method for determining player's next target system, to use new property "nextSystem" (when available in 1.85/6).
* Bus overload chance will slowly decrease during flight the longer the player goes without being hit.
* Tweaked what happens when a bus overload occurs, making it less likely that 3-5 items are damaged almost all at once.
* Added ship roles from Keeper's YAH Haulers to NPC configuration.
* Added ship roles from YAH to NPC configuration.
* Added equipment from In-System Taxi OXP.
* Fixed issue with equipment items that take up cargo space causing mis-calculations of the available cargo space.
* Checking for an overloaded state now happens more frequently when docked, to cater for scenarios where equipment is added outside the equip ship screen (F3).
* Code refactoring and bug fixes.

0.6.5
* Improvements to the heat sink deployment method.
* Correction to issues with the timer for heat sink detonation control.

0.6.4
* Adjusted space/weight components of UPS Police Scanner and UPS Universal Scanner.
* Fixed issue with core heat shield equipment not being added in the background whenever one of the new heat shield items is purchased.

0.6.3
* Removed some debug messages.
* Removed all unnecessary debug-mode checks.
* Added equipment items from "Vector" OXP.
* Added equipment items from "Ring Racers" OXP.
* Prevented sale of any equipment item that has a zero cost amount (as they are likely to be mission-OXP-related).

0.6.2
* Added logic for NPC's to turn off cloaking devices if their cabin temperature gets too high.
* Added logic to check whether installing stored equipment has worked before removing it from the storage array.
* Fixed incorrect monkey patching on shipDied and shipRemoved events.

0.6.1
* More equipment items can be transferred to storage, including things like MFD's and targeting enhancements.
* Removed incorrect restriction for the military shield enhancement (it is not actually dependant on the standard shield boosters).
* Added equipment space override for Asp Mark II Special.
* Armour repair amounts are now in-line with the original cost of the item.
* Fixed issue with equipment price in some OXP stations being ludicrously expensive.

0.6.0
* Added class "A" energy banks, that only take half the space of standard units, but also increase cabin heat.
* Added class "D", "E" and "F" engines that only take half the space of class "A", "B" and "C" engines, but they also increase cabin heat.
* Added class "D", "E" and "F" thrusters that only take half the space of class "A", "B" and "C" thrusters, but they also increase cabin heat.
* Fixed Javascript error when escape pod is used.
* If the Email System is present, adjusted method used to send emails when selling equipment.
* Changed the equipment space setting for escape pods, as these would be built into the architecture of the ship, not in the equipment racks.
* Added a tech level factor to equipment prices, so equipment should be cheaper in hi-tech systems, and more expensive in low-tech systems.
* Adjusted the used equipment sale reduction from 15% to 10%.
* Adjusted the heat build up from using hyperdrives to be variable based on the class level of hyperdrive.
* Added conflicting status with Redspear's Equipment by Ship Class OXP.
* Made compatible with Hyperspace Hanger OXP.
* Fixed issue with multiple passenger berths not being correctly reflected in weight calculations or display screens.
* Fixed issue where damaged shields would continue to decharge even after repairing them.
* Fixed issue where, if the Military Shield Enhancement and the Shield Boosters were damaged, you couldn't repair the former without repairing the latter, but time and credits would be deducted if you tried.
* Fixed equipment naming convention issue.
* Bug fixes.

0.5.0
* Added equipment space extensions to allow for more equipment without using cargo space, but with weight and cabin temp penalties.
* Adjusted equipment space settings for fuel injectors.
* Turned off some debug messages.
* Toned down colour of storage facility background overlay image.
* Fixed further compatibility issues with Ship Respray.
* Fixed further compatibility issues with Combat Simulator.
* Changed background overlay image during sell negotiations.

0.4.4
* The impact of damaged boosters was not being applied correctly. It wasn't making any difference if they were damaged.
* Determination of player's hyperspace destination now considers the presence of the ANA.
* Fixed error when not checking if a timer exists before trying to turn it off.
* Adjusted weight/space settings for boosters.
* Made compatible with "Hyperdrives" OXP.
* Really really fixed the issue with the HUD disappearing after viewing the config screens.

0.4.3
* Was not correctly reading values in script_info from shipdata.

0.4.2
* Fixed spelling error in manifest.plist.

0.4.1
* Fixed small bug that could occur if the amount of used equipment space exactly equals the available space.
* Removed debug message when purchasing a new ship.
* Fixed issue with HUD not becoming visible again when launching while viewing the ship configuration screen..

0.4.0
* Adjusted heat shielding insulation strength for type 3 and 4 heat shields, making them more useful, particularly for sun-skimmers. Also added types 5 and 6 for additional heat shield options.
* Fixed issue where the default level of heat insulation was being reset if heat shield equipment was not specifically installed on a ship.
* Adjustments to manifest.plist.
* Changed short range chart selection range to 7.5ly, rather than 15.
* Better handling of interstellar space conditions.
* Disabled ship configuration F3 item at police/navy stations (repairs are still possible at these stations, though).
* Fixed issue with emails sent when selling equipment not displaying the correct refund amount.
* F3 "Ship configuration" item now has a cost of 0 (zero).
* Added the possibility of having a mis-jump when entering hyperspace with high heat levels.
* Fixed issue with equipment overload state when returning from a combat simulation.

0.3.0
* Included the ability to store most equipment items in a local storage centre, and then retrieve that item at a later date. Also includes ability to sell equipment items directly from storage, or to transfer equipment items between storage facilities.
* Cargo can also be stored in the main station storage facility, and transferred between facilities.
* Included the ability to sell the cloaking device, or any equipment item that has an effective tech level >= 16, through a negotiation process.
* Added warning sounds/notifications when ship temperature reaches critical levels.
* Improved compatibility with the Single-Use witchdrive OXP.
* Added a random element to the process of adding equipment to NPC's, so not all ships of the same role will have the same equipment.
* Fixed issue where some column headings were not appearing correctly on the main Ship Config screen and the Electrical Bus sub-menu.
* Fixed issue with invalid reference error when energy equipment is damaged.
* Fixed issue with selling of passenger berths not working.
* Removed the Breakable Torus Drive code and the incompatibility flag, moved OXP reference to "optional_oxps". If you like this feature you can install that OXP directly.
* Removed the station equipmentPriceFactor from equipment price calculations, to avoid the loophole of buying equipment at the main station and selling it at a Rock Hermit for massive profits.
* Fixed bug with armour damage-point calculations that was preventing any damage to equipment from taking place until armour was mostly gone.
* Prevented smuggling compartments from being stored.
* Added some additional role translations.
* Changed "==" comparisons to "===" for performance improvements.
* Equipment refund price set to 85% of original price.
* Turned off free upgrades, turned on equipment installation time.
* Added SniperLock equipment to ignore list.

0.2.0
* Added new equipment configuration item "Boosters" which give a boost to engines and thrusters (allowing your ship to reach higher speeds), but also generate cabin heat.
* Now compatible with Ngalo's NShields and NPC Equipment Damage OXP's.
* Fixed issue where buying a new ship was not resetting the stored equipment values on the configuration display.
* Adjusted the weights of the electrical buses.
* NPC fuel injectors now won't be upgraded if the auto-weapons routine didn't install them in the first place.
* Added equipment items from Solar Harvester OXP and Single-Use Witchdrive OXP.
* Improved the equipment space calculation, so that ships with more than 35t of cargo space will get at least 20t of equipment space, plus some extra.
* Added means by which non-standard primary roles can be translated into core roles so that appropriate equipment is applied to each ship, rather than just the default equipment.
* Added some additional equipment space exceptions.
* Added some additional zoom factors for various ship types.
* Turned off debug messages.
* Adjustments to code design to allow for NPC equipment failure.
* Bug fixes.

0.1.3
* Further adjustments to Separated Lasers and Sniper Gun space and weight amounts as supplied by Norby.
* Added more NPC config possibilities.
* Removed the "playerRescuedEscapePod" event, because it wasn't firing when I thought it would anyway.
* Fixed spelling mistake on F3 screen description.
* Added ability to allow third party OXP equipment to add their own heat delta value into the cabin heat calculation when in operation.
* Added witchdrive jump heat buildup to heat calculations.

0.1.2
* Fixed issue with cabin temp when heat shield is damaged.
* Adjusted "Separated Lasers" weight values.
* Fixed issue with ships that have 0 cargo (eg Asp) attempting to be given EQ_EQUIPSPACE_0.
* Fixed issue with "thrust" not being set along with "maxThrust".
* Fixed issue with JS objects not being available when player ejects.

0.1.1
* Added some additional equipment items to the "No equipment space" list.
* Added equipment items from Separated Lasers, Multiple Lasers, Sniper Gun, Trail Detector, Tionisla Reporter, Headlights, FarPlanets.
* Configured the heat sink and the breakable torus drive entity to not get ship configuration.
* Adding in missing JS file for the breakable torus drive.
* Fixed issue with the cleanup routine for heatsinks causing a Javascript error.
* Added missing ";" in shipdata.plist.
* Code improvements.

0.1.0
* Fixed display issues on config screen where one header line was being overwritten.
* Fixed NPC shield mechanics.
* Added a flag to allow use of previous NPC config setup, based on role inclusion. To switch back to using role inclusion, set "this._useExclusions = false" in "shipconfig_npc.js".
* Selling damaged equipment items will now only refund half the cost of the item.
* Added bus overload chance to ship configuration screen.
* Included fuel injector class level in bus overload calculation, as they use the engines electrical bus.
* Added bus overload factor to temperature calculation.
* Added additional energy bank options, now going up to 25 banks.
* Rebalanced energy bank power couplings, reducing the number of classes to 8 (approx 3 banks per coupling level).
* Updated space/weight definition for Missile Machine from Armoury.oxp to better reflect what this device is.
* Tweaked TL availability for Class 4 Hyperdrives.

0.0.13
* Fixes to NPC equipment routines and heat sink parameter location for consistency with player and NPC ships.

0.0.12
* Config is now applied to all ships, including ones with "auto_weapons" set to false. Config can be switched off for a ship by adding a "no_config = 'yes'" to the script info for a ship.
* Laser use, laser strikes, fuel injector use and cloaking device use will now heat up the cabin, which applies to NPC's as well. New equipment "Heat Sinks" allow for a percentage of cabin temperature to be dumped.
* Added 7 classes of armour that will absorb damage before equipment. If IronHide armour or HardShips armour is installed, Ship Configuration armour items will not be available.
* Added integration with Custom Shields and NPC Shields.
* Fixed spelling mistake on "Equipment Specification" screen.
* Adjusted space/weight requirements for gravity scanners and small and large dishes, from Telescope OXP, based on descriptions.
* Moved most static text to descriptions.plist.
* Fixed missing variable declaration in bus overload code.
* Fixed issue on configuration screen where incorrect text was being displayed when no fuel injectors or heat shields were installed.
* Removed all the "EQ_*_REPAIR" items from equipment.plist, as I figured out how to make the core repair items display properly.
* Fixed issue with "getCargoCapacity" routine, which would return a "NaN" value for some ships.
* Fixed issue with "Unknown escape code in string" errors appearing in log file.
* Configured NPC equipment system, and created templates for most roles.
* Further fixes to the issue where equipment items that take up cargo space were throwing out the available space calculations.
* Updated screenID's to enable BGS background sounds.
* Cleaned up sound function to avoid the need to check for BGS.
* Updated check for "Allow Big GUI".
* Toned down overlay images.
* Code refactoring.

0.0.11
* Fixed Java script bug when dumping cargo.
* Added police roles to NPC list.
* Fixed spelling mistake for the heat shield when applying base equipment.
* Fixed issue where equipment items that take cargo space were incorrectly adjusting the maximum cargo space available for equipment.
* Added hyperdrive names, courtesy of Redspear.
* Added passenger berth equipment item to matrix (although it isn't necessary now that the bugs above have been fixed).
* Damaged core items now appear red on the Ship Configuration main menu.
* Code refactoring and cleanup.

0.0.10
* Fixed issue with equipment space overload status showing with "0t" used cargo space.
* Fixed issue where, after purchasing class 3 or above fuel injectors or heat shields, then saving and loading the game, class 2 items would also be installed.
* Fixed issue where cargo space was being returned to the player after a save/load sequence.

0.0.9
* Added more plumbing for doing specific NPC role configurations.
* Reworked the power to weight ratios to make larger ships harder to move, and smaller ships easier to move. So you can still put everything into an Anaconda, but you won't turn it into a Cobra.
* Fixed issue with adding default equipment, where the calculation for the engine power coupling was in some situations returning invalid configurations.

0.0.8
* Fixed bug in $addEquipmentDataFromScriptInfo routine that was applying equipment weight value from script_info to equipment space and overwriting whatever had been entered for space.
* Fixed issue where some Cobra Mark III models have a different mass.
* Fixed issue with Ship Respray, where cargo space was disappearing when a respray was purchased.
* Added current class levels to main menu items to make current installed items more visible.

0.0.7
* In an "overloaded" state, you can now switch between selling equipment and changing configuration in order to free up space.
* Fixed issue with the installed equipment list, where player ships with no missiles defined was causing an error.
* Fixed issue where you could install a much lower power coupling regardless of the equipment attached to it.
* Adjusted layout of interface screen.
* Adjusted position of "Ship Configuration" item on F3 screen so that fuel will come before it.
* Adjusted the thruster percentages to give them more range.

0.0.6
* Fixed issue where NPC's were not getting adjustments applied, and where occasionally the wrong piece of kit was showing up on the player.
* Changed minimum techlevel for doing configuration changes to 2, so you can't do config changes at Rock Hermits.
* Fixed incorrect text on repair item for breakable torus drive.
* Code refactoring.

0.0.5
* Added equipment items from "Laser Cannons".
* Added better checking for unknown lasers.

0.0.4
* Really fixed the energy draining away issue.

0.0.3
* Disabled the "overheating engine" code as it wasn't working as intended.
* Fixed issue (hopefully this time for sure!) where energy was being drained away.
* Fixed issue (hopefully) with being able to purchase multiple items of the same type.
* Adjusted engine upgrade speed values.
* Fixed missing ";" in shipdata.plist.

0.0.2
* Price of upgrades now scaled to ship size (so an engine upgrade for a Boa costs more than an engine upgrade for a Transporter).
* Changed layout of ship config screen to be more intuitive.
* Added a flag to make all upgrades free during testing period.
* Fixed issue (hopefully!) where energy was being drained away on launch.
* Adjusted thrust and speed values for engine upgrades to be more noticeable.
* When cargo is removed to make space for equipment, it will now be sold, rather than just removed.
* Changed power-to-weight ratio for Transporters.
* Changed shield upgrades to be in multiples of 64.
* Changed Class 4 hyperdrive spin time to 5 seconds.
* Moved salvaged equipment (from Anarchies OXP) into the ignore list, as these items are removed on purchase anyway.
* IF BGS is in use, now using the BGS hull bang noise when damage occurs.
* Added logic to cool engines down if you've run them in overload for a period of time.
* Bug fixes.
* Code refactoring.

0.0.1
* Initial Alpha release
</div>

== Links ==
=== Other Ship Customisation OXPs ===
==== Retexturing ====
*[[Respray for Griffs]] Capt Murphy's original Respray oxp (2012)
*[[Ship Respray OXP]] by Phkb
*[[Decal]] by Griff
*[[:Category:Retextures OXPs]] - explanation of regular/alternate/replacement ship retexture oxp's
==== Ship Configuration ====
*[[Stranger's Set]] includes Stranger's simpler version of Ship Configuration OXP
*[[SOTL Altmap]] is cim's original OXP/alternative scenario which introduced Ship Configuration

== Quick Facts ==
{{OXPLevel|3}}{{IconOXP|ooVersion="1.82"|oxpCPU="Average"|oxpMEM="Average"|oxpGPU="Low"|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
{{Infobox OXPb| title = ShipConfiguration.oxz
|version = 1.5.5
|release = 2026-05-11
|license = CC BY-NC-SA 3.0
|features = Ship customisation, equipment
|category = Mechanics OXPs
|author = [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=17842 Oolite BB]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-red.png]]

File:ShipConfiguration.oxz

2026-05-11T12:25:19Z

Phkb: Phkb uploaded a new version of File:ShipConfiguration.oxz

Version 0.1.0

Talk:NPB Neutralizer OXZ

2026-05-11T07:14:45Z

Phkb:

Talk:NPB Neutralizer OXZ

2026-05-11T07:14:29Z

Phkb: Created page with "Some points: - Getting a "kill" using this weapon won't count for most mission OXP's - you will still need to keep firing until the ship is destroyed. - Every weapon will end..."

Some points:
- Getting a "kill" using this weapon won't count for most mission OXP's - you will still need to keep firing until the ship is destroyed.
- Every weapon will end up working as an NPB Neutralizer, as long as you have one installed, as the code doesn't check which view is being used and what weapon is installed there.
- Info says you need to be clean, but code doesn't prevent an Offender/Fugitive install.
- Info also says Police have these retro fitted, but there's no code granting it specifically to police ships, and "available_to_NPCs = false;" in the equipment.plist
- Given the uber-ness of this weapon, I'm curious as to why you've rated it "Neutral". I think this should be "Some bias in the players favour/Makes the game a little easier".

phkb

File:LoadoutByCategory 190.oxz

2026-05-11T05:10:53Z

Phkb: Phkb uploaded a new version of File:LoadoutByCategory 190.oxz

File:LoadoutByCategory.oxz

2026-05-11T05:10:38Z

Phkb: Phkb uploaded a new version of File:LoadoutByCategory.oxz

New Cargoes

2026-05-11T02:00:45Z

Phkb: /* Change log */

[[Image:New_Cargoes.png|thumb|600px|right|The specialist market is found on the F4 ship/station interface]]
New Cargoes adds over 100 new trade goods to the 8 galaxies. Each new good is a more specific variety of one of the generic cargoes: valuable to the right buyer, largely worthless otherwise.

In addition, a variety of new short-lived trading opportunities are available (you need TraderNet for these).

New Cargoes was designed to allow other OXPs to add cargoes, traders, and events to the universe as a framework, in addition to the cargoes and opportunities including in New Cargoes itself.

== Why? ==
[[File:New Cargoes icon.png|right]]
{{QuoteText|Text=I really enjoy the variety and deepness New Cargoes gives to the game.|Source=([https://bb.oolite.space/viewtopic.php?p=192210#p192210 Spara])}}

One of the things that slightly disappointed me about the original Elite was that you couldn't really follow in the footsteps of the fictional traders. There's a bit in the [[Dark Wheel]] where Alex Ryder is at Xezaor looking for cargo, notices that Durassion ore is available at a good price, and might sell well at Lave. But it's a long journey, and the travel would be worthless if a better deposit was found. He decides it's too risky and looks elsewhere. Later fiction has continued much the same idea that your basic Agri-Ind pair of planets won't generally cover a trader's expenses, and so longer and riskier trade routes develop.

In Elite, though, you could only buy general Minerals. And even if Xezaor has minerals at a good price, there's probably somewhere much closer than Lave to sell them for profit. Oolite - while a little more flexible in the cargo department - has much the same limitations ... but is extensible enough to work around them.

So, introducing the New Cargoes OXP. Any cargo you can imagine - provided it can reasonably be described under one of the 14 generic headings of 1TC cargo - can be offered for sale at some main stations and some OXP stations, and be sold for profit at others. Market collapses and variation are included, so the trading involves a degree of risk. Any OXP can define cargo and other functionality for the New Cargoes framework

==Installation==
*Downloadable through the in-game [[Expansions Manager]]
*The current version of New Cargoes is 2.2 [[Media:NewCargoes_2.2.oxz|NewCargoes_2.2.oxz]]

*The previous version of New Cargoes is 1.2.3. [http://cim.sotl.org.uk/games/files/oolite/New_Cargoes_1.2.3.oxz Download 1.2.3] and install in the usual way. This moves access to the New Cargoes trading to the new Interfaces screen (F4)

===Other OXPs===
*[[Famous Planets]] gives much of the F7 screen information which provides the clues for which systems export or require the various "new cargoes".
*[[SothisTC|Sothis.oxp & SothisTC.oxp]] combined provide Sothis orbital stations in Corporate States only where one can read TraderNet for free and where there are more market opportunities for New Cargoes goods.
 
Other OXPs that affect cargo handling are compatible with New Cargoes.
* [[HyperCargo_OXP|HyperCargo]], if installed, should be at least version 1.07. If you take an open contract, you should take care to avoid placing the open contract's cargo in the HyperCargo at any time, as you may lose it if you do.
* [[Illegal_Goods_Tweak_OXP|Illegal Goods Tweak]], if installed, should be at least version 1.7

Warning: [[Smugglers]] is incompatible with New Cargoes (they both involve licenses for regionally banned goods, and New Cargoes was never updated to the Trade-goods.plist, leading to issues with illegality). Version 2.0 is now compatible with Smugglers.

[[File:NewCargoes Digebiti.png|thumb|right|600px|TraderNet newsflash]]
[[File:NewCargoes - Budget Tourists.png|thumb|right|600px|TraderNet "Know your goods"]]

==Using New Cargoes==
Once New Cargoes is installed, load your saved game or start a new one. If this is the first time you have loaded the game since installing or upgrading New Cargoes, you should wait a couple of seconds before continuing, to ensure that all New Cargoes data is initialised properly.

*'''In current versions''': At any supported station, press F4 to bring up the Interface screen, then select "Speciality Cargo Trading" from the "Commerce" category.
*'''In version 1.1.0 or earlier''': At a main station, press F8 three times to get to the New Cargoes trade interface. At a supported non-main station, press F2 then F8 instead. When you have finished, select "Exit specialist cargo trading" to return to your ship.

===Buying and selling cargo===

Your first option allows you to buy special cargo from the station's
market. This will be available in moderate quantities for a set price,
similar to the standard trade goods. As usual, you must have room in
your hold and enough credits on hand to buy the cargo. It will then
appear on your ship's manifest as 1TC of the appropriate generic cargo
type. For instance, if you buy "Goat Soup", it will appear as "Food"
on your manifest.

The second option allows you to sell carried cargo to buyers at the
station. Again, the price is set automatically for this service. Make
sure you sell special cargo in this way rather than through the
general F8 screen, or you will make a significant loss.

The trick, of course, is to buy the cargo cheaply at a system where it
is plentiful, and then take it to sell for massive profits at a system
where it is rare but desired. For most goods there will only be a
small number of systems in each galaxy that really want to buy them.

===Gathering trade route information===

The third option tells you the exports and imports of the current system, and then takes you to the trader bars to gather
gossip about other systems. Traders are sometimes happy to chat about their recent
successes and failures, and intentionally giving misinformation is
rare. Do remember, however, that just because one trader made a
massive profit taking cargo from A to B doesn't mean you'll
automatically be able to do the same. Try to confirm any information
you pick up here before acting on it.

===Trade deals===

The fourth option takes you to the trade floor. In most main stations
there will be someone here offering a more interesting deal - an
auction, a special contract, a permit to legally carry controlled
goods, or something else. Be careful, as not everyone here will have
your best interests in mind. Make sure that you can fulfil your side
of the deal before signing any agreements.

===Detailed manifest===

The fifth option shows your manifest in more detail, on multiple pages
if needed. The origin of goods you have collected will be shown to aid
your memory and help you assess your profit margins.

===Contracts and permits===

The sixth option shows you details of the contracts you have entered
into, any permits you are carrying, and any special regulations
applying to trade in this system.

===TraderNet===

If you have bought a TraderNet subscription, you can view recent TraderNet bulletins with the seventh option. These contain information on places to buy and sell trade goods, upcoming events, and regional fluctuations in prices. Spara's [[SothisTC]] variant station allows free access to TraderNet (requires you to modify the SothisTC oxp).

==How to trade well==

The concise summary:
* Look at as many sources of information as you can about trade goods, and look for patterns in what can be bought and sold where. Have Famous Planets OXP loaded.
* Plan your route in advance. If you don't have a full hold, maybe there's a short detour that would be profitable on the way.
* Get a TraderNet subscription (from the shipyard), and keep it renewed. If you hear about something nearby, act quickly.

[[New_Cargoes_Trading_Advice|Transcript of the introductory lecture in the "advanced trading" course]] at Lave Academy.

==Difficulty==

If you choose to trade mostly or exclusively in new cargoes,
then making a trading profit will become much less reliable (though
there are higher profits when you succeed), and may require you to
travel through more dangerous systems.

Also, New Cargoes makes some OXP stations - the ones which are most friendly to GalCop - use GalCop's rules for import and export of illegal goods. This can surprise you even if you aren't carrying new cargoes, so be careful.

----
==New Cargoes for OXP writers==

"New Cargoes provides a flexible framework for other OXPs to add extra cargoes and trade opportunities. See the [[NewCargoesAPI|New Cargoes API reference]] for more information" (Cim, 2013).

Sadly, New Cargoes was written ''before'' the introduction of the [[Trade-goods.plist]] with Oolite v.1.81, and never updated for it, so its utility in this regard is now somewhat spotty (Cholmondeley 2021). Version 2.0 now works with the current versions of Oolite.

=== Disclaimer ===
"There are a few oxp's which I haven't maintained recently and probably don't work particularly well with the core changes since I wrote them. New Cargoes especially needs a ground-up rewrite to use the new commodity features (in the new Trade-goods.plist) properly (from https://cim.sotl.org.uk/games/)" (Cim 2015). One supposes that ideally it would work through the F8/F8F8 screens rather than the F4 screen!

=== Comment ===
{{QuoteText|Text=New Cargoes attempts to rework all the legal/illegal configuration by turning everything legal at base, and then applying legal penalties via code, essentially bypassing the core game code. It is not certain that the method used to nullify the illegal goods actually works, which means you could be double-pinged for any infringement.

And this is also one of the main reasons New Cargoes is incompatible with Phkb's [[Smugglers - The Galactic Underworld|Smugglers OXP]], which is making goods illegal left, right and centre.|Source=([https://bb.oolite.space/viewtopic.php?p=280346#p280346 Phkb (2021)])}}

==Change log==
* 2.2: Added "[[New Cargoes Trading Advice]]" to the [[Ship's Library]] (if installed)
* 2.1: Fixed issue where F4 interface was not being added to the current station in all situations.
* 2.0: Updated to work with current versions of Oolite.

* 1.2.3: Fix bugs with save/load of regional data and pricing of fetch contracts. Thanks to Solonar and Keeper for reports.
* 1.2.2: Fix serious bug with losing cargo on launch. Thanks to Solonar for patient diagnosis.
* 1.2.1: Fix bug with permits
* 1.2.0: Oolite 1.77 required. Move access to the Interfaces screen. Some internal improvements, and a few more trade routes.
* 1.1.0: Removed Snoopers dependency, some interface improvements suggested by JazHaz, by popular demand introduced a few easier ways to find out where trade goods can be exported and imported at a decent profit, and made import prices slightly more generous.
* 1.0.6: Fix bugs with the handling of permits, Kiota stations, and open contracts found by Capt. Murphy, BuggyBY and XLA
* 1.0.5: Fix bug with world script startup order found by Eric Walch.
* 1.0.4: Fix bugs with Ore Processor and with open contracts; thanks to Wardy and BuggyBY
* 1.0.3: Fix bug with import/export laws at some OXP stations; add new API functions.
* 1.0.2: Fix bug with permits and misjumps; thanks to Capt. Murphy for report.
* 1.0.1: Extra API function for [[HyperCargo_OXP|HyperCargo]] compatibility
* 1.0.0: Initial release version

==Musings==
This OXP is truly brilliant!

It makes trading much more complex and realistic. For example, the new cargoes you find can be either cheap local products or more expensive items which have been imported - and you need to work out which! Prices also vary regionally. And the way that it works with the F7 screen (presuming that [[Famous Planets]] is loaded, is super!

It brings some of the [[Lore]] to life.

Sadly, 
1) it is clunky. Needing to shift backwards and forwards between the F4 & F8 screens is not great (one presumes that were thoughts of using the then new F8F8 screen, but they were never implemented). There is no obvious sign on the F8 screen that the new cargo ''is'' a much more expensive "new cargo". 
2) There are a handful of oddities mentioned on the sector system pages which could do with being included ''eg'': [[Sector1/Digebiti|Digebitian duelling pistols]], [[Sector1/Tionisla|Tionislan hunting crossbows]] & [[Sector1/Lave|Lavese bacons]]. These seem to have originally come from [[The Traders Almanach]] - and there are a handful of others such as the Bemearean walnut wood used for the Fer-de-Lance dashboards.

==Links==
*[[Economics]] (contains Cim's analysis of economics in Oolite)
*[[Oolite Trading]]
*[[New_Cargoes_Trading_Advice|Transcript of the introductory lecture in the "advanced trading" course]] at Lave Academy.

*[https://bb.oolite.space/viewtopic.php?t=11498 Revamping the trade system?] includes Cim's early musings about this OXP (2012)
*[https://bb.oolite.space/viewtopic.php?f=2&t=18555 Auctions - How can you be at the right place at the right time?] (2017)

*[https://bb.oolite.space/viewtopic.php?f=4&t=21469 New Cargoes 2.0] Phkb's update - compatible with [[Smugglers]] ''etc''. (2023)

== Relevant OXPs ==
*[[Famous Planets]] gives useful information on the F7 screen
*[[Hermitage]] links in with this OXP
*[[Riredi OXP]] adds in to this OXP
*[[Tianve OXP]] adds in to this OXP

== Gameplay and Balance Indicator ==
{{OXPLevel|1}}
[[File:Tag-colour-orange.png|right]]
Trade becomes much more complex (and realistic).

==Quick Facts==
{{Infobox OXPb| title = New Cargoes
|version = 2.2
|release = 2026-05-11
|features = New cargoes and trade contracts
|license = CC-BY-SA 3
|category = Mechanics OXPs
|author = [[User:cim|cim]]
|download = [[#Download|See Download]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=11519 BB-Link (v1.2.3)] [https://bb.oolite.space/viewtopic.php?f=4&t=21469 BB-Link (v2.0)]
}}

[[Category:The Dark Wheel]]

New Cargoes

2026-05-11T01:59:28Z

Phkb:

[[Image:New_Cargoes.png|thumb|600px|right|The specialist market is found on the F4 ship/station interface]]
New Cargoes adds over 100 new trade goods to the 8 galaxies. Each new good is a more specific variety of one of the generic cargoes: valuable to the right buyer, largely worthless otherwise.

In addition, a variety of new short-lived trading opportunities are available (you need TraderNet for these).

New Cargoes was designed to allow other OXPs to add cargoes, traders, and events to the universe as a framework, in addition to the cargoes and opportunities including in New Cargoes itself.

== Why? ==
[[File:New Cargoes icon.png|right]]
{{QuoteText|Text=I really enjoy the variety and deepness New Cargoes gives to the game.|Source=([https://bb.oolite.space/viewtopic.php?p=192210#p192210 Spara])}}

One of the things that slightly disappointed me about the original Elite was that you couldn't really follow in the footsteps of the fictional traders. There's a bit in the [[Dark Wheel]] where Alex Ryder is at Xezaor looking for cargo, notices that Durassion ore is available at a good price, and might sell well at Lave. But it's a long journey, and the travel would be worthless if a better deposit was found. He decides it's too risky and looks elsewhere. Later fiction has continued much the same idea that your basic Agri-Ind pair of planets won't generally cover a trader's expenses, and so longer and riskier trade routes develop.

In Elite, though, you could only buy general Minerals. And even if Xezaor has minerals at a good price, there's probably somewhere much closer than Lave to sell them for profit. Oolite - while a little more flexible in the cargo department - has much the same limitations ... but is extensible enough to work around them.

So, introducing the New Cargoes OXP. Any cargo you can imagine - provided it can reasonably be described under one of the 14 generic headings of 1TC cargo - can be offered for sale at some main stations and some OXP stations, and be sold for profit at others. Market collapses and variation are included, so the trading involves a degree of risk. Any OXP can define cargo and other functionality for the New Cargoes framework

==Installation==
*Downloadable through the in-game [[Expansions Manager]]
*The current version of New Cargoes is 2.2 [[Media:NewCargoes_2.2.oxz|NewCargoes_2.2.oxz]]

*The previous version of New Cargoes is 1.2.3. [http://cim.sotl.org.uk/games/files/oolite/New_Cargoes_1.2.3.oxz Download 1.2.3] and install in the usual way. This moves access to the New Cargoes trading to the new Interfaces screen (F4)

===Other OXPs===
*[[Famous Planets]] gives much of the F7 screen information which provides the clues for which systems export or require the various "new cargoes".
*[[SothisTC|Sothis.oxp & SothisTC.oxp]] combined provide Sothis orbital stations in Corporate States only where one can read TraderNet for free and where there are more market opportunities for New Cargoes goods.
 
Other OXPs that affect cargo handling are compatible with New Cargoes.
* [[HyperCargo_OXP|HyperCargo]], if installed, should be at least version 1.07. If you take an open contract, you should take care to avoid placing the open contract's cargo in the HyperCargo at any time, as you may lose it if you do.
* [[Illegal_Goods_Tweak_OXP|Illegal Goods Tweak]], if installed, should be at least version 1.7

Warning: [[Smugglers]] is incompatible with New Cargoes (they both involve licenses for regionally banned goods, and New Cargoes was never updated to the Trade-goods.plist, leading to issues with illegality). Version 2.0 is now compatible with Smugglers.

[[File:NewCargoes Digebiti.png|thumb|right|600px|TraderNet newsflash]]
[[File:NewCargoes - Budget Tourists.png|thumb|right|600px|TraderNet "Know your goods"]]

==Using New Cargoes==
Once New Cargoes is installed, load your saved game or start a new one. If this is the first time you have loaded the game since installing or upgrading New Cargoes, you should wait a couple of seconds before continuing, to ensure that all New Cargoes data is initialised properly.

*'''In current versions''': At any supported station, press F4 to bring up the Interface screen, then select "Speciality Cargo Trading" from the "Commerce" category.
*'''In version 1.1.0 or earlier''': At a main station, press F8 three times to get to the New Cargoes trade interface. At a supported non-main station, press F2 then F8 instead. When you have finished, select "Exit specialist cargo trading" to return to your ship.

===Buying and selling cargo===

Your first option allows you to buy special cargo from the station's
market. This will be available in moderate quantities for a set price,
similar to the standard trade goods. As usual, you must have room in
your hold and enough credits on hand to buy the cargo. It will then
appear on your ship's manifest as 1TC of the appropriate generic cargo
type. For instance, if you buy "Goat Soup", it will appear as "Food"
on your manifest.

The second option allows you to sell carried cargo to buyers at the
station. Again, the price is set automatically for this service. Make
sure you sell special cargo in this way rather than through the
general F8 screen, or you will make a significant loss.

The trick, of course, is to buy the cargo cheaply at a system where it
is plentiful, and then take it to sell for massive profits at a system
where it is rare but desired. For most goods there will only be a
small number of systems in each galaxy that really want to buy them.

===Gathering trade route information===

The third option tells you the exports and imports of the current system, and then takes you to the trader bars to gather
gossip about other systems. Traders are sometimes happy to chat about their recent
successes and failures, and intentionally giving misinformation is
rare. Do remember, however, that just because one trader made a
massive profit taking cargo from A to B doesn't mean you'll
automatically be able to do the same. Try to confirm any information
you pick up here before acting on it.

===Trade deals===

The fourth option takes you to the trade floor. In most main stations
there will be someone here offering a more interesting deal - an
auction, a special contract, a permit to legally carry controlled
goods, or something else. Be careful, as not everyone here will have
your best interests in mind. Make sure that you can fulfil your side
of the deal before signing any agreements.

===Detailed manifest===

The fifth option shows your manifest in more detail, on multiple pages
if needed. The origin of goods you have collected will be shown to aid
your memory and help you assess your profit margins.

===Contracts and permits===

The sixth option shows you details of the contracts you have entered
into, any permits you are carrying, and any special regulations
applying to trade in this system.

===TraderNet===

If you have bought a TraderNet subscription, you can view recent TraderNet bulletins with the seventh option. These contain information on places to buy and sell trade goods, upcoming events, and regional fluctuations in prices. Spara's [[SothisTC]] variant station allows free access to TraderNet (requires you to modify the SothisTC oxp).

==How to trade well==

The concise summary:
* Look at as many sources of information as you can about trade goods, and look for patterns in what can be bought and sold where. Have Famous Planets OXP loaded.
* Plan your route in advance. If you don't have a full hold, maybe there's a short detour that would be profitable on the way.
* Get a TraderNet subscription (from the shipyard), and keep it renewed. If you hear about something nearby, act quickly.

[[New_Cargoes_Trading_Advice|Transcript of the introductory lecture in the "advanced trading" course]] at Lave Academy.

==Difficulty==

If you choose to trade mostly or exclusively in new cargoes,
then making a trading profit will become much less reliable (though
there are higher profits when you succeed), and may require you to
travel through more dangerous systems.

Also, New Cargoes makes some OXP stations - the ones which are most friendly to GalCop - use GalCop's rules for import and export of illegal goods. This can surprise you even if you aren't carrying new cargoes, so be careful.

----
==New Cargoes for OXP writers==

"New Cargoes provides a flexible framework for other OXPs to add extra cargoes and trade opportunities. See the [[NewCargoesAPI|New Cargoes API reference]] for more information" (Cim, 2013).

Sadly, New Cargoes was written ''before'' the introduction of the [[Trade-goods.plist]] with Oolite v.1.81, and never updated for it, so its utility in this regard is now somewhat spotty (Cholmondeley 2021). Version 2.0 now works with the current versions of Oolite.

=== Disclaimer ===
"There are a few oxp's which I haven't maintained recently and probably don't work particularly well with the core changes since I wrote them. New Cargoes especially needs a ground-up rewrite to use the new commodity features (in the new Trade-goods.plist) properly (from https://cim.sotl.org.uk/games/)" (Cim 2015). One supposes that ideally it would work through the F8/F8F8 screens rather than the F4 screen!

=== Comment ===
{{QuoteText|Text=New Cargoes attempts to rework all the legal/illegal configuration by turning everything legal at base, and then applying legal penalties via code, essentially bypassing the core game code. It is not certain that the method used to nullify the illegal goods actually works, which means you could be double-pinged for any infringement.

And this is also one of the main reasons New Cargoes is incompatible with Phkb's [[Smugglers - The Galactic Underworld|Smugglers OXP]], which is making goods illegal left, right and centre.|Source=([https://bb.oolite.space/viewtopic.php?p=280346#p280346 Phkb (2021)])}}

==Change log==
* 2.2: Added "New Cargoes Trading Advice" to the Ship's Library (if installed)
* 2.1: Fixed issue where F4 interface was not being added to the current station in all situations.
* 2.0: Updated to work with current versions of Oolite.

* 1.2.3: Fix bugs with save/load of regional data and pricing of fetch contracts. Thanks to Solonar and Keeper for reports.
* 1.2.2: Fix serious bug with losing cargo on launch. Thanks to Solonar for patient diagnosis.
* 1.2.1: Fix bug with permits
* 1.2.0: Oolite 1.77 required. Move access to the Interfaces screen. Some internal improvements, and a few more trade routes.
* 1.1.0: Removed Snoopers dependency, some interface improvements suggested by JazHaz, by popular demand introduced a few easier ways to find out where trade goods can be exported and imported at a decent profit, and made import prices slightly more generous.
* 1.0.6: Fix bugs with the handling of permits, Kiota stations, and open contracts found by Capt. Murphy, BuggyBY and XLA
* 1.0.5: Fix bug with world script startup order found by Eric Walch.
* 1.0.4: Fix bugs with Ore Processor and with open contracts; thanks to Wardy and BuggyBY
* 1.0.3: Fix bug with import/export laws at some OXP stations; add new API functions.
* 1.0.2: Fix bug with permits and misjumps; thanks to Capt. Murphy for report.
* 1.0.1: Extra API function for [[HyperCargo_OXP|HyperCargo]] compatibility
* 1.0.0: Initial release version

==Musings==
This OXP is truly brilliant!

It makes trading much more complex and realistic. For example, the new cargoes you find can be either cheap local products or more expensive items which have been imported - and you need to work out which! Prices also vary regionally. And the way that it works with the F7 screen (presuming that [[Famous Planets]] is loaded, is super!

It brings some of the [[Lore]] to life.

Sadly, 
1) it is clunky. Needing to shift backwards and forwards between the F4 & F8 screens is not great (one presumes that were thoughts of using the then new F8F8 screen, but they were never implemented). There is no obvious sign on the F8 screen that the new cargo ''is'' a much more expensive "new cargo". 
2) There are a handful of oddities mentioned on the sector system pages which could do with being included ''eg'': [[Sector1/Digebiti|Digebitian duelling pistols]], [[Sector1/Tionisla|Tionislan hunting crossbows]] & [[Sector1/Lave|Lavese bacons]]. These seem to have originally come from [[The Traders Almanach]] - and there are a handful of others such as the Bemearean walnut wood used for the Fer-de-Lance dashboards.

==Links==
*[[Economics]] (contains Cim's analysis of economics in Oolite)
*[[Oolite Trading]]
*[[New_Cargoes_Trading_Advice|Transcript of the introductory lecture in the "advanced trading" course]] at Lave Academy.

*[https://bb.oolite.space/viewtopic.php?t=11498 Revamping the trade system?] includes Cim's early musings about this OXP (2012)
*[https://bb.oolite.space/viewtopic.php?f=2&t=18555 Auctions - How can you be at the right place at the right time?] (2017)

*[https://bb.oolite.space/viewtopic.php?f=4&t=21469 New Cargoes 2.0] Phkb's update - compatible with [[Smugglers]] ''etc''. (2023)

== Relevant OXPs ==
*[[Famous Planets]] gives useful information on the F7 screen
*[[Hermitage]] links in with this OXP
*[[Riredi OXP]] adds in to this OXP
*[[Tianve OXP]] adds in to this OXP

== Gameplay and Balance Indicator ==
{{OXPLevel|1}}
[[File:Tag-colour-orange.png|right]]
Trade becomes much more complex (and realistic).

==Quick Facts==
{{Infobox OXPb| title = New Cargoes
|version = 2.2
|release = 2026-05-11
|features = New cargoes and trade contracts
|license = CC-BY-SA 3
|category = Mechanics OXPs
|author = [[User:cim|cim]]
|download = [[#Download|See Download]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=11519 BB-Link (v1.2.3)] [https://bb.oolite.space/viewtopic.php?f=4&t=21469 BB-Link (v2.0)]
}}

[[Category:The Dark Wheel]]

File:NewCargoes 2.2.oxz

2026-05-11T01:56:47Z

Phkb:

Black Market

2026-05-10T12:22:38Z

Phkb:

Adds black markets to most Rock Hermits and some other stations.

==Overview==
When docked at most non-GalCop stations (Rock Hermits, predominantly), and even GalCop stations in some systems, you will find a new interface screen called "Black Market". This interface provides access to a number of options: 
a. Noticeboard: View some of the messages from the black market news boards. Some are good, some aren't. You might even learn about some tasty abandoned cargo! 
b. Smuggling contracts: These contracts will be smaller cargo quantities (less than 20t), and they will all be illegal at the destination system, so there will be a high degree of risk with each one. However, the rewards will be substantial, more than double what the cargo would be worth at the destination. ([[Smugglers - The Galactic Underworld|Smugglers OXP]] required) 
c. Purchase fake import permits: You can purchase fake import permits that may or may not work at the destination system. The chance is only a slightly better than 50%. ([[Smugglers - The Galactic Underworld|Smugglers OXP]] required) 
d. Purchase Rock Hermit waypoints: Finding Rock Hermits is important, as they are the primary location to access the Black Market. Waypoints can help you find a Rock Hermit in a given system. 
e. Purchase phase scan settings: Not always available but occasionally a trader will offer their settings for a price. ([[Smugglers - The Galactic Underworld|Smugglers OXP]] required) 
f. Sell phase scan settings: If you have discovered a phase scan setting, you can sell it for some real coin! This will only be available once you have purchased a phase scanner. ([[Smugglers - The Galactic Underworld|Smugglers OXP]] required) 
g. Sell restricted equipment: If you've come into possession of some military grade equipment, you can potentially find a buyer on the black market. 

Please be aware that GalCop have been known to run sting operations at some Black Markets. If you are caught buying illegal information or goods through a Black Market while a sting operation is in place, you will be penalised.

==3rd Party Access To Black Market==
===Selling Custom Items===
It's possible for other OXP's to add items to be sold on the Black Market. You can add your item using the following method:

var sbm = worldScripts.Smugglers_BlackMarket;
if (sbm) {
sbm.$addSaleItem({
key:"my_key_value", // reference to be passed back to your worldscript when the item is sold, so you can know which item it was
text:"A very exclusive item", // text to display on the sale screen
cost:1000, // the base cost of the item. a system factor will be applied to this value, either increasing or decreasing it
worldScript:"my_worldscript_name", // the name of your worldscript
sellCallback:"$my_functionname", // the name of the function to be called in the item is sold
});
}

this.$my_functionname = function(key, price) {
// this is the function that will be called. the key name and the price are two parameters of the function
// you can now do any additional functions that need to be done (eg removing special equipment or cargo)
}

Items added to the Black Market will stay there until the next witchspace jump. If you want to remove the item manually, you can use this function:

var sbm = worldScripts.Smugglers_BlackMarket;
if (sbm) {
sbm.$removeSaleItem(key);
}

You can also remove all sale items for your worldScript with this function:

var sbm = worldScripts.Smugglers_BlackMarket;
if (sbm) {
sbm.$removeWorldScriptItems(ws);
}

===Purchase Custom Items===
It's possible for other OXP's to add items to be purchased on the Black Market. You can add your item using the following method:

var sbm = worldScripts.Smugglers_BlackMarket;
if (sbm) {
sbm.$addPurchaseItem({
key:"my_key_value", // reference to be passed back to your worldscript when the item is bough, so you can know which item it was
text:"A very exclusive item", // text to display on the sale screen
cost:1000, // the base cost of the item. a system factor will be applied to this value, either increasing or decreasing it
worldScript:"my_worldscript_name", // the name of your worldscript
purchaseCallback:"$my_functionname",// the name of the function to be called in the item is bought
});
}

this.$my_functionname = function(key, price) {
// this is the function that will be called. the key name and the price are two parameters of the function
// you can now do any additional functions that need to be done (eg adding special equipment or cargo)
}

Items added to the Black Market will stay there until the next witchspace jump. If you want to remove the item manually, you can use this function:

var sbm = worldScripts.Smugglers_BlackMarket;
if (sbm) {
sbm.$removePurchaseItem(key);
}

You can also remove all purchase items for your worldScript with this function:

var sbm = worldScripts.Smugglers_BlackMarket;
if (sbm) {
sbm.$removePurchaseWorldScriptItems(ws);
}

==Developer Note==
This OXP used to reside inside the [[Smugglers - The Galactic Underworld|Smugglers OXP]], and so a lot of the code and descriptions are related to that OXP. However, I had the need of a Black Market for another project, and rather than force players to install Smugglers (which has a big impact on gameplay), I split out the functionality into a separate pack.

==Download==
Download [[Media:BlackMarket_1.7.oxz|BlackMarket_1.7.oxz]] 

==License==
This OXP is released under the Creative Commons Attribution - Non-Commercial - Share Alike 3.0 license. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/

Skull and crossbones image from http://simpleicon.com/dangerous_sign.html.

==Version History==
1.7
* Added Pirate Coves to list of RH's that will have a Black Market.
* Black Market Info Booklet now only purchasable through the Black Market.
* Added new section on Black Market: "Buy Other Items", with associated API calls.
* Added the buy/sell sound effects when buying/selling items.
* Switched to using logcontrol for debug messages.

1.6
* Added Black Market Info Booklet to Ship's Library (if installed).

1.5
* Darkened overlay images for better compatibility with Oolite 1.92.

1.4
* Moved all text into descriptions.plist for easier localisation.

1.3
* Added sound when a fuel leak occurs.

1.2
* Added missing noticeboard items to descriptions.plist.
* Small code improvements.

1.1
* Fixed issue that was displaying "You have a waypoint to a Rock Hermit in this system" on th F7 page for every system.

1.0
* Initial release

==Quick Facts==
{{OXPLevel|0}}{{IconOXP|ooVersion="1.80"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Low"|oxpIsAPI=true|oxpIsDocumented=true}}
{{Infobox OXPb| title = BlackMarket.oxz
|version = 1.7
|release = 2026-05-10
|license = CC BY-NC-SA 4.0
|features = Rock Hermits
|category = Mechanics OXPs‏‎
|author = [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=17723 Oolite BB]
}}

Smugglers - The Galactic Underworld

2026-05-10T12:18:44Z

Phkb: /* Download */

[[File:Smugglers' News Flash.png|right|500px]]
Makes any commodity potentially illegal to import in various systems, and adds equipment and contracts for those interested in smuggling goods outside normal legal channels.

==Introduction==
Historically, in both the original Elite and therefore in Oolite, there were three illegal goods: slaves, narcotics and firearms. These were illegal to export from all GalCop stations, and there was no variation or flexibility in those items. This OXP aims to expand what goods are illegal, making it far more variable. There are new interface screens to show what items are illegal and where, a new Black Market available from Rock Hermits and other stations, and new equipment items to aid in smuggling cargo.

==Background==
It started with a single system.

[[Sector1/Ceedra|Ceedra]], an insignificant confederacy in an unfrequented arm of galactic sector 1. They had been receiving some contaminated imported food from the nearby Anarchy system [[Sector1/Isdibi|Isdibi]], possibly random or possibly intentional as a way to destabilise the government, it was difficult to tell. But a request was made to [[GalCop]] to put an import ban on food and force any traders that bring food to the station to hand it over for destruction.

The impact was almost immediate. Traders were outraged that their harmless cargo of wheat and grains were being taken away, which had never before happened in GalCop history, plus they received a bounty for doing so, doubling the pain. Messages were sent, trade delegations made an outward show of force, but GalCop's hands were tied. This was the decision of the planet in question, and under GalCop law they were perfectly entitled to impose import restrictions, beyond the export restrictions that had long been in place for slaves or narcotics.

Suddenly the floodgates were opened. System after system found reason to ban goods, from basic staples like food or textiles, up to the traders standard fare of computers, furs and liquor. Even precious metals were banned in some systems, often for rather obscure reasons. And always, once a ban was in place, the price would hit the roof.

Some commentators have suggested there is evidence that certain systems were requesting a good to be made illegal purely for the jump in price that naturally follows and the bump in traffic that accompanies extra profits. While GalCop have been sought for comment, none has been forthcoming, and nothing appears to be able to bring a halt to the practice. If systems are indeed creating spurious trade legalities, GalCop is not preventing them.

Somewhat inevitably, at almost the same time, an entirely new market emerged, beneath the radar of GalCop's far-seeing eyes. As soon as a good was declared illegal to import the price of that good sky-rocketed, and the temptation to circumvent the restrictions GalCop was forced to impose was too great. Dock masters became a particular target, being offered high sums to fiddle manifest registries. Shadier stations began to offer customised smuggling compartments that provided a way to hide cargo from the customs scanning equipment. Contracts to move illicit cargo were also available from these locations.

While it was always present in some form or another, now the Galactic Underworld became almost mainstream. The galaxy had changed.

==Overview==
This OXP aims to broaden the scope and appeal of illegal goods in a number of ways.

===1. Illegal goods===
Illegal goods can now be any of the 17 different commodity types. So food might be declared illegal on one planet, computers on another. These things might change as well, so computers might be illegal for a few months, and then conditions are lifted and they are back to normal again.

Also, illegal trade goods will now be illegal to import(*). If you arrive at a GalCop station with visible illegal goods in your hold, you will be fined and your cargo will be confiscated. See also the section below on ''Bribing Officials''.

Even if you plan to stay on the right side to the law, this OXP can add variety to the way illegal goods are handled by the game, and make the process of shipping cargo across the galaxy more interesting.

Illegal goods notifications can be viewed on the F7 System Data screen, as well as via the F4 interface screen (see below). The F6 Galactic Chart will highlight systems within 7 LY that have illegal goods. Systems with just '''firearms''' as illegal will be shown with an '''orange diamond'''. Systems with other commodities, or with multiple commodities, will be shown with a '''yellow diamond'''.

(*) '''Slaves''' remain illegal to export, and they are the only commodity that is illegal to export. The reason for this is that some escape capsules end up being transported as slaves, and it's unfair to penalise the player for potentially rescuing downed pilots. It is recommended the [[Illegal_Goods_Tweak_OXP|Illegal Goods Tweak OXP]] be installed so that captured slaves can be released. For other fixes see [[Escape Pod]].

===2. Smuggling Compartment===
To help traders to work around these import restrictions a new piece of equipment, the smuggling compartment, can be purchased at non-GalCop stations (Rock Hermits in particular, but also other docking ports) in TL4 or greater systems.

Cargo can be moved into and out of the smuggling compartment via an F4 Interface screen "Smuggling Compartment Configuration". During flight, the "Smuggling Compartment Storage" primable equipment item allows for the transfer of cargo from the standard hold to the smuggling compartment. Cargo cannot be transferred out of the smuggling compartment during flight.

The smuggling compartment has, in most circumstances, around a 25-40% chance of being detected, based on tech level. GalCop is always improving their detection equipment, which means that the scanner resistant technology of the smuggling compartment needs to be updated regularly to cope. About every 30 days a "Version Upgrade" should be purchased (at TL5 or greater systems) for your smuggling compartment, which will install the latest scanner resistant technology and keep the chance of detection as good as it possibly can be.

This chance improves slightly once the "Phase Adjustment" equipment (available at TL7 or greater systems) is installed. With the phase adjustment equipment installed the phase setting of the hold can be adjusted, which can reduce the chance of being detected considerably. Phase settings can be picked up at Black Market noticeboard (which might be unreliable), or they can be purchased for a considerable cost. See also the Phase Scanner (below).

If your compartment is damaged during a battle, cargo may be lost, the same as with normal cargo. You will need to find a non-GalCop station to repair the damage, otherwise the entire compartment will be discovered and removed, and you will receive a bounty. If you have a ship overhaul performed at a GalCop station with the smuggling compartment, it will be discovered and removed, and you will receive a bounty. See also the section below on Bribing Officials.

===3. New equipment===
Apart from the smuggling compartment and phase adjustment tool, this OXP also introduces the following equipment items.

'''** Phase Scanner **''' 
TL8 or greater Anarchy systems will sometimes have a Phase Scanner available for purchase. The scanner can, when aimed at GalCop main stations, detect what phase setting the manifest scanners will be susceptible to. Once you know what the phase setting is for a particular government and tech level they can set the phase of their smuggling compartment and it will be almost undetectable to GalCop manifest scanners.

The Phase scanner is used by targeting the main station, priming the equipment and then activating it. It will take a few seconds to perform its job, and will consume a large amount of energy in the process - a naval energy unit is required. If you are too close to the station, or you are moving too slowly, the station will detect the scan and a bounty will be placed on you. If you then dock at the station the scanner will be removed. If you are too far away from the main station the scanner will not operate. If a police vessel catches you performing a scan you will receive a bounty and may find yourself under fire.

If your scanner is damaged you must get it repaired at a non-GalCop station, otherwise the equipment will be confiscated and you will receive a bounty. If you have a ship overhaul performed at a GalCop station while the equipment is on board, it will be removed as part of the overhaul and you will receive a bounty. But see also "Bribing Officials" below.

'''** Tech version upgrades **''' 
Technology improves every day, and the scanner resistant technology used in the smuggling compartment needs to be updated to keep in step with the times. So, the tech version upgrade will keep your smuggling compartment up-to-date. Available at TL5 or greater systems.

'''** Import Permits **''' 
While some goods might be declared illegal, you can still purchase a permit to import that good from the planet in question. Usually these permits are quite expensive.

Permits can only be used once, and will automatically be removed after use.

===4. Bribing Officials===
If your smuggling compartment is discovered during a renovation or when damaged, or you dock with illegal cargo in your hold, you can attempt to bribe the station officials. You will be asked to enter the amount of the bribe. If you pay attention to what the official says you can get an idea on whether a smaller amount will be required, but larger amounts will have a greater chance of being successful. If you are successful you will be able to keep all your cargo and equipment. If you are unsuccessful you will lose all smuggling-related equipment and may end up increasing the bounty on your head.

The Black Market noticeboard (see below) can be useful in finding systems where the dock master and other customs officials can be bribed for a reasonable amount.

===5. New Interfaces screens===
'''** Black market **''' 
See the [[Black Market]] page for more information about the Black Market.

'''** Dock master **''' 
When docked at a main station, and when the dock master is available (he doesn't work 24/7!) from this interface you can ask him about any good milk runs he/she is aware of, or you can try to bribe them into changing your cargo manifest for you.

'''** Illegal goods information **''' 
Illegal goods are changing all the time. To try to keep track of the potential chaos, this interface screen will initially show you the latest changes to illegal goods in the sector, plus it offers the following options: 
a. List of all illegal goods in the galaxy. Here you can see it all. 
b. List of all illegal goods within 7LY of your current system. 
c. List of illegal goods on your current course. If you have a long, cross-chart trip planned, this option will tell you what's illegal on the way, and flagging which ones you have a permit for (if any). 
d. List of all import permits. This is what you are authorised (legally or not) to import. 
e. List of all Rock Hermit waypoints purchased.

== Tips ==
One now needs to keep abreast of developments in the systems one is about to visit. This ''can'' be done using the new F4 choices. And it can ''also'' be done using the F7 screen - and if one's route has been plotted using the [[ANA]], one can view the different systems along the route in F7 using the left/right arrow keys.

----
==Adding additional commodities==
Additional commodities can be added to the system by doing the following:
* '''Adding the commodity permit cost, and price factors.'''

var sbi = worldScripts.Smugglers_Illegal; 
sbi._commodityInfo["my_commodity_key"] = [permitCost, factorIncIllegal, factorIncBM];
// permitCost = How much an import permit will cost for this commodity (eg 2000)
// factorIncIllegal = The factor to increase this commodity by when it is flagged as illegal (eg 2.5 = 2.5 times original price)
// factorIncBM = The factor to increase this commodity by at a black market
// when it is flagged illegal at the main station (eg 1.4 = 1.4 times standard price)

* '''Adding illegal possibilities for this commodity to the pool'''

var sbi = worldScripts.Smugglers_Illegal;
sbi._possibilities.push({
govTypes:"0,3",
commodity:"my_commodity_key",
properties:"",
permit:1,
scale:1,
period:30,
chance:0.5,
description:"A brief description of the in-game reason for making this commodity illegal."});
/*
govTypes: Comma-separated list of government types (0-7) this definition can apply to eg ("0,1,2")
commodity: Comma-separated list of commodity names this definition will apply to (eg "food,my_commodity_key").
properties: Comma-separated list of text search strings to use against the planetary description.
For instance, "civil war" would only select planets that have "civil war" in their description.
"drink|brew" would only select planets that have "drink" or "brew" in their description.
permit: Boolean value (0 or 1) indicating whether a permit can be purchased for this commodity
scale: The legality scale to apply to this commodity.
The scale will apply when calculating the bounty to apply to a player caught smuggling
illegal goods as a multiplier. Most illegal goods have a scale of 1. Slaves have 2.
period: The period (in days) this definition will be active for.
chance: A chance factor, between 0 (never) and 1 (very often), to apply when selecting this definition
description: The description to display for this definition.
*/

* '''Add the [[Market Script Interface]] market script to your commodity.'''
The [[Market Script Interface]] OXP enables multi-OXP interfaces to the same market script, and is how Smugglers enables the legal/illegal flags to be set for each commodity.

In the commodity definition in your "trade-goods.plist" file, add the following line:

"market_script" = "msi_tradegoods_market.js";

Note: If your commodity definition already has a "market_script" defined, you will need to interface your code with [[Market Script Interface]], to enable it to work with the Smugglers version.

==Notes==
* This OXP updates the "oolite-contracts-cargo.js" file with a new version of the _initialiseCargoContractsForSystem function that excludes illegal goods from being selected for standard cargo contracts.
* Related to the previous note, this OXP also updates the _initialiseCargoContractsForSystem function of Switech's Cargo-Contract-Mod, to exclcude illegal goods from being selected for standard cargo contracts.
* This OXP also changes the logic of the "Legal" column on the F8 Market screen. Previously, goods that were illegal to export were marked with "Im", and goods illegal to import were marked with "Ex". This logic has been reversed, and the column relabelled as "Ban" to indicate what type of ban is in place.

==Special Note==
Because of the complex nature of this OXP, the possibility for conflicts is great, so please report any bugs or unexpected outcomes. Don't assume someone else has noticed it - if two people report a bug it makes tracking the bug down so much easier!

And it goes without saying that I'd like to hear from you if you have any suggestions on how the OXP could be improved.

==Requirements==
The [[Market Script Interface]] OXP is a requirement for this pack. 
The [[Black Market]] OXP is a requirement for this pack.

==Incompatible OXP's==
At present, this OXP is incompatible with the following OXPs:
* [[New_Cargoes|New Cargoes]] v1.2.3: The system of permits, how it stores cargo, and how it controls illegal goods are all potentially conflicting. See New Cargoes for a link to a detailed analysis.
However, version 2 of New Cargoes is compatible with Smugglers.

This conflict has been recorded in the manifest file, so if you have New Cargoes installed the "Smugglers" OXP will not load.

==Installation==
Place the 'Smugglers_2.11.oxz' or 'Smugglers.oxp' (extracted from the ZIP file download) into your 'AddOns' folder and when you start the game, hold down 'Shift' until you see the spinning Cobra.

==Download==
Download [[Media:Smugglers_2.12.oxz|Smugglers_2.12.oxz]] v2.12 (downloaded {{#downloads:Smugglers_2.12.oxz}} times). 
Download [https://app.box.com/s/9zwazfe98cg2z89bmpn7mmhypm24d3zj Smugglers.zip] v2.12 (extract OXP folder to AddOns)

==License==
This OXP is released under the Creative Commons Attribution - Non-Commercial - Share Alike 3.0 license. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/

Skull and crossbones image from https://commons.wikimedia.org/wiki/File:Skull_and_crossbones.png. 
Warning image from http://simpleicon.com/warning-3.html. 
Chat image from http://simpleicon.com/chat-2.html. 
ID image from http://simpleicon.com/id_card.html. 
Lock image from http://simpleicon.com/lock-2.html. 
Cupboard image from http://simpleicon.com/cupboard_4.html 
Candle image from http://simpleicon.com/candle-2.html. 
Form image from http://simpleicon.com/admite_form_1.html. 
Map marker image from http://simpleicon.com/map_marker.html.

With the help of: 
Layne, Stormrider, Norby, cim, Diziet Sma, Cody, and all the people on the BB who offered suggestions and ideas to make this OXP as good as it could be. If the OXP fails in any way, is it because of my limitations as a programmer, not because of the paucity of your ideas and contributions!

==Version History==
2.12
* Smugglers Guidebook now only purchasable through the Black Market.

2.11
* Added Smuggler's Guidebook to the Ship's Library (if installed).
* Added check for the Market Screen Legal Column mod.
* Tweaked some mission screens for better positioning.
* The initial entry point to "Import Permits" and "Smuggling Compartments" is now free, so you no longer need a minimum cash balance to see what permits are available or what the Smuggling Compartment options are. If using Oolite 1.92, the amount and install time columns will also be suppressed for these items.

2.10
* Fixed issue with inverted logic check in monkey-patch for Switech's cargo contract mod.

2.9
* Updated monkey-patch for Switech's cargo contract mod.

2.8
* Fixed issue with cargo storage when New Cargoes not installed.

2.7
* Darkened overlay images for better compatibility with Oolite 1.92.

2.6
* Moved all text into descriptions.plist or missiontext.plist for easier localisation.
* Corrected information in readme.txt.
* Pushed out tech upgrades to every 60 days (rather than every 30).
* When asked about milkruns, the Dock Master will now show a short range chart or the run, rather than a long range chart.

2.5
* Tokenised descriptions to reduce size of save file.
* Added shortcut keys to short & long range charts.
* Added text to Contextual Help.

2.4
* Bug Fixes.

2.3
* Fixed bug introduced when changing over to use the Market Script Interface.
* Fixed syntax error in Dock Master script.

2.2
* Allows color and shape of chart markers for illegal goods to be changed via Library Config.
* Tweaked the returns and time frames for gold, platinum and gem stones, to not be quite so generous or easy to exploit.
* Fixed issue where illegal goods were not being created if starting a new game with the "Easy Start" option.
* Code refactoring.

2.1.1
* Removed reference to blackmarket script from world-scripts.plist.

2.1
* Enabled equipment conditions, which had been turned off for testing.

2.0
* Updated market script process to use new [[Market Script Interface]] OXP.
* Switched pricing change to be inside market script callbacks (so they will now show up on sample price calculations).
* Made compatible with [[New Cargoes]] OXP (version 2.0)
* Split off [[Black Market]] into its own OXP, and made it a requirement of this OXP.

1.5.8
* Fixed some potential referencing errors with mission screens.

1.5.7
* Added extra facility for removing the Black Market on stations.

1.5.6
* Better use of new functions available in later versions of Oolite.
* Removed code that was deleting TL1 phase scan settings.
* Bug fixes.

1.5.5
* List of illegal goods displayed on F7 system data screen will now be shown inflight, but without reasons (ie just a list of illegal goods).
* Additional checking types added to ship condition checking routine.
* Bug fixes.

1.5.4
* Moving kg or g type commodities will now force the Manifest MFD to update.
* Better integration with Escape Pod Tweaks. Scooped escape pods can no longer be transferred to the smuggling compartment.
* Equipment.plist corrections.
* Updates to readme.txt file.

1.5.3
* Removed 1t cargo space requirement for in-flight storage equipment, to ensure it is always available when a smuggling compartment is installed.
* Removed incorrect Naval Energy Unit requirement for in-flight storage equipment.
* Code refactoring.

1.5.2
* Fixed issue with the in-flight storage function not handling all conditions when checking scooped cargo.
<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">
1.5.1
* Fixed broken integration with "Escape Pod Tweaks".

1.5.0
* Added new options for when player is caught in a sting operation: pay a fine amount, accept a legal penalty, or attempt to bribe their way out of trouble.
* System productivity now has an influence on the amount you need to offer when bribing officials.
* Calculation of the maximum smuggling compartment size now factors in current smuggling compartment size so all downgrade options are available (not just the ones that would fix in the current available space).
* Fixed damage/repair process.
* Fixed issue with smuggling compartment damage resetting the tech level of the compartment.
* Fixed incorrect description lookup key.
* Improved integration with the "Escape Pod Tweaks" OXP.
* Code cleanup.

1.4.2
* Systems with illegal goods marked on the map will now have their marks removed after loading the game if the setting switch is turned off via Library Config.

1.4.1
* Primable equipment now given to player who already had a smuggling compartment installed.

1.4.0
* Added primable equipment which allows cargo to be moved to the smuggling compartment during flight.
* Fixed issue on "Move cargo out" screen, showing "[avail]" instead of available compartment space.
* Removed decimal point values from showing for available compartment space.
* Better handling of kg and g commodities.
* Fixed issue with outrageous amounts being offered for narcotics and slaves on the Black Market.

1.3.2
* Better handling of interstellar space conditions.

1.3.1
* Added options to [[Library OXP|Library]] Config to control whether systems with illegal goods are marked on the galaxy map.

1.3.0
* It is now possible to add new commodities to the list of illegal goods possibilities.
* The dock master can now relabel cargo as new (ie. non-core) commodities.
* System map will now be shown when the dock master informs player of a milk run, highlighting the two systems.
* Illegal goods on route will now handle not having the Advanced Navigation Array correctly.
* Cleaned up overlay images.

1.2.2
* Added "display_color" property to some equipment items (Oolite v1.85/86 only).
* Added integration options for "Bounty System - Most Wanted" OXP.
* Better handling of interstellar space.
* Code refactoring.

1.2.1
* Fix for crazy prices being applied after a saved game is reloaded.

1.2.0
* Changed method of adjusting prices to work better with other OXP's that adjust prices.
* Fixed Javascript error when attempting to sell illegal cargo through the Black Market.
* Added console message confirming sale of illegal cargo through the Black Market.
* Code cleanup.

1.1.4
* Arranged data on illegal goods lists to be in columns.
* Removed hard-coded scanner range values.

1.1.3
* Fixed error where function to remove sting ship monkey patches wasn't being passed the correct parameter.

1.1.2
* Added code for putting smuggling contracts on the Bulletin board system if the Contracts On BB OXP is also installed.
* Code refactoring.

1.1.1
* Fixed some spelling mistakes.
* Added "machinery" to list of commodities the "Visible As" property of a smuggling compartment can be set to.
* Fixed issue with not being able to move machinery into or out of the smuggling compartment.
* Fixed issue with not being able to purchase or sell machinery directly from the smuggling compartment.

1.1.0
* Additional info on F7 screen is now only available when docked to stop the information from overrunning the HUD.
* Corrected use of "techLevel"/"techlevel" on systemInfo objects.
* Re-fixed issue with amount of gold, platinum and gemstones taking up the same amount of smuggling cargo space as normal cargo space.

1.0.0
* Bug fixes.

0.9.0
* Added new Black Market option, enabling the sale of rare or expensive equipment items (eg naval-sourced equipment)
* Added ability for 3rd party OXP's to add items for sale to the Black Market.
* Fixed incorrect label in descriptions.plist.
* Fixed issue where a smuggling compartment repair item was being displayed when the unit wasn't damaged.
* Add ability for sting ship to respond to cloaked attacks.
* Better handling of interstellar space conditions.
* Some values were not being reset correctly after a galactic jump.
* Police ship model used on all police-related screens displayed at that station will now be the same model.
* Sound effects added for mode/activate functions of phase scanner.

0.8.1
* Fixed issue where opening the "Purchase Smuggling Compartment" screen was turning off the HUD and not turning it back on again.

0.8.0
* Fixed Javascript error when opening the market info details screen for a commodity in interstellar space.
* Added $isGoodIllegal function to Smugglers_Illegal.

0.7.9
* Fixed issue where docking will illegal goods and rescued escape pods was not allowing the player to bribe the station officials.

0.7.8
* Fixed issue where illegal good definitions were not being applied correctly in every situation.

0.7.7
* Fixed issue with smuggling compartments of various sizes appearing on the equipment screen.

0.7.6
* Better handling of situation where another OXP removes the smuggling compartment.
* Fixed issue with contracts where a Javascript error could occur in rare circumstances.
* Fixed Javascript error with script attached to police sting ship.
* Improved sting ship compatibility with other worldScripts.
* Really (hopefully, maybe) fixed vector error in Blackmarket script.
* Changed "==" comparisons to "===" for performance improvements.

0.7.5
* Fixed Javascript vector error in Blackmarket script.
* Added code to make use of enhanced F7 screen features in Oolite 1.83/4.

0.7.4
* Reconfigured the cargo contracts fixes to work with the default contract code and with Switech's cargo contract mod OXP.
* Removed unnecessary "requires.plist" file.
* Extra checking for the presence of the sting ship to prevent null errors.
* Fixed issue where smuggling equipment was not being offered for sale anywhere.
* Fixed issue where the phase scanner was not being offered for sale at any time.
* Fixed issue where going into the smuggling compartment purchase page multiple times without actually purchasing something was deducting money anyway.
* Adjusted the price of the phase scanner.
* Tidying up of some equipment installation rules.
* F7 screen was turning off HUD when in flight in some circumstances.

0.7.3
* Fixed issue with incorrect text showing on F8F8 commodity info screen.
* Included current system in list of planets shown on "Illegal imports on current course" option.
* Fixed issue with the Black Market welcome text, which was not being correctly reset upon docking.

0.7.2
* Fixed loop variable pointer error in Black Market script.

0.7.1
* Fixed timer setup bug in Black Market script.

0.7.0
* Updated all bounty changes to use "setBounty", rather than just updating the bounty directly, so a description can be passed to other OXP's.
* Expanded the use of the "properties" element of illegal definitions, so that multiple options can be entered (eg "cuisine,meat,steak").
* Added a couple of extra illegal goods definitions.
* Added the ability to sell illegal cargo on the Black Market, for a reduced price. Plus some extra things...
* Added Seedy Space Bars to list of stations that have a Black Market.
* Moved a lot of static text into descriptions.plist and missiontext.plist.
* Fixed issue with only 500kg of gold or platinum taking up 1t of smuggling cargo space, and 500000g of gemstones.
* Removed redundant items from equipment.plist.
* Fixed bug when using a HUD that doesn't implement the "Big GUI" option, where the HUD was being turned off when displaying some mission screens, but wasn't being turned back on again.
* In Oolite 1.83 the bugfix relating to damaged equipment items that take up cargo space is resolved, so code has been added to switch to using the in-built repair methods, rather than keeping a long list of "Repair" equipment items. For backwards compatibility with 1.82, however, those items are still present.
* Adjusted the costs of repair items to be more in-line with how the core system handles repair costs.
* Improved integration with Illegal Goods Tweak. When docking with slaves, IGT will always run first, and Smugglers will be called afterwards.
* Updated screenID's to enable BGS background sounds.
* Renamed background overlay images to prevent possibility of future duplication.
* Added checks for null value in station allegiance.
* Updated the check for "Allow Big GUI".
* Cleaned up sound function to avoid the need to check for BGS.
* Toned down overlay images.
* Code refactoring.

0.6.2
* Fixed bug with checking for and removing used permits.
* Fixed issue where Constrictor hunt mission hints were being pushed off the System Data screen by all the illegal goods notifications.
* Added extra overlay image for purchasing Permits.
* Added extra overlay image for Rock Hermit waypoint list.

0.6.1
* Using escape pod will now empty smuggler's compartment.
* Pared down "trade-goods.plist" to only contain required information, hopefully making it compatible with "Risk based economy" v2 OXP and BlOomberg Markets OXP.
* Removing the smuggling compartment or phase scanner at a Rock Hermit (or other non-GalCop station) will now refund the full cost, rather than just 70%.
* Changing the size of the smuggling compartment will refund the full price of the old size first, before purchasing the new size.
* Fixed bug when starting new game.
* Fixed issue where the message about delivering illegal goods via a cargo contract was appearing incorrectly.

0.6.0
* Fixed issue where illegal flags were not appearing on secondary stations, removed need to have planetinfo.plist.
* Removed log file debug code.

0.5.0
* Fixed bug with selling relabelled cargo.
* Fixed issue with delivering a standard cargo contract to a system where the cargo has become illegal after accepting the contract. The player was not being given the opportunity to bribe a docking official to clear their bounty.
* Fixed issue where, after using the phase scanner and being discovered using it, and then docking, the player was not being given the opportunity to bribe their way out of trouble.
* Added emails for various actions, when the Email System OXP is in use.
* Changed skull and crossbones background image for Black Market.
* Improved integration with [[Illegal_Goods_Tweak_OXP|Illegal Goods Tweak OXP]] (v2.2.0). The inital screen IGT displays will now look like an Amnesty Intergalactic screen, rather than a GalCop one, and the player has only two choices: hand over the slaves, or work with GalCop. If they choose the latter, Smugglers will include slaves as part of its import restrictions and the player can bribe as normal if they choose to.

0.4.0
* Fixed issue where you could purchase any smuggling compartment, regardless of how much credit you have.
* Added player credit balance to smuggling compartment purchase screen.
* Added player credit balance to Black Market purchasing screens.
* Tightened up which stations will have a Black Market.
* Added government icon and TL to all purchase screens in Black Market.
* Tweaks to the calculation of phase scan noticeboard items.
* Improvements to the page handling for illegal goods.

0.3.1
* Fixed mangled manifest.plist file.

0.3.0
* Tweaks to the minimum tech level for purchasing smuggling equipment items.
* Further adjustments to precious metals and gem stones illegal notifications for better economic balance.
* Added overlay background images to various interface screens.
* Smuggling compartment repair costs now linked to size of compartment.
* Arriving in a system where you have a permit but no cargo for that permit will no longer remove the permit.
* Routine to create new illegal goods will now exclude the current system, to prevent the issue where the engine understands a good is illegal, but the game interface doesn't.
* Added extra checks to the docking process to ensure a good that the engine understands is illegal is also marked as illegal on the market screen before penalising the player.
* Added police ship models to all the after-dock screens.

0.2.0
* Made the price of RH waypoints, fake permits and phase scans related to the station price factor.
* Bribing the same station multiple times will increase the required amount of the bribe (by 10 or 20 percent each time).
* Added the last successful bribe amount to the screen where you enter a bribe amount.
* Reduced the police vessel detection range for the phase scanner, as their ships wouldn't have the same range as the main station.
* Main station market quantity of illegal goods under contract now set to zero (so, when arriving short, the player can't just buy the difference, launch and redock to complete the contract).
* Fixed issue where you could purchase anything from the Black Market, regardless of how much credit you have.
* Limited smuggling compartment options to standard commodities only.
* Fixed issue where wrong illegal goods were being picked up if the player followed another ship through a wormhole.
* Rebalanced prices for precious metals and gem stones.
* Damaged smuggling compartments and phase scanners can now be repaired, and better handling of damaged equipment in general.
* Fixed issue where phase scanner would not show up for purchase anywhere.
* Fixed issue where having 0t available space would not allow transfer of precious metals from smuggling compartment to standard hold.
* Added a new item to the Illegal Goods interface screen that lists all purchased Rock Hermit waypoints.
* Fixed issue with tech upgrades, where the option to purchase new ones was always available, no matter how many times you purchased it.
* Adjusted the price of the tech upgrade.
* Bug fixes.

0.1.2
* Added missing semi-colon to planetinfo.plist.
* Found additional spot where techlevel was showing 1 lower than actual.
* Fixed issue where phase scans for TL 1 systems would not show up in the list of discovered phase scans.

0.1.1
* Tech levels on all displays were showing 1 lower than actual.
* Attempting to bribe a dock master to relabel cargo when you don't have any cargo that can be relabeled would put the game into a locked state.
* Spelling corrections.

0.1.0
* Initial public release
</div>

== Links ==
*[https://bb.oolite.space/viewtopic.php?f=4&t=17723 BB Thread for this OXP]
*[https://bb.oolite.space/viewtopic.php?f=4&t=17179 Idea for Smugglers OXP] (2015) Fons et origo of this OXP
*[https://bb.oolite.space/viewtopic.php?f=2&t=17675 Legal column on Market screen] (2015) related discussion of the confusions inherent in the Legal column.

*[https://bb.oolite.space/viewtopic.php?p=204379#p204379 Expanded version of the smuggling proposal] (Elite: Dangerous - Design Decision Forum: 2013)

==Quick Facts==
{{OXPLevel|2}}{{IconOXP|ooVersion="1.82"|oxpCPU="Average"|oxpMEM="Average"|oxpGPU="Low"|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
{{Infobox OXPb| title = Smugglers.oxz
|version = 2.12
|release = 2026-05-10
|license = CC BY-NC-SA 3.0
|features = Equipment, Commodities
|category = Mechanics OXPs
|author = [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=17723 Oolite BB]
}}

==Gameplay and Balance indicator==
[[Image:tag-colour-orange.png]]

Smugglers - The Galactic Underworld

2026-05-10T12:18:29Z

Phkb:

[[File:Smugglers' News Flash.png|right|500px]]
Makes any commodity potentially illegal to import in various systems, and adds equipment and contracts for those interested in smuggling goods outside normal legal channels.

==Introduction==
Historically, in both the original Elite and therefore in Oolite, there were three illegal goods: slaves, narcotics and firearms. These were illegal to export from all GalCop stations, and there was no variation or flexibility in those items. This OXP aims to expand what goods are illegal, making it far more variable. There are new interface screens to show what items are illegal and where, a new Black Market available from Rock Hermits and other stations, and new equipment items to aid in smuggling cargo.

==Background==
It started with a single system.

[[Sector1/Ceedra|Ceedra]], an insignificant confederacy in an unfrequented arm of galactic sector 1. They had been receiving some contaminated imported food from the nearby Anarchy system [[Sector1/Isdibi|Isdibi]], possibly random or possibly intentional as a way to destabilise the government, it was difficult to tell. But a request was made to [[GalCop]] to put an import ban on food and force any traders that bring food to the station to hand it over for destruction.

The impact was almost immediate. Traders were outraged that their harmless cargo of wheat and grains were being taken away, which had never before happened in GalCop history, plus they received a bounty for doing so, doubling the pain. Messages were sent, trade delegations made an outward show of force, but GalCop's hands were tied. This was the decision of the planet in question, and under GalCop law they were perfectly entitled to impose import restrictions, beyond the export restrictions that had long been in place for slaves or narcotics.

Suddenly the floodgates were opened. System after system found reason to ban goods, from basic staples like food or textiles, up to the traders standard fare of computers, furs and liquor. Even precious metals were banned in some systems, often for rather obscure reasons. And always, once a ban was in place, the price would hit the roof.

Some commentators have suggested there is evidence that certain systems were requesting a good to be made illegal purely for the jump in price that naturally follows and the bump in traffic that accompanies extra profits. While GalCop have been sought for comment, none has been forthcoming, and nothing appears to be able to bring a halt to the practice. If systems are indeed creating spurious trade legalities, GalCop is not preventing them.

Somewhat inevitably, at almost the same time, an entirely new market emerged, beneath the radar of GalCop's far-seeing eyes. As soon as a good was declared illegal to import the price of that good sky-rocketed, and the temptation to circumvent the restrictions GalCop was forced to impose was too great. Dock masters became a particular target, being offered high sums to fiddle manifest registries. Shadier stations began to offer customised smuggling compartments that provided a way to hide cargo from the customs scanning equipment. Contracts to move illicit cargo were also available from these locations.

While it was always present in some form or another, now the Galactic Underworld became almost mainstream. The galaxy had changed.

==Overview==
This OXP aims to broaden the scope and appeal of illegal goods in a number of ways.

===1. Illegal goods===
Illegal goods can now be any of the 17 different commodity types. So food might be declared illegal on one planet, computers on another. These things might change as well, so computers might be illegal for a few months, and then conditions are lifted and they are back to normal again.

Also, illegal trade goods will now be illegal to import(*). If you arrive at a GalCop station with visible illegal goods in your hold, you will be fined and your cargo will be confiscated. See also the section below on ''Bribing Officials''.

Even if you plan to stay on the right side to the law, this OXP can add variety to the way illegal goods are handled by the game, and make the process of shipping cargo across the galaxy more interesting.

Illegal goods notifications can be viewed on the F7 System Data screen, as well as via the F4 interface screen (see below). The F6 Galactic Chart will highlight systems within 7 LY that have illegal goods. Systems with just '''firearms''' as illegal will be shown with an '''orange diamond'''. Systems with other commodities, or with multiple commodities, will be shown with a '''yellow diamond'''.

(*) '''Slaves''' remain illegal to export, and they are the only commodity that is illegal to export. The reason for this is that some escape capsules end up being transported as slaves, and it's unfair to penalise the player for potentially rescuing downed pilots. It is recommended the [[Illegal_Goods_Tweak_OXP|Illegal Goods Tweak OXP]] be installed so that captured slaves can be released. For other fixes see [[Escape Pod]].

===2. Smuggling Compartment===
To help traders to work around these import restrictions a new piece of equipment, the smuggling compartment, can be purchased at non-GalCop stations (Rock Hermits in particular, but also other docking ports) in TL4 or greater systems.

Cargo can be moved into and out of the smuggling compartment via an F4 Interface screen "Smuggling Compartment Configuration". During flight, the "Smuggling Compartment Storage" primable equipment item allows for the transfer of cargo from the standard hold to the smuggling compartment. Cargo cannot be transferred out of the smuggling compartment during flight.

The smuggling compartment has, in most circumstances, around a 25-40% chance of being detected, based on tech level. GalCop is always improving their detection equipment, which means that the scanner resistant technology of the smuggling compartment needs to be updated regularly to cope. About every 30 days a "Version Upgrade" should be purchased (at TL5 or greater systems) for your smuggling compartment, which will install the latest scanner resistant technology and keep the chance of detection as good as it possibly can be.

This chance improves slightly once the "Phase Adjustment" equipment (available at TL7 or greater systems) is installed. With the phase adjustment equipment installed the phase setting of the hold can be adjusted, which can reduce the chance of being detected considerably. Phase settings can be picked up at Black Market noticeboard (which might be unreliable), or they can be purchased for a considerable cost. See also the Phase Scanner (below).

If your compartment is damaged during a battle, cargo may be lost, the same as with normal cargo. You will need to find a non-GalCop station to repair the damage, otherwise the entire compartment will be discovered and removed, and you will receive a bounty. If you have a ship overhaul performed at a GalCop station with the smuggling compartment, it will be discovered and removed, and you will receive a bounty. See also the section below on Bribing Officials.

===3. New equipment===
Apart from the smuggling compartment and phase adjustment tool, this OXP also introduces the following equipment items.

'''** Phase Scanner **''' 
TL8 or greater Anarchy systems will sometimes have a Phase Scanner available for purchase. The scanner can, when aimed at GalCop main stations, detect what phase setting the manifest scanners will be susceptible to. Once you know what the phase setting is for a particular government and tech level they can set the phase of their smuggling compartment and it will be almost undetectable to GalCop manifest scanners.

The Phase scanner is used by targeting the main station, priming the equipment and then activating it. It will take a few seconds to perform its job, and will consume a large amount of energy in the process - a naval energy unit is required. If you are too close to the station, or you are moving too slowly, the station will detect the scan and a bounty will be placed on you. If you then dock at the station the scanner will be removed. If you are too far away from the main station the scanner will not operate. If a police vessel catches you performing a scan you will receive a bounty and may find yourself under fire.

If your scanner is damaged you must get it repaired at a non-GalCop station, otherwise the equipment will be confiscated and you will receive a bounty. If you have a ship overhaul performed at a GalCop station while the equipment is on board, it will be removed as part of the overhaul and you will receive a bounty. But see also "Bribing Officials" below.

'''** Tech version upgrades **''' 
Technology improves every day, and the scanner resistant technology used in the smuggling compartment needs to be updated to keep in step with the times. So, the tech version upgrade will keep your smuggling compartment up-to-date. Available at TL5 or greater systems.

'''** Import Permits **''' 
While some goods might be declared illegal, you can still purchase a permit to import that good from the planet in question. Usually these permits are quite expensive.

Permits can only be used once, and will automatically be removed after use.

===4. Bribing Officials===
If your smuggling compartment is discovered during a renovation or when damaged, or you dock with illegal cargo in your hold, you can attempt to bribe the station officials. You will be asked to enter the amount of the bribe. If you pay attention to what the official says you can get an idea on whether a smaller amount will be required, but larger amounts will have a greater chance of being successful. If you are successful you will be able to keep all your cargo and equipment. If you are unsuccessful you will lose all smuggling-related equipment and may end up increasing the bounty on your head.

The Black Market noticeboard (see below) can be useful in finding systems where the dock master and other customs officials can be bribed for a reasonable amount.

===5. New Interfaces screens===
'''** Black market **''' 
See the [[Black Market]] page for more information about the Black Market.

'''** Dock master **''' 
When docked at a main station, and when the dock master is available (he doesn't work 24/7!) from this interface you can ask him about any good milk runs he/she is aware of, or you can try to bribe them into changing your cargo manifest for you.

'''** Illegal goods information **''' 
Illegal goods are changing all the time. To try to keep track of the potential chaos, this interface screen will initially show you the latest changes to illegal goods in the sector, plus it offers the following options: 
a. List of all illegal goods in the galaxy. Here you can see it all. 
b. List of all illegal goods within 7LY of your current system. 
c. List of illegal goods on your current course. If you have a long, cross-chart trip planned, this option will tell you what's illegal on the way, and flagging which ones you have a permit for (if any). 
d. List of all import permits. This is what you are authorised (legally or not) to import. 
e. List of all Rock Hermit waypoints purchased.

== Tips ==
One now needs to keep abreast of developments in the systems one is about to visit. This ''can'' be done using the new F4 choices. And it can ''also'' be done using the F7 screen - and if one's route has been plotted using the [[ANA]], one can view the different systems along the route in F7 using the left/right arrow keys.

----
==Adding additional commodities==
Additional commodities can be added to the system by doing the following:
* '''Adding the commodity permit cost, and price factors.'''

var sbi = worldScripts.Smugglers_Illegal; 
sbi._commodityInfo["my_commodity_key"] = [permitCost, factorIncIllegal, factorIncBM];
// permitCost = How much an import permit will cost for this commodity (eg 2000)
// factorIncIllegal = The factor to increase this commodity by when it is flagged as illegal (eg 2.5 = 2.5 times original price)
// factorIncBM = The factor to increase this commodity by at a black market
// when it is flagged illegal at the main station (eg 1.4 = 1.4 times standard price)

* '''Adding illegal possibilities for this commodity to the pool'''

var sbi = worldScripts.Smugglers_Illegal;
sbi._possibilities.push({
govTypes:"0,3",
commodity:"my_commodity_key",
properties:"",
permit:1,
scale:1,
period:30,
chance:0.5,
description:"A brief description of the in-game reason for making this commodity illegal."});
/*
govTypes: Comma-separated list of government types (0-7) this definition can apply to eg ("0,1,2")
commodity: Comma-separated list of commodity names this definition will apply to (eg "food,my_commodity_key").
properties: Comma-separated list of text search strings to use against the planetary description.
For instance, "civil war" would only select planets that have "civil war" in their description.
"drink|brew" would only select planets that have "drink" or "brew" in their description.
permit: Boolean value (0 or 1) indicating whether a permit can be purchased for this commodity
scale: The legality scale to apply to this commodity.
The scale will apply when calculating the bounty to apply to a player caught smuggling
illegal goods as a multiplier. Most illegal goods have a scale of 1. Slaves have 2.
period: The period (in days) this definition will be active for.
chance: A chance factor, between 0 (never) and 1 (very often), to apply when selecting this definition
description: The description to display for this definition.
*/

* '''Add the [[Market Script Interface]] market script to your commodity.'''
The [[Market Script Interface]] OXP enables multi-OXP interfaces to the same market script, and is how Smugglers enables the legal/illegal flags to be set for each commodity.

In the commodity definition in your "trade-goods.plist" file, add the following line:

"market_script" = "msi_tradegoods_market.js";

Note: If your commodity definition already has a "market_script" defined, you will need to interface your code with [[Market Script Interface]], to enable it to work with the Smugglers version.

==Notes==
* This OXP updates the "oolite-contracts-cargo.js" file with a new version of the _initialiseCargoContractsForSystem function that excludes illegal goods from being selected for standard cargo contracts.
* Related to the previous note, this OXP also updates the _initialiseCargoContractsForSystem function of Switech's Cargo-Contract-Mod, to exclcude illegal goods from being selected for standard cargo contracts.
* This OXP also changes the logic of the "Legal" column on the F8 Market screen. Previously, goods that were illegal to export were marked with "Im", and goods illegal to import were marked with "Ex". This logic has been reversed, and the column relabelled as "Ban" to indicate what type of ban is in place.

==Special Note==
Because of the complex nature of this OXP, the possibility for conflicts is great, so please report any bugs or unexpected outcomes. Don't assume someone else has noticed it - if two people report a bug it makes tracking the bug down so much easier!

And it goes without saying that I'd like to hear from you if you have any suggestions on how the OXP could be improved.

==Requirements==
The [[Market Script Interface]] OXP is a requirement for this pack. 
The [[Black Market]] OXP is a requirement for this pack.

==Incompatible OXP's==
At present, this OXP is incompatible with the following OXPs:
* [[New_Cargoes|New Cargoes]] v1.2.3: The system of permits, how it stores cargo, and how it controls illegal goods are all potentially conflicting. See New Cargoes for a link to a detailed analysis.
However, version 2 of New Cargoes is compatible with Smugglers.

This conflict has been recorded in the manifest file, so if you have New Cargoes installed the "Smugglers" OXP will not load.

==Installation==
Place the 'Smugglers_2.11.oxz' or 'Smugglers.oxp' (extracted from the ZIP file download) into your 'AddOns' folder and when you start the game, hold down 'Shift' until you see the spinning Cobra.

==Download==
Download [[Media:Smugglers_2.12.oxz|Smugglers_2.12.oxz]] v2.12 (downloaded {{#downloads:Smugglers_2.12.oxz}} times). 
Download [https://app.box.com/s/9zwazfe98cg2z89bmpn7mmhypm24d3zj Smugglers.zip] v2.11 (extract OXP folder to AddOns)

==License==
This OXP is released under the Creative Commons Attribution - Non-Commercial - Share Alike 3.0 license. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/

Skull and crossbones image from https://commons.wikimedia.org/wiki/File:Skull_and_crossbones.png. 
Warning image from http://simpleicon.com/warning-3.html. 
Chat image from http://simpleicon.com/chat-2.html. 
ID image from http://simpleicon.com/id_card.html. 
Lock image from http://simpleicon.com/lock-2.html. 
Cupboard image from http://simpleicon.com/cupboard_4.html 
Candle image from http://simpleicon.com/candle-2.html. 
Form image from http://simpleicon.com/admite_form_1.html. 
Map marker image from http://simpleicon.com/map_marker.html.

With the help of: 
Layne, Stormrider, Norby, cim, Diziet Sma, Cody, and all the people on the BB who offered suggestions and ideas to make this OXP as good as it could be. If the OXP fails in any way, is it because of my limitations as a programmer, not because of the paucity of your ideas and contributions!

==Version History==
2.12
* Smugglers Guidebook now only purchasable through the Black Market.

2.11
* Added Smuggler's Guidebook to the Ship's Library (if installed).
* Added check for the Market Screen Legal Column mod.
* Tweaked some mission screens for better positioning.
* The initial entry point to "Import Permits" and "Smuggling Compartments" is now free, so you no longer need a minimum cash balance to see what permits are available or what the Smuggling Compartment options are. If using Oolite 1.92, the amount and install time columns will also be suppressed for these items.

2.10
* Fixed issue with inverted logic check in monkey-patch for Switech's cargo contract mod.

2.9
* Updated monkey-patch for Switech's cargo contract mod.

2.8
* Fixed issue with cargo storage when New Cargoes not installed.

2.7
* Darkened overlay images for better compatibility with Oolite 1.92.

2.6
* Moved all text into descriptions.plist or missiontext.plist for easier localisation.
* Corrected information in readme.txt.
* Pushed out tech upgrades to every 60 days (rather than every 30).
* When asked about milkruns, the Dock Master will now show a short range chart or the run, rather than a long range chart.

2.5
* Tokenised descriptions to reduce size of save file.
* Added shortcut keys to short & long range charts.
* Added text to Contextual Help.

2.4
* Bug Fixes.

2.3
* Fixed bug introduced when changing over to use the Market Script Interface.
* Fixed syntax error in Dock Master script.

2.2
* Allows color and shape of chart markers for illegal goods to be changed via Library Config.
* Tweaked the returns and time frames for gold, platinum and gem stones, to not be quite so generous or easy to exploit.
* Fixed issue where illegal goods were not being created if starting a new game with the "Easy Start" option.
* Code refactoring.

2.1.1
* Removed reference to blackmarket script from world-scripts.plist.

2.1
* Enabled equipment conditions, which had been turned off for testing.

2.0
* Updated market script process to use new [[Market Script Interface]] OXP.
* Switched pricing change to be inside market script callbacks (so they will now show up on sample price calculations).
* Made compatible with [[New Cargoes]] OXP (version 2.0)
* Split off [[Black Market]] into its own OXP, and made it a requirement of this OXP.

1.5.8
* Fixed some potential referencing errors with mission screens.

1.5.7
* Added extra facility for removing the Black Market on stations.

1.5.6
* Better use of new functions available in later versions of Oolite.
* Removed code that was deleting TL1 phase scan settings.
* Bug fixes.

1.5.5
* List of illegal goods displayed on F7 system data screen will now be shown inflight, but without reasons (ie just a list of illegal goods).
* Additional checking types added to ship condition checking routine.
* Bug fixes.

1.5.4
* Moving kg or g type commodities will now force the Manifest MFD to update.
* Better integration with Escape Pod Tweaks. Scooped escape pods can no longer be transferred to the smuggling compartment.
* Equipment.plist corrections.
* Updates to readme.txt file.

1.5.3
* Removed 1t cargo space requirement for in-flight storage equipment, to ensure it is always available when a smuggling compartment is installed.
* Removed incorrect Naval Energy Unit requirement for in-flight storage equipment.
* Code refactoring.

1.5.2
* Fixed issue with the in-flight storage function not handling all conditions when checking scooped cargo.
<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">
1.5.1
* Fixed broken integration with "Escape Pod Tweaks".

1.5.0
* Added new options for when player is caught in a sting operation: pay a fine amount, accept a legal penalty, or attempt to bribe their way out of trouble.
* System productivity now has an influence on the amount you need to offer when bribing officials.
* Calculation of the maximum smuggling compartment size now factors in current smuggling compartment size so all downgrade options are available (not just the ones that would fix in the current available space).
* Fixed damage/repair process.
* Fixed issue with smuggling compartment damage resetting the tech level of the compartment.
* Fixed incorrect description lookup key.
* Improved integration with the "Escape Pod Tweaks" OXP.
* Code cleanup.

1.4.2
* Systems with illegal goods marked on the map will now have their marks removed after loading the game if the setting switch is turned off via Library Config.

1.4.1
* Primable equipment now given to player who already had a smuggling compartment installed.

1.4.0
* Added primable equipment which allows cargo to be moved to the smuggling compartment during flight.
* Fixed issue on "Move cargo out" screen, showing "[avail]" instead of available compartment space.
* Removed decimal point values from showing for available compartment space.
* Better handling of kg and g commodities.
* Fixed issue with outrageous amounts being offered for narcotics and slaves on the Black Market.

1.3.2
* Better handling of interstellar space conditions.

1.3.1
* Added options to [[Library OXP|Library]] Config to control whether systems with illegal goods are marked on the galaxy map.

1.3.0
* It is now possible to add new commodities to the list of illegal goods possibilities.
* The dock master can now relabel cargo as new (ie. non-core) commodities.
* System map will now be shown when the dock master informs player of a milk run, highlighting the two systems.
* Illegal goods on route will now handle not having the Advanced Navigation Array correctly.
* Cleaned up overlay images.

1.2.2
* Added "display_color" property to some equipment items (Oolite v1.85/86 only).
* Added integration options for "Bounty System - Most Wanted" OXP.
* Better handling of interstellar space.
* Code refactoring.

1.2.1
* Fix for crazy prices being applied after a saved game is reloaded.

1.2.0
* Changed method of adjusting prices to work better with other OXP's that adjust prices.
* Fixed Javascript error when attempting to sell illegal cargo through the Black Market.
* Added console message confirming sale of illegal cargo through the Black Market.
* Code cleanup.

1.1.4
* Arranged data on illegal goods lists to be in columns.
* Removed hard-coded scanner range values.

1.1.3
* Fixed error where function to remove sting ship monkey patches wasn't being passed the correct parameter.

1.1.2
* Added code for putting smuggling contracts on the Bulletin board system if the Contracts On BB OXP is also installed.
* Code refactoring.

1.1.1
* Fixed some spelling mistakes.
* Added "machinery" to list of commodities the "Visible As" property of a smuggling compartment can be set to.
* Fixed issue with not being able to move machinery into or out of the smuggling compartment.
* Fixed issue with not being able to purchase or sell machinery directly from the smuggling compartment.

1.1.0
* Additional info on F7 screen is now only available when docked to stop the information from overrunning the HUD.
* Corrected use of "techLevel"/"techlevel" on systemInfo objects.
* Re-fixed issue with amount of gold, platinum and gemstones taking up the same amount of smuggling cargo space as normal cargo space.

1.0.0
* Bug fixes.

0.9.0
* Added new Black Market option, enabling the sale of rare or expensive equipment items (eg naval-sourced equipment)
* Added ability for 3rd party OXP's to add items for sale to the Black Market.
* Fixed incorrect label in descriptions.plist.
* Fixed issue where a smuggling compartment repair item was being displayed when the unit wasn't damaged.
* Add ability for sting ship to respond to cloaked attacks.
* Better handling of interstellar space conditions.
* Some values were not being reset correctly after a galactic jump.
* Police ship model used on all police-related screens displayed at that station will now be the same model.
* Sound effects added for mode/activate functions of phase scanner.

0.8.1
* Fixed issue where opening the "Purchase Smuggling Compartment" screen was turning off the HUD and not turning it back on again.

0.8.0
* Fixed Javascript error when opening the market info details screen for a commodity in interstellar space.
* Added $isGoodIllegal function to Smugglers_Illegal.

0.7.9
* Fixed issue where docking will illegal goods and rescued escape pods was not allowing the player to bribe the station officials.

0.7.8
* Fixed issue where illegal good definitions were not being applied correctly in every situation.

0.7.7
* Fixed issue with smuggling compartments of various sizes appearing on the equipment screen.

0.7.6
* Better handling of situation where another OXP removes the smuggling compartment.
* Fixed issue with contracts where a Javascript error could occur in rare circumstances.
* Fixed Javascript error with script attached to police sting ship.
* Improved sting ship compatibility with other worldScripts.
* Really (hopefully, maybe) fixed vector error in Blackmarket script.
* Changed "==" comparisons to "===" for performance improvements.

0.7.5
* Fixed Javascript vector error in Blackmarket script.
* Added code to make use of enhanced F7 screen features in Oolite 1.83/4.

0.7.4
* Reconfigured the cargo contracts fixes to work with the default contract code and with Switech's cargo contract mod OXP.
* Removed unnecessary "requires.plist" file.
* Extra checking for the presence of the sting ship to prevent null errors.
* Fixed issue where smuggling equipment was not being offered for sale anywhere.
* Fixed issue where the phase scanner was not being offered for sale at any time.
* Fixed issue where going into the smuggling compartment purchase page multiple times without actually purchasing something was deducting money anyway.
* Adjusted the price of the phase scanner.
* Tidying up of some equipment installation rules.
* F7 screen was turning off HUD when in flight in some circumstances.

0.7.3
* Fixed issue with incorrect text showing on F8F8 commodity info screen.
* Included current system in list of planets shown on "Illegal imports on current course" option.
* Fixed issue with the Black Market welcome text, which was not being correctly reset upon docking.

0.7.2
* Fixed loop variable pointer error in Black Market script.

0.7.1
* Fixed timer setup bug in Black Market script.

0.7.0
* Updated all bounty changes to use "setBounty", rather than just updating the bounty directly, so a description can be passed to other OXP's.
* Expanded the use of the "properties" element of illegal definitions, so that multiple options can be entered (eg "cuisine,meat,steak").
* Added a couple of extra illegal goods definitions.
* Added the ability to sell illegal cargo on the Black Market, for a reduced price. Plus some extra things...
* Added Seedy Space Bars to list of stations that have a Black Market.
* Moved a lot of static text into descriptions.plist and missiontext.plist.
* Fixed issue with only 500kg of gold or platinum taking up 1t of smuggling cargo space, and 500000g of gemstones.
* Removed redundant items from equipment.plist.
* Fixed bug when using a HUD that doesn't implement the "Big GUI" option, where the HUD was being turned off when displaying some mission screens, but wasn't being turned back on again.
* In Oolite 1.83 the bugfix relating to damaged equipment items that take up cargo space is resolved, so code has been added to switch to using the in-built repair methods, rather than keeping a long list of "Repair" equipment items. For backwards compatibility with 1.82, however, those items are still present.
* Adjusted the costs of repair items to be more in-line with how the core system handles repair costs.
* Improved integration with Illegal Goods Tweak. When docking with slaves, IGT will always run first, and Smugglers will be called afterwards.
* Updated screenID's to enable BGS background sounds.
* Renamed background overlay images to prevent possibility of future duplication.
* Added checks for null value in station allegiance.
* Updated the check for "Allow Big GUI".
* Cleaned up sound function to avoid the need to check for BGS.
* Toned down overlay images.
* Code refactoring.

0.6.2
* Fixed bug with checking for and removing used permits.
* Fixed issue where Constrictor hunt mission hints were being pushed off the System Data screen by all the illegal goods notifications.
* Added extra overlay image for purchasing Permits.
* Added extra overlay image for Rock Hermit waypoint list.

0.6.1
* Using escape pod will now empty smuggler's compartment.
* Pared down "trade-goods.plist" to only contain required information, hopefully making it compatible with "Risk based economy" v2 OXP and BlOomberg Markets OXP.
* Removing the smuggling compartment or phase scanner at a Rock Hermit (or other non-GalCop station) will now refund the full cost, rather than just 70%.
* Changing the size of the smuggling compartment will refund the full price of the old size first, before purchasing the new size.
* Fixed bug when starting new game.
* Fixed issue where the message about delivering illegal goods via a cargo contract was appearing incorrectly.

0.6.0
* Fixed issue where illegal flags were not appearing on secondary stations, removed need to have planetinfo.plist.
* Removed log file debug code.

0.5.0
* Fixed bug with selling relabelled cargo.
* Fixed issue with delivering a standard cargo contract to a system where the cargo has become illegal after accepting the contract. The player was not being given the opportunity to bribe a docking official to clear their bounty.
* Fixed issue where, after using the phase scanner and being discovered using it, and then docking, the player was not being given the opportunity to bribe their way out of trouble.
* Added emails for various actions, when the Email System OXP is in use.
* Changed skull and crossbones background image for Black Market.
* Improved integration with [[Illegal_Goods_Tweak_OXP|Illegal Goods Tweak OXP]] (v2.2.0). The inital screen IGT displays will now look like an Amnesty Intergalactic screen, rather than a GalCop one, and the player has only two choices: hand over the slaves, or work with GalCop. If they choose the latter, Smugglers will include slaves as part of its import restrictions and the player can bribe as normal if they choose to.

0.4.0
* Fixed issue where you could purchase any smuggling compartment, regardless of how much credit you have.
* Added player credit balance to smuggling compartment purchase screen.
* Added player credit balance to Black Market purchasing screens.
* Tightened up which stations will have a Black Market.
* Added government icon and TL to all purchase screens in Black Market.
* Tweaks to the calculation of phase scan noticeboard items.
* Improvements to the page handling for illegal goods.

0.3.1
* Fixed mangled manifest.plist file.

0.3.0
* Tweaks to the minimum tech level for purchasing smuggling equipment items.
* Further adjustments to precious metals and gem stones illegal notifications for better economic balance.
* Added overlay background images to various interface screens.
* Smuggling compartment repair costs now linked to size of compartment.
* Arriving in a system where you have a permit but no cargo for that permit will no longer remove the permit.
* Routine to create new illegal goods will now exclude the current system, to prevent the issue where the engine understands a good is illegal, but the game interface doesn't.
* Added extra checks to the docking process to ensure a good that the engine understands is illegal is also marked as illegal on the market screen before penalising the player.
* Added police ship models to all the after-dock screens.

0.2.0
* Made the price of RH waypoints, fake permits and phase scans related to the station price factor.
* Bribing the same station multiple times will increase the required amount of the bribe (by 10 or 20 percent each time).
* Added the last successful bribe amount to the screen where you enter a bribe amount.
* Reduced the police vessel detection range for the phase scanner, as their ships wouldn't have the same range as the main station.
* Main station market quantity of illegal goods under contract now set to zero (so, when arriving short, the player can't just buy the difference, launch and redock to complete the contract).
* Fixed issue where you could purchase anything from the Black Market, regardless of how much credit you have.
* Limited smuggling compartment options to standard commodities only.
* Fixed issue where wrong illegal goods were being picked up if the player followed another ship through a wormhole.
* Rebalanced prices for precious metals and gem stones.
* Damaged smuggling compartments and phase scanners can now be repaired, and better handling of damaged equipment in general.
* Fixed issue where phase scanner would not show up for purchase anywhere.
* Fixed issue where having 0t available space would not allow transfer of precious metals from smuggling compartment to standard hold.
* Added a new item to the Illegal Goods interface screen that lists all purchased Rock Hermit waypoints.
* Fixed issue with tech upgrades, where the option to purchase new ones was always available, no matter how many times you purchased it.
* Adjusted the price of the tech upgrade.
* Bug fixes.

0.1.2
* Added missing semi-colon to planetinfo.plist.
* Found additional spot where techlevel was showing 1 lower than actual.
* Fixed issue where phase scans for TL 1 systems would not show up in the list of discovered phase scans.

0.1.1
* Tech levels on all displays were showing 1 lower than actual.
* Attempting to bribe a dock master to relabel cargo when you don't have any cargo that can be relabeled would put the game into a locked state.
* Spelling corrections.

0.1.0
* Initial public release
</div>

== Links ==
*[https://bb.oolite.space/viewtopic.php?f=4&t=17723 BB Thread for this OXP]
*[https://bb.oolite.space/viewtopic.php?f=4&t=17179 Idea for Smugglers OXP] (2015) Fons et origo of this OXP
*[https://bb.oolite.space/viewtopic.php?f=2&t=17675 Legal column on Market screen] (2015) related discussion of the confusions inherent in the Legal column.

*[https://bb.oolite.space/viewtopic.php?p=204379#p204379 Expanded version of the smuggling proposal] (Elite: Dangerous - Design Decision Forum: 2013)

==Quick Facts==
{{OXPLevel|2}}{{IconOXP|ooVersion="1.82"|oxpCPU="Average"|oxpMEM="Average"|oxpGPU="Low"|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
{{Infobox OXPb| title = Smugglers.oxz
|version = 2.12
|release = 2026-05-10
|license = CC BY-NC-SA 3.0
|features = Equipment, Commodities
|category = Mechanics OXPs
|author = [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=17723 Oolite BB]
}}

==Gameplay and Balance indicator==
[[Image:tag-colour-orange.png]]

File:BlackMarket 1.7.oxz

2026-05-10T12:17:00Z

Phkb:

File:Smugglers 2.12.oxz

2026-05-10T12:16:16Z

Phkb:

Loadout by Category

2026-05-10T06:50:05Z

Phkb:

[[File:Equipordering3.png|thumb|right|300px|Effect on Oolite v.1.90 F3 Ship Outfitting Screen The red "selling" lines come from the Equipment 'Sell Item' Color OXP]]
[[File:Reordering-headers.png|thumb|right|300px|Effect on Oolite "nightly" v.1.91 F3 Ship Outfitting Screen]]
Orders the F3 Ship Outfitting Screen and the F5 Commander's Status Screen.

== Overview ==
Back in 2004 this was not needed. There were just 20 pieces of equipment! But some 20 years later, with almost 2,500 named pieces of equipment, this can be a necessity. The original ordering algorithm for the F3 and F5 screens made sense in the early days. Now, with too many OXPs, it engenders confusion.

This mod categorizes all visible and purchasable equipment into the following categories:
=== Categories ===
*Fuel
*General/Miscellaneous
*Astrogation or Navigation
*Lasers
*Missiles
*Energy
*Defensive
*Shields
*Targeting
*Armour
*Scanners
*MFDs
*Cargo/Mining
*Laser Mount Switching System
*Towbar and Accessories
*Self-Repair System
*Escorts/Fighters
*Documentation
*Illicit
*Second-hand equipment

Each of these categories will appear as a sub-heading on the F3 and F5 screens.

== Download ==
*For those running the latest Oolite version (that is, Oolite 1.91.0.7574-231217-e230e31, the one with PR #470 in it), you can use [[Media:LoadoutByCategory.oxz|LoadoutByCategory.oxz]].
*For Oolite v.1.90 or previous, use this version: [[Media:LoadoutByCategory_190.oxz|LoadoutByCategory_190.oxz]]

=== Why two versions? ===
One difference is, with PR#470, things on the F3 screen can be ordered independently of things on the F5 screen.

So, with the version for v1.90, everything is in reverse alphabetical order on the F5 screen, and the less important groups are shown first on the F5 screen (things like MFD's). With the latest Oolite version, one can (a) order each group alphabetically on both F3 and F5, and (b) put the more important groups first on the F5 screen.

There is also no need to include a spurious cost and time for the equipment headings on the F3 screen.

== The Dark Side ==
For more on this, see the entry under [[Equipment.plist]] which includes the lengthy sort order in this oxp's equipment-overrides.plist (there are ''c.'' 2,500 pieces of equipment in Oolite!)

== Feedback ==
Categorisation can always be a problem. If you feel that a piece of equipment has been mis-categorised, post a note on the [https://bb.oolite.space/viewtopic.php?f=4&t=21507 Bulletin Board thread].

== Quick Facts ==
{{IconOXP|ooVersion="1.90"|oxpCPU="Low"|oxpMEM="Low"|oxpIsConfigurable=true}}
[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
{{Infobox OXPb| title = LoadoutByCategory.oxz
|version = 1.11
|release = 2026-05-10
|license = CC BY-NC-SA 4.0
|features = Reorders equipment on F3 & F5 screens
|category = Misc OXPs
|author = [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=21507 Oolite BB]
}}

Smugglers - The Galactic Underworld

2026-05-10T06:49:18Z

Phkb:

[[File:Smugglers' News Flash.png|right|500px]]
Makes any commodity potentially illegal to import in various systems, and adds equipment and contracts for those interested in smuggling goods outside normal legal channels.

==Introduction==
Historically, in both the original Elite and therefore in Oolite, there were three illegal goods: slaves, narcotics and firearms. These were illegal to export from all GalCop stations, and there was no variation or flexibility in those items. This OXP aims to expand what goods are illegal, making it far more variable. There are new interface screens to show what items are illegal and where, a new Black Market available from Rock Hermits and other stations, and new equipment items to aid in smuggling cargo.

==Background==
It started with a single system.

[[Sector1/Ceedra|Ceedra]], an insignificant confederacy in an unfrequented arm of galactic sector 1. They had been receiving some contaminated imported food from the nearby Anarchy system [[Sector1/Isdibi|Isdibi]], possibly random or possibly intentional as a way to destabilise the government, it was difficult to tell. But a request was made to [[GalCop]] to put an import ban on food and force any traders that bring food to the station to hand it over for destruction.

The impact was almost immediate. Traders were outraged that their harmless cargo of wheat and grains were being taken away, which had never before happened in GalCop history, plus they received a bounty for doing so, doubling the pain. Messages were sent, trade delegations made an outward show of force, but GalCop's hands were tied. This was the decision of the planet in question, and under GalCop law they were perfectly entitled to impose import restrictions, beyond the export restrictions that had long been in place for slaves or narcotics.

Suddenly the floodgates were opened. System after system found reason to ban goods, from basic staples like food or textiles, up to the traders standard fare of computers, furs and liquor. Even precious metals were banned in some systems, often for rather obscure reasons. And always, once a ban was in place, the price would hit the roof.

Some commentators have suggested there is evidence that certain systems were requesting a good to be made illegal purely for the jump in price that naturally follows and the bump in traffic that accompanies extra profits. While GalCop have been sought for comment, none has been forthcoming, and nothing appears to be able to bring a halt to the practice. If systems are indeed creating spurious trade legalities, GalCop is not preventing them.

Somewhat inevitably, at almost the same time, an entirely new market emerged, beneath the radar of GalCop's far-seeing eyes. As soon as a good was declared illegal to import the price of that good sky-rocketed, and the temptation to circumvent the restrictions GalCop was forced to impose was too great. Dock masters became a particular target, being offered high sums to fiddle manifest registries. Shadier stations began to offer customised smuggling compartments that provided a way to hide cargo from the customs scanning equipment. Contracts to move illicit cargo were also available from these locations.

While it was always present in some form or another, now the Galactic Underworld became almost mainstream. The galaxy had changed.

==Overview==
This OXP aims to broaden the scope and appeal of illegal goods in a number of ways.

===1. Illegal goods===
Illegal goods can now be any of the 17 different commodity types. So food might be declared illegal on one planet, computers on another. These things might change as well, so computers might be illegal for a few months, and then conditions are lifted and they are back to normal again.

Also, illegal trade goods will now be illegal to import(*). If you arrive at a GalCop station with visible illegal goods in your hold, you will be fined and your cargo will be confiscated. See also the section below on ''Bribing Officials''.

Even if you plan to stay on the right side to the law, this OXP can add variety to the way illegal goods are handled by the game, and make the process of shipping cargo across the galaxy more interesting.

Illegal goods notifications can be viewed on the F7 System Data screen, as well as via the F4 interface screen (see below). The F6 Galactic Chart will highlight systems within 7 LY that have illegal goods. Systems with just '''firearms''' as illegal will be shown with an '''orange diamond'''. Systems with other commodities, or with multiple commodities, will be shown with a '''yellow diamond'''.

(*) '''Slaves''' remain illegal to export, and they are the only commodity that is illegal to export. The reason for this is that some escape capsules end up being transported as slaves, and it's unfair to penalise the player for potentially rescuing downed pilots. It is recommended the [[Illegal_Goods_Tweak_OXP|Illegal Goods Tweak OXP]] be installed so that captured slaves can be released. For other fixes see [[Escape Pod]].

===2. Smuggling Compartment===
To help traders to work around these import restrictions a new piece of equipment, the smuggling compartment, can be purchased at non-GalCop stations (Rock Hermits in particular, but also other docking ports) in TL4 or greater systems.

Cargo can be moved into and out of the smuggling compartment via an F4 Interface screen "Smuggling Compartment Configuration". During flight, the "Smuggling Compartment Storage" primable equipment item allows for the transfer of cargo from the standard hold to the smuggling compartment. Cargo cannot be transferred out of the smuggling compartment during flight.

The smuggling compartment has, in most circumstances, around a 25-40% chance of being detected, based on tech level. GalCop is always improving their detection equipment, which means that the scanner resistant technology of the smuggling compartment needs to be updated regularly to cope. About every 30 days a "Version Upgrade" should be purchased (at TL5 or greater systems) for your smuggling compartment, which will install the latest scanner resistant technology and keep the chance of detection as good as it possibly can be.

This chance improves slightly once the "Phase Adjustment" equipment (available at TL7 or greater systems) is installed. With the phase adjustment equipment installed the phase setting of the hold can be adjusted, which can reduce the chance of being detected considerably. Phase settings can be picked up at Black Market noticeboard (which might be unreliable), or they can be purchased for a considerable cost. See also the Phase Scanner (below).

If your compartment is damaged during a battle, cargo may be lost, the same as with normal cargo. You will need to find a non-GalCop station to repair the damage, otherwise the entire compartment will be discovered and removed, and you will receive a bounty. If you have a ship overhaul performed at a GalCop station with the smuggling compartment, it will be discovered and removed, and you will receive a bounty. See also the section below on Bribing Officials.

===3. New equipment===
Apart from the smuggling compartment and phase adjustment tool, this OXP also introduces the following equipment items.

'''** Phase Scanner **''' 
TL8 or greater Anarchy systems will sometimes have a Phase Scanner available for purchase. The scanner can, when aimed at GalCop main stations, detect what phase setting the manifest scanners will be susceptible to. Once you know what the phase setting is for a particular government and tech level they can set the phase of their smuggling compartment and it will be almost undetectable to GalCop manifest scanners.

The Phase scanner is used by targeting the main station, priming the equipment and then activating it. It will take a few seconds to perform its job, and will consume a large amount of energy in the process - a naval energy unit is required. If you are too close to the station, or you are moving too slowly, the station will detect the scan and a bounty will be placed on you. If you then dock at the station the scanner will be removed. If you are too far away from the main station the scanner will not operate. If a police vessel catches you performing a scan you will receive a bounty and may find yourself under fire.

If your scanner is damaged you must get it repaired at a non-GalCop station, otherwise the equipment will be confiscated and you will receive a bounty. If you have a ship overhaul performed at a GalCop station while the equipment is on board, it will be removed as part of the overhaul and you will receive a bounty. But see also "Bribing Officials" below.

'''** Tech version upgrades **''' 
Technology improves every day, and the scanner resistant technology used in the smuggling compartment needs to be updated to keep in step with the times. So, the tech version upgrade will keep your smuggling compartment up-to-date. Available at TL5 or greater systems.

'''** Import Permits **''' 
While some goods might be declared illegal, you can still purchase a permit to import that good from the planet in question. Usually these permits are quite expensive.

Permits can only be used once, and will automatically be removed after use.

===4. Bribing Officials===
If your smuggling compartment is discovered during a renovation or when damaged, or you dock with illegal cargo in your hold, you can attempt to bribe the station officials. You will be asked to enter the amount of the bribe. If you pay attention to what the official says you can get an idea on whether a smaller amount will be required, but larger amounts will have a greater chance of being successful. If you are successful you will be able to keep all your cargo and equipment. If you are unsuccessful you will lose all smuggling-related equipment and may end up increasing the bounty on your head.

The Black Market noticeboard (see below) can be useful in finding systems where the dock master and other customs officials can be bribed for a reasonable amount.

===5. New Interfaces screens===
'''** Black market **''' 
See the [[Black Market]] page for more information about the Black Market.

'''** Dock master **''' 
When docked at a main station, and when the dock master is available (he doesn't work 24/7!) from this interface you can ask him about any good milk runs he/she is aware of, or you can try to bribe them into changing your cargo manifest for you.

'''** Illegal goods information **''' 
Illegal goods are changing all the time. To try to keep track of the potential chaos, this interface screen will initially show you the latest changes to illegal goods in the sector, plus it offers the following options: 
a. List of all illegal goods in the galaxy. Here you can see it all. 
b. List of all illegal goods within 7LY of your current system. 
c. List of illegal goods on your current course. If you have a long, cross-chart trip planned, this option will tell you what's illegal on the way, and flagging which ones you have a permit for (if any). 
d. List of all import permits. This is what you are authorised (legally or not) to import. 
e. List of all Rock Hermit waypoints purchased.

== Tips ==
One now needs to keep abreast of developments in the systems one is about to visit. This ''can'' be done using the new F4 choices. And it can ''also'' be done using the F7 screen - and if one's route has been plotted using the [[ANA]], one can view the different systems along the route in F7 using the left/right arrow keys.

----
==Adding additional commodities==
Additional commodities can be added to the system by doing the following:
* '''Adding the commodity permit cost, and price factors.'''

var sbi = worldScripts.Smugglers_Illegal; 
sbi._commodityInfo["my_commodity_key"] = [permitCost, factorIncIllegal, factorIncBM];
// permitCost = How much an import permit will cost for this commodity (eg 2000)
// factorIncIllegal = The factor to increase this commodity by when it is flagged as illegal (eg 2.5 = 2.5 times original price)
// factorIncBM = The factor to increase this commodity by at a black market
// when it is flagged illegal at the main station (eg 1.4 = 1.4 times standard price)

* '''Adding illegal possibilities for this commodity to the pool'''

var sbi = worldScripts.Smugglers_Illegal;
sbi._possibilities.push({
govTypes:"0,3",
commodity:"my_commodity_key",
properties:"",
permit:1,
scale:1,
period:30,
chance:0.5,
description:"A brief description of the in-game reason for making this commodity illegal."});
/*
govTypes: Comma-separated list of government types (0-7) this definition can apply to eg ("0,1,2")
commodity: Comma-separated list of commodity names this definition will apply to (eg "food,my_commodity_key").
properties: Comma-separated list of text search strings to use against the planetary description.
For instance, "civil war" would only select planets that have "civil war" in their description.
"drink|brew" would only select planets that have "drink" or "brew" in their description.
permit: Boolean value (0 or 1) indicating whether a permit can be purchased for this commodity
scale: The legality scale to apply to this commodity.
The scale will apply when calculating the bounty to apply to a player caught smuggling
illegal goods as a multiplier. Most illegal goods have a scale of 1. Slaves have 2.
period: The period (in days) this definition will be active for.
chance: A chance factor, between 0 (never) and 1 (very often), to apply when selecting this definition
description: The description to display for this definition.
*/

* '''Add the [[Market Script Interface]] market script to your commodity.'''
The [[Market Script Interface]] OXP enables multi-OXP interfaces to the same market script, and is how Smugglers enables the legal/illegal flags to be set for each commodity.

In the commodity definition in your "trade-goods.plist" file, add the following line:

"market_script" = "msi_tradegoods_market.js";

Note: If your commodity definition already has a "market_script" defined, you will need to interface your code with [[Market Script Interface]], to enable it to work with the Smugglers version.

==Notes==
* This OXP updates the "oolite-contracts-cargo.js" file with a new version of the _initialiseCargoContractsForSystem function that excludes illegal goods from being selected for standard cargo contracts.
* Related to the previous note, this OXP also updates the _initialiseCargoContractsForSystem function of Switech's Cargo-Contract-Mod, to exclcude illegal goods from being selected for standard cargo contracts.
* This OXP also changes the logic of the "Legal" column on the F8 Market screen. Previously, goods that were illegal to export were marked with "Im", and goods illegal to import were marked with "Ex". This logic has been reversed, and the column relabelled as "Ban" to indicate what type of ban is in place.

==Special Note==
Because of the complex nature of this OXP, the possibility for conflicts is great, so please report any bugs or unexpected outcomes. Don't assume someone else has noticed it - if two people report a bug it makes tracking the bug down so much easier!

And it goes without saying that I'd like to hear from you if you have any suggestions on how the OXP could be improved.

==Requirements==
The [[Market Script Interface]] OXP is a requirement for this pack. 
The [[Black Market]] OXP is a requirement for this pack.

==Incompatible OXP's==
At present, this OXP is incompatible with the following OXPs:
* [[New_Cargoes|New Cargoes]] v1.2.3: The system of permits, how it stores cargo, and how it controls illegal goods are all potentially conflicting. See New Cargoes for a link to a detailed analysis.
However, version 2 of New Cargoes is compatible with Smugglers.

This conflict has been recorded in the manifest file, so if you have New Cargoes installed the "Smugglers" OXP will not load.

==Installation==
Place the 'Smugglers_2.11.oxz' or 'Smugglers.oxp' (extracted from the ZIP file download) into your 'AddOns' folder and when you start the game, hold down 'Shift' until you see the spinning Cobra.

==Download==
Download [[Media:Smugglers_2.11.oxz|Smugglers_2.11.oxz]] v2.11 (downloaded {{#downloads:Smugglers_2.11.oxz}} times). 
Download [https://app.box.com/s/9zwazfe98cg2z89bmpn7mmhypm24d3zj Smugglers.zip] v2.11 (extract OXP folder to AddOns)

==License==
This OXP is released under the Creative Commons Attribution - Non-Commercial - Share Alike 3.0 license. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/

Skull and crossbones image from https://commons.wikimedia.org/wiki/File:Skull_and_crossbones.png. 
Warning image from http://simpleicon.com/warning-3.html. 
Chat image from http://simpleicon.com/chat-2.html. 
ID image from http://simpleicon.com/id_card.html. 
Lock image from http://simpleicon.com/lock-2.html. 
Cupboard image from http://simpleicon.com/cupboard_4.html 
Candle image from http://simpleicon.com/candle-2.html. 
Form image from http://simpleicon.com/admite_form_1.html. 
Map marker image from http://simpleicon.com/map_marker.html.

With the help of: 
Layne, Stormrider, Norby, cim, Diziet Sma, Cody, and all the people on the BB who offered suggestions and ideas to make this OXP as good as it could be. If the OXP fails in any way, is it because of my limitations as a programmer, not because of the paucity of your ideas and contributions!

==Version History==
2.11
* Added Smuggler's Guidebook to the Ship's Library (if installed).
* Added check for the Market Screen Legal Column mod.
* Tweaked some mission screens for better positioning.
* The initial entry point to "Import Permits" and "Smuggling Compartments" is now free, so you no longer need a minimum cash balance to see what permits are available or what the Smuggling Compartment options are. If using Oolite 1.92, the amount and install time columns will also be suppressed for these items.

2.10
* Fixed issue with inverted logic check in monkey-patch for Switech's cargo contract mod.

2.9
* Updated monkey-patch for Switech's cargo contract mod.

2.8
* Fixed issue with cargo storage when New Cargoes not installed.

2.7
* Darkened overlay images for better compatibility with Oolite 1.92.

2.6
* Moved all text into descriptions.plist or missiontext.plist for easier localisation.
* Corrected information in readme.txt.
* Pushed out tech upgrades to every 60 days (rather than every 30).
* When asked about milkruns, the Dock Master will now show a short range chart or the run, rather than a long range chart.

2.5
* Tokenised descriptions to reduce size of save file.
* Added shortcut keys to short & long range charts.
* Added text to Contextual Help.

2.4
* Bug Fixes.

2.3
* Fixed bug introduced when changing over to use the Market Script Interface.
* Fixed syntax error in Dock Master script.

2.2
* Allows color and shape of chart markers for illegal goods to be changed via Library Config.
* Tweaked the returns and time frames for gold, platinum and gem stones, to not be quite so generous or easy to exploit.
* Fixed issue where illegal goods were not being created if starting a new game with the "Easy Start" option.
* Code refactoring.

2.1.1
* Removed reference to blackmarket script from world-scripts.plist.

2.1
* Enabled equipment conditions, which had been turned off for testing.

2.0
* Updated market script process to use new [[Market Script Interface]] OXP.
* Switched pricing change to be inside market script callbacks (so they will now show up on sample price calculations).
* Made compatible with [[New Cargoes]] OXP (version 2.0)
* Split off [[Black Market]] into its own OXP, and made it a requirement of this OXP.

1.5.8
* Fixed some potential referencing errors with mission screens.

1.5.7
* Added extra facility for removing the Black Market on stations.

1.5.6
* Better use of new functions available in later versions of Oolite.
* Removed code that was deleting TL1 phase scan settings.
* Bug fixes.

1.5.5
* List of illegal goods displayed on F7 system data screen will now be shown inflight, but without reasons (ie just a list of illegal goods).
* Additional checking types added to ship condition checking routine.
* Bug fixes.

1.5.4
* Moving kg or g type commodities will now force the Manifest MFD to update.
* Better integration with Escape Pod Tweaks. Scooped escape pods can no longer be transferred to the smuggling compartment.
* Equipment.plist corrections.
* Updates to readme.txt file.

1.5.3
* Removed 1t cargo space requirement for in-flight storage equipment, to ensure it is always available when a smuggling compartment is installed.
* Removed incorrect Naval Energy Unit requirement for in-flight storage equipment.
* Code refactoring.

1.5.2
* Fixed issue with the in-flight storage function not handling all conditions when checking scooped cargo.
<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">
1.5.1
* Fixed broken integration with "Escape Pod Tweaks".

1.5.0
* Added new options for when player is caught in a sting operation: pay a fine amount, accept a legal penalty, or attempt to bribe their way out of trouble.
* System productivity now has an influence on the amount you need to offer when bribing officials.
* Calculation of the maximum smuggling compartment size now factors in current smuggling compartment size so all downgrade options are available (not just the ones that would fix in the current available space).
* Fixed damage/repair process.
* Fixed issue with smuggling compartment damage resetting the tech level of the compartment.
* Fixed incorrect description lookup key.
* Improved integration with the "Escape Pod Tweaks" OXP.
* Code cleanup.

1.4.2
* Systems with illegal goods marked on the map will now have their marks removed after loading the game if the setting switch is turned off via Library Config.

1.4.1
* Primable equipment now given to player who already had a smuggling compartment installed.

1.4.0
* Added primable equipment which allows cargo to be moved to the smuggling compartment during flight.
* Fixed issue on "Move cargo out" screen, showing "[avail]" instead of available compartment space.
* Removed decimal point values from showing for available compartment space.
* Better handling of kg and g commodities.
* Fixed issue with outrageous amounts being offered for narcotics and slaves on the Black Market.

1.3.2
* Better handling of interstellar space conditions.

1.3.1
* Added options to [[Library OXP|Library]] Config to control whether systems with illegal goods are marked on the galaxy map.

1.3.0
* It is now possible to add new commodities to the list of illegal goods possibilities.
* The dock master can now relabel cargo as new (ie. non-core) commodities.
* System map will now be shown when the dock master informs player of a milk run, highlighting the two systems.
* Illegal goods on route will now handle not having the Advanced Navigation Array correctly.
* Cleaned up overlay images.

1.2.2
* Added "display_color" property to some equipment items (Oolite v1.85/86 only).
* Added integration options for "Bounty System - Most Wanted" OXP.
* Better handling of interstellar space.
* Code refactoring.

1.2.1
* Fix for crazy prices being applied after a saved game is reloaded.

1.2.0
* Changed method of adjusting prices to work better with other OXP's that adjust prices.
* Fixed Javascript error when attempting to sell illegal cargo through the Black Market.
* Added console message confirming sale of illegal cargo through the Black Market.
* Code cleanup.

1.1.4
* Arranged data on illegal goods lists to be in columns.
* Removed hard-coded scanner range values.

1.1.3
* Fixed error where function to remove sting ship monkey patches wasn't being passed the correct parameter.

1.1.2
* Added code for putting smuggling contracts on the Bulletin board system if the Contracts On BB OXP is also installed.
* Code refactoring.

1.1.1
* Fixed some spelling mistakes.
* Added "machinery" to list of commodities the "Visible As" property of a smuggling compartment can be set to.
* Fixed issue with not being able to move machinery into or out of the smuggling compartment.
* Fixed issue with not being able to purchase or sell machinery directly from the smuggling compartment.

1.1.0
* Additional info on F7 screen is now only available when docked to stop the information from overrunning the HUD.
* Corrected use of "techLevel"/"techlevel" on systemInfo objects.
* Re-fixed issue with amount of gold, platinum and gemstones taking up the same amount of smuggling cargo space as normal cargo space.

1.0.0
* Bug fixes.

0.9.0
* Added new Black Market option, enabling the sale of rare or expensive equipment items (eg naval-sourced equipment)
* Added ability for 3rd party OXP's to add items for sale to the Black Market.
* Fixed incorrect label in descriptions.plist.
* Fixed issue where a smuggling compartment repair item was being displayed when the unit wasn't damaged.
* Add ability for sting ship to respond to cloaked attacks.
* Better handling of interstellar space conditions.
* Some values were not being reset correctly after a galactic jump.
* Police ship model used on all police-related screens displayed at that station will now be the same model.
* Sound effects added for mode/activate functions of phase scanner.

0.8.1
* Fixed issue where opening the "Purchase Smuggling Compartment" screen was turning off the HUD and not turning it back on again.

0.8.0
* Fixed Javascript error when opening the market info details screen for a commodity in interstellar space.
* Added $isGoodIllegal function to Smugglers_Illegal.

0.7.9
* Fixed issue where docking will illegal goods and rescued escape pods was not allowing the player to bribe the station officials.

0.7.8
* Fixed issue where illegal good definitions were not being applied correctly in every situation.

0.7.7
* Fixed issue with smuggling compartments of various sizes appearing on the equipment screen.

0.7.6
* Better handling of situation where another OXP removes the smuggling compartment.
* Fixed issue with contracts where a Javascript error could occur in rare circumstances.
* Fixed Javascript error with script attached to police sting ship.
* Improved sting ship compatibility with other worldScripts.
* Really (hopefully, maybe) fixed vector error in Blackmarket script.
* Changed "==" comparisons to "===" for performance improvements.

0.7.5
* Fixed Javascript vector error in Blackmarket script.
* Added code to make use of enhanced F7 screen features in Oolite 1.83/4.

0.7.4
* Reconfigured the cargo contracts fixes to work with the default contract code and with Switech's cargo contract mod OXP.
* Removed unnecessary "requires.plist" file.
* Extra checking for the presence of the sting ship to prevent null errors.
* Fixed issue where smuggling equipment was not being offered for sale anywhere.
* Fixed issue where the phase scanner was not being offered for sale at any time.
* Fixed issue where going into the smuggling compartment purchase page multiple times without actually purchasing something was deducting money anyway.
* Adjusted the price of the phase scanner.
* Tidying up of some equipment installation rules.
* F7 screen was turning off HUD when in flight in some circumstances.

0.7.3
* Fixed issue with incorrect text showing on F8F8 commodity info screen.
* Included current system in list of planets shown on "Illegal imports on current course" option.
* Fixed issue with the Black Market welcome text, which was not being correctly reset upon docking.

0.7.2
* Fixed loop variable pointer error in Black Market script.

0.7.1
* Fixed timer setup bug in Black Market script.

0.7.0
* Updated all bounty changes to use "setBounty", rather than just updating the bounty directly, so a description can be passed to other OXP's.
* Expanded the use of the "properties" element of illegal definitions, so that multiple options can be entered (eg "cuisine,meat,steak").
* Added a couple of extra illegal goods definitions.
* Added the ability to sell illegal cargo on the Black Market, for a reduced price. Plus some extra things...
* Added Seedy Space Bars to list of stations that have a Black Market.
* Moved a lot of static text into descriptions.plist and missiontext.plist.
* Fixed issue with only 500kg of gold or platinum taking up 1t of smuggling cargo space, and 500000g of gemstones.
* Removed redundant items from equipment.plist.
* Fixed bug when using a HUD that doesn't implement the "Big GUI" option, where the HUD was being turned off when displaying some mission screens, but wasn't being turned back on again.
* In Oolite 1.83 the bugfix relating to damaged equipment items that take up cargo space is resolved, so code has been added to switch to using the in-built repair methods, rather than keeping a long list of "Repair" equipment items. For backwards compatibility with 1.82, however, those items are still present.
* Adjusted the costs of repair items to be more in-line with how the core system handles repair costs.
* Improved integration with Illegal Goods Tweak. When docking with slaves, IGT will always run first, and Smugglers will be called afterwards.
* Updated screenID's to enable BGS background sounds.
* Renamed background overlay images to prevent possibility of future duplication.
* Added checks for null value in station allegiance.
* Updated the check for "Allow Big GUI".
* Cleaned up sound function to avoid the need to check for BGS.
* Toned down overlay images.
* Code refactoring.

0.6.2
* Fixed bug with checking for and removing used permits.
* Fixed issue where Constrictor hunt mission hints were being pushed off the System Data screen by all the illegal goods notifications.
* Added extra overlay image for purchasing Permits.
* Added extra overlay image for Rock Hermit waypoint list.

0.6.1
* Using escape pod will now empty smuggler's compartment.
* Pared down "trade-goods.plist" to only contain required information, hopefully making it compatible with "Risk based economy" v2 OXP and BlOomberg Markets OXP.
* Removing the smuggling compartment or phase scanner at a Rock Hermit (or other non-GalCop station) will now refund the full cost, rather than just 70%.
* Changing the size of the smuggling compartment will refund the full price of the old size first, before purchasing the new size.
* Fixed bug when starting new game.
* Fixed issue where the message about delivering illegal goods via a cargo contract was appearing incorrectly.

0.6.0
* Fixed issue where illegal flags were not appearing on secondary stations, removed need to have planetinfo.plist.
* Removed log file debug code.

0.5.0
* Fixed bug with selling relabelled cargo.
* Fixed issue with delivering a standard cargo contract to a system where the cargo has become illegal after accepting the contract. The player was not being given the opportunity to bribe a docking official to clear their bounty.
* Fixed issue where, after using the phase scanner and being discovered using it, and then docking, the player was not being given the opportunity to bribe their way out of trouble.
* Added emails for various actions, when the Email System OXP is in use.
* Changed skull and crossbones background image for Black Market.
* Improved integration with [[Illegal_Goods_Tweak_OXP|Illegal Goods Tweak OXP]] (v2.2.0). The inital screen IGT displays will now look like an Amnesty Intergalactic screen, rather than a GalCop one, and the player has only two choices: hand over the slaves, or work with GalCop. If they choose the latter, Smugglers will include slaves as part of its import restrictions and the player can bribe as normal if they choose to.

0.4.0
* Fixed issue where you could purchase any smuggling compartment, regardless of how much credit you have.
* Added player credit balance to smuggling compartment purchase screen.
* Added player credit balance to Black Market purchasing screens.
* Tightened up which stations will have a Black Market.
* Added government icon and TL to all purchase screens in Black Market.
* Tweaks to the calculation of phase scan noticeboard items.
* Improvements to the page handling for illegal goods.

0.3.1
* Fixed mangled manifest.plist file.

0.3.0
* Tweaks to the minimum tech level for purchasing smuggling equipment items.
* Further adjustments to precious metals and gem stones illegal notifications for better economic balance.
* Added overlay background images to various interface screens.
* Smuggling compartment repair costs now linked to size of compartment.
* Arriving in a system where you have a permit but no cargo for that permit will no longer remove the permit.
* Routine to create new illegal goods will now exclude the current system, to prevent the issue where the engine understands a good is illegal, but the game interface doesn't.
* Added extra checks to the docking process to ensure a good that the engine understands is illegal is also marked as illegal on the market screen before penalising the player.
* Added police ship models to all the after-dock screens.

0.2.0
* Made the price of RH waypoints, fake permits and phase scans related to the station price factor.
* Bribing the same station multiple times will increase the required amount of the bribe (by 10 or 20 percent each time).
* Added the last successful bribe amount to the screen where you enter a bribe amount.
* Reduced the police vessel detection range for the phase scanner, as their ships wouldn't have the same range as the main station.
* Main station market quantity of illegal goods under contract now set to zero (so, when arriving short, the player can't just buy the difference, launch and redock to complete the contract).
* Fixed issue where you could purchase anything from the Black Market, regardless of how much credit you have.
* Limited smuggling compartment options to standard commodities only.
* Fixed issue where wrong illegal goods were being picked up if the player followed another ship through a wormhole.
* Rebalanced prices for precious metals and gem stones.
* Damaged smuggling compartments and phase scanners can now be repaired, and better handling of damaged equipment in general.
* Fixed issue where phase scanner would not show up for purchase anywhere.
* Fixed issue where having 0t available space would not allow transfer of precious metals from smuggling compartment to standard hold.
* Added a new item to the Illegal Goods interface screen that lists all purchased Rock Hermit waypoints.
* Fixed issue with tech upgrades, where the option to purchase new ones was always available, no matter how many times you purchased it.
* Adjusted the price of the tech upgrade.
* Bug fixes.

0.1.2
* Added missing semi-colon to planetinfo.plist.
* Found additional spot where techlevel was showing 1 lower than actual.
* Fixed issue where phase scans for TL 1 systems would not show up in the list of discovered phase scans.

0.1.1
* Tech levels on all displays were showing 1 lower than actual.
* Attempting to bribe a dock master to relabel cargo when you don't have any cargo that can be relabeled would put the game into a locked state.
* Spelling corrections.

0.1.0
* Initial public release
</div>

== Links ==
*[https://bb.oolite.space/viewtopic.php?f=4&t=17723 BB Thread for this OXP]
*[https://bb.oolite.space/viewtopic.php?f=4&t=17179 Idea for Smugglers OXP] (2015) Fons et origo of this OXP
*[https://bb.oolite.space/viewtopic.php?f=2&t=17675 Legal column on Market screen] (2015) related discussion of the confusions inherent in the Legal column.

*[https://bb.oolite.space/viewtopic.php?p=204379#p204379 Expanded version of the smuggling proposal] (Elite: Dangerous - Design Decision Forum: 2013)

==Quick Facts==
{{OXPLevel|2}}{{IconOXP|ooVersion="1.82"|oxpCPU="Average"|oxpMEM="Average"|oxpGPU="Low"|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
{{Infobox OXPb| title = Smugglers.oxz
|version = 2.11
|release = 2026-05-10
|license = CC BY-NC-SA 3.0
|features = Equipment, Commodities
|category = Mechanics OXPs
|author = [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=17723 Oolite BB]
}}

==Gameplay and Balance indicator==
[[Image:tag-colour-orange.png]]

Black Market

2026-05-10T06:48:03Z

Phkb:

Adds black markets to most Rock Hermits and some other stations.

==Overview==
When docked at most non-GalCop stations (Rock Hermits, predominantly), and even GalCop stations in some systems, you will find a new interface screen called "Black Market". This interface provides access to a number of options: 
a. Noticeboard: View some of the messages from the black market news boards. Some are good, some aren't. You might even learn about some tasty abandoned cargo! 
b. Smuggling contracts: These contracts will be smaller cargo quantities (less than 20t), and they will all be illegal at the destination system, so there will be a high degree of risk with each one. However, the rewards will be substantial, more than double what the cargo would be worth at the destination. ([[Smugglers - The Galactic Underworld|Smugglers OXP]] required) 
c. Purchase fake import permits: You can purchase fake import permits that may or may not work at the destination system. The chance is only a slightly better than 50%. ([[Smugglers - The Galactic Underworld|Smugglers OXP]] required) 
d. Purchase Rock Hermit waypoints: Finding Rock Hermits is important, as they are the primary location to access the Black Market. Waypoints can help you find a Rock Hermit in a given system. 
e. Purchase phase scan settings: Not always available but occasionally a trader will offer their settings for a price. ([[Smugglers - The Galactic Underworld|Smugglers OXP]] required) 
f. Sell phase scan settings: If you have discovered a phase scan setting, you can sell it for some real coin! This will only be available once you have purchased a phase scanner. ([[Smugglers - The Galactic Underworld|Smugglers OXP]] required) 
g. Sell restricted equipment: If you've come into possession of some military grade equipment, you can potentially find a buyer on the black market. 

Please be aware that GalCop have been known to run sting operations at some Black Markets. If you are caught buying illegal information or goods through a Black Market while a sting operation is in place, you will be penalised.

==3rd Party Access To Black Market==
It's possible for other OXP's to add items to be sold on the Black Market. You can add your item using the following method:

var sbm = worldScripts.Smugglers_BlackMarket;
if (sbm) {
sbm.$addSaleItem({
key:"my_key_value", // reference to be passed back to your worldscript when the item is sold, so you can know which item it was
text:"A very exclusive item", // text to display on the sale screen
cost:1000, // the base cost of the item. a system factor will be applied to this value, either increasing or decreasing it
worldScript:"my_worldscript_name", // the name of your worldscript
sellCallback:"$my_functionname", // the name of the function to be called in the item is sold
});
}

this.$my_functionname = function(key, price) {
// this is the function that will be called. the key name and the price are two parameters of the function
// you can now do any additional functions that need to be done (eg removing special equipment or cargo)
}

Items added to the Black Market will stay there until the next witchspace jump. If you want to remove the item manually, you can use this function:

var sbm = worldScripts.Smugglers_BlackMarket;
if (sbm) {
sbm.$removeSaleItem(key);
}

You can also remove all sale items for your worldScript with this function:

var sbm = worldScripts.Smugglers_BlackMarket;
if (sbm) {
sbm.$removeWorldScriptItems(ws);
}

==Developer Note==
This OXP used to reside inside the [[Smugglers - The Galactic Underworld|Smugglers OXP]], and so a lot of the code and descriptions are related to that OXP. However, I had the need of a Black Market for another project, and rather than force players to install Smugglers (which has a big impact on gameplay), I split out the functionality into a separate pack.

==Download==
Download [[Media:BlackMarket_1.6.oxz|BlackMarket_1.6.oxz]] 

==License==
This OXP is released under the Creative Commons Attribution - Non-Commercial - Share Alike 3.0 license. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/

Skull and crossbones image from http://simpleicon.com/dangerous_sign.html.

==Version History==
1.6
* Added Black Market Info Booklet to Ship's Library (if installed).

1.5
* Darkened overlay images for better compatibility with Oolite 1.92.

1.4
* Moved all text into descriptions.plist for easier localisation.

1.3
* Added sound when a fuel leak occurs.

1.2
* Added missing noticeboard items to descriptions.plist.
* Small code improvements.

1.1
* Fixed issue that was displaying "You have a waypoint to a Rock Hermit in this system" on th F7 page for every system.

1.0
* Initial release

==Quick Facts==
{{OXPLevel|0}}{{IconOXP|ooVersion="1.80"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Low"|oxpIsAPI=true|oxpIsDocumented=true}}
{{Infobox OXPb| title = BlackMarket.oxz
|version = 1.6
|release = 2026-05-10
|license = CC BY-NC-SA 4.0
|features = Rock Hermits
|category = Mechanics OXPs‏‎
|author = [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=17723 Oolite BB]
}}

Ship Repurchase

2026-05-10T06:47:10Z

Phkb:

==Overview==
This OXP aims to make the experience of using an escape pod a bit more interesting and realistic. The first change is that the player will be auto-ejected from their ship just before it is destroyed, in almost all cases1, even if they don't have an escape pod. If the player has not fitted an escape pod, they will eject from their ship in a life-support suit only, which provides a means of keeping the pilot in stasis until they can be recovered. If an escape pod is fitted, it will auto-eject the player when it is clear the ship can no longer support life. Players can also choose when they eject if they have an escape pod, rather than waiting for the auto-eject process to kick in. Also, any parcels or passengers currently on board, and any gold, platinum or gem-stones will not fit into the life-support suit, and so will be lost with the rest of the cargo and ship. If an escape pod is fitted, these items will be preserved.

Once the player has been recovered, they then need to decide what to do about replacing their ship. They will be given (at most) three options: 
# to replace their previous ship plus all the equipment on it;
# to just replace their existing ship, leaving out any equipment; or
# choosing a lower cost ship as a replacement.

For options (1) and (2) there is a cost involved: 10% of the original cost. If, however, you have purchased an escape pod, there is an insurance component to the purchase that reduces the amount to be only 5% of the original cost. A more expensive escape pod option, named "Escape Pod Plus", will reduce the amount further, to 2.5% of the original cost.

Option (3) is always free. Potentially two ships will be offered, depending on the base value of your current ship. The following table outlines the ships that will be offered (Offer 1 ships are generally trader-type ships, while Offer 2 ships are generally hunter-type ships):

<table><tr><td width="120px">Current ship Base Value</td><td width="170px">Offer 1</td><td width="170px">Offer 2</td></tr>
<tr><td>650001+</td><td>Anaconda</td><td>Fer-de-Lance</td></tr>
<tr><td>495001-650000</td><td>Boa Class Cruiser</td><td>Fer-de-Lance</td></tr>
<tr><td>485001-495000</td><td>Boa</td><td>Fer-de-Lance</td></tr>
<tr><td>450001-485000</td><td>Boa</td><td>Asp Mark II</td></tr>
<tr><td>375001-450000</td><td>Python</td><td>Asp Mark II</td></tr>
<tr><td>200001-375000</td><td>Python</td><td>Cobra Mark III</td></tr>
<tr><td>150001-200000</td><td>Cobra Mark III</td><td></td></tr>
<tr><td>145001-150000</td><td>Moray Medical Boat</td><td>Moray Star Boat</td></tr>
<tr><td>125001-145000</td><td>Moray Star Boat</td><td></td></tr>
<tr><td>100001-125000</td><td>Cobra Mark I</td><td></td></tr>
<tr><td>0-100000</td><td>Adder</td><td></td></tr>
</table>

If a full ship plus equipment replacement is chosen, the ship will arrive in a fully working condition. That is, any equipment that was damaged at the time of destruction will be in a working order on the replacement2, and the ship will not be in need of an overhaul.

If the player has insufficient funds to purchase either the full replacement, or the stock replacement ship, they will be forced to accept the lower value ship as their free ship to continue their galactic journey.

Note that, if you have passengers on board, choosing option (2) or (3) will result in those passengers being abandoned at the station and the contracts terminated.

1 Note: If your ship is caught in a cascade explosion, the auto-eject process cannot eject you to a safe distance, meaning any life-suit or escape pod will also be destroyed. 
2 Note: The one exception to this rule is the cloaking device, which, because of the nature of the device and how it came to be in your posession, constitutes a real problem for insurance repair coverage. However, if you are rescued at a station that has a suitably high tech level, the device will be repaired.

==Frequent Ejecting Penalty==
In order to curb misuse (for instance, ejecting from a badly damaged ship to avoid repair bills), players who eject frequently will suffer a repurchase penalty. The calculation is (1 + ((monthly_eject_count - 1) x 2) / 10) x original_percentage. So, ejecting 2 times in a month will increase the percentage to 12%. Ejecting 3 times in a month will increase the percentages to 14%. If you were to eject 16 times in a month, that would change the 10% of original cost of the ship to be 40%.

As a player progresses through the game, the length of time used for picking up ejecting events in the calculation will increase. Players with less than 32 kills will stay at the 30 day mark. After 32 kills, the period increases to 60 days (2 months). At 64 kills, the period is 90 days (3 months); at 128 kills, the period is 4 months; at 512 kills the period is 6 months; at 2560 kills, the period is 9 months; and at 6400+ kills, the period is 1 year.

==Insurance==
Due to the high number of total-loss payments insurance providers have been forced to make over the last decade, no-cost replacement insurance is no longer a complimentary part of an escape pod purchase. Instead, as noted above, any escape pod purchase will instead reduce the cost of any repurchase event.

However, many clients still find even the reduced costs difficult to bear. So insurance providers have introduced "Ship Repurchase Insurance", which covers the holder of the policy for a maximum of 30 days from date of purchase, and will reduce the cost of any ship plus equipment replacement to just 1000cr. A ship-only replacement will cost just 500cr. This insurance can be purchased at any GalCop-aligned station in all systems. The insurance is a once-only policy - if the policy is invoked, the terms state that the policy is then terminated.

==New Jamesons==
Insurance providers understand that new pilots need more protection than experienced ones. To help new pilots on their way, these payments will only be required for pilots who have attained an Elite rank of "Poor". If a "Harmless" or "Mostly Harmless" pilot ejects, the cost of a full replacement ship will be greatly reduced: 200cr for a full ship and equipment replacement, 100cr for a ship-only replacement.

==Interstellar space==
Ejecting in interstellar space is generally fatal - there is usually no one close enough to your location to render assistance, and the limited fuel on the escape pod is insufficient to enable a return to normal space.

Occasionally, though, there are rescue options even in interstellar space. If one of these options is close by (like a naval station or carrier), there is a chance a rescue will take place. However, insurance operators cannot provide replacement ships in this situation. Instead, the player will be given a used ship and will have to make their way back to normal space in this. When they dock at a GalCop station they will at that time be presented with options for ship replacement.

==History==
The standard escape pod in the core game operates in a strange way. While the description indicates there is some sort of insurance policy involved in purchasing the pod, if you eject with a ship full of damaged equipment, you will be given a replacement ship with the same damaged equipment in it. This reflects what happened in the 8-bit versions of Elite, and was likely a result of limited resources to do anything more complex.

==Required OXP's==
This OXP uses the [[Ship Storage Helper]] OXP to store and recover the players ship.

==Compatibility==
This OXP should be fully compatible with the [[Auto_eject_OXP|Auto-Eject OXP]] by Commander McLane. The "Auto-Eject" equipment will eject the player ahead of the auto-eject function of this pack, and the repurchasing process will apply in both situations.

It should also be fully compatible with the [[Interstellar Tweaks]] OXP by UK Eliter. When ejecting in interstellar space, the recovery options of this OXP will ceed control to Interstellar Tweaks, allowing it to choose the destination. The repurchasing process will apply after recovery.

==Download==
Download [[Media:ShipRepurchase.oxz|ShipRepurchase.oxz]] v0.7 (downloaded {{#downloads:ShipRepurchase.oxz}} times).

==License==
This work is licensed under the Creative Commons Attribution-Noncommercial-Share Alike 4.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/4.0/

Rocket image from http://simpleicon.com/rocket.html 
Shield image from https://www.iconfinder.com/icons/175318/shield_icon#size=512

==Version History==
0.7
* Added "Ship Repurchasing Information" book to Ship's Library (if installed).

0.6.4
* Darkened overlay images for better compatibility with Oolite 1.92.

0.6.3
* Moved all text into descriptions.plist for easier localisation.

0.6.2
* Preventing recovery from a Generation ship.

0.6.1
* Increased required version level for Ship Storage Helper.

0.6
* Adjusted the method for determining when the ship is about to die, to allow for other OXP's to potentially change the player ship energy before ejecting the player.
* Changed insurance premium coverage period to 60 days.
* If insurance lapses while in transit, it will still be valid at next dock if the player needs to use it.
* Reduced cost of Escape Pod Plus to 3000 credits, and set techlevel requirement to same as for a normal escape pod.
* If the Escape Pod Plus is installed, rescue time will be reduced to less than 12 hours. Also, 50% of cargo will be recovered.
* Cost of Repurchase Insurance reduced to 2500 credits.
* Removed the frequent ejection penalty calculation (although it could be returned based on feedback).
* Raised minimum Oolite version to 1.89 (now utilising equipment-overrides.plist file and new escape pod rescue time property).

0.5
* Better handling of multiple damage events taking place at the same time.

0.4
* Better integration with Ship Configuration OXP armour settings.
* Better integration with Battle Damage OXP.
* Code refactoring.

0.3
* Added integration with Email System, so contract termination emails are sent if the player loses parcel or passenger contracts due to using the life-support suit when ejecting.

0.2
* Now considering player score when determining how far back to include ejecting events in the frequent ejecting penalty calculation.
* Free ship offer can be one of 2 types: a trader ship, or a hunter/assassin ship.
* Fixed issue where equipment items that can be multiple were not all being repaired after an eject event.
* Enforced consistency with Cobra Mark III and Mark I base prices.
* Fixed issue where interstellar space mode was being activated incorrectly.

0.1
* Initial version.

== Quick Facts ==
{{OXPLevel|3}}{{IconOXP|ooVersion="1.90"|oxpCPU="Average"|oxpMEM="Low"|oxpGPU="Low"|oxpIsChild=true}}
{{Infobox OXPb| title = ShipRepurchase.oxz
|version = 0.7
|release = 2026-05-10
|license = CC BY-NC-SA 4.0
|features = Escape Pods, Insurance
|category = Mechanics OXPs
|author = [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=19239 Oolite BB]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-red.png]]

XenonUI

2026-05-10T06:46:09Z

Phkb:

[[image:XenonUI_sample.png|thumb|right|700px|Sample screenshot using Dangerous Square Font and Resource Pack E, combined with the Xenon HUD 
Note Sub-Commands given on left & right of main screen]]

==Overview==
Still forgetting what "?" does on the F8 screen? Or "^" on the F6 screen? XenonUI gives you all the information on your screen!

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.

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

[[File:XenonUI (Expansions Manager).png|thumb|right|500px|Stop-Press! XenonUI now adds this guide for your in-game [[Expansions Manager]]! 
On the left (Sub-Commands): filter/information/extract contents 
On the right: guide to colours]]
== Features ==
The OXP is made up of two parts: the main XenonUI.oxz, which holds all the config, code and the music file, and a resources pack which holds all the images. This will allow fast updates to the code section, which is small, without having to download the large resources file regularly.

There are different packs for screen ratios of 16:9 or 16:10 (also known as 8:5 ratio), and using different fonts for the text.
<table><tr><td></td><td colspan="2">'''Screen Ratio'''</td></tr>
<tr><td>'''Font'''</td><td>'''16:9'''</td><td>'''16:10'''</td></tr>
<tr><td>[[Oolite_Fonts#OCR_A_Extended|OCR A Extended]]</td><td>Pack A</td><td>Pack B</td></tr>
<tr><td>[[Oolite_Fonts#Xolonium|Xolonium]]</td><td>Pack C</td><td>Pack D</td></tr>
<tr><td>[[Oolite_Fonts#Dangerous_Square|Dangerous Square]]</td><td>Pack E</td><td>Pack F</td></tr>
<tr><td>Default (Helvetica)</td><td>Pack G</td><td>Pack H</td></tr>
<tr><td>[[Oolite_Fonts#Dosis|Dosis/Dangerous]]</td><td>Pack I</td><td>Pack J</td></tr>
<tr><td>[[Oolite_Fonts#Discognate|Discognate]]</td><td>Pack K</td><td>Pack L</td></tr>
<tr><td>[[Oolite_Fonts#NovaSquare|NovaSquare]]</td><td>Pack M</td><td>Pack N</td></tr>
</table>

*To compare the fonts see [[Fonts]]

*For narrower screens, there is a "Redux" version, which removes all the sidebars, leaving only the grid background and main window outline. Because of this, the legend overlay on the F6 galactic chart display is not provided in this version.

==Amber Color Style==
It is possible to switch between the default blue color style, and an amber color style, using [[Library OXP|Library Config]].
[[image:XenonUI_amber_sample.png|centre|700px|Sample amber screenshot using Dangerous Square Font and Resource Pack E, combined with the Xenon HUD]]

== F6 Overlay integration ==
A facility has been provided for other OXP's to supply the overlays on the F6 screen which describe the economy, government, techlevel and sun colors. To use it, add the following code to your startUpComplete world script:

var xui = worldScripts.XenonUI;
// "economy": this defines which section the callback applies to, either economy, government, techlevel or suncolor
// this.name: this defines the name of your world script where the function can be found
// "$returnF6EconomyOverlay": this defines the name of the function that will be called when the F6 overlay is required.
xui.$setF6OverlayLookup("economy", this.name, "$returnF6EconomyOverlay");

Then create the function that will be called when the various F6 overlays are requested.
The parameters "ratio" and "font" will be passed to your function.
"ratio" will be either "16_9" or "16_10", referring to screen ratio of the Xenon UI images currently active.
"font" will be the font name of the font type associated with the Xenon UI resources currently active. Will be either "default", "dangeroussquare", "discognate", "dosis", "novasquare", "ocraextended" or "xolonium".

this.$returnF6EconomyOverlay = function(ratio, font) {
return "my_f6-overlay-economy_" + ratio + "_" + font + ".png";
}

== Conflicts ==
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, in order to maintain the illusion that the player is looking at the game world through a computer monitor with a standard interface.

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");

(See Version History below: 3.3, 2.0.1, 1.3.3, ''etc'')

===Conflicts: BackGroundSet (BGS) 1.0 Compatibility===
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 particularly 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.

===Conflicts: BackGroundSet 2.0 Compatibility===
Xenon UI will hook into [[Library OXP|Library]] GUI to register itself as a GUI set. Therefore, you can go to the [[Library OXP|Library]] GUI settings and change between BGS 2.0 and Xenon UI anytime you like.

Because of the way the images are created, Xenon UI is still utilising settings in "screenbackgrounds.plist", which may lead to some inconsistencies. For instance, if Xenon UI and BGS 2.0 are installed, when you start Oolite and select the option to open a saved commander, the background will likely be Xenon UI. Once you have loaded a game where BGS 2.0 is the specified GUI, if you then press F2 to load a new game, you will see the BGS background.

==Changing Keyboard commands==
If you have changed any of the keyboard commands for gui screens (''eg'' changing the filtering or sorting key on the F8 Market screen, or the system name/info key on the F6 chart screen), XenonUI will '''not''' show these changes. Only the [[Vanilla game]] gui key-commands are displayed.

==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 one of the resource packs (A through N) 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 does not have any sidebars or Galactic chart legend overlays.

===AddOns===
There is an addon pack for Xenon UI, "Xenon UI SW Economy Addition", which adjusts the economy descriptions on the F6 page to match the definitions in [[SW Economy]]. This addon will only work with the Xenon UI pack (not the redux version). 
This is no longer required if you have the latest version of SW Economy.

==Download==
===Main Version===
Download [[Media:XenonUI.oxz|XenonUI.oxz]] v3.14 (downloaded {{#downloads:XenonUI.oxz}} times).
 Download resources pack A (16:9 screens) [[Oolite_Fonts#OCR_A_Extended|OCR A Extended font]] v2.1 [[Media:XenonUIResourcesA.oxz|XenonUIResourcesA.oxz]] (downloaded {{#downloads:XenonUIResourcesA.oxz}} times).
 Download resources pack B (16:10 screens) [[Oolite_Fonts#OCR_A_Extended|OCR A Extended font]] v2.1 [[Media:XenonUIResourcesB.oxz|XenonUIResourcesB.oxz]] (downloaded {{#downloads:XenonUIResourcesB.oxz}} times).
 Download resources pack C (16:9 screens) [[Oolite_Fonts#Xolonium|Xolonium font]] v2.1 [[Media:XenonUIResourcesC.oxz|XenonUIResourcesC.oxz]] (downloaded {{#downloads:XenonUIResourcesC.oxz}} times).
 Download resources pack D (16:10 screens) [[Oolite_Fonts#Xolonium|Xolonium font]] v2.1 [[Media:XenonUIResourcesD.oxz|XenonUIResourcesD.oxz]] (downloaded {{#downloads:XenonUIResourcesD.oxz}} times).
 Download resources pack E (16:9 screens) [[Oolite_Fonts#Dangerous_Square|Dangerous Square font]] v2.1 [[Media:XenonUIResourcesE.oxz|XenonUIResourcesE.oxz]] (downloaded {{#downloads:XenonUIResourcesE.oxz}} times).
 Download resources pack F (16:10 screens) [[Oolite_Fonts#Dangerous_Square|Dangerous Square font]] v2.1 [[Media:XenonUIResourcesF.oxz|XenonUIResourcesF.oxz]] (downloaded {{#downloads:XenonUIResourcesF.oxz}} times).
 Download resources pack G (16:9 screens) Default (Helvetica) font v2.1 [[Media:XenonUIResourcesG.oxz|XenonUIResourcesG.oxz]] (downloaded {{#downloads:XenonUIResourcesG.oxz}} times).
 Download resources pack H (16:10 screens) Default (Helvetica) font v2.1 [[Media:XenonUIResourcesH.oxz|XenonUIResourcesH.oxz]] (downloaded {{#downloads:XenonUIResourcesH.oxz}} times).
 Download resources pack I (16:9 screens) [[Oolite_Fonts#Dosis|Dosis (Dangerous) font]] v2.1 [[Media:XenonUIResourcesI.oxz|XenonUIResourcesI.oxz]] (downloaded {{#downloads:XenonUIResourcesI.oxz}} times).
 Download resources pack J (16:10 screens) [[Oolite_Fonts#Dosis|Dosis (Dangerous) font]] v2.1 [[Media:XenonUIResourcesJ.oxz|XenonUIResourcesJ.oxz]] (downloaded {{#downloads:XenonUIResourcesJ.oxz}} times).
 Download resources pack K (16:9 screens) [[Oolite_Fonts#Discognate|Discognate font]] v2.1 [[Media:XenonUIResourcesK.oxz|XenonUIResourcesK.oxz]] (downloaded {{#downloads:XenonUIResourcesK.oxz}} times).
 Download resources pack L (16:10 screens) [[Oolite_Fonts#Discognate|Discognate font]] v2.1 [[Media:XenonUIResourcesL.oxz|XenonUIResourcesL.oxz]] (downloaded {{#downloads:XenonUIResourcesL.oxz}} times).
 Download resources pack M (16:9 screens) [[Oolite_Fonts#NovaSquare|NovaSquare font]] v2.1 [[Media:XenonUIResourcesM.oxz|XenonUIResourcesM.oxz]] (downloaded {{#downloads:XenonUIResourcesM.oxz}} times).
 Download resources pack N (16:10 screens) [[Oolite_Fonts#NovaSquare|NovaSquare font]] v2.1 [[Media:XenonUIResourcesN.oxz|XenonUIResourcesN.oxz]] (downloaded {{#downloads:XenonUIResourcesN.oxz}} times).

Download SWEconomy Additions: [[Media:XenonUI_SWEconomy_Addition.oxz|XenonUI_SWEconomy_Addition.oxz]] v1.0 (This is no longer required if you have the latest version of SW Economy)

===Redux Version (for narrower eg 4:3 screens)===
Download [[Media:XenonReduxUI.oxz|XenonReduxUI.oxz]] v3.10 (downloaded {{#downloads:XenonReduxUI.oxz}} times).
 Download [[Media:XenonReduxUIResources.oxz|XenonReduxUIResources.oxz]] v2.0 (downloaded {{#downloads:XenonReduxUIResources.oxz}} times).

==Licence/Author==
This work is licensed under the Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.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.

==Version History==
3.14
* Further improved compatibility with Market Ads and Library GUI.

3.13
* Further improved compatibility with OXP's that turn the HUD on/off on the System Data screen.

3.12
* Improved compatibility with Market Ads and Library GUI.

3.11
* Darkened overlay images for better compatibility with Oolite 1.92.

3.10
* Fixed issue where mission chart screens had the wrong background if Library is installed.
* Fixed some small graphic artefacts in some of the overlay images.
* Moved text into descriptions.plist for easier localisation.

3.9
* Added fix for issue where the wrong F6 screen overlay could be shown when the screen is first displayed.
* Added new start menu background.

3.8
* Added fix for issue where the HUD being turned on/off could result in the wrong size UI screen being shown.

3.7
* Added custom background for the OXZ Manager screen, with helper text.

3.6.1
* Fixed for issue where the game is saved while Overlays are disabled and HDBG OXP is installed, and the game is then reloaded.

3.6
* Added facility to allow for 3rd party OXP's to provide the F6 overlay images.

3.5
* Bug fixes.

3.4
* Bug fixes.

3.3
* Fixes for [[Ship's_Library_OXP|Ships Library]], [[SothisTC|Sothis TC]], [[New_Cargoes|New Cargoes]] and [[Iron_Raven|Iron Raven]] to restore background images.

3.2
* Improvements into [[BGS]] compatibility.

3.1
* Small tweak for potential performance improvements.
* Updated compatibility with Library 1.7.

3.0
* Added "Amber" background option (selectable via Library Config).
* Code refactoring.

2.2.1
* Improvements in Library GUI integration.
<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">
2.2.0
* Added functions to enable different chart legend overlays to be displayed, based on what the player has selected. (Oolite 1.87/88 required)

2.1.4
* Improved coverage of different mission screen sequencing scenarios. (Oolite 1.85/86 required)
* Improved integration with XenonReduxUI via Library GUI.
* Added new screenbackgrounds added in v1.87 ("custom_chart_mission").

2.1.3
* Fixed incorrect key lookup with mission screen overlays.
* Fixed issue with turning off overlay images with Library GUI.
* Disabling background images on a mission screen will now also disable any overlays as well.

2.1.2
* Bug fixes.

2.1.1
* Rejigged connection to Library GUI for nicer handovers when GUI's change.

2.1.0
* Updated for simpler integration with Library GUI.
* Code refactoring.

2.0.4
* Adjusted the Random Hits screen ID exception.

2.0.2
* Updated title screen image.
* F5 Cmdr Profile and F5F5 Manifest were swapped around when using Library GUI.

2.0.1
* Fixed compatibility issue with [[HDBG]] when using Library GUI.

2.0.0
* Made compatible with [[Library OXP|Library]] GUI.
* Added some configuration settings to Library Config.
* Added additional overlays to various data screens.
* Code cleanup.

1.4.2
* Corrected error in Nova Mission runScreen command parameters (caused by me, not the core code!) that was causing the Yes/No option to not display.

1.4.1
* Updated check for "Allow Big GUI".

1.4.0
* Changed new game background to the 'no hud' variant.
* New title screen image.
* Added mission screen overlays. Can be disabled by setting "this._disableOverlays = true;" in "xenonui.js".
* Fixed issue with BGS where the F6 overlay image was being removed.
* Fixed issue where exiting the Ship Library screen would sometimes show the wrong background.
* Added mission screen exception for Random Hits.

1.3.3
* Added screenID exceptions for UPS Courier.
* Added screenID exceptions for Escort Contracts (v1.6.3).
* Added routine to use 1.83/4 code to check for big GUI HUD's.

1.3.2
* Fixed Javascript bug.

1.3.1
* Added screenID exceptions for Blackmonks.
* Fixed issue where all components were not being disabled correctly when no resource packs are installed.

1.3.0
* Checks for the "allow_big_gui" option on HUD's. Uses the "nohud" background variations when found.
* Fixed issue where the wrong background was being selected going to or from the F8 Market screen if Market Observer is installed.
* Added screenID exceptions for Rescue Stations.

1.2.0
* Updated all images to be 2048x1024 to stop Oolite from rescaling them. Results in a much cleaner image
* Fixed issue with mission screens that exit to the short or long range chart, where the wrong background was being displayed.
* Added screenID's to nova mission screens.
* Moved the music file back into the main OXP so it doesn't have to be in all the resource packs.
* Added a paused overlay.
* Added a legend overlay to the Galactic chart screens to aid in understanding the various highlight modes.
* Added a routine to check for the presence of resource pack, and output an error to the log if no pack is found.
* Added a "requires_oxp" section to all resource packs to require the main OXP.

1.1.4
* Adjusted the main title colour to match with the background.
* Adjusted graphical elements to line up better between screens, as noted by Tichy.
* Fixed issue with Trumbles and Nova missions not showing proper background image.
* Changed license of code section to CC-BY-NC-SA 3.0 due to inclusion of trumbles and nova mission code.

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

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

1.1.1
* Fixed bug where "." is missing before "indexOf".

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 OXP ([[HDBG]])
* Added some BGS override exceptions

1.0
* Initial release
</div>

==Quick Facts==
{{OXPLevel|0}}{{IconOXP|ooVersion="1.80"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Average"|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
{{Infobox OXPb| title = XenonUI.oxz
|version = 3.14
|release = 2026-05-10
|license = CC BY-NC-SA 3.0
|features = Backgrounds Music
|category = Ambience OXPs
|author = [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=17511 Oolite BB]
}}

==Gameplay and Balance indicator==

[[Image:tag-colour-blue.png|right]]
This OXP is crucial for new players, giving vital information on-screen. A must!

[[Category:Sound Sets OXPs]]

Planetfall2 OXP

2026-05-10T06:45:01Z

Phkb:

[[Image:IconPF2.png|100px|right]]
[[File:PlanetFall2 city 7.png|300px|thumb|right|Landing at a city]]
[[File:PlanetFall2 moon 5.png|300px|thumb|right|Landing on a moon]]
== Overview ==
{{Infobox EquipStats Oolite| title = PlanetFall2 OXP
|image =
|equipName = Atmospheric Stabilisers
|equipCost = 5,000₢
|equipTL = 9
}}
An OXP which allows the Commander to land at specific locations on planets and moons (but not suns, even at night). Each main planet has up to 5 designated landing sites, while additional planets can have 3, and each moon can have 2 (configurable via [[Library OXP|Library Config]]). Pick your landing site and point your ship at the flashing marker near the surface that indicates the Ground Control Interface Point for the landing zone. Ensure your flight path is not too steep, otherwise you may sustain damage when the automated landing protocol engages.

Be careful of turbulence as you enter the atmosphere. To assist with atmospheric turbulence, the "Atmospheric Stabilisers" can be purchased at any TL9+ system for 5000cr. When equipped, this will reduce the impact of turbulence on your ship. Speed will have an impact on how much your ship is effected by turbulence. Slowing down will decrease the effect.

Your approach will trigger an automatic landing request. You should receive a response after a few seconds, indicating you are either cleared for landing or not. If you have clearance, continue towards the Ground Control Interface Point at less than 100 m/s until the automated system engages, captures your ship and lowers you to a landing pad.

Planetary take-off is via a launch booster, with control being returned to the Commander once orbital insertion is achieved.

=== A suite of OXPs ===
This OXP is currently a suite of 3 OXPs with another 2 optional OXPs:
*'''PlanetFall2''' (the coding)
*'''PlanetFall Resources A''' } individual planetary images part 1
*'''PlanetFall Resources B''' } individual planetary images part 2

*Optional: '''Feudal PlanetFall2''' (linking PlanetFall2 with [[Feudal States]] which is currently the only OXP which does much on the planet surface).
:<s>At time of writing PlanetFall2 is only compatible with Feudal States v.1 (and the ''alpha'' Feudal States v.2 is only compatible with PlanetFall v.1)!</s> It should now be compatible with both versions of Feudal States.
*Optional: [[Planet Rotation Cosmetics OXP]] slows down the planet's rotation as you approach it and are captured by the planet's gravity.

[[File:Planetfall2 Transit system.png|right|300px]]

=== Gaming changes from Thargoid's PlanetFall v1 (2008-13) ===
*You can now land on a planet without purchasing "planetary landing capabilities"/"atmospheric stabilisers" - but it is rather more dangerous
::If you have already bought "planetary landing capabilities", PF2 will convert them to "atmospheric stabilisers"
*There are now specific landing sites on the planet
*Commodity Markets are now included (''ie'' PlanetFall Markets OXP is redundant).
*When landed you can transit from one landing site to another (and pay good money to transit your ship, too!).
*[[Maintenance]] overhauls are now performed on the planet surface rather than in the orbital station (they will tell you this on the station!)
*There are other changes to be discovered!

== Requirements ==
*Oolite v.1.90 or better
*[[GNN]]
*[[Library OXP]]
*[[Market Script Interface]]
*[[External Docking System]]

While it isn’t a requirement, the [[Planet Rotation Cosmetics OXP]] is a highly recommended addition for PlanetFall 2.

== Options ==
There are a '''lot''' of options available to help configure the system the way you want it. The list is long, so if you want to see everything, ''click'' the link on the right.
<div class="mw-collapsible mw-collapsed" data-expandtext="Show me everything!" data-collapsetext="Turn it off! Turn it off!" style="overflow:auto;">
Library Config has the following sections for PlanetFall2:
* General settings
* Main planet settings
** F3/F8 access
** Spawn chances
* Extra Planet settings
** F3/F8 access
** Spawn chances
* Moon settings
** F3/F8 access
** Spawn chances
* Spawn chances: TL factors
* Transit costs
* Ship transfer costs

=== General settings ===
'''Flags'''
* '''Move shipyards to planet:''' Controls whether shipyards are moved to planet-side locations.
* '''Move maintenance to planet:''' Controls whether the "Maintenance Overhaul" item is moved to only be offered on planet-side locations.
* '''Atmosphere turbulence:''' Controls whether the turbulence effect, when entering the atmosphere of a planet, is active or not.
* '''Shallow approach:''' Controls whether a shallow approach angle is required when landing on a surface location.
* '''Use landing images:''' Controls whether the images displayed after landing at a planetary site are displayed.
* '''Use Almanac names:''' Controls whether the names of planetary locations are given names based on the methodology from the Galactic Almanac.
* '''Allow planetary transit:''' Controls whether it is possible to fast travel to other planetary sites after landing.

'''Values'''
* '''Main planet max:''' Maximum number of locations that could be spawned on the main planet.
* '''Extra planet max:''' Maximum number of locations that could be spawned on a secondary planet with an atmosphere.
* '''Moon max:''' Maximum number of locations that could be spawned on a moon with no atmosphere.
* '''Atmosphere max altitude:''' Maximum height (in km) of the atmosphere of a planet.
* '''Beacon range:''' Max distance (in km) that planetary beacons become visible to the player.
* '''Service Level dec:''' Amount that service level will be reduced by when launching from a planet.
* '''Transfer Time:''' Amount of time (in hours) that will pass when transferring player ship to the current location.
* '''Train speed:''' Base average speed of trains (in kph), which is scaled up or down based on the TL of the system.
* '''Turbulence impact scale:''' Scales the impact of turbulence, where 1.0 means no change to the default, 0.5 halves the impact, and 0.0 means no impact (same as turning turbulence off).

=== Main planet settings ===
==== F3/F8 Access ====
'''Flags'''
* '''Capital cities:''' Whether capital cities will have access to the F3 Equip Ship screen.
* '''Military bases:''' Whether military bases will have access to the F3 Equip Ship screen.
* '''Leisure complexes:''' Whether leisure complexes will have access to the F3 Equip Ship screen.
* '''Factories:''' Whether factories will have access to the F3 Equip Ship screen.
* '''Rubbish dumps:''' Whether rubbish dumps will have access to the F3 Equip Ship screen.

'''Values'''
* '''Capital cities:''' What type of market will be available at capital cities.
* '''Military bases:''' What type of market will be available at military bases.
* '''Leisure complexes:''' What type of market will be available at military bases.
* '''Factories:''' What type of market will be available at factories.
* '''Rubbish dumps:''' What type of market will be available at rubbish dumps.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51. (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn city:''' Chance of spawning a capital city.
* '''Spawn military base:''' Chance of spawning a military base.
* '''Spawn leisure complex:''' Chance of spawning a leisure complex.
* '''Spawn factory:''' Chance of spawning a factory.
* '''Spawn rubbish dump:''' Chance of spawning a rubbish dump.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Extra planet Settings ===
==== F3/F8 Access ====
'''Flags'''
* '''Colony cities:''' Whether colony cities will have access to the F3 Equip Ship screen.
* '''Military bases:''' Whether military bases will have access to the F3 Equip Ship screen.
* '''Leisure complexes:''' Whether leisure complexes will have access to the F3 Equip Ship screen.
* '''Factories:''' Whether factories will have access to the F3 Equip Ship screen.
* '''Rubbish dumps:''' Whether rubbish dumps will have access to the F3 Equip Ship screen.

'''Values'''
* '''Colony cities:''' What type of market will be available at colony cities.
* '''Military bases:''' What type of market will be available at military bases.
* '''Leisure complexes:''' What type of market will be available at leisure complexes.
* '''Factories:''' What type of market will be available at factories.
* '''Rubbish dumps:''' What type of market will be available at rubbish dumps.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51 (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn colony city:''' Chance of spawning a colony city.
* '''Spawn military base:''' Chance of spawning a military base.
* '''Spawn leisure complex:''' Chance of spawning a leisure complex.
* '''Spawn factory:''' Chance of spawning a factory.
* '''Spawn rubbish dump:''' Chance of spawning a rubbish dump.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Moons ===
==== F3/F8 Access ====
'''Flags'''
* '''Colony domes:''' Whether colony domes will have access to the F3 Equip Ship screen.
* '''Mines:''' Whether mines will have access to the F3 Equip Ship screen.
* '''Prisons:''' Whether prisons will have access to the F3 Equip Ship screen.
* '''Leisure domes:''' Whether leisure domes will have access to the F3 Equip Ship screen.
* '''Robot factories:''' Whether robot factories will have access to the F3 Equip Ship screen.
* '''Research complexes:''' Whether research complexes will have access to the F3 Equip Ship screen.
* '''Wastelands:''' Whether wastelands will have access to the F3 Equip Ship screen.

'''Values'''
* '''Colony domes:''' What type of market will be available at colony domes.
* '''Mines:''' What type of market will be available at mines.
* '''Prison:''' What type of market will be available at prisons.
* '''Leisure domes:''' What type of market will be available at leisure domes.
* '''Robot factories:''' What type of market will be available at robot factories.
* '''Research complexes:''' What type of market will be available at research complexes.
* '''Wastelands:''' What type of market will be available at wastelands.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51 (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn colony dome:''' Chance of spawning a colony dome.
* '''Spawn mine:''' Chance of spawning a mine.
* '''Spawn prison:''' Chance of spawning a prison.
* '''Spawn leisure dome:''' Chance of spawning a leisure dome.
* '''Spawn robot factory:''' Chance of spawning a robot factory.
* '''Spawn research complex:''' Chance of spawning a research complex.
* '''Spawn wasteland:''' Chance of spawning a wasteland.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Spawn chances: TL factors ===
'''Values'''
* '''Main planet min/max:''' Factor to apply to spawn chance of main planet locations based on the TL of the system.
* '''Extra planets min/max:''' Factor to apply to spawn chance of extra planet locations based on the TL of the system.
* '''Moons min/max:''' Factor to apply to spawn chance of moon locations based on the TL of the system.

The min value would be applied at the lowest TL, while the max value would apply to the highest TL. 
TL's in between would get a scaled value between min and max.

=== Transit costs ===
'''Values'''
* '''Fee:''' Base cost for a single trip (cr).
* '''Anarchy factor:''' Factor applied to fee in Anarchy systems
* '''Feudal factor:''' Factor applied to fee in Feudal systems.
* '''Multi-government factor:''' Factor applied to fee in Multi-Government systems.
* '''Dictatorship factor:''' Factor applied to fee in Dictatorship systems.
* '''Communist factor:''' Factor applied to fee in Communist systems.
* '''Confederacy factor:''' Factor applied to fee in Confederacy systems.
* '''Democracy factor:''' Factor applied to fee in Democracy systems.
* '''Corporate State factor:''' Factor applied to fee in Corporate State systems.

eg 0.0 = All trips are free; 1.0 = Use base cost; 0.5 = 50% of base cost.

=== Ship transfer costs ===
'''Values'''
* '''Fee:''' Base cost for ship transfer (cr).
* '''Anarchy factor:''' Factor applied to fee in Anarchy systems
* '''Feudal factor:''' Factor applied to fee in Feudal systems.
* '''Multi-government factor:''' Factor applied to fee in Multi-Government systems.
* '''Dictatorship factor:''' Factor applied to fee in Dictatorship systems.
* '''Communist factor:''' Factor applied to fee in Communist systems.
* '''Confederacy factor:''' Factor applied to fee in Confederacy systems.
* '''Democracy factor:''' Factor applied to fee in Democracy systems.
* '''Corporate State factor:''' Factor applied to fee in Corporate State systems.

eg 0.0 = Ship transfers are free; 1.0 = Use base cost; 1.5 = 150% base cost.

</div>

== Downloads ==
All components are downloadable through the in-game [[Expansions Manager]] 
Direct download here 
* [[Media:PlanetFall2_2.32.oxz|PlanetFall2_2.32.oxz]] (downloaded {{#downloads:PlanetFall2_2.32.oxz}} times).
* [[Media:PlanetFall2_ResourcesA.oxz|PlanetFall2_ResourcesA.oxz]] v1.1
* [[Media:PlanetFall2_ResourcesB.oxz|PlanetFall2_ResourcesB.oxz]] v1.0
* [[Media:Feudal_PlanetFall2_1.5.oxz|Feudal_PlanetFall2.oxz]] v1.5 (downloaded {{#downloads:Feudal_PlanetFall2_1.5.oxz}} times).
 
* [[Media:PlanetFall2_BlackMonks.oxz|PlanetFall2_BlackMonks.oxz]] v2.1 - Adds Bank of the Black Monks to the planet surface locations, providing all the normal bank facilities. The [[Black_Monk_Monastery|Bank of the Black Monks]] also needs to be installed.
* [[Media:PlanetFall2_HoopyCasino.oxz|PlanetFall2_HoopyCasino.oxz]] v2.5 - Adds HOopy casinos to the planet surface locations, complete with gaming opportunities. The [[HOopy_Casino|HOopy Casino OXP]] also needs to be installed.
* [[Media:PlanetFall2_Oo-Haul.oxz|PlanetFall2_Oo-Haul.oxz]] v2.1 - Adds an Oo-Haul distribution centre to the main planet, and a mission to escort a hauler from it out to either the witchpoint or constore. The [[Your_Ad_Here!|YAH/Your Ad Here!]] OXP and [[Oo-Haul]] need to be installed.

== License ==
*Author (PF v.2): [[User:Phkb|Phkb]]
*Author (PF v.1): [[User:Thargoid|Thargoid]]

This OXP is released under the Creative Commons Attribution - Non-Commercial - Share Alike 3.0 license with the following clauses:

* Whilst you are free (and encouraged) to re-use any of the scripting, models or texturing in this OXP, the usage must be distinct from that within this OXP. Unique identifiers such as (but not limited to) unique shipdata.plist entity keys, mission variables, script names (this.name), equipment identity strings (EQ_), description list arrays and entity roles must not be re-used without prior agreement. Basically if it's unique or would identify or overwrite anything in the original OXP, then you may not re-use it (for obvious compatibility reasons).
* rebundling of this OXP within another distribution is permitted as long as it is unchanged. The following derivates however are permitted and except from the above:
** the conversion of files between XML and openStep.
** the merging of files with other files of the same type from other OXPs.
* The license information (either as this file or merged into a larger one) must be included in the OXP.
* Even though it is not compulsory, if you are re-using any sizable or recognisable piece of this OXP, please let me know :)

---> (Details of images used) --->
<div class="mw-collapsible mw-collapsed" data-expandtext="Show gory details" data-collapsetext="Hide gory details" style="overflow:auto;">
'''Image files:''' 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_20850610.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21988050.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_23326348.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21988072.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_23326337.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21835246.htm Image by user6702303 on Freepik 
 
https://www.freepik.com/free-photo/blue-sky-with-scattered-white-clouds_12110221.htm Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22542965.htm Freepik 
https://www.freepik.com/free-photo/cloudy-sky-daylight-background_19380968.htm Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22543011.htm Freepik 
https://www.freepik.com/free-photo/blue-sky-with-cloud-closeup_6133056.htm Image by photogenia on Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22542943.htm Freepik 
https://www.freepik.com/free-vector/20-vehicles-outline-icon-presentation_38543743.htm Image by flatart on Freepik 
 
https://www.freepik.com/free-ai-image/subway-dark-atmosphere_76653967.htm Image by freepik 
https://www.freepik.com/free-ai-image/new-york-city-subway-train-motion_69844323.htm Image by freepik 
https://www.freepik.com/free-photo/motion-blur-automatic-train-moving-inside-tunnel-tokyo-japan_10824408.htm Image by tawatchai07 on Freepik 
 
</div>
Some images were generated by AI at https://www.freepik.com/pikaso/ai-image-generator 

'''Sound files:''' 
"e train 140kmh 04 190613_0029.wav" by klankbeeld -- https://freesound.org/s/476298/ -- License: Attribution 4.0 
"Arrival of a passenger electric train.1950km station_2(Eq,lmtr).wav" by newlocknew -- https://freesound.org/s/580464/ -- License: Attribution 4.0 

== Version History ==
2.32
* Fixed issue where a excessive number of Colony Domes were being spawned (and possibly Colony Cities as well).
* Citizens of a system can now use the transit system for free. (Requires Diplomacy OXP)
* Home System members with enough standing can now use the transit system for free. (Requires Home System OXP).

2.31
* Added GNN interface to some planetary surface locations.
* Fixed null reference error that could occur during transits.
* Added screenID's to all mission screens.
* Speed of the landing FX now scales with system performance.
* Switched to using logcontrol.plist for debug output.

2.30
* Changed manifest title from "PlanetFall" to "PlanetFall2".
* Changed Library Config aliases to "PlanetFall2".
* Changed category to "Systems".
* Fixed issue with adding OXP locations to custom systems, where some keys were being added to the list twice.

2.29
* Shuttles that choose to land on a planet will now do so at one of the landing sites.
* Shuttles will also launch from the landing sites.

2.28
* Fixed method of detecting when two landing sites are too close together.
* Changed calculation method for positioning landing sites to ensure good separation from others.

2.27
* Fixed issue where stored names were not being restored from missionVariables reliably.
* Fixed issue with naming system for Oo-Haul sites, which wasn't including "(Distribution Centre)" in the name.
* Fixed issue with naming HOopy Casino sites, which wasn't including "(HOopy Casino)" in the name.
* OXP planet locations defined via the ship role "planetFall2_???_externalOXP" are now attempted to be added to custom systems. Random factors and spawn conditions can then come in to play to limit the number of spawns.

<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">
2.26
* Darkened overlay images for better compatibility with Oolite 1.92.

2.25
* Moved more text into missiontext.plist.
* Fixed issue with ship transfer fee not being calculated correctly when being deducted from the players account.

2.24
* Added check for, and warning message of, PlanetLand OXP conflict.

2.23
* Fixed issue where shipyards were not viewable on stations that have overridden the "move shipyards to planet" option.

2.22
* Display a message when attempting to access shipyards on stations when they are located on planetary surfaces.
* Added option to disable the shallow approach angle requirement when landing on a surface location.
* Tweaked spawning logic so planetary locations can't be too close together, increasing the distance from the previous fix.

2.21
* Change to manifest file to match with split of resources pack into two.

2.20
* Added a function, $getSystemLocations, which returns an object containing the ship keys and place names of all planetary locations in a given system.

2.19
* Setting beacon range to zero will make all beacons visible all the time.
* Added ability to scale the maximum turbulence factor per planet.

2.18
* Added a "turbulence impact scale" option so the effect of turbulence can be scaled to taste.
* Allowed for blank entries in location overrides to switch to randomised location types and naming.
* Fixed issues when checking roles to determine the type of VFX to show for landing.
* Added ability to override the landing clouds, docks and overlays on a per-planet basis.
* Some code refactoring.

2.17
* Moved most text into missiontext.plist for easier localisation.
* Removed monkey patch on Marker Inquirer as no longer required.

2.16
* Tweak to prevent LMSS and Laser Arrangement interfaces disappearing on non-PlanetFall locations.

2.15
* Increased the number of shipdata entities to better handle high values for the number of planetary landing points.

2.14
* Added protection for instances where a planet or moon has no air color value set.
* Fixed issue where the reason for the denial of a landing request was not being transmitted to the player.

2.13
* Further fixes to linkage between landing sites and planets.

2.12
* Fixed incorrect property setting in shipdata.
* Changed allegiance setting for research complexes to be neutral.
* Fixed issue where landing sites could spawn too close together.

2.11
* Fixed issue where link between landing sites and planets could occasionally break due to rounding errors.

2.10
* Prevented things like "Immigration Control" from appearing in Anarchy systems.
* Prevented turbulence frame callback from being started twice.
* Fixed error: this.serviceLevelDecrease is not a function.
* Tweaks to hopefully permanently fix issue where turbulence effect keeps running after a witchspace jump or docking.

2.9
* Fixed JS error in transit process code.
* Fixed issue where Vimana-X HUD was not resetting correctly on launch after using transit system.

2.8
* Split off planet rotation slowing into separate OXP, and made optional for this OXP.

2.7
* Dying while turbulence is active will now stop the frame callback.
* Added tweak to planet rotation when approaching planet, slowing it down to make scale issues less obvious (can be configured with Library Config).
* Code refactoring.

2.6
* Small tweak to the market script.
* Small fix to the name generation process for Capital Cities.

2.5
* Refined some text in messages for better understanding and integration with the built in voice.
* Added a pre-spawn check for a condition script on custom (ie non-built-in) surface locations.
* Fixed issue that was preventing custom names from being applied to custom system setups.
* Added a PDF document outlining how to create custom systems, for non-coders.
* Updates for the PlanetFall Oo-haul mission pack.
* Added conflict with PlanetFallMarketSaver - this OXP shouldn't be necessary with PlanetFall2.
* Added conflict with PlanetFall Markets - this OXP shouldn't be necessary with PlanetFall2.
* Removed some unused settings in config.
* Split off graphical assets into separate OXP, to make updating the core code easier for everyone.
* Added a second train FX image, so that the second animation doesn't just look completely like the first.
* Tweaked train FX images to make them more centred.
* Added scan class to station entities.

2.4
* Adjusted calculations to make landing when pointing at the GCIP more consistent.

2.3
* Added a planet-side transit system, so you don't have to launch and re-dock to visit another landing site on the same planet.
* Transit costs are adjusted based on government types. Configurable via Library Config.
* Ship transfer costs are adjusted based on government types. Configurable via Library Config.
* Fixed shipyard transfer process to not run more than once per system.
* Added fragment and vertex shaders to ensure all break patterns appear clearly and without shadow.
* Removed yaw turbulence factor. Only pitch and roll turbulence will be now be set.
* Fixed issue that was preventing subSurface colonies and moonSurface domes from being spawned.
* Amount of reduction to service level is now configurable via Library Config.
* Added a function (PlanetFall2.playerShipIsLocal) that can be called to determine if the player is near their ship or not.
* Removed the Blackmonks and HoOpy Casino config options, and incorporated spawn chances in script_info object of shipdata and condition script.

2.2
* Fixed issue where, if "Additional Planets" doesn't create any planets, no landing sites are created on the main planet.
* Reapplied monkey match for Market Inquirer to address issue with beacons not showing when more than 100000m from the player when docked.
* Removed conflicts with SW Planetary Systems and Moons, although it is unlikely any created moons will get landing sites.

2.1
* Added methods to allow for a fully customised system to be defined (with multiple sites per planet/moon).
* Moved Feudal States override code into a separate OXP.
* Fixed missing semi-colon in shipdata.plist.
* Switched ground control interface point to be a normal ship object (rather than a visual effect) to gain better compatibility with OXP's like Telescope.
* Made the ground control interface points more visible.
* Reduced the number of monkey patches required.
* Made the maximum range at which the space compass will detect ground control interface points configurable via Library Config, and changed the default value to 200km.
* Added some conflict oxps ("Planetary Systems" and "Moons" by stranger).
* Improved compatibility with Market Inquirer.
* Tweaked spawning methods to better reflect the original PlanetFall results, where OXP station roles are not added unless override flag is set.
* Added a warning screen for players, informing them that ship maintenance services are only available on the planet.
* Added a chance of a misjump when executing a witchspace jump inside the atmosphere.
* Fixed issue where entering witchspace while the turbulence effect is still active would result in it staying active.
* Fixed bug that was setting service level to the minimum value when launching from a planetary location.
* Turbulence now doesn't end when speed is zero.
* Added a config item to manage how much the service level of the player ship is reduced.
* Added shipdata entries to allow for multiple military bases, leisure complexes, factories and dumps on the main planet in custom systems.
* Fixed issues where NaN, NaN, Nan is calculated for a vector.
* Log messages now controllable via a debug flag.
* Removed some unused code.

2.0
* Updated landing FX, with clouds and landing pads.
* Updated launching FX.
* Changed docking method to have a fixed location (rather than just descending towards the planet surface anywhere), which means you can now save your game at planetary locations.
* Access to equipment sales (F3 Equip Ship) configuration via Library Config.
* Updated market information to allow for 3 different methods to be applied to any of the locations. (Configurable via Library Config)
* Added a variety of arrival report screen backgrounds. (Can be turned off via Library Config)
* Added a turbulence effect when in the atmosphere of a planet. (Can be turned off via Library Config)
* Equipment item renamed to "Atmospheric Stabilisers", but is optional for planetary landings.
* Moved ships from shipyards on other stations to planetary locations. (Configurable via Library Config)
* Moved "Maintenance Overhaul" to only be available on the main planet. (Configurable via Library Config)
* Added script updates to Feudal Systems, Aquatics, Market Inquirer, Galactic Almanac and In-System cargo delivery to maintain compatibility.
* Additional compatibility settings updated via shipdata-overrides.plist.
</div>

== The Dark Side ==
=== Custom designing a system ===
You can now custom design a system:
:specifically naming landing sites (see inside Lave.oxp)
:adding tweaks for entering the atmosphere: storms, haze, colours, and [[OXP_howto_texture#Planet_textures|city night-lights]] (see inside Famous Planets v.3 & see inside Lave.oxp)
:tweaking landing: images and haze ((see inside DGill's newest Feudal Systems suite & Famous Planets v.3)
:tweaking the space port "experience": things to do (see inside DGill's newest Feudal Systems suite)

To tweak a system see the "Creating Custom Systems.pdf" & the "Developer's ReadMe" hidden inside the oxp and then also the example [https://app.box.com/s/5xbksy48qr9cp31z2wpef6wjla05s3ih/file/1505969925081 SuperSystem.oxp]
:There is more detail [https://bb.oolite.space/viewtopic.php?p=301011#p301011 here] (runs on for several pages) and [https://bb.oolite.space/viewtopic.php?p=301065#p301065 here]

=== Problems with the Oolite game engine ===
*Planets were never meant to be interacted with in Oolite - there's a lot of hand-waving going on with PF2 when it comes to landing on the surface. [https://bb.oolite.space/viewtopic.php?p=301396#p301396 Phkb (2025)]
*The Oolite game engine does support larger planets and stars - I put together an OXP a while ago which uses them - but not necessarily particularly well. (Editor: [[SOTL Altmap]]? [[SOTL Exploration]]?) 
:You would have noticeable "corners" on the planets at 'real-world' sizes, as a 20,000 triangle polygon gets too large. You can already see these if you go as low as you can on a planet and look at the horizon. Similarly, the way planet texturing works would need to be significantly changed to avoid pixels tens of kilometres wide. There are display issues with large stars at high distances. There's a bit of a hack in the display code to avoid the worst of it, but there can still be strange issues with which objects are displayed in front of which. (You would probably need a higher Open GL version to solve these, which may or may not be practical to hide behind a graphics setting toggle) [https://bb.oolite.space/viewtopic.php?p=263420#p263420 Cim (2018)]

== Links ==
*[https://bb.oolite.space/viewtopic.php?t=21606 BB thread] (2024)
*[[Planetfall OXP]] PF v.1 original wiki page

== Quick Facts ==
{{OXPLevel|0|2}}{{IconOXP|ooVersion="1.90"|oxpCPU="Average"|oxpMEM="Low"|oxpGPU="Average"|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
{{Infobox OXPb| title = PlanetFall2.oxz
|version = 2.32
|release = 2026-05-10
|license = CC BY-NC-SA 3.0
|features = Planetary landings
|category = Systems OXPs
|author = [[User:Thargoid|Thargoid]], [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?t=21606 Oolite BB]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-orange.png|right]]
By default, planetary landings are harder than they were in V1. However, if you don't land on or approach planets, gameplay is largely unaffected (or it can be).

File:PlanetFall2 2.32.oxz

2026-05-10T06:42:34Z

Phkb:

File:XenonUI.oxz

2026-05-10T06:42:20Z

Phkb: Phkb uploaded a new version of File:XenonUI.oxz

File:XenonReduxUI.oxz

2026-05-10T06:41:51Z

Phkb: Phkb uploaded a new version of File:XenonReduxUI.oxz

File:LoadoutByCategory.oxz

2026-05-10T06:41:23Z

Phkb: Phkb uploaded a new version of File:LoadoutByCategory.oxz

File:LoadoutByCategory 190.oxz

2026-05-10T06:41:04Z

Phkb: Phkb uploaded a new version of File:LoadoutByCategory 190.oxz

File:ShipRepurchase.oxz

2026-05-10T06:40:34Z

Phkb: Phkb uploaded a new version of File:ShipRepurchase.oxz

Version 0.2

File:Smugglers 2.11.oxz

2026-05-10T06:39:37Z

Phkb:

File:BlackMarket 1.6.oxz

2026-05-10T06:38:59Z

Phkb:

Library OXP

2026-05-08T08:20:37Z

Phkb: /* Quick Facts */

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

[[Image:IconLib.png|100px|right]]
[[Image:Library (Config for AddOns Settings List).png|320px|thumb|Config for AddOns (List of OXPs with settings)]]
[[Image:Library (BGS Config Flags).png|320px|thumb|Config for AddOns (example: BGS flags settings) '''Flags''' are On/Off options, Values give a numerical range. (Old Hyperspace is added by Tsoj's newest version of BGS)]]
[[Image:Library (BGS Config Values).png|320px|thumb|Config for AddOns (example: BGS values settings) '''Values''' ('''D''' is the default setting, '''R''' shows the range)]]
[[Image:Sv pad03.jpg|320px|thumb|right|PAD: GalCop (showing Galactic Navy integration)]]
[[Image:Lib_PAD01.png|320px|thumb|right|PAD: Persons (showing Vanilla game integration)]]
[[File:Sv pad08.jpg|320px|thumb|right|PAD: Player data]]
[[Image:Lib_Animator01.png|320px|thumb|right|Demos: Animator]]
[[Image:Lib_Starmap02.png|320px|thumb|right|Demos: Starmap]]

==Overview==
Reinventing the wheel is not everybody's taste, so here comes a collection of useful snippets and helpers.

Library OXP's main function 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.

*Adds '''Config for AddOns''' to the [[F4 page (ship and system interfaces)|F4 ship-station interface]] screen (allowing in-game tweaking of compatible OXPs)
*Adds a '''PAD''' to the [[F4 page (ship and system interfaces)|F4 ship-station interface]] screen (for personal details, recalling (GNN) news flashes, storing data, ''etc''.)
*Plays music during your game (which can be contextual, changing if inside the [[aegis]] or if attacked) - but needs a compatible music .oxp installed - see below for list

*''Can'' be used by mission OXPs to display instructions (see Starmap below)
*''Can'' be used to show an animated display and possibly even a [[Cutscene]] (see Animator below)
*''Can'' be used by other OXPs to display information on the PAD about Guild memberships, NPC's met, peculiarities of systems, ''etc''. It already does this for the [[Galactic Navy OXP]].
*''Can'' be used by OXP ship designers to help display ships, exhausts, materials ''etc''. (see MatFinder and devtools below).

=== Config for AddOns ===
'''Config for AddOns''' (Library Config) appears on your Docked F4 screen "AddOns" category.
:for tweaking OXPs while ''inside'' the game (and docked!) - ''here are some examples''
*[[BGS]]: (see the 3 screen shots on top right), where one select the effects one desires - station chatter, graphics for hyperspace jump ''etc''.).
*[[Email System OXP]] - listed as "GalCop Admin Services" - one can select categories of e-mails which one wishes not to be sent
*[[Risky Business]] - one can select either or both of the "Risky Business" or the "Risk Based Economy]] effects to alter the trading profits in one's game.
*[[Satellites]] - one can select the planets at which they appear, and the number appearing
*[[Station Dock Control]] - one can control many aspects of what information is presented about docking/docked ships
*[[Xenon UI]] - one can select the amber background alternative instead of the blue

=== PAD (Personal Assistance Device) ===
[[Lib PAD|PAD]] (Captain's Log category) - a Personal Assistance Device with details of your [[Galactic Navy OXP]] 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. Currently there 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. Currently only used for the vanilla game missions.
:: SYSTEMS: An empty category at the moment. Usable 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 currently 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 actually comprehensible! But the fabulous flood of detail for [[Telescope]]...

== Ancillary OXPs ==
Library OXP acts as an enabler for a huge range of other OXPs (see below). There are also some Demos (see below) showing how abilities of Library OXP can be instantiated in Oolite. 
These ''Ancillary OXPs'' instead tweak aspects of Library OXP itself.
*[https://app.box.com/s/271jbpimu2jbs6au913ujkq3y7gcgkr4 LibraryConfigOnF2.oxz] relocates the anti-immersive "Config for AddOns" from the in-game docked F4 screen to the Game Options F2 screen (by Phkb 2025)
*[https://bb.oolite.space/viewtopic.php?p=301851#p301851 PADCustomAvatars.oxp] allows the (relatively) easy addition of custom player portraits to the choice in Library's P.A.D. (by Phkb 2025)

==Features==
For Documentation just follow the links. There is more material tucked inside the Library OXZ - and some examples in the Demos
* ''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_BinSearch.js'' - Instantiated search tree.
* ''[[Lib_Config|Lib_Config.js]]'' - Configuration interface for AddOns.
* ''Lib_Crypt.js'' - De-/Encryption for strings.
* ''[[Lib_GUI|Lib_GUI.js]]'' - Unified GUI image, sound and music handling.
* ''Lib_Main.js'' - Generic functions for various tasks.
* ''[[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}}

=== More on the workings of Library.oxp ===
Making sense of Library.
::Click to the right if you want the gory details ----->
<div class="mw-collapsible mw-collapsed" data-expandtext="Show gory details" data-collapsetext="Hide gory details" style="overflow:auto;">
[[Cabal Common Library OXP]] - Library's precursor - had these scripts
* [[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
[[File:CCL Briefing01.jpg|300px|thumb|CCL Briefing]]
* [[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
[[File:CCL Keyboard01.jpg|300px|thumb|CCL Keyboard]]
* [[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 (=> Lib_Music)
* [[Cabal_Common_Library_Doc_Overlay|Cabal_Common_Overlay]], inflight overlays
[[File:Vector inflightoverlays.jpg|300px|thumb|CCL Overlay]]
* [[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

:1) In the CCL era, PAD was part of the [[Vector OXP]] which needed CCL to work.
:2) Cabal_Common_Overlay/Inflight overlays are presumably these:

Library has these:
:? Lib_2DCollision.js - Methods for checking if point is in bounding-box, on line or in poly.
:x Lib_Animator.js - Tool to create animations on mission screens (see Demos). - Animator Demo: Cutscenes?
:? Lib_BinSearch.js - Instantiated search tree.
:√ Lib_Config.js - Configuration interface for AddOns. (Widely used by many OXPs)
:? 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). Orchestral Demo & Contextual Jukebox.
:√ Lib_PAD.js - Unified logbook, mission-log, diary and interface. Added in v1.7
:x Lib_Starmap.js - In-System-Maps in 3D (docked and inflight) (see Demos). Added in v1.7 - Starmap Demo

and there are more:
:x Lib_Cubecode.js (the Vector display above?)
:x Lib_EntityStrength.js (seems to check for weapons, shield strength & recharge rates, NPCs in system)
:x lib_fx.js
:x Lib_MissionCoord.js
:- Lib_PAD_Events.js (unsure about this one - is it what adds the GNN newsflashes into the PAD? Or new data cards such as NPCs or systems?)
:? lib_shield.js
:? lib_starmap12.js
:? lib_test.js (Detect changes in custom role entity?)

Decoder:
:√ - used by our community in other OXPs
:x - not used
:? - not even understood!

=== Comments ===
Phkb who is the only one to have updated parts of Library.oxp in the past 7 years wrote this:
I've really only used Lib Config, Lib GUI and Lib PAD. Lib PAD events is just a feeder into Lib PAD - it takes some standard game events and records them in the PAD, similar to what I did with the Email System, where I added a whole bunch of automatic emails when the player does certain things. I think I understand Lib GUI pretty well, but it's probably not going to be used very much outside of Xenon UI and BGS.

I have a suspicion Lib Test was in response to my [[Ship Configuration OXP]] - my logic for that OXP was that, if I'm penalising the player by making their ship slower or harder to steer based on the equipment and weight, then it should be applied to *all* NPC ships as well, otherwise the balance of the game would be skewed. But by applying the changes to things like mission ships, it moves those ships away from a particular performance rating a mission author was aiming for. I might be overthinking it, and it's too late to ask now.

One of the issues I have with the code in Library suite is that it's so *dense*, in that everything is reduced to the smallest possible space. A lot of the code uses single letter variable names, which makes reading it a real chore. Whenever I have to dive into it, I spend a lot of time asking questions like "So, what's 'c' in this context? What's 's'? And 't'? And 'z'?", and having to follow the flow of the code back to the origin to work it out for each one. The code is super clever, and it does some pretty amazing things, but it's written in a way that makes maintaining it, for anyone other that the original author, super hard. And the little documentation left behind is not always very helpful, even for a programmer. Several times I've read the documentation and I'm still left with questions about the implementation, which means the only way to actually work it out is trial and error - feeding data in to see what you get out. And that's for the easy stuff, like PAD. The animator, starmap, those things are several levels up from what we're doing with PAD. [https://bb.oolite.space/viewtopic.php?p=301809#p301809 Phkb, 2025]

</div>

== Integration ==
=== Config for AddOns ===
Over 60 OXP's use Library's "Config for AddOns" option on the F4 screen to allow configuration. Click [[File:IconLib.png|30px]] for a partial list.

=== Music ===
Library can introduce music (as well as sound effects). For a full list of all such OXP's see [[:Category:Sound Sets OXPs]] 

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 classical music .oxp (2016: 22Mb)
*[[Contextual Jukebox OXP]] by Arquebus of [https://bb.oolite.space/viewtopic.php?f=2&t=21111 YouTube fame] (2021: 115Mb)
*DIY kit: [https://bb.oolite.space/viewtopic.php?f=4&t=21127 Dangerous Background Music OXP]: [[User:Tsoj|Tsoj]] (2021)

Version of Library.oxp incorporating Tsoj's changes for music
*[https://app.box.com/s/ra79jgfe154y9gvsviyl7kow6eng7yli Download]
*[https://bb.oolite.space/viewtopic.php?p=280702#p280702 Discussion] (2021)

=== OXP's & Vanilla game integration for P.A.D. ===
*[[Vanilla game]] missions have been integrated into Library.oxp
*[[Galactic Navy OXP]] has been integrated into Library.oxp
*[[GNN]] has been integrated into Library.oxp (the most recent new item is displayed on the PAD)
*[[User:Phkb|Phkb]] has updated the [[Cataclysm OXP]] mission and included Library integration - ''this'' is where to look to see how to do it!

=== Demos ===
Designed to show how to integrate other OXP's with Library; Install like any other [[OXP]].
* [https://app.box.com/s/59vqswqh0wxiccerk7wgxerl0m0wmx20 Animator Demo] (zip, 2.8 MiB): a helper for animations on mission screens
* [https://app.box.com/s/xd9hnscxrjlb0p5suz8t00e7m5qo743d Lib Music Orchestral Demo]: [[User:Svengali|Svengali]]'s original music .oxp (2016: 22Mb)
* [https://app.box.com/s/0enjeiuyzjkyg36yxc5j04sdjhx9s7aa Starmap Demo] (oxz, 2.4 KB) - see [https://bb.oolite.space/viewtopic.php?p=264969#p264969 explanation]: Lib_Starmap introduces In-System-Maps in 3D (or 2.5D *sigh*). These maps can be shown on missionScreens and inflight. On missionScreens they can be animated (''eg'' through Lib_Animator). Inflight users can control them via the Advanced Space Compass. Usage for OXP's is easy.

''Apart from the demos, nothing yet uses Library's Animator & Star Map functions.''

=== Tools ===
There are two tools tucked away in diverse locations:

* 1) [https://app.box.com/s/pwttg9nrqvvpqzya0wcpqpc4ly9bov1r Lib_MatFinder 1.1] (oxz, 39.7 KB) - A developer-tool to work out materials entries.
The whole thing started when I looked in some older OXPs. Pretty often they don't have later implemented stuff (materials, custom views), but creating these entries eats a lot of time and needs a lot of testruns/finetuning. It was meant for my personal use only to speed up the updating orgy I've had in mind, but in the end it got better than expected, so I released it as helper. [https://bb.oolite.space/viewtopic.php?p=154692#p154692 Svengali 2011]
:See [[MatFinder]] for more detail (culled from BB and put in order)
:See [https://bb.oolite.space/viewtopic.php?p=265566#p265566 here] for original BB description. (2 pages, 2018).

::Once you load the .oxp, see your F4 screen (if you have Library.oxp running too) under "Developer" to access this tool.
[[File:Lib MatFinder Pos01.png|150px]]
[[File:Lib MatFinder Pos02.png|150px]]
[[File:Lib MatFinder.png|150px]]

::On your F4 screen under "Lib_MatEditor":
[[File:Lib_MatEditor_%281%29.png|150px]]
[[File:Lib_MatEditor_%282%29.png|150px]]

* 2) [[DevTools]] (oxz) - Tests for all kind of things. Useless for gaming but still funny.

::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 under "Lib_MatEditor":
[[File:Lib DevTools 1.png|150px]]
[[File:Lib DevTools 2.png|150px]]
----

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

== Requirements ==
* Latest version needs Oolite v1.88.

== Download ==
Install like any other [[OXP]]. Library is on the in-game [[Expansions Manager]]. Or, if you prefer, [[media:Library_1.9.1.oxz|Library_1.9.1.oxz]]

=== Previous Verions ===
* [https://app.box.com/s/gqfc5nxse0k9yipm93wrjra7nqjzy89y Library 1.7.1] (oxz, 4.9 MiB)

== Tweaks ==
*[https://bb.oolite.space/viewtopic.php?p=252499#p252499 To add a radio channel]

*Possible Error
:[https://bb.oolite.space/viewtopic.php?p=270334#p270334 Error followed by Phkb's fix] (2020)
Replace Lib_GUI code, line 311 with
ex = (this.$noEx.indexOf(id)===-1 && this.$IDsExt[id]?this.$IDsExt[id]:null),

== Musings ==
[[User:Cholmondely|Cholmondely]] writes: '''this OXP is a tragedy'''. It is ''so'' powerful and can add ''so'' much to the game and nobody did anything with it. [[User:Svengali|Svengali]] died before he could update his old broken missions ([[Vector]] & [[Localhero OXP]]) to run on the newer versions of Oolite and to use it (''all'' the necessary elements are already built in for them). And nobody else has used it either - apart from the "Config for AddOns" element. In 2022 one music .oxp appeared which uses it (as does another DIY oxp), but the other elements languish in the dust.

There are also a number of abilities lurking in the precursor CCL which were probably inherited by Library.oxp:
:[[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_SpecialMarkets|Cabal_Common_SpecialMarkets]], trading special goods
:[[Cabal_Common_Library_Doc_OXPStrength|Cabal_Common_Strength]], environment control
:''somewhere in all this is a ''random integer function'' which is used by [[Factions OXP]] and is presumably still in Library somewhere... (like https://wiki.alioth.net/index.php/Cabal_Common_Library_Doc_Functions#rand.28.29)

The one change which ''would'' be very useful would be the ability to recall more than just the ''one'' most recent GNN news broadcast in the PAD.

== Links ==
*[https://bb.oolite.space/viewtopic.php?t=21449 Library OXP logos and images] (2023-34)

==Quick Facts==
{{OXPLevel|0}}{{IconOXP
|ooVersion = "1.88"
|oxpCPU = "Medium"
|oxpMEM = "Average"
|oxpGPU = "Average"
|oxpIsParent = true
|oxpIsChild =
|oxpIsAPI = true
|oxpIsDocumented = true
|oxpIsConfigurable = true
}}
{{Infobox OXPb| title = Library
|image = [[Image:IconLib.png|100px]]
|version = 1.9.1
|release = 2026-05-08
|license = CC-by-nc-sa-4.0
|features = Helper for OXPs
|category = Misc OXPs
|author = BlackWolf & Svengali
|download = [[#Download|See Download]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=18248 BB-Link]
}}

[[Category:Oolite utilities]]

Library OXP

2026-05-08T08:20:09Z

Phkb: /* Download */

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

[[Image:IconLib.png|100px|right]]
[[Image:Library (Config for AddOns Settings List).png|320px|thumb|Config for AddOns (List of OXPs with settings)]]
[[Image:Library (BGS Config Flags).png|320px|thumb|Config for AddOns (example: BGS flags settings) '''Flags''' are On/Off options, Values give a numerical range. (Old Hyperspace is added by Tsoj's newest version of BGS)]]
[[Image:Library (BGS Config Values).png|320px|thumb|Config for AddOns (example: BGS values settings) '''Values''' ('''D''' is the default setting, '''R''' shows the range)]]
[[Image:Sv pad03.jpg|320px|thumb|right|PAD: GalCop (showing Galactic Navy integration)]]
[[Image:Lib_PAD01.png|320px|thumb|right|PAD: Persons (showing Vanilla game integration)]]
[[File:Sv pad08.jpg|320px|thumb|right|PAD: Player data]]
[[Image:Lib_Animator01.png|320px|thumb|right|Demos: Animator]]
[[Image:Lib_Starmap02.png|320px|thumb|right|Demos: Starmap]]

==Overview==
Reinventing the wheel is not everybody's taste, so here comes a collection of useful snippets and helpers.

Library OXP's main function 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.

*Adds '''Config for AddOns''' to the [[F4 page (ship and system interfaces)|F4 ship-station interface]] screen (allowing in-game tweaking of compatible OXPs)
*Adds a '''PAD''' to the [[F4 page (ship and system interfaces)|F4 ship-station interface]] screen (for personal details, recalling (GNN) news flashes, storing data, ''etc''.)
*Plays music during your game (which can be contextual, changing if inside the [[aegis]] or if attacked) - but needs a compatible music .oxp installed - see below for list

*''Can'' be used by mission OXPs to display instructions (see Starmap below)
*''Can'' be used to show an animated display and possibly even a [[Cutscene]] (see Animator below)
*''Can'' be used by other OXPs to display information on the PAD about Guild memberships, NPC's met, peculiarities of systems, ''etc''. It already does this for the [[Galactic Navy OXP]].
*''Can'' be used by OXP ship designers to help display ships, exhausts, materials ''etc''. (see MatFinder and devtools below).

=== Config for AddOns ===
'''Config for AddOns''' (Library Config) appears on your Docked F4 screen "AddOns" category.
:for tweaking OXPs while ''inside'' the game (and docked!) - ''here are some examples''
*[[BGS]]: (see the 3 screen shots on top right), where one select the effects one desires - station chatter, graphics for hyperspace jump ''etc''.).
*[[Email System OXP]] - listed as "GalCop Admin Services" - one can select categories of e-mails which one wishes not to be sent
*[[Risky Business]] - one can select either or both of the "Risky Business" or the "Risk Based Economy]] effects to alter the trading profits in one's game.
*[[Satellites]] - one can select the planets at which they appear, and the number appearing
*[[Station Dock Control]] - one can control many aspects of what information is presented about docking/docked ships
*[[Xenon UI]] - one can select the amber background alternative instead of the blue

=== PAD (Personal Assistance Device) ===
[[Lib PAD|PAD]] (Captain's Log category) - a Personal Assistance Device with details of your [[Galactic Navy OXP]] 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. Currently there 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. Currently only used for the vanilla game missions.
:: SYSTEMS: An empty category at the moment. Usable 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 currently 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 actually comprehensible! But the fabulous flood of detail for [[Telescope]]...

== Ancillary OXPs ==
Library OXP acts as an enabler for a huge range of other OXPs (see below). There are also some Demos (see below) showing how abilities of Library OXP can be instantiated in Oolite. 
These ''Ancillary OXPs'' instead tweak aspects of Library OXP itself.
*[https://app.box.com/s/271jbpimu2jbs6au913ujkq3y7gcgkr4 LibraryConfigOnF2.oxz] relocates the anti-immersive "Config for AddOns" from the in-game docked F4 screen to the Game Options F2 screen (by Phkb 2025)
*[https://bb.oolite.space/viewtopic.php?p=301851#p301851 PADCustomAvatars.oxp] allows the (relatively) easy addition of custom player portraits to the choice in Library's P.A.D. (by Phkb 2025)

==Features==
For Documentation just follow the links. There is more material tucked inside the Library OXZ - and some examples in the Demos
* ''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_BinSearch.js'' - Instantiated search tree.
* ''[[Lib_Config|Lib_Config.js]]'' - Configuration interface for AddOns.
* ''Lib_Crypt.js'' - De-/Encryption for strings.
* ''[[Lib_GUI|Lib_GUI.js]]'' - Unified GUI image, sound and music handling.
* ''Lib_Main.js'' - Generic functions for various tasks.
* ''[[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}}

=== More on the workings of Library.oxp ===
Making sense of Library.
::Click to the right if you want the gory details ----->
<div class="mw-collapsible mw-collapsed" data-expandtext="Show gory details" data-collapsetext="Hide gory details" style="overflow:auto;">
[[Cabal Common Library OXP]] - Library's precursor - had these scripts
* [[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
[[File:CCL Briefing01.jpg|300px|thumb|CCL Briefing]]
* [[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
[[File:CCL Keyboard01.jpg|300px|thumb|CCL Keyboard]]
* [[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 (=> Lib_Music)
* [[Cabal_Common_Library_Doc_Overlay|Cabal_Common_Overlay]], inflight overlays
[[File:Vector inflightoverlays.jpg|300px|thumb|CCL Overlay]]
* [[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

:1) In the CCL era, PAD was part of the [[Vector OXP]] which needed CCL to work.
:2) Cabal_Common_Overlay/Inflight overlays are presumably these:

Library has these:
:? Lib_2DCollision.js - Methods for checking if point is in bounding-box, on line or in poly.
:x Lib_Animator.js - Tool to create animations on mission screens (see Demos). - Animator Demo: Cutscenes?
:? Lib_BinSearch.js - Instantiated search tree.
:√ Lib_Config.js - Configuration interface for AddOns. (Widely used by many OXPs)
:? 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). Orchestral Demo & Contextual Jukebox.
:√ Lib_PAD.js - Unified logbook, mission-log, diary and interface. Added in v1.7
:x Lib_Starmap.js - In-System-Maps in 3D (docked and inflight) (see Demos). Added in v1.7 - Starmap Demo

and there are more:
:x Lib_Cubecode.js (the Vector display above?)
:x Lib_EntityStrength.js (seems to check for weapons, shield strength & recharge rates, NPCs in system)
:x lib_fx.js
:x Lib_MissionCoord.js
:- Lib_PAD_Events.js (unsure about this one - is it what adds the GNN newsflashes into the PAD? Or new data cards such as NPCs or systems?)
:? lib_shield.js
:? lib_starmap12.js
:? lib_test.js (Detect changes in custom role entity?)

Decoder:
:√ - used by our community in other OXPs
:x - not used
:? - not even understood!

=== Comments ===
Phkb who is the only one to have updated parts of Library.oxp in the past 7 years wrote this:
I've really only used Lib Config, Lib GUI and Lib PAD. Lib PAD events is just a feeder into Lib PAD - it takes some standard game events and records them in the PAD, similar to what I did with the Email System, where I added a whole bunch of automatic emails when the player does certain things. I think I understand Lib GUI pretty well, but it's probably not going to be used very much outside of Xenon UI and BGS.

I have a suspicion Lib Test was in response to my [[Ship Configuration OXP]] - my logic for that OXP was that, if I'm penalising the player by making their ship slower or harder to steer based on the equipment and weight, then it should be applied to *all* NPC ships as well, otherwise the balance of the game would be skewed. But by applying the changes to things like mission ships, it moves those ships away from a particular performance rating a mission author was aiming for. I might be overthinking it, and it's too late to ask now.

One of the issues I have with the code in Library suite is that it's so *dense*, in that everything is reduced to the smallest possible space. A lot of the code uses single letter variable names, which makes reading it a real chore. Whenever I have to dive into it, I spend a lot of time asking questions like "So, what's 'c' in this context? What's 's'? And 't'? And 'z'?", and having to follow the flow of the code back to the origin to work it out for each one. The code is super clever, and it does some pretty amazing things, but it's written in a way that makes maintaining it, for anyone other that the original author, super hard. And the little documentation left behind is not always very helpful, even for a programmer. Several times I've read the documentation and I'm still left with questions about the implementation, which means the only way to actually work it out is trial and error - feeding data in to see what you get out. And that's for the easy stuff, like PAD. The animator, starmap, those things are several levels up from what we're doing with PAD. [https://bb.oolite.space/viewtopic.php?p=301809#p301809 Phkb, 2025]

</div>

== Integration ==
=== Config for AddOns ===
Over 60 OXP's use Library's "Config for AddOns" option on the F4 screen to allow configuration. Click [[File:IconLib.png|30px]] for a partial list.

=== Music ===
Library can introduce music (as well as sound effects). For a full list of all such OXP's see [[:Category:Sound Sets OXPs]] 

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 classical music .oxp (2016: 22Mb)
*[[Contextual Jukebox OXP]] by Arquebus of [https://bb.oolite.space/viewtopic.php?f=2&t=21111 YouTube fame] (2021: 115Mb)
*DIY kit: [https://bb.oolite.space/viewtopic.php?f=4&t=21127 Dangerous Background Music OXP]: [[User:Tsoj|Tsoj]] (2021)

Version of Library.oxp incorporating Tsoj's changes for music
*[https://app.box.com/s/ra79jgfe154y9gvsviyl7kow6eng7yli Download]
*[https://bb.oolite.space/viewtopic.php?p=280702#p280702 Discussion] (2021)

=== OXP's & Vanilla game integration for P.A.D. ===
*[[Vanilla game]] missions have been integrated into Library.oxp
*[[Galactic Navy OXP]] has been integrated into Library.oxp
*[[GNN]] has been integrated into Library.oxp (the most recent new item is displayed on the PAD)
*[[User:Phkb|Phkb]] has updated the [[Cataclysm OXP]] mission and included Library integration - ''this'' is where to look to see how to do it!

=== Demos ===
Designed to show how to integrate other OXP's with Library; Install like any other [[OXP]].
* [https://app.box.com/s/59vqswqh0wxiccerk7wgxerl0m0wmx20 Animator Demo] (zip, 2.8 MiB): a helper for animations on mission screens
* [https://app.box.com/s/xd9hnscxrjlb0p5suz8t00e7m5qo743d Lib Music Orchestral Demo]: [[User:Svengali|Svengali]]'s original music .oxp (2016: 22Mb)
* [https://app.box.com/s/0enjeiuyzjkyg36yxc5j04sdjhx9s7aa Starmap Demo] (oxz, 2.4 KB) - see [https://bb.oolite.space/viewtopic.php?p=264969#p264969 explanation]: Lib_Starmap introduces In-System-Maps in 3D (or 2.5D *sigh*). These maps can be shown on missionScreens and inflight. On missionScreens they can be animated (''eg'' through Lib_Animator). Inflight users can control them via the Advanced Space Compass. Usage for OXP's is easy.

''Apart from the demos, nothing yet uses Library's Animator & Star Map functions.''

=== Tools ===
There are two tools tucked away in diverse locations:

* 1) [https://app.box.com/s/pwttg9nrqvvpqzya0wcpqpc4ly9bov1r Lib_MatFinder 1.1] (oxz, 39.7 KB) - A developer-tool to work out materials entries.
The whole thing started when I looked in some older OXPs. Pretty often they don't have later implemented stuff (materials, custom views), but creating these entries eats a lot of time and needs a lot of testruns/finetuning. It was meant for my personal use only to speed up the updating orgy I've had in mind, but in the end it got better than expected, so I released it as helper. [https://bb.oolite.space/viewtopic.php?p=154692#p154692 Svengali 2011]
:See [[MatFinder]] for more detail (culled from BB and put in order)
:See [https://bb.oolite.space/viewtopic.php?p=265566#p265566 here] for original BB description. (2 pages, 2018).

::Once you load the .oxp, see your F4 screen (if you have Library.oxp running too) under "Developer" to access this tool.
[[File:Lib MatFinder Pos01.png|150px]]
[[File:Lib MatFinder Pos02.png|150px]]
[[File:Lib MatFinder.png|150px]]

::On your F4 screen under "Lib_MatEditor":
[[File:Lib_MatEditor_%281%29.png|150px]]
[[File:Lib_MatEditor_%282%29.png|150px]]

* 2) [[DevTools]] (oxz) - Tests for all kind of things. Useless for gaming but still funny.

::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 under "Lib_MatEditor":
[[File:Lib DevTools 1.png|150px]]
[[File:Lib DevTools 2.png|150px]]
----

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

== Requirements ==
* Latest version needs Oolite v1.88.

== Download ==
Install like any other [[OXP]]. Library is on the in-game [[Expansions Manager]]. Or, if you prefer, [[media:Library_1.9.1.oxz|Library_1.9.1.oxz]]

=== Previous Verions ===
* [https://app.box.com/s/gqfc5nxse0k9yipm93wrjra7nqjzy89y Library 1.7.1] (oxz, 4.9 MiB)

== Tweaks ==
*[https://bb.oolite.space/viewtopic.php?p=252499#p252499 To add a radio channel]

*Possible Error
:[https://bb.oolite.space/viewtopic.php?p=270334#p270334 Error followed by Phkb's fix] (2020)
Replace Lib_GUI code, line 311 with
ex = (this.$noEx.indexOf(id)===-1 && this.$IDsExt[id]?this.$IDsExt[id]:null),

== Musings ==
[[User:Cholmondely|Cholmondely]] writes: '''this OXP is a tragedy'''. It is ''so'' powerful and can add ''so'' much to the game and nobody did anything with it. [[User:Svengali|Svengali]] died before he could update his old broken missions ([[Vector]] & [[Localhero OXP]]) to run on the newer versions of Oolite and to use it (''all'' the necessary elements are already built in for them). And nobody else has used it either - apart from the "Config for AddOns" element. In 2022 one music .oxp appeared which uses it (as does another DIY oxp), but the other elements languish in the dust.

There are also a number of abilities lurking in the precursor CCL which were probably inherited by Library.oxp:
:[[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_SpecialMarkets|Cabal_Common_SpecialMarkets]], trading special goods
:[[Cabal_Common_Library_Doc_OXPStrength|Cabal_Common_Strength]], environment control
:''somewhere in all this is a ''random integer function'' which is used by [[Factions OXP]] and is presumably still in Library somewhere... (like https://wiki.alioth.net/index.php/Cabal_Common_Library_Doc_Functions#rand.28.29)

The one change which ''would'' be very useful would be the ability to recall more than just the ''one'' most recent GNN news broadcast in the PAD.

== Links ==
*[https://bb.oolite.space/viewtopic.php?t=21449 Library OXP logos and images] (2023-34)

==Quick Facts==
{{OXPLevel|0}}{{IconOXP
|ooVersion = "1.88"
|oxpCPU = "Medium"
|oxpMEM = "Average"
|oxpGPU = "Average"
|oxpIsParent = true
|oxpIsChild =
|oxpIsAPI = true
|oxpIsDocumented = true
|oxpIsConfigurable = true
}}
{{Infobox OXPb| title = Library
|image = [[Image:IconLib.png|100px]]
|version = 1.9
|release = 2026-04-20
|license = CC-by-nc-sa-4.0
|features = Helper for OXPs
|category = Misc OXPs
|author = BlackWolf & Svengali
|download = [[#Download|See Download]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=18248 BB-Link]
}}

[[Category:Oolite utilities]]

File:Library 1.9.1.oxz

2026-05-08T07:16:18Z

Phkb:

Planetfall2 OXP

2026-05-07T06:40:00Z

Phkb: /* Version History */

[[Image:IconPF2.png|100px|right]]
[[File:PlanetFall2 city 7.png|300px|thumb|right|Landing at a city]]
[[File:PlanetFall2 moon 5.png|300px|thumb|right|Landing on a moon]]
== Overview ==
{{Infobox EquipStats Oolite| title = PlanetFall2 OXP
|image =
|equipName = Atmospheric Stabilisers
|equipCost = 5,000₢
|equipTL = 9
}}
An OXP which allows the Commander to land at specific locations on planets and moons (but not suns, even at night). Each main planet has up to 5 designated landing sites, while additional planets can have 3, and each moon can have 2 (configurable via [[Library OXP|Library Config]]). Pick your landing site and point your ship at the flashing marker near the surface that indicates the Ground Control Interface Point for the landing zone. Ensure your flight path is not too steep, otherwise you may sustain damage when the automated landing protocol engages.

Be careful of turbulence as you enter the atmosphere. To assist with atmospheric turbulence, the "Atmospheric Stabilisers" can be purchased at any TL9+ system for 5000cr. When equipped, this will reduce the impact of turbulence on your ship. Speed will have an impact on how much your ship is effected by turbulence. Slowing down will decrease the effect.

Your approach will trigger an automatic landing request. You should receive a response after a few seconds, indicating you are either cleared for landing or not. If you have clearance, continue towards the Ground Control Interface Point at less than 100 m/s until the automated system engages, captures your ship and lowers you to a landing pad.

Planetary take-off is via a launch booster, with control being returned to the Commander once orbital insertion is achieved.

=== A suite of OXPs ===
This OXP is currently a suite of 3 OXPs with another 2 optional OXPs:
*'''PlanetFall2''' (the coding)
*'''PlanetFall Resources A''' } individual planetary images part 1
*'''PlanetFall Resources B''' } individual planetary images part 2

*Optional: '''Feudal PlanetFall2''' (linking PlanetFall2 with [[Feudal States]] which is currently the only OXP which does much on the planet surface).
:<s>At time of writing PlanetFall2 is only compatible with Feudal States v.1 (and the ''alpha'' Feudal States v.2 is only compatible with PlanetFall v.1)!</s> It should now be compatible with both versions of Feudal States.
*Optional: [[Planet Rotation Cosmetics OXP]] slows down the planet's rotation as you approach it and are captured by the planet's gravity.

[[File:Planetfall2 Transit system.png|right|300px]]

=== Gaming changes from Thargoid's PlanetFall v1 (2008-13) ===
*You can now land on a planet without purchasing "planetary landing capabilities"/"atmospheric stabilisers" - but it is rather more dangerous
::If you have already bought "planetary landing capabilities", PF2 will convert them to "atmospheric stabilisers"
*There are now specific landing sites on the planet
*Commodity Markets are now included (''ie'' PlanetFall Markets OXP is redundant).
*When landed you can transit from one landing site to another (and pay good money to transit your ship, too!).
*[[Maintenance]] overhauls are now performed on the planet surface rather than in the orbital station (they will tell you this on the station!)
*There are other changes to be discovered!

== Requirements ==
*Oolite v.1.90 or better
*[[GNN]]
*[[Library OXP]]
*[[Market Script Interface]]
*[[External Docking System]]

While it isn’t a requirement, the [[Planet Rotation Cosmetics OXP]] is a highly recommended addition for PlanetFall 2.

== Options ==
There are a '''lot''' of options available to help configure the system the way you want it. The list is long, so if you want to see everything, ''click'' the link on the right.
<div class="mw-collapsible mw-collapsed" data-expandtext="Show me everything!" data-collapsetext="Turn it off! Turn it off!" style="overflow:auto;">
Library Config has the following sections for PlanetFall2:
* General settings
* Main planet settings
** F3/F8 access
** Spawn chances
* Extra Planet settings
** F3/F8 access
** Spawn chances
* Moon settings
** F3/F8 access
** Spawn chances
* Spawn chances: TL factors
* Transit costs
* Ship transfer costs

=== General settings ===
'''Flags'''
* '''Move shipyards to planet:''' Controls whether shipyards are moved to planet-side locations.
* '''Move maintenance to planet:''' Controls whether the "Maintenance Overhaul" item is moved to only be offered on planet-side locations.
* '''Atmosphere turbulence:''' Controls whether the turbulence effect, when entering the atmosphere of a planet, is active or not.
* '''Shallow approach:''' Controls whether a shallow approach angle is required when landing on a surface location.
* '''Use landing images:''' Controls whether the images displayed after landing at a planetary site are displayed.
* '''Use Almanac names:''' Controls whether the names of planetary locations are given names based on the methodology from the Galactic Almanac.
* '''Allow planetary transit:''' Controls whether it is possible to fast travel to other planetary sites after landing.

'''Values'''
* '''Main planet max:''' Maximum number of locations that could be spawned on the main planet.
* '''Extra planet max:''' Maximum number of locations that could be spawned on a secondary planet with an atmosphere.
* '''Moon max:''' Maximum number of locations that could be spawned on a moon with no atmosphere.
* '''Atmosphere max altitude:''' Maximum height (in km) of the atmosphere of a planet.
* '''Beacon range:''' Max distance (in km) that planetary beacons become visible to the player.
* '''Service Level dec:''' Amount that service level will be reduced by when launching from a planet.
* '''Transfer Time:''' Amount of time (in hours) that will pass when transferring player ship to the current location.
* '''Train speed:''' Base average speed of trains (in kph), which is scaled up or down based on the TL of the system.
* '''Turbulence impact scale:''' Scales the impact of turbulence, where 1.0 means no change to the default, 0.5 halves the impact, and 0.0 means no impact (same as turning turbulence off).

=== Main planet settings ===
==== F3/F8 Access ====
'''Flags'''
* '''Capital cities:''' Whether capital cities will have access to the F3 Equip Ship screen.
* '''Military bases:''' Whether military bases will have access to the F3 Equip Ship screen.
* '''Leisure complexes:''' Whether leisure complexes will have access to the F3 Equip Ship screen.
* '''Factories:''' Whether factories will have access to the F3 Equip Ship screen.
* '''Rubbish dumps:''' Whether rubbish dumps will have access to the F3 Equip Ship screen.

'''Values'''
* '''Capital cities:''' What type of market will be available at capital cities.
* '''Military bases:''' What type of market will be available at military bases.
* '''Leisure complexes:''' What type of market will be available at military bases.
* '''Factories:''' What type of market will be available at factories.
* '''Rubbish dumps:''' What type of market will be available at rubbish dumps.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51. (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn city:''' Chance of spawning a capital city.
* '''Spawn military base:''' Chance of spawning a military base.
* '''Spawn leisure complex:''' Chance of spawning a leisure complex.
* '''Spawn factory:''' Chance of spawning a factory.
* '''Spawn rubbish dump:''' Chance of spawning a rubbish dump.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Extra planet Settings ===
==== F3/F8 Access ====
'''Flags'''
* '''Colony cities:''' Whether colony cities will have access to the F3 Equip Ship screen.
* '''Military bases:''' Whether military bases will have access to the F3 Equip Ship screen.
* '''Leisure complexes:''' Whether leisure complexes will have access to the F3 Equip Ship screen.
* '''Factories:''' Whether factories will have access to the F3 Equip Ship screen.
* '''Rubbish dumps:''' Whether rubbish dumps will have access to the F3 Equip Ship screen.

'''Values'''
* '''Colony cities:''' What type of market will be available at colony cities.
* '''Military bases:''' What type of market will be available at military bases.
* '''Leisure complexes:''' What type of market will be available at leisure complexes.
* '''Factories:''' What type of market will be available at factories.
* '''Rubbish dumps:''' What type of market will be available at rubbish dumps.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51 (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn colony city:''' Chance of spawning a colony city.
* '''Spawn military base:''' Chance of spawning a military base.
* '''Spawn leisure complex:''' Chance of spawning a leisure complex.
* '''Spawn factory:''' Chance of spawning a factory.
* '''Spawn rubbish dump:''' Chance of spawning a rubbish dump.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Moons ===
==== F3/F8 Access ====
'''Flags'''
* '''Colony domes:''' Whether colony domes will have access to the F3 Equip Ship screen.
* '''Mines:''' Whether mines will have access to the F3 Equip Ship screen.
* '''Prisons:''' Whether prisons will have access to the F3 Equip Ship screen.
* '''Leisure domes:''' Whether leisure domes will have access to the F3 Equip Ship screen.
* '''Robot factories:''' Whether robot factories will have access to the F3 Equip Ship screen.
* '''Research complexes:''' Whether research complexes will have access to the F3 Equip Ship screen.
* '''Wastelands:''' Whether wastelands will have access to the F3 Equip Ship screen.

'''Values'''
* '''Colony domes:''' What type of market will be available at colony domes.
* '''Mines:''' What type of market will be available at mines.
* '''Prison:''' What type of market will be available at prisons.
* '''Leisure domes:''' What type of market will be available at leisure domes.
* '''Robot factories:''' What type of market will be available at robot factories.
* '''Research complexes:''' What type of market will be available at research complexes.
* '''Wastelands:''' What type of market will be available at wastelands.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51 (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn colony dome:''' Chance of spawning a colony dome.
* '''Spawn mine:''' Chance of spawning a mine.
* '''Spawn prison:''' Chance of spawning a prison.
* '''Spawn leisure dome:''' Chance of spawning a leisure dome.
* '''Spawn robot factory:''' Chance of spawning a robot factory.
* '''Spawn research complex:''' Chance of spawning a research complex.
* '''Spawn wasteland:''' Chance of spawning a wasteland.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Spawn chances: TL factors ===
'''Values'''
* '''Main planet min/max:''' Factor to apply to spawn chance of main planet locations based on the TL of the system.
* '''Extra planets min/max:''' Factor to apply to spawn chance of extra planet locations based on the TL of the system.
* '''Moons min/max:''' Factor to apply to spawn chance of moon locations based on the TL of the system.

The min value would be applied at the lowest TL, while the max value would apply to the highest TL. 
TL's in between would get a scaled value between min and max.

=== Transit costs ===
'''Values'''
* '''Fee:''' Base cost for a single trip (cr).
* '''Anarchy factor:''' Factor applied to fee in Anarchy systems
* '''Feudal factor:''' Factor applied to fee in Feudal systems.
* '''Multi-government factor:''' Factor applied to fee in Multi-Government systems.
* '''Dictatorship factor:''' Factor applied to fee in Dictatorship systems.
* '''Communist factor:''' Factor applied to fee in Communist systems.
* '''Confederacy factor:''' Factor applied to fee in Confederacy systems.
* '''Democracy factor:''' Factor applied to fee in Democracy systems.
* '''Corporate State factor:''' Factor applied to fee in Corporate State systems.

eg 0.0 = All trips are free; 1.0 = Use base cost; 0.5 = 50% of base cost.

=== Ship transfer costs ===
'''Values'''
* '''Fee:''' Base cost for ship transfer (cr).
* '''Anarchy factor:''' Factor applied to fee in Anarchy systems
* '''Feudal factor:''' Factor applied to fee in Feudal systems.
* '''Multi-government factor:''' Factor applied to fee in Multi-Government systems.
* '''Dictatorship factor:''' Factor applied to fee in Dictatorship systems.
* '''Communist factor:''' Factor applied to fee in Communist systems.
* '''Confederacy factor:''' Factor applied to fee in Confederacy systems.
* '''Democracy factor:''' Factor applied to fee in Democracy systems.
* '''Corporate State factor:''' Factor applied to fee in Corporate State systems.

eg 0.0 = Ship transfers are free; 1.0 = Use base cost; 1.5 = 150% base cost.

</div>

== Downloads ==
All components are downloadable through the in-game [[Expansions Manager]] 
Direct download here 
* [[Media:PlanetFall2_2.31.oxz|PlanetFall2_2.31.oxz]] (downloaded {{#downloads:PlanetFall2_2.31.oxz}} times).
* [[Media:PlanetFall2_ResourcesA.oxz|PlanetFall2_ResourcesA.oxz]] v1.1
* [[Media:PlanetFall2_ResourcesB.oxz|PlanetFall2_ResourcesB.oxz]] v1.0
* [[Media:Feudal_PlanetFall2_1.5.oxz|Feudal_PlanetFall2.oxz]] v1.5 (downloaded {{#downloads:Feudal_PlanetFall2_1.5.oxz}} times).
 
* [[Media:PlanetFall2_BlackMonks.oxz|PlanetFall2_BlackMonks.oxz]] v2.1 - Adds Bank of the Black Monks to the planet surface locations, providing all the normal bank facilities. The [[Black_Monk_Monastery|Bank of the Black Monks]] also needs to be installed.
* [[Media:PlanetFall2_HoopyCasino.oxz|PlanetFall2_HoopyCasino.oxz]] v2.5 - Adds HOopy casinos to the planet surface locations, complete with gaming opportunities. The [[HOopy_Casino|HOopy Casino OXP]] also needs to be installed.
* [[Media:PlanetFall2_Oo-Haul.oxz|PlanetFall2_Oo-Haul.oxz]] v2.1 - Adds an Oo-Haul distribution centre to the main planet, and a mission to escort a hauler from it out to either the witchpoint or constore. The [[Your_Ad_Here!|YAH/Your Ad Here!]] OXP and [[Oo-Haul]] need to be installed.

== License ==
*Author (PF v.2): [[User:Phkb|Phkb]]
*Author (PF v.1): [[User:Thargoid|Thargoid]]

This OXP is released under the Creative Commons Attribution - Non-Commercial - Share Alike 3.0 license with the following clauses:

* Whilst you are free (and encouraged) to re-use any of the scripting, models or texturing in this OXP, the usage must be distinct from that within this OXP. Unique identifiers such as (but not limited to) unique shipdata.plist entity keys, mission variables, script names (this.name), equipment identity strings (EQ_), description list arrays and entity roles must not be re-used without prior agreement. Basically if it's unique or would identify or overwrite anything in the original OXP, then you may not re-use it (for obvious compatibility reasons).
* rebundling of this OXP within another distribution is permitted as long as it is unchanged. The following derivates however are permitted and except from the above:
** the conversion of files between XML and openStep.
** the merging of files with other files of the same type from other OXPs.
* The license information (either as this file or merged into a larger one) must be included in the OXP.
* Even though it is not compulsory, if you are re-using any sizable or recognisable piece of this OXP, please let me know :)

---> (Details of images used) --->
<div class="mw-collapsible mw-collapsed" data-expandtext="Show gory details" data-collapsetext="Hide gory details" style="overflow:auto;">
'''Image files:''' 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_20850610.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21988050.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_23326348.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21988072.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_23326337.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21835246.htm Image by user6702303 on Freepik 
 
https://www.freepik.com/free-photo/blue-sky-with-scattered-white-clouds_12110221.htm Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22542965.htm Freepik 
https://www.freepik.com/free-photo/cloudy-sky-daylight-background_19380968.htm Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22543011.htm Freepik 
https://www.freepik.com/free-photo/blue-sky-with-cloud-closeup_6133056.htm Image by photogenia on Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22542943.htm Freepik 
https://www.freepik.com/free-vector/20-vehicles-outline-icon-presentation_38543743.htm Image by flatart on Freepik 
 
https://www.freepik.com/free-ai-image/subway-dark-atmosphere_76653967.htm Image by freepik 
https://www.freepik.com/free-ai-image/new-york-city-subway-train-motion_69844323.htm Image by freepik 
https://www.freepik.com/free-photo/motion-blur-automatic-train-moving-inside-tunnel-tokyo-japan_10824408.htm Image by tawatchai07 on Freepik 
 
</div>
Some images were generated by AI at https://www.freepik.com/pikaso/ai-image-generator 

'''Sound files:''' 
"e train 140kmh 04 190613_0029.wav" by klankbeeld -- https://freesound.org/s/476298/ -- License: Attribution 4.0 
"Arrival of a passenger electric train.1950km station_2(Eq,lmtr).wav" by newlocknew -- https://freesound.org/s/580464/ -- License: Attribution 4.0 

== Version History ==
2.31
* Added GNN interface to some planetary surface locations.
* Fixed null reference error that could occur during transits.
* Added screenID's to all mission screens.
* Speed of the landing FX now scales with system performance.
* Switched to using logcontrol.plist for debug output.

2.30
* Changed manifest title from "PlanetFall" to "PlanetFall2".
* Changed Library Config aliases to "PlanetFall2".
* Changed category to "Systems".
* Fixed issue with adding OXP locations to custom systems, where some keys were being added to the list twice.

2.29
* Shuttles that choose to land on a planet will now do so at one of the landing sites.
* Shuttles will also launch from the landing sites.

2.28
* Fixed method of detecting when two landing sites are too close together.
* Changed calculation method for positioning landing sites to ensure good separation from others.

2.27
* Fixed issue where stored names were not being restored from missionVariables reliably.
* Fixed issue with naming system for Oo-Haul sites, which wasn't including "(Distribution Centre)" in the name.
* Fixed issue with naming HOopy Casino sites, which wasn't including "(HOopy Casino)" in the name.
* OXP planet locations defined via the ship role "planetFall2_???_externalOXP" are now attempted to be added to custom systems. Random factors and spawn conditions can then come in to play to limit the number of spawns.

<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">
2.26
* Darkened overlay images for better compatibility with Oolite 1.92.

2.25
* Moved more text into missiontext.plist.
* Fixed issue with ship transfer fee not being calculated correctly when being deducted from the players account.

2.24
* Added check for, and warning message of, PlanetLand OXP conflict.

2.23
* Fixed issue where shipyards were not viewable on stations that have overridden the "move shipyards to planet" option.

2.22
* Display a message when attempting to access shipyards on stations when they are located on planetary surfaces.
* Added option to disable the shallow approach angle requirement when landing on a surface location.
* Tweaked spawning logic so planetary locations can't be too close together, increasing the distance from the previous fix.

2.21
* Change to manifest file to match with split of resources pack into two.

2.20
* Added a function, $getSystemLocations, which returns an object containing the ship keys and place names of all planetary locations in a given system.

2.19
* Setting beacon range to zero will make all beacons visible all the time.
* Added ability to scale the maximum turbulence factor per planet.

2.18
* Added a "turbulence impact scale" option so the effect of turbulence can be scaled to taste.
* Allowed for blank entries in location overrides to switch to randomised location types and naming.
* Fixed issues when checking roles to determine the type of VFX to show for landing.
* Added ability to override the landing clouds, docks and overlays on a per-planet basis.
* Some code refactoring.

2.17
* Moved most text into missiontext.plist for easier localisation.
* Removed monkey patch on Marker Inquirer as no longer required.

2.16
* Tweak to prevent LMSS and Laser Arrangement interfaces disappearing on non-PlanetFall locations.

2.15
* Increased the number of shipdata entities to better handle high values for the number of planetary landing points.

2.14
* Added protection for instances where a planet or moon has no air color value set.
* Fixed issue where the reason for the denial of a landing request was not being transmitted to the player.

2.13
* Further fixes to linkage between landing sites and planets.

2.12
* Fixed incorrect property setting in shipdata.
* Changed allegiance setting for research complexes to be neutral.
* Fixed issue where landing sites could spawn too close together.

2.11
* Fixed issue where link between landing sites and planets could occasionally break due to rounding errors.

2.10
* Prevented things like "Immigration Control" from appearing in Anarchy systems.
* Prevented turbulence frame callback from being started twice.
* Fixed error: this.serviceLevelDecrease is not a function.
* Tweaks to hopefully permanently fix issue where turbulence effect keeps running after a witchspace jump or docking.

2.9
* Fixed JS error in transit process code.
* Fixed issue where Vimana-X HUD was not resetting correctly on launch after using transit system.

2.8
* Split off planet rotation slowing into separate OXP, and made optional for this OXP.

2.7
* Dying while turbulence is active will now stop the frame callback.
* Added tweak to planet rotation when approaching planet, slowing it down to make scale issues less obvious (can be configured with Library Config).
* Code refactoring.

2.6
* Small tweak to the market script.
* Small fix to the name generation process for Capital Cities.

2.5
* Refined some text in messages for better understanding and integration with the built in voice.
* Added a pre-spawn check for a condition script on custom (ie non-built-in) surface locations.
* Fixed issue that was preventing custom names from being applied to custom system setups.
* Added a PDF document outlining how to create custom systems, for non-coders.
* Updates for the PlanetFall Oo-haul mission pack.
* Added conflict with PlanetFallMarketSaver - this OXP shouldn't be necessary with PlanetFall2.
* Added conflict with PlanetFall Markets - this OXP shouldn't be necessary with PlanetFall2.
* Removed some unused settings in config.
* Split off graphical assets into separate OXP, to make updating the core code easier for everyone.
* Added a second train FX image, so that the second animation doesn't just look completely like the first.
* Tweaked train FX images to make them more centred.
* Added scan class to station entities.

2.4
* Adjusted calculations to make landing when pointing at the GCIP more consistent.

2.3
* Added a planet-side transit system, so you don't have to launch and re-dock to visit another landing site on the same planet.
* Transit costs are adjusted based on government types. Configurable via Library Config.
* Ship transfer costs are adjusted based on government types. Configurable via Library Config.
* Fixed shipyard transfer process to not run more than once per system.
* Added fragment and vertex shaders to ensure all break patterns appear clearly and without shadow.
* Removed yaw turbulence factor. Only pitch and roll turbulence will be now be set.
* Fixed issue that was preventing subSurface colonies and moonSurface domes from being spawned.
* Amount of reduction to service level is now configurable via Library Config.
* Added a function (PlanetFall2.playerShipIsLocal) that can be called to determine if the player is near their ship or not.
* Removed the Blackmonks and HoOpy Casino config options, and incorporated spawn chances in script_info object of shipdata and condition script.

2.2
* Fixed issue where, if "Additional Planets" doesn't create any planets, no landing sites are created on the main planet.
* Reapplied monkey match for Market Inquirer to address issue with beacons not showing when more than 100000m from the player when docked.
* Removed conflicts with SW Planetary Systems and Moons, although it is unlikely any created moons will get landing sites.

2.1
* Added methods to allow for a fully customised system to be defined (with multiple sites per planet/moon).
* Moved Feudal States override code into a separate OXP.
* Fixed missing semi-colon in shipdata.plist.
* Switched ground control interface point to be a normal ship object (rather than a visual effect) to gain better compatibility with OXP's like Telescope.
* Made the ground control interface points more visible.
* Reduced the number of monkey patches required.
* Made the maximum range at which the space compass will detect ground control interface points configurable via Library Config, and changed the default value to 200km.
* Added some conflict oxps ("Planetary Systems" and "Moons" by stranger).
* Improved compatibility with Market Inquirer.
* Tweaked spawning methods to better reflect the original PlanetFall results, where OXP station roles are not added unless override flag is set.
* Added a warning screen for players, informing them that ship maintenance services are only available on the planet.
* Added a chance of a misjump when executing a witchspace jump inside the atmosphere.
* Fixed issue where entering witchspace while the turbulence effect is still active would result in it staying active.
* Fixed bug that was setting service level to the minimum value when launching from a planetary location.
* Turbulence now doesn't end when speed is zero.
* Added a config item to manage how much the service level of the player ship is reduced.
* Added shipdata entries to allow for multiple military bases, leisure complexes, factories and dumps on the main planet in custom systems.
* Fixed issues where NaN, NaN, Nan is calculated for a vector.
* Log messages now controllable via a debug flag.
* Removed some unused code.

2.0
* Updated landing FX, with clouds and landing pads.
* Updated launching FX.
* Changed docking method to have a fixed location (rather than just descending towards the planet surface anywhere), which means you can now save your game at planetary locations.
* Access to equipment sales (F3 Equip Ship) configuration via Library Config.
* Updated market information to allow for 3 different methods to be applied to any of the locations. (Configurable via Library Config)
* Added a variety of arrival report screen backgrounds. (Can be turned off via Library Config)
* Added a turbulence effect when in the atmosphere of a planet. (Can be turned off via Library Config)
* Equipment item renamed to "Atmospheric Stabilisers", but is optional for planetary landings.
* Moved ships from shipyards on other stations to planetary locations. (Configurable via Library Config)
* Moved "Maintenance Overhaul" to only be available on the main planet. (Configurable via Library Config)
* Added script updates to Feudal Systems, Aquatics, Market Inquirer, Galactic Almanac and In-System cargo delivery to maintain compatibility.
* Additional compatibility settings updated via shipdata-overrides.plist.
</div>

== The Dark Side ==
=== Custom designing a system ===
You can now custom design a system:
:specifically naming landing sites (see inside Lave.oxp)
:adding tweaks for entering the atmosphere: storms, haze, colours, and [[OXP_howto_texture#Planet_textures|city night-lights]] (see inside Famous Planets v.3 & see inside Lave.oxp)
:tweaking landing: images and haze ((see inside DGill's newest Feudal Systems suite & Famous Planets v.3)
:tweaking the space port "experience": things to do (see inside DGill's newest Feudal Systems suite)

To tweak a system see the "Creating Custom Systems.pdf" & the "Developer's ReadMe" hidden inside the oxp and then also the example [https://app.box.com/s/5xbksy48qr9cp31z2wpef6wjla05s3ih/file/1505969925081 SuperSystem.oxp]
:There is more detail [https://bb.oolite.space/viewtopic.php?p=301011#p301011 here] (runs on for several pages) and [https://bb.oolite.space/viewtopic.php?p=301065#p301065 here]

=== Problems with the Oolite game engine ===
*Planets were never meant to be interacted with in Oolite - there's a lot of hand-waving going on with PF2 when it comes to landing on the surface. [https://bb.oolite.space/viewtopic.php?p=301396#p301396 Phkb (2025)]
*The Oolite game engine does support larger planets and stars - I put together an OXP a while ago which uses them - but not necessarily particularly well. (Editor: [[SOTL Altmap]]? [[SOTL Exploration]]?) 
:You would have noticeable "corners" on the planets at 'real-world' sizes, as a 20,000 triangle polygon gets too large. You can already see these if you go as low as you can on a planet and look at the horizon. Similarly, the way planet texturing works would need to be significantly changed to avoid pixels tens of kilometres wide. There are display issues with large stars at high distances. There's a bit of a hack in the display code to avoid the worst of it, but there can still be strange issues with which objects are displayed in front of which. (You would probably need a higher Open GL version to solve these, which may or may not be practical to hide behind a graphics setting toggle) [https://bb.oolite.space/viewtopic.php?p=263420#p263420 Cim (2018)]

== Links ==
*[https://bb.oolite.space/viewtopic.php?t=21606 BB thread] (2024)
*[[Planetfall OXP]] PF v.1 original wiki page

== Quick Facts ==
{{OXPLevel|0|2}}{{IconOXP|ooVersion="1.90"|oxpCPU="Average"|oxpMEM="Low"|oxpGPU="Average"|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
{{Infobox OXPb| title = PlanetFall2.oxz
|version = 2.31
|release = 2026-05-07
|license = CC BY-NC-SA 3.0
|features = Planetary landings
|category = Systems OXPs
|author = [[User:Thargoid|Thargoid]], [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?t=21606 Oolite BB]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-orange.png|right]]
By default, planetary landings are harder than they were in V1. However, if you don't land on or approach planets, gameplay is largely unaffected (or it can be).

Planetfall2 OXP

2026-05-07T02:59:56Z

Phkb: /* A suite of OXPs */

[[Image:IconPF2.png|100px|right]]
[[File:PlanetFall2 city 7.png|300px|thumb|right|Landing at a city]]
[[File:PlanetFall2 moon 5.png|300px|thumb|right|Landing on a moon]]
== Overview ==
{{Infobox EquipStats Oolite| title = PlanetFall2 OXP
|image =
|equipName = Atmospheric Stabilisers
|equipCost = 5,000₢
|equipTL = 9
}}
An OXP which allows the Commander to land at specific locations on planets and moons (but not suns, even at night). Each main planet has up to 5 designated landing sites, while additional planets can have 3, and each moon can have 2 (configurable via [[Library OXP|Library Config]]). Pick your landing site and point your ship at the flashing marker near the surface that indicates the Ground Control Interface Point for the landing zone. Ensure your flight path is not too steep, otherwise you may sustain damage when the automated landing protocol engages.

Be careful of turbulence as you enter the atmosphere. To assist with atmospheric turbulence, the "Atmospheric Stabilisers" can be purchased at any TL9+ system for 5000cr. When equipped, this will reduce the impact of turbulence on your ship. Speed will have an impact on how much your ship is effected by turbulence. Slowing down will decrease the effect.

Your approach will trigger an automatic landing request. You should receive a response after a few seconds, indicating you are either cleared for landing or not. If you have clearance, continue towards the Ground Control Interface Point at less than 100 m/s until the automated system engages, captures your ship and lowers you to a landing pad.

Planetary take-off is via a launch booster, with control being returned to the Commander once orbital insertion is achieved.

=== A suite of OXPs ===
This OXP is currently a suite of 3 OXPs with another 2 optional OXPs:
*'''PlanetFall2''' (the coding)
*'''PlanetFall Resources A''' } individual planetary images part 1
*'''PlanetFall Resources B''' } individual planetary images part 2

*Optional: '''Feudal PlanetFall2''' (linking PlanetFall2 with [[Feudal States]] which is currently the only OXP which does much on the planet surface).
:<s>At time of writing PlanetFall2 is only compatible with Feudal States v.1 (and the ''alpha'' Feudal States v.2 is only compatible with PlanetFall v.1)!</s> It should now be compatible with both versions of Feudal States.
*Optional: [[Planet Rotation Cosmetics OXP]] slows down the planet's rotation as you approach it and are captured by the planet's gravity.

[[File:Planetfall2 Transit system.png|right|300px]]

=== Gaming changes from Thargoid's PlanetFall v1 (2008-13) ===
*You can now land on a planet without purchasing "planetary landing capabilities"/"atmospheric stabilisers" - but it is rather more dangerous
::If you have already bought "planetary landing capabilities", PF2 will convert them to "atmospheric stabilisers"
*There are now specific landing sites on the planet
*Commodity Markets are now included (''ie'' PlanetFall Markets OXP is redundant).
*When landed you can transit from one landing site to another (and pay good money to transit your ship, too!).
*[[Maintenance]] overhauls are now performed on the planet surface rather than in the orbital station (they will tell you this on the station!)
*There are other changes to be discovered!

== Requirements ==
*Oolite v.1.90 or better
*[[GNN]]
*[[Library OXP]]
*[[Market Script Interface]]
*[[External Docking System]]

While it isn’t a requirement, the [[Planet Rotation Cosmetics OXP]] is a highly recommended addition for PlanetFall 2.

== Options ==
There are a '''lot''' of options available to help configure the system the way you want it. The list is long, so if you want to see everything, ''click'' the link on the right.
<div class="mw-collapsible mw-collapsed" data-expandtext="Show me everything!" data-collapsetext="Turn it off! Turn it off!" style="overflow:auto;">
Library Config has the following sections for PlanetFall2:
* General settings
* Main planet settings
** F3/F8 access
** Spawn chances
* Extra Planet settings
** F3/F8 access
** Spawn chances
* Moon settings
** F3/F8 access
** Spawn chances
* Spawn chances: TL factors
* Transit costs
* Ship transfer costs

=== General settings ===
'''Flags'''
* '''Move shipyards to planet:''' Controls whether shipyards are moved to planet-side locations.
* '''Move maintenance to planet:''' Controls whether the "Maintenance Overhaul" item is moved to only be offered on planet-side locations.
* '''Atmosphere turbulence:''' Controls whether the turbulence effect, when entering the atmosphere of a planet, is active or not.
* '''Shallow approach:''' Controls whether a shallow approach angle is required when landing on a surface location.
* '''Use landing images:''' Controls whether the images displayed after landing at a planetary site are displayed.
* '''Use Almanac names:''' Controls whether the names of planetary locations are given names based on the methodology from the Galactic Almanac.
* '''Allow planetary transit:''' Controls whether it is possible to fast travel to other planetary sites after landing.

'''Values'''
* '''Main planet max:''' Maximum number of locations that could be spawned on the main planet.
* '''Extra planet max:''' Maximum number of locations that could be spawned on a secondary planet with an atmosphere.
* '''Moon max:''' Maximum number of locations that could be spawned on a moon with no atmosphere.
* '''Atmosphere max altitude:''' Maximum height (in km) of the atmosphere of a planet.
* '''Beacon range:''' Max distance (in km) that planetary beacons become visible to the player.
* '''Service Level dec:''' Amount that service level will be reduced by when launching from a planet.
* '''Transfer Time:''' Amount of time (in hours) that will pass when transferring player ship to the current location.
* '''Train speed:''' Base average speed of trains (in kph), which is scaled up or down based on the TL of the system.
* '''Turbulence impact scale:''' Scales the impact of turbulence, where 1.0 means no change to the default, 0.5 halves the impact, and 0.0 means no impact (same as turning turbulence off).

=== Main planet settings ===
==== F3/F8 Access ====
'''Flags'''
* '''Capital cities:''' Whether capital cities will have access to the F3 Equip Ship screen.
* '''Military bases:''' Whether military bases will have access to the F3 Equip Ship screen.
* '''Leisure complexes:''' Whether leisure complexes will have access to the F3 Equip Ship screen.
* '''Factories:''' Whether factories will have access to the F3 Equip Ship screen.
* '''Rubbish dumps:''' Whether rubbish dumps will have access to the F3 Equip Ship screen.

'''Values'''
* '''Capital cities:''' What type of market will be available at capital cities.
* '''Military bases:''' What type of market will be available at military bases.
* '''Leisure complexes:''' What type of market will be available at military bases.
* '''Factories:''' What type of market will be available at factories.
* '''Rubbish dumps:''' What type of market will be available at rubbish dumps.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51. (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn city:''' Chance of spawning a capital city.
* '''Spawn military base:''' Chance of spawning a military base.
* '''Spawn leisure complex:''' Chance of spawning a leisure complex.
* '''Spawn factory:''' Chance of spawning a factory.
* '''Spawn rubbish dump:''' Chance of spawning a rubbish dump.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Extra planet Settings ===
==== F3/F8 Access ====
'''Flags'''
* '''Colony cities:''' Whether colony cities will have access to the F3 Equip Ship screen.
* '''Military bases:''' Whether military bases will have access to the F3 Equip Ship screen.
* '''Leisure complexes:''' Whether leisure complexes will have access to the F3 Equip Ship screen.
* '''Factories:''' Whether factories will have access to the F3 Equip Ship screen.
* '''Rubbish dumps:''' Whether rubbish dumps will have access to the F3 Equip Ship screen.

'''Values'''
* '''Colony cities:''' What type of market will be available at colony cities.
* '''Military bases:''' What type of market will be available at military bases.
* '''Leisure complexes:''' What type of market will be available at leisure complexes.
* '''Factories:''' What type of market will be available at factories.
* '''Rubbish dumps:''' What type of market will be available at rubbish dumps.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51 (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn colony city:''' Chance of spawning a colony city.
* '''Spawn military base:''' Chance of spawning a military base.
* '''Spawn leisure complex:''' Chance of spawning a leisure complex.
* '''Spawn factory:''' Chance of spawning a factory.
* '''Spawn rubbish dump:''' Chance of spawning a rubbish dump.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Moons ===
==== F3/F8 Access ====
'''Flags'''
* '''Colony domes:''' Whether colony domes will have access to the F3 Equip Ship screen.
* '''Mines:''' Whether mines will have access to the F3 Equip Ship screen.
* '''Prisons:''' Whether prisons will have access to the F3 Equip Ship screen.
* '''Leisure domes:''' Whether leisure domes will have access to the F3 Equip Ship screen.
* '''Robot factories:''' Whether robot factories will have access to the F3 Equip Ship screen.
* '''Research complexes:''' Whether research complexes will have access to the F3 Equip Ship screen.
* '''Wastelands:''' Whether wastelands will have access to the F3 Equip Ship screen.

'''Values'''
* '''Colony domes:''' What type of market will be available at colony domes.
* '''Mines:''' What type of market will be available at mines.
* '''Prison:''' What type of market will be available at prisons.
* '''Leisure domes:''' What type of market will be available at leisure domes.
* '''Robot factories:''' What type of market will be available at robot factories.
* '''Research complexes:''' What type of market will be available at research complexes.
* '''Wastelands:''' What type of market will be available at wastelands.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51 (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn colony dome:''' Chance of spawning a colony dome.
* '''Spawn mine:''' Chance of spawning a mine.
* '''Spawn prison:''' Chance of spawning a prison.
* '''Spawn leisure dome:''' Chance of spawning a leisure dome.
* '''Spawn robot factory:''' Chance of spawning a robot factory.
* '''Spawn research complex:''' Chance of spawning a research complex.
* '''Spawn wasteland:''' Chance of spawning a wasteland.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Spawn chances: TL factors ===
'''Values'''
* '''Main planet min/max:''' Factor to apply to spawn chance of main planet locations based on the TL of the system.
* '''Extra planets min/max:''' Factor to apply to spawn chance of extra planet locations based on the TL of the system.
* '''Moons min/max:''' Factor to apply to spawn chance of moon locations based on the TL of the system.

The min value would be applied at the lowest TL, while the max value would apply to the highest TL. 
TL's in between would get a scaled value between min and max.

=== Transit costs ===
'''Values'''
* '''Fee:''' Base cost for a single trip (cr).
* '''Anarchy factor:''' Factor applied to fee in Anarchy systems
* '''Feudal factor:''' Factor applied to fee in Feudal systems.
* '''Multi-government factor:''' Factor applied to fee in Multi-Government systems.
* '''Dictatorship factor:''' Factor applied to fee in Dictatorship systems.
* '''Communist factor:''' Factor applied to fee in Communist systems.
* '''Confederacy factor:''' Factor applied to fee in Confederacy systems.
* '''Democracy factor:''' Factor applied to fee in Democracy systems.
* '''Corporate State factor:''' Factor applied to fee in Corporate State systems.

eg 0.0 = All trips are free; 1.0 = Use base cost; 0.5 = 50% of base cost.

=== Ship transfer costs ===
'''Values'''
* '''Fee:''' Base cost for ship transfer (cr).
* '''Anarchy factor:''' Factor applied to fee in Anarchy systems
* '''Feudal factor:''' Factor applied to fee in Feudal systems.
* '''Multi-government factor:''' Factor applied to fee in Multi-Government systems.
* '''Dictatorship factor:''' Factor applied to fee in Dictatorship systems.
* '''Communist factor:''' Factor applied to fee in Communist systems.
* '''Confederacy factor:''' Factor applied to fee in Confederacy systems.
* '''Democracy factor:''' Factor applied to fee in Democracy systems.
* '''Corporate State factor:''' Factor applied to fee in Corporate State systems.

eg 0.0 = Ship transfers are free; 1.0 = Use base cost; 1.5 = 150% base cost.

</div>

== Downloads ==
All components are downloadable through the in-game [[Expansions Manager]] 
Direct download here 
* [[Media:PlanetFall2_2.31.oxz|PlanetFall2_2.31.oxz]] (downloaded {{#downloads:PlanetFall2_2.31.oxz}} times).
* [[Media:PlanetFall2_ResourcesA.oxz|PlanetFall2_ResourcesA.oxz]] v1.1
* [[Media:PlanetFall2_ResourcesB.oxz|PlanetFall2_ResourcesB.oxz]] v1.0
* [[Media:Feudal_PlanetFall2_1.5.oxz|Feudal_PlanetFall2.oxz]] v1.5 (downloaded {{#downloads:Feudal_PlanetFall2_1.5.oxz}} times).
 
* [[Media:PlanetFall2_BlackMonks.oxz|PlanetFall2_BlackMonks.oxz]] v2.1 - Adds Bank of the Black Monks to the planet surface locations, providing all the normal bank facilities. The [[Black_Monk_Monastery|Bank of the Black Monks]] also needs to be installed.
* [[Media:PlanetFall2_HoopyCasino.oxz|PlanetFall2_HoopyCasino.oxz]] v2.5 - Adds HOopy casinos to the planet surface locations, complete with gaming opportunities. The [[HOopy_Casino|HOopy Casino OXP]] also needs to be installed.
* [[Media:PlanetFall2_Oo-Haul.oxz|PlanetFall2_Oo-Haul.oxz]] v2.1 - Adds an Oo-Haul distribution centre to the main planet, and a mission to escort a hauler from it out to either the witchpoint or constore. The [[Your_Ad_Here!|YAH/Your Ad Here!]] OXP and [[Oo-Haul]] need to be installed.

== License ==
*Author (PF v.2): [[User:Phkb|Phkb]]
*Author (PF v.1): [[User:Thargoid|Thargoid]]

This OXP is released under the Creative Commons Attribution - Non-Commercial - Share Alike 3.0 license with the following clauses:

* Whilst you are free (and encouraged) to re-use any of the scripting, models or texturing in this OXP, the usage must be distinct from that within this OXP. Unique identifiers such as (but not limited to) unique shipdata.plist entity keys, mission variables, script names (this.name), equipment identity strings (EQ_), description list arrays and entity roles must not be re-used without prior agreement. Basically if it's unique or would identify or overwrite anything in the original OXP, then you may not re-use it (for obvious compatibility reasons).
* rebundling of this OXP within another distribution is permitted as long as it is unchanged. The following derivates however are permitted and except from the above:
** the conversion of files between XML and openStep.
** the merging of files with other files of the same type from other OXPs.
* The license information (either as this file or merged into a larger one) must be included in the OXP.
* Even though it is not compulsory, if you are re-using any sizable or recognisable piece of this OXP, please let me know :)

---> (Details of images used) --->
<div class="mw-collapsible mw-collapsed" data-expandtext="Show gory details" data-collapsetext="Hide gory details" style="overflow:auto;">
'''Image files:''' 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_20850610.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21988050.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_23326348.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21988072.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_23326337.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21835246.htm Image by user6702303 on Freepik 
 
https://www.freepik.com/free-photo/blue-sky-with-scattered-white-clouds_12110221.htm Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22542965.htm Freepik 
https://www.freepik.com/free-photo/cloudy-sky-daylight-background_19380968.htm Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22543011.htm Freepik 
https://www.freepik.com/free-photo/blue-sky-with-cloud-closeup_6133056.htm Image by photogenia on Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22542943.htm Freepik 
https://www.freepik.com/free-vector/20-vehicles-outline-icon-presentation_38543743.htm Image by flatart on Freepik 
 
https://www.freepik.com/free-ai-image/subway-dark-atmosphere_76653967.htm Image by freepik 
https://www.freepik.com/free-ai-image/new-york-city-subway-train-motion_69844323.htm Image by freepik 
https://www.freepik.com/free-photo/motion-blur-automatic-train-moving-inside-tunnel-tokyo-japan_10824408.htm Image by tawatchai07 on Freepik 
 
</div>
Some images were generated by AI at https://www.freepik.com/pikaso/ai-image-generator 

'''Sound files:''' 
"e train 140kmh 04 190613_0029.wav" by klankbeeld -- https://freesound.org/s/476298/ -- License: Attribution 4.0 
"Arrival of a passenger electric train.1950km station_2(Eq,lmtr).wav" by newlocknew -- https://freesound.org/s/580464/ -- License: Attribution 4.0 

== Version History ==
2.31
* Added GNN interface to some planetary surface locations.
* Fixed null reference error that could occur during transits.
* Added screenID's to all mission screens.
* Speed of the landing FX now scales with system performance.
* Switched to using logcontrol.plist for debug output.

2.30
* Changed manifest title from "PlanetFall" to "PlanetFall2".
* Changed Library Config aliases to "PlanetFall2".
* Changed category to "Systems".
* Fixed issue with adding OXP locations to custom systems, where some keys were being added to the list twice.

2.29
* Shuttles that choose to land on a planet will now do so at one of the landing sites.
* Shuttles will also launch from the landing sites.

2.28
* Fixed method of detecting when two landing sites are too close together.
* Changed calculation method for positioning landing sites to ensure good separation from others.

2.27
* Fixed issue where stored names were not being restored from missionVariables reliably.
* Fixed issue with naming system for Oo-Haul sites, which wasn't including "(Distribution Centre)" in the name.
* Fixed issue with naming HOopy Casino sites, which wasn't including "(HOopy Casino)" in the name.
* OXP planet locations defined via the ship role "planetFall2_???_externalOXP" are now attempted to be added to custom systems. Random factors and spawn conditions can then come in to play to limit the number of spawns.

2.26
* Darkened overlay images for better compatibility with Oolite 1.92.

2.25
* Moved more text into missiontext.plist.
* Fixed issue with ship transfer fee not being calculated correctly when being deducted from the players account.

2.24
* Added check for, and warning message of, PlanetLand OXP conflict.

2.23
* Fixed issue where shipyards were not viewable on stations that have overridden the "move shipyards to planet" option.

2.22
* Display a message when attempting to access shipyards on stations when they are located on planetary surfaces.
* Added option to disable the shallow approach angle requirement when landing on a surface location.
* Tweaked spawning logic so planetary locations can't be too close together, increasing the distance from the previous fix.

2.21
* Change to manifest file to match with split of resources pack into two.

2.20
* Added a function, $getSystemLocations, which returns an object containing the ship keys and place names of all planetary locations in a given system.

2.19
* Setting beacon range to zero will make all beacons visible all the time.
* Added ability to scale the maximum turbulence factor per planet.

<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">
2.18
* Added a "turbulence impact scale" option so the effect of turbulence can be scaled to taste.
* Allowed for blank entries in location overrides to switch to randomised location types and naming.
* Fixed issues when checking roles to determine the type of VFX to show for landing.
* Added ability to override the landing clouds, docks and overlays on a per-planet basis.
* Some code refactoring.

2.17
* Moved most text into missiontext.plist for easier localisation.
* Removed monkey patch on Marker Inquirer as no longer required.

2.16
* Tweak to prevent LMSS and Laser Arrangement interfaces disappearing on non-PlanetFall locations.

2.15
* Increased the number of shipdata entities to better handle high values for the number of planetary landing points.

2.14
* Added protection for instances where a planet or moon has no air color value set.
* Fixed issue where the reason for the denial of a landing request was not being transmitted to the player.

2.13
* Further fixes to linkage between landing sites and planets.

2.12
* Fixed incorrect property setting in shipdata.
* Changed allegiance setting for research complexes to be neutral.
* Fixed issue where landing sites could spawn too close together.

2.11
* Fixed issue where link between landing sites and planets could occasionally break due to rounding errors.

2.10
* Prevented things like "Immigration Control" from appearing in Anarchy systems.
* Prevented turbulence frame callback from being started twice.
* Fixed error: this.serviceLevelDecrease is not a function.
* Tweaks to hopefully permanently fix issue where turbulence effect keeps running after a witchspace jump or docking.

2.9
* Fixed JS error in transit process code.
* Fixed issue where Vimana-X HUD was not resetting correctly on launch after using transit system.

2.8
* Split off planet rotation slowing into separate OXP, and made optional for this OXP.

2.7
* Dying while turbulence is active will now stop the frame callback.
* Added tweak to planet rotation when approaching planet, slowing it down to make scale issues less obvious (can be configured with Library Config).
* Code refactoring.

2.6
* Small tweak to the market script.
* Small fix to the name generation process for Capital Cities.

2.5
* Refined some text in messages for better understanding and integration with the built in voice.
* Added a pre-spawn check for a condition script on custom (ie non-built-in) surface locations.
* Fixed issue that was preventing custom names from being applied to custom system setups.
* Added a PDF document outlining how to create custom systems, for non-coders.
* Updates for the PlanetFall Oo-haul mission pack.
* Added conflict with PlanetFallMarketSaver - this OXP shouldn't be necessary with PlanetFall2.
* Added conflict with PlanetFall Markets - this OXP shouldn't be necessary with PlanetFall2.
* Removed some unused settings in config.
* Split off graphical assets into separate OXP, to make updating the core code easier for everyone.
* Added a second train FX image, so that the second animation doesn't just look completely like the first.
* Tweaked train FX images to make them more centred.
* Added scan class to station entities.

2.4
* Adjusted calculations to make landing when pointing at the GCIP more consistent.

2.3
* Added a planet-side transit system, so you don't have to launch and re-dock to visit another landing site on the same planet.
* Transit costs are adjusted based on government types. Configurable via Library Config.
* Ship transfer costs are adjusted based on government types. Configurable via Library Config.
* Fixed shipyard transfer process to not run more than once per system.
* Added fragment and vertex shaders to ensure all break patterns appear clearly and without shadow.
* Removed yaw turbulence factor. Only pitch and roll turbulence will be now be set.
* Fixed issue that was preventing subSurface colonies and moonSurface domes from being spawned.
* Amount of reduction to service level is now configurable via Library Config.
* Added a function (PlanetFall2.playerShipIsLocal) that can be called to determine if the player is near their ship or not.
* Removed the Blackmonks and HoOpy Casino config options, and incorporated spawn chances in script_info object of shipdata and condition script.

2.2
* Fixed issue where, if "Additional Planets" doesn't create any planets, no landing sites are created on the main planet.
* Reapplied monkey match for Market Inquirer to address issue with beacons not showing when more than 100000m from the player when docked.
* Removed conflicts with SW Planetary Systems and Moons, although it is unlikely any created moons will get landing sites.

2.1
* Added methods to allow for a fully customised system to be defined (with multiple sites per planet/moon).
* Moved Feudal States override code into a separate OXP.
* Fixed missing semi-colon in shipdata.plist.
* Switched ground control interface point to be a normal ship object (rather than a visual effect) to gain better compatibility with OXP's like Telescope.
* Made the ground control interface points more visible.
* Reduced the number of monkey patches required.
* Made the maximum range at which the space compass will detect ground control interface points configurable via Library Config, and changed the default value to 200km.
* Added some conflict oxps ("Planetary Systems" and "Moons" by stranger).
* Improved compatibility with Market Inquirer.
* Tweaked spawning methods to better reflect the original PlanetFall results, where OXP station roles are not added unless override flag is set.
* Added a warning screen for players, informing them that ship maintenance services are only available on the planet.
* Added a chance of a misjump when executing a witchspace jump inside the atmosphere.
* Fixed issue where entering witchspace while the turbulence effect is still active would result in it staying active.
* Fixed bug that was setting service level to the minimum value when launching from a planetary location.
* Turbulence now doesn't end when speed is zero.
* Added a config item to manage how much the service level of the player ship is reduced.
* Added shipdata entries to allow for multiple military bases, leisure complexes, factories and dumps on the main planet in custom systems.
* Fixed issues where NaN, NaN, Nan is calculated for a vector.
* Log messages now controllable via a debug flag.
* Removed some unused code.

2.0
* Updated landing FX, with clouds and landing pads.
* Updated launching FX.
* Changed docking method to have a fixed location (rather than just descending towards the planet surface anywhere), which means you can now save your game at planetary locations.
* Access to equipment sales (F3 Equip Ship) configuration via Library Config.
* Updated market information to allow for 3 different methods to be applied to any of the locations. (Configurable via Library Config)
* Added a variety of arrival report screen backgrounds. (Can be turned off via Library Config)
* Added a turbulence effect when in the atmosphere of a planet. (Can be turned off via Library Config)
* Equipment item renamed to "Atmospheric Stabilisers", but is optional for planetary landings.
* Moved ships from shipyards on other stations to planetary locations. (Configurable via Library Config)
* Moved "Maintenance Overhaul" to only be available on the main planet. (Configurable via Library Config)
* Added script updates to Feudal Systems, Aquatics, Market Inquirer, Galactic Almanac and In-System cargo delivery to maintain compatibility.
* Additional compatibility settings updated via shipdata-overrides.plist.
</div>

== The Dark Side ==
=== Custom designing a system ===
You can now custom design a system:
:specifically naming landing sites (see inside Lave.oxp)
:adding tweaks for entering the atmosphere: storms, haze, colours, and [[OXP_howto_texture#Planet_textures|city night-lights]] (see inside Famous Planets v.3 & see inside Lave.oxp)
:tweaking landing: images and haze ((see inside DGill's newest Feudal Systems suite & Famous Planets v.3)
:tweaking the space port "experience": things to do (see inside DGill's newest Feudal Systems suite)

To tweak a system see the "Creating Custom Systems.pdf" & the "Developer's ReadMe" hidden inside the oxp and then also the example [https://app.box.com/s/5xbksy48qr9cp31z2wpef6wjla05s3ih/file/1505969925081 SuperSystem.oxp]
:There is more detail [https://bb.oolite.space/viewtopic.php?p=301011#p301011 here] (runs on for several pages) and [https://bb.oolite.space/viewtopic.php?p=301065#p301065 here]

=== Problems with the Oolite game engine ===
*Planets were never meant to be interacted with in Oolite - there's a lot of hand-waving going on with PF2 when it comes to landing on the surface. [https://bb.oolite.space/viewtopic.php?p=301396#p301396 Phkb (2025)]
*The Oolite game engine does support larger planets and stars - I put together an OXP a while ago which uses them - but not necessarily particularly well. (Editor: [[SOTL Altmap]]? [[SOTL Exploration]]?) 
:You would have noticeable "corners" on the planets at 'real-world' sizes, as a 20,000 triangle polygon gets too large. You can already see these if you go as low as you can on a planet and look at the horizon. Similarly, the way planet texturing works would need to be significantly changed to avoid pixels tens of kilometres wide. There are display issues with large stars at high distances. There's a bit of a hack in the display code to avoid the worst of it, but there can still be strange issues with which objects are displayed in front of which. (You would probably need a higher Open GL version to solve these, which may or may not be practical to hide behind a graphics setting toggle) [https://bb.oolite.space/viewtopic.php?p=263420#p263420 Cim (2018)]

== Links ==
*[https://bb.oolite.space/viewtopic.php?t=21606 BB thread] (2024)
*[[Planetfall OXP]] PF v.1 original wiki page

== Quick Facts ==
{{OXPLevel|0|2}}{{IconOXP|ooVersion="1.90"|oxpCPU="Average"|oxpMEM="Low"|oxpGPU="Average"|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
{{Infobox OXPb| title = PlanetFall2.oxz
|version = 2.31
|release = 2026-05-07
|license = CC BY-NC-SA 3.0
|features = Planetary landings
|category = Systems OXPs
|author = [[User:Thargoid|Thargoid]], [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?t=21606 Oolite BB]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-orange.png|right]]
By default, planetary landings are harder than they were in V1. However, if you don't land on or approach planets, gameplay is largely unaffected (or it can be).

Planetfall2 OXP

2026-05-07T02:46:01Z

Phkb: /* Quick Facts */

[[Image:IconPF2.png|100px|right]]
[[File:PlanetFall2 city 7.png|300px|thumb|right|Landing at a city]]
[[File:PlanetFall2 moon 5.png|300px|thumb|right|Landing on a moon]]
== Overview ==
{{Infobox EquipStats Oolite| title = PlanetFall2 OXP
|image =
|equipName = Atmospheric Stabilisers
|equipCost = 5,000₢
|equipTL = 9
}}
An OXP which allows the Commander to land at specific locations on planets and moons (but not suns, even at night). Each main planet has up to 5 designated landing sites, while additional planets can have 3, and each moon can have 2 (configurable via [[Library OXP|Library Config]]). Pick your landing site and point your ship at the flashing marker near the surface that indicates the Ground Control Interface Point for the landing zone. Ensure your flight path is not too steep, otherwise you may sustain damage when the automated landing protocol engages.

Be careful of turbulence as you enter the atmosphere. To assist with atmospheric turbulence, the "Atmospheric Stabilisers" can be purchased at any TL9+ system for 5000cr. When equipped, this will reduce the impact of turbulence on your ship. Speed will have an impact on how much your ship is effected by turbulence. Slowing down will decrease the effect.

Your approach will trigger an automatic landing request. You should receive a response after a few seconds, indicating you are either cleared for landing or not. If you have clearance, continue towards the Ground Control Interface Point at less than 100 m/s until the automated system engages, captures your ship and lowers you to a landing pad.

Planetary take-off is via a launch booster, with control being returned to the Commander once orbital insertion is achieved.

=== A suite of OXPs ===
This OXP is currently a suite of 2 OXPs with another 2 optional OXPs:
*'''PlanetFall2''' (the coding)
*'''PlanetFall Resources''' (the individual planetary images)

*Optional: '''Feudal PlanetFall2''' (linking PlanetFall2 with [[Feudal States]] which is currently the only OXP which does much on the planet surface).
:<s>At time of writing PlanetFall2 is only compatible with Feudal States v.1 (and the ''alpha'' Feudal States v.2 is only compatible with PlanetFall v.1)!</s> It should now be compatible with both versions of Feudal States.
*Optional: [[Planet Rotation Cosmetics OXP]] slows down the planet's rotation as you approach it and are captured by the planet's gravity.

[[File:Planetfall2 Transit system.png|right|300px]]

=== Gaming changes from Thargoid's PlanetFall v1 (2008-13) ===
*You can now land on a planet without purchasing "planetary landing capabilities"/"atmospheric stabilisers" - but it is rather more dangerous
::If you have already bought "planetary landing capabilities", PF2 will convert them to "atmospheric stabilisers"
*There are now specific landing sites on the planet
*Commodity Markets are now included (''ie'' PlanetFall Markets OXP is redundant).
*When landed you can transit from one landing site to another (and pay good money to transit your ship, too!).
*[[Maintenance]] overhauls are now performed on the planet surface rather than in the orbital station (they will tell you this on the station!)
*There are other changes to be discovered!

== Requirements ==
*Oolite v.1.90 or better
*[[GNN]]
*[[Library OXP]]
*[[Market Script Interface]]
*[[External Docking System]]

While it isn’t a requirement, the [[Planet Rotation Cosmetics OXP]] is a highly recommended addition for PlanetFall 2.

== Options ==
There are a '''lot''' of options available to help configure the system the way you want it. The list is long, so if you want to see everything, ''click'' the link on the right.
<div class="mw-collapsible mw-collapsed" data-expandtext="Show me everything!" data-collapsetext="Turn it off! Turn it off!" style="overflow:auto;">
Library Config has the following sections for PlanetFall2:
* General settings
* Main planet settings
** F3/F8 access
** Spawn chances
* Extra Planet settings
** F3/F8 access
** Spawn chances
* Moon settings
** F3/F8 access
** Spawn chances
* Spawn chances: TL factors
* Transit costs
* Ship transfer costs

=== General settings ===
'''Flags'''
* '''Move shipyards to planet:''' Controls whether shipyards are moved to planet-side locations.
* '''Move maintenance to planet:''' Controls whether the "Maintenance Overhaul" item is moved to only be offered on planet-side locations.
* '''Atmosphere turbulence:''' Controls whether the turbulence effect, when entering the atmosphere of a planet, is active or not.
* '''Shallow approach:''' Controls whether a shallow approach angle is required when landing on a surface location.
* '''Use landing images:''' Controls whether the images displayed after landing at a planetary site are displayed.
* '''Use Almanac names:''' Controls whether the names of planetary locations are given names based on the methodology from the Galactic Almanac.
* '''Allow planetary transit:''' Controls whether it is possible to fast travel to other planetary sites after landing.

'''Values'''
* '''Main planet max:''' Maximum number of locations that could be spawned on the main planet.
* '''Extra planet max:''' Maximum number of locations that could be spawned on a secondary planet with an atmosphere.
* '''Moon max:''' Maximum number of locations that could be spawned on a moon with no atmosphere.
* '''Atmosphere max altitude:''' Maximum height (in km) of the atmosphere of a planet.
* '''Beacon range:''' Max distance (in km) that planetary beacons become visible to the player.
* '''Service Level dec:''' Amount that service level will be reduced by when launching from a planet.
* '''Transfer Time:''' Amount of time (in hours) that will pass when transferring player ship to the current location.
* '''Train speed:''' Base average speed of trains (in kph), which is scaled up or down based on the TL of the system.
* '''Turbulence impact scale:''' Scales the impact of turbulence, where 1.0 means no change to the default, 0.5 halves the impact, and 0.0 means no impact (same as turning turbulence off).

=== Main planet settings ===
==== F3/F8 Access ====
'''Flags'''
* '''Capital cities:''' Whether capital cities will have access to the F3 Equip Ship screen.
* '''Military bases:''' Whether military bases will have access to the F3 Equip Ship screen.
* '''Leisure complexes:''' Whether leisure complexes will have access to the F3 Equip Ship screen.
* '''Factories:''' Whether factories will have access to the F3 Equip Ship screen.
* '''Rubbish dumps:''' Whether rubbish dumps will have access to the F3 Equip Ship screen.

'''Values'''
* '''Capital cities:''' What type of market will be available at capital cities.
* '''Military bases:''' What type of market will be available at military bases.
* '''Leisure complexes:''' What type of market will be available at military bases.
* '''Factories:''' What type of market will be available at factories.
* '''Rubbish dumps:''' What type of market will be available at rubbish dumps.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51. (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn city:''' Chance of spawning a capital city.
* '''Spawn military base:''' Chance of spawning a military base.
* '''Spawn leisure complex:''' Chance of spawning a leisure complex.
* '''Spawn factory:''' Chance of spawning a factory.
* '''Spawn rubbish dump:''' Chance of spawning a rubbish dump.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Extra planet Settings ===
==== F3/F8 Access ====
'''Flags'''
* '''Colony cities:''' Whether colony cities will have access to the F3 Equip Ship screen.
* '''Military bases:''' Whether military bases will have access to the F3 Equip Ship screen.
* '''Leisure complexes:''' Whether leisure complexes will have access to the F3 Equip Ship screen.
* '''Factories:''' Whether factories will have access to the F3 Equip Ship screen.
* '''Rubbish dumps:''' Whether rubbish dumps will have access to the F3 Equip Ship screen.

'''Values'''
* '''Colony cities:''' What type of market will be available at colony cities.
* '''Military bases:''' What type of market will be available at military bases.
* '''Leisure complexes:''' What type of market will be available at leisure complexes.
* '''Factories:''' What type of market will be available at factories.
* '''Rubbish dumps:''' What type of market will be available at rubbish dumps.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51 (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn colony city:''' Chance of spawning a colony city.
* '''Spawn military base:''' Chance of spawning a military base.
* '''Spawn leisure complex:''' Chance of spawning a leisure complex.
* '''Spawn factory:''' Chance of spawning a factory.
* '''Spawn rubbish dump:''' Chance of spawning a rubbish dump.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Moons ===
==== F3/F8 Access ====
'''Flags'''
* '''Colony domes:''' Whether colony domes will have access to the F3 Equip Ship screen.
* '''Mines:''' Whether mines will have access to the F3 Equip Ship screen.
* '''Prisons:''' Whether prisons will have access to the F3 Equip Ship screen.
* '''Leisure domes:''' Whether leisure domes will have access to the F3 Equip Ship screen.
* '''Robot factories:''' Whether robot factories will have access to the F3 Equip Ship screen.
* '''Research complexes:''' Whether research complexes will have access to the F3 Equip Ship screen.
* '''Wastelands:''' Whether wastelands will have access to the F3 Equip Ship screen.

'''Values'''
* '''Colony domes:''' What type of market will be available at colony domes.
* '''Mines:''' What type of market will be available at mines.
* '''Prison:''' What type of market will be available at prisons.
* '''Leisure domes:''' What type of market will be available at leisure domes.
* '''Robot factories:''' What type of market will be available at robot factories.
* '''Research complexes:''' What type of market will be available at research complexes.
* '''Wastelands:''' What type of market will be available at wastelands.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51 (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn colony dome:''' Chance of spawning a colony dome.
* '''Spawn mine:''' Chance of spawning a mine.
* '''Spawn prison:''' Chance of spawning a prison.
* '''Spawn leisure dome:''' Chance of spawning a leisure dome.
* '''Spawn robot factory:''' Chance of spawning a robot factory.
* '''Spawn research complex:''' Chance of spawning a research complex.
* '''Spawn wasteland:''' Chance of spawning a wasteland.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Spawn chances: TL factors ===
'''Values'''
* '''Main planet min/max:''' Factor to apply to spawn chance of main planet locations based on the TL of the system.
* '''Extra planets min/max:''' Factor to apply to spawn chance of extra planet locations based on the TL of the system.
* '''Moons min/max:''' Factor to apply to spawn chance of moon locations based on the TL of the system.

The min value would be applied at the lowest TL, while the max value would apply to the highest TL. 
TL's in between would get a scaled value between min and max.

=== Transit costs ===
'''Values'''
* '''Fee:''' Base cost for a single trip (cr).
* '''Anarchy factor:''' Factor applied to fee in Anarchy systems
* '''Feudal factor:''' Factor applied to fee in Feudal systems.
* '''Multi-government factor:''' Factor applied to fee in Multi-Government systems.
* '''Dictatorship factor:''' Factor applied to fee in Dictatorship systems.
* '''Communist factor:''' Factor applied to fee in Communist systems.
* '''Confederacy factor:''' Factor applied to fee in Confederacy systems.
* '''Democracy factor:''' Factor applied to fee in Democracy systems.
* '''Corporate State factor:''' Factor applied to fee in Corporate State systems.

eg 0.0 = All trips are free; 1.0 = Use base cost; 0.5 = 50% of base cost.

=== Ship transfer costs ===
'''Values'''
* '''Fee:''' Base cost for ship transfer (cr).
* '''Anarchy factor:''' Factor applied to fee in Anarchy systems
* '''Feudal factor:''' Factor applied to fee in Feudal systems.
* '''Multi-government factor:''' Factor applied to fee in Multi-Government systems.
* '''Dictatorship factor:''' Factor applied to fee in Dictatorship systems.
* '''Communist factor:''' Factor applied to fee in Communist systems.
* '''Confederacy factor:''' Factor applied to fee in Confederacy systems.
* '''Democracy factor:''' Factor applied to fee in Democracy systems.
* '''Corporate State factor:''' Factor applied to fee in Corporate State systems.

eg 0.0 = Ship transfers are free; 1.0 = Use base cost; 1.5 = 150% base cost.

</div>

== Downloads ==
All components are downloadable through the in-game [[Expansions Manager]] 
Direct download here 
* [[Media:PlanetFall2_2.31.oxz|PlanetFall2_2.31.oxz]] (downloaded {{#downloads:PlanetFall2_2.31.oxz}} times).
* [[Media:PlanetFall2_ResourcesA.oxz|PlanetFall2_ResourcesA.oxz]] v1.1
* [[Media:PlanetFall2_ResourcesB.oxz|PlanetFall2_ResourcesB.oxz]] v1.0
* [[Media:Feudal_PlanetFall2_1.5.oxz|Feudal_PlanetFall2.oxz]] v1.5 (downloaded {{#downloads:Feudal_PlanetFall2_1.5.oxz}} times).
 
* [[Media:PlanetFall2_BlackMonks.oxz|PlanetFall2_BlackMonks.oxz]] v2.1 - Adds Bank of the Black Monks to the planet surface locations, providing all the normal bank facilities. The [[Black_Monk_Monastery|Bank of the Black Monks]] also needs to be installed.
* [[Media:PlanetFall2_HoopyCasino.oxz|PlanetFall2_HoopyCasino.oxz]] v2.5 - Adds HOopy casinos to the planet surface locations, complete with gaming opportunities. The [[HOopy_Casino|HOopy Casino OXP]] also needs to be installed.
* [[Media:PlanetFall2_Oo-Haul.oxz|PlanetFall2_Oo-Haul.oxz]] v2.1 - Adds an Oo-Haul distribution centre to the main planet, and a mission to escort a hauler from it out to either the witchpoint or constore. The [[Your_Ad_Here!|YAH/Your Ad Here!]] OXP and [[Oo-Haul]] need to be installed.

== License ==
*Author (PF v.2): [[User:Phkb|Phkb]]
*Author (PF v.1): [[User:Thargoid|Thargoid]]

This OXP is released under the Creative Commons Attribution - Non-Commercial - Share Alike 3.0 license with the following clauses:

* Whilst you are free (and encouraged) to re-use any of the scripting, models or texturing in this OXP, the usage must be distinct from that within this OXP. Unique identifiers such as (but not limited to) unique shipdata.plist entity keys, mission variables, script names (this.name), equipment identity strings (EQ_), description list arrays and entity roles must not be re-used without prior agreement. Basically if it's unique or would identify or overwrite anything in the original OXP, then you may not re-use it (for obvious compatibility reasons).
* rebundling of this OXP within another distribution is permitted as long as it is unchanged. The following derivates however are permitted and except from the above:
** the conversion of files between XML and openStep.
** the merging of files with other files of the same type from other OXPs.
* The license information (either as this file or merged into a larger one) must be included in the OXP.
* Even though it is not compulsory, if you are re-using any sizable or recognisable piece of this OXP, please let me know :)

---> (Details of images used) --->
<div class="mw-collapsible mw-collapsed" data-expandtext="Show gory details" data-collapsetext="Hide gory details" style="overflow:auto;">
'''Image files:''' 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_20850610.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21988050.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_23326348.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21988072.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_23326337.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21835246.htm Image by user6702303 on Freepik 
 
https://www.freepik.com/free-photo/blue-sky-with-scattered-white-clouds_12110221.htm Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22542965.htm Freepik 
https://www.freepik.com/free-photo/cloudy-sky-daylight-background_19380968.htm Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22543011.htm Freepik 
https://www.freepik.com/free-photo/blue-sky-with-cloud-closeup_6133056.htm Image by photogenia on Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22542943.htm Freepik 
https://www.freepik.com/free-vector/20-vehicles-outline-icon-presentation_38543743.htm Image by flatart on Freepik 
 
https://www.freepik.com/free-ai-image/subway-dark-atmosphere_76653967.htm Image by freepik 
https://www.freepik.com/free-ai-image/new-york-city-subway-train-motion_69844323.htm Image by freepik 
https://www.freepik.com/free-photo/motion-blur-automatic-train-moving-inside-tunnel-tokyo-japan_10824408.htm Image by tawatchai07 on Freepik 
 
</div>
Some images were generated by AI at https://www.freepik.com/pikaso/ai-image-generator 

'''Sound files:''' 
"e train 140kmh 04 190613_0029.wav" by klankbeeld -- https://freesound.org/s/476298/ -- License: Attribution 4.0 
"Arrival of a passenger electric train.1950km station_2(Eq,lmtr).wav" by newlocknew -- https://freesound.org/s/580464/ -- License: Attribution 4.0 

== Version History ==
2.31
* Added GNN interface to some planetary surface locations.
* Fixed null reference error that could occur during transits.
* Added screenID's to all mission screens.
* Speed of the landing FX now scales with system performance.
* Switched to using logcontrol.plist for debug output.

2.30
* Changed manifest title from "PlanetFall" to "PlanetFall2".
* Changed Library Config aliases to "PlanetFall2".
* Changed category to "Systems".
* Fixed issue with adding OXP locations to custom systems, where some keys were being added to the list twice.

2.29
* Shuttles that choose to land on a planet will now do so at one of the landing sites.
* Shuttles will also launch from the landing sites.

2.28
* Fixed method of detecting when two landing sites are too close together.
* Changed calculation method for positioning landing sites to ensure good separation from others.

2.27
* Fixed issue where stored names were not being restored from missionVariables reliably.
* Fixed issue with naming system for Oo-Haul sites, which wasn't including "(Distribution Centre)" in the name.
* Fixed issue with naming HOopy Casino sites, which wasn't including "(HOopy Casino)" in the name.
* OXP planet locations defined via the ship role "planetFall2_???_externalOXP" are now attempted to be added to custom systems. Random factors and spawn conditions can then come in to play to limit the number of spawns.

2.26
* Darkened overlay images for better compatibility with Oolite 1.92.

2.25
* Moved more text into missiontext.plist.
* Fixed issue with ship transfer fee not being calculated correctly when being deducted from the players account.

2.24
* Added check for, and warning message of, PlanetLand OXP conflict.

2.23
* Fixed issue where shipyards were not viewable on stations that have overridden the "move shipyards to planet" option.

2.22
* Display a message when attempting to access shipyards on stations when they are located on planetary surfaces.
* Added option to disable the shallow approach angle requirement when landing on a surface location.
* Tweaked spawning logic so planetary locations can't be too close together, increasing the distance from the previous fix.

2.21
* Change to manifest file to match with split of resources pack into two.

2.20
* Added a function, $getSystemLocations, which returns an object containing the ship keys and place names of all planetary locations in a given system.

2.19
* Setting beacon range to zero will make all beacons visible all the time.
* Added ability to scale the maximum turbulence factor per planet.

<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">
2.18
* Added a "turbulence impact scale" option so the effect of turbulence can be scaled to taste.
* Allowed for blank entries in location overrides to switch to randomised location types and naming.
* Fixed issues when checking roles to determine the type of VFX to show for landing.
* Added ability to override the landing clouds, docks and overlays on a per-planet basis.
* Some code refactoring.

2.17
* Moved most text into missiontext.plist for easier localisation.
* Removed monkey patch on Marker Inquirer as no longer required.

2.16
* Tweak to prevent LMSS and Laser Arrangement interfaces disappearing on non-PlanetFall locations.

2.15
* Increased the number of shipdata entities to better handle high values for the number of planetary landing points.

2.14
* Added protection for instances where a planet or moon has no air color value set.
* Fixed issue where the reason for the denial of a landing request was not being transmitted to the player.

2.13
* Further fixes to linkage between landing sites and planets.

2.12
* Fixed incorrect property setting in shipdata.
* Changed allegiance setting for research complexes to be neutral.
* Fixed issue where landing sites could spawn too close together.

2.11
* Fixed issue where link between landing sites and planets could occasionally break due to rounding errors.

2.10
* Prevented things like "Immigration Control" from appearing in Anarchy systems.
* Prevented turbulence frame callback from being started twice.
* Fixed error: this.serviceLevelDecrease is not a function.
* Tweaks to hopefully permanently fix issue where turbulence effect keeps running after a witchspace jump or docking.

2.9
* Fixed JS error in transit process code.
* Fixed issue where Vimana-X HUD was not resetting correctly on launch after using transit system.

2.8
* Split off planet rotation slowing into separate OXP, and made optional for this OXP.

2.7
* Dying while turbulence is active will now stop the frame callback.
* Added tweak to planet rotation when approaching planet, slowing it down to make scale issues less obvious (can be configured with Library Config).
* Code refactoring.

2.6
* Small tweak to the market script.
* Small fix to the name generation process for Capital Cities.

2.5
* Refined some text in messages for better understanding and integration with the built in voice.
* Added a pre-spawn check for a condition script on custom (ie non-built-in) surface locations.
* Fixed issue that was preventing custom names from being applied to custom system setups.
* Added a PDF document outlining how to create custom systems, for non-coders.
* Updates for the PlanetFall Oo-haul mission pack.
* Added conflict with PlanetFallMarketSaver - this OXP shouldn't be necessary with PlanetFall2.
* Added conflict with PlanetFall Markets - this OXP shouldn't be necessary with PlanetFall2.
* Removed some unused settings in config.
* Split off graphical assets into separate OXP, to make updating the core code easier for everyone.
* Added a second train FX image, so that the second animation doesn't just look completely like the first.
* Tweaked train FX images to make them more centred.
* Added scan class to station entities.

2.4
* Adjusted calculations to make landing when pointing at the GCIP more consistent.

2.3
* Added a planet-side transit system, so you don't have to launch and re-dock to visit another landing site on the same planet.
* Transit costs are adjusted based on government types. Configurable via Library Config.
* Ship transfer costs are adjusted based on government types. Configurable via Library Config.
* Fixed shipyard transfer process to not run more than once per system.
* Added fragment and vertex shaders to ensure all break patterns appear clearly and without shadow.
* Removed yaw turbulence factor. Only pitch and roll turbulence will be now be set.
* Fixed issue that was preventing subSurface colonies and moonSurface domes from being spawned.
* Amount of reduction to service level is now configurable via Library Config.
* Added a function (PlanetFall2.playerShipIsLocal) that can be called to determine if the player is near their ship or not.
* Removed the Blackmonks and HoOpy Casino config options, and incorporated spawn chances in script_info object of shipdata and condition script.

2.2
* Fixed issue where, if "Additional Planets" doesn't create any planets, no landing sites are created on the main planet.
* Reapplied monkey match for Market Inquirer to address issue with beacons not showing when more than 100000m from the player when docked.
* Removed conflicts with SW Planetary Systems and Moons, although it is unlikely any created moons will get landing sites.

2.1
* Added methods to allow for a fully customised system to be defined (with multiple sites per planet/moon).
* Moved Feudal States override code into a separate OXP.
* Fixed missing semi-colon in shipdata.plist.
* Switched ground control interface point to be a normal ship object (rather than a visual effect) to gain better compatibility with OXP's like Telescope.
* Made the ground control interface points more visible.
* Reduced the number of monkey patches required.
* Made the maximum range at which the space compass will detect ground control interface points configurable via Library Config, and changed the default value to 200km.
* Added some conflict oxps ("Planetary Systems" and "Moons" by stranger).
* Improved compatibility with Market Inquirer.
* Tweaked spawning methods to better reflect the original PlanetFall results, where OXP station roles are not added unless override flag is set.
* Added a warning screen for players, informing them that ship maintenance services are only available on the planet.
* Added a chance of a misjump when executing a witchspace jump inside the atmosphere.
* Fixed issue where entering witchspace while the turbulence effect is still active would result in it staying active.
* Fixed bug that was setting service level to the minimum value when launching from a planetary location.
* Turbulence now doesn't end when speed is zero.
* Added a config item to manage how much the service level of the player ship is reduced.
* Added shipdata entries to allow for multiple military bases, leisure complexes, factories and dumps on the main planet in custom systems.
* Fixed issues where NaN, NaN, Nan is calculated for a vector.
* Log messages now controllable via a debug flag.
* Removed some unused code.

2.0
* Updated landing FX, with clouds and landing pads.
* Updated launching FX.
* Changed docking method to have a fixed location (rather than just descending towards the planet surface anywhere), which means you can now save your game at planetary locations.
* Access to equipment sales (F3 Equip Ship) configuration via Library Config.
* Updated market information to allow for 3 different methods to be applied to any of the locations. (Configurable via Library Config)
* Added a variety of arrival report screen backgrounds. (Can be turned off via Library Config)
* Added a turbulence effect when in the atmosphere of a planet. (Can be turned off via Library Config)
* Equipment item renamed to "Atmospheric Stabilisers", but is optional for planetary landings.
* Moved ships from shipyards on other stations to planetary locations. (Configurable via Library Config)
* Moved "Maintenance Overhaul" to only be available on the main planet. (Configurable via Library Config)
* Added script updates to Feudal Systems, Aquatics, Market Inquirer, Galactic Almanac and In-System cargo delivery to maintain compatibility.
* Additional compatibility settings updated via shipdata-overrides.plist.
</div>

== The Dark Side ==
=== Custom designing a system ===
You can now custom design a system:
:specifically naming landing sites (see inside Lave.oxp)
:adding tweaks for entering the atmosphere: storms, haze, colours, and [[OXP_howto_texture#Planet_textures|city night-lights]] (see inside Famous Planets v.3 & see inside Lave.oxp)
:tweaking landing: images and haze ((see inside DGill's newest Feudal Systems suite & Famous Planets v.3)
:tweaking the space port "experience": things to do (see inside DGill's newest Feudal Systems suite)

To tweak a system see the "Creating Custom Systems.pdf" & the "Developer's ReadMe" hidden inside the oxp and then also the example [https://app.box.com/s/5xbksy48qr9cp31z2wpef6wjla05s3ih/file/1505969925081 SuperSystem.oxp]
:There is more detail [https://bb.oolite.space/viewtopic.php?p=301011#p301011 here] (runs on for several pages) and [https://bb.oolite.space/viewtopic.php?p=301065#p301065 here]

=== Problems with the Oolite game engine ===
*Planets were never meant to be interacted with in Oolite - there's a lot of hand-waving going on with PF2 when it comes to landing on the surface. [https://bb.oolite.space/viewtopic.php?p=301396#p301396 Phkb (2025)]
*The Oolite game engine does support larger planets and stars - I put together an OXP a while ago which uses them - but not necessarily particularly well. (Editor: [[SOTL Altmap]]? [[SOTL Exploration]]?) 
:You would have noticeable "corners" on the planets at 'real-world' sizes, as a 20,000 triangle polygon gets too large. You can already see these if you go as low as you can on a planet and look at the horizon. Similarly, the way planet texturing works would need to be significantly changed to avoid pixels tens of kilometres wide. There are display issues with large stars at high distances. There's a bit of a hack in the display code to avoid the worst of it, but there can still be strange issues with which objects are displayed in front of which. (You would probably need a higher Open GL version to solve these, which may or may not be practical to hide behind a graphics setting toggle) [https://bb.oolite.space/viewtopic.php?p=263420#p263420 Cim (2018)]

== Links ==
*[https://bb.oolite.space/viewtopic.php?t=21606 BB thread] (2024)
*[[Planetfall OXP]] PF v.1 original wiki page

== Quick Facts ==
{{OXPLevel|0|2}}{{IconOXP|ooVersion="1.90"|oxpCPU="Average"|oxpMEM="Low"|oxpGPU="Average"|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
{{Infobox OXPb| title = PlanetFall2.oxz
|version = 2.31
|release = 2026-05-07
|license = CC BY-NC-SA 3.0
|features = Planetary landings
|category = Systems OXPs
|author = [[User:Thargoid|Thargoid]], [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?t=21606 Oolite BB]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-orange.png|right]]
By default, planetary landings are harder than they were in V1. However, if you don't land on or approach planets, gameplay is largely unaffected (or it can be).

Planetfall2 OXP

2026-05-07T02:44:11Z

Phkb: /* Downloads */

[[Image:IconPF2.png|100px|right]]
[[File:PlanetFall2 city 7.png|300px|thumb|right|Landing at a city]]
[[File:PlanetFall2 moon 5.png|300px|thumb|right|Landing on a moon]]
== Overview ==
{{Infobox EquipStats Oolite| title = PlanetFall2 OXP
|image =
|equipName = Atmospheric Stabilisers
|equipCost = 5,000₢
|equipTL = 9
}}
An OXP which allows the Commander to land at specific locations on planets and moons (but not suns, even at night). Each main planet has up to 5 designated landing sites, while additional planets can have 3, and each moon can have 2 (configurable via [[Library OXP|Library Config]]). Pick your landing site and point your ship at the flashing marker near the surface that indicates the Ground Control Interface Point for the landing zone. Ensure your flight path is not too steep, otherwise you may sustain damage when the automated landing protocol engages.

Be careful of turbulence as you enter the atmosphere. To assist with atmospheric turbulence, the "Atmospheric Stabilisers" can be purchased at any TL9+ system for 5000cr. When equipped, this will reduce the impact of turbulence on your ship. Speed will have an impact on how much your ship is effected by turbulence. Slowing down will decrease the effect.

Your approach will trigger an automatic landing request. You should receive a response after a few seconds, indicating you are either cleared for landing or not. If you have clearance, continue towards the Ground Control Interface Point at less than 100 m/s until the automated system engages, captures your ship and lowers you to a landing pad.

Planetary take-off is via a launch booster, with control being returned to the Commander once orbital insertion is achieved.

=== A suite of OXPs ===
This OXP is currently a suite of 2 OXPs with another 2 optional OXPs:
*'''PlanetFall2''' (the coding)
*'''PlanetFall Resources''' (the individual planetary images)

*Optional: '''Feudal PlanetFall2''' (linking PlanetFall2 with [[Feudal States]] which is currently the only OXP which does much on the planet surface).
:<s>At time of writing PlanetFall2 is only compatible with Feudal States v.1 (and the ''alpha'' Feudal States v.2 is only compatible with PlanetFall v.1)!</s> It should now be compatible with both versions of Feudal States.
*Optional: [[Planet Rotation Cosmetics OXP]] slows down the planet's rotation as you approach it and are captured by the planet's gravity.

[[File:Planetfall2 Transit system.png|right|300px]]

=== Gaming changes from Thargoid's PlanetFall v1 (2008-13) ===
*You can now land on a planet without purchasing "planetary landing capabilities"/"atmospheric stabilisers" - but it is rather more dangerous
::If you have already bought "planetary landing capabilities", PF2 will convert them to "atmospheric stabilisers"
*There are now specific landing sites on the planet
*Commodity Markets are now included (''ie'' PlanetFall Markets OXP is redundant).
*When landed you can transit from one landing site to another (and pay good money to transit your ship, too!).
*[[Maintenance]] overhauls are now performed on the planet surface rather than in the orbital station (they will tell you this on the station!)
*There are other changes to be discovered!

== Requirements ==
*Oolite v.1.90 or better
*[[GNN]]
*[[Library OXP]]
*[[Market Script Interface]]
*[[External Docking System]]

While it isn’t a requirement, the [[Planet Rotation Cosmetics OXP]] is a highly recommended addition for PlanetFall 2.

== Options ==
There are a '''lot''' of options available to help configure the system the way you want it. The list is long, so if you want to see everything, ''click'' the link on the right.
<div class="mw-collapsible mw-collapsed" data-expandtext="Show me everything!" data-collapsetext="Turn it off! Turn it off!" style="overflow:auto;">
Library Config has the following sections for PlanetFall2:
* General settings
* Main planet settings
** F3/F8 access
** Spawn chances
* Extra Planet settings
** F3/F8 access
** Spawn chances
* Moon settings
** F3/F8 access
** Spawn chances
* Spawn chances: TL factors
* Transit costs
* Ship transfer costs

=== General settings ===
'''Flags'''
* '''Move shipyards to planet:''' Controls whether shipyards are moved to planet-side locations.
* '''Move maintenance to planet:''' Controls whether the "Maintenance Overhaul" item is moved to only be offered on planet-side locations.
* '''Atmosphere turbulence:''' Controls whether the turbulence effect, when entering the atmosphere of a planet, is active or not.
* '''Shallow approach:''' Controls whether a shallow approach angle is required when landing on a surface location.
* '''Use landing images:''' Controls whether the images displayed after landing at a planetary site are displayed.
* '''Use Almanac names:''' Controls whether the names of planetary locations are given names based on the methodology from the Galactic Almanac.
* '''Allow planetary transit:''' Controls whether it is possible to fast travel to other planetary sites after landing.

'''Values'''
* '''Main planet max:''' Maximum number of locations that could be spawned on the main planet.
* '''Extra planet max:''' Maximum number of locations that could be spawned on a secondary planet with an atmosphere.
* '''Moon max:''' Maximum number of locations that could be spawned on a moon with no atmosphere.
* '''Atmosphere max altitude:''' Maximum height (in km) of the atmosphere of a planet.
* '''Beacon range:''' Max distance (in km) that planetary beacons become visible to the player.
* '''Service Level dec:''' Amount that service level will be reduced by when launching from a planet.
* '''Transfer Time:''' Amount of time (in hours) that will pass when transferring player ship to the current location.
* '''Train speed:''' Base average speed of trains (in kph), which is scaled up or down based on the TL of the system.
* '''Turbulence impact scale:''' Scales the impact of turbulence, where 1.0 means no change to the default, 0.5 halves the impact, and 0.0 means no impact (same as turning turbulence off).

=== Main planet settings ===
==== F3/F8 Access ====
'''Flags'''
* '''Capital cities:''' Whether capital cities will have access to the F3 Equip Ship screen.
* '''Military bases:''' Whether military bases will have access to the F3 Equip Ship screen.
* '''Leisure complexes:''' Whether leisure complexes will have access to the F3 Equip Ship screen.
* '''Factories:''' Whether factories will have access to the F3 Equip Ship screen.
* '''Rubbish dumps:''' Whether rubbish dumps will have access to the F3 Equip Ship screen.

'''Values'''
* '''Capital cities:''' What type of market will be available at capital cities.
* '''Military bases:''' What type of market will be available at military bases.
* '''Leisure complexes:''' What type of market will be available at military bases.
* '''Factories:''' What type of market will be available at factories.
* '''Rubbish dumps:''' What type of market will be available at rubbish dumps.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51. (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn city:''' Chance of spawning a capital city.
* '''Spawn military base:''' Chance of spawning a military base.
* '''Spawn leisure complex:''' Chance of spawning a leisure complex.
* '''Spawn factory:''' Chance of spawning a factory.
* '''Spawn rubbish dump:''' Chance of spawning a rubbish dump.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Extra planet Settings ===
==== F3/F8 Access ====
'''Flags'''
* '''Colony cities:''' Whether colony cities will have access to the F3 Equip Ship screen.
* '''Military bases:''' Whether military bases will have access to the F3 Equip Ship screen.
* '''Leisure complexes:''' Whether leisure complexes will have access to the F3 Equip Ship screen.
* '''Factories:''' Whether factories will have access to the F3 Equip Ship screen.
* '''Rubbish dumps:''' Whether rubbish dumps will have access to the F3 Equip Ship screen.

'''Values'''
* '''Colony cities:''' What type of market will be available at colony cities.
* '''Military bases:''' What type of market will be available at military bases.
* '''Leisure complexes:''' What type of market will be available at leisure complexes.
* '''Factories:''' What type of market will be available at factories.
* '''Rubbish dumps:''' What type of market will be available at rubbish dumps.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51 (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn colony city:''' Chance of spawning a colony city.
* '''Spawn military base:''' Chance of spawning a military base.
* '''Spawn leisure complex:''' Chance of spawning a leisure complex.
* '''Spawn factory:''' Chance of spawning a factory.
* '''Spawn rubbish dump:''' Chance of spawning a rubbish dump.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Moons ===
==== F3/F8 Access ====
'''Flags'''
* '''Colony domes:''' Whether colony domes will have access to the F3 Equip Ship screen.
* '''Mines:''' Whether mines will have access to the F3 Equip Ship screen.
* '''Prisons:''' Whether prisons will have access to the F3 Equip Ship screen.
* '''Leisure domes:''' Whether leisure domes will have access to the F3 Equip Ship screen.
* '''Robot factories:''' Whether robot factories will have access to the F3 Equip Ship screen.
* '''Research complexes:''' Whether research complexes will have access to the F3 Equip Ship screen.
* '''Wastelands:''' Whether wastelands will have access to the F3 Equip Ship screen.

'''Values'''
* '''Colony domes:''' What type of market will be available at colony domes.
* '''Mines:''' What type of market will be available at mines.
* '''Prison:''' What type of market will be available at prisons.
* '''Leisure domes:''' What type of market will be available at leisure domes.
* '''Robot factories:''' What type of market will be available at robot factories.
* '''Research complexes:''' What type of market will be available at research complexes.
* '''Wastelands:''' What type of market will be available at wastelands.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51 (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn colony dome:''' Chance of spawning a colony dome.
* '''Spawn mine:''' Chance of spawning a mine.
* '''Spawn prison:''' Chance of spawning a prison.
* '''Spawn leisure dome:''' Chance of spawning a leisure dome.
* '''Spawn robot factory:''' Chance of spawning a robot factory.
* '''Spawn research complex:''' Chance of spawning a research complex.
* '''Spawn wasteland:''' Chance of spawning a wasteland.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Spawn chances: TL factors ===
'''Values'''
* '''Main planet min/max:''' Factor to apply to spawn chance of main planet locations based on the TL of the system.
* '''Extra planets min/max:''' Factor to apply to spawn chance of extra planet locations based on the TL of the system.
* '''Moons min/max:''' Factor to apply to spawn chance of moon locations based on the TL of the system.

The min value would be applied at the lowest TL, while the max value would apply to the highest TL. 
TL's in between would get a scaled value between min and max.

=== Transit costs ===
'''Values'''
* '''Fee:''' Base cost for a single trip (cr).
* '''Anarchy factor:''' Factor applied to fee in Anarchy systems
* '''Feudal factor:''' Factor applied to fee in Feudal systems.
* '''Multi-government factor:''' Factor applied to fee in Multi-Government systems.
* '''Dictatorship factor:''' Factor applied to fee in Dictatorship systems.
* '''Communist factor:''' Factor applied to fee in Communist systems.
* '''Confederacy factor:''' Factor applied to fee in Confederacy systems.
* '''Democracy factor:''' Factor applied to fee in Democracy systems.
* '''Corporate State factor:''' Factor applied to fee in Corporate State systems.

eg 0.0 = All trips are free; 1.0 = Use base cost; 0.5 = 50% of base cost.

=== Ship transfer costs ===
'''Values'''
* '''Fee:''' Base cost for ship transfer (cr).
* '''Anarchy factor:''' Factor applied to fee in Anarchy systems
* '''Feudal factor:''' Factor applied to fee in Feudal systems.
* '''Multi-government factor:''' Factor applied to fee in Multi-Government systems.
* '''Dictatorship factor:''' Factor applied to fee in Dictatorship systems.
* '''Communist factor:''' Factor applied to fee in Communist systems.
* '''Confederacy factor:''' Factor applied to fee in Confederacy systems.
* '''Democracy factor:''' Factor applied to fee in Democracy systems.
* '''Corporate State factor:''' Factor applied to fee in Corporate State systems.

eg 0.0 = Ship transfers are free; 1.0 = Use base cost; 1.5 = 150% base cost.

</div>

== Downloads ==
All components are downloadable through the in-game [[Expansions Manager]] 
Direct download here 
* [[Media:PlanetFall2_2.31.oxz|PlanetFall2_2.31.oxz]] (downloaded {{#downloads:PlanetFall2_2.31.oxz}} times).
* [[Media:PlanetFall2_ResourcesA.oxz|PlanetFall2_ResourcesA.oxz]] v1.1
* [[Media:PlanetFall2_ResourcesB.oxz|PlanetFall2_ResourcesB.oxz]] v1.0
* [[Media:Feudal_PlanetFall2_1.5.oxz|Feudal_PlanetFall2.oxz]] v1.5 (downloaded {{#downloads:Feudal_PlanetFall2_1.5.oxz}} times).
 
* [[Media:PlanetFall2_BlackMonks.oxz|PlanetFall2_BlackMonks.oxz]] v2.1 - Adds Bank of the Black Monks to the planet surface locations, providing all the normal bank facilities. The [[Black_Monk_Monastery|Bank of the Black Monks]] also needs to be installed.
* [[Media:PlanetFall2_HoopyCasino.oxz|PlanetFall2_HoopyCasino.oxz]] v2.5 - Adds HOopy casinos to the planet surface locations, complete with gaming opportunities. The [[HOopy_Casino|HOopy Casino OXP]] also needs to be installed.
* [[Media:PlanetFall2_Oo-Haul.oxz|PlanetFall2_Oo-Haul.oxz]] v2.1 - Adds an Oo-Haul distribution centre to the main planet, and a mission to escort a hauler from it out to either the witchpoint or constore. The [[Your_Ad_Here!|YAH/Your Ad Here!]] OXP and [[Oo-Haul]] need to be installed.

== License ==
*Author (PF v.2): [[User:Phkb|Phkb]]
*Author (PF v.1): [[User:Thargoid|Thargoid]]

This OXP is released under the Creative Commons Attribution - Non-Commercial - Share Alike 3.0 license with the following clauses:

* Whilst you are free (and encouraged) to re-use any of the scripting, models or texturing in this OXP, the usage must be distinct from that within this OXP. Unique identifiers such as (but not limited to) unique shipdata.plist entity keys, mission variables, script names (this.name), equipment identity strings (EQ_), description list arrays and entity roles must not be re-used without prior agreement. Basically if it's unique or would identify or overwrite anything in the original OXP, then you may not re-use it (for obvious compatibility reasons).
* rebundling of this OXP within another distribution is permitted as long as it is unchanged. The following derivates however are permitted and except from the above:
** the conversion of files between XML and openStep.
** the merging of files with other files of the same type from other OXPs.
* The license information (either as this file or merged into a larger one) must be included in the OXP.
* Even though it is not compulsory, if you are re-using any sizable or recognisable piece of this OXP, please let me know :)

---> (Details of images used) --->
<div class="mw-collapsible mw-collapsed" data-expandtext="Show gory details" data-collapsetext="Hide gory details" style="overflow:auto;">
'''Image files:''' 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_20850610.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21988050.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_23326348.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21988072.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_23326337.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21835246.htm Image by user6702303 on Freepik 
 
https://www.freepik.com/free-photo/blue-sky-with-scattered-white-clouds_12110221.htm Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22542965.htm Freepik 
https://www.freepik.com/free-photo/cloudy-sky-daylight-background_19380968.htm Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22543011.htm Freepik 
https://www.freepik.com/free-photo/blue-sky-with-cloud-closeup_6133056.htm Image by photogenia on Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22542943.htm Freepik 
https://www.freepik.com/free-vector/20-vehicles-outline-icon-presentation_38543743.htm Image by flatart on Freepik 
 
https://www.freepik.com/free-ai-image/subway-dark-atmosphere_76653967.htm Image by freepik 
https://www.freepik.com/free-ai-image/new-york-city-subway-train-motion_69844323.htm Image by freepik 
https://www.freepik.com/free-photo/motion-blur-automatic-train-moving-inside-tunnel-tokyo-japan_10824408.htm Image by tawatchai07 on Freepik 
 
</div>
Some images were generated by AI at https://www.freepik.com/pikaso/ai-image-generator 

'''Sound files:''' 
"e train 140kmh 04 190613_0029.wav" by klankbeeld -- https://freesound.org/s/476298/ -- License: Attribution 4.0 
"Arrival of a passenger electric train.1950km station_2(Eq,lmtr).wav" by newlocknew -- https://freesound.org/s/580464/ -- License: Attribution 4.0 

== Version History ==
2.31
* Added GNN interface to some planetary surface locations.
* Fixed null reference error that could occur during transits.
* Added screenID's to all mission screens.
* Speed of the landing FX now scales with system performance.
* Switched to using logcontrol.plist for debug output.

2.30
* Changed manifest title from "PlanetFall" to "PlanetFall2".
* Changed Library Config aliases to "PlanetFall2".
* Changed category to "Systems".
* Fixed issue with adding OXP locations to custom systems, where some keys were being added to the list twice.

2.29
* Shuttles that choose to land on a planet will now do so at one of the landing sites.
* Shuttles will also launch from the landing sites.

2.28
* Fixed method of detecting when two landing sites are too close together.
* Changed calculation method for positioning landing sites to ensure good separation from others.

2.27
* Fixed issue where stored names were not being restored from missionVariables reliably.
* Fixed issue with naming system for Oo-Haul sites, which wasn't including "(Distribution Centre)" in the name.
* Fixed issue with naming HOopy Casino sites, which wasn't including "(HOopy Casino)" in the name.
* OXP planet locations defined via the ship role "planetFall2_???_externalOXP" are now attempted to be added to custom systems. Random factors and spawn conditions can then come in to play to limit the number of spawns.

2.26
* Darkened overlay images for better compatibility with Oolite 1.92.

2.25
* Moved more text into missiontext.plist.
* Fixed issue with ship transfer fee not being calculated correctly when being deducted from the players account.

2.24
* Added check for, and warning message of, PlanetLand OXP conflict.

2.23
* Fixed issue where shipyards were not viewable on stations that have overridden the "move shipyards to planet" option.

2.22
* Display a message when attempting to access shipyards on stations when they are located on planetary surfaces.
* Added option to disable the shallow approach angle requirement when landing on a surface location.
* Tweaked spawning logic so planetary locations can't be too close together, increasing the distance from the previous fix.

2.21
* Change to manifest file to match with split of resources pack into two.

2.20
* Added a function, $getSystemLocations, which returns an object containing the ship keys and place names of all planetary locations in a given system.

2.19
* Setting beacon range to zero will make all beacons visible all the time.
* Added ability to scale the maximum turbulence factor per planet.

<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">
2.18
* Added a "turbulence impact scale" option so the effect of turbulence can be scaled to taste.
* Allowed for blank entries in location overrides to switch to randomised location types and naming.
* Fixed issues when checking roles to determine the type of VFX to show for landing.
* Added ability to override the landing clouds, docks and overlays on a per-planet basis.
* Some code refactoring.

2.17
* Moved most text into missiontext.plist for easier localisation.
* Removed monkey patch on Marker Inquirer as no longer required.

2.16
* Tweak to prevent LMSS and Laser Arrangement interfaces disappearing on non-PlanetFall locations.

2.15
* Increased the number of shipdata entities to better handle high values for the number of planetary landing points.

2.14
* Added protection for instances where a planet or moon has no air color value set.
* Fixed issue where the reason for the denial of a landing request was not being transmitted to the player.

2.13
* Further fixes to linkage between landing sites and planets.

2.12
* Fixed incorrect property setting in shipdata.
* Changed allegiance setting for research complexes to be neutral.
* Fixed issue where landing sites could spawn too close together.

2.11
* Fixed issue where link between landing sites and planets could occasionally break due to rounding errors.

2.10
* Prevented things like "Immigration Control" from appearing in Anarchy systems.
* Prevented turbulence frame callback from being started twice.
* Fixed error: this.serviceLevelDecrease is not a function.
* Tweaks to hopefully permanently fix issue where turbulence effect keeps running after a witchspace jump or docking.

2.9
* Fixed JS error in transit process code.
* Fixed issue where Vimana-X HUD was not resetting correctly on launch after using transit system.

2.8
* Split off planet rotation slowing into separate OXP, and made optional for this OXP.

2.7
* Dying while turbulence is active will now stop the frame callback.
* Added tweak to planet rotation when approaching planet, slowing it down to make scale issues less obvious (can be configured with Library Config).
* Code refactoring.

2.6
* Small tweak to the market script.
* Small fix to the name generation process for Capital Cities.

2.5
* Refined some text in messages for better understanding and integration with the built in voice.
* Added a pre-spawn check for a condition script on custom (ie non-built-in) surface locations.
* Fixed issue that was preventing custom names from being applied to custom system setups.
* Added a PDF document outlining how to create custom systems, for non-coders.
* Updates for the PlanetFall Oo-haul mission pack.
* Added conflict with PlanetFallMarketSaver - this OXP shouldn't be necessary with PlanetFall2.
* Added conflict with PlanetFall Markets - this OXP shouldn't be necessary with PlanetFall2.
* Removed some unused settings in config.
* Split off graphical assets into separate OXP, to make updating the core code easier for everyone.
* Added a second train FX image, so that the second animation doesn't just look completely like the first.
* Tweaked train FX images to make them more centred.
* Added scan class to station entities.

2.4
* Adjusted calculations to make landing when pointing at the GCIP more consistent.

2.3
* Added a planet-side transit system, so you don't have to launch and re-dock to visit another landing site on the same planet.
* Transit costs are adjusted based on government types. Configurable via Library Config.
* Ship transfer costs are adjusted based on government types. Configurable via Library Config.
* Fixed shipyard transfer process to not run more than once per system.
* Added fragment and vertex shaders to ensure all break patterns appear clearly and without shadow.
* Removed yaw turbulence factor. Only pitch and roll turbulence will be now be set.
* Fixed issue that was preventing subSurface colonies and moonSurface domes from being spawned.
* Amount of reduction to service level is now configurable via Library Config.
* Added a function (PlanetFall2.playerShipIsLocal) that can be called to determine if the player is near their ship or not.
* Removed the Blackmonks and HoOpy Casino config options, and incorporated spawn chances in script_info object of shipdata and condition script.

2.2
* Fixed issue where, if "Additional Planets" doesn't create any planets, no landing sites are created on the main planet.
* Reapplied monkey match for Market Inquirer to address issue with beacons not showing when more than 100000m from the player when docked.
* Removed conflicts with SW Planetary Systems and Moons, although it is unlikely any created moons will get landing sites.

2.1
* Added methods to allow for a fully customised system to be defined (with multiple sites per planet/moon).
* Moved Feudal States override code into a separate OXP.
* Fixed missing semi-colon in shipdata.plist.
* Switched ground control interface point to be a normal ship object (rather than a visual effect) to gain better compatibility with OXP's like Telescope.
* Made the ground control interface points more visible.
* Reduced the number of monkey patches required.
* Made the maximum range at which the space compass will detect ground control interface points configurable via Library Config, and changed the default value to 200km.
* Added some conflict oxps ("Planetary Systems" and "Moons" by stranger).
* Improved compatibility with Market Inquirer.
* Tweaked spawning methods to better reflect the original PlanetFall results, where OXP station roles are not added unless override flag is set.
* Added a warning screen for players, informing them that ship maintenance services are only available on the planet.
* Added a chance of a misjump when executing a witchspace jump inside the atmosphere.
* Fixed issue where entering witchspace while the turbulence effect is still active would result in it staying active.
* Fixed bug that was setting service level to the minimum value when launching from a planetary location.
* Turbulence now doesn't end when speed is zero.
* Added a config item to manage how much the service level of the player ship is reduced.
* Added shipdata entries to allow for multiple military bases, leisure complexes, factories and dumps on the main planet in custom systems.
* Fixed issues where NaN, NaN, Nan is calculated for a vector.
* Log messages now controllable via a debug flag.
* Removed some unused code.

2.0
* Updated landing FX, with clouds and landing pads.
* Updated launching FX.
* Changed docking method to have a fixed location (rather than just descending towards the planet surface anywhere), which means you can now save your game at planetary locations.
* Access to equipment sales (F3 Equip Ship) configuration via Library Config.
* Updated market information to allow for 3 different methods to be applied to any of the locations. (Configurable via Library Config)
* Added a variety of arrival report screen backgrounds. (Can be turned off via Library Config)
* Added a turbulence effect when in the atmosphere of a planet. (Can be turned off via Library Config)
* Equipment item renamed to "Atmospheric Stabilisers", but is optional for planetary landings.
* Moved ships from shipyards on other stations to planetary locations. (Configurable via Library Config)
* Moved "Maintenance Overhaul" to only be available on the main planet. (Configurable via Library Config)
* Added script updates to Feudal Systems, Aquatics, Market Inquirer, Galactic Almanac and In-System cargo delivery to maintain compatibility.
* Additional compatibility settings updated via shipdata-overrides.plist.
</div>

== The Dark Side ==
=== Custom designing a system ===
You can now custom design a system:
:specifically naming landing sites (see inside Lave.oxp)
:adding tweaks for entering the atmosphere: storms, haze, colours, and [[OXP_howto_texture#Planet_textures|city night-lights]] (see inside Famous Planets v.3 & see inside Lave.oxp)
:tweaking landing: images and haze ((see inside DGill's newest Feudal Systems suite & Famous Planets v.3)
:tweaking the space port "experience": things to do (see inside DGill's newest Feudal Systems suite)

To tweak a system see the "Creating Custom Systems.pdf" & the "Developer's ReadMe" hidden inside the oxp and then also the example [https://app.box.com/s/5xbksy48qr9cp31z2wpef6wjla05s3ih/file/1505969925081 SuperSystem.oxp]
:There is more detail [https://bb.oolite.space/viewtopic.php?p=301011#p301011 here] (runs on for several pages) and [https://bb.oolite.space/viewtopic.php?p=301065#p301065 here]

=== Problems with the Oolite game engine ===
*Planets were never meant to be interacted with in Oolite - there's a lot of hand-waving going on with PF2 when it comes to landing on the surface. [https://bb.oolite.space/viewtopic.php?p=301396#p301396 Phkb (2025)]
*The Oolite game engine does support larger planets and stars - I put together an OXP a while ago which uses them - but not necessarily particularly well. (Editor: [[SOTL Altmap]]? [[SOTL Exploration]]?) 
:You would have noticeable "corners" on the planets at 'real-world' sizes, as a 20,000 triangle polygon gets too large. You can already see these if you go as low as you can on a planet and look at the horizon. Similarly, the way planet texturing works would need to be significantly changed to avoid pixels tens of kilometres wide. There are display issues with large stars at high distances. There's a bit of a hack in the display code to avoid the worst of it, but there can still be strange issues with which objects are displayed in front of which. (You would probably need a higher Open GL version to solve these, which may or may not be practical to hide behind a graphics setting toggle) [https://bb.oolite.space/viewtopic.php?p=263420#p263420 Cim (2018)]

== Links ==
*[https://bb.oolite.space/viewtopic.php?t=21606 BB thread] (2024)
*[[Planetfall OXP]] PF v.1 original wiki page

== Quick Facts ==
{{OXPLevel|0|2}}{{IconOXP|ooVersion="1.90"|oxpCPU="Average"|oxpMEM="Low"|oxpGPU="Average"|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
{{Infobox OXPb| title = PlanetFall2.oxz
|version = 2.30
|release = 2026-04-11
|license = CC BY-NC-SA 3.0
|features = Planetary landings
|category = Systems OXPs
|author = [[User:Thargoid|Thargoid]], [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?t=21606 Oolite BB]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-orange.png|right]]
By default, planetary landings are harder than they were in V1. However, if you don't land on or approach planets, gameplay is largely unaffected (or it can be).

Planetfall2 OXP

2026-05-07T02:43:38Z

Phkb: /* Version History */

[[Image:IconPF2.png|100px|right]]
[[File:PlanetFall2 city 7.png|300px|thumb|right|Landing at a city]]
[[File:PlanetFall2 moon 5.png|300px|thumb|right|Landing on a moon]]
== Overview ==
{{Infobox EquipStats Oolite| title = PlanetFall2 OXP
|image =
|equipName = Atmospheric Stabilisers
|equipCost = 5,000₢
|equipTL = 9
}}
An OXP which allows the Commander to land at specific locations on planets and moons (but not suns, even at night). Each main planet has up to 5 designated landing sites, while additional planets can have 3, and each moon can have 2 (configurable via [[Library OXP|Library Config]]). Pick your landing site and point your ship at the flashing marker near the surface that indicates the Ground Control Interface Point for the landing zone. Ensure your flight path is not too steep, otherwise you may sustain damage when the automated landing protocol engages.

Be careful of turbulence as you enter the atmosphere. To assist with atmospheric turbulence, the "Atmospheric Stabilisers" can be purchased at any TL9+ system for 5000cr. When equipped, this will reduce the impact of turbulence on your ship. Speed will have an impact on how much your ship is effected by turbulence. Slowing down will decrease the effect.

Your approach will trigger an automatic landing request. You should receive a response after a few seconds, indicating you are either cleared for landing or not. If you have clearance, continue towards the Ground Control Interface Point at less than 100 m/s until the automated system engages, captures your ship and lowers you to a landing pad.

Planetary take-off is via a launch booster, with control being returned to the Commander once orbital insertion is achieved.

=== A suite of OXPs ===
This OXP is currently a suite of 2 OXPs with another 2 optional OXPs:
*'''PlanetFall2''' (the coding)
*'''PlanetFall Resources''' (the individual planetary images)

*Optional: '''Feudal PlanetFall2''' (linking PlanetFall2 with [[Feudal States]] which is currently the only OXP which does much on the planet surface).
:<s>At time of writing PlanetFall2 is only compatible with Feudal States v.1 (and the ''alpha'' Feudal States v.2 is only compatible with PlanetFall v.1)!</s> It should now be compatible with both versions of Feudal States.
*Optional: [[Planet Rotation Cosmetics OXP]] slows down the planet's rotation as you approach it and are captured by the planet's gravity.

[[File:Planetfall2 Transit system.png|right|300px]]

=== Gaming changes from Thargoid's PlanetFall v1 (2008-13) ===
*You can now land on a planet without purchasing "planetary landing capabilities"/"atmospheric stabilisers" - but it is rather more dangerous
::If you have already bought "planetary landing capabilities", PF2 will convert them to "atmospheric stabilisers"
*There are now specific landing sites on the planet
*Commodity Markets are now included (''ie'' PlanetFall Markets OXP is redundant).
*When landed you can transit from one landing site to another (and pay good money to transit your ship, too!).
*[[Maintenance]] overhauls are now performed on the planet surface rather than in the orbital station (they will tell you this on the station!)
*There are other changes to be discovered!

== Requirements ==
*Oolite v.1.90 or better
*[[GNN]]
*[[Library OXP]]
*[[Market Script Interface]]
*[[External Docking System]]

While it isn’t a requirement, the [[Planet Rotation Cosmetics OXP]] is a highly recommended addition for PlanetFall 2.

== Options ==
There are a '''lot''' of options available to help configure the system the way you want it. The list is long, so if you want to see everything, ''click'' the link on the right.
<div class="mw-collapsible mw-collapsed" data-expandtext="Show me everything!" data-collapsetext="Turn it off! Turn it off!" style="overflow:auto;">
Library Config has the following sections for PlanetFall2:
* General settings
* Main planet settings
** F3/F8 access
** Spawn chances
* Extra Planet settings
** F3/F8 access
** Spawn chances
* Moon settings
** F3/F8 access
** Spawn chances
* Spawn chances: TL factors
* Transit costs
* Ship transfer costs

=== General settings ===
'''Flags'''
* '''Move shipyards to planet:''' Controls whether shipyards are moved to planet-side locations.
* '''Move maintenance to planet:''' Controls whether the "Maintenance Overhaul" item is moved to only be offered on planet-side locations.
* '''Atmosphere turbulence:''' Controls whether the turbulence effect, when entering the atmosphere of a planet, is active or not.
* '''Shallow approach:''' Controls whether a shallow approach angle is required when landing on a surface location.
* '''Use landing images:''' Controls whether the images displayed after landing at a planetary site are displayed.
* '''Use Almanac names:''' Controls whether the names of planetary locations are given names based on the methodology from the Galactic Almanac.
* '''Allow planetary transit:''' Controls whether it is possible to fast travel to other planetary sites after landing.

'''Values'''
* '''Main planet max:''' Maximum number of locations that could be spawned on the main planet.
* '''Extra planet max:''' Maximum number of locations that could be spawned on a secondary planet with an atmosphere.
* '''Moon max:''' Maximum number of locations that could be spawned on a moon with no atmosphere.
* '''Atmosphere max altitude:''' Maximum height (in km) of the atmosphere of a planet.
* '''Beacon range:''' Max distance (in km) that planetary beacons become visible to the player.
* '''Service Level dec:''' Amount that service level will be reduced by when launching from a planet.
* '''Transfer Time:''' Amount of time (in hours) that will pass when transferring player ship to the current location.
* '''Train speed:''' Base average speed of trains (in kph), which is scaled up or down based on the TL of the system.
* '''Turbulence impact scale:''' Scales the impact of turbulence, where 1.0 means no change to the default, 0.5 halves the impact, and 0.0 means no impact (same as turning turbulence off).

=== Main planet settings ===
==== F3/F8 Access ====
'''Flags'''
* '''Capital cities:''' Whether capital cities will have access to the F3 Equip Ship screen.
* '''Military bases:''' Whether military bases will have access to the F3 Equip Ship screen.
* '''Leisure complexes:''' Whether leisure complexes will have access to the F3 Equip Ship screen.
* '''Factories:''' Whether factories will have access to the F3 Equip Ship screen.
* '''Rubbish dumps:''' Whether rubbish dumps will have access to the F3 Equip Ship screen.

'''Values'''
* '''Capital cities:''' What type of market will be available at capital cities.
* '''Military bases:''' What type of market will be available at military bases.
* '''Leisure complexes:''' What type of market will be available at military bases.
* '''Factories:''' What type of market will be available at factories.
* '''Rubbish dumps:''' What type of market will be available at rubbish dumps.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51. (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn city:''' Chance of spawning a capital city.
* '''Spawn military base:''' Chance of spawning a military base.
* '''Spawn leisure complex:''' Chance of spawning a leisure complex.
* '''Spawn factory:''' Chance of spawning a factory.
* '''Spawn rubbish dump:''' Chance of spawning a rubbish dump.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Extra planet Settings ===
==== F3/F8 Access ====
'''Flags'''
* '''Colony cities:''' Whether colony cities will have access to the F3 Equip Ship screen.
* '''Military bases:''' Whether military bases will have access to the F3 Equip Ship screen.
* '''Leisure complexes:''' Whether leisure complexes will have access to the F3 Equip Ship screen.
* '''Factories:''' Whether factories will have access to the F3 Equip Ship screen.
* '''Rubbish dumps:''' Whether rubbish dumps will have access to the F3 Equip Ship screen.

'''Values'''
* '''Colony cities:''' What type of market will be available at colony cities.
* '''Military bases:''' What type of market will be available at military bases.
* '''Leisure complexes:''' What type of market will be available at leisure complexes.
* '''Factories:''' What type of market will be available at factories.
* '''Rubbish dumps:''' What type of market will be available at rubbish dumps.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51 (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn colony city:''' Chance of spawning a colony city.
* '''Spawn military base:''' Chance of spawning a military base.
* '''Spawn leisure complex:''' Chance of spawning a leisure complex.
* '''Spawn factory:''' Chance of spawning a factory.
* '''Spawn rubbish dump:''' Chance of spawning a rubbish dump.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Moons ===
==== F3/F8 Access ====
'''Flags'''
* '''Colony domes:''' Whether colony domes will have access to the F3 Equip Ship screen.
* '''Mines:''' Whether mines will have access to the F3 Equip Ship screen.
* '''Prisons:''' Whether prisons will have access to the F3 Equip Ship screen.
* '''Leisure domes:''' Whether leisure domes will have access to the F3 Equip Ship screen.
* '''Robot factories:''' Whether robot factories will have access to the F3 Equip Ship screen.
* '''Research complexes:''' Whether research complexes will have access to the F3 Equip Ship screen.
* '''Wastelands:''' Whether wastelands will have access to the F3 Equip Ship screen.

'''Values'''
* '''Colony domes:''' What type of market will be available at colony domes.
* '''Mines:''' What type of market will be available at mines.
* '''Prison:''' What type of market will be available at prisons.
* '''Leisure domes:''' What type of market will be available at leisure domes.
* '''Robot factories:''' What type of market will be available at robot factories.
* '''Research complexes:''' What type of market will be available at research complexes.
* '''Wastelands:''' What type of market will be available at wastelands.
Market type key:
* 0 = No market;
* 1 = Default market, which will likely be the main station market;
* 2 = SFEP (Stations for Extra Planets) method, which adjusts prices and quantities based on the distance of the site from the main station.
* 3 = Original market, as defined in PlanetFall v1.51 (but pre-Oolite 1.84).

==== Spawn chances ====
'''Values'''
* '''Spawn colony dome:''' Chance of spawning a colony dome.
* '''Spawn mine:''' Chance of spawning a mine.
* '''Spawn prison:''' Chance of spawning a prison.
* '''Spawn leisure dome:''' Chance of spawning a leisure dome.
* '''Spawn robot factory:''' Chance of spawning a robot factory.
* '''Spawn research complex:''' Chance of spawning a research complex.
* '''Spawn wasteland:''' Chance of spawning a wasteland.

eg 0.4 = 40% chance. The chance will be adjusted slightly by the TechLevel factor (see below).

=== Spawn chances: TL factors ===
'''Values'''
* '''Main planet min/max:''' Factor to apply to spawn chance of main planet locations based on the TL of the system.
* '''Extra planets min/max:''' Factor to apply to spawn chance of extra planet locations based on the TL of the system.
* '''Moons min/max:''' Factor to apply to spawn chance of moon locations based on the TL of the system.

The min value would be applied at the lowest TL, while the max value would apply to the highest TL. 
TL's in between would get a scaled value between min and max.

=== Transit costs ===
'''Values'''
* '''Fee:''' Base cost for a single trip (cr).
* '''Anarchy factor:''' Factor applied to fee in Anarchy systems
* '''Feudal factor:''' Factor applied to fee in Feudal systems.
* '''Multi-government factor:''' Factor applied to fee in Multi-Government systems.
* '''Dictatorship factor:''' Factor applied to fee in Dictatorship systems.
* '''Communist factor:''' Factor applied to fee in Communist systems.
* '''Confederacy factor:''' Factor applied to fee in Confederacy systems.
* '''Democracy factor:''' Factor applied to fee in Democracy systems.
* '''Corporate State factor:''' Factor applied to fee in Corporate State systems.

eg 0.0 = All trips are free; 1.0 = Use base cost; 0.5 = 50% of base cost.

=== Ship transfer costs ===
'''Values'''
* '''Fee:''' Base cost for ship transfer (cr).
* '''Anarchy factor:''' Factor applied to fee in Anarchy systems
* '''Feudal factor:''' Factor applied to fee in Feudal systems.
* '''Multi-government factor:''' Factor applied to fee in Multi-Government systems.
* '''Dictatorship factor:''' Factor applied to fee in Dictatorship systems.
* '''Communist factor:''' Factor applied to fee in Communist systems.
* '''Confederacy factor:''' Factor applied to fee in Confederacy systems.
* '''Democracy factor:''' Factor applied to fee in Democracy systems.
* '''Corporate State factor:''' Factor applied to fee in Corporate State systems.

eg 0.0 = Ship transfers are free; 1.0 = Use base cost; 1.5 = 150% base cost.

</div>

== Downloads ==
All components are downloadable through the in-game [[Expansions Manager]] 
Direct download here 
* [[Media:PlanetFall2_2.30.oxz|PlanetFall2_2.30.oxz]] (downloaded {{#downloads:PlanetFall2_2.30.oxz}} times).
* [[Media:PlanetFall2_ResourcesA.oxz|PlanetFall2_ResourcesA.oxz]] v1.1
* [[Media:PlanetFall2_ResourcesB.oxz|PlanetFall2_ResourcesB.oxz]] v1.0
* [[Media:Feudal_PlanetFall2_1.5.oxz|Feudal_PlanetFall2.oxz]] v1.5 (downloaded {{#downloads:Feudal_PlanetFall2_1.5.oxz}} times).
 
* [[Media:PlanetFall2_BlackMonks.oxz|PlanetFall2_BlackMonks.oxz]] v2.1 - Adds Bank of the Black Monks to the planet surface locations, providing all the normal bank facilities. The [[Black_Monk_Monastery|Bank of the Black Monks]] also needs to be installed.
* [[Media:PlanetFall2_HoopyCasino.oxz|PlanetFall2_HoopyCasino.oxz]] v2.5 - Adds HOopy casinos to the planet surface locations, complete with gaming opportunities. The [[HOopy_Casino|HOopy Casino OXP]] also needs to be installed.
* [[Media:PlanetFall2_Oo-Haul.oxz|PlanetFall2_Oo-Haul.oxz]] v2.1 - Adds an Oo-Haul distribution centre to the main planet, and a mission to escort a hauler from it out to either the witchpoint or constore. The [[Your_Ad_Here!|YAH/Your Ad Here!]] OXP and [[Oo-Haul]] need to be installed.

== License ==
*Author (PF v.2): [[User:Phkb|Phkb]]
*Author (PF v.1): [[User:Thargoid|Thargoid]]

This OXP is released under the Creative Commons Attribution - Non-Commercial - Share Alike 3.0 license with the following clauses:

* Whilst you are free (and encouraged) to re-use any of the scripting, models or texturing in this OXP, the usage must be distinct from that within this OXP. Unique identifiers such as (but not limited to) unique shipdata.plist entity keys, mission variables, script names (this.name), equipment identity strings (EQ_), description list arrays and entity roles must not be re-used without prior agreement. Basically if it's unique or would identify or overwrite anything in the original OXP, then you may not re-use it (for obvious compatibility reasons).
* rebundling of this OXP within another distribution is permitted as long as it is unchanged. The following derivates however are permitted and except from the above:
** the conversion of files between XML and openStep.
** the merging of files with other files of the same type from other OXPs.
* The license information (either as this file or merged into a larger one) must be included in the OXP.
* Even though it is not compulsory, if you are re-using any sizable or recognisable piece of this OXP, please let me know :)

---> (Details of images used) --->
<div class="mw-collapsible mw-collapsed" data-expandtext="Show gory details" data-collapsetext="Hide gory details" style="overflow:auto;">
'''Image files:''' 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_20850610.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21988050.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_23326348.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21988072.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_23326337.htm Image by user6702303 on Freepik 
https://www.freepik.com/free-photo/empty-dark-room-modern-futuristic-sci-fi-background-3d-illustration_21835246.htm Image by user6702303 on Freepik 
 
https://www.freepik.com/free-photo/blue-sky-with-scattered-white-clouds_12110221.htm Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22542965.htm Freepik 
https://www.freepik.com/free-photo/cloudy-sky-daylight-background_19380968.htm Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22543011.htm Freepik 
https://www.freepik.com/free-photo/blue-sky-with-cloud-closeup_6133056.htm Image by photogenia on Freepik 
https://www.freepik.com/free-photo/beautiful-skyscape-during-daytime_22542943.htm Freepik 
https://www.freepik.com/free-vector/20-vehicles-outline-icon-presentation_38543743.htm Image by flatart on Freepik 
 
https://www.freepik.com/free-ai-image/subway-dark-atmosphere_76653967.htm Image by freepik 
https://www.freepik.com/free-ai-image/new-york-city-subway-train-motion_69844323.htm Image by freepik 
https://www.freepik.com/free-photo/motion-blur-automatic-train-moving-inside-tunnel-tokyo-japan_10824408.htm Image by tawatchai07 on Freepik 
 
</div>
Some images were generated by AI at https://www.freepik.com/pikaso/ai-image-generator 

'''Sound files:''' 
"e train 140kmh 04 190613_0029.wav" by klankbeeld -- https://freesound.org/s/476298/ -- License: Attribution 4.0 
"Arrival of a passenger electric train.1950km station_2(Eq,lmtr).wav" by newlocknew -- https://freesound.org/s/580464/ -- License: Attribution 4.0 

== Version History ==
2.31
* Added GNN interface to some planetary surface locations.
* Fixed null reference error that could occur during transits.
* Added screenID's to all mission screens.
* Speed of the landing FX now scales with system performance.
* Switched to using logcontrol.plist for debug output.

2.30
* Changed manifest title from "PlanetFall" to "PlanetFall2".
* Changed Library Config aliases to "PlanetFall2".
* Changed category to "Systems".
* Fixed issue with adding OXP locations to custom systems, where some keys were being added to the list twice.

2.29
* Shuttles that choose to land on a planet will now do so at one of the landing sites.
* Shuttles will also launch from the landing sites.

2.28
* Fixed method of detecting when two landing sites are too close together.
* Changed calculation method for positioning landing sites to ensure good separation from others.

2.27
* Fixed issue where stored names were not being restored from missionVariables reliably.
* Fixed issue with naming system for Oo-Haul sites, which wasn't including "(Distribution Centre)" in the name.
* Fixed issue with naming HOopy Casino sites, which wasn't including "(HOopy Casino)" in the name.
* OXP planet locations defined via the ship role "planetFall2_???_externalOXP" are now attempted to be added to custom systems. Random factors and spawn conditions can then come in to play to limit the number of spawns.

2.26
* Darkened overlay images for better compatibility with Oolite 1.92.

2.25
* Moved more text into missiontext.plist.
* Fixed issue with ship transfer fee not being calculated correctly when being deducted from the players account.

2.24
* Added check for, and warning message of, PlanetLand OXP conflict.

2.23
* Fixed issue where shipyards were not viewable on stations that have overridden the "move shipyards to planet" option.

2.22
* Display a message when attempting to access shipyards on stations when they are located on planetary surfaces.
* Added option to disable the shallow approach angle requirement when landing on a surface location.
* Tweaked spawning logic so planetary locations can't be too close together, increasing the distance from the previous fix.

2.21
* Change to manifest file to match with split of resources pack into two.

2.20
* Added a function, $getSystemLocations, which returns an object containing the ship keys and place names of all planetary locations in a given system.

2.19
* Setting beacon range to zero will make all beacons visible all the time.
* Added ability to scale the maximum turbulence factor per planet.

<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">
2.18
* Added a "turbulence impact scale" option so the effect of turbulence can be scaled to taste.
* Allowed for blank entries in location overrides to switch to randomised location types and naming.
* Fixed issues when checking roles to determine the type of VFX to show for landing.
* Added ability to override the landing clouds, docks and overlays on a per-planet basis.
* Some code refactoring.

2.17
* Moved most text into missiontext.plist for easier localisation.
* Removed monkey patch on Marker Inquirer as no longer required.

2.16
* Tweak to prevent LMSS and Laser Arrangement interfaces disappearing on non-PlanetFall locations.

2.15
* Increased the number of shipdata entities to better handle high values for the number of planetary landing points.

2.14
* Added protection for instances where a planet or moon has no air color value set.
* Fixed issue where the reason for the denial of a landing request was not being transmitted to the player.

2.13
* Further fixes to linkage between landing sites and planets.

2.12
* Fixed incorrect property setting in shipdata.
* Changed allegiance setting for research complexes to be neutral.
* Fixed issue where landing sites could spawn too close together.

2.11
* Fixed issue where link between landing sites and planets could occasionally break due to rounding errors.

2.10
* Prevented things like "Immigration Control" from appearing in Anarchy systems.
* Prevented turbulence frame callback from being started twice.
* Fixed error: this.serviceLevelDecrease is not a function.
* Tweaks to hopefully permanently fix issue where turbulence effect keeps running after a witchspace jump or docking.

2.9
* Fixed JS error in transit process code.
* Fixed issue where Vimana-X HUD was not resetting correctly on launch after using transit system.

2.8
* Split off planet rotation slowing into separate OXP, and made optional for this OXP.

2.7
* Dying while turbulence is active will now stop the frame callback.
* Added tweak to planet rotation when approaching planet, slowing it down to make scale issues less obvious (can be configured with Library Config).
* Code refactoring.

2.6
* Small tweak to the market script.
* Small fix to the name generation process for Capital Cities.

2.5
* Refined some text in messages for better understanding and integration with the built in voice.
* Added a pre-spawn check for a condition script on custom (ie non-built-in) surface locations.
* Fixed issue that was preventing custom names from being applied to custom system setups.
* Added a PDF document outlining how to create custom systems, for non-coders.
* Updates for the PlanetFall Oo-haul mission pack.
* Added conflict with PlanetFallMarketSaver - this OXP shouldn't be necessary with PlanetFall2.
* Added conflict with PlanetFall Markets - this OXP shouldn't be necessary with PlanetFall2.
* Removed some unused settings in config.
* Split off graphical assets into separate OXP, to make updating the core code easier for everyone.
* Added a second train FX image, so that the second animation doesn't just look completely like the first.
* Tweaked train FX images to make them more centred.
* Added scan class to station entities.

2.4
* Adjusted calculations to make landing when pointing at the GCIP more consistent.

2.3
* Added a planet-side transit system, so you don't have to launch and re-dock to visit another landing site on the same planet.
* Transit costs are adjusted based on government types. Configurable via Library Config.
* Ship transfer costs are adjusted based on government types. Configurable via Library Config.
* Fixed shipyard transfer process to not run more than once per system.
* Added fragment and vertex shaders to ensure all break patterns appear clearly and without shadow.
* Removed yaw turbulence factor. Only pitch and roll turbulence will be now be set.
* Fixed issue that was preventing subSurface colonies and moonSurface domes from being spawned.
* Amount of reduction to service level is now configurable via Library Config.
* Added a function (PlanetFall2.playerShipIsLocal) that can be called to determine if the player is near their ship or not.
* Removed the Blackmonks and HoOpy Casino config options, and incorporated spawn chances in script_info object of shipdata and condition script.

2.2
* Fixed issue where, if "Additional Planets" doesn't create any planets, no landing sites are created on the main planet.
* Reapplied monkey match for Market Inquirer to address issue with beacons not showing when more than 100000m from the player when docked.
* Removed conflicts with SW Planetary Systems and Moons, although it is unlikely any created moons will get landing sites.

2.1
* Added methods to allow for a fully customised system to be defined (with multiple sites per planet/moon).
* Moved Feudal States override code into a separate OXP.
* Fixed missing semi-colon in shipdata.plist.
* Switched ground control interface point to be a normal ship object (rather than a visual effect) to gain better compatibility with OXP's like Telescope.
* Made the ground control interface points more visible.
* Reduced the number of monkey patches required.
* Made the maximum range at which the space compass will detect ground control interface points configurable via Library Config, and changed the default value to 200km.
* Added some conflict oxps ("Planetary Systems" and "Moons" by stranger).
* Improved compatibility with Market Inquirer.
* Tweaked spawning methods to better reflect the original PlanetFall results, where OXP station roles are not added unless override flag is set.
* Added a warning screen for players, informing them that ship maintenance services are only available on the planet.
* Added a chance of a misjump when executing a witchspace jump inside the atmosphere.
* Fixed issue where entering witchspace while the turbulence effect is still active would result in it staying active.
* Fixed bug that was setting service level to the minimum value when launching from a planetary location.
* Turbulence now doesn't end when speed is zero.
* Added a config item to manage how much the service level of the player ship is reduced.
* Added shipdata entries to allow for multiple military bases, leisure complexes, factories and dumps on the main planet in custom systems.
* Fixed issues where NaN, NaN, Nan is calculated for a vector.
* Log messages now controllable via a debug flag.
* Removed some unused code.

2.0
* Updated landing FX, with clouds and landing pads.
* Updated launching FX.
* Changed docking method to have a fixed location (rather than just descending towards the planet surface anywhere), which means you can now save your game at planetary locations.
* Access to equipment sales (F3 Equip Ship) configuration via Library Config.
* Updated market information to allow for 3 different methods to be applied to any of the locations. (Configurable via Library Config)
* Added a variety of arrival report screen backgrounds. (Can be turned off via Library Config)
* Added a turbulence effect when in the atmosphere of a planet. (Can be turned off via Library Config)
* Equipment item renamed to "Atmospheric Stabilisers", but is optional for planetary landings.
* Moved ships from shipyards on other stations to planetary locations. (Configurable via Library Config)
* Moved "Maintenance Overhaul" to only be available on the main planet. (Configurable via Library Config)
* Added script updates to Feudal Systems, Aquatics, Market Inquirer, Galactic Almanac and In-System cargo delivery to maintain compatibility.
* Additional compatibility settings updated via shipdata-overrides.plist.
</div>

== The Dark Side ==
=== Custom designing a system ===
You can now custom design a system:
:specifically naming landing sites (see inside Lave.oxp)
:adding tweaks for entering the atmosphere: storms, haze, colours, and [[OXP_howto_texture#Planet_textures|city night-lights]] (see inside Famous Planets v.3 & see inside Lave.oxp)
:tweaking landing: images and haze ((see inside DGill's newest Feudal Systems suite & Famous Planets v.3)
:tweaking the space port "experience": things to do (see inside DGill's newest Feudal Systems suite)

To tweak a system see the "Creating Custom Systems.pdf" & the "Developer's ReadMe" hidden inside the oxp and then also the example [https://app.box.com/s/5xbksy48qr9cp31z2wpef6wjla05s3ih/file/1505969925081 SuperSystem.oxp]
:There is more detail [https://bb.oolite.space/viewtopic.php?p=301011#p301011 here] (runs on for several pages) and [https://bb.oolite.space/viewtopic.php?p=301065#p301065 here]

=== Problems with the Oolite game engine ===
*Planets were never meant to be interacted with in Oolite - there's a lot of hand-waving going on with PF2 when it comes to landing on the surface. [https://bb.oolite.space/viewtopic.php?p=301396#p301396 Phkb (2025)]
*The Oolite game engine does support larger planets and stars - I put together an OXP a while ago which uses them - but not necessarily particularly well. (Editor: [[SOTL Altmap]]? [[SOTL Exploration]]?) 
:You would have noticeable "corners" on the planets at 'real-world' sizes, as a 20,000 triangle polygon gets too large. You can already see these if you go as low as you can on a planet and look at the horizon. Similarly, the way planet texturing works would need to be significantly changed to avoid pixels tens of kilometres wide. There are display issues with large stars at high distances. There's a bit of a hack in the display code to avoid the worst of it, but there can still be strange issues with which objects are displayed in front of which. (You would probably need a higher Open GL version to solve these, which may or may not be practical to hide behind a graphics setting toggle) [https://bb.oolite.space/viewtopic.php?p=263420#p263420 Cim (2018)]

== Links ==
*[https://bb.oolite.space/viewtopic.php?t=21606 BB thread] (2024)
*[[Planetfall OXP]] PF v.1 original wiki page

== Quick Facts ==
{{OXPLevel|0|2}}{{IconOXP|ooVersion="1.90"|oxpCPU="Average"|oxpMEM="Low"|oxpGPU="Average"|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
{{Infobox OXPb| title = PlanetFall2.oxz
|version = 2.30
|release = 2026-04-11
|license = CC BY-NC-SA 3.0
|features = Planetary landings
|category = Systems OXPs
|author = [[User:Thargoid|Thargoid]], [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?t=21606 Oolite BB]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-orange.png|right]]
By default, planetary landings are harder than they were in V1. However, if you don't land on or approach planets, gameplay is largely unaffected (or it can be).

File:Yah constores only 1.0.3.oxz

2026-05-07T01:44:33Z

Phkb: Phkb uploaded a new version of File:Yah constores only 1.0.3.oxz

File:Random player 1.0.1.oxz

2026-05-07T01:42:06Z

Phkb: Phkb uploaded a new version of File:Random player 1.0.1.oxz

File:PlanetFall2 2.31.oxz

2026-05-07T01:39:39Z

Phkb:

File:SimonB's Ships1.0.oxz

2026-05-07T00:22:30Z

Phkb: Phkb uploaded a new version of File:SimonB's Ships1.0.oxz

File:Oolite.oxp.davidkroc.sidewinder-ng.oxz

2026-05-07T00:21:55Z

Phkb: Phkb uploaded a new version of File:Oolite.oxp.davidkroc.sidewinder-ng.oxz

== Summary ==
Sidewinder NG

File:FarstarMurderer1.2.oxz

2026-05-07T00:21:30Z

Phkb: Phkb uploaded a new version of File:FarstarMurderer1.2.oxz

v1.2
CC-by-nc-sa 4.0

File:Cougar ST1.5.oxz

2026-05-07T00:21:19Z

Phkb: Phkb uploaded a new version of File:Cougar ST1.5.oxz