Modding:Celestial.config

From Starbounder - Starbound Wiki
Jump to: navigation, search

Celestial.config defines parameters for generating the map of star systems and planets. It is contained in the root Data:Assets directory.

Key Value Pairs

Key Value Type Value Subtype Description Valid Values
chunkSize Number
chunkCacheSize Number
maxSystemChunkSearches Number
maxWorldSearches Number
xySearchCoordRange Array Number Array Length 2
zCoordRange Array
numCoordHashes Number
systemProbability Number
orbitalLevels Number
constellationProbability Number
constellationLineCountRange Array Number Array Length 2
constellationMaxTries Number
minimumConstellationLineLength Number
maximumConstellationLineLength Number
minimumConstellationMagnitude Number
minimumConstellationLineCloseness Number
radialSlots Number
twinkleFrames Number
twinkleScale Number
skyBrightnessBase Number
maxRecentlyVisitedSystems Number Number of systems stored as recently visited. The star map connects these with dashed lines.
sectors Array Sector Array of sectors available.
planetHorizons Object Planet Horizons Object containing locations of images for rendering the horizon of the current planet while in the player's ship.
systemTypes Object System Types Object containing the types of star systems. Star systems can be added to create new types of systems.
planetaryTypes Object Planetary Types Object containing the types of planets. Planets can be added to create new types of planets
satelliteTypes Object Satellite Types Object containing the types of satellites of planets. Satellite can be added to create new types of satellites

planetHorizons

Object containing locations of images for rendering the horizon of the current planet while in the player's ship.

Key Value Pairs

Key Value Type Value Subtype Description Valid Values
biomeTextures String Path to biome-specific images
atmosphereTextures String Path to horizon glow image
shadowTextures String Path to shadow image
maskTextures String Path to continent mask images
liquidTextures String Path to liquid layer images
maskRange Array Number Range of integers to fill into the <selector> keyword for continent masks Array Length 2
maskPerPlanetRange Array Number Array Length 2

Example

 "planetHorizons" : {
   "biomeTextures" : "/celestial/system/horizon/textures/<biome>_<selector>.png",
   "atmosphereTextures" : "/celestial/system/horizon/atmosphere/atmosphere_<selector>.png",
   "shadowTextures" : "/celestial/system/horizon/shadow/shadow_<selector>.png",
   "maskTextures" : "/celestial/system/horizon/masks/<mask>_<selector>.png",
   "liquidTextures" : "/celestial/system/horizon/liquids/<liquid>_<selector>.png",
   "maskRange" : [0, 40],
   "maskPerPlanetRange" : [1, 3]
 },

systemTypes

Object containing the types systems. New System Type Objects can be added to create new types of systems. This Key Value pairs in this object take the form of: "system_id": <System Type Object>. For this reason, there is no fixed set of valid key value pairs, there can be any number of satellite objects.

Example

 "systemTypes" : {
   "SystemA" : {
     ... <System Type Object> ...
   },
   "SystemB" : {
     ... <System Type Object> ...
   },
   "SystemC" : {
     ... <System Type Object> ...
   }
 }

planetaryTypes

Object containing the types planets. New Planet Type Objects can be added to create new types of planets. This Key Value pairs in this object take the form of: "planet_id": <Planet Type Object>. For this reason, there is no fixed set of valid key value pairs, there can be any number of satellite objects.

Example

 "planetTypes" : {
   "PlanetA" : {
     ... <Planet Type Object> ...
   },
   "PlanetB" : {
     ... <Planet Type Object> ...
   },
   "PlanetC" : {
     ... <Planet Type Object> ...
   }
 }

satelliteTypes

Object containing the types of satellites of planets. New Satellite Type Objects can be added to create new types of satellites. This Key Value pairs in this object take the form of: "satellite_id": <Satellite Type Object>. For this reason, there is no fixed set of valid key value pairs, there can be any number of satellite objects.

Example

 "satelliteTypes" : {
   "SatelliteA" : {
     ... <Satellite Type Object> ...
   },
   "SatelliteB" : {
     ... <Satellite Type Object> ...
   },
   "SatelliteC" : {
     ... <Satellite Type Object> ...
   }
 }