Skip to content

Star System Schema

Schema Type: JSON Type: object

Configuration for a specific star system

freeMapAngle

Type: boolean

In this system should the player be able to rotate their map camera freely or be stuck above the plane of the solar system?


returnToSolarSystemWhenTooFar

Type: boolean

When well past the furthest orbit, should the player be summoned back to the star?


farClipPlaneOverride

Type: number

An override value for the far clip plane. Allows you to see farther.


canEnterViaWarpDrive

Type: boolean Default: true

Whether this system can be warped to via the warp drive. If you set factRequiredForWarp, this will be true.


destroyStockPlanets

Type: boolean Default: true

Do you want a clean slate for this star system? Or will it be a modified version of the original.


enableTimeLoop

Type: boolean Default: true

Should the time loop be enabled in this system?


factRequiredForWarp

Type: string

The FactID that must be revealed before it can be warped to. Don't set `canEnterViaWarpDrive` to `false` if
you're using this, because it will be overwritten.


loopDuration

Type: number Default: 22

The duration of the time loop in minutes. This is the time the sun explodes. End Times plays 85 seconds before this time, and your memories get sent back about 40 seconds after this time.


mapRestricted

Type: boolean

Should the player not be able to view the map in this system?


Skybox

Type: SkyboxModule

Customize the skybox for this system

See Definitions/SkyboxModule

startHere

Type: boolean

Set to `true` if you want to spawn here after dying, not Timber Hearth. You can still warp back to the main star system.


respawnHere

Type: boolean

Set to `true` if you want the player to stay in this star system if they die in it.


travelAudio

Type: string

The audio that will play when travelling in space. Can be a path to a .wav/.ogg/.mp3 file, or taken from the AudioClip list.


Vessel

Type: VesselModule

Configure warping to this system with the vessel

See Definitions/VesselModule

entryPositions

Type: array

Manually layout ship log entries in detective mode

Items

Type: EntryPositionInfo

No Description Found

See Definitions/EntryPositionInfo

initialReveal

Type: array

A list of fact IDs to reveal when the game starts.

Items

Type: string

No Description Found


shipLogStartingPlanetID

Type: string

The planet to focus on when entering the ship log for the first time in a loop. If not set this will be the planet at navtigation position (1, 0)


curiosities

Type: array

List colors of curiosity entries

Items

Type: CuriosityColorInfo

No Description Found

See Definitions/CuriosityColorInfo

extras

Type: object

Extra data that may be used by extension mods


$schema

Type: string

The schema to validate with