Skip to content

Celestial Body Schema

Schema Type: JSON Type: object

Describes a celestial body to generate

name

Type: string

Unique name of your planet. If not specified, the file name (without the extension) is used.


starSystem

Type: string Default: SolarSystem

Unique star system containing your planet. If you set this to be a custom solar system remember to add a Spawn module to one of the bodies, or else you can't get to the system.


isQuantumState

Type: boolean

Does this config describe a quantum state of a custom planet defined in another file?


isStellarRemnant

Type: boolean

Does this config describe a stellar remnant of a custom star defined in another file?


canShowOnTitle

Type: boolean Default: true

Should this planet ever be shown on the title screen?


destroy

Type: boolean

`true` if you want to delete this planet


trackForSolarSystemRadius

Type: boolean Default: true

Do we track the position of this body when calculating the solar system radius?
`true` if you want the map zoom speed, map panning distance/speed, map camera farclip plane,
and autopilot-returning-to-solar-system to adjust to this planet's orbit


removeChildren

Type: array

A list of paths to child GameObjects to destroy on this planet

Items

Type: string

No Description Found


AmbientLights

Type: array

Add ambient lights to this body

Items

Type: AmbientLightModule

No Description Found

See Definitions/AmbientLightModule

AsteroidBelt

Type: AsteroidBeltModule

Generate asteroids around this body

See Definitions/AsteroidBeltModule

Atmosphere

Type: AtmosphereModule

Describes this Body's atmosphere

See Definitions/AtmosphereModule

Base

Type: BaseModule

Base Properties of this Body

See Definitions/BaseModule

Bramble

Type: BrambleModule

Add bramble nodes to this planet and/or make this planet a bramble dimension

See Definitions/BrambleModule

Cloak

Type: CloakModule

Add a cloaking field to this planet

See Definitions/CloakModule

Dream

Type: DreamModule

Make this planet part of the dream world

See Definitions/DreamModule

FocalPoint

Type: FocalPointModule

Make this body into a focal point (barycenter)

See Definitions/FocalPointModule

Funnel

Type: FunnelModule

Add funnel from this planet to another

See Definitions/FunnelModule

HeightMap

Type: HeightMapModule

Generate the surface of this planet using a heightmap

See Definitions/HeightMapModule

Lava

Type: LavaModule

Add lava to this planet

See Definitions/LavaModule

MapMarker

Type: MapMarkerModule

Map marker properties of this body

See Definitions/MapMarkerModule

Orbit

Type: OrbitModule

Describes this Body's orbit (or lack there of)

See Definitions/OrbitModule

ProcGen

Type: ProcGenModule

Procedural Generation

See Definitions/ProcGenModule

Props

Type: PropModule

Spawn various objects on this body

See Definitions/PropModule

ReferenceFrame

Type: ReferenceFrameModule

Reference frame properties of this body

See Definitions/ReferenceFrameModule

Rings

Type: array

Create rings around the planet

Items

Type: RingModule

No Description Found

See Definitions/RingModule

Sand

Type: SandModule

Add sand to this planet

See Definitions/SandModule

ShipLog

Type: ShipLogModule

Add ship log entries to this planet and describe how it looks in map mode

See Definitions/ShipLogModule

ShockEffect

Type: ShockEffectModule

Settings for shock effect on planet when the nearest star goes supernova

See Definitions/ShockEffectModule

Spawn

Type: SpawnModule

Spawn the player at this planet

See Definitions/SpawnModule

Star

Type: StarModule

Make this body a star

See Definitions/StarModule

Water

Type: WaterModule

Add water to this planet

See Definitions/WaterModule

ParticleFields

Type: array

Add particle effects in a field around the planet.
Also known as Vection Fields.

Items

Type: ParticleFieldModule

No Description Found

See Definitions/ParticleFieldModule

Volumes

Type: VolumesModule

Add various volumes on this body

See Definitions/VolumesModule

CometTail

Type: CometTailModule

Add a comet tail to this body, like the Interloper

See Definitions/CometTailModule

extras

Type: object

Extra data that may be used by extension mods


$schema

Type: string

The schema to validate with