Modding:SystemType (JSONObject)

From Starbounder - Starbound Wiki
Jump to: navigation, search

Quick Navigation


Planet Types define new types of planets that can occur in star systems. They are defined as part of the Planet Types Object in Celestial.config.

Key Value Pairs

Key Value Type Value Subtype Description Valid Values
selectionWeight Number Probability of spawning compared to other systemTypes.
planetaryBodyProbability Number Probability of planets spawning in the system. [0, 1]
baseParameters Object Base Parameters Object that defines in game details of the planet
variationParameters Array Variation Parameters Parameters to vary the size of the planet
orbitRegions Array Orbit Region Regions around the system that define parameters such as temperature

Example

 "Foo" : {
   "selectionWeight" : 2.0,
   "planetaryBodyProbability" : 0.2,
   "baseParameters" : {
     "image" : "/celestial/system/red_sun.png",
     "twinkleTime" : [0.5, 1.5]
   },
   "variationParameters" : [
     {
       "magnitude" : 1,
       "description" : "Red Subdwarf",
       "imageScale" : 0.12,
       "twinkleFrames" : "/celestial/stars/star5pxRed.png",
       "twinkleBackground" : "/celestial/stars/backgrounds/star5px.png",
       "brightness" : [1, 1],
       "temperature" : [6500, 6500]
     },
     {
       "magnitude" : 2,
       "description" : "Red Dwarf",
       "imageScale" : 0.16,
       "twinkleFrames" : "/celestial/stars/star7pxRed.png",
       "twinkleBackground" : "/celestial/stars/backgrounds/star7px.png",
       "brightness" : [1, 1],
       "temperature" : [6500, 6500]
     },
     {
       "magnitude" : 3,
       "description" : "Large Red Dwarf",
       "imageScale" : 0.20,
       "twinkleFrames" : "/celestial/stars/star11pxRed.png",
       "twinkleBackground" : "/celestial/stars/backgrounds/star11px.png",
       "brightness" : [1, 1],
       "temperature" : [6500, 6500]
     }
   ],
   "orbitRegions" : [
     [ [1, 2], "Mild" ],
     [ [3, 12], "Cold" ]
   ]
 }

baseParameters

Key Value Pairs

Key Value Type Value Subtype Description Valid Values
image String Path to the image for rendering the central body in the star map.
twinkleTime Array Number

variationParameters

Key Value Pairs

Key Value Type Value Subtype Description Valid Values
magnitude Number Relative size of the variation.
description String Human readable description of the variation.
imageScale Number Scaling applied to the base image in [[Modding:#baseParameters|baseParameters]].
twinkleFrames String
twinkleBackground String
brightness Array Number
temperature Array Number

orbitRegion

Orbit Regions are defined as an array. The order of the elements matters

Array Elements

Index Value Type Value Subtype Description Valid Values
0 Array Number
1 String Temperature ID used by Planet Orbit Parameters and Satellite Orbit Parameters