Cholmondely: Tweaks.

2026-09-30T15:15:56Z

Tweaks.

Cholmondely: Page created

2026-09-30T14:53:25Z

Page created

New page

The CB-HUD Mark IV is a fully featured HUD requiring no other OXPs.
[[File:Cb68-CB-HUD-Mark-IV.jpg|right|900px]]
==Overview==
The CB-HUD Mark IV is developed and produced by the [[Crab Boolean Corporation|Crab-Boolean Corporation]] located on [[Sector1/Riredi|Riredi]] in galaxy 1.

=== Features ===
Compact flight instruments, adaptive energy divisions, absolute shield percentages, speed/altitude/cabin/weapon-temperature readouts, fuel and jump destination, basic/advanced compass and native joystick sensitivity indicator.

Equipment indicators cover docking computer, escape pod, ECM and injectors.

Master alert and rotating Alerts cover equipment damage, maintenance, contraband and legal warnings. Cargo and relevant station information remain visible docked; missile pylons remain visible there even with weapons offline.

Four warning rows left of the crosshair show incoming missiles, forward/aft shield warnings and low/critical energy. Lamps blink; text stays steady.

Four target rows on the right show unique name (if available), type/legal state, distance with Closing/Opening/Steady, and Condition: Good, Weak or Crit.

Both blocks use 10x10 text with a fixed edge facing the crosshair.

*10 [[MFD]]s
*[[HUD Selector]] compliant
*The layout is designed for 16:10; other aspect ratios may leave less room for side MFDs.

=== Warning thresholds ===
*Own shield percentages always use 128 energy points as 100%, regardless of shield upgrades. Weak below 40%, clears at 50%; down at zero, back to weak at 10%.
*Own energy: low below 25%, clears at 30%; critical below 15%, back to low at 20%.
*Target condition uses that target's maximum: Weak below 40%, Good at 45%;
*Crit below 15%, back to Weak at 20%. Target condition is energy, not OXP shields.

=== Docking light (D) ===
:Orange: no known clearance.
::Blinking orange: requested, waiting.
:Green: clearance granted or this station explicitly requires none.
::Blinking green: clearance expires soon. The white D and outline stay steady.

The selected station takes priority. Selecting another station does not inherit the first station's clearance. With no station selected, an active request is retained; otherwise the main station is used while within its [[aegis]].

Green is about clearance, not collision avoidance, traffic or dock size.

=== Optional OXP support ===
*[[HUDSelector]], Smivs' [[Extra Fuel Tanks]] and [[Shield Equalizer And Capacitors OXP]] are optional.
*[[CombatMFD]] is ''not'' required; its data sources and other OXP scripts are untouched.
*[[Shield Cycler]] 1.12 and Shield Cycler Next 2.1/2.1.1 can show their live mode: the upper former Equalized label says Cycler mode:, the lower shows the mode. "Disabled" is shown when switched off. Reduced functionality can still operate.
:Only install one Cycler branch. Unknown versions/data omit the mode display. The adapter reads the internal state defensively; it never controls shield transfer.

==Minimum requirements==
*Oolite 1.86+
*[[HUD Selector]] compliant

=== Monitor Resolution ===
This HUD works best 16:10. Other resolutions work, but little space may be left for left and right MFD´s.

==Installation==
Place CB-HUD-Mark-IV-1.0.0.oxz in the normal Oolite AddOns location. Keep only one Mark-IV version active. Mark III may remain installed. Select Mark IV through HUDSelector if it is installed. Without HUDSelector, Mark IV activates automatically. The original Mark III uses the Default HUD entry rather than a separate named entry; another default-HUD replacement can affect that selection. Reload Oolite's configuration (rebuild its cache when necessary). This package does not install itself.
=== Compatibility and Testing ===
Automated tests cover warning thresholds, docking state, text configuration, optional integrations and HUD lifecycle. Standalone startup, HUD selection,
selection preservation and ship purchase were checked in a simulated Oolite JavaScript environment, also using the unmodified HUDSelector 1.28 package's script. These checks supplement in-game testing; they do not emulate rendering.

The minimum Oolite version 1.86 is based on a native source/API audit. In-game 1.86 testing and in-game Shield Cycler testing have not been performed. Standard incoming missile events/scan class are supported; unusual script-only missile behaviour may differ.

== Download ==
=== Current version ===
* Version 1.0 [https://app.box.com/s/0fxma53oqutfkjli7zq25kf8hno6gicz oolite.oxp.captain_beatnik.CB-HUD_mark_iv.oxz]

== License ==
*License: CC-BY-NC-SA 4.0
=== Attribution and Thanks ===
CB-HUD Mark IV by Captain Beatnik is derived from CB-HUD Mark III and the original configuration files supplied with Oolite.

Many thanks to Giles C Williams (aegidian) and all contributors for developing Oolite.

Thanks to Mazur, Thargoid, Killer Wolf, JeffBTX, Wyvern, Smivs and CommonSenseOTB.
I learned a great deal by studying their work.

Special thanks to Norby, Phkb, Cag and Neelix. Their work made the additional functions of this HUD possible.

Finally, many thanks to Cholmondely and Maik for their work on the wiki and documentation.

These acknowledgements are also retained in Config/cb68_cbhudIV_main.plist.

=== Development Assistance ===
OpenAI Codex, an AI coding assistant, assisted with JavaScript, configuration, code review and documentation. The HUD concept, design decisions and in-game testing are by Captain Beatnik.

== The [[Dark Side]] ==
=== Text Customisation ===
All own visible text, units and templates are in the Config folder's [[Descriptions.plist]].

Edit quoted values while retaining the namespaced keys and placeholders needed.

Empty strings and leading/trailing spaces are valid; blanking text does not disable warnings, lamps or equipment. Longer translations need visual testing.

Target text has a width limit; type shortening preserves the default bounty Cr suffix. Dock system/station names share a 36-character budget including dots.

=== How the HUD is built ===
The HUD needs no additional image files or textures. Its layout, instruments, scale marks and crosshairs are defined through JavaScript and the .plist configuration, using Oolite's built-in drawing functions and font. No Images or Textures folder is included in the package.

Config/cb68_cbhudIV_main.plist has no legends section. All Mark-IV-defined labels and readouts use <tt>drawCustomText</tt>: dials, with their text supplied from Config/descriptions.plist through the script. Native displays such as the clock and equipment carousel continue to draw their own text.

Oolite draws legends before dials, then processes the dials in their listed order. Placing custom text and scale elements later in that list lets them appear in front of the filled instrument bars. A legend cannot provide that foreground layer over a dial. Scale lines are drawn as narrow custom bars, not as images.

The left-hand shield, energy and weapon-temperature bars fill from right to left. This uses a negative width in the relevant dial definition, for example
<tt>width = -98;</tt> for the shield bars. The magnitude specifies the bar width and the negative sign reverses its fill direction. Optional capacitor bars use the same technique. This makes the left and right instrument groups visually mirror one another without needing separate artwork.

== Links ==
*Author: [[User:Captain Beatnik|Captain Beatnik]] (page has links to his other HUDs)
*[https://bb.oolite.space/viewtopic.php?p=307272#p307272 BB Release Note for Mark IV] (2026)
:Feedback is always welcome if something doesn't work or where something could or should be improved or done differently.
*[[CB-HUD Mark III]] (2025-6) previous version!
*[[CB-HUD Mark II]] (2011) popular precursor (includes notes on CB-HUD Mark I).
*[[HUD]]
*[[hud.plist]]

{{HUD-OXP}}

@@ Line 1: / Line 1: @@
-The CB-HUD Mark IV is a fully featured HUD requiring no other OXPs.
+A clean, balanced HUD featuring detailed flight instruments, equipment indicators, combat warnings and compact target information. It requires no other OXPs.
 [[File:Cb68-CB-HUD-Mark-IV.jpg|right|900px]]
 ==Overview==
@@ Line 5: / Line 5: @@
 === Features ===
 Compact flight instruments, adaptive energy divisions, absolute shield percentages, speed/altitude/cabin/weapon-temperature readouts, fuel and jump destination, basic/advanced compass and native joystick sensitivity indicator.
@@ Line 82: / Line 84: @@
 == The [[Dark Side]] ==
 === Text Customisation ===
 All own visible text, units and templates are in the Config folder's [[Descriptions.plist]].

CB-HUD Mark IV - Revision history

Cholmondely: Tweaks.

Cholmondely: Page created