Elite Wiki - User contributions [en]

Fully Annotated HUD Configuration (hud.plist) File

2026-08-11T12:09:27Z

Phkb: Fixed code formatting

[[File:Origin-story.png|right|thumb|300px|x-origin & y-origin!]]
{
// =============================================================================
// IMPORTANT: This is a PROPERTY LIST (.plist) file in OpenStep format.
// =============================================================================
// Please note that this file uses OpenStep format (not JSON, XML, or other formats).
// When editing, be careful to preserve all punctuation, especially:
// - Commas at the end of dictionary entries (except the last one)
// - Semicolons after key-value pairs
// - Proper use of quotes, parentheses, and braces
// Incorrect punctuation will cause the file to fail to load in Oolite.
//
// =============================================================================
// GLOBAL HUD SETTINGS
// =============================================================================
// These settings control the overall behavior and appearance of the entire HUD. (The parameters that control visibility of the HUD elements are not included)
// Changes here affect all HUD elements globally.

// --- CROSSHAIR SETTINGS ---
// Controls the appearance of the targeting crosshair
crosshair_scale = 32.0; // Size multiplier for the crosshair. Higher values = larger crosshair
crosshair_width = 1.5; // Line thickness of the crosshair in pixels
crosshair_color = "greenColor"; // Color of the crosshair. Can be named colors ("redColor", "blueColor")
// or RGBA tuples like "(0.0, 1.0, 0.0, 1.0)" for green

// --- SCANNER SETTINGS ---
// Controls the behavior and appearance of the radar scanner
scanner_minimalistic = no; // If YES, uses a simplified scanner display with less detail
scanner_non_linear = no; // If YES, scanner zoom is non-linear (more sensitive near center)
scanner_ultra_zoom = no; // If YES, enables ultra zoom mode for the scanner

// --- GUI AND DISPLAY SETTINGS ---
// General interface settings
allow_big_gui = no; // If YES, allows larger GUI elements (rarely used)
overall_alpha = 0.75; // Global transparency for all HUD elements (0.0 = invisible, 1.0 = opaque)

// --- SPECIAL INDICATOR SETTINGS ---
// Controls specific HUD behaviors
cloak_indicator_on_status_light = yes; // If YES, shows cloak status on the status light instead of separate indicator
reticle_target_sensitive = no; // If YES, reticle changes color when hovering over targets

// =============================================================================
// POSITION SYSTEM DOCUMENTATION
// =============================================================================
// POSITION PARAMETERS:
// All positioned elements use the following coordinate system:
//
// x: The x-position of the dial on screen.
// y: The y-position of the dial on screen.
//
// x_origin:
// - x_origin = 1.0: x co-ordinate is relative to the RIGHT hand side of the screen
// - x_origin = 0 or unspecified: x is relative to the MIDDLE of the screen (default)
// - x_origin = -1.0: x co-ordinate is relative to the LEFT hand side of the screen
//
// y_origin:
// - y_origin = 1.0: y co-ordinate is relative to the TOP of the screen
// - y_origin = 0 or unspecified: y is relative to the MIDDLE of the screen (default)
// - y_origin = -1.0: y is relative to the BOTTOM of the screen
//
// BEST PRACTICE: It is preferable to define HUD elements relative to the screen
// borders (x_origin = ±1.0, y_origin = ±1.0) rather than the center, so that HUD
// elements fit better on all screen aspect ratios and resolutions.

// =============================================================================
// SPECIAL PARAMETERS DOCUMENTATION
// =============================================================================
// SPECIAL PARAMETERS:
// Some parameters only work with specific dials and have unique behaviors:
//
// align:
// - Only works with "drawASCTarget:" selector
// - When set to 1, right-aligns the text to the X coordinate instead of standard left alignment
// - Other values: 0 = left alignment (default), <s> 2 = center alignment </s>
//
// labelled:
// - Only works with "drawEnergyGauge:" selector
// - When set to yes, adds bank numbers to the energy banks
// - Has no effect on other dials
//
// n_bars:
// - For "drawEnergyGauge:": determines how many energy banks are drawn (default is 1)
// - For "drawPrimedEquipment:": if set to >1 (odd numbers work better than even),
// also shows some previous and next primable equipment in the cycle
// - Ignored for all other dials
//
// spacing:
// - Only works with "drawMissileDisplay:" selector
// - Determines spacing between the missile icons in the display
// - Does nothing for other dials

// =============================================================================
// DIALS SECTION
// =============================================================================
// The dials array defines all individual HUD elements (gauges, indicators, displays).
// Elements are drawn in the order they appear here - later elements appear on top.
// Each dial is a dictionary with properties defining its appearance and behavior.
//
// COLOR PARAMETER USAGE:
// Many dials support color parameters that change appearance based on values:
// - color_low: Color for low values/ranges
// - color_medium: Color for medium values/ranges
// - color_high: Color for high values/ranges
// - color_critical: Color for critical/dangerous values (temperature, altitude)
// - color_surround: Color for the border/frame around the dial
// - color: Base color for dials that don't use range-based coloring
//
// All color parameters accept standard Oolite color formats:
// - Named colors: "greenColor", "redColor", "yellowColor", etc.
// - RGB tuples: (1.0, 0.0, 0.0) for red
// - RGBA tuples: (1.0, 0.0, 0.0, 0.5) for semi-transparent red
// - Hex strings: "#FF0000" for red (less common in plist files)

dials = // these are drawn, in order, after the legends
(
// =============================================================================
// TARGETING RETICLE
// =============================================================================
// The crosshair that appears when targeting missiles or objects
{ // Targeting reticle
equipment_required = "EQ_SCANNER_SHOW_MISSILE_TARGET"; // Only show if this equipment is installed
selector = "drawTargetReticle:"; // Internal method that draws this element
// reticle_scale = 0.015625 /* 1/64 is default */ // Uncomment to override default scale
target_rgba = "greenColor"; // Color for normal targeting
target_sensitive_rgba = "redColor"; // Color when crosshairs are over target
wormhole_rgba = "cyanColor"; // Color when targeting wormholes
// Note: Moves about on screen - no position parameters needed
},

// =============================================================================
// WAYPOINT DISPLAY
// =============================================================================
// Shows navigation waypoints when advanced compass is equipped
{ // Waypoint display
equipment_required = "EQ_ADVANCED_COMPASS"; // Only show with advanced compass
selector = "drawWaypoints:"; // Internal drawing method
// Note: Moves about on screen - no position parameters needed
},

// =============================================================================
// SCANNER (RADAR)
// =============================================================================
// The main radar display showing contacts around the ship
{ // scanner
alpha = 1.0; // Transparency (1.0 = fully opaque)
selector = "drawScanner:"; // Internal method to draw the scanner
// POSITION PARAMETERS:
x = 0; // Horizontal position: 0 = center of screen
y = 68; // Vertical position: 68 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
height = 64.0; // Height of scanner in pixels
width = 288.0; // Width of scanner in pixels
rgb_color = (1.0, 0.0, 0.0); // RGB color: (red, green, blue) = bright red
},

// =============================================================================
// SCANNER ZOOM INDICATOR
// =============================================================================
// Shows the current zoom level of the scanner
{ // scanner zoom indicator
alpha = 1.0; // Fully opaque
selector = "drawScannerZoomIndicator:"; // Drawing method
// POSITION PARAMETERS:
x = 100; // 100 pixels right of center
y = 36; // 36 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
},

// =============================================================================
// STICK SENSITIVITY INDICATOR
// =============================================================================
// Shows current joystick/control sensitivity setting
{ // stick sensitivity indicator
alpha = 1.0; // Fully opaque
selector = "drawStickSensitivityIndicator:"; // Drawing method
// POSITION PARAMETERS:
x = 150; // 150 pixels right of center
y = 75; // 75 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
height = 12; // 12 pixels tall
width = 12; // 12 pixels wide
},

// =============================================================================
// COMPASS
// =============================================================================
// Shows direction to target/station/waypoint
{ // compass
alpha = 1.0; // Fully opaque
selector = "drawCompass:"; // Drawing method
// POSITION PARAMETERS:
x = 132; // 132 pixels right of center
y = 32; // 32 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
rgb_color = (0.0, 0.0, 1.0); // RGB color: blue
},

// =============================================================================
// STATION AEGIS INDICATOR
// =============================================================================
// Shows when within station protection range
{ // station aegis
alpha = 1.0; // Fully opaque
selector = "drawAegis:"; // Drawing method
// POSITION PARAMETERS:
x = -132; // 132 pixels left of center
y = 32; // 32 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
},

// =============================================================================
// FUEL SCOOP STATUS
// =============================================================================
// Shows when fuel scoop is active
{ // fuel scoop status
alpha = 0.75; // Semi-transparent (75% opaque)
selector = "drawScoopStatus:"; // Drawing method
// POSITION PARAMETERS:
x = -132; // 132 pixels left of center
y = 92; // 92 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
},

// =============================================================================
// SPEED BAR
// =============================================================================
// Shows current ship speed
{ // speed bar, can draw a surround 2 units out from the dial size specified
draw_surround = yes; // Draw a border around the bar (2 pixels larger than bar)
height = 8; // Bar height in pixels
selector = "drawSpeedBar:"; // Drawing method
width = 80; // Bar width in pixels
// POSITION PARAMETERS:
x = 200; // 200 pixels right of center
y = 95; // 95 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
// COLOR PARAMETERS:
color_low = "greenColor"; // Color for low speed range
color_medium = "yellowColor"; // Color for medium speed range
color_high = "redColor"; // Color for high speed range
color_surround = "whiteColor"; // Color for the border around the bar
},

// =============================================================================
// ROLL BAR
// =============================================================================
// Shows current roll rate
{ // roll bar, can draw a surround 2 units out from the dial size specified
draw_surround = yes; // Draw border around bar
height = 6; // Bar height
selector = "drawRollBar:"; // Drawing method
width = 80; // Bar width
// POSITION PARAMETERS:
x = 200; // 200 pixels right of center
y = 80; // 80 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
// COLOR PARAMETERS:
color = "greenColor"; // Base color for the roll bar
color_surround = "whiteColor"; // Color for the border around the bar
},

// =============================================================================
// PITCH BAR
// =============================================================================
// Shows current pitch rate
{ // pitch bar, can draw a surround 2 units out from the dial size specified
draw_surround = yes; // Draw border around bar
height = 6; // Bar height
selector = "drawPitchBar:"; // Drawing method
width = 80; // Bar width
// POSITION PARAMETERS:
x = 200; // 200 pixels right of center
y = 70; // 70 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
// COLOR PARAMETERS:
color = "greenColor"; // Base color for the pitch bar
color_surround = "whiteColor"; // Color for the border around the bar
},

// =============================================================================
// YAW BAR
// =============================================================================
// Shows current yaw rate
{ // yaw bar, can draw a surround 2 units out from the dial size specified
draw_surround = yes; // Draw border around bar
height = 8; // Bar height
selector = "drawYawBar:"; // Drawing method
width = 80; // Bar width
// POSITION PARAMETERS:
x = 200; // 200 pixels right of center
y = -130; // 130 pixels down from center
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = 0; // Vertical origin: 0 = center of screen (default)
// COLOR PARAMETERS:
color = "greenColor"; // Base color for the yaw bar
color_surround = "whiteColor"; // Color for the border around the bar
},

// =============================================================================
// ENERGY GAUGE
// =============================================================================
// Shows main energy bank levels
{ // energy gauge
draw_surround = yes; // Draw border around gauge
height = 48; // Gauge height
selector = "drawEnergyGauge:"; // Drawing method
width = 80; // Gauge width
// POSITION PARAMETERS:
x = 200; // 200 pixels right of center
y = 35; // 35 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
// SPECIAL PARAMETERS:
labelled = yes; // Add bank numbers to the energy banks (only works with this selector)
n_bars = 3; // Number of energy banks to display (only works with this selector)
// COLOR PARAMETERS:
color_low = "redColor"; // Color for low energy level
color_medium = "yellowColor"; // Color for medium energy level
color_surround = "whiteColor"; // Color for the border around the gauge
},

// =============================================================================
// FORWARD SHIELD BAR
// =============================================================================
// Shows forward shield strength
{ // forward shield bar, can draw a surround 2 units out from the dial size specified
draw_surround = yes; // Draw border around bar
height = 8; // Bar height
selector = "drawForwardShieldBar:"; // Drawing method
width = 80; // Bar width
// POSITION PARAMETERS:
x = -200; // 200 pixels left of center
y = 94; // 94 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
// COLOR PARAMETERS:
color_low = "redColor"; // Color for low shield strength
color_medium = "yellowColor"; // Color for medium shield strength
color_high = "greenColor"; // Color for high shield strength
color_surround = "whiteColor"; // Color for the border around the bar
},

// =============================================================================
// AFT SHIELD BAR
// =============================================================================
// Shows aft shield strength
{ // aft shield bar, can draw a surround 2 units out from the dial size specified
draw_surround = yes; // Draw border around bar
height = 8; // Bar height
selector = "drawAftShieldBar:"; // Drawing method
width = 80; // Bar width
// POSITION PARAMETERS:
x = -200; // 200 pixels left of center
y = 78; // 78 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
// COLOR PARAMETERS:
color_low = "redColor"; // Color for low shield strength
color_medium = "yellowColor"; // Color for medium shield strength
color_high = "greenColor"; // Color for high shield strength
color_surround = "whiteColor"; // Color for the border around the bar
},

// =============================================================================
// SURROUND (DECORATIVE)
// =============================================================================
// Draws a decorative border (used here for visual grouping)
{ // just draws a surround 2 units around the selected size
height = 40; // Height of surround area
color = "yellowColor"; // Color of the border
selector = "drawSurround:"; // Drawing method
width = 80; // Width of surround area
// POSITION PARAMETERS:
x = -200; // 200 pixels left of center
y = 46; // 46 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
},

// =============================================================================
// FUEL BAR
// =============================================================================
// Shows current fuel level
{ // fuel bar
height = 8; // Bar height
selector = "drawFuelBar:"; // Drawing method
width = 80; // Bar width
// POSITION PARAMETERS:
x = -200; // 200 pixels left of center
y = 61; // 61 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
// COLOR PARAMETERS:
// Special case: 'medium' is used for the bar itself, while 'high' and 'low'
// are used for the distance marker for the current destination system
color_low = "redColor"; // Color for distance marker when fuel is insufficient
color_medium = "greenColor"; // Color for the fuel bar itself
color_high = "yellowColor"; // Color for distance marker when fuel is sufficient
color_surround = "whiteColor"; // Color for the border around the bar (if draw_surround is enabled)
},

// =============================================================================
// WITCHSPACE DESTINATION LABEL
// =============================================================================
// Shows the destination system during hyperspace
{ // witchspace destination label
selector = "drawWitchspaceDestination:"; // Drawing method
height = 10; // Character height
width = 10; // Character width
// POSITION PARAMETERS:
y = 55; // 55 pixels up from bottom
x = -240; // 240 pixels left of center
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
color = (0.25,0.25,1.0,1.0); // RGBA color: blue with full opacity
},

// =============================================================================
// CABIN TEMPERATURE BAR
// =============================================================================
// Shows internal cabin temperature
{ // cabin temperature bar
height = 8; // Bar height
selector = "drawCabinTempBar:"; // Drawing method
width = 80; // Bar width
// POSITION PARAMETERS:
x = -200; // 200 pixels left of center
y = 51; // 51 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
// COLOR PARAMETERS:
color_low = "greenColor"; // Color for normal temperature range
color_medium = "yellowColor"; // Color for elevated temperature range
color_high = "orangeColor"; // Color for high temperature range
color_critical = "redColor"; // Color for dangerous critical temperature
color_surround = "whiteColor"; // Color for the border around the bar
},

// =============================================================================
// WEAPON TEMPERATURE BAR
// =============================================================================
// Shows weapon system temperature
{ // weapon temperature bar
height = 8; // Bar height
selector = "drawWeaponTempBar:"; // Drawing method
width = 80; // Bar width
// POSITION PARAMETERS:
x = -200; // 200 pixels left of center
y = 41; // 41 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
// Note: Weapon temperature bar doesn't support the standard color parameters
// It uses the default temperature gradient coloring
},

// =============================================================================
// ALTITUDE BAR
// =============================================================================
// Shows altitude when near planets
{ // altitude bar
height = 8; // Bar height
selector = "drawAltitudeBar:"; // Drawing method
width = 80; // Bar width
// POSITION PARAMETERS:
x = -200; // 200 pixels left of center
y = 31; // 31 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
// COLOR PARAMETERS:
color_low = "greenColor"; // Color for safe altitude range
color_medium = "yellowColor"; // Color for caution altitude range
color_high = "orangeColor"; // Color for warning altitude range
color_critical = "redColor"; // Color for critical altitude (danger of crashing)
color_surround = "whiteColor"; // Color for the border around the bar
},

// =============================================================================
// MISSILE DISPLAY
// =============================================================================
// Shows status of mounted missiles
{ // missile display, x and y give the location, the x-spacing is given by spacing, the size defines the icon size
height = 12; // Icon height
selector = "drawMissileDisplay:"; // Drawing method
spacing = 16; // Horizontal spacing between missile icons
width = 12; // Icon width
// POSITION PARAMETERS:
x = -228; // 228 pixels left of center
y = 16; // 16 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
},

// =============================================================================
// STATUS INDICATOR LIGHT
// =============================================================================
// Shows general ship status (alert/warning/caution)
{ // status indicator light, x and y give the location, the size defines the icon size
height = 8; // Light height
selector = "drawStatusLight:"; // Drawing method
width = 8; // Light width
// POSITION PARAMETERS:
x = -108; // 108 pixels left of center
y = 32; // 32 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
},

// =============================================================================
// SHIP'S CLOCK
// =============================================================================
// Shows current game time
{ // ship's clock, x and y give the location, the size defines the character size
height = 12; // Character height
selector = "drawClock:"; // Drawing method
width = 12; // Character width
// POSITION PARAMETERS:
x = -41; // 41 pixels left of center
y = 18; // 18 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
},

// =============================================================================
// PRIMED EQUIPMENT DISPLAY
// =============================================================================
// Shows currently activated/primed equipment
{ // primed equipment, x and y give the location, the size defines the character size
selector = "drawPrimedEquipment:"; // Drawing method
// POSITION PARAMETERS:
y_origin = -1; // Vertical origin: -1 = bottom of screen
x = 156; // 156 pixels right of center
y = -2; // 2 pixels down from center
x_origin = 0; // Horizontal origin: 0 = center of screen
width = 10; // Character width
height = 10; // Character height
// SPECIAL PARAMETERS:
n_bars = 3; // Shows current and adjacent primable equipment (odd numbers work better)
},

// =============================================================================
// COMPASS BEACON/WAYPOINT ID
// =============================================================================
// Shows the ID of targeted beacon or waypoint
{ // compass beacon/waypoint ID, x and y give the location, the size defines the character size
equipment_required = "EQ_ADVANCED_COMPASS"; // Only with advanced compass
selector = "drawASCTarget:"; // Drawing method
height = 12; // Character height
width = 12; // Character width
// POSITION PARAMETERS:
x = 144; // 144 pixels right of center
y = 4; // 4 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
// SPECIAL PARAMETERS:
align = 1; // Right-align text to X coordinate (only works with this selector)
},

// =============================================================================
// WEAPONS SYSTEMS OFFLINE TEXT
// =============================================================================
// Shows warning when weapons are offline
{ // weapons systems offline text, x and y give the location, the size defines the character size
height = 10; // Character height
selector = "drawWeaponsOfflineText:"; // Drawing method
width = 10; // Character width
// POSITION PARAMETERS:
x = -51; // 51 pixels left of center
y = -51; // 51 pixels down from center
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = 0; // Vertical origin: 0 = center of screen (default)
rgb_color = (0.0, 1.0, 0.0, 1.0); // RGBA color: green with full opacity
},

// =============================================================================
// FPS COUNTER
// =============================================================================
// Shows frames per second (debug/development tool)
{ // fps counter, x and y give the location, the size defines the character size
height = 18; // Character height
selector = "drawFPSInfoCounter:"; // Drawing method
width = 18; // Character width
// POSITION PARAMETERS:
x = -300; // 300 pixels left of center
y = -20; // 20 pixels down from center
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = 1; // Vertical origin: 1 = top of screen
rgb_color = (0.0, 1.0, 0.0, 1.0); // RGBA color: green with full opacity
},

// =============================================================================
// CUSTOM BAR (EXAMPLE)
// =============================================================================
// Example of a custom bar that could be added for OXP-specific purposes
// This is not in the original file but shows how drawCustomBar would work
/*
{ // custom bar example
draw_surround = yes; // Draw border around bar
height = 8; // Bar height
selector = "drawCustomBar:"; // Drawing method
width = 80; // Bar width
// POSITION PARAMETERS:
x = 0; // Center of screen
y = -150; // 150 pixels down from center
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = 0; // Vertical origin: 0 = center of screen (default)
// COLOR PARAMETERS:
color_low = "blueColor"; // Color for low values
color_medium = "greenColor"; // Color for medium values
color_high = "yellowColor"; // Color for high values
color_surround = "whiteColor"; // Color for the border around the bar
},
*/
);

// =============================================================================
// LEGENDS SECTION
// =============================================================================
// Legends are text labels that appear with dials. They are drawn BEFORE dials,
// so text appears behind the graphics. Each legend can be linked to a specific
// dial using the 'with_dial' property.
//
// COLOR PARAMETER:
// Legends support a 'color' property to override the default text color:
// - color: Sets the text color for the legend
// - Accepts standard Oolite color formats (named colors, RGB/RGBA tuples)

legends = // these are drawn, in order, before the dials
(
// =============================================================================
// LEFT SIDE LEGENDS
// =============================================================================
// Labels for dials on the left side of the screen

{
text = "FWD"; // Text to display: Forward shields
align = 1; // Text alignment: 1 = center
// POSITION PARAMETERS:
x = -245; // 245 pixels left of center
y = 86; // 86 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
height = 12; // Font height
width = 12; // Font width
// COLOR PARAMETER:
color = "cyanColor"; // Text color for this legend
with_dial = "drawForwardShieldBar:"; // Only show if this dial is visible
},
{
text = "AFT"; // Text to display: Aft shields
align = 1; // Center alignment
// POSITION PARAMETERS:
x = -245; // 245 pixels left of center
y = 70; // 70 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
height = 12; // Font height
width = 12; // Font width
// COLOR PARAMETER:
color = "cyanColor"; // Text color for this legend
with_dial = "drawAftShieldBar:"; // Link to aft shield bar
},
{
text = "FUEL"; // Text to display: Fuel level
align = 1; // Center alignment
// POSITION PARAMETERS:
x = -245; // 245 pixels left of center
y = 55; // 55 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
height = 10; // Font height
width = 10; // Font width
// COLOR PARAMETER:
color = "orangeColor"; // Text color for this legend
with_dial = "drawFuelBar:"; // Link to fuel bar
},
{
text = "CT"; // Text to display: Cabin Temperature
align = 1; // Center alignment
// POSITION PARAMETERS:
x = -245; // 245 pixels left of center
y = 45; // 45 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
height = 10; // Font height
width = 10; // Font width
// COLOR PARAMETER:
color = "yellowColor"; // Text color for this legend
with_dial = "drawCabinTempBar:"; // Link to cabin temp bar
},
{
text = "LT"; // Text to display: Laser Temperature
align = 1; // Center alignment
// POSITION PARAMETERS:
x = -245; // 245 pixels left of center
y = 34; // 34 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
height = 10; // Font height
width = 10; // Font width
// COLOR PARAMETER:
color = "yellowColor"; // Text color for this legend
with_dial = "drawWeaponTempBar:"; // Link to weapon temp bar
},
{
text = "ALT"; // Text to display: Altitude
align = 1; // Center alignment
// POSITION PARAMETERS:
x = -245; // 245 pixels left of center
y = 24; // 24 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
height = 10; // Font height
width = 10; // Font width
// COLOR PARAMETER:
color = "greenColor"; // Text color for this legend
with_dial = "drawAltitudeBar:"; // Link to altitude bar
},
{
text = "MISS"; // Text to display: Missiles
align = 1; // Center alignment
// POSITION PARAMETERS:
x = -245; // 245 pixels left of center
y = 3; // 3 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
height = 14; // Font height
width = 14; // Font width
// COLOR PARAMETER:
color = "redColor"; // Text color for this legend
with_dial = "drawMissileDisplay:"; // Link to missile display
},

// =============================================================================
// RIGHT SIDE LEGENDS
// =============================================================================
// Labels for dials on the right side of the screen

{
text = "SPD"; // Text to display: Speed
// POSITION PARAMETERS:
x = 242; // 242 pixels right of center
y = 86; // 86 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
height = 14; // Font height
width = 14; // Font width
// COLOR PARAMETER:
color = "whiteColor"; // Text color for this legend
with_dial = "drawSpeedBar:"; // Link to speed bar
},
{
text = "ROLL"; // Text to display: Roll rate
// POSITION PARAMETERS:
x = 242; // 242 pixels right of center
y = 72; // 72 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
height = 12; // Font height
width = 12; // Font width
// COLOR PARAMETER:
color = "whiteColor"; // Text color for this legend
with_dial = "drawRollBar:"; // Link to roll bar
},
{ // yaw bar legend
text = "YAW"; // Text to display: Yaw rate
// POSITION PARAMETERS:
x = 242; // 242 pixels right of center
y = -138; // 138 pixels down from center
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = 0; // Vertical origin: 0 = center of screen (default)
height = 12; // Font height
width = 12; // Font width
// COLOR PARAMETER:
color = "whiteColor"; // Text color for this legend
with_dial = "drawYawBar:"; // Link to yaw bar
},
{
text = "PITCH"; // Text to display: Pitch rate
// POSITION PARAMETERS:
x = 242; // 242 pixels right of center
y = 62; // 62 pixels up from bottom
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = -1; // Vertical origin: -1 = bottom of screen
height = 12; // Font height
width = 12; // Font width
// COLOR PARAMETER:
color = "whiteColor"; // Text color for this legend
with_dial = "drawPitchBar:"; // Link to pitch bar
}
);

// =============================================================================
// MULTI-FUNCTION DISPLAYS (MFDs)
// =============================================================================
// MFDs are customizable panels that can show various information like cargo,
// manifest, map, etc. Players can cycle through different MFD modes in-game.
// You can define up to 12 MFDs. They are typically positioned on the sides
// of the screen to avoid interfering with the main HUD elements.
//
// COLOR PARAMETER:
// MFDs support a 'color' property to change from the default green:
// - color: Sets the color of the MFD display elements
// - Accepts standard Oolite color formats (named colors, RGB/RGBA tuples)

multi_function_displays = // can have 1 to 12 multi function displays
(
{
width = 198; // Panel width in pixels
height = 132; // Panel height in pixels
// POSITION PARAMETERS:
x = -156; // 156 pixels left of center
y = -72; // 72 pixels down from center
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = 1; // Vertical origin: 1 = top of screen
// COLOR PARAMETER:
color = "cyanColor"; // Color for MFD display elements (default is green)
},
{
width = 198; // Panel width in pixels
height = 132; // Panel height in pixels
// POSITION PARAMETERS:
x = 156; // 156 pixels right of center
y = -72; // 72 pixels down from center
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = 1; // Vertical origin: 1 = top of screen
// COLOR PARAMETER:
color = "cyanColor"; // Color for MFD display elements (default is green)
}
);

// =============================================================================
// MESSAGE GUI
// =============================================================================
// Controls the display of in-game messages (mission messages, alerts,
// status updates, etc.). This is the main text display area for communications.

message_gui = {
width = 252; // Panel width in pixels
height = 140; // Panel height in pixels
// POSITION PARAMETERS:
x = 128; // 128 pixels right of center
y = -60; // 60 pixels down from center
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = 0; // Vertical origin: 0 = center of screen (default)
row_height = 14; // Height of each message line in pixels
permanent = no; // If NO, panel hides when no messages
background_automatic = yes; // If YES, background auto-hides when no messages
// default background transparent
background_rgba = "0.0 0.05 0.45 0.0"; // Background color (RGBA): dark blue, fully transparent
text_color = "yellowColor"; // Default text color for messages
text_comms_color = "greenColor"; // Text color for communications messages
};

// =============================================================================
// COMMUNICATIONS LOG GUI
// =============================================================================
// Shows the history of communications (radio chatter, station messages,
// comms log, etc.). Typically positioned opposite the message GUI.

comm_log_gui = {
alpha = "0.75"; // Transparency: can be number or string
width = 216; // Panel width in pixels
height = 132; // Panel height in pixels
// POSITION PARAMETERS:
x = -156; // 156 pixels left of center
y = -68; // 68 pixels down from center
x_origin = 0; // Horizontal origin: 0 = center of screen
y_origin = 0; // Vertical origin: 0 = center of screen (default)
row_height = 12; // Height of each log line in pixels
permanent = no; // If NO, panel hides when inactive
automatic = yes; // If YES, auto-hides when no communications
background_rgba = "0.0 0.05 0.45 0.5"; // Background color: dark blue, semi-transparent
};
}

// See [https://wiki.alioth.net/index.php/HUD_Customisation_Guide HUD_Customisation_Guide]

[[Category:Oolite scripting]]

File:ToriB.png

2026-08-05T10:33:17Z

Phkb: Phkb uploaded a new version of File:ToriB.png

Torus station

2026-08-05T10:32:22Z

Phkb: Updated version

{{Infobox StationStats Oolite| title = Torus Station
|image = [[Image:Oolite-twintorus.jpg|280px]]
|dimensions = 5770 x 5770 x 1000 ''single'' 2000 ''double''
|maneuverability = Roll: 4.0 Pitch: 4.0
|isrotating = Yes
|energyrecharge = 100
|armaments = None
|defenders = Galcop
|isoxp = OXP
|beacon = N
}}
== Overview ==
Colossal and majestic, '''Torus''' stations can be spotted at a great distance in space, and serve as a reminder that one is approaching the cream of technological advancement. Capable of containing vast resources and unorthodox space accommodation, they are usually lucrative centers of commerce.

[[Image:Oolite-torusLS.jpg|320px|left|thumb|The ''virgin Torus'' at Onrira, early construction phase]]
==History==
When the first Torus station was unveiled in orbit of [[Sector1/Onrira|Onrira]] in 3129, it marked an event of political promise. As [[GASEC]] and [[GalCop]] had relied heavily on the services of [[Obnoxicorp]] in both the political lobbying and execution of the project, there were many champions to claim honours and declare directions for the future, and some confusion could not be disguised.

As Onrira was at the time under a flawed Multi-Government system, caught up in the recurring [[Esonatoid]] calamity, there was solid cause to see the political instability resolved, especially considering the potential of the world's abundant resources. The Obnoxicorp strategy was intended to join the fragmented leadership in space, and shape a common prosperity through trade. The Torus station made this possible.

Early indications showed success as Onrira began to prosper, offering hope to similar systems who would benefit from a similar lift, but few of these figured in Obnoxicorp's elaborate plans. Torus stations began to appear on a galactic scale, but exclusively around planets of great commercial promise, and not where diplomatic efforts were needed. Although Galcop leadership were said to be displeased about the direction of the Torus program, any public acknowledgement of failure was suppressed.

[[Image:TorusOniraApproach.jpg|320px|left|thumb|A modern Onrira Torus visible at great distance]]
==Design==
[[Image:ToriB.png|520px|thumb|right|The new Dual Torus 2.4]]
Although enormous in size, a Torus station is remarkably unproblematic to assemble compared to other space habitat. At the project's announcement, the modular design concept was praised for its simplicity of fabrication and genius of design. The prefabricated segments are transported with ease to the assembly site, where a Torus station is finalized according to specific needs and budget.

It was all going so well, until the considerable self-satisfaction of the project's designers and economic backers was brutally snuffed out at the unveiling of the full scale prototype. Under embarrassing circumstances, a fatal design flaw was exposed, allowing a relatively minor collision to trigger the complete modular dissociation of its constituent parts, ending careers and causing years of delay until all errors were guaranteed to be corrected.

Theoretically, there is no limit to the amount of rings a Torus can feature, though few have requested more than two. A single Torus supporting 8 times the population of a [[Coriolis station (Oolite)|Coriolis]] and unique controlled segment facilities, corporate opportunity dwells at the very heart of the design.

Some years later Obnoxicorp Inc. has released a new and heavily modified version - the Tori2 - to counteract other companies designs and to reduce accidents with sleepy spaceship commanders crashing into this collossal structure, even though rumours say this attempt has failed completely.

== Locations ==
:Chart 1: Onrira (23), Inera (33), Ceesxe (151)
:Chart 2: Onatbeza (66), Laribebi (98), Recexela (231)
:Chart 3: Lezaer (5), Orzaedve (42)
:Chart 4: Gebiisso (141), Dicebe (197)
:Chart 5: Tetiri (70), Xevera (198), Gesolaon (249)
:Chart 6: Bearrabe (40), Enqura (50), Diesanen (149)
:Chart 7: Quandixe (53), Maraus (66), Bionbiin (119), Articeso (229)
:Chart 8: Esusale (251)

== Requirements ==
* This [[OXP]] requires Oolite v1.76.1

== Download ==
*[[Media:Tori_2.4.oxz|Tori_2.4.oxz]]

==Version history==
*January 2006, v1, [[User:Murgh|Murgh]], models
*October 2010, [[User:Svengali|Svengali]], overhaul
*October 2014, [[User:CaptSolo|CaptSolo]] with [[User:Griff|Griff]], overhaul, high definition textures, Griff docking bay
*August 2026, v2.4 [[User:phkb|phkb]], texture update, specular maps, Oolite 1.90/1.91 shader compatibility

=== Older version downloads ===
* [[Media:Tori2.02.oxz | Tori2.02 OXZ]] (downloaded {{#downloads:Tori2.02.oxz}} times) 
* [https://app.box.com/s/11g8a0utw5xkjopyef91 Murghs_Stations2.0.zip] (1.3 MB) 2013-03-08.
* [http://app.box.com/shared/tc3ncj9xo6 Tori 2.01] (740.5KB) 2010-10-15
* [http://capnhack.com/hosting/oolite/Oolite/OXPs/tori.zip Tori.oxp v1] (556 KB) via Oosat, containing the 4 original Torus variants.

== Links ==
*[https://bb.oolite.space/viewtopic.php?f=4&t=8592 Murgh - Obnoxicorp Inc.] (2010-14)
*[https://bb.oolite.space/viewtopic.php?f=4&t=21479 v2.1 BB thread]
*[https://bb.oolite.space/viewtopic.php?f=4&t=3765 Torus space stations' sphere of influence] (2007-12) - from the days when NPCs would collide while docking

== Gameplay and Balance Indicator ==
{{OXPLevel}}
[[File:Tag-colour-green.png]]

{{station-OXP}}

Traffic Control OXP

2026-08-05T10:28:19Z

Phkb: Updated version

==Overview==
A little script which gives each system main station a traffic control department, whose job it is to guide new Commanders (and a few old hands who have become too reliant on docking computers) on the best route for manual approach and docking into the station. They oversee all traffic from station aegis and planetary approach right up until the actual docking itself. Also they keep an eye on ships leaving the station and wish people a bon voyage. Just don't dally in the approach lane and get in everyone's way, or you'll feel their wrath!

Recommended for new players learning how to dock manually, and for experienced players who want a bit of extra ambience around main stations. It is fully integrated with the docking clearance protocols introduced in Oolite 1.72 (if the stations enable them). Most messages from this OXP will appear only if your ship does not have functional docking computers, but a few will appear regardless, for example: Clear the lane, Commander! If you see a message that starts with 'Traffic Control:' then it is probably from this OXP.

In terms of balance, this OXP is neutral for beginners and slightly biased against the experienced player, because it enforces (with fines and small but escalating bounties) a sensible rule against the use of cloaking devices in proximity to main stations... however, to be fair, it will not impose any penalties if you pass undetected (or at least unidentified). Of course, requesting docking clearance or activating docking computers will transmit your identity to the station...

This OXP is compatible with all other OXPs, and includes considerations for Buoy Repair, ILS and AutoDock if those OXPs are also installed.

==Requirements==
This OXP requires at least version 1.88 of Oolite.

The traffic controllers also assume that any Commander's ship equipped with Docking Computers can look after itself in terms of approach and docking.

==Version History==
<pre>
09/10/2008 - Version 1.00, Initial release.
04/11/2008 - Version 1.01, scripting update for v1.72+ compatibility.
24/05/2010 - Version 1.10, fortified equipment damage checking for 1.74
13/02/2011 - Version 1.11, removal of upper limit, to allow running with 1.75
08/07/2020 - Version 2.00, updated by Milo; set minimum Oolite version to 1.88;
*fixed errors if navigation buoy is destroyed;
*corrected planet approach guidance (follow green circle, not square, if ship has a basic compass);
*added additional hints for new players (until they buy docking computers);
*set up recurring reminders to "clear the lane" when not supposed to be there;
*integrated docking advice with docking clearance protocol for main stations that require clearance;
*added warning messages to fugitive players entering station aegis or requesting docking clearance;
*Cloaking Devices: added responses to being detected using cloaking devices in the station aegis (this OXP now declares it illegal to cloak within main station aegis and introduces a small bounty for the first offence, which will be increased for non-fugitive players each time they are detected still cloaked after the initial offence; however, entering the aegis cloaked and never interacting with the station will not impose a penalty as the traffic controllers are unaware of the trespass); added a 1000 credit fine (or equivalent bounty) to the arrival report when docking at main stations while cloaked (even if fast-docking is used);
*added considerations for nova systems (traffic control will leave a recording when sun has gone nova) and for Buoy Repair, ILS and AutoDock OXPs
07/11/2021 - Version 2.01, updated by Milo; fix bug reported by dybal (docking clearance "granted" status was not correctly detected, resulting in unintended behavior, particularly noticeable when combined with ILS OXP)
07/16/2021 - Version 2.02, updated by Milo; reduced the frequency of some messages, changed one word to be more situationally neutral, and fixed a log warning involving percent symbols; updated license from CC 3.0 to CC 4.0
07/06/2025 - Version 2.3, updated by phkb; Moved all text into descriptions.plist for easier localisation. Ensured all timers are stopped when docking at a station.
07/08/2025 - Version 2.3.1, updated by phkb; Added "use strict"; to main script file.
28/03/2026 - Version 2.4, updated by phkb; Reminders to leave the docking area are now not sent if player has docking clearance, improved handling of nova systems.
05/08/2026 - Version 2.5, updated by phkb; Reminders to leave the docking area are now really not sent if the player has docking clearance.
</pre>

==Download==
The latest version, [[Media:TrafficControl_2.5.oxz|Traffic Control v2.5]], can be downloaded via the expansion manager or from the wiki by clicking on the link.

An older version, [http://www.box.com/shared/qah2zp7sq2 '''Traffic Control v1.11'''], can be downloaded from Box.Net by clicking on the link.

==Links==
*[[User:Thargoid|Thargoid's OXP page]].
*[https://bb.oolite.space/viewtopic.php?f=4&t=20180 BB Thread] (2019-20)
*[https://bb.oolite.space/viewtopic.php?p=59662#p59662 Original thread] (2008)

[[File:Tag-colour-blue.png]]{{OXPLevel|0}}
{{mechanics-OXP}}

Clippers

2026-08-05T10:27:22Z

Phkb: Updated version

[[Image:newClipperComp-750.png|right]]

==Overview==
Inspired by the great Clipper ships of Old Earth's 19th Century the Boa II Clipper was developed by the Gerege Federation Space Works as a result of extensive market research carried out for them by respected pollsters Moori. The research indicated that there was an un-filled niche in the market for a very fast combat-capable transport, a ship capable of covering great distances comfortably, safely, but most of all, quickly.

To keep development time and costs down it was decided to adapt the proven hull of the Boa Class Cruiser, rather than design a new ship from scratch. As the Boa CC was strong, capacious, and very manoeuvrable, little needed to be done other than increase the engine power. By enlarging the engine room they were able to shoe-horn in a third Stardrive, thus giving the Clipper an immediate 50% power increase over the Class Cruiser, and a top speed of a highly creditable 0.362 LM. The trade-off is a 25 ton reduction in cargo space, but the remaining 150 tons capacity was considered more than adequate.

Following the success of their Clipper upgrade to the Boa 2, the Gerege Federation SpaceWorks felt that a similar upgrade to a smaller freighter would also be worthwhile. Following negotiations with Whatt and Pritney, they obtained a licence to adapt Python hulls to 'Clipper' specification.

Both Python and Boa Clippers have sacrificed some cargo space to allow fitment of extra drive units allowing higher top speeds. GFS favour the DeClapton and Layla Quark-scintillation StarDrive as these units are powerful yet compact and are extremely reliable.

In keeping with their role as long distance express transports, both Clipper models are equipped as standard with Fuel Scoops and Heat Shielding to allow 'sunskimming', and with the introduction of the Python variant external secondary fuel tanks were introduced across the range. These hold 3LY of fuel and this can be moved into the main tanks when they are empty.

These ships have custom HUDs, with a clear logical layout optimised for combat situations.

If an NPC is severely damaged in battle and the pilot ejects the ship will progressively become derelict. The ship loses power and the navigation strobes will stop, the lights fade, followed by the engine glow, and finally the derelict is left gently tumbling in space.

{{:Python Clipper Class}}{{:Boa II Clipper Class}}

==Compatibility==
This OXP is compatible with [[ExtraFuelTanks]] OXP. Both OXPs can be installed together. If you fly a Boa or Python Clipper with External Fuel Tanks you will not see ExtraFuelTanks offered, but if you have several Commanders flying various ships and use ExtraFuelTanks these will continue to work normally.

==Author==

OXP by [[User:Smivs|Smivs]]

==Credits==

Many thanks to Griff for allowing me to 'borrow' the engine model from his 'Boa'.

==Licence==

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

==Version History==
Version 1.4.5 Released 5th August, 2026. Minor bugfix - shipdata.plist.

Version 1.4.4 Released 3rd March, 2018. Minor bugfix - shipdata.plist.

Version 1.4.3 Released 31st May, 2015. Bugfix to correct mis-named sub-entity key which was causing the OXP not to load.

Version 1.4.2 Released 30th May, 2015. Bugfix to allow the game to recognise older Boa Clipper player ships.

Version 1.4.1 Released 11th May, 2015. Bugfix release - code errors corrected for Mac compatibility and to fix 'derelict' feature for python.

Version 1.4 Released 5th May, 2015. Complete overhaul for v1.82.

Version 1.3.4 released 4th September, 2014. Updated custom HUDs and added normal and specular mapping, plus a few minor tweaks. Updated licence.

Version 1.3.3 released 2nd July, 2014. OXZ release, fully updated for Oolite v1.80.

Version 1.3.2 released 23rd January, 2013. Bugfixes to HUDs and requires.plist and made Oolite v1.77 compatible.

Version 1.3.1 released 9th June, 2012 Corrected AI error in shipdata.plist.

Version 1.3 released 18th may, 2012. Interactive features from Smivs'Shipset added. Now compatible with BattleDamage OXP

Version 1.2 released 10th January, 2012. HUD upgrade.

Version 1.1 released 3rd January, 2012. shipdata.plist error corrected - improvements to custom HUD

Version 1.0 Released 22nd December, 2011.

== Download ==
Download [[Media:Clippers_1.4.5.oxz|Clippers_1.4.5 OXZ]] (downloaded {{#downloads:Clippers_1.4.5.oxz}} times).

===Previous Versions===
[http://www.smivsonline.co.uk/oxps_Clipper.htm Clippers_v1.3.2 OXP] direct download from Smivsonline.

==Installation==

The latest OXZ can be downloaded/installed via the Expansions Manager.
To install the OXP version, unzip the download and place the .oxp folder in your Oolite AddOns folder. Please note that this is an older version, and that the current OXZ is recommended.

[[File:Griff Clippers.png|thumb|right|600px|Griff Clippers retexture]]
== Griff Clippers OXZ (Griffificated Retexture) ==
*Download [[Media:GriffClippers_1.1.oxz|GriffClippers_1.1.oxz]] (Phkb, 2026).
*Discussion [https://bb.oolite.space/viewtopic.php?t=22130 here]

==Oolite Forum thread==

Any questions, problems or bug reports should be posted on this OXP's BB thread [https://bb.oolite.space/viewtopic.php?f=4&t=11370 here]

==Gameplay and Balance indicator==

[[Image:tag-colour-blue.png]]

{{ship-OXP}}

File:Clippers 1.4.5.oxz

2026-08-05T10:25:26Z

Phkb:

File:Tori 2.4.oxz

2026-08-05T10:23:37Z

Phkb:

File:TrafficControl 2.5.oxz

2026-08-05T10:22:49Z

Phkb:

Ship Repurchase

2026-08-03T06:08:27Z

Phkb: Version update

[[File:EscapeCapsule-Oolite.png|left|thumb|300px|''If'' you bought an escape pod]]
[[File:Escape Suit 01.PNG|right|thumb|300px|And ... ''if'' you didn't!]]
==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.9 (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.9
* Fixed undefined reference error.

0.8
* Tighter integration with Library.
* Improved integration with the Nova mission.
* Fixed issues where cargo was not being correctly handled when repurchasing a ship after an interstellar or nova bailout.
* Implemented logcontrol.plist for debug messages.

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.9
|release = 2026-08-03
|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]]

File:ShipRepurchase.oxz

2026-08-03T06:07:31Z

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

Version 0.2

Planetfall2 OXP

2026-08-03T04:15:33Z

Phkb: Version update

[[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]] v1.4
*[[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.35.oxz|PlanetFall2_2.35.oxz]] (downloaded {{#downloads:PlanetFall2_2.35.oxz}} times).
* [[Media:PlanetFall2_ResourcesA.oxz|PlanetFall2_ResourcesA.oxz]] v1.1
* [[Media:PlanetFall2_ResourcesB.oxz|PlanetFall2_ResourcesB.oxz]] v1.0
* [[Media:Feudal_PlanetFall2_1.7.oxz|Feudal_PlanetFall2_1.7.oxz]] v1.7 (downloaded {{#downloads:Feudal_PlanetFall2_1.7.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.35
* Tighter integration with Library.
* Improved handling of nova conditions.

2.34
* Shipyard not moved to planet in Anarchy systems.
* Made ship maintenance available from stations in Anarchy systems.
* Methods for creating random location names should now create the same name for the same location, every time. No more name switching.
* Added some additional place naming methods for potential future use.
* Fixed issue with naming function for Leisure Complexes, where some of the elements in brackets were not being returned.
* Corrections to some number extraction processes.

2.33
* Fixed bug in $getPlanetFromLandingSite function.
* Tweak to monkey patch function.

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.35
|release = 2026-08-03
|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.35.oxz

2026-08-03T04:13:42Z

Phkb:

Traffic Control OXP

2026-08-03T03:42:28Z

Phkb: Version update

==Overview==
A little script which gives each system main station a traffic control department, whose job it is to guide new Commanders (and a few old hands who have become too reliant on docking computers) on the best route for manual approach and docking into the station. They oversee all traffic from station aegis and planetary approach right up until the actual docking itself. Also they keep an eye on ships leaving the station and wish people a bon voyage. Just don't dally in the approach lane and get in everyone's way, or you'll feel their wrath!

Recommended for new players learning how to dock manually, and for experienced players who want a bit of extra ambience around main stations. It is fully integrated with the docking clearance protocols introduced in Oolite 1.72 (if the stations enable them). Most messages from this OXP will appear only if your ship does not have functional docking computers, but a few will appear regardless, for example: Clear the lane, Commander! If you see a message that starts with 'Traffic Control:' then it is probably from this OXP.

In terms of balance, this OXP is neutral for beginners and slightly biased against the experienced player, because it enforces (with fines and small but escalating bounties) a sensible rule against the use of cloaking devices in proximity to main stations... however, to be fair, it will not impose any penalties if you pass undetected (or at least unidentified). Of course, requesting docking clearance or activating docking computers will transmit your identity to the station...

This OXP is compatible with all other OXPs, and includes considerations for Buoy Repair, ILS and AutoDock if those OXPs are also installed.

==Requirements==
This OXP requires at least version 1.88 of Oolite.

The traffic controllers also assume that any Commander's ship equipped with Docking Computers can look after itself in terms of approach and docking.

==Version History==
<pre>
09/10/2008 - Version 1.00, Initial release.
04/11/2008 - Version 1.01, scripting update for v1.72+ compatibility.
24/05/2010 - Version 1.10, fortified equipment damage checking for 1.74
13/02/2011 - Version 1.11, removal of upper limit, to allow running with 1.75
08/07/2020 - Version 2.00, updated by Milo; set minimum Oolite version to 1.88;
*fixed errors if navigation buoy is destroyed;
*corrected planet approach guidance (follow green circle, not square, if ship has a basic compass);
*added additional hints for new players (until they buy docking computers);
*set up recurring reminders to "clear the lane" when not supposed to be there;
*integrated docking advice with docking clearance protocol for main stations that require clearance;
*added warning messages to fugitive players entering station aegis or requesting docking clearance;
*Cloaking Devices: added responses to being detected using cloaking devices in the station aegis (this OXP now declares it illegal to cloak within main station aegis and introduces a small bounty for the first offence, which will be increased for non-fugitive players each time they are detected still cloaked after the initial offence; however, entering the aegis cloaked and never interacting with the station will not impose a penalty as the traffic controllers are unaware of the trespass); added a 1000 credit fine (or equivalent bounty) to the arrival report when docking at main stations while cloaked (even if fast-docking is used);
*added considerations for nova systems (traffic control will leave a recording when sun has gone nova) and for Buoy Repair, ILS and AutoDock OXPs
07/11/2021 - Version 2.01, updated by Milo; fix bug reported by dybal (docking clearance "granted" status was not correctly detected, resulting in unintended behavior, particularly noticeable when combined with ILS OXP)
07/16/2021 - Version 2.02, updated by Milo; reduced the frequency of some messages, changed one word to be more situationally neutral, and fixed a log warning involving percent symbols; updated license from CC 3.0 to CC 4.0
07/06/2025 - Version 2.3, updated by phkb; Moved all text into descriptions.plist for easier localisation. Ensured all timers are stopped when docking at a station.
07/08/2025 - Version 2.3.1, updated by phkb; Added "use strict"; to main script file.
28/03/2026 - Version 2.4, updated by phkb; Reminders to leave the docking area are now not sent if player has docking clearance, improved handling of nova systems.
</pre>

==Download==
The latest version, [[Media:TrafficControl_2.4.oxz|Traffic Control v2.4]], can be downloaded via the expansion manager or from the wiki by clicking on the link.

An older version, [http://www.box.com/shared/qah2zp7sq2 '''Traffic Control v1.11'''], can be downloaded from Box.Net by clicking on the link.

==Links==
*[[User:Thargoid|Thargoid's OXP page]].
*[https://bb.oolite.space/viewtopic.php?f=4&t=20180 BB Thread] (2019-20)
*[https://bb.oolite.space/viewtopic.php?p=59662#p59662 Original thread] (2008)

[[File:Tag-colour-blue.png]]{{OXPLevel|0}}
{{mechanics-OXP}}

GalCop Missions

2026-08-03T03:41:01Z

Phkb: Version update

[[image:gcm_mission_example.png|right|500px|Sample mission]]
Adds over 80 different types of missions.

==Overview==
This OXP adds some local missions to the [[Bulletin Board System]], to hopefully add more things to do in and around each system. Very little by way of new ships, stations, equipment or AI's has been added to the game. The idea was to simply make use of the existing assets in new and (hopefully) interesting ways.

There are a number of different missions available, and the availability of these missions depends on a number of factors (score, system tech level, government type, installed equipment etc). Missions can be offered in a number of ways: via the Bulletin Board, from scooped escape pods, from passing ships, or from emails.

This OXP also includes the concept of "mission chains", in that completing one mission may trigger a second mission, which could then trigger a third mission, and so on. Sometimes the player is given an option as to whether they want to perform the secondary mission, and sometimes they won't be.

Generally, all the missions are optional. If you don't visit the Bulletin board, you won't see what's on offer, and very little in the game will change if you don't do the missions (although see the two sections below: Gameplay Impacts and Disease Outbreaks). You may occasionally be offered a mission when scooping escape capsules, and sometimes passing ships will pass on requests.

===Gameplay impacts===
Some of the missions in this pack can impact on other areas of the game. For instance, one type of mission, if completed successfully, will result in a higher frequency of mis-jumps to a particular system. Some missions can effect the commodities of a station, or the availability of equipment at a station. It will hopefully be obvious when these changes take place (ie as a result of completing a mission).

===Disease Outbreaks===
Another potential impact is on systems that are reported to have disease outbreaks. If a major outbreak occurs, GalCop might choose to lock down the system, preventing the disease from spreading off-world. When this happens, you might find you can’t jump to a particular system without a permit. Some pilots have reported there are ways around GalCop’s restrictions, but even if you do, you might find that GalCop stations in that system will physically prevent you from docking, and inattentive pilots might find their ship taking damage rather than entering the docking slot.

When a disease outbreak restriction is in effect, there might be missions you can undertake that will grant you the required permissions and passcodes to successfully enter the system and dock at the main station. These missions will likely be in systems close to where the outbreak is occurring.

==Mission Categories==
This mission pack contains over 80 different missions and variations, but most of the missions fall into one of these general categories.
* '''Hunter''' - Hunt down and destroy certain ships (asteroids, pirates, traders, Thargoids, police, etc).
* '''Recovery''' - Find and collect certain items (cargo, derelicts, black boxes, data packets, etc).
* '''Rescue''' - Locate and collect escape pods, deliver critical equipment to stricken ships, deliver medical supplies.
* '''Delivery''' - Take cargo between one point and another, but outside the normal cargo mission system.
* '''Covert''' - Install spying software, disrupt station economies, hack witchpoint beacons.
* '''Donation''' - Donate money or cargo to charities to gain economic or legal advantages.

==Required Equipment==
[[Fuel_Scoops|Fuel/Cargo scoops]] and the [[Advanced_Space_Compass|Advanced Space Compass]] are required for many of the missions. If your ship lacks these items, certain missions will be unavailable.

[[BroadcastComms_MFD|Broadcast Comms MFD]] is a requirement for many of the missions, as it provides an interface for ship-to-ship communications. If you have not purchased this item, some of the missions will be unavailable.

==New Equipment==
Some new equipment has been added with this OXP.
[[File:Range Finder (1).png|right|320px]]
[[File:Range Finder (2).png|right|320px]]
===Range Finder MFD===
When this item is purchased, installed and primed, you can press the "b" key (Mode) to switch the mode between escape capsules, black boxes, asteroids, ships, communication relays and cargo pods. Pressing the "n" (Activate) key will initiate a scan of the local area, up to a distance of 200km. The scan will take approximately 2 seconds to run, but will be run continuously until deactivated with the "n" key again. Any objects of the selected type within range will be displayed, along with the distance to the object. A "+" or "-" indicator will be displayed next to each item, showing whether you are moving away from (+), or towards (-), the target. When the target is less than 50km away, a simplified directional indicator will be shown instead, but outside this distance, the range finder does not provide directional information. The information returned by the scan is displayed in an MFD, so you will need to select an MFD slot (using the ":" key) and then select the Range Finder MFD (using the ";" key).

Direction indicators when distance < 50km:
O - Target is generally ahead of you
o - Target is ahead of you.
X - Target is directly ahead of you.
< - Target is to the left
> - Target is to the right
^ - Target is above you
v - Target is below you
A - Target is behind you (ie Aft)

Range Finder MFD
Techlevel: 5
Price: 250 cr

Note: When the Range Finder is activated, there will be a drain on your ships energy. If the [[Ship Configuration OXP|Ship Configuration OXP]] is installed, engaging the Range Finder will also generate cabin heat.

===Range Finder Extender===
An additional device, a Range Finder Extender, which increases the range of the scanner to 500km, as well as boosting the range for the simplified directional indicator to 75km.

Range Finder Extender
Techlevel: 9
Price: 2650 cr

===Comms Relay Beacon Switch===
This device will be issued to the player when attempting particular missions, although it can also be purchased independently from TL3 systems for 60cr. It is a primable piece of equipment that will communicate with any communication relays in the system and request the beacon to be switched on for a short period of time. The device can be used 3 times before needing to be recharged. Using the device will incur a 5% penalty on whatever mission the communication relay relates to.

Comms Relay Beacon Switch
Techlevel: 3
Price: 60 cr

===Comms Relay Beacon Switch Recharge===
This item will replace all the degraded parts of the switch, allowing it to be used 3 more times. The cost will vary, based on how degraded the current parts are. It is available in all systems.

===Cargo Stopper===
This device makes use of the [[Tractor Beam|tractor beam]] which forms part of the cargo scoops. When your ship is aimed at cargo cannisters that are floating away, it will automatically use the tractor beam to bring the cargo to a stop. Cargo must be within 2km of your ship, and in the centre area of your front viewscreen, otherwise the tractor beam can't reach it.

Cargo Stopper
Techlevel: 6
Price: 30 cr

===Ejection Damper===
This device attaches to the end of the cargo scoop, and when engaged, will apply some force to any ejected item so that it will slow to a stop within a short period of time, rather than floating away at a constant rate.

Once purchased, the unit must be turned on before any cargo will be impacted. Prime the "Ejection Damper" equipment, and press either the "Mode" (b) or "Activate" (n) key to turn the unit on. Pressing those keys a second time will turn the unit off. The unit is automatically turned off whenever your ship docks.

When the unit is on, all cargo ejected will be slowed to a stop. The device can be used on 50 ejected items before it needs to be replaced.

Ejection Damper
Techlevel: 7
Price: 100cr

==Required OXP's==
The following OXP's are listed as required:
* [[Bulletin Board System]] - Required as all missions are accessed through this interface.
* [[BroadcastComms_MFD|BroadcastComms MFD]] - Required for missions that need ship-to-ship communications to take place. Also used for accepting or declining secondary missions.
* [[Email_System_OXP|Email System]] - Provides another interface for missions to be offered.
* [[GNN]] - Provides text randomisation system used for mission descriptions. Plus, some news items will be published periodically, which can add some flavour to game events.

==Recommended OXP's==
The following OXP's are listed as recommended, in that additional text and/or gameplay options will become available if they are installed.
* [https://bb.oolite.space/viewtopic.php?f=4&t=17846 Manifest Scanner] - Can aid with finding cargo in other ships, which can be very important if you are on a mission to steal certain cargo.
* [[Cargo_Scanner_OXP|Cargo Scanner]] - Can help with some missions to identify the contents of cargo containers.
* [[Black Market]] - Some additional opportunities are available through the Black Market interface in this OXP.
* [[Satellites]] - Some missions are available related to the various satellites created by this OXP.

[[File:F4 Reputation.png|thumb|right|300px|After blasting some local pirates on a number of visits (no missions involved), this Jameson became a "Casual Acquaintance" of Ararus]]
==What else is in the box?==
'''Reputations:''' The missions available to the player originate from a number of different entities - governments, corporations, factions of every stripe. As missions are performed for these entities your reputation will increase. However, given the number of entities involved, a new F4 interface screen has been created that combines all reputation information into an easy to read display. Also, any awards received can be displayed as well.

If you have the [[Library OXP]] installed, you additionally have the option of importing a variety of internal and OXP reputations into the screen, rather than having those reputations displayed on the F5F5 Manifest screen.

<div class="mw-collapsible mw-collapsed" data-expandtext="Spoiler: show mission list" data-collapsetext="Hide list" style="overflow:auto;">
This is Phkb's working list, taken from his GalCopBB_Missions.js (April 2026 version) with inclusions from the other scripts.

There seem to be 81 fully functional missions (presumably those with the blue blobs!), with much code already written for the others (I have assumed that the satellite missions are all fully functional). (''Cholmondeley 12:19, 28 July 2026 (BST)'')

''Mission types''
:*1 - "Cleanup the spaceways": destroy x number of asteroids in the current system
:::any system, max of 1 mission of this type
:*2 - "Making the system safer": destroy x number of pirates in system y.
:::any safe system within 7 LY of a feudal or anarchy
:::record when mission is accepted and only offer another one to the same system after 10 days
:*3 - "Disrupting trade (System authority)": destroy x number of traders in system y.
:::any multi-gov or worse, near a safe system
:::record when mission is accepted and only offer another one to the same system after 10 days
:*4 - "Disrupting trade (Pirate authority)": destroy x number of traders in system y.
:::record when mission is accepted and only offer another one to the same system after 10 days
:*5 - "Thargoid hunt" - intentionally misjump between system X and Y and destroy N number of thargoid motherships (not tharglets)
:*6 - "Collect the deposit" (System authority): find dumped cargo in system X, deliver to system Y.
:::- cargo will be guarded by x number of high quality ships
:*7 - "Collect the deposit" (Pirate authority)
:*8 - "Pirates for hire (System authority)": attack trader ships in system X to get their cargo (n tons required),
:::return to system Y
:*9 - "Pirates for hire (Pirate authority)": attack trader ships in system X to get their cargo (n tons required), return to system Y
:*10 - "Pirate specific commodity (System authority)": find an amount of a particular commodity but only when in a particular system and only from piracy (not purchased from stations)
:*11 - "Pirate specific commodity (Pirate authority)": find an amount of a particular commodity but only when in a particular system and only from piracy (not purchased from stations)
:*12 - "Free slaves": (if IGT is installed) target all ships entering Communist or higher system, and if carrying slaves, demand cargo.
:::(Recommend the "Manifest Scanner" be installed)
:::Use BroadcastCommsMFD to "Demand slaves"
:::Ship will then have the ability to respond: either "OK" (and slaves are dumped), or "I'm not carrying slaves", or "Get lost"
:*13 - "Collect Thargoid wreckage" destroy thargoids and collect wreckage in interstellar space
:::add scenario where alloys are destroyed during flight
:::>> prevent thargoid alloys from being relabelled by Smugglers
:::>> prevent thargoid alloys from being put into storage by SC
:*14 - Gun runner: attack ships in target looking for firearms
:*15 - Drug dealer: attack ships in target looking for narcotics
:*16 - Civil unrest (pirate authority): destroy as many police ships in current system as you can
:*17 - Garbage scow: dump radioactive waste containers near sun so they are destroyed by heat
:*18 - Rival gang war (ie pirate hunt) (pirate authority)

''Escape Pods, Black Boxes & Derelicts''
:*20 - Find escape pod in particular system and rescue occupant
:::- when in range, send out a distress signal to the player
:*21 - interstellar escape pod rescue
:*22 - Find black box in particular system and collect it
:::- make this different from Rescue Stations by making the black box be inside the hulk of a destroyed ship
:::- need some way of locating ship hulk - maybe an intermittent comms signal?
::::- have console message appear saying "Weak navigation beacon signal ("U") being picked up."
::::- player switches ASC to find "U", gets a heading, then signal disappears. The further away the player is, the more inaccurate the ASC heading is.
::::- repeat until the player finds the hulk (ie is comes within scanner range)
::::- give player the option of selling black box on the black market
:*23 - interstellar black box recovery
:*24 - Destroy derelict ship, scoop data cache (special cargo pod) and return it to station
:*25 - catch runaway escape pod - escape pod ended up with a massive ejection speed and is on it's way to interstellar space.
:::a regular waypoint will be set showing the pods last position

''Ship-to-ship''
:*30 - Find and meet a particular ship in a particular system, will lead to secondary mission
:::- via BB as a mission
:::- via email when created as a primary mission
:::- via a random trader along space lane or at witchpoint
:*31 - go to waypoint in system y, receive message from comms relay
:*32 - Meet ship in system X, give them info package
:*33 - intercept ship carrying stolen data cache, (use Broadcast comms to demand data pack), which must then be scooped
:34 - track ship from witchpoint to station, then return
:::- if player gets with 25 km of target and appears to be following them (eg heading is roughly the same and the player is behind them) they will detect player and flee (mission failed)
:::- player can get closer if they are cloaked
:::this needs to be more interesting that just following them to the station.
:36 - Find ship in system X by sending a pass phrase to any/all ships - one of which will reply with a message with details of where to find special cargo to be returned to system Y
:37 - Find ship in system X by sending a pass phrase to any/all ships - one of which will reply with a message with details of where to find data point to be returned to system Y

''Delivery-type missions''
:*40 - Special delivery - player given unique cargo (poss using Smugglers illegal goods) or equipment, must deliver to remote point in destination, paid in precious metals/gems given to the player at the drop point
:*41 - Special delivery - player given cargo or equipment, must go to system X to find a data point, to get location of drop point in system Y, paid in previous metals/gems given to the player at the drop point
:*42 - special delivery: transport special computer equipment to ship, without docking at a station (docking will render the mission void)
:*43 - transport vital equipment to stricken ship to enable it to continue flying
:::- have option of giving player secondary mission here
:*44 - transport vital equipment to stricken ship in interstellar space to enable it to continue flying and escape
:45 - Special delivery (only used for a secondary mission. similar to 40 but without giving cargo) - player told to get Xt of commodity, then deliver to a remote point in destination, paid is precious metals/gems
:46 - pickup cargo from waypoint, delivery to another waypoint
:::will need a cargo shepherd, cargo stopper for ejection damper
:::arrival at one or other of waypoints could result in an ambush
:47 - (only used for a secondary mission. similar to 41 but without giving cargo) - player told to get Xt of commodity, go to X to find data point to get location of drop point in Y, paid in precious metals/gems

''Medical missions''
:*50 - deliver critical medical supplies to systems with "disease" as part of their description
:::- each day do a check for
:::(a) is a disease outbreak starting on a system?
::::only have, at most 2-3 outbreaks at any one time
::::when starting the outbreak, send a news item to snoopers, and define the end point for the outbreak (2-3 months ahead), define propagation chance
::::if a player transports medical supplies, take a day off the end point, reduce the propagation chance
:::(b) is a disease outbreak stopping on a system?
::::send an item to snoopers
:::(c) is disease spreading to a neighbouring system
::::there is a chance disease will spread to a neighbouring system - add it to the outbreak list, with a news item and end point
::::- medical supply missions offered only from hi-tech worlds (TL 12 and above)
::::expiry time is based on the volatility of the antibiotics being carried.
:*51 - Transport critically ill patients from disease system to high tech level destination
:*52 - Transport virus specimens
:*53 - collect 3 components for an experimental antidote from different parts of the galaxy

''Software hacking: Witchpoint beacons/stations''
:*60 - Hacking witchpoints
:::System authorities in system X are concerned about the flow of pirate traffic through their system. They want to hack into the witchpoint beacons of all systems within a 7LY range, that will enable them to monitor traffic flows into their system, outside of GalCop's purview.
:::- will require getting within 200m of witchpoint marker, targeting the marker and initiating the special equipment (prime, activate)
:*61 - Restoring witchpoints
:::GalCop has become aware of an illegal data stream emanating from witchpoint markers around system X. You need to go to each of the systems listed, and clean the illegal code from the units.
:::- will require getting within 200m of witchpoint marker, targeting the marker and initiating the special equipment (prime, activate)
:::- will only be available once mission 60 has been performed at a system
:*62 - deliver security software payload to pirate rock hermit that track all ships coming and going from the station
:::- need to use cloaking device to dock with hermit. going red alert within 50k of station will result in mission failure.
:::>> TEST
:*63 - (from non galcop stations) deliver software payload to main station that will disrupt the trade computers (allowing all commodities to be purchased for 1 cr). (possible) for a period of 2 weeks
:::- when installing the software you will be asked what amount to set commodity prices to. You must enter the number specified in the mission description (either 1 or 99).
:::- you have to launch within 2 minutes of installing the software (and not redock again for 24 hours) otherwise GalCop will be able to trace the upload and you'll get hit with a massive fine (10000cr, 200 bounty)
:*64 - (from non galcop stations) deliver software payload to main station that will disrupt the equipment page, preventing any access for a period of 2 weeks.
:::- you have to launch within 2 minutes of installing the software (and not redock again for 24 hours) otherwise GalCop will be able to trace the upload and you'll get hit with a massive fine (10000cr, 200 bounty)
:*65 - get galcop system software
:::Player needs to do a multi-step process in order to get the software:
:::1. go to destination (a multi-gov of lower system with TL > 7) and pick up customised escape pod from any non-GalCop station (mission screen will inform player of installation)
:::2. return to system and use customised escape pod at more than 100000k from main station
:::3. after redocking, launch and wait for the next police ship to launch
:::4. follow police ship - it will self-destruct after 5-10 minutes, spewing an escape pod and a cargo item.
:::5. Scoop the cargo item and return it to the source station.
:66 - Perform scan of rock hermits, possibly while cloaked, return collected data
:::- need to create scanning equipment item
:::- harvest phase scanner code from Smugglers for general operating params
:67 - Perform scan of main station, possibly while cloaked, return collected data

''Solar activity system missions''
:*70 - Use scan equipment to take close up measurements of sun
:::get to fuel scoop dist = ((system.sun.collisionRadius * system.sun.collisionRadius) / system.sun.position.squaredDistanceTo(player.ship.position)) > 0.75;
:::prime scanning device, activate
:::await completion
:::If player retreats before scan is complete, scan will stop, but will restart automatically when in range again (ie it won't start from the beginning)
:*71 - Recover data cache in low orbit over sun
:::find data cache
:::transmit security code
:::await data package
:72 - Launch monitoring devices (special cargo or missiles)
:::must deploy 2 special cargo items from within fuel scoop range, one on the planet side, the other on the far side of the sun.
:*73 - Variation on 70: Go to another system to pick up new equipment, then bring it back and scan the sun
:*74 - Take solar data to hi-tech system for analysis
:75 - return analysed solar data to original system?
:76 - Recover derelict ship near the sun (derelict will be given a high heat shield rating to prevent destruction)
:::- Use DeepSpaceDredger for equipment/process of ship recovery?

''Charity missions''
:*80/81/82/83 - Give credits to entity
:*84/85/86/87 - purchase and give commodity to entity (slaves for AI, any for the others)
:88 - purchase any commodity (not slaves, firearms or narcs) and give to AI
:89 - donation to nationalist entity of system
:::- reward of better commodity prices?
:::maybe just better prices on illegals?
:::- reward of better equipment prices?
:::- reward of better ship prices?
:? - donation to religious entity

''War zone missions''
:*90 - evacuate refugees
:*91 - transfer injured
:92 - import weapons

''Earthquake system missions''
:*100 - Use scan equipment (seismic resonance scanner) to scan planet in 3-4 locations
:::player must get in low enough orbit to perform scan successfully
:::have some way of informing the player where the scan points are - waypoints, must be within 2km of waypoints
:*101 - transport injured people to hi-techlevel system for treatment
:*102 - destroy a number of asteroids around the planet. The gravitational effect of the asteroids means instability on the surface
:103 - collect and deliver special equipment
:*104 - take seismic data to hi-techlevel system for data analysis

''Satellite missions (when Satellites OXP is installed)''
:*110 - Extract data
:*111 - Install new firmware
:*112 - Destroy satellite
:*113 - Hack satellite
:*114 - insert data

''Investigations''
:*130 - a stash of cargo pods with precious metals/gems
:*131 - a ship graveyard
:*132 - a damaged escape pod
:*133 - a pirate base
:*134 - a thargoid trap
:*135 - a proximity mine that causes a fuel leak
:*136 - a spooky noise/comms
:*137 - a pirate trap
:*138 - an asteroid field with blackbox
:139 - (currently unused)
:*140 - destroy pirate base
:*141 - deliver goodbye messages

''Defence/escort missions''
:*150 - defend anaconda from pirates
:151 - defend liner from pirates (need liners OXP installed)
:*152 - defend main station from pirates
:153 - defend other galcop station from pirates (OXP required)
:*154 - defend main station from thargoids
:155 - defend other station from thargoids (OXP's required)
:*156 - defend witchpoint beacon from thargoids

:160 Scan planet from low orbit
:::requires to maintain a low orbit for a certain amount of time, with some possibility of attack

</div>

==Download==
Download [[Media:GalCopMissions_0.15.oxz|GalCopMissions_0.15.oxz]] (downloaded {{#downloads:GalCopMissions_0.15.oxz}} times). 
Download [https://app.box.com/s/wo2nfn3j1xkkjinfu3ytgn810r7gkr2v GalCopMissions.zip] v0.15 (extract OXP folder to AddOns)

==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/

Thanks to Svengali and Disembodied for their PhraseGen tool. 
Thanks to Ramirez for his remote mine model (from the "Missiles and Bombs" OXP). 
Thanks to these forum members who have submitted bug reports or suggestions that have helped make the OXP better: Nite Owl, herodotus, Astrobe, Damocles Edge, Cody, Bogatyr, pagroove, gsagostinho, Cmd. Northgate, Balisongdalo, javirodriguez, and lohcek.gsagostinho, Cmd. Northgate, Balisongdalo, javirodriguez, and lohcek. 
Special thanks to cim who has very kindly given permission to include his "Black Box" model from [[RRS_Group|Rescue Stations]] in this OXP. 

No entry sign image from http://simpleicon.com/no_entry_sign_1.html 
Warning sign image from http://simpleicon.com/warning-2.html 
Tick image from http://simpleicon.com/ok_1.html 
Pill image from http://simpleicon.com/pill_3.html 
Star badge from https://www.iconfinder.com/icons/1031361/award_badge_best_prize_reward_icon#size=512 (Free for commercial use) 
Round badge from https://www.iconfinder.com/icons/465072/achievement_award_label_medal_politic_win_winner_icon#size=512 (Free for commercial use) 
Star medal from https://www.iconfinder.com/icons/111092/medal_icon#size=512 (CC BY-SA 3.0) 
Star medal on ribbon from https://www.iconfinder.com/icons/316245/medal_icon#size=512 (Free for commercial use) 
Trophy image from http://simpleicon.com/trophy_1.html 
Cup image from http://simpleicon.com/cup.html 
Candle image from http://simpleicon.com/candle-2.html 
Family image from http://simpleicon.com/chat_10.html 
Education image from http://simpleicon.com/wp-content/uploads/knowledge.png 
Head image from https://www.shareicon.net/download/2016/04/17/751132_people_512x512.png 
Raining image from http://simpleicon.com/wp-content/uploads/lightning__raining_2.png 
Biohazard image from https://www.freepik.com/free-vector/biohazard-yellow-circle-sign-graphic-illustration_2631298.htm#fromView=search&page=1&position=0&uuid=040f7aab-af6b-4231-9d3d-7f20cc869cd0" Image by rawpixel.com on Freepik 
Tractor beam sound effect by Finnolia Productions Inc from http://www.soundeffectsplus.com (see licence here: https://www.soundeffectsplus.com/content/license/) 
Sound effect from https://freesound.org/people/jmorrisoncafe330/sounds/110097/ (license https://creativecommons.org/licenses/sampling+/1.0/) 
Sound effect from https://freesound.org/people/klankbeeld/sounds/169334/ (license https://creativecommons.org/licenses/by/3.0/) 
Sound effect from https://freesound.org/people/klankbeeld/sounds/239633/ (license https://creativecommons.org/licenses/by/3.0/) 
Sound effect from https://freesound.org/people/flint10/sounds/197547/ (license https://creativecommons.org/publicdomain/zero/1.0/) 
Sound effect from https://freesound.org/people/Robinhood76/sounds/219853/ (license https://creativecommons.org/licenses/by-nc/3.0/) 
Sound effect from https://freesound.org/people/Robinhood76/sounds/333230/ (license https://creativecommons.org/licenses/by-nc/3.0/) 
Sound effect from https://freesound.org/people/staticpony1/sounds/249597/ (license https://creativecommons.org/publicdomain/zero/1.0/) 
Sound effect from https://freesound.org/people/TheBillinator3000/sounds/333845/ (license https://creativecommons.org/publicdomain/zero/1.0/) 
Sound effect from https://freesound.org/people/InSintesi/sounds/346295/ (license https://creativecommons.org/licenses/by/3.0/) 
Sound effect from https://freesound.org/people/lennyboy/sounds/275186/ (license https://creativecommons.org/publicdomain/zero/1.0/) 
Sound effect from https://freesound.org/people/AlienXXX/sounds/168511/ (license https://creativecommons.org/licenses/by/3.0/)

==Discussion==
This OXP is discussed at this forum link: https://bb.oolite.space/viewtopic.php?f=4&t=18745

==Version History==
0.15
* Updated methods for third party heat application in Ship Configuration.
* Fixed issue with Nova mission detection for creating award.

0.14
* Market prices on disease outbreak systems now boosted, and quantities reduced. If you can get there, it's probably worth it.
* Added a hint for the player if they attempt to jump into a quarantined system and are blocked by GalCop.
* Suppressed Rescue Stations ambience for disease systems, to prevent confusion over lockdowns.

0.13
* Added ability to call functions when testing conditions.

0.12
* Added Galactic Navy as a reputation entity, and added it to some missions.

0.11
* Fixed issue with "Recover stolen items" mission, when recovering the stolen documents, where the mission could not be completed.
* Darkened overlay images for better compatibility with Oolite 1.92.

0.10
* Fixed more issues with the Satellite missions.

0.9
* Really corrected issue preventing some satellite missions from being completable if the Galactic Almanac OXP is installed.
* Sound now plays when a fuel leak occurs.
* Tweaks to the reputation system to allow for complete localisation through descriptions.plist.
* Made some reputations visible on the reputations screen, even if the actual reputation value is zero.
* Fixed issue where some missions with a minimum player score were being offered to players under that value.
* Moved as much text as possible into descriptions.plist for slightly easier localisation.
* Added prebuilt descriptions for each mission that uses PhraseGen, so PhraseGen can be avoided when translating text. See notes in descriptions.plist or galcopbb_missiondetails.js for details.
* Bug fixes.

0.8.2
* Fixed referencing errors in spawning scripts for "Recover special cargo" (type 24) and "Black Box recovery" (type 22) missions.
* Fixed issue with mission state not being correctly recorded when the derelict is destroyed in black box recovery missions (types 22/23).
* Fixed issue with invalid functions calls for meet ship missions (type 30).
* Fixed issue with the meet ship mission, delivered by email (type 30), that wouldn't generate a second mission when you meet the target.
* Added clarity to "Computer Delivery" mission (type 42), so when the target ship is destroyed, the mission is failed.
* Removed "Computer Delivery" from being a follow-up mission.
* Fixed reference error bugs with investigation missions (types 130-138).
* Fixed issue with email missions causing a JS exception.
* Fixed invalid descriptions lookup key.
* Grammar corrections.

0.8.1
* Fixed referencing error in data cache missions (type 41) that was preventing the mission from being completable.

0.8
* Added a 10% penalty to cargo recovery missions (type 6) for each cargo pod the player destroys.
* Destroying a cargo pod in a "Cargo Recovery" mission will now trigger a mission status update.
* Fixed multiple issues with the descriptive text for "Cargo Recovery" missions (type 6).
* For type 6/7 missions, changed reward calculation to be based on the value of the commodity being collected.
* Excluded escape pods from being considered in the "Pirates for Hire" mission (type 8) when slaves are being sought.
* Adjusted spawning rules for ship with stolen items (type 33), to ensure they always spawn in scanner range of the player.
* Fixed bug in special delivery mission (type 40) that was preventing key information from being updated.
* Tweaked special delivery mission (type 40) so mission complete percentage doesn't go above 100%.
* Added missing position to a "Computer delivery" mission (type 42) description.
* Bug fixes in disease outbreak script (types 50-52).
* Fixed issue with disease outbreak systems, where system traffic wasn't being reduced, and GalCop station docking wasn't being prevented, in the case where the player doesn't have a valid permit.
* Added a screen displayed when docking at a station to inform player of disease lockdown systems with 7LY.
* Fixed grammar in descriptive text for "Hacking the witchpoint" mission (type 60).
* Fixed issues with mission details and grammar for station disrupt missions (type 63).
* Fixed issues preventing the disrupt station missions (type 63/64) from being completable.
* Reduced eject distance for the "Acquire GalCop Software" mission (type 65).
* Fixed issues preventing the "Acquire GalCop Software" mission (type 65) from being completable.
* Beacon labels are now turned off after collecting data from Solar Monitors (type 71).
* Updated manifest and BB status entries for donation missions (types 80-87) so that after a partial donation the status shows how much is remaining to donate.
* Removed waypoints from terminated or failed Seismic Scan missions (type 100).
* Fixed issue with manifest entry for "Asteroids in low orbit" mission (type 102), where it did not show progress towards completion.
* Fixed issue with completing the "Deliver Seismic Scan Data" mission (type 104), where the equipment item wasn't being removed.
* Destroying a satellite will now update the mission objectives (types 110-124).
* Corrected issue preventing some satellite missions from being completable if the Galactic Almanac OXP is installed.
* Fixed bug when spawning satellite defenders that was preventing the AI from being switched.
* Tweaked how far you have to go past the reference point before the unidentified signal is started in an Investigation mission (type 130-138).
* Tweaked descriptions for investigation missions to include a "reference point" past which a fair distance must be travelled in order to find the signal.
* Tweaked the location of unidentified signals in Investigation missions (type 130-138).
* Fixed spelling in "Defend station from attack" mission (type 152) description.
* Added some lurking pirates outside pirate bases.
* Added some extra details to manifest entry for missions that send to you a specific location in a system.
* Ejection damper now includes "uses left" in a console message when turned on and again when used.
* Switched a few mission types to stop the clock when complete.
* Switched a lot of mission types to be completable at any main station.
* Fixed issue that was preventing the Range Finder equipment from detecting mission-based escape pods.
* Fixed issue that was preventing the Range Finder equipment from detecting derelict ships.
* Added a simplified directional indicator to the Range Finder for when scanned items are less then 50km distant.
* Fixed issue where cargo collected for missions wasn't being handed over correctly and removed from the player's hold.
* Fixed issue where scooping more cargo than the mission requirement would cause some display and calculation irregularities.
* Fixed issue where the F5F5 manifest page wasn't getting updated correctly for missions that have multiple items to collect if items had been destroyed.
* Fixed various other grammar issues in mission text.
* Fixed grammar in readme.txt.
* Set global debug flag to false.
* Code refactoring.

<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">
0.7.0
* Fixed bug in "Extract telescope data" mission, where the wrong satellite types were being used in the calculations.

0.6.9
* Fixed issue where scooped Thargoid metal fragments were not being counted towards mission objective (type 13).
* Code refactoring.

0.6.8
* Fixed referencing errors with hit team docking notifications.
* Fixed JS error when in interstellar space while a slave rescue mission is active.
* Fixed JS error for disease outbreak systems.
* Fixed description for blackbox secondary mission that wasn't putting location into the details.
* Will now try up to 10 times to create a secondary mission after meeting a ship.
* When no secondary mission can be created after meeting a ship, a message providing some explanation is now given.
* Improved process for detecting and flagging alloys as having come from Thargoid vessels (type 13).
* Hit teams bug fixes.
* Bug fixes.

0.6.7
* Added mission type 18 to available missions.
* Fixed spelling error in function names for Collect ingredients mission (type 53).
* Fixed issue with possibly changing the status of the "defend the anaconda" mission (type 150) after completing it successfully.

0.6.6
* Turned off debug flag on investigation missions.

0.6.5
* Completing some missions will now reduce the players bounty.

0.6.4
* Fixed issue with the Reputations screen not showing some items.

0.6.3
* Removed customised PhraseGen code, made GNN a requirement for the OXP.

0.6.2
* Fixed a bug with donation missions and integration with Market Observer.

0.6.1
* Fixed error when repairing the Range Finder.
* Tweak to cargo stopper process for mild performance improvements when selecting targets.
* Fixes to the descriptions for slave repatriation missions (type 84).
* Fixes to the description for the Destroy Satellites mission (type 122).
* Donating cargo or slaves to charities will now update Market Observer (if installed).
* Adjusted time limit for satellite download missions.
* Tweaked manifest descriptions on satellite missions to better communicate distinct requirements for missions.
* Range Finder now compatible with GalTech Escape Pods.

0.6.0
* Cargo stopper is now activated automatically when cargo is targeted, in front of the player ship and in range, negating the need for priming and activating the equipment.
* Fixed stealing cargo missions, where it was possible to hand in cargo at stations other than the originating station.
* Improved mission status messages for stealing cargo missions to show how much has been collected.
* Bug fixes.

0.5.9
* Fixed some instances of timers being recycled while running.

0.5.8
* Fixed issue with delivery missions, where comms relay was not being spawned due to a Javascript error.

0.5.7
* Fixed some issues with retrieving data from stored settings used when the system populator runs.
* Cleaned up the process of setting ship scripts in all script files to prevent scripts not being present when required.

0.5.6
* Bug fix in spawning routine for derelict ships for black box missions (type 22).
* Fix to (hopefully) prevent scenario where mission ships were not being spawned.

0.5.5
* Small text adjustments for game consistency.
* Fix JS error in satellite missions.

0.5.4
* Improved logic for adding ships to a system.
* Fixed invalid reference error when generating missions.
* Better use of new functions available in later versions of Oolite.
* Corrected use of samplePrice method.

0.5.3
* The number of asteroids required to complete the Asteroid Removal missions (type 1) is now restricted to be less than the number of asteroids currently in the system.
* Fixed bug in the Hit Teams script where the definition of the "$initiateInvestigation" routine was inaccurately declared.

0.5.2
* Fixed invalid variable reference error.

0.5.1
* An email will now be sent to the player when they accept their first mission to Interstellar space, offering tips on how to enter interstellar space, and what to expect when they get there.

0.5.0
* Added some civil warzone missions (types 90, 91).
* Added defence missions (types 150, 152, 154, 156).
* Added a new delivery mission (type 46), which involves collecting cargo from a waypoint, and dropping it at another waypoint.
* Added a new investigation mission (136). Be afraid...
* Added secondary mission (type 74) to solar activity missions (70, 71, 73).
* Fixed error in description for solar activity mission (74).
* Fixed issue preventing the "gather ingredients" mission (53) from being created.
* Fixed issue with the "Remove Ejection Damper" equipment item, which wasn't removing the ejection damper equipment.
* Fixed issue with cargo recovery missions (6, 7), where ejecting and re-scooping cargo pods would throw the mission status out of kilter.
* Fixed manifest entry for the upload surveillance data mission (118) which was showing the wrong destination.
* Fixed some missions that were not including a player-rated bonus in their payment amounts.
* Defend satellite missions (124) were not being created for players with more than 64 kills.
* Upgrade satellite firmware missions (115) now have proper pass codes to transmit to the satellites.
* Tweaked the payment amount, and completion time requirement for satellite firmware update missions (115).
* Completing the delivery of personal messages for a dead pilot (141, secondary mission after investigation mission 132) now done manually.
* Limited some Thargoid missions to only be available in frontier systems.
* Updated description of Range Finder MFD equipment on F3 screen to include mention of cargo pods mode.
* Tweaks to the custom assassin AI routines to eliminate null target conditions.
* Various adjustments to the manifest entry for many missions.
* Spelling corrections.
* Bug fixes and code refactoring.
* Added a method to main script to allow for any mission to be easily tested during runtime ($testMissionType).

0.4.0
* Added "Cargo pod" mode to Range Finder.
* Fixed error with Range Finder when scanning for Black Boxes. If non-ship entities were in range (eg planet, sun), a Javascript error would occur.
* Changing the Range Finder mode will now clear the MFD of previous scan results.

0.3.7
* Fixed bug with missing variable declaration in failed mission function call.

0.3.6
* Removed debug flag that would cause a particular mission to always be generated.

0.3.5
* Fixed issue with secondary mission after investigation mission (132) not having correct destination on manifest.
* Code refactoring.

0.3.4
* Fixed title in manifest.plist file.
* Fixed missing reference error when completing data cache missions.
* Fixed missing reference error when completing black box missions.
* Fixed missing reference error when completing meet ship missions.
* Fixed missing reference error when completing hacking/restoring witchpoint beacon missions.
* Fixed missing reference error when completing some solar activity missions.
* Fixed missing reference error when completing some disease outbreak missions.

0.3.3
* Added some fallback code in case cargo pods are not spawned with our preferred barrel type.

0.3.2
* Fixed incorrect worldScript name references in Pirate Bases script.
* Added extra qualification to mission destination texts that refer to main planet, to help distinguish the main planet from any additional planets.
* Tweaked one investigation mission to limit its availability to more experienced players with an upgraded ship.
* Fixed issue with the Thargoid wreckage mission (13) which wasn't recognising wreckage collected in interstellar space.
* Removed debug log messages.

0.3.1
* Fixed spawning issues for investigation missions (types 130-139).
* Tweaked the power of the proximity mine.

0.3.0
* Added investigation missions (types 130-139).
* Switched from using a dummy alloy ship entity as a navigational beacon to using a visual effect.
* Code refactoring, improving code reuse.
* Split more mission specific functions out of general script file to associated script file.
* Fixed issue with some missions having a decimal amount as part of the payment.
* Performance improvements when generating new missions for a system.
* Fixed status message with drug dealer mission (15).
* Bug fixes.

0.2.4
* Linked the MFD to Broadcast Comms MFD in the Auto-Prime Equipment OXP.
* Makes use of GNN OXP if installed.
* Improved handling of player ship death scenarios.
* Fixed linkage to [[Home System]].

0.2.3
* Added the Ejection Damper equipment.
* Reduced the effective range of the Cargo Stopper to approximately 2km to make it slightly less OP.
* Added a sound effect for the tractor beam when activated.

0.2.2
* Tweaks to the positioning of ships for "Special Delivery" missions (40/41).
* Fixed issue with "Special Delivery" mission (40), where the target ship was not responding to the "I don't have any more" comms message.
* Tweaks to the scavenger AI, so the target ship doesn't jump out of the system prematurely.
* Added Advanced Space Compass as a requirement for "Special Delivery" missions (40).
* Removed some debug messages.

0.2.1
* Fixed issue with escape pod rescue missions (21, 22, 25) not being completable.
* Moved more interstellar populator routines into the correct methods.
* Removed some hard-coded scanner range values.
* Spelling corrections.

0.2.0
* Fixed issues with the "Collect cargo" (6/7) missions, where scooped cargo was being counted as destroyed instead of collected.
* Fixed issue with "Special Delivery" (40) missions where, if cargo was dumped and then re-scooped because it was drifting out of range, when the cargo was re-dumped the target ship was ignoring it.
* Fixed issues with missions that have multiple stages (types 41, 63, 64, 65, and 73) that weren't being initialised correctly and so would never start.
* Fixed issues with escape pod rescue missions (20) and runaway escape pod missions (25) that was preventing the escape pods from being spawned.
* Added a new device, a Comms Relay Beacon Switch, that is issued to the player for any "Collect data cache" (31) or "Special delivery" (41) mission. This device will turn on the comms relay beacon again after the initial transmission period has expired, although using it will incur a 5% payment reduction.
* Added a new device, the "Cargo Stopper", primable equipment available from TL6 systems, which, when pointed at moving cargo and then activated, will bring the cargo to a stop.
* Fixed issue where I.T.H.A. reputation was not being removed from the F5 page correctly when reputations were set to be moved to the "Reputations and Awards" page.
* Forced bonus payment calculations to return an integer, rather than a decimal.
* Some mission text tweaks.

0.1.5
* Adjustments to the population routines for interstellar space.
* Fixed bug where reputation was not being applied correctly for missions where multiple reputation entities were defined.
* Fixed bug with distance calculation in the Disease Outbreak script.
* Adjusted time calculation for travel between threatened satellites during a satellite defend mission.
* Added reputation links to [[Home System]] OXP.
* Better handling of Combat Simulator.

0.1.4
* Adjusted calculation of the number of deaths from a disease outbreak.
* Fixes to secondary missions sourced from black boxes or escape pods or passing ships having a termination penalty.

0.1.3
* Reworked all the cargo collection mission types (8,9,10,11,13,14,15) so that mission updates happen when cargo is handed in, not when it is scooped (although a notification will still be given to the player that the cargo was suitable for the mission). Expiry time has also been removed, and maximum quantity can now be greater than the player's available cargo hold.
* Fixed issues with Thargoid wreckage collection missions, so alloys can now be successfully handed in, and (hopefully) alloys from any Thargoid warship (including OXP Thargoids) should now be acceptable.
* Applied some fixes for the "Stranded ship" mission to stop the ship from moving before receiving help.
* Code refactoring.
* Bug fixes.

0.1.2
* Tweaked the energy drain of the Range Finder.
* Added sound for when the Range Finder scan is stopped.
* Removed debug flag from "Thargoid wreckage" missions, so they shouldn't appear as frequently.
* Fixed cargo dontation charity missions that were only being made available if the local market had slaves.
* Code refactoring and (hopefully) performance improvements.

0.1.1
* Fixed bug with Thargoid wreckage mission that was preventing the wreckage from being recognised.
* Made the "Collect Thargoid wreckage" mission have no expiry, and provided a means by which you can hand over incomplete amounts and continue.
* Removed debug flag from "Interstellar escape pod rescue" missions, so they shouldn't appear as frequently.

0.1.0
* Added some missions using Satellites OXP (types 110, 111, 113, 115, 122, 124).
* Fixed issue where emailed missions, or missions delivered via another ship, were not checking all the conditions, giving the player a mission they couldn't complete.
* Fixed issue with "Request for meeting" missions, where the target would not respond when the passcode was transmitted.
* Added additional text to mission briefing for missions that require an interstellar space destination to make it clearer this is required.
* Added additional text to mission briefing to make it clearer when a mission requires the player to return to the source system in order to complete it.
* Applied distance and player score bonuses to Special delivery missions (type 40).
* Fixed issue with the WBSA device not being startable when the beacon is targeted.
* Fixed issue with the Range Finder not creating an energy drain.
* Mission text tweaks.

0.0.9
* Added "Gather ingredients" mission (type 53).
* Fixed issue where missions with a deposit could have a negative net payment if the player's reputation is low.
* Fixed issue with manifest entries not reflecting the state of progress correctly.
* Reworked how textures are specified in mission definitions.
* Added overlay images to charity missions.
* Added routines to control the creation of asteroid fields, so they will be created in the same place in each system, and reused for future missions.
* Fixed issues with mission descriptions missing some text elements.
* Fixed issue with cargo recovery mission text containing ">undefined".
* Fixed issue with RRS reputations causing a JavaScript error when opening the "Reputation and Awards" F4 screen.
* Headings on the reputations page will now be suppressed if there are no related items to display.
* Converted text for mission types 74, 100, 101 and 102 to use the PhraseGen tool.
* Some tweaks/fixes to mission text.
* Code refactoring.

0.0.8
* Better logic for determining what is a witchpoint buoy.
* Better client name generation using PhraseGen tool.
* Fixed minor text issue with the "decline mission" for escape pod messages.
* No mission accept/complete confirmation emails will be sent for secondary missions when the source of the mission is an NPC from an escape pod or a ship.
* If player ejects escape pod while in pod occupant is communicating, conversation will stop and mission offering will be correctly terminated.
* Fixed error when scooping escape pod with no "crew" set (ie equivalent to scooping 1t slaves)
* Improved robustness of "Rescue Stricken Ship" missions.
* Fixed issue where stricken ships were not communicating with player correctly.
* Fixed error when firing on the stricken ship after it was repaired.

0.0.7
* Better logic for determining if a pirate ship has just been destroyed.
* Added a "+/-" indicator on the Range Finder MFD, to make it clearer in which direction the player is moving in relation to the target.

0.0.6
* Prevented Cargo Shepherd magnets from being targeted by delivery ships.
* Corrected issues with intergrating to the Smugglers Black Market script.

0.0.5
* Fixed mess left after code refactoring. :(

0.0.4
* Fixed issue with escape pod missions not being complete-able.
* Turned off lights on derelict ships.
* Code refactoring to reduce the chance of scripts for various mission types conflicting with another.
* More robust logic for connecting with Smugglers Black Market.
* Bug fixes.

0.0.3
* Made compatible with Oolite v1.84.

0.0.2
* Initial public release.
</div>

== Quick Facts ==
{{OXPLevel|1|4}}{{IconOXP|ooVersion="1.84"|oxpCPU="Average"|oxpMEM="Average"|oxpGPU="Low"|oxpIsConfigurable=true}}
{|class="floatright" style="alignment:right;margin: 0 auto;"
|[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
|[[Image:IconBB.png|48px|right|link=Bulletin Board System|alt=Missions offered through the 'Bulletin Board System']]
|[[Image:IconGNN.png|48px|right|link=GNN|alt=News items displayed through GNN]]
|}
{{Infobox OXPb| title = GalCopMissions.oxz
|version = 0.15
|release = 2026-08-03
|license = CC BY-NC-SA 4.0
|features = Missions
|category = Missions OXPs
|author = [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=18745 Oolite BB]
}}

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

System Features Rings

2026-08-03T03:39:25Z

Phkb: /* Quick Facts */

This OXP adds some dust rings to a few planets in each galaxy.
[[File:Systemrings1.jpg|700px|right]]

== Overview ==
This .oxp generates a wide variety of different ring systems which encircle the planets.

There are a number of other effects (as for example when one enters the atmosphere of a planet and looks at the rings)

If a system's main planet has rings, it will also be noted on the [[F7 screen (data on "system")|F7 screen]].

The rings can prove very useful for (''eg.'') helping locate rock hermits which are close to them
:Check out [[Sector1/Isinor|Isinor]] where the RH is between the rings (to which it is close) and the sun.

The original .oxp was crafted by [[User:cim|cim]] in 2013 and then upgraded by [[User:Gsagostinho|Gsagostinho]] in 2017-18 (with the improvements to Oolite's shaders).

 
==Images==
<gallery>
Image:systemrings1.jpg|Rings as in version 2.9
Image:systemrings2.jpg|Transparency is now supported in Oolite 1.87
Image:systemrings3.jpg|Close up of new rings
Image:Gsagostinho.SystemFeatures.Rings.2.3-screenie1.jpg|Previous version of rings
Image:Gsagostinho.SystemFeatures.Rings.2.3-screenie2.jpg|Rings now have different thickness
Image:Gsagostinho.SystemFeatures.Rings.2.3-screenie3.jpg|As well as different number of main gaps (in this case, 2)
Image:Gsagostinho.SystemFeatures.Rings.2.3-screenie4.jpg|As we get closer, their granular structure becomes visible
Image:Gsagostinho.SystemFeatures.Rings.2.6.screenie1.jpg|Close up detail
</gallery>

== Download ==
Download using the extension manager in the game, or using the following link: [http://wiki.alioth.net/img_auth.php/5/5d/Cim.gsagostinho.SystemFeatures.Rings.oxz System Features: Rings 2.10.4]. (Requires Oolite 1.84 or later)

03/08/2026 - Version 2.10.4:
* Check for valid fcb before attempting to remove it.

16/10/2018 - Version 2.10.3:
* Fixing a newly introduced bug in the visuals of the gaps in the rings.

13/10/2018 - Version 2.10.2:
* some more minor optimizations.

09/10/2018 - Version 2.10.1:
* more optimizations.
* rings get more transparent when entering an atmosphere.

09/10/2018 - Version 2.10:
* optimized some of the shader's code (thanks Svengali!).

07/10/2018 - Version 2.9:
* better handling of the alpha channel .

23/09/2017 - Version 2.8.1:
* bug in the description text now properly solved, it was still present due to a small oversight (thanks again, Cody).

23/09/2017 - Version 2.8:
* changed description text to "This planet has rings."
* fixed a bug in which the description text appears many times (thanks Cody and Norby).

19/09/2017 - Version 2.7:
* added "use strict"; to scripts which removes some warnings in the log.
* rings are now a little bit more common (1/8 of planets will have them).
* the description of a system will now tell whether it has rings or not (thanks phkb for the help implementing this!).
* close-up grain density now proportional to the colour intensity of the ring lane.
* fixed bug in which Ribior's main station would spawn inside rings (thanks to spara, cim and all others for the suggestions and spara for doing the all hard work for the fix).

27/08/2017 - Version 2.6:
* the sinusoidal functions which create the variations of colour intensity now fade in one by one according to the distance, which solves the Moire pattern problems.
* shading applied at close distances so that the grains look like rocks.

17/08/2017 - Version 2.5:
* fix for a small bug affecting certain cards (wrong type for second argument of pow).

03/08/2017 - Version 2.4:
* change to shader to fix a bug with certain ATI cards.

24/07/2017 - Version 2.3:

* code refactoring.
* rings fade into blue when entering the atmosphere (such as when using PlanetFall).

20/07/2017 - Version 2.2:
* smaller ring bands and grains only visible at closer distance.
* improved the issues with moire pattern, in particular at lower resolutions.

20/07/2017 - Version 2.1:
* the large gaps in the rings are now randomized making each system more unique.
* the colour gradient function is also randomized for more unique rings.
* renamed the effect script.

19/07/2017 - Version 2.0:
* rings now have different relative sizes to the planet.
* they also have different radial length.
* applied a slight yellow tint.
* applied ambient light.
* shadows are darker.
* changed the spawning algorithm which, among other things, make the rings more common.
* ring now uses a colour gradient instead of a texture (which is now only used to generate noise).

Version 1.2:
* use 1.80 features, repackage.

Version 1.1:
* improved ring texture and appearance contributed by ZygoUgo.

Version 1.0:
* initial non-beta release.

== Requirements ==
A shader-supporting graphics card is required, the more recent the better. Older shader-supporting cards may be too slow to render the rings at an adequate framerate.

== Tweaks ==
*[https://bb.oolite.space/viewtopic.php?p=223633#p223633 Remove rings from main planet but place them around additional planets] (DGill, 2014)

You might need to consult [[How to tweak OXZ's]]

== Links ==
*[https://bb.oolite.space/viewtopic.php?f=4&t=3460&p=264770#p264770 smcameron's ring generators] (2018 - Linux?)
*[https://bb.oolite.space/viewtopic.php?f=4&t=12544 (RELEASE) System Features: Sunspots and Rings OXPs] - (2012-13) for cim's original oxp - includes programming comments about adding collisions to this OXP...
*And see [[User:Frame|Frame]]'s 2017 [https://www.youtube.com/watch?v=e03qmsNYbkM YouTube film] where he mentions plans for asteroid rings (and other goodies).

==Quick Facts==
{{OXPLevel|0}}{{Infobox OXPb| title = System Features: Rings
|version = 2.10.4
|release = 2026-08-03
|license = CC-BY-SA 3.0
|features = Ring system
|category = Ambience OXPs
|author = [[User:cim|cim]], [[User:Gsagostinho|gsagostinho]]
|download = [[#Download|See Download]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=18921&p=257815 Bulletin Board thread]
}}

System Features Rings

2026-08-03T03:38:58Z

Phkb: /* Download */ Version update

This OXP adds some dust rings to a few planets in each galaxy.
[[File:Systemrings1.jpg|700px|right]]

== Overview ==
This .oxp generates a wide variety of different ring systems which encircle the planets.

There are a number of other effects (as for example when one enters the atmosphere of a planet and looks at the rings)

If a system's main planet has rings, it will also be noted on the [[F7 screen (data on "system")|F7 screen]].

The rings can prove very useful for (''eg.'') helping locate rock hermits which are close to them
:Check out [[Sector1/Isinor|Isinor]] where the RH is between the rings (to which it is close) and the sun.

The original .oxp was crafted by [[User:cim|cim]] in 2013 and then upgraded by [[User:Gsagostinho|Gsagostinho]] in 2017-18 (with the improvements to Oolite's shaders).

 
==Images==
<gallery>
Image:systemrings1.jpg|Rings as in version 2.9
Image:systemrings2.jpg|Transparency is now supported in Oolite 1.87
Image:systemrings3.jpg|Close up of new rings
Image:Gsagostinho.SystemFeatures.Rings.2.3-screenie1.jpg|Previous version of rings
Image:Gsagostinho.SystemFeatures.Rings.2.3-screenie2.jpg|Rings now have different thickness
Image:Gsagostinho.SystemFeatures.Rings.2.3-screenie3.jpg|As well as different number of main gaps (in this case, 2)
Image:Gsagostinho.SystemFeatures.Rings.2.3-screenie4.jpg|As we get closer, their granular structure becomes visible
Image:Gsagostinho.SystemFeatures.Rings.2.6.screenie1.jpg|Close up detail
</gallery>

== Download ==
Download using the extension manager in the game, or using the following link: [http://wiki.alioth.net/img_auth.php/5/5d/Cim.gsagostinho.SystemFeatures.Rings.oxz System Features: Rings 2.10.4]. (Requires Oolite 1.84 or later)

03/08/2026 - Version 2.10.4:
* Check for valid fcb before attempting to remove it.

16/10/2018 - Version 2.10.3:
* Fixing a newly introduced bug in the visuals of the gaps in the rings.

13/10/2018 - Version 2.10.2:
* some more minor optimizations.

09/10/2018 - Version 2.10.1:
* more optimizations.
* rings get more transparent when entering an atmosphere.

09/10/2018 - Version 2.10:
* optimized some of the shader's code (thanks Svengali!).

07/10/2018 - Version 2.9:
* better handling of the alpha channel .

23/09/2017 - Version 2.8.1:
* bug in the description text now properly solved, it was still present due to a small oversight (thanks again, Cody).

23/09/2017 - Version 2.8:
* changed description text to "This planet has rings."
* fixed a bug in which the description text appears many times (thanks Cody and Norby).

19/09/2017 - Version 2.7:
* added "use strict"; to scripts which removes some warnings in the log.
* rings are now a little bit more common (1/8 of planets will have them).
* the description of a system will now tell whether it has rings or not (thanks phkb for the help implementing this!).
* close-up grain density now proportional to the colour intensity of the ring lane.
* fixed bug in which Ribior's main station would spawn inside rings (thanks to spara, cim and all others for the suggestions and spara for doing the all hard work for the fix).

27/08/2017 - Version 2.6:
* the sinusoidal functions which create the variations of colour intensity now fade in one by one according to the distance, which solves the Moire pattern problems.
* shading applied at close distances so that the grains look like rocks.

17/08/2017 - Version 2.5:
* fix for a small bug affecting certain cards (wrong type for second argument of pow).

03/08/2017 - Version 2.4:
* change to shader to fix a bug with certain ATI cards.

24/07/2017 - Version 2.3:

* code refactoring.
* rings fade into blue when entering the atmosphere (such as when using PlanetFall).

20/07/2017 - Version 2.2:
* smaller ring bands and grains only visible at closer distance.
* improved the issues with moire pattern, in particular at lower resolutions.

20/07/2017 - Version 2.1:
* the large gaps in the rings are now randomized making each system more unique.
* the colour gradient function is also randomized for more unique rings.
* renamed the effect script.

19/07/2017 - Version 2.0:
* rings now have different relative sizes to the planet.
* they also have different radial length.
* applied a slight yellow tint.
* applied ambient light.
* shadows are darker.
* changed the spawning algorithm which, among other things, make the rings more common.
* ring now uses a colour gradient instead of a texture (which is now only used to generate noise).

Version 1.2:
* use 1.80 features, repackage.

Version 1.1:
* improved ring texture and appearance contributed by ZygoUgo.

Version 1.0:
* initial non-beta release.

== Requirements ==
A shader-supporting graphics card is required, the more recent the better. Older shader-supporting cards may be too slow to render the rings at an adequate framerate.

== Tweaks ==
*[https://bb.oolite.space/viewtopic.php?p=223633#p223633 Remove rings from main planet but place them around additional planets] (DGill, 2014)

You might need to consult [[How to tweak OXZ's]]

== Links ==
*[https://bb.oolite.space/viewtopic.php?f=4&t=3460&p=264770#p264770 smcameron's ring generators] (2018 - Linux?)
*[https://bb.oolite.space/viewtopic.php?f=4&t=12544 (RELEASE) System Features: Sunspots and Rings OXPs] - (2012-13) for cim's original oxp - includes programming comments about adding collisions to this OXP...
*And see [[User:Frame|Frame]]'s 2017 [https://www.youtube.com/watch?v=e03qmsNYbkM YouTube film] where he mentions plans for asteroid rings (and other goodies).

==Quick Facts==
{{OXPLevel|0}}{{Infobox OXPb| title = System Features: Rings
|version = 2.8.1
|release = 2017-09-23
|license = CC-BY-SA 3.0
|features = Ring system
|category = Ambience OXPs
|author = [[User:cim|cim]], [[User:Gsagostinho|gsagostinho]]
|download = [[#Download|See Download]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=18921&p=257815 Bulletin Board thread]
}}

Quick-Visa

2026-08-03T03:37:31Z

Phkb: Version update

[[image:quickvisa.png|right|500px|Quick-Visa station]]
An add-on for the [[Diplomancy OXP]]
==Overview==
This mod does two things. Firstly, if the player doesn't have a citizenship or a valid visa when they arrive in a new system, it will warn the player that a visa is required for docking at system stations.

Additionally, it adds "Quick-Visa Self-Service" stations near the witchpoint, which allow the player to purchase 24h, 48h or 72h visas for the current system, at a substantially inflated price.

==Operation==
To use the Quick-Visa Self-Service station, bring your ship close to the station itself. When you are close enough, options will appear in your Broadcast Comms equipment:
* Purchase 24h Visa for {amt1}
* Purchase 48h Visa for {amt2}
* Purchase 72h Visa for {amt3}

Use your Broadcast Comms equipment to select the desired option: Press "Shift-N" to prime the equipment, and then "b" to change the currently selected item in the list. When the desired option is selected, press "n" to transmit your request. You will be notified shortly thereafter if your request was successful.

==Backstory==
It's the bane of many a pilot's life. In a hurry to reach a destination, they launch and jump into a new system, completely forgetting that a visa is required. They jet along the spacelane to the main station, only to discover, to their horror, that they would be denied entry.

Into this dilemma came Quick-Visa, a startup conceived with this one issue in mind. Based in the Galaxy 4 system of Edorqu, the trio of entrepreneurs who funded the initial investment, discovered there could be a solution that was both beneficial to the systems requiring visas, and lucrative enough to fund the massive outlays envisaged. Initial tests confirmed their analysis that pilots would be willing to pay a significant amount over the normal visa cost to avoid the other hassles of not having one.

They began by reaching out, through diplomatic channels, to many of the communist and dictatorship systems in their own corner of the galaxy. Would they be interested in getting additional income, at almost no cost to them, while providing a benefit to incoming traders? Understandably, given those terms, many were willing to participate in a trial.

And so the rollout began. Old communication stations were repurposed, chosen largely because they were so cheap and had enough existing technology on board, given a shiny new coat of paint, and deposited near the witchpoint of some carefully selected systems.

No one could have predicted just how effective they were. Within just a few days, not only had they been able to pay for the stations already purchased and issue massive payments to the governments they were deployed in, they were scrambling to answer all the diplomatic calls they were receiving. Could they deploy the system there? How quickly could they get it set up?

Money was being thrown at them from a variety of directions, and in a short amount of time the system was rolled out across all the charts. The start-up out-grew it's original offices and moved to a private station of their own design in a far off (and secret) corner of the galaxy, and the money just continued to roll in.

Everyone was happy - the governments, the investors, and, to a certain degree, the pilots who kept paying for the over-priced visas. It was certainly cheaper than getting a fine at the station, and quicker than doing a fuel-scooping run to the sun.

==Requirements==
The [[Diplomancy_OXP|Diplomacy OXP]] is required, as it is the mod which controls visas and citizenships. 
The [[BroadcastComms_MFD|Broadcast Comms OXP]] is required to communicate with the Quick-Visa Self-Service stations.

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

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

==Version History==
1.6
* Turned off "smooth" on ball turrets.
* Turned off greetings in nova systems.

1.5
* Added some ball turrets to dissuade aggressors.
* Suppress player messages in condition red.

1.4
* Fixed missing semi-colon in shipdata.plist file.

1.3
* Fixed issue where moving away from the station would remove the BCC links, but not put them back if the player approaches for a second time.
* Quick-Visa stations no longer mass lock the player.
* Made station rotate for more visual interest.

1.2
* Turned of station naming for the Quick-Visa stations.
* Fixed issue where visas purchased through Quick-Visa stations were not being recognised by PlanetFall2 locations.

1.1
* Tweaks to the Quick-Visa Self-Service station model.
* Fixed invalid filename in shipdata.

1.0
* Initial release

== Quick Facts ==
{{OXPLevel}}{{IconOXP|ooVersion = "1.90"|oxpCPU = "Low"|oxpMEM = "Low"|oxpGPU = "Low"}}
[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
{{Infobox OXPb| title = QuickVisa.oxz
|version = 1.6
|release = 2026-08-03
|license = CC BY-NC-SA 4.0
|features =
|category = Misc OXPs
|author = [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?t=21866 Oolite BB]
}}

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

Docking Fees

2026-08-03T03:36:29Z

Phkb: Version update

[[File:HDBG1-full.png|thumb|600px|right|Docking message with [[HDBG]] background]]
Adds a small docking fee and docking messages to all [[GalCop]] stations based on system tech level. Many OXP stations are also given unique fees or docking messages.

== Overview ==
This is a minor OXP for Oolite-- it adds docking fees based on tech level to all GalCop stations (the fee is 1/2 the system's tech level, between 0.5₢ for a tech 1 to 7.5₢ at tech 15) as well as some colourful docking messages chosen at random.

Rock hermits and many OXP stations are also included, either as no-cost landing stations (they either offer limited services or poor trading) or in some cases costing more than the main station to dock.(Astrofactories/commie factories cost a bribe to dock with because of the cheaper equipment prices, casinos cost twice as much as the main station because they're luxury retreats, ''etc''.)

I have attempted to include as many OXP stations as I could find, but the list is by no means complete due to the number of additional stations that are mission-created or in older OXPs. Thanks to additional station lists provided by Norby, I believe that all OXP stations that exist as of June 2015 have been at least accounted for (though not all have been given special messages or fees).

This OXP integrates with [[HDBG]] (High Definition BackGrounds) to provide immersive backgrounds for arrival (see screen shot above).

Note that in [[Classic Elite]] the [[The Space Traders Flight Training Manual]] stipulates that all taxes and fees are actually included in the market prices! This was also the logic in the early days of Oolite. Although exactly how this works when the buying and selling prices are identical, is a matter of some intrigue!

== 3rd Party interface ==
To add a unique docking message for a specific station use the following code:
worldScripts["Docking Fees"].$addFee("my_station_role", {fee:20, message:"Welcome to my station, commander! Have a nice day, and thanks for paying your [fee_amt] fee."});
"my_station_role" must be a role of the station in question.

Possible parameters:
<table><tr><td>'''fee'''</td><td>the fee amount to deduct from the player</td></tr>
<tr><td>'''multiplier'''</td><td>a multiplier which is applied to the default fee calculation, allowing you to make your station more expensive (numbers greater than 1) or cheaper (numbers between 0 and 1) than the default.</td></tr>
<tr><td>'''messageKey'''</td><td>the key name of the docking message from descriptions.plist.</td></tr>
<tr><td>'''message'''</td><td>the text of the message to be displayed.</td></tr></table>

Text in "message", and inside your descriptions.plist messageKey text, can include the following text inserts:
<table><tr><td>'''[fee_amt]'''</td><td>will be replaced by the fee paid by the player.</td></tr>
<tr><td>'''[st_name]'''</td><td>will be replaced by the station name where the player is docking.</td></tr></table>

To disable docking fees for a particular station, use the following code:
worldScripts["Docking Fees"].$addFee("my_station_role", {messageKey:""});

== Download ==
Download [[Media:DockingFees_2.3.oxz|DockingFees_2.3.oxz]] (downloaded {{#downloads:DockingFees_2.3.oxz}} times)

== License ==
*License: CC-BY-NC-SA 4.0
*Authors: Layne, Eris, phkb
*Version: 2.3
*Required Oolite Version: 1.80

== Credits ==
Special thanks to [[User:Phkb|Phkb]] for help understanding the structure of the message callbacks; my friend Eris (who does not play Oolite but knows her Javascript very well in-deed). Thanks to everyone on the Oolite forum who gave me scripting pointers. Thanks to [[User:Norby|Norby]] for the comprehensive list of OXP stations and additional suggestions.

== Version History ==
*03-08-26 2.3
:No docking fees in systems going nova.
*30-11-23 2.2
:Fixed incorrect lookup key for RRS stations.
*8-1-22 2.1
:Added currency symbol to arrival text.
:Fixed issue of defaulting to main station fee when fee equals 0.
*7-6-21 2.0
:Reworked logic to allow for new stations to be added into the system without recoding.
:Code refactoring.
*7-2-18 1.6.2
:Fixed issue with long decimal values being displayed in arrival messages.
:Fixed issue with incorrect role being used for current Black Monks stations.
:Added message for Tionisla Orbital Graveyard station.
*7-27-15 1.6.1
:Bugfix to correct Escape Capsule misbehaviors!
*6-15-15 1.6
:Fee script changed to exclude any station not specifically included in the script (random OXP stations will no longer have docking fees assigned). Many, many (and did I say many?) new stations have been added to the list, though most have only a generic docking message or none at all.
*6-9-15 1.5
:One additional docking message per tech level for a total of fifteen new messages!
*5-7-15 1.4
:Corrections to scripting for compatibility with Combat Simulator OXP. Additional stations (Sentinel, Lave Academy, Training) added to script. Minor typos corrected in docking report.
*4-26-15 1.3
:First public release of OXP package.
*4-23-15 1.2
:OXP (config files, ''etc''.) constructed and messages moved to docking report screen. Multiple new messages written for galcop and more OXP stations (Commies, Dictators, Feudal, ''etc''.) added.
*4-23-15 1.1
:Changes to script by phkb to add support for non-galcop stations.
*4-22-15 1.0
:Initial version of script posted on Oolite forum.

== Links ==
*[https://bb.oolite.space/viewtopic.php?f=6&t=17382 BB Thread] (2015+)
*[https://bb.oolite.space/viewtopic.php?f=4&t=2740 Docking Fees and General Running costs] (2006) Fons et origo of this .oxp?

== Gameplay and Balance Indicator ==
[[File:Tag-colour-green.png|right]]

{{ambience-OXP}}

Ship Repurchase

2026-08-03T03:35:12Z

Phkb: Version update

[[File:EscapeCapsule-Oolite.png|left|thumb|300px|''If'' you bought an escape pod]]
[[File:Escape Suit 01.PNG|right|thumb|300px|And ... ''if'' you didn't!]]
==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.8 (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.8
* Tighter integration with Library.
* Improved integration with the Nova mission.
* Fixed issues where cargo was not being correctly handled when repurchasing a ship after an interstellar or nova bailout.
* Implemented logcontrol.plist for debug messages.

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.8
|release = 2026-08-03
|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]]

Risky Business

2026-08-03T03:34:06Z

Phkb:

[[File:IconLib.png|right]]
Improves profits in pirate-ridden systems

== Overview ==
Risky Business aims to make Multi-Gov, Feudal and Anarchy systems more rewarding for traders, by tweaking prices on a few goods. Goods that are already over the average could be increased. Goods that are below the average could be reduced. Not all goods will be impacted at all locations.

== Detail ==
RB doesn't look at the local systems so much as just assuming a dangerous system (ie. Anarchy, Feudal, Multi-Gov) will have some high-demand commodities. It will randomly pick a couple of commodities that are already above or below average and basically make them more so. So you might occasionally find computers for sale at well over the galactic average, or furs for well under. So computers in [[Sector1/Ararus|Ararus]] might sell for 120₢/TC.

This contrasts with Cim's [[Risk Based Economy OXP]] which also tweaks the markets, but instead "adjusts prices according to trade volume - so safer systems have more 'centred' prices, and hub systems have more 'centred' prices." It looks at how safe/dangerous a system is, based on the type of local systems surround it, and moves prices accordingly. R-BE's focus is on the market as a whole, rather than extreme pricing for just one or two commodities.

This also contrasts, more markedly, with [[Real-Life Economics]] which is based on the assumption that traders would ignore the piracy and restore pricing equilibrium where extreme economic systems were close (eliminating the better [[Milkrun|milk-runs]]).

== Two oxp's for the price of one! ==
=== Risk-based economy: choose with Library Config ===
The current version also incorporates Cim's [[Risk Based Economy OXP]].

"Risk-based economy" not only considers the politics of the system but also the hub-ishness of it (how many other trading systems are in the region), ''and'' affects prices in a more global fashion.

You can choose to implement the one, the other or both through selecting Library oxp's ''Config for AddOns'' on the [[F4 screen (ship and system interfaces)]].

[[File:Supply & demand.png|right|320px]]
== License ==
*Author: Phkb
*License: CC-BY-SA-NC 4.0
*Version: 0.3
*Requires: Oolite v.1.81 or newer, [[Library OXP|Library]], [[Market Script Interface]]

== Download ==
*Downloadable through the in-game [[Expansions Manager]]
:or manually:
*[[Media:RiskyBusiness_0.3.oxz|RiskyBusiness_0.3.oxz]]
:Download, unzip and pop into your AddOns folder (see [[OXP]] if you need more detail).

== Links ==
Discussion can be found here: [https://bb.oolite.space/viewtopic.php?f=4&p=271089 BB Link].
*Author: [[User:Phkb|Phkb]]
*[[Economics]]
*[[Oolite Trading]]

== Gameplay and Balance Indicator ==
[[File:Tag-colour-blue.png|right]]
Better rewards for dangerous trading.

{{mechanics-OXP}}

File:RiskyBusiness 0.3.oxz

2026-08-03T03:31:57Z

Phkb:

File:ShipRepurchase.oxz

2026-08-03T03:31:47Z

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

Version 0.2

File:DockingFees 2.3.oxz

2026-08-03T03:30:56Z

Phkb:

File:QuickVisa.oxz

2026-08-03T03:30:43Z

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

File:Cim.gsagostinho.SystemFeatures.Rings.oxz

2026-08-03T03:30:04Z

Phkb: /* System Features: Rings */

== System Features: Rings ==

Version: 2.10.4

Required Oolite Version: 1.84

Author: cim, Gilberto Agostinho (gsagostinho)

License: CC-BY-SA 3.0

File:Cim.gsagostinho.SystemFeatures.Rings.oxz

2026-08-03T03:29:53Z

Phkb: Phkb uploaded a new version of File:Cim.gsagostinho.SystemFeatures.Rings.oxz

== System Features: Rings ==

Version: 2.10.3

Required Oolite Version: 1.84

Author: cim, Gilberto Agostinho (gsagostinho)

License: CC-BY-SA 3.0

File:GalCopMissions 0.15.oxz

2026-08-03T03:29:19Z

Phkb:

File:TrafficControl 2.4.oxz

2026-08-03T03:28:31Z

Phkb:

SuperCobra

2026-08-02T07:11:43Z

Phkb: /* Download */ Added clarity

__NOTOC__
{{Semantic Infobox ShipStats Oolite| title=SuperCobra
|image = [[Image:SuperCobra.png|250px]]
|width = 131m
|height = 25.6m
|length = 59.4m
|capacity = 40 TC
|capacityext = 15 TC
|gunmounts = Fore, Aft, Starboard, Port
|maxspeed = 0.45 LM
|maneuverability = Roll: 2.2 Pitch: 1.2
|missileslots = 4
|energybanks = 7
|energyrecharge = 7
|milshields = Yes
|shieldboost = Yes
|hyperspace = Yes
|isoxp =OXP
|isplayer = Yes
|baseprice = 1,622,000 ₢
}}
== Overview ==
[[Image:SuperCobra-Thargoid.png|thumb|left|200px|A SuperCobra attacks a [[Thargoid Warship (Oolite)|Thargoid warship]]]]
The SuperCobra is the newest in the range of Cobra ships from [[Cowell & MgRath|Cowell & MgRath Shipyards]] of [[Lave]]. Intended as a follow-up to the enormously successful [[Cobra Mk.3 (Oolite)|Cobra Mk.3]], the ship is larger and faster with a stronger hull, with the ability to carry military shield enhancements and shield energy boosters. It exemplifies the latest generation of small multi-role ships that can be used for trading, military purposes, bounty hunting (and to the dismay of the [[GalCop|Police]], [[Piracy|piracy]]).

== Notable features ==
The ship is most notable for being the Cobra Mk.3 replacement - and basically looks like a Cobra Mk.3, the differences only becoming obvious when the two ships are together, or when the SuperCobra lights up its engines trailing four bright plumes instead of two. Although its predecessor is still popular, most ship afficionados considered the Cobra range to be getting long in the tooth, and even becoming outclassed in most respects by newer designs such as the [[Python Class Cruiser]]. With 'What Spaceship' recommending the somewhat large and unweildy PCC over the Cobra Mk.3 in a recent issue, CMR shipyards decided to expedite bringing the SuperCobra design to market.

Few of the ships have been seen in trader's hands; the increases in size and speed have made this a very expensive ship to buy. However, the ability to fit military shield enhancements and at the same time, fit shield boosters, have made this craft extremely attractive to well-heeled bounty hunters and pirates alike. Pirates in particular like the cavernous cargo area - extendable to 55 TC - and lone marauding SuperCobras have been spotted in the more dangerous systems. Bounty hunters have also discovered the advantages of a large cargo area as pirates will often spill copious quantities of loot - and bounty hunters returning with the cargo the pirate stole is no longer an uncommon sight (blurring even more the difference between a pirate and a bounty hunter). The ship is also used quite often by traders with not so legitimate cargo like firearms or narcotics.

The ship is universally liked by those who have flown one - it is one of the most manoeuvrable ships in its size class, as well as having a good turn of speed. The addition of witch space fuel injectors make the ship a courier's dream.

== Notable Pilots ==
The first prototype SuperCobra was flown in 3138, in an abortive coup to attack the capital of the Duval Empire at Achenar. The identities of the crew are restricted under the Galactic Cooperative Official Secrets Act. While destroyed, it proved itself in battle against an [[Imperial Courier]], as told in [[Status Quo]]. It is not known if the crew perished with the ship's destruction.

== Download ==
[https://app.box.com/shared/xsc8dq6z0x Download version 1.4.2] Updated on 12/10/2010.

This ship is also found inside the [[Random Hits]] oxp.

== Version History ==
* Version 1.4.2 Fixed casing error that affected Linux systems. 
* Version 1.4.1 Fixed some old spelling errors in messages. 
* Version 1.4 Prepared for Oolite 1.73. Now also reacts on attacks during docking.

== Links ==
Any original threads will have been lost in the [[Great Deletion]] - but see here: [https://bb.oolite.space/viewtopic.php?f=2&t=2069 Info request.... SuperCobra] (2006)
*Original [http://capnhack.com/hosting/oolite/Oolite/OoSat.html OoSat] version (2006)
*Author: [[8bitapocalypse]] (see also his [[Ixian Ships]])

{{ship-OXP}}

Wireframe Ship Images

2026-07-27T06:15:25Z

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.14)

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

==Version History==
1.14
* Corrected filenames for Basilisk, Battle Cruiser and Thargoid Outpost.
* Corrected reference for Feudal Shuttle.
* Corrected reference for Transporter Escort.
* Corrected reference for Pteranodon.

1.13
* Added various items from Xeptatl's Sword.
* Fixed size of a couple of ship images.
* Added correct image for the Cloaking device.

1.12
* Added ships from PT BVRM.

1.11
* Added ships from Small Ships OXP.
* Added ships from Defense 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.13
|release = 2026-07-27
|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-07-27T06:14:53Z

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

Test Ship Model

2026-07-27T01:11:21Z

Phkb: /* For Oolite 1.92 */ clearer instructions

A utility for testing models of ships/stations ''et cetera''
[[File:Test Ship Model.png|thumb|right|600px||Viewing the Coriolis station model in Oolite 1.92]]
[[File:Test_ship_model_1.90.png|thumb|right|600px||Viewing the Coriolis station model in Oolite 1.90]]

== Overview ==
This is a utility mod that allows you to quickly and easily view a ship model from the game. This utility uses features in Oolite 1.92

=== Use ===
When docked at a station, an F4 interface will be available, called "Test Ship Model". When you select this, you will be asked to enter the ship's data key to display. Enter that key, and press enter.

At this point, you will be shown the ship.

==== For Oolite 1.92 ====
You can now use the arrow keys, the page up/dn keys, and the yaw keys ("," and ".") to rotate and zoom the ship. Pressing Ctrl plus the arrow keys will move the model in that direction. You can increase or decrease how far one keypress will move the ship by using the "+" and "-" keys. Pressing Ctrl and the "+" and "-" keys will change the step by a small amount.

"R" will reset the view back to the initial position, including resetting sub-entity positions.

"N" will return to the screen where a new ship data key can be entered. Previous ships you have viewed will be listed as well. Use a number to select one of those ship keys instead of entering another data key. The last 15 ships will be displayed, and the list will be saved with the save game settings.

"H" will hide the instructions, which will be displayed with the ship model. Pressing "H" again will bring the instructions back.

If the ship model uses the personality property to change the skin or colour of the ship, you can enter a personality number by pressing the number keys. As you do, the "New personality" item will show in the instructions. Once you have entered the desired number, press "P" to set the personality to this value.

Pressing ESC will return you to the F4 Interfaces screen.

==== For Oolite 1.90 ====
Use the menu on the left side to rotate the ship, zoom in and out, change the step amount, and reset the view.

To switch between "Rotation" and "Movement" modes, select either "Rotation >" or "Movement >" at the top of the menu.

===Sub-entities===
If the model being viewed has sub-entities, it is possible to select and then move/rotate each individual sub-entity. Press "s" (or select the "Select subent" menu) to cycle through the available subentities. As each sub-entity is selected, the index and either the name or data key of the subentity will be shown.

In 1.92, use the Ctrl plus arrows keys and Ctrl + "," and "." to move the sub-entity, and use the arrow keys, "," and "." keys to rotate the sub-entity.

In 1.90, use the menu to rotate and move the sub-entity.

To see the updated definitions for all the sub-entities, press the "d" key (or select the "Dump subents" menu). This will write the updated sub-entity definitions to the log file.

=== Shortcut ===
In Oolite 1.92, you can also press Ctrl-T on the F5 Ship Status screen to jump directly to the Test Ship Model screen.

=== Extra Notes ===
* You can't display the model of anything with "is_template" set to yes/true/1. You would need the in-game version of the ship, ie. where "like_ship" has been set to the template key name.

* Also, if there is a condition_script on the shipdata entry, those conditions will need to pass to display the model. For instance, attempting to view ships from the Commies mod will require you to be in a Communist system.

And that's it, really. Nothing too fancy, but show-casing a bit of what we can now do with mission screens.

== Requirements ==
Oolite 1.82 or later is required.

== Download ==
* [[Media:TestShipModel.oxz|TestShipModel.oxz]] (v1.4)

== 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/

== Version History ==
1.4
* Added ability to select a sub-entity and move/rotate it. Adjusted subentity information can then be output to the log file.
* Added ship name to displayed information.
* Added console messages to notify of some changes when instructions are hidden (Oolite 1.92 only).
* Added ability to change the step in small increments (Oolite 1.92 only).
* Improved integration with Library.

1.3
* Added ability to move the model up/down/left/right.

1.2
* Made compatible with Oolite version 1.90 (and back to 1.82 actually!).
* Added shortcut key to F5 Manifest screen (Ctrl-T) to open the test screen (available in Oolite 1.92 or later).
* The ship datakey is now shown at the top of the view model screen.
* Moved all text to descriptions.plist for easier localisation.

1.1
* Switched "allowInterrupt" to false.
* Added option to clear the data key history.

1.0
* initial release

== Links ==
* [https://bb.oolite.space/viewtopic.php?f=4&t=21453 BB thread] (2023)
* Author: [[User:Phkb|Phkb]]

[[Category:Oolite utilities]]

Library OXP

2026-07-27T01:01:38Z

Phkb:

''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 screen (ship and system interfaces)|F4 ship-station interface]] screen (allowing in-game tweaking of compatible OXPs)
*Adds a '''PAD''' to the [[F4 screen (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_OXP|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 screen when docked) by Svengali
*[[OXPConfig]] (done via the F2 screen - 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
:√ 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 with other OXPs ==
=== Config for AddOns ===
Over 70 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 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)
*[[Hyperradio js OXP|HyperRadio™]] - your on-board radio music station

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!
*DGill's [[Feudal States]] suite of 4 OXPs uses P.A.D.

=== Maps ===
*[[System Map]] runs off Library.oxp

=== 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 function.''

=== 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.10.5.oxz|Library_1.10.5.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.10.5
|release = 2026-07-27
|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]]

Hyperradio js OXP

2026-07-27T01:00:00Z

Phkb: /* Quick Facts */

{{Infobox EquipStats Oolite| title = Hyperradio
|image = [[Image:Hyperradio.png|80px]]
|equipName = EQ_HYPER_RADIO
|equipCost = 1.200
|equipTL = 7
}}
==Overview==
{{OXPNote|This AddOn has been updated to use [[Library OXP|Library]] for new AddOns 
Phkb has upgraded the Hyperradio OXPs to work with Library OXP - and has added another 6 channels}}
Trading goods between worlds is an extremely dangerous and hard job and a commander will need some relaxing moments. Listen to your radio station and enjoy Jazz, Folk, Rock or whatever you like. Use one station for all systems or expand it, so you will get different programs in different systems. You can even add your own music to the playlist. So rip your CDs, download songs, or install one or more of the available [[Hyperradio_Musicpacks|musicpacks]]. Everything is possible - and traveling will be much more fun - even 'milkruns' won't be boring business anymore. And with the capacity to be expanded by other users creating their own musicpacks it will always be the right investment.

Additionally Frame has created a nice oxp for [[Random_Docking_Music_OXP|random docking music]].

==Handling==
Adding own songs to the main playlist of the Hyperradio is simple. Please note that only ogg-vorbis is supported by Oolite.

1. Just place your soundfiles in the OXPs Music-folder. 
2. Open hyperradio.js in the Scripts-folder (you can use a simple text-editor) and add your filenames to the array. 
Example:
this.hyperradio_playListOriginal = [
"Rage-Back_in_time.ogg",
"Stevie_Ray_Vaughan-Voodoo_Child.ogg"
];
Save your additions. That's it.

3. Fire up Oolite and buy the Hyperradio license (it is not everywhere available).
* Launch from the station and select it via priming key (Shift + N).
* Select the station via activation key (n). You can cycle through the available stations.
* To start playing a station press the mode key (b).

To get some more complexity it is possible to use different 'stations' with different playlists. There are a few [[Hyperradio_Musicpacks|musicpacks]] already available for you.

If you are using one or more of the available musicpacks the Hyperradio preselects one of them or the main list.

Documentation about creating own stations is available at the [[Hyperradio_Howto_Musicpacks|HowTo make a own station]] page.

==Infos==
{{OXPConfig-small}}
The Hyperradio is your personal tool for playing music in the game. Before it was a bit tedious to run other applications (like Winamp) for this case, because these music-players are not really connected to Oolite and the user doesn't have control about it (or has to switch to this application). The Hyperradio jumps in here to play your songs and reacts on changes in Oolite.

Additionally it is compatible and configurable via [[OXPConfig|OXPConfig2]] and [[Repair_Bots|Repair Bots]].

Hyperradio can be configured (OXPConfig2 or editing):
* '''logging''': en/disables the extended logging. Default false.
* '''mergePacks''': en/disables copying musicpacks in mainlist. Default true.
* '''podMusic''': en/disables playing a short sample when player ejects. Default true.
* '''onlyMain''': en/disables using only the main playlist. Default false.

* Extended features - if [[Snoopers|Snoopers2.4]] is installed

==Requirements==
===Version 1.x===
* Oolite v1.77
* [[Cabal_Common_Library|Cabal_Common_Library1.7]]
* [[Snoopers|Snoopers2.4]] or [[Hyperradio_Musicpacks|musicpacks]] to enable extra functions.
===Version 2.x===
* Oolite 1.80
* [[Library OXP|Library OXP]]
* [[Hyperradio_Musicpacks|musicpacks]] to add available listening stations.

==Download==
* Downloadable v1.x and v2.x through the in-game [[Expansions Manager]]
===Version 1.x===
* [http://deephorizonindustries.com/Downloads/Hyperradio1.26.1.zip Hyperradio1.26.1.zip] (741 KB).
* Download in OXZ format [[Media:Hyperradio_1.26.1.oxz|here]] for Oolite 1.79 or later (downloaded {{#downloads:Hyperradio_1.26.1.oxz}} times).
===Version 2.x===
* Download in OXZ format [[Media:HyperRadio_2.1.oxz|here]] for Oolite 1.79 or later (downloaded {{#downloads:HyperRadio_2.1.oxz}} times).

===For Oolite v1.76.1:===
* [http://deephorizonindustries.com/Downloads/Hyperradio1.25.zip Hyperradio1.25.zip] (742 KB).

== Tweaks ==
*[https://bb.oolite.space/viewtopic.php?p=216135#p216135 To extend Subscription time] (Diziet Sma, 2014)
*[https://bb.oolite.space/viewtopic.php?p=217617#p217617 To play when in red alert] (Capt Solo, 2014)

You might need to consult [[How to tweak OXZ's]]

==See Also==
[[Hyperradio_Musicpacks]] 
[[Hyperradio_Howto_Musicpacks]] 
[[Random_Docking_Music_OXP|Random docking music]]
=== BB Threads ===
*[https://bb.oolite.space/viewtopic.php?f=6&t=16191 OXP idea: Seeking those with radio DJ/Announcer experience] (2013-14: adding DJ patter between the tracks - with links to various downloadable putative patter portions, and adverts too!)
==== Hyperradio 2 ====
[https://bb.oolite.space/viewtopic.php?t=21914 Phkb's update with new channels] (2025)

==Quick Facts==
{{OXPLevel|0}}{{IconOXP
|ooVersion = "1.77"
|oxpCPU = "Average"
|oxpMEM = "Average"
|oxpGPU = "Low"
|oxpIsParent = true
|oxpIsChild = true
|oxpIsAPI =
|oxpIsDocumented = true
|oxpIsConfigurable = true
}}
{{Infobox OXPb| title = Hyperradio
|image = [[Image:Hyperradio.png|220px]]
|version = 1.26.1
|release = 2013-01-22
|license = CC-by-nc-sa-3.0
|features = Equipment, Music
|category = Equipment OXPs
|author = Svengali
|download = [[#Download|See Download]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=4067 BB-Link]
}}

{{OXPLevel|0}}{{IconOXP
|ooVersion = "1.80"
|oxpCPU = "Average"
|oxpMEM = "Average"
|oxpGPU = "Low"
|oxpIsParent = true
|oxpIsChild = true
|oxpIsAPI =
|oxpIsDocumented = true
|oxpIsConfigurable = true
}}
{{Infobox OXPb| title = HyperRadio 2.0
|image = [[Image:Hyperradio.png|220px]]
|version = 2.1
|release = 2026-07-27
|license = CC-by-nc-sa-3.0
|features = Equipment, Music
|category = Equipment OXPs
|author = [[User:Svengali|Svengali]], [[User:phkb|phkb]]
|download = [[#Download|See Download]]
|feedback = [https://bb.oolite.space/viewtopic.php?t=21914 BB-Link]
}}

{{Required OXP|Cabal Common Library}}
{{Required OXP|Snoopers}}

Hyperradio js OXP

2026-07-27T00:59:33Z

Phkb: /* Version 2.x */

{{Infobox EquipStats Oolite| title = Hyperradio
|image = [[Image:Hyperradio.png|80px]]
|equipName = EQ_HYPER_RADIO
|equipCost = 1.200
|equipTL = 7
}}
==Overview==
{{OXPNote|This AddOn has been updated to use [[Library OXP|Library]] for new AddOns 
Phkb has upgraded the Hyperradio OXPs to work with Library OXP - and has added another 6 channels}}
Trading goods between worlds is an extremely dangerous and hard job and a commander will need some relaxing moments. Listen to your radio station and enjoy Jazz, Folk, Rock or whatever you like. Use one station for all systems or expand it, so you will get different programs in different systems. You can even add your own music to the playlist. So rip your CDs, download songs, or install one or more of the available [[Hyperradio_Musicpacks|musicpacks]]. Everything is possible - and traveling will be much more fun - even 'milkruns' won't be boring business anymore. And with the capacity to be expanded by other users creating their own musicpacks it will always be the right investment.

Additionally Frame has created a nice oxp for [[Random_Docking_Music_OXP|random docking music]].

==Handling==
Adding own songs to the main playlist of the Hyperradio is simple. Please note that only ogg-vorbis is supported by Oolite.

1. Just place your soundfiles in the OXPs Music-folder. 
2. Open hyperradio.js in the Scripts-folder (you can use a simple text-editor) and add your filenames to the array. 
Example:
this.hyperradio_playListOriginal = [
"Rage-Back_in_time.ogg",
"Stevie_Ray_Vaughan-Voodoo_Child.ogg"
];
Save your additions. That's it.

3. Fire up Oolite and buy the Hyperradio license (it is not everywhere available).
* Launch from the station and select it via priming key (Shift + N).
* Select the station via activation key (n). You can cycle through the available stations.
* To start playing a station press the mode key (b).

To get some more complexity it is possible to use different 'stations' with different playlists. There are a few [[Hyperradio_Musicpacks|musicpacks]] already available for you.

If you are using one or more of the available musicpacks the Hyperradio preselects one of them or the main list.

Documentation about creating own stations is available at the [[Hyperradio_Howto_Musicpacks|HowTo make a own station]] page.

==Infos==
{{OXPConfig-small}}
The Hyperradio is your personal tool for playing music in the game. Before it was a bit tedious to run other applications (like Winamp) for this case, because these music-players are not really connected to Oolite and the user doesn't have control about it (or has to switch to this application). The Hyperradio jumps in here to play your songs and reacts on changes in Oolite.

Additionally it is compatible and configurable via [[OXPConfig|OXPConfig2]] and [[Repair_Bots|Repair Bots]].

Hyperradio can be configured (OXPConfig2 or editing):
* '''logging''': en/disables the extended logging. Default false.
* '''mergePacks''': en/disables copying musicpacks in mainlist. Default true.
* '''podMusic''': en/disables playing a short sample when player ejects. Default true.
* '''onlyMain''': en/disables using only the main playlist. Default false.

* Extended features - if [[Snoopers|Snoopers2.4]] is installed

==Requirements==
===Version 1.x===
* Oolite v1.77
* [[Cabal_Common_Library|Cabal_Common_Library1.7]]
* [[Snoopers|Snoopers2.4]] or [[Hyperradio_Musicpacks|musicpacks]] to enable extra functions.
===Version 2.x===
* Oolite 1.80
* [[Library OXP|Library OXP]]
* [[Hyperradio_Musicpacks|musicpacks]] to add available listening stations.

==Download==
* Downloadable v1.x and v2.x through the in-game [[Expansions Manager]]
===Version 1.x===
* [http://deephorizonindustries.com/Downloads/Hyperradio1.26.1.zip Hyperradio1.26.1.zip] (741 KB).
* Download in OXZ format [[Media:Hyperradio_1.26.1.oxz|here]] for Oolite 1.79 or later (downloaded {{#downloads:Hyperradio_1.26.1.oxz}} times).
===Version 2.x===
* Download in OXZ format [[Media:HyperRadio_2.1.oxz|here]] for Oolite 1.79 or later (downloaded {{#downloads:HyperRadio_2.1.oxz}} times).

===For Oolite v1.76.1:===
* [http://deephorizonindustries.com/Downloads/Hyperradio1.25.zip Hyperradio1.25.zip] (742 KB).

== Tweaks ==
*[https://bb.oolite.space/viewtopic.php?p=216135#p216135 To extend Subscription time] (Diziet Sma, 2014)
*[https://bb.oolite.space/viewtopic.php?p=217617#p217617 To play when in red alert] (Capt Solo, 2014)

You might need to consult [[How to tweak OXZ's]]

==See Also==
[[Hyperradio_Musicpacks]] 
[[Hyperradio_Howto_Musicpacks]] 
[[Random_Docking_Music_OXP|Random docking music]]
=== BB Threads ===
*[https://bb.oolite.space/viewtopic.php?f=6&t=16191 OXP idea: Seeking those with radio DJ/Announcer experience] (2013-14: adding DJ patter between the tracks - with links to various downloadable putative patter portions, and adverts too!)
==== Hyperradio 2 ====
[https://bb.oolite.space/viewtopic.php?t=21914 Phkb's update with new channels] (2025)

==Quick Facts==
{{OXPLevel|0}}{{IconOXP
|ooVersion = "1.77"
|oxpCPU = "Average"
|oxpMEM = "Average"
|oxpGPU = "Low"
|oxpIsParent = true
|oxpIsChild = true
|oxpIsAPI =
|oxpIsDocumented = true
|oxpIsConfigurable = true
}}
{{Infobox OXPb| title = Hyperradio
|image = [[Image:Hyperradio.png|220px]]
|version = 1.26.1
|release = 2013-01-22
|license = CC-by-nc-sa-3.0
|features = Equipment, Music
|category = Equipment OXPs
|author = Svengali
|download = [[#Download|See Download]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=4067 BB-Link]
}}

{{OXPLevel|0}}{{IconOXP
|ooVersion = "1.80"
|oxpCPU = "Average"
|oxpMEM = "Average"
|oxpGPU = "Low"
|oxpIsParent = true
|oxpIsChild = true
|oxpIsAPI =
|oxpIsDocumented = true
|oxpIsConfigurable = true
}}
{{Infobox OXPb| title = HyperRadio 2.0
|image = [[Image:Hyperradio.png|220px]]
|version = 2.0
|release = 2025-08-04
|license = CC-by-nc-sa-3.0
|features = Equipment, Music
|category = Equipment OXPs
|author = [[User:Svengali|Svengali]], [[User:phkb|phkb]]
|download = [[#Download|See Download]]
|feedback = [https://bb.oolite.space/viewtopic.php?t=21914 BB-Link]
}}

{{Required OXP|Cabal Common Library}}
{{Required OXP|Snoopers}}

Test Ship Model

2026-07-27T00:59:02Z

Phkb:

A utility for testing models of ships/stations ''et cetera''
[[File:Test Ship Model.png|thumb|right|600px||Viewing the Coriolis station model in Oolite 1.92]]
[[File:Test_ship_model_1.90.png|thumb|right|600px||Viewing the Coriolis station model in Oolite 1.90]]

== Overview ==
This is a utility mod that allows you to quickly and easily view a ship model from the game. This utility uses features in Oolite 1.92

=== Use ===
When docked at a station, an F4 interface will be available, called "Test Ship Model". When you select this, you will be asked to enter the ship's data key to display. Enter that key, and press enter.

At this point, you will be shown the ship.

==== For Oolite 1.92 ====
You can now use the arrow keys, the page up/dn keys, and the yaw keys ("," and ".") to rotate and zoom the ship. Pressing Ctrl plus the arrow keys will move the model in that direction. You can increase or decrease how far one keypress will move the ship by using the "+" and "-" keys.

"R" will reset the view back to the initial position.

"N" will return to the screen where a new ship data key can be entered. Previous ships you have viewed will be listed as well. Use a number to select one of those ship keys instead of entering another data key. The last 15 ships will be displayed, and the list will be saved with the save game settings.

"H" will hide the instructions, which will be displayed with the ship model. Pressing "H" again will bring the instructions back.

If the ship model uses the personality property to change the skin or colour of the ship, you can enter a personality number by pressing the number keys. As you do, the "New personality" item will show in the instructions. Once you have entered the desired number, press "P" to set the personality to this value.

Pressing ESC will return you to the F4 Interfaces screen.

==== For Oolite 1.90 ====
Use the menu on the left side to rotate the ship, zoom in and out, change the step amount, and reset the view.

To switch between "Rotation" and "Movement" modes, select either "Rotation >" or "Movement >" at the top of the menu.

===Sub-entities===
If the model being viewed has sub-entities, it is possible to select and then move/rotate each individual sub-entity. Press "s" (or select the "Select subent" menu) to cycle through the available subentities. As each sub-entity is selected, the index and either the name or data key of the subentity will be shown.

In 1.92, use the Ctrl plus arrows keys and Ctrl + "," and "." to move the sub-entity, and use the arrow keys, "," and "." keys to rotate the sub-entity.

In 1.90, use the menu to rotate and move the sub-entity.

To see the updated definitions for all the sub-entities, press the "d" key (or select the "Dump subents" menu). This will write the updated sub-entity definitions to the log file.

=== Shortcut ===
In Oolite 1.92, you can also press Ctrl-T on the F5 Ship Status screen to jump directly to the Test Ship Model screen.

=== Extra Notes ===
* You can't display the model of anything with "is_template" set to yes/true/1. You would need the in-game version of the ship, ie. where "like_ship" has been set to the template key name.

* Also, if there is a condition_script on the shipdata entry, those conditions will need to pass to display the model. For instance, attempting to view ships from the Commies mod will require you to be in a Communist system.

And that's it, really. Nothing too fancy, but show-casing a bit of what we can now do with mission screens.

== Requirements ==
Oolite 1.82 or later is required.

== Download ==
* [[Media:TestShipModel.oxz|TestShipModel.oxz]] (v1.4)

== 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/

== Version History ==
1.4
* Added ability to select a sub-entity and move/rotate it. Adjusted subentity information can then be output to the log file.
* Added ship name to displayed information.
* Added console messages to notify of some changes when instructions are hidden (Oolite 1.92 only).
* Added ability to change the step in small increments (Oolite 1.92 only).
* Improved integration with Library.

1.3
* Added ability to move the model up/down/left/right.

1.2
* Made compatible with Oolite version 1.90 (and back to 1.82 actually!).
* Added shortcut key to F5 Manifest screen (Ctrl-T) to open the test screen (available in Oolite 1.92 or later).
* The ship datakey is now shown at the top of the view model screen.
* Moved all text to descriptions.plist for easier localisation.

1.1
* Switched "allowInterrupt" to false.
* Added option to clear the data key history.

1.0
* initial release

== Links ==
* [https://bb.oolite.space/viewtopic.php?f=4&t=21453 BB thread] (2023)
* Author: [[User:Phkb|Phkb]]

[[Category:Oolite utilities]]

Loadout by Category

2026-07-27T00:56:13Z

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.14
|release = 2026-07-27
|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]
}}

Vimana-X HUD

2026-07-27T00:55:29Z

Phkb:

[[File:Vimanax_hud.png|thumb|right|600px||VimanaX 12MFD HUD with all the lights on •''additional'' warning signs (red exclamations marks inside dials) •relevant "mode" now given for (e.g.) Market Inquirer MFD (above the left-hand dials) •confusing fuel injector icon is now inside the speed dial on the left •SRS (Ship repair system/repairbots) & AMS (Anti-missile system) status now replaceable with details of Elite rank status and Legal status (above the right-hand dials) •''Incoming missile warning'' (red reticle icon to the bottom left of the green targetting box in the middle of the viewscreen)]]
Phkb's major update of the Vimana HUD. More compatibility (''eg'' with scanner options, fonts, equipment), a glare-proof option and more logical placement of icons.
== Overview ==
Gnievmir's original [[Vimana HUD]] has earned a lot of praise for the stylish layout of the graphical dials and other UI bells and whistles. However, I always struggled to choose it for a number of reasons:
* It seemed to be designed with a single font in mind. Using a different font leads to a lot of text overrunning the graphical bounds of the UI, or not aligning correctly.
* It also seemed to be designed with a very specific group of OXP's in mind. If those OXP's are missing then parts of the UI were effectively useless.
* When viewing any of the F5-F8 pages during flight, or when going to the F2 screen after pausing, the HUD would overlap parts of the screen, making some things difficult to read.
* The Ship info and Target info panels are useful, but only a limited number of ships would be shown as an image.
* The "Mode" information for certain primable OXP equipment items was limited in what it would show.
* The jump distance indicator on the fuel gauge would only show after the Travel Module was purchased.
* An "uber" laser was included in the original Vimana HUD, as well as a targeting equipment item. Both were better suited to separate OXP's.

== What changed ==
So, I embarked on a tweaking session, which turned into a design/layout session, which turned into a much bigger update than I was expecting. However, I feel the result is worth it. Here's a complete breakdown of everything I did:

[[File:Vimanax_options2.png|thumb|right|F4 interface page, showing all available options.]]
# I divided the UI up into two, with only the scanner and core dials and gauges showing whenever a non-viewscreen view is selected.
# I repositioned some components to allow for some greater flexibility with other items. I repositioned the injectors icon, the fuel scoop icon, and the fuel warning icon to be inside the speed, cargo and fuel gauges respectively, which allowed me to move the shield capacitors icon, shield cycler icon and EEU icons to the left side of the UI. This then allowed enough room to add an additional gauge which is used for aft armour (at present, this is only used by Ship Configuration, but if other OXP's deploy aft shields it can be configured to use that as well).
# I darkened the background of the UI substantially, making it less transparent, and therefore better able to cope with high-glare environments. But in case anyone was particularly attached to the "light" version, it can still be used as an option (selectable from an F4 interface screen).
# I reworked much of the text alignment code to ensure all the displays would work well with every font available. So columns will line up, text will be centred where required, and text items will not go beyond the bounds of the UI (mostly!).
# I looked at how it works with other OXP's and tried to expand the possibilities and remove the locked-in feeling with some of the UI elements. In particular, the Anti-missile system and the Self-Repair system, which had their own lines on the UI. I switched this for a customisable system to allow for future OXP integrations, and added a couple of extra options to select from. There is now a F4 interface page, "Vimana-X HUD Settings" where the different options can be selected.
# I expanded the "MODE" display for primable equipment, finding as many OXP's as I could that make use of this feature and adding the appropriate text.
# I added alert icons inside each of the items that can cause alerts (altitude, cabin temp, energy, shields), and a missile warning icon in the combat HUD, to complement the larger warnings that appear at the top of the screen. If you find the top screen icons too intrusive, they can be turned off via the interfaces page, leaving just the smaller alert icons on the HUD. Also, I removed the text from the alert images, leaving them as images, and added text to the HUD, so that the warnings will appear in whatever font the player has chosen to use.
# I added a bunch (500+!) of extra ship images from a variety of sources, so chances are a ship image will display in the left panel in the majority of cases. I also redid the existing images, because I couldn't reproduce the style of the original. What I've used is the wireframe version of all the ships, which carries a nice blueprint/schematic style to the ships. If I've left out your favourite ships, just let me know and I'll include them in a future release.
# I changed the way the "scan" component works. In the original HUD, different parts of your ship would be highlighted individually, as if a "scan" was taking place. However, given the number of new ship images I was adding, it would be a mammoth task to divide each one up into four to keep that system. So I implemented a new "scan" that will work for whatever ship is displayed.
# I changed the colour of the jump distance indicator in the fuel gauge, to make it stand out more.
# I changed the source of the targeted ship's weapon, taking it from Combat MFD's data, so that it matches what you see in that MFD, but also so that some information isn't revealed before the player has any right to know.
# I added an icon for the naval energy unit, to make it distinct from the normal one.
# To aid with startup timeout issues, I made the various timers start in sequence, and play a small sound when they turn on, to indicate the systems are starting up.
# I added a 10-MFD version of the HUD, as well as reducing the size of the lower left and right MFD's on the 12-MFD version, to prevent them from overlapping the UI on a 16:9 display. If you use the 12-MFD HUD, and your screen dimensions cause the lower left and right MFD's to overlap the UI, and it doesn't make your eyes twitch, then everything is fine! But if you find small details like that really annoying, and you really need all the MFD's you can get, I'd recommend the 10-MFD version. I won't judge.
# I turned on the non-linear scanner and ultra zoom options on the HUD. Plus added options to change these settings on the F4 interface page.
# The Alt gauge will now reset when entering interstellar space.
# Only equipment that is visible on the F5 page will be shown on any damaged equipment list.
# Lots of small bug fixes, code tweaks and performance improvements.
# I removed the targeting equipment item and the "uber" laser. It's now just a HUD. If you really want to keep those items, you should keep the original Vimana HUD OXP installed. There should be no conflicts between the HUDs.

If you have previously used the Vimana HUD, and purchased the Target, Travel and Ship modules for it, you will have those modules added automatically when you install this HUD. However, be sure to keep both HUDs installed before you switch to Vimana-X. If you uninstall Vimana first, Vimana-X won't be able to know that you had those equipment items already, so you'll have to purchase them again.

== Purchasable Additions ==
=== Travel Module ===
(TL6 1,000₢) shows multiple witchspace destinations

=== Ship Module ===
(TL6 1,500₢) shows damage status of ship

=== Target Module ===
(TL6 2,500₢) shows combat or docking information with a nice icon of most of the probable targets

==Required OXP's==
The following OXP's are listed as required:
* [[Combat MFD]] - Required for some aspects of the HUD.
* [[Wireframe Ship Images]] - Required for ship images shown in current target and player ship.

== Download ==
Available on the Expansion Manager or here: [[Media:VimanaX_HUD_1.87.oxz|VimanaX_HUD_1.28.oxz]]

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

== Version History ==
1.28
* Tighter integration with Library.
* Improved link to HyperRadio 2.0.
* Added missing ":" to target cargo text in descriptions.plist.

1.27
* Added equipment link to Hyper Radio 2.
* Tweaks to how satellites are displayed in the target module.

1.26
* Moved all text into descriptions.plist for easier localisation.
* Added code to clear the players target when switching between ident and missile target modes.
* Small tweak to logic for determining if a target is a ship or not.
* Hopefully some performance boost from refactoring code to make localisation easier.

1.25
* Switched the custom name to be right aligned, rather than left aligned.

1.24
* When a target entity has a custom name, it will now be put on a separate line, below the ship class name.

1.23
* Refuelling stations now show energy and collision radius when targeted.
* Equipment damaged or repaired in dock will now longer generate an error.

1.22
* Fixed bug that was causing the travel info to be calculated and displayed over and over.
* Fixed issue with globe image.

1.21
* Added rgba_background to message_gui element.
* Added individual images for all asteroids, boulders, fragments and splinters.
* Split off the ship images into a separate OXP ([[Wireframe Ship Images]]) to make it easier for other OXP authors to leverage the images, and so this OXP doesn't need to be updated as much.
* Re-enabled ship scan and shield graphics (forgot to turn them on again after testing!)

1.20
* Performance improvements.
* Added image for Sidewinder NG
* Added more Thargoid/Tharglet images, and improved identification for various Thargoid Warships and Robot Fighters.
* Added/tweaked images for Thargoid vessels in TCAT 2.0.
* Added some missing Feudal States images.
* Added image for Cobra Mk IX.
* Max normal speed now always shown correctly on speed dial.

1.19
* Added images for Revolutionary AstroFarms and Revolutionary Logistics.

1.18
* Added image for Fruit Bat and Flying Fox.
* Added missing Rock Hermit disambiguation link for Pirate Coves.
* Carriers that are ships will now have their speed displayed in the left panel when targeted, instead of their collision radius.

1.17
* Added images from Lave Academy.
* Added images from Coluber Racers.
* Added image from STE.
* Improved detection of Xenon UI amber mode on startup.
* Improved protection against missing data from Extra Rock Hermits.

1.16
* Added images for Extra Rock Hermits.

1.15
* Added images for Jump Gates.
* Added images for Nuit Vampires.
* Added images for Isis Interstellar.

1.14
* Fixed for NaN showing in space compass distance when Manual Witchspace Alignment target is selected.
* Clock on docked HUD is now right-aligned to the game window no matter what font is used.
* Some code refactoring.

1.13
* Small tweak to the compass target distance display, so "km" remains the scale up to 9999km before switching.

1.12
* Fixed issue with missile warning system not working reliably,
* Added primable equipment info for Ejection Damper (from GalCop Missions OXP).
* Tweaked the distance to target element, so large values should fit into the UI bounds better.
* Space compass target distance made to stay within bounds.
* Speed value will now stay within bounds.
* Added disambiguation for Kiota Habitat Stations (could be 2 ring, 4 ring or 4 ring variant).
* Added code to read [[Telescope]] V2 mode (only available with Telescope v2.1.4).

1.11
* Added some missing station image lookups.
* Rotated some station images for consistency.
* Tweaked the compass image for less graininess.
* Further improvements to the MFD background clearing process.
* Added extra system info to witchspace destination label when docked.
* Added station name and current system name and info to docked HUD.
* Missile data in the target information panel now only shows what type of missile the target has launched.
* Used cargo space of the target is now only visible if Manifest Scanner has scanned ship.
* Added missing Sidewinder image, now distinct from Sidewinder Escort.
* Added disambiguation keys for ships named "Sidewinder Scout Ships" (which could be Sidewinders or Sidewinder Escorts).

1.10
* Better protection against undefined results when targeting ships.

1.9
* Fixed issue with docked HUD not showing hyperspace destination unless a system map concealment OXP was active and systems had been revealed.
* Added docked HUD amber mode, which is auto-selected if XenonUI is active and has it's amber mode turned on.
* Fixed a number of errors with ship images (missing files, mis-named files and incorrect lookups).

1.8
* Added ship images for Sniper Gun ships.
* Added ship images for Riredi OXP ships.
* Added ship speed to combat crosshairs.

1.7
* Fixed issue where route information was not showing in left side panel unless a system map concealment OXP was active and systems had been revealed.
* Switched gauges for Alt, Energy, Front/Aft Shield, and Front/Aft Armour to have biggest dial segment for the smallest (and most critical) value.
* Fixed issue where Ironhide armour percentage could have excessive decimal points.
* Made flashing warning labels stay on screen for longer for better readability.
* Fixed issue preventing Shield Cycler icons from appearing.
* Removed incompatibility settings with Shield Cycler.
* Switched alerting function calculation of altitude to use Combat MFD's calculation, rather than doing it again.
* Linked up colour of the Manual Witchspace Alignment jump beacon to match UI colours.
* Some code refactoring.

1.6
* Fixed issue with target speed values showing as "undefined".
* More improvements to the MFD background clearing process.
* Fixed spelling error for Vampire Mk6 image.
* Fixed spelling error for Boomslang MkIII image.
* Fixed spelling error for Raptor Defense Interceptor image.
* Corrected station identification for Solo's Alt Stations.
* Fixed JS error when targeting a system that cannot be reached.
* Small tweak to the character width of the speed value, so it doesn't overflow the UI when speed is high and using wide fonts.

1.5
* Added fuel leak warning.
* Cleaned up issue where MFD background images were not being removed when the MFD slot was cleared, in some cases.
* Fixed a couple of issues where JS errors would occur when the player ship was destroyed.
* Fixed issues where the witchspace destination would read "(Unknown)" when no destination had been set.
* Moved storage of missile monitoring array to somewhere where it shouldn't be overwritten or lost.
* Bug fixes.

1.4
* Target info for escape pods now just shows speed and bounty.
* Fixed issue where not all cargo containers were getting an image in the target info.
* Made the background of MFD's a bit darker when in "dark" mode.
* Changed the color of the MFD's to green to match the rest of the UI.
* Switched to CombatMFD's target speed value, for consistency between that MFD and the target info displayed here.
* Switched to CombatMFD's altitude calculation, as there's no need to calculate the same number twice.
* Borrowed missile tracking system from XenonHUD for improved performance.
* Resized most of the image files to save Oolite time resizing them after starting.
* Made the HUD work properly without HUD Selector installed.
* Better integration with HUD Selector, particularly the number of MFD's shown as available.
* Added options to sell each of the mods.
* Witchspace destination and the travel mod now honour the concealment property on systems.
* Added more ship images.
* Code cleanup and refactoring.

1.3
* Added ship images for the Accipiter, Boomslang Mk3 and Mk4, Constore buoys, Copperhead Yari, Escortdeck ships including the S8, Farstar Murderer, Far Arm ships, Firefly, King Cobra MkI, Metal alloys, Morrigan, Mosquito, Outrider, S9 Firefly, Shuriken, Shrike, Swift, Scimitar, Stingray, Scorpius, Tembo, Tepiu, Wyvern, Snark, YAH billboard, Montana05's resource pack items, plus a couple of items I missed from Armoury.

1.2
* Stopped auto-awarding all mods to player, regardless of whether they'd purchased the Vimana HUD equivalents.
* Fixed a bug with checking route distance when no route set.
* Tweaks to the Heat sink special slot output. Will now display "0 avail" when no heat sinks are left, rather than a blank.

1.1
* Adjusted the F4 options page to better handle all options being visible.
* Added options for setting Ultra Zoom and Non-Linear scanner to the options page.
* Added joystick sensitivity indicator to the HUD.
* Added ship images for FdL Lightspeeder, Stormbrewer, Kracken, Draven ships, Armory items, Phantom, Spectre, SKS Plasma Mk1, Heavy Metal ships, ADCK Bulk Haulers, Saiph Interceptor, Rigel Tactical Bomber, Star Destroyer, Star Destroyer Shuttle, Tie Fighter and Tie Interceptor.
* Some code refactoring.

1.0
* Initial release

== Quick Facts ==
{{OXPLevel|0}}
{{IconOXP|ooVersion="1.80"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Low"}}
{{Infobox OXPb| title = Vimana-X HUD
|version = 1.28
|release = 2026-07-27
|features = Full featured HUD
|license = CC BY-NC-SA 4.0
|category = HUDs OXPs
|author = [[User:Gnievmir|Gnievmir]], [[User:phkb|phkb]]
|feedback = [https://bb.oolite.space/viewtopic.php?f=4&t=21415 BB-Link]
}}
[[Category:HUDs OXPs]]
[[Category:Oolite expansion packs]]

Anarchies OXP

2026-07-27T00:54:01Z

Phkb: /* Version History */

[[File:Anarchies Facelift.png|right|400px]]
Add flavour to the Anarchy systems. This oxp also affects the [[bounty]] system.
== Introduction ==

It's a dangerous Ooniverse out there. Especially if you choose the life of a "privateer", looking for high profits without a special regard to your legal rating. A little trading in guns and drugs, a little racketeering, a little plundering of ships that hadn't been crippled before you arrived at the scene, some unfortunate confrontations with the police; and before long you find yourself on [[GalCop|GalCop's]] "most wanted"-list, a handsome sum on your head, hunted not only by your fellow pirates, but also by bounty hunters and the police. An uncomfortable position indeed.

If you install this OXP things get worse.

== Overview ==

Install this OXP, and the appearance of [[Powers_and_Organisations#Anarchy_Worlds|Anarchy-systems]] in Oolite will change. In certain Anarchy-systems you will find Hacker Outposts, Salvage Gangs, Sentinel Stations or Renegade Stations. Depending on your legal status these may be more or less useful to you, and docking with them may be more or less dangerous to you.

Anarchies.oxp also modifies the way how the game deals with your legal status in general. First of all the bounty on your head—which translates into a bad legal status of 'Offender' or 'Fugitive'—will stick to you for a much longer time. If you don't commit more crimes, your status will get cleared after a while, just by jumping from system to system, as it was in the plain game. But once you are 'Fugitive' and the stations don't accept requests from your docking computer anymore, this will take much longer than without this OXP installed. It may take almost forever to get downrated to an 'Offender' rating again. The OXP also shuts the back-door of using your escape pod to become 'Clean' again. With Anarchies.oxp installed, your legal status travels with you even in your escape capsule, and is locked into your new ship's transponder, as soon as you arrive at a station.

But the OXP offers also a variety of new ways of getting rid of an 'Offender'- or 'Fugitive'-status. These ways include the purchase of certain items on certain asteroids; but also bribing a GalCop official in the main station of an Anarchy-system is an option. You can even do something for your legal reputation if you choose to help the cops (but this will not prevent them from attacking you, as long as you still are 'Fugitive' or 'Offender' yourself).

== Notable Features ==
[[File:Hacker Outpost.png|thumb|right|250px|Hacker Outpost]]
[[File:Salvager.png|thumb|right|250px|Salvage Gang]]
[[File:Adckstation.png|thumb|right|250px|Sentinel Station]]
[[File:Behe3.png|thumb|right|250px|2 variants of the Amnesty Offer Behemoths]]

=== Hacker Outposts ===
In some Anarchies you will find a [[Hacker Outpost]]. These are huge inhabited asteroids, usually hidden in an asteroid field far away from the main station and GalCop's zone of influence. If you don't get a clue from one of their henchmen you won't find it. And if the henchman doesn't accept you as a fellow privateer you will have to "tease" him a little before he will share his information.

Even though the Hackers prefer Anarchies with a higher tech level, they are still technologically far ahead of that themselves. The Hackers are welcoming to a pilot who is—for whatever reason—in some trouble with GalCop, and they have a solution to offer—for a price. If you want, they can hack into GalCop's central database and clear your whole legal record, provided you have enough money to maintain the quite expensive sub-ether broadband connection they need for their work.

Apart from that you may be able to make some good deals with the Hackers. Living far away from the space lanes they are always in need of all every-day supplies. And they are happy to obtain the raw materials for their home-built computer systems. On the other hand there is not much pastime in the outpost apart from building sophisticated high-end soft- and hardware. So you may stumble over many an opportunity in the outpost's market-section.

=== Salvage Gangs ===
In some Anarchies, and even in non-Anarchy-systems, usually in the medium-range tech level, you can't miss the local [[Salvage Gang]]. Again this is a huge, hollowed-out asteroid, which is home to a gang of salvagers. You will find them wherever there is something to salvage, i.e. usually in the middle of the main corridor. Most of their business is legal, or at least not illegal enough to draw too much of GalCop's attention towards them. A clever commander will find many a bargain on the asteroid's market, especially as far as used alloys and machinery are concerned.

A visit to the Salvager's equipment store can perhaps be even more rewarding. Don't bother with the original, first-hand equipment. If they have any, it will be more expensive than in the system's main station. But quite often they manage to recover complete and (almost) unharmed equipment items from stranded shipwrecks. They refurbish and sell these items, and this is where you are in for some real bargains, if you feel the urge to fully equip your ship. The only question is: Can you trust the Salvager's advertising slogans? And what exactly is the One-Gunfight-Guarantee™? But anyway, it's cheap; so you can probably even afford to fix it, if it breaks.

Finally for the not-quite-so-legal part of their business: If GalCop for some odd reason doesn't seem to like you, there will be a special piece of equipment, which you will be able to obtain in the more shady Salvage Gangs in Anarchy-systems; sort of under the counter, so-to-speak. It may or may not be helpful to you; you will find out.

=== Sentinel Stations ===
In some of the rougher Anarchy-systems, usually at the lower end of the tech level-spectrum, [[GalCop]] already feels that it is losing control of the space lanes to the pirates. That's the reason for the installation of a [[Military station|Sentinel Station]] at the outer end of the corridor, somewhere close to the witchpoint. Seeing a Sentinel Station guard his way has been a relief for many a trader who had underestimated the real danger of making business in Anarchy-systems.

The Sentinel Station offers not only protection to honest pilots, but also a range of services in its equipment-section. Of course you're dealing with the military here, so don't expect shopping to be cheap. But on the other hand, the superior quality of the offered equipment is out of the question. A clever pilot, however, may make some good deals in the station's market.

Oh, and don't even think about attacking a Sentinel Station. If you are in range of its plasma turrets, this will have been your last thought.

=== Renegade Stations ===
It should also be mentioned that in some cases GalCop's fears were justified. It ''has'' lost control to the pirates, who simply have overrun the military station and turned it into a [[Military station|Renegade Station]]. Unfortunately for harmless traders there is no way to tell from the distance whether the outlaws already have taken over the station. And once you are in scanner range it may be too late. The Renegades love to attack unsuspecting victims (and suspecting victims as well, for that matter). And even if they are busy attacking somebody else, or you have luckily slipped through their scanner grid, please don't attempt to dock with the Renegade Station. No, really; don't. And if you do, don't say I haven't warned you!

On the other hand, if you feel you are one of them (and I'm not talking about some parking violations; what I mean is, if you are a real criminal), and have righteously earned a good bad reputation; well, in that case you should seriously consider to pay the Renegades a visit. Their station is as close to a safe haven for all sorts of racketeers as it gets. The equipment-department may not be worth a visit—in the fight following the initial attack on the Sentinel Station much of the stock was destroyed, and generally the Renegades are not very well-known for their particularly caring and careful attitude towards things anyway; so the few intact items remaining on the shelves are much sought after among the criminals on the station, and thus equally expensive. And that is, if you want to risk a gunfight with some awful-looking and heavily armed creatures in the first place, in order to even get to the store and bid for one of the rusty missiles. On the other hand, a visit to the Renegade Station's market may feel like pirates' paradise. It is here that you really appreciate why you chose this kind of career anyway.

=== Bribery and corruption ===
Even some main stations offer new opportunities hitherto unknown to not-so-law-abiding pilots. If you have managed to dock at all, which may require manual abilities, depending on your register of previous convictions, and have passed through the initial controls without being forced to lick the hangar clean—you know what I mean—then it may be worthwhile to hang around in the equipment department, and watch out for dubious [[GalCop]] personnel. Rumour has it that especially in stations in [[Powers_and_Organisations#Anarchy_Worlds|Anarchy-systems]] discipline among GalCop officials has become a little lax, and you might find an officer willing to take a bribe for clearing your legal status. Of course the conscience of an official of the Galactic Co-operative of Worlds, invested with a position of responsibility in an environment with a less-than-desirable amount of comfort and safety has its value, and therefore its price. A word of warning, though: It goes without saying that the attempt to bargain in such a delicate matter as bribing someone who has access to GalCop's central database will be at your own risk.

=== Amnesty Offers ===
On the other hand, GalCop's military arm, the Galactic Navy, is always interested in skilled pilots with combat effectiveness. The ongoing war against the Thargoids means that the Navy sometimes can't be too picky in whom it calls to active reserve duty. Therefore GalCop issues an [[Amnesty Offers|Amnesty Order]] from time to time. Pilots willing to take the offer have to report at a naval Behemoth parked in a system close to a current war zone. The amnesty offer is announced foremost in all kinds of meeting points for commanders who have a legal record to clear, among them Hacker Outposts and Salvage Gangs. GalCop is only considering an amnesty for criminals in exchange for their help if the Navy is really in a tight spot, therefore expect the deadline until the offer expires to be equally tight. If you make it in time and find the Behemoth, you'll be given a naval assignment. You have to fulfill it—and come back in one piece—in order to get your legal record cleared. Just don't get yourself involved in criminal activities again! (NOTE: everything mentioned in this paragraph requires [[Behemoth|Behemoth.oxp]] to be installed. If you don't have it, you won't receive any amnesty offers.)

== Featured Stations and Ships ==

1) The [[Hacker Outpost]]. Dockable Asteroid. Modeled by Killer Wolf for this OXP. Shader effects by Griff (v 2.0). Killer Wolf expresses his thanks to Charlie, Griff, Selezen, Arexack_Heretic, LittleBear, Dr. Nil, Ahruman and anybody else who has helped building it.

2) The [[Salvage Gang]]. Dockable Asteroid. Modeled by Killer Wolf for this OXP. Shader effects by Griff (v 2.0). Credits see above.

3) The [[Military station|Sentinel Station]]. Dockable Station. Modeled by Aegidian for gwxstations.oxp and taken from that OXP. Only the colour of the plasma bolts was altered.

4) The [[Military station|Renegade Station]]. Clone of the Sentinel Station, again another colour of the plasma bolts.

5) The [[Renegade Viper|Hacker Viper]]. Pirate ship, Hacker henchman and defense ship of Hacker Outpost and Renegade Station. Modeled by 8bitapocalypse for renegade_viper.oxp and taken from that OXP.

6) The [[Phoenix|Salvager Phoenix]]. Defense ship of Salvage Gang and Renegade Station. Modeled by Cmdr Wyvern for phoenix.oxp and taken from that OXP. Salvager logo was added to the original texture.

7) The [[Hognose Tugship|Salvager Tugger]]. Tugship of the Salvage Gang. Modeled by murgh for tugs.oxp and taken from that OXP. Salvager logo was added to the original texture.

7b) A couple of tugged ships. A variety of ships from the original set, taken from murgh's tugs.oxp.

8) Three bounty hunters. They will come after the player, as long as he is FUGITIVE. Asp, CobraMkIII and Fer-de-Lance from the original set, hardened and with custom AI.

== Thanks ==

Last but not least I want to give lots of thanks to all who have contributed so far: Julyy for the original idea, [[Killer Wolf]] for a couple of very good suggestions that I could incorporate and for two beautiful asteroid models, [[User:Griff|Griff]] for providing some beautiful shader effects for these asteroids, [[User:Arexack|Arexack_Heretic]] for a lot of very useful and practical advice, [[User:LittleBear|LittleBear]] for pointing me to BlackMonks as an example for some things I was trying to do, [[User:Eric Walch|Eric Walch]] for bringing some problems in the script to my attention and providing imaginative suggestions how to solve them, and for not only introducing me to the secrets of ship-scripts, but also providing ready-made scripts for whatever I wanted to do, Disembodied for the amnesty idea, the ship-designers whose work I took the liberty to use in this OXP, Cap'n Hack for still hosting Oosat1 (and for guest-starring in this OXP), [[User:Ahruman|Ahruman]], [[User:Another_commander|Another_commander]] and the others for improving Oolite, [[User:Aegidian|Aegidian]] for this wonderful game, and all the other members of the Oolite BB who contributed to this OXP!

== Lore ==
An Anarchy system is defined as “a system where no diplomatic relations may be established”, generally due to a complete lack of recognisable government. Again, therefore, formal agreement to the Cooperative treaties is generally missing, though in practice there is often at least a vague acceptance of them by individuals.

[[Sector6/Laxeti|Laxeti]] in Chart 6 is one typical example, where all larger governments have broken down, there is no planetary authority larger than a city, and all attempts to establish diplomatic communications with the Cooperative have failed, even on a multi-government model. Visitors to the planet must arrange their visits separately to each region, and similarly traders wishing to ship goods to the surface must barter carefully in the absence of any currency with worth outside the few hundred square kilometres it originates in.

[[Sector1/Maesin|Maesin]] in Chart 1 is very different, but the result in space is the same. The original colonists were refugees from a harsh dictatorial system, and came to Maesin with the aim of having no hierarchies, no formal power structures, and no leaders, so that no-one could seize power in the same way. With persistent effort, they have succeeded in doing this, and the planet remains a peaceful voluntary collective of subsistence farmers to this day. Unfortunately, as a consequence, there is absolutely no authority which the Cooperative can deal with, and so the space above the planet is a haven for pirates and other criminals.

[[Sector4/Isquinza|Isquinza]] in Chart 4 is a highly unusual Anarchy. The planetary government is a well-organised corporate dictatorship, well known for the manufacture of Zero-G Hockey sticks and other sporting goods. However, they are also extremely isolationist. Trade is carried out by a few trusted intermediaries, and direct communication between the surface and space is completely outlawed. Most of the facts about the government are only known through extremely careful anthropological research, as it refuses outright to talk to the Cooperative or visitors at all, and only allows the trusted intermediaries to land.

== License ==

This work is licensed under the Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License. To view a copy of this license, visit the Creative Commons' website or send a letter to Creative Commons, 171 Second Street, Suite 300, San Fransisco, California, 94105, USA.

Practically this means that you may rip it apart and use whatever seems useful to you, as long as you credit the original author ("Commander McLane"), and share your work under the same license. It would be nice—although by no means necessary—to give me a note (either on the Oolite BB, or via email), if you intend to use parts of it.

== Version History ==

version 2.10.2 (July 2026)
- Fixed a script error.
- Tighter integration with Library.

version 2.10.1 (July 2026)
- Fixed condition script that was preventing Renegade Vipers from spawning.

version 2.10 (July 2026)
- Spelling corrections
- Moved all text into descriptions.plist or missiontext.plist for easier localisation.
- When checking what station the player is at, switched to using station roles.
- Removed extraneous entries in descriptions.plist
- Converted missiontext.plist to OpenStep format.
- Fixed JS error in henchman ship script.
- Hacker Outpost will now spawn without a beacon, and when you find the henchman, the beacon will bee added. This allows for the game to be saved at Hacker Outposts.
- Some scripting has been updated to use the latest Oolite functions.
- File cleanup.

version 2.9.5 (Feb 2026)
- Updated some PNG files to remove invalid colour profile.

version 2.9.4 (July 2020)
- fixed conditions script so ships derived from anarchies-renegade_viper could be spawned.

version‭ ‬2.9.3 (‬March ‬2017)
- fixed semicolon problems in Mac, thanks to hoqllnq.

<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">
version‭ ‬2.9.2‭ (‬December‭ ‬2016‭)
-‎ ‏updated all subentities to use new style
-‎ ‏updated equipment.plist to OpenStep format.
-‎ ‏updated shipdata.plist to OpenStep format.
-‎ ‏changed‭ ‬’background‭’‬ properties of mission screens to‭ ‬’overlay‭’
-‎ ‏added screen ID to all mission screens.
-‎ ‏updated station market scripts to use new style.
-‎ ‏updated equipment conditions to use a condition script.
-‎ ‏updated shipdata.plist to use a condition script.
-‎ ‏fixed incorrect texture reference in‭ ‬"afl-m-dock‭"‬ definition.

version 2.9.1 (November 2016)
- fixed issues with double Behemoths appearing in system
- fixed issues with the amnesty mission not being triggered when docking at the Behemoth
- fixed javascript "undefined" error relating to "bouy-witchspace".

version 2.9 (October 2014)
- converted to OXZ format
- contain the facelift by spara
- you can save in the additional stations, except in the Hacker Outpost which is not stationary

version 2.8 (April 2012)
- fixed a problem that made the amnesty mission unfinishable if the game was saved and reloaded while doing it

version 2.7 (March 2012)
- fixed a problem that could limit other OXPs' (or the main game's) freedom to make the cloaking device repairable

version 2.6 (January 2012)
- moved some more previously overlooked methods to their own name space
- fixed problem of vanishing Sentinel Asteroids with Oolite 1.76
- fixed a small bug where removing the second henchman would give an error message
- Sentinel and Renegade Stations are aligned with the planet again
- Sentinel and Renegade Stations now are behaving like they're supposed to for the first time
- Sentinel Stations now have patrol ships to secure the space lane
- Oolite 1.76 required

version 2.5 (March 2011)
- changed all JS-scripts to strict mode
- moved all self-defined methods into their own namespace
- implemented another idea for coming clean: doing a Navy reserve mission and getting amnesty on completion
- for this to fully work Oolite 1.75.1 is now required

version 2.4 (February 2011)
- Salvage Gangs' hails are now sent via ship script instead AI, giving more timing flexibility
- Salvager Tugger is now part of the Salvage Gang's ship group, therefore it will be defended by the Gang
- two of the tugged ship models included in the OXP
- fixed another bug introduced with the shader bugfix in 2.3
- Cloaking Device no longer buyable in Hacker Outpost by accident, but still repairable
- fixed a nasty bug that removed the player's extra energy unit whenever he bought new equipment
- replaced all instances of pseudo random with scrambledPseudoRandomNumber; this will change the distribution of Salvage Gangs across systems, but not the overall number of them
- cleaning-up of AIs and shipdata
- requires now Oolite 1.75

version 2.3 (November 2009)
- fixed the bugs introduced with the shader bugfix in 2.2 (thanks, Griff!)
- JS: replaced all setOrientation and setPosition, as needed in Oolite 1.73
- JS: changed the handling of defense groups according to the requirements of Oolite 1.73
- requires Oolite 1.73

version 2.2 (July 2009)
- fixed a bug with the Salvage Gang's shaders (thanks, another_commander and Griff!)

version 2.1 (January 2009)
- fixed a bug that would let Salvager Tuggers not appear in version 2.0
- fixed a bug with the Sentinel and Renegade Stations that would cause them to behave strangely when attacked

version 2.0 (January 2009)
- revised the Hacker Outpost model, closing the visible gaps around the tunnel exits
- tunnels in both Hacker Outpost and Salvage Gang replaced with models that use shaders (thanks, Griff!)
- docking bays in both Hacker Outpost and Salvage Gang replaced with Griff's models (ditto!)
- tweaked tugger model a little
- henchmen will no longer give the Hacker Outpost's location to everybody
- simplified the Hacker Outpost spawning
- Salvage Gang now aligning with the planet, and asteroid field spawned via ship script
- fixed a bug that would give the bribe offer too often
- fixed a bug that had replaced all Renegade Stations with Sentinel Stations in 1.1
- fixed a bug that would not initialise some processes if a new commander was started
- player's bounty now reduced 10% per jump if fugitive, instead of a 20 or 10 points
- salvaged equipment is now installed on buying, instead of waiting for launch
- equipment failure chance is now triggered through a timer, instead of a bunch of events; and now uses the new EquipmentInfo object
- there is also a chance now that salvaged equipment will work just fine, removing the failure possibility
- some minor tweaks in this readMe
- JS: replaced player.ship.bounty with player.bounty, which wasn't supported in Oolite 1.72
- JS: replaced all 'let' with 'var'
- requires now Oolite 1.72.1

version 1.1 (November 2008)
- the main script is now completely in JavaScript
- Hacker Outposts are now correctly facing the planet, via their new ship-script (thanks, Eric!)
- as a bonus also their Sentinel Asteroids are finally placed correctly and work (thanks, Eric!)
- added some flashers to the asteroid models
- AIs improved
- Hacker Outposts, Salvage Gangs and Renegade Stations have now their correct commodity prices
- requires Oolite 1.72

version 1.0 (February 2008)
- fully functional version
- requires Oolite 1.65

version 0.1 (March 2007)
- teaser with basic functionality
</div>

== Minimum Requirements ==
Anarchies requires at least Oolite 1.79. I recommend you upgrade to the latest stable release version of Oolite if you haven't yet. The amnesty mission also requires that you have [[Behemoth|Behemoth.oxp]] installed.

== Other related OXPs ==
[[File:IconBGS.png|right]]
=== BGS ===
[[BGS]] enhances this OXP

=== Famous Planets ===
[[Famous Planets]] transmogrifies Sori (a TL9 Dictatorship) into [[Ascension]] - a TL16 Anarchy (Utopian, if not for the pirates!). In vanilla Oolite there are no TL16 systems.

This is particularly relevant for the [[Weapon Laws]] OXP which allows the more lethal weaponry to be sold only in the more piratic systems, where high [[TL]] tends to be quite rare.

== Download Location ==
Download [[Media:Anarchies_2.10.2.oxz‎|Anarchies_2.10.2.oxz‎]] (downloaded {{#downloads:Anarchies_2.10.2.oxz‎}} times).

There is a facelift pack for v2.10 here: [[Media:Anarchies_Facelift.oxz|Anarchies_Facelift.oxz]] (80mb)

[[Media:Anarchies_2.9.5.oxz‎|Anarchies_2.9.5.oxz‎]] (downloaded {{#downloads:Anarchies_2.9.5.oxz‎}} times).

[[Media:Anarchies-2.9.4.oxz‎|Anarchies-2.9.4.oxz‎]] was downloaded {{#downloads:Anarchies-2.9.4.oxz‎}} times.

[[Media:Anarchies_2.9.3.oxz‎|Anarchies_2.9.3.oxz‎]] was downloaded {{#downloads:Anarchies_2.9.3.oxz‎}} times.

[[Media:Anarchies.2.9.oxz‎|Anarchies.2.9.oxz‎]] was downloaded {{#downloads:Anarchies.2.9.oxz‎}} times.

[http://app.box.com/s/491d03d312b3623744e3 Anarchies2.8.oxp] is available for download via box.com.

== Installation ==
The OXZ version is installable within the game from the expansion manager.

Manual way for the OXP version: Unzip the download file. Then move or copy the file Anarchies2.8.oxp from its download folder to your AddOns folder. Restart Oolite. If you have a previous version installed, please remove it first.

== Links ==
There are more related topics, older ones also contain interesting descriptions and screenshots.
*[https://bb.oolite.space/viewtopic.php?f=4&t=11508 Anarchies 2.8] (2012 - date)
*[https://bb.oolite.space/viewtopic.php?f=4&t=14184&p=201322 Anarchies facelift] (2013)
*[https://bb.oolite.space/viewtopic.php?f=4&t=7040&p=93298 Anarchies 2.3] (2009 - 11)
*[https://bb.oolite.space/viewtopic.php?f=4&t=4253&p=46606 Anarchies 1.0] (2008)
*[https://bb.oolite.space/viewtopic.php?f=4&t=3201&p=31763 Anarchies 0.1] (2007)

*[https://bb.oolite.space/viewtopic.php?p=30758#p30758 Original Idea] (2007)
*[[User:Commander McLane‎|Commander McLane‎]]

*[https://bb.oolite.space/viewtopic.php?f=2&t=16509 Anarchy in the Oolite universe] (2014) - arguments for anarchy and that it is "good"...

*Phkb's ideas about an [https://bb.oolite.space/viewtopic.php?f=4&t=21011 Anarchies Overhaul] - pirates capturing the main orbital station! (2021)

[[Category:Oolite]]
{{system-OXP}}

Anarchies OXP

2026-07-27T00:52:01Z

Phkb:

[[File:Anarchies Facelift.png|right|400px]]
Add flavour to the Anarchy systems. This oxp also affects the [[bounty]] system.
== Introduction ==

It's a dangerous Ooniverse out there. Especially if you choose the life of a "privateer", looking for high profits without a special regard to your legal rating. A little trading in guns and drugs, a little racketeering, a little plundering of ships that hadn't been crippled before you arrived at the scene, some unfortunate confrontations with the police; and before long you find yourself on [[GalCop|GalCop's]] "most wanted"-list, a handsome sum on your head, hunted not only by your fellow pirates, but also by bounty hunters and the police. An uncomfortable position indeed.

If you install this OXP things get worse.

== Overview ==

Install this OXP, and the appearance of [[Powers_and_Organisations#Anarchy_Worlds|Anarchy-systems]] in Oolite will change. In certain Anarchy-systems you will find Hacker Outposts, Salvage Gangs, Sentinel Stations or Renegade Stations. Depending on your legal status these may be more or less useful to you, and docking with them may be more or less dangerous to you.

Anarchies.oxp also modifies the way how the game deals with your legal status in general. First of all the bounty on your head—which translates into a bad legal status of 'Offender' or 'Fugitive'—will stick to you for a much longer time. If you don't commit more crimes, your status will get cleared after a while, just by jumping from system to system, as it was in the plain game. But once you are 'Fugitive' and the stations don't accept requests from your docking computer anymore, this will take much longer than without this OXP installed. It may take almost forever to get downrated to an 'Offender' rating again. The OXP also shuts the back-door of using your escape pod to become 'Clean' again. With Anarchies.oxp installed, your legal status travels with you even in your escape capsule, and is locked into your new ship's transponder, as soon as you arrive at a station.

But the OXP offers also a variety of new ways of getting rid of an 'Offender'- or 'Fugitive'-status. These ways include the purchase of certain items on certain asteroids; but also bribing a GalCop official in the main station of an Anarchy-system is an option. You can even do something for your legal reputation if you choose to help the cops (but this will not prevent them from attacking you, as long as you still are 'Fugitive' or 'Offender' yourself).

== Notable Features ==
[[File:Hacker Outpost.png|thumb|right|250px|Hacker Outpost]]
[[File:Salvager.png|thumb|right|250px|Salvage Gang]]
[[File:Adckstation.png|thumb|right|250px|Sentinel Station]]
[[File:Behe3.png|thumb|right|250px|2 variants of the Amnesty Offer Behemoths]]

=== Hacker Outposts ===
In some Anarchies you will find a [[Hacker Outpost]]. These are huge inhabited asteroids, usually hidden in an asteroid field far away from the main station and GalCop's zone of influence. If you don't get a clue from one of their henchmen you won't find it. And if the henchman doesn't accept you as a fellow privateer you will have to "tease" him a little before he will share his information.

Even though the Hackers prefer Anarchies with a higher tech level, they are still technologically far ahead of that themselves. The Hackers are welcoming to a pilot who is—for whatever reason—in some trouble with GalCop, and they have a solution to offer—for a price. If you want, they can hack into GalCop's central database and clear your whole legal record, provided you have enough money to maintain the quite expensive sub-ether broadband connection they need for their work.

Apart from that you may be able to make some good deals with the Hackers. Living far away from the space lanes they are always in need of all every-day supplies. And they are happy to obtain the raw materials for their home-built computer systems. On the other hand there is not much pastime in the outpost apart from building sophisticated high-end soft- and hardware. So you may stumble over many an opportunity in the outpost's market-section.

=== Salvage Gangs ===
In some Anarchies, and even in non-Anarchy-systems, usually in the medium-range tech level, you can't miss the local [[Salvage Gang]]. Again this is a huge, hollowed-out asteroid, which is home to a gang of salvagers. You will find them wherever there is something to salvage, i.e. usually in the middle of the main corridor. Most of their business is legal, or at least not illegal enough to draw too much of GalCop's attention towards them. A clever commander will find many a bargain on the asteroid's market, especially as far as used alloys and machinery are concerned.

A visit to the Salvager's equipment store can perhaps be even more rewarding. Don't bother with the original, first-hand equipment. If they have any, it will be more expensive than in the system's main station. But quite often they manage to recover complete and (almost) unharmed equipment items from stranded shipwrecks. They refurbish and sell these items, and this is where you are in for some real bargains, if you feel the urge to fully equip your ship. The only question is: Can you trust the Salvager's advertising slogans? And what exactly is the One-Gunfight-Guarantee™? But anyway, it's cheap; so you can probably even afford to fix it, if it breaks.

Finally for the not-quite-so-legal part of their business: If GalCop for some odd reason doesn't seem to like you, there will be a special piece of equipment, which you will be able to obtain in the more shady Salvage Gangs in Anarchy-systems; sort of under the counter, so-to-speak. It may or may not be helpful to you; you will find out.

=== Sentinel Stations ===
In some of the rougher Anarchy-systems, usually at the lower end of the tech level-spectrum, [[GalCop]] already feels that it is losing control of the space lanes to the pirates. That's the reason for the installation of a [[Military station|Sentinel Station]] at the outer end of the corridor, somewhere close to the witchpoint. Seeing a Sentinel Station guard his way has been a relief for many a trader who had underestimated the real danger of making business in Anarchy-systems.

The Sentinel Station offers not only protection to honest pilots, but also a range of services in its equipment-section. Of course you're dealing with the military here, so don't expect shopping to be cheap. But on the other hand, the superior quality of the offered equipment is out of the question. A clever pilot, however, may make some good deals in the station's market.

Oh, and don't even think about attacking a Sentinel Station. If you are in range of its plasma turrets, this will have been your last thought.

=== Renegade Stations ===
It should also be mentioned that in some cases GalCop's fears were justified. It ''has'' lost control to the pirates, who simply have overrun the military station and turned it into a [[Military station|Renegade Station]]. Unfortunately for harmless traders there is no way to tell from the distance whether the outlaws already have taken over the station. And once you are in scanner range it may be too late. The Renegades love to attack unsuspecting victims (and suspecting victims as well, for that matter). And even if they are busy attacking somebody else, or you have luckily slipped through their scanner grid, please don't attempt to dock with the Renegade Station. No, really; don't. And if you do, don't say I haven't warned you!

On the other hand, if you feel you are one of them (and I'm not talking about some parking violations; what I mean is, if you are a real criminal), and have righteously earned a good bad reputation; well, in that case you should seriously consider to pay the Renegades a visit. Their station is as close to a safe haven for all sorts of racketeers as it gets. The equipment-department may not be worth a visit—in the fight following the initial attack on the Sentinel Station much of the stock was destroyed, and generally the Renegades are not very well-known for their particularly caring and careful attitude towards things anyway; so the few intact items remaining on the shelves are much sought after among the criminals on the station, and thus equally expensive. And that is, if you want to risk a gunfight with some awful-looking and heavily armed creatures in the first place, in order to even get to the store and bid for one of the rusty missiles. On the other hand, a visit to the Renegade Station's market may feel like pirates' paradise. It is here that you really appreciate why you chose this kind of career anyway.

=== Bribery and corruption ===
Even some main stations offer new opportunities hitherto unknown to not-so-law-abiding pilots. If you have managed to dock at all, which may require manual abilities, depending on your register of previous convictions, and have passed through the initial controls without being forced to lick the hangar clean—you know what I mean—then it may be worthwhile to hang around in the equipment department, and watch out for dubious [[GalCop]] personnel. Rumour has it that especially in stations in [[Powers_and_Organisations#Anarchy_Worlds|Anarchy-systems]] discipline among GalCop officials has become a little lax, and you might find an officer willing to take a bribe for clearing your legal status. Of course the conscience of an official of the Galactic Co-operative of Worlds, invested with a position of responsibility in an environment with a less-than-desirable amount of comfort and safety has its value, and therefore its price. A word of warning, though: It goes without saying that the attempt to bargain in such a delicate matter as bribing someone who has access to GalCop's central database will be at your own risk.

=== Amnesty Offers ===
On the other hand, GalCop's military arm, the Galactic Navy, is always interested in skilled pilots with combat effectiveness. The ongoing war against the Thargoids means that the Navy sometimes can't be too picky in whom it calls to active reserve duty. Therefore GalCop issues an [[Amnesty Offers|Amnesty Order]] from time to time. Pilots willing to take the offer have to report at a naval Behemoth parked in a system close to a current war zone. The amnesty offer is announced foremost in all kinds of meeting points for commanders who have a legal record to clear, among them Hacker Outposts and Salvage Gangs. GalCop is only considering an amnesty for criminals in exchange for their help if the Navy is really in a tight spot, therefore expect the deadline until the offer expires to be equally tight. If you make it in time and find the Behemoth, you'll be given a naval assignment. You have to fulfill it—and come back in one piece—in order to get your legal record cleared. Just don't get yourself involved in criminal activities again! (NOTE: everything mentioned in this paragraph requires [[Behemoth|Behemoth.oxp]] to be installed. If you don't have it, you won't receive any amnesty offers.)

== Featured Stations and Ships ==

1) The [[Hacker Outpost]]. Dockable Asteroid. Modeled by Killer Wolf for this OXP. Shader effects by Griff (v 2.0). Killer Wolf expresses his thanks to Charlie, Griff, Selezen, Arexack_Heretic, LittleBear, Dr. Nil, Ahruman and anybody else who has helped building it.

2) The [[Salvage Gang]]. Dockable Asteroid. Modeled by Killer Wolf for this OXP. Shader effects by Griff (v 2.0). Credits see above.

3) The [[Military station|Sentinel Station]]. Dockable Station. Modeled by Aegidian for gwxstations.oxp and taken from that OXP. Only the colour of the plasma bolts was altered.

4) The [[Military station|Renegade Station]]. Clone of the Sentinel Station, again another colour of the plasma bolts.

5) The [[Renegade Viper|Hacker Viper]]. Pirate ship, Hacker henchman and defense ship of Hacker Outpost and Renegade Station. Modeled by 8bitapocalypse for renegade_viper.oxp and taken from that OXP.

6) The [[Phoenix|Salvager Phoenix]]. Defense ship of Salvage Gang and Renegade Station. Modeled by Cmdr Wyvern for phoenix.oxp and taken from that OXP. Salvager logo was added to the original texture.

7) The [[Hognose Tugship|Salvager Tugger]]. Tugship of the Salvage Gang. Modeled by murgh for tugs.oxp and taken from that OXP. Salvager logo was added to the original texture.

7b) A couple of tugged ships. A variety of ships from the original set, taken from murgh's tugs.oxp.

8) Three bounty hunters. They will come after the player, as long as he is FUGITIVE. Asp, CobraMkIII and Fer-de-Lance from the original set, hardened and with custom AI.

== Thanks ==

Last but not least I want to give lots of thanks to all who have contributed so far: Julyy for the original idea, [[Killer Wolf]] for a couple of very good suggestions that I could incorporate and for two beautiful asteroid models, [[User:Griff|Griff]] for providing some beautiful shader effects for these asteroids, [[User:Arexack|Arexack_Heretic]] for a lot of very useful and practical advice, [[User:LittleBear|LittleBear]] for pointing me to BlackMonks as an example for some things I was trying to do, [[User:Eric Walch|Eric Walch]] for bringing some problems in the script to my attention and providing imaginative suggestions how to solve them, and for not only introducing me to the secrets of ship-scripts, but also providing ready-made scripts for whatever I wanted to do, Disembodied for the amnesty idea, the ship-designers whose work I took the liberty to use in this OXP, Cap'n Hack for still hosting Oosat1 (and for guest-starring in this OXP), [[User:Ahruman|Ahruman]], [[User:Another_commander|Another_commander]] and the others for improving Oolite, [[User:Aegidian|Aegidian]] for this wonderful game, and all the other members of the Oolite BB who contributed to this OXP!

== Lore ==
An Anarchy system is defined as “a system where no diplomatic relations may be established”, generally due to a complete lack of recognisable government. Again, therefore, formal agreement to the Cooperative treaties is generally missing, though in practice there is often at least a vague acceptance of them by individuals.

[[Sector6/Laxeti|Laxeti]] in Chart 6 is one typical example, where all larger governments have broken down, there is no planetary authority larger than a city, and all attempts to establish diplomatic communications with the Cooperative have failed, even on a multi-government model. Visitors to the planet must arrange their visits separately to each region, and similarly traders wishing to ship goods to the surface must barter carefully in the absence of any currency with worth outside the few hundred square kilometres it originates in.

[[Sector1/Maesin|Maesin]] in Chart 1 is very different, but the result in space is the same. The original colonists were refugees from a harsh dictatorial system, and came to Maesin with the aim of having no hierarchies, no formal power structures, and no leaders, so that no-one could seize power in the same way. With persistent effort, they have succeeded in doing this, and the planet remains a peaceful voluntary collective of subsistence farmers to this day. Unfortunately, as a consequence, there is absolutely no authority which the Cooperative can deal with, and so the space above the planet is a haven for pirates and other criminals.

[[Sector4/Isquinza|Isquinza]] in Chart 4 is a highly unusual Anarchy. The planetary government is a well-organised corporate dictatorship, well known for the manufacture of Zero-G Hockey sticks and other sporting goods. However, they are also extremely isolationist. Trade is carried out by a few trusted intermediaries, and direct communication between the surface and space is completely outlawed. Most of the facts about the government are only known through extremely careful anthropological research, as it refuses outright to talk to the Cooperative or visitors at all, and only allows the trusted intermediaries to land.

== License ==

This work is licensed under the Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License. To view a copy of this license, visit the Creative Commons' website or send a letter to Creative Commons, 171 Second Street, Suite 300, San Fransisco, California, 94105, USA.

Practically this means that you may rip it apart and use whatever seems useful to you, as long as you credit the original author ("Commander McLane"), and share your work under the same license. It would be nice—although by no means necessary—to give me a note (either on the Oolite BB, or via email), if you intend to use parts of it.

== Version History ==

version 2.10.1 (July 2026)
- Fixed condition script that was preventing Renegade Vipers from spawning.

version 2.10 (July 2026)
- Spelling corrections
- Moved all text into descriptions.plist or missiontext.plist for easier localisation.
- When checking what station the player is at, switched to using station roles.
- Removed extraneous entries in descriptions.plist
- Converted missiontext.plist to OpenStep format.
- Fixed JS error in henchman ship script.
- Hacker Outpost will now spawn without a beacon, and when you find the henchman, the beacon will bee added. This allows for the game to be saved at Hacker Outposts.
- Some scripting has been updated to use the latest Oolite functions.
- File cleanup.

version 2.9.5 (Feb 2026)
- Updated some PNG files to remove invalid colour profile.

version 2.9.4 (July 2020)
- fixed conditions script so ships derived from anarchies-renegade_viper could be spawned.

version‭ ‬2.9.3 (‬March ‬2017)
- fixed semicolon problems in Mac, thanks to hoqllnq.

<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">
version‭ ‬2.9.2‭ (‬December‭ ‬2016‭)
-‎ ‏updated all subentities to use new style
-‎ ‏updated equipment.plist to OpenStep format.
-‎ ‏updated shipdata.plist to OpenStep format.
-‎ ‏changed‭ ‬’background‭’‬ properties of mission screens to‭ ‬’overlay‭’
-‎ ‏added screen ID to all mission screens.
-‎ ‏updated station market scripts to use new style.
-‎ ‏updated equipment conditions to use a condition script.
-‎ ‏updated shipdata.plist to use a condition script.
-‎ ‏fixed incorrect texture reference in‭ ‬"afl-m-dock‭"‬ definition.

version 2.9.1 (November 2016)
- fixed issues with double Behemoths appearing in system
- fixed issues with the amnesty mission not being triggered when docking at the Behemoth
- fixed javascript "undefined" error relating to "bouy-witchspace".

version 2.9 (October 2014)
- converted to OXZ format
- contain the facelift by spara
- you can save in the additional stations, except in the Hacker Outpost which is not stationary

version 2.8 (April 2012)
- fixed a problem that made the amnesty mission unfinishable if the game was saved and reloaded while doing it

version 2.7 (March 2012)
- fixed a problem that could limit other OXPs' (or the main game's) freedom to make the cloaking device repairable

version 2.6 (January 2012)
- moved some more previously overlooked methods to their own name space
- fixed problem of vanishing Sentinel Asteroids with Oolite 1.76
- fixed a small bug where removing the second henchman would give an error message
- Sentinel and Renegade Stations are aligned with the planet again
- Sentinel and Renegade Stations now are behaving like they're supposed to for the first time
- Sentinel Stations now have patrol ships to secure the space lane
- Oolite 1.76 required

version 2.5 (March 2011)
- changed all JS-scripts to strict mode
- moved all self-defined methods into their own namespace
- implemented another idea for coming clean: doing a Navy reserve mission and getting amnesty on completion
- for this to fully work Oolite 1.75.1 is now required

version 2.4 (February 2011)
- Salvage Gangs' hails are now sent via ship script instead AI, giving more timing flexibility
- Salvager Tugger is now part of the Salvage Gang's ship group, therefore it will be defended by the Gang
- two of the tugged ship models included in the OXP
- fixed another bug introduced with the shader bugfix in 2.3
- Cloaking Device no longer buyable in Hacker Outpost by accident, but still repairable
- fixed a nasty bug that removed the player's extra energy unit whenever he bought new equipment
- replaced all instances of pseudo random with scrambledPseudoRandomNumber; this will change the distribution of Salvage Gangs across systems, but not the overall number of them
- cleaning-up of AIs and shipdata
- requires now Oolite 1.75

version 2.3 (November 2009)
- fixed the bugs introduced with the shader bugfix in 2.2 (thanks, Griff!)
- JS: replaced all setOrientation and setPosition, as needed in Oolite 1.73
- JS: changed the handling of defense groups according to the requirements of Oolite 1.73
- requires Oolite 1.73

version 2.2 (July 2009)
- fixed a bug with the Salvage Gang's shaders (thanks, another_commander and Griff!)

version 2.1 (January 2009)
- fixed a bug that would let Salvager Tuggers not appear in version 2.0
- fixed a bug with the Sentinel and Renegade Stations that would cause them to behave strangely when attacked

version 2.0 (January 2009)
- revised the Hacker Outpost model, closing the visible gaps around the tunnel exits
- tunnels in both Hacker Outpost and Salvage Gang replaced with models that use shaders (thanks, Griff!)
- docking bays in both Hacker Outpost and Salvage Gang replaced with Griff's models (ditto!)
- tweaked tugger model a little
- henchmen will no longer give the Hacker Outpost's location to everybody
- simplified the Hacker Outpost spawning
- Salvage Gang now aligning with the planet, and asteroid field spawned via ship script
- fixed a bug that would give the bribe offer too often
- fixed a bug that had replaced all Renegade Stations with Sentinel Stations in 1.1
- fixed a bug that would not initialise some processes if a new commander was started
- player's bounty now reduced 10% per jump if fugitive, instead of a 20 or 10 points
- salvaged equipment is now installed on buying, instead of waiting for launch
- equipment failure chance is now triggered through a timer, instead of a bunch of events; and now uses the new EquipmentInfo object
- there is also a chance now that salvaged equipment will work just fine, removing the failure possibility
- some minor tweaks in this readMe
- JS: replaced player.ship.bounty with player.bounty, which wasn't supported in Oolite 1.72
- JS: replaced all 'let' with 'var'
- requires now Oolite 1.72.1

version 1.1 (November 2008)
- the main script is now completely in JavaScript
- Hacker Outposts are now correctly facing the planet, via their new ship-script (thanks, Eric!)
- as a bonus also their Sentinel Asteroids are finally placed correctly and work (thanks, Eric!)
- added some flashers to the asteroid models
- AIs improved
- Hacker Outposts, Salvage Gangs and Renegade Stations have now their correct commodity prices
- requires Oolite 1.72

version 1.0 (February 2008)
- fully functional version
- requires Oolite 1.65

version 0.1 (March 2007)
- teaser with basic functionality
</div>

== Minimum Requirements ==
Anarchies requires at least Oolite 1.79. I recommend you upgrade to the latest stable release version of Oolite if you haven't yet. The amnesty mission also requires that you have [[Behemoth|Behemoth.oxp]] installed.

== Other related OXPs ==
[[File:IconBGS.png|right]]
=== BGS ===
[[BGS]] enhances this OXP

=== Famous Planets ===
[[Famous Planets]] transmogrifies Sori (a TL9 Dictatorship) into [[Ascension]] - a TL16 Anarchy (Utopian, if not for the pirates!). In vanilla Oolite there are no TL16 systems.

This is particularly relevant for the [[Weapon Laws]] OXP which allows the more lethal weaponry to be sold only in the more piratic systems, where high [[TL]] tends to be quite rare.

== Download Location ==
Download [[Media:Anarchies_2.10.2.oxz‎|Anarchies_2.10.2.oxz‎]] (downloaded {{#downloads:Anarchies_2.10.2.oxz‎}} times).

There is a facelift pack for v2.10 here: [[Media:Anarchies_Facelift.oxz|Anarchies_Facelift.oxz]] (80mb)

[[Media:Anarchies_2.9.5.oxz‎|Anarchies_2.9.5.oxz‎]] (downloaded {{#downloads:Anarchies_2.9.5.oxz‎}} times).

[[Media:Anarchies-2.9.4.oxz‎|Anarchies-2.9.4.oxz‎]] was downloaded {{#downloads:Anarchies-2.9.4.oxz‎}} times.

[[Media:Anarchies_2.9.3.oxz‎|Anarchies_2.9.3.oxz‎]] was downloaded {{#downloads:Anarchies_2.9.3.oxz‎}} times.

[[Media:Anarchies.2.9.oxz‎|Anarchies.2.9.oxz‎]] was downloaded {{#downloads:Anarchies.2.9.oxz‎}} times.

[http://app.box.com/s/491d03d312b3623744e3 Anarchies2.8.oxp] is available for download via box.com.

== Installation ==
The OXZ version is installable within the game from the expansion manager.

Manual way for the OXP version: Unzip the download file. Then move or copy the file Anarchies2.8.oxp from its download folder to your AddOns folder. Restart Oolite. If you have a previous version installed, please remove it first.

== Links ==
There are more related topics, older ones also contain interesting descriptions and screenshots.
*[https://bb.oolite.space/viewtopic.php?f=4&t=11508 Anarchies 2.8] (2012 - date)
*[https://bb.oolite.space/viewtopic.php?f=4&t=14184&p=201322 Anarchies facelift] (2013)
*[https://bb.oolite.space/viewtopic.php?f=4&t=7040&p=93298 Anarchies 2.3] (2009 - 11)
*[https://bb.oolite.space/viewtopic.php?f=4&t=4253&p=46606 Anarchies 1.0] (2008)
*[https://bb.oolite.space/viewtopic.php?f=4&t=3201&p=31763 Anarchies 0.1] (2007)

*[https://bb.oolite.space/viewtopic.php?p=30758#p30758 Original Idea] (2007)
*[[User:Commander McLane‎|Commander McLane‎]]

*[https://bb.oolite.space/viewtopic.php?f=2&t=16509 Anarchy in the Oolite universe] (2014) - arguments for anarchy and that it is "good"...

*Phkb's ideas about an [https://bb.oolite.space/viewtopic.php?f=4&t=21011 Anarchies Overhaul] - pirates capturing the main orbital station! (2021)

[[Category:Oolite]]
{{system-OXP}}

Cataclysm OXP

2026-07-27T00:50:55Z

Phkb:

[[File:Thargoid-attacked-Oolite.png|thumb|right|320px]]
{{QuoteText|Text= punkbohemian wrote: "... would it be possible to design a plot-driven campaign? "

Yes. You can check out Cataclysm, which I consider a great example of a story-like mission set.|Source=([https://bb.oolite.space/viewtopic.php?p=78358#p78358 another_commander (2009)])}}

== Introduction ==

Things aren't looking too good at the Thargoid front. The Thargoids don't confine themselves to intercepting ships in witchspace anymore. Attacks on the space lanes, on main stations, even on planets themselves have become more frequent.

The Galactic Navy has tried to keep on par with the threat. The Behemoth and Leviathan class of capital ships—together with new and capable fighters—have been introduced, new and powerful anti-Thargoid weapons have been developed, Navy Sector Commands are sending battle groups on the space lanes and in interstellar space.

But it seems the Thargoids are always one step ahead. The introduction of the Behemoths saw the advent of new classes of Thargoid Battleships, gigantic Thargoid Carriers have started threatening the GalCop worlds, and the Navy Frigates and their battle groups are now being countered by what seems to be a second wave of completely new Thargoid Ships, together with new and fearsome variants of Thargons.

A while ago the Navy had obtained and—with the help of a certain fearless space commander—securely delivered some secret defense plans of the Thargoid Hive Worlds, and Naval Intelligence was confident that these would give the troops the means for a push against the Thargoid home system. But what has come out of that? Nothing seems to have happened since, no news of a main strike against a Thargoid home world have made it to the public. Or did it all end in a disaster, and this new and unprecedentedly angry wave of Thargoid attacks on GalCop worlds was only triggered by a failed invasion attempt on their space? The [[Tionisla Chronicle Array|Tionisla Chronicle]] does certainly not know.

But now we are on the very brink of new and important developments. The atmosphere is highly charged with anxiety and anticipation, and somehow it is going to discharge violently. Veteran spacefarers can sense a cataclysmic event at the horizon. The future of the Galactic Co-operative of Worlds is at stake. Something has to happen, ... and indeed something has happened.
[[File:Captain Curruthers.png|thumb|right|150px|Captain Curruthers from [[Library OXP|Library]]'s PAD ]]
It all starts when—after a particularly vicious wave of Thargoid attacks in the middle of Galaxy 1—a well known officer of Her Imperial Majesty's Space Navy contacts a certain fearless space commander, and asks for help. [[Captain Curruthers|Mission One - FAQ]] has made a rapid career and become Rear Admiral since the Constrictor incident, and he hasn't forgotten who got him out of the trouble with the stolen prototype. Nor have Captain Fortesque and Agent Blake — their unaltered ranks perhaps indicating that the Thargoid Plans plan didn't turn out as a huge success. But this new thing has all the prospect to become one...

== Technical Overview ==

Cataclysm.oxp is a mission OXP that takes up the threads of the native Constrictor Hunt and Thargoid Plans missions, and sends you on a mission far bigger than anything you have done for the Navy so far. It gives you the opportunity to re-visit places you have visited before, and re-meet people you had contact with during these missions. And of course it will let you meet various other people, and lead you to a lot of new places, some of which you probably haven't visited before.

The mission starts in the middle of Galaxy 1, roughly in the area where the first part of the Constrictor Hunt took place. After a ruthless Thargoid attack on a main station, during which you once again excelled in the defense force, it is time for Rear Admiral Curruthers to contact you with an important news. (If you don't excel, you won't be contacted unless you excel.) From there on you are in the service of Her Imperial Majesty's Space Navy again, and soon find yourself on a quest that will lead you through most parts of the known Ooniverse. What are you going to find in the end? Only %R knows!
{{OXPLevel|5|6}}
The mission requires an able commander with an equally able ship. Therefore it is not suited for a beginner. Anyway, you will have to have finished both the Constrictor Hunt and the Thargoid Plans missions, and be in Galaxy 1 in order to get Cataclysm started, which means that you have to have cycled the eight galaxies at least once before you are offered this mission. So you will probably have been ☆ Deadly ☆ for quite a while before the events depicted here start to unfold. The OXP requires you to be 'twice deadly'—having at least 5120 kills—to get started. At the end of it you may well have come close to ★★★ E L I T E ★★★ ...

[[Image:IconLib.png|48px|right|link=Library OXP|alt=Uses Library's P.A.D.]]
== Minimum Requirements ==

Cataclysm.oxp requires at least Oolite v.1.72.1.

The [[OXP]] doesn't require any other OXP for running; however your experience will get more varied, more exciting, and probably more difficult as well, if you play with some other OXPs installed (most of those mentioned in the introduction):

* [[Thargorn Threat]] and [[Second Wave]] will give you a greater variety of Thargoid ships involved in the action.

If you play with [[Thargoid Wars]] installed, the beginning of Cataclysm.oxp will blend naturally into the scenario you are used to from that OXP.

* [[Behemoth]] and [[Military Fiasco]] will at some points add valuable reinforcements on your side.

* [[Missiles and Bombs]] will give you a greater choice of weaponry.

* [[Asteroid Storm]] will give you a greater variety in asteroid fields.

* [[Galactic Navy]] will not be used in any specific way by this OXP, but may add to the atmosphere of being at war with the Thargoids. (Although there seems to be a strange bug in Oolite 1.72.1 that may lead to ships from Cataclysm not being created when Galactic Navy is installed as well; see below.)

* [[Thargoid Carrier]] will also not interact specifically with this OXP, but may add to the atmosphere as well.

* [[Stations for Extra Planets]] will give you many more stations that look like the added stations in this OXP, thereby unifying the design.

* [[Additional Planets]] will just enhance the scenery. (If you usually play with Additional Planets, you will perhaps notice changes in a couple of systems. This is because the additional planets and moons have been partially disabled by this OXP, in order to prevent possible location clashes.)

== Known Problems (Version 1.1) ==
Due to a not-yet-fully-understood bug in either Oolite or some OXPs there are some OXPs that will prevent other scripts from creating additional ships with role 'police'. Cataclysm wants to create a couple of those ships at one point in the story. However, the police ships are not a story necessity. The two OXPs that caused this behaviour on McLane's own system are [[Commies]] and [[Galactic Navy]]. He hoped that the developers would find and eliminate the problem.

== License ==
*Author: Commander McLane
*License: CC BY-NC-SA 3.0
*Version: 2.6
*Requires: Oolite v.1.90

== Download Location ==
You can download v2.6 from the Download Manager, or here: [[Media:Cataclysm_2.6.oxz|Cataclysm_2.6.oxz]]

===Previous Versions===
It worked in 2009 (v.1.74?), it was broken by 2011 (v.1.76).
[http://app.box.com/shared/jnoh7v2lik Cataclysm1.1] is available for download through box.com.
Move or copy the file Cataclysm.oxp from the main folder to the AddOns folder inside the Oolite main folder. Restart Oolite.

== Links ==
*[https://bb.oolite.space/viewtopic.php?f=4&t=21458 Cataclysm 2.0 BB Thread] (2023)
*[https://bb.oolite.space/viewtopic.php?f=4&t=5534 '''Cataclysm.oxp''' (1.1) now available] BB thread (2009-14).
*[[User:Commander McLane|Commander McLane]] (author)
*[https://bb.oolite.space/viewtopic.php?p=145551#p145551 Commander McLane] on not updating Cataclysm (2011)
*[https://bb.oolite.space/viewtopic.php?t=6893 Stuck in Cataclysm] (2009) - Problems in Galaxy 6 with the trail going cold
*For older versions of Oolite: see [[Oolite]] (Downloading Earlier versions)

{{mission-OXP}}

Wireframe Ship Images

2026-07-27T00:50:21Z

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.13)

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

==Version History==
1.13
* Added various items from Xeptatl's Sword.
* Fixed size of a couple of ship images.
* Added correct image for the Cloaking device.

1.12
* Added ships from PT BVRM.

1.11
* Added ships from Small Ships OXP.
* Added ships from Defense 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.13
|release = 2026-07-27
|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:Library 1.10.5.oxz

2026-07-27T00:47:25Z

Phkb:

File:HyperRadio 2.1.oxz

2026-07-27T00:46:54Z

Phkb:

File:TestShipModel.oxz

2026-07-27T00:46:41Z

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

File:RemoveIndividualPylon 1.1.oxz

2026-07-27T00:46:06Z

Phkb:

File:LoadoutByCategory.oxz

2026-07-27T00:45:57Z

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

File:LoadoutByCategory 190.oxz

2026-07-27T00:45:45Z

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

File:WireframeShipImages.oxz

2026-07-27T00:45:20Z

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

File:VimanaX HUD 1.28.oxz

2026-07-27T00:42:52Z

Phkb: