Operations manual
Star system build specification
Sample specification
YAML 2-space indentation
Reference

The build specification is YAML. Use 2-space indentation. Unknown keys are rejected. This schema is used when creating a single star system via build configuration mode.

Top-level properties

name
Optional name for the star system.
primary
Optional star definition for the primary star. See star definition below.
surveyIndex
Survey index (0–12). Controls the level of detail generated for orbital bodies.
allegiance
Allegiance code for the system. See allegiances.
bases
Array of base facility codes present in the system. See bases.
known
Boolean. When true, marks the system as a known/charted system.
counts
Optional orbital body counts. See counts definition below.
populated
Optional population constraints used by the generator. See populated definition below.

Star definition

type (required)
Spectral type in the form OBAFGKM + 0..9, for example G2.

Special types

  • BD – Brown Dwarf
  • D – White Dwarf
  • BH – Black Hole
  • PSR – Pulsar
  • NS – Neutron Star

Special types do not require a class.

class (conditionally required)
Luminosity class. Required unless type is a special type.

Options

  • Ia – Luminous supergiant
  • Ib – Less luminous supergiant
  • II – Bright giant
  • III – Giant
  • IV – Subgiant
  • V – Main sequence
  • VI – Subdwarf
  • giant – Gas giant star
companion
Optional companion star (another star definition).
close
Optional star in close orbit (another star definition). See World Builder's Handbook, page 27 for the orbit ranges.
near
Optional star in near orbit (another star definition). See World Builder's Handbook, page 27 for the orbit ranges.
far
Optional star in far orbit (another star definition). See World Builder's Handbook, page 27 for the orbit ranges.
bodies
Optional list of orbital bodies for this star. See orbital bodies below.

Counts definition

density
Orbital body density modifier (0–30). When specified, the generator determines the number of terrestrial planets, planetoid belts, and gas giants automatically. Rules on density can be found in Book 3 – Referee's Handbook.
terrestrialPlanets
Explicit count of terrestrial planets (0–20).
planetoidBelts
Explicit count of planetoid belts (0–20).
gasGiants
Explicit count of gas giants (0–20).
mainWorld
Optional main world definition. See orbital bodies for structure.

Requirements

Counts must specify either density alone, or all three of terrestrialPlanets, planetoidBelts, and gasGiants. The mainWorld field is optional in both cases.

Orbital bodies

uwp (required)
UWP code (e.g. X674000-0), a known label (terrestrial, small gas giant, gas giant, large gas giant, super earth), or empty (uwp: 'empty') to indicate no orbital body at that position.
orbit
Optional orbit placement label. Must be one of inner, warm, hzco, cold, outer, or habitable. Only one body per star may specify an orbit label.
name
Optional name for the orbital body.
mainWorld
Boolean. When true, designates this body as the main world.

Populated definition

type (required)
Layout preset for how populated worlds are distributed.

Options

  • full
  • hard-horizontal
  • hard-vertical
  • split-horizontal
  • split-vertical
allegiance (required)
Default allegiance code. See allegiances.
minTechLevel, maxTechLevel
Constraints for generated tech level (0–100).
minPopulationCode, maxPopulationCode
Constraints for generated population code (0–16).
REFERENCE 0422RD