Gittes-archive/new-horizons
2
0
Fork 0
mirror of https://github.com/Outer-Wilds-New-Horizons/new-horizons.git synced 2025-12-11 20:15:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update schema.json

Browse Source
This commit is contained in:
Nick 2022-03-03 22:37:07 -05:00
parent 68b9404db9
commit 80ca144793
1 changed files with 165 additions and 147 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

206
NewHorizons/schema.json
View File

@ -47,8 +47,7 @@
"colorPart": { "colorPart": {
"type": "integer", "type": "integer",
"default": 0, "default": 0,
"minimum": 0, "minimum": 0
"maximum": 255
}, },
"color": { "color": {
"type": "object", "type": "object",
@ -131,11 +130,13 @@
"properties": { "properties": {
"hasMapMarker": { "hasMapMarker": {
"type": "boolean", "type": "boolean",
"default": false "default": false,
"description" : "If the body should have a marker on the map screen."
}, },
"hasAmbientLight": { "hasAmbientLight": {
"type": "boolean", "type": "boolean",
"default": false "default": false,
"description" : "If the dark side of the body should have some slight ammount of light"
}, },
"surfaceGravity": { "surfaceGravity": {
"type": "number", "type": "number",
@ -148,12 +149,13 @@
"linear", "linear",
"inverseSquared" "inverseSquared"
], ],
"default": "linear" "default": "linear",
"description" : "How gravity falls off with distance. Most planets use linear but the sun and some moons use inverseSquared."
}, },
"surfaceSize": { "surfaceSize": {
"type": "number", "type": "number",
"default": 100, "default": 100,
"description": "A scale height used for a number of things." "description": "A scale height used for a number of things. Should be the approximate radius of the body."
}, },
"sphereOfInfluence": { "sphereOfInfluence": {
"type": "number", "type": "number",
@ -167,7 +169,8 @@
}, },
"hasCometTail": { "hasCometTail": {
"type": "boolean", "type": "boolean",
"default": false "default": false,
"description" : "If you want the body to have a tail like the Interloper."
}, },
"hasReferenceFrame": { "hasReferenceFrame": {
"type": "boolean", "type": "boolean",
@ -195,42 +198,44 @@
"description": "Scale height of the atmosphere" "description": "Scale height of the atmosphere"
}, },
"cloudTint": { "cloudTint": {
"$ref": "#/$defs/color" "$ref": "#/$defs/color",
"description" : "Colour of the cloud layer. Only relevant if \"cloud\" has a value"
}, },
"cloud": { "cloud": {
"type": "string", "type": "string",
"description": "Relative filepath to the cloud texture, if the planet has clouds. Optional." "description": "Relative filepath to the cloud texture, if the planet has clouds."
}, },
"cloudCap": { "cloudCap": {
"type": "string", "type": "string",
"description": "Relative filepath to the cloud cap texture, if the planet has clouds. Optional." "description": "Relative filepath to the cloud cap texture, if the planet has clouds."
}, },
"cloudRamp": { "cloudRamp": {
"type": "string", "type": "string",
"description": "Relative filepath to the cloud ramp texture, if the planet has clouds. Optional." "description": "Relative filepath to the cloud ramp texture, if the planet has clouds. If you don't put anything here it will be auto-generated."
}, },
"useBasicCloudShader": { "useBasicCloudShader": {
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Use Giant's deep shader or just apply the cloud texture as is." "description": "Set to false to use Giant's deep shader. Set to true to just apply the cloud texture as is."
}, },
"shadowsOnClouds": { "shadowsOnClouds": {
"type": "boolean", "type": "boolean",
"default": true, "default": true,
"description": "If the top layer should have shadows" "description": "If the top layer should have shadows. Set to false if you're making a brown dwarf."
}, },
"fogTint": { "fogTint": {
"$ref": "#/$defs/color", "$ref": "#/$defs/color",
"description": "Colour of fog on the planet." "description": "Colour of fog on the planet, if you put fog."
}, },
"fogDensity": { "fogDensity": {
"type": "number", "type": "number",
"minimum": 0, "minimum": 0,
"maximum": 1 "maximum": 1,
"description" : "How dense the fog is, if you put fog."
}, },
"fogSize": { "fogSize": {
"type": "number", "type": "number",
"description": "Radius of fog sphere, independent of the atmosphere", "description": "Radius of fog sphere, independent of the atmosphere. This has to be set for there to be fog.",
"minimum": 0 "minimum": 0
}, },
"hasRain": { "hasRain": {
@ -243,12 +248,13 @@
}, },
"hasOxygen": { "hasOxygen": {
"type": "boolean", "type": "boolean",
"default": false "default": false,
"description" : "Lets you survive on the planet without a suit."
}, },
"hasAtmosphere": { "hasAtmosphere": {
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Whether we use an atmospheric shader on the planet." "description": "Whether we use an atmospheric shader on the planet. Doesn't affect clouds, fog, rain, snow, oxygen, etc. Purely visual."
}, },
"atmosphereTint": { "atmosphereTint": {
"$ref": "#/$defs/color", "$ref": "#/$defs/color",
@ -263,7 +269,7 @@
"type": "integer", "type": "integer",
"default": 5000, "default": 5000,
"minimum": 0, "minimum": 0,
"description": "The average distance between the planet and its primary body." "description": "The semi-major axis of the ellipse that is the body's orbit. For a circular orbit this is the radius."
}, },
"inclination": { "inclination": {
"$ref": "#/$defs/angle", "$ref": "#/$defs/angle",
@ -276,38 +282,45 @@
}, },
"isMoon": { "isMoon": {
"type": "boolean", "type": "boolean",
"description": "Is this the moon of a planet?" "description": "Is this the moon of a planet? Used for determining when its name is shown on the map."
}, },
"longitudeOfAscendingNode": { "longitudeOfAscendingNode": {
"type": "number", "$ref": "#/$defs/angle",
"default": 0 "description" : "An angle (in degrees) defining the point where the orbit of the body rises above the orbital plane if it has nonzero inclination."
}, },
"eccentricity": { "eccentricity": {
"type": "number", "type": "number",
"default": 0, "default": 0,
"minimum": 0, "minimum": 0,
"maximum": 0.99 "maximum": 0.99999,
"description" : "At 0 the orbit is a circle. The closer to 1 it is, the more oval-shaped the orbit is."
}, },
"argumentOfPeriapsis": { "argumentOfPeriapsis": {
"$ref": "#/$defs/angle" "$ref": "#/$defs/angle",
"description" : "An angle (in degrees) defining the location of the periapsis (closest distance to it's primary body) if it has nonzero eccentricity."
}, },
"trueAnomaly": { "trueAnomaly": {
"$ref": "#/$defs/angle" "$ref": "#/$defs/angle",
"description" : "Where the planet should start off in its orbit in terms of the central angle."
}, },
"axialTilt": { "axialTilt": {
"$ref": "#/$defs/angle" "$ref": "#/$defs/angle",
"description" : "The angle between the normal to the orbital plane and its axis of rotation."
}, },
"siderealPeriod": { "siderealPeriod": {
"type": "number", "type": "number",
"default": 0 "default": 0,
"description" : "Rotation period in minutes."
}, },
"isTidallyLocked": { "isTidallyLocked": {
"type": "boolean", "type": "boolean",
"default": false "default": false,
"description" : "Should the body always have one side facing its primary?"
}, },
"showOrbitLine": { "showOrbitLine": {
"type": "boolean", "type": "boolean",
"default": false "default": false,
"description" : "Referring to the orbit line in the map screen."
}, },
"isStatic": { "isStatic": {
"type": "boolean", "type": "boolean",
@ -321,7 +334,7 @@
"trackingOrbitLine": { "trackingOrbitLine": {
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Should we just draw a line behind its orbit." "description": "Should we just draw a line behind its orbit instead of the entire circle/ellipse?"
} }
} }
}, },
@ -331,7 +344,8 @@
"innerRadius": { "innerRadius": {
"type": "number", "type": "number",
"default": 0, "default": 0,
"minimum": 0 "minimum": 0,
"description" : "Inner radius of the disk "
}, },
"outerRadius": { "outerRadius": {
"type": "number", "type": "number",
@ -340,10 +354,12 @@
}, },
"inclination": { "inclination": {
"type": "number", "type": "number",
"default": 0 "default": 0,
"description" : "Angle between the rings and the equatorial plane of the planet."
}, },
"longitudeOfAscendingNode": { "longitudeOfAscendingNode": {
"$ref": "#/$defs/angle" "$ref": "#/$defs/angle",
"description" : "Angle defining the point where the rings rise up from the planet's equatorial plane if inclination is nonzero."
}, },
"texture": { "texture": {
"type": "string", "type": "string",
@ -351,10 +367,12 @@
}, },
"rotationSpeed": { "rotationSpeed": {
"type": "number", "type": "number",
"default": 0 "default": 0,
"description" : "Allows the rings to rotate."
}, },
"curve": { "curve": {
"$ref": "#/$defs/curve" "$ref": "#/$defs/curve",
"description" : "Allows the rings to grow/shrink with time."
} }
} }
}, },
@ -371,11 +389,13 @@
}, },
"minHeight": { "minHeight": {
"type": "number", "type": "number",
"minimum": 0 "minimum": 0,
"description" : "The lowest points on your planet will be at this height."
}, },
"maxHeight": { "maxHeight": {
"type": "number", "type": "number",
"minimum": 0 "minimum": 0,
"description" : "The highest points on your planet will be at this height."
} }
} }
}, },
@ -396,10 +416,12 @@
"minimum": 0 "minimum": 0
}, },
"inclination": { "inclination": {
"$ref": "#/$defs/angle" "$ref": "#/$defs/angle",
"description" : "Angle between the rings and the equatorial plane of the planet."
}, },
"longitudeOfAscendingNode": { "longitudeOfAscendingNode": {
"$ref": "#/$defs/angle" "$ref": "#/$defs/angle",
"description" : "Angle defining the point where the rings rise up from the planet's equatorial plane if inclination is nonzero."
}, },
"randomSeed": { "randomSeed": {
"type": "integer", "type": "integer",
@ -417,7 +439,8 @@
"size": { "size": {
"type": "number", "type": "number",
"default": 2000, "default": 2000,
"minimum": 0 "minimum": 0,
"description" : "Radius of the star."
}, },
"tint": { "tint": {
"$ref": "#/$defs/color", "$ref": "#/$defs/color",
@ -425,7 +448,7 @@
}, },
"solarFlareTint": { "solarFlareTint": {
"$ref": "#/$defs/color", "$ref": "#/$defs/color",
"description": "Colour of the solar flares." "description": "Colour of the solar flares. The shader is a bit weird so the value you put won't exactly reflect what you see. Try experimenting with different colours to see what works."
}, },
"lightTint": { "lightTint": {
"$ref": "#/$defs/color", "$ref": "#/$defs/color",
@ -439,10 +462,12 @@
}, },
"hasAtmosphere": { "hasAtmosphere": {
"type": "boolean", "type": "boolean",
"default": true "default": true,
"description" : "The default sun has its own atmosphere that is different from regular planets. If you want that, set this to true."
}, },
"curve": { "curve": {
"$ref": "#/$defs/curve" "$ref": "#/$defs/curve",
"description" : "Allows the star to shrink/grow over time."
} }
} }
}, },
@ -488,7 +513,8 @@
}, },
"scale": { "scale": {
"type": "number", "type": "number",
"default": 1 "default": 1,
"description" : "How many props to scatter around the planet."
} }
} }
} }
@ -521,11 +547,6 @@
"type": "boolean", "type": "boolean",
"description": "Do we override rotation and try to automatically align this object to stand upright on the body's surface?", "description": "Do we override rotation and try to automatically align this object to stand upright on the body's surface?",
"default": false "default": false
},
"generateColliders": {
"type": "bool",
"default": false,
"description": "For each mesh filter found here should we make a mesh collider?"
} }
}, },
"scale": { "scale": {
@ -540,17 +561,21 @@
"type": "object", "type": "object",
"properties": { "properties": {
"position": { "position": {
"$ref": "#/$defs/vector3" "$ref": "#/$defs/vector3",
"description" : "When you enter into dialogue, you will look here."
}, },
"radius": { "radius": {
"type": "number", "type": "number",
"default": 0 "default": 0,
"description" : "Radius of the spherical collision volume where you get the \"talk to\" prompt when looking at. If you use a remoteTriggerPosition, this will instead be the size of the volume that will trigger the dialogue when you enter it."
}, },
"xmlFile": { "xmlFile": {
"type": "string" "type": "string",
"description" : "Relative path to the xml file defining the dialogue."
}, },
"remoteTriggerPosition": { "remoteTriggerPosition": {
"$ref": "#/$defs/vector3" "$ref": "#/$defs/vector3",
"description" : "Allows you to trigger dialogue from a distance when you walk into an area."
} }
} }
} }
@ -646,23 +671,15 @@
}, },
"frequency": { "frequency": {
"type": "string", "type": "string",
"enum": [ "description" : "The frequency ID of the signal. The built-in game values are \"Default\", \"Traveler\", \"Quantum\", \"EscapePod\", \"Statue\", \"WarpCore\", \"HideAndSeek\", and \"Radio\". You can also put a custom value."
"Default",
"Traveler",
"Quantum",
"EscapePod",
"Statue",
"WarpCore",
"HideAndSeek",
"Radio"
]
}, },
"name": { "name": {
"type": "string" "type": "string",
"description" : "The unique ID of the signal."
}, },
"audioClip": { "audioClip": {
"type": "string", "type": "string",
"description": "Name of an existing AudioClip in the game" "description": "Name of an existing AudioClip in the game that will player over the signal."
}, },
"audioFilePath": { "audioFilePath": {
"type": "string", "type": "string",
@ -680,22 +697,22 @@
"detectionRadius": { "detectionRadius": {
"type": "number", "type": "number",
"minimum": 0, "minimum": 0,
"description": "How close the player must get to the signal to detect it" "description": "How close the player must get to the signal to detect it. This is when you get the \"Unknown Signal Detected\" notification."
}, },
"identificationRadius": { "identificationRadius": {
"type": "number", "type": "number",
"minimum": 0, "minimum": 0,
"description": "How close the player must get to the signal to identify it" "description": "How close the player must get to the signal to identify it. This is when you learn it's name."
}, },
"onlyAudibleToScope": { "onlyAudibleToScope": {
"type": "boolean", "type": "boolean",
"default": true, "default": true,
"description": "False if the player can hear the signal without equipping the signal-scope" "description": "False if the player can hear the signal without equipping the signal-scope."
}, },
"insideCloak": { "insideCloak": {
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Only set to true if you are putting this signal inside a cloaking field" "description": "Only set to true if you are putting this signal inside a cloaking field."
} }
} }
} }
@ -708,7 +725,8 @@
"size": { "size": {
"type": "number", "type": "number",
"default": 0, "default": 0,
"minimum": 0 "minimum": 0,
"description" : "Radius of the singularity. Note that this isn't the same as the event horizon, but includes the entire volume that has warped effects in it."
}, },
"pairedSingularity": { "pairedSingularity": {
"type": "string", "type": "string",
@ -805,28 +823,28 @@
"properties": { "properties": {
"xmlFile": { "xmlFile": {
"type": "string", "type": "string",
"description": "The xml file to load ship log entries from" "description": "The relative path to the xml file to load ship log entries from."
}, },
"spriteFolder": { "spriteFolder": {
"type": "string", "type": "string",
"description": "A path to the folder where entry sprites are stored" "description": "A path to the folder where entry sprites are stored."
}, },
"initialReveal": { "initialReveal": {
"type": "array", "type": "array",
"description": "A list of fact IDs to reveal when the game starts", "description": "A list of fact IDs to reveal when the game starts.",
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
"entryPositions": { "entryPositions": {
"type": "array", "type": "array",
"description": "A set of positions to use instead of automatic layout in rumor mode", "description": "A set of positions to use instead of automatic layout in rumor mode.",
"items": { "items": {
"type": "object", "type": "object",
"properties": { "properties": {
"id": { "id": {
"type": "string", "type": "string",
"description": "The name of the entry to apply the position to" "description": "The name of the entry to apply the position to."
}, },
"position": { "position": {
"$ref": "#/$defs/vector2" "$ref": "#/$defs/vector2"
@ -839,70 +857,70 @@
"properties": { "properties": {
"revealedSprite": { "revealedSprite": {
"type": "string", "type": "string",
"description": "The path to the sprite to show when the planet is revealed in map mode" "description": "The path to the sprite to show when the planet is revealed in map mode."
}, },
"outlineSprite": { "outlineSprite": {
"type": "string", "type": "string",
"description": "The path to the sprite to show when the planet is unexplored in map mode" "description": "The path to the sprite to show when the planet is unexplored in map mode."
}, },
"manualPosition": { "manualPosition": {
"$ref": "#/$defs/vector2", "$ref": "#/$defs/vector2",
"description": "Manually place this planet at the specified position" "description": "Manually place this planet at the specified position."
}, },
"manualNavigationPosition": { "manualNavigationPosition": {
"$ref": "#/$defs/wholeVector2", "$ref": "#/$defs/wholeVector2",
"description": "Specify where this planet is in terms of navigation" "description": "Specify where this planet is in terms of navigation."
}, },
"scale": { "scale": {
"type": "number", "type": "number",
"description": "Scale to apply to the planet in map mode", "description": "Scale to apply to the planet in map mode.",
"default": 1 "default": 1
}, },
"invisibleWhenHidden": { "invisibleWhenHidden": {
"type": "bool", "type": "bool",
"description": "Hide the planet completely if unexplored instead of showing an outline", "description": "Hide the planet completely if unexplored instead of showing an outline.",
"default": false "default": false
}, },
"offset": { "offset": {
"type": "number", "type": "number",
"description": "Extra distance to apply to this object in map mode", "description": "Extra distance to apply to this object in map mode.",
"default": 0 "default": 0
}, },
"remove": { "remove": {
"type": "boolean", "type": "boolean",
"description": "Completely remove this planet (and it's children) from map mode", "description": "Completely remove this planet (and it's children) from map mode.",
"default": false "default": false
}, },
"details": { "details": {
"type": "array", "type": "array",
"description": "Place non-selectable object in map mode (like sand funnels)", "description": "Place non-selectable object in map mode (like sand funnels).",
"items": { "items": {
"type": "object", "type": "object",
"properties": { "properties": {
"revealedSprite": { "revealedSprite": {
"type": "string", "type": "string",
"description": "The sprite to show when the parent AstroBody is revealed" "description": "The sprite to show when the parent AstroBody is revealed."
}, },
"outlineSprite": { "outlineSprite": {
"type": "string", "type": "string",
"description": "The sprite to show when the parent AstroBody is rumored/unexplored" "description": "The sprite to show when the parent AstroBody is rumored/unexplored."
}, },
"rotation": { "rotation": {
"$refs": "#/$defs/angle", "$refs": "#/$defs/angle",
"description": "The angle in degrees to rotate the detail" "description": "The angle in degrees to rotate the detail."
}, },
"invisibleWhenHidden": { "invisibleWhenHidden": {
"type": "boolean", "type": "boolean",
"description": "Whether to completely hide this detail when the parent AstroBody is unexplored", "description": "Whether to completely hide this detail when the parent AstroBody is unexplored.",
"default": false "default": false
}, },
"position": { "position": {
"$ref": "#/$defs/vector2", "$ref": "#/$defs/vector2",
"description": "The position (relative to the parent) to place the detail" "description": "The position (relative to the parent) to place the detail."
}, },
"scale": { "scale": {
"$ref": "#/$defs/vector2", "$ref": "#/$defs/vector2",
"description": "The amount to scale the x and y axis of the detail by" "description": "The amount to scale the x and y axis of the detail by."
} }
} }
} }
@ -911,21 +929,21 @@
}, },
"Curiosities": { "Curiosities": {
"type": "array", "type": "array",
"description": "A set of colors to apply to curiosities", "description": "A set of colors to apply to curiosities.",
"items": { "items": {
"type": "object", "type": "object",
"properties": { "properties": {
"id": { "id": {
"type": "string", "type": "string",
"description": "The ID of the curiosity to apply the color to" "description": "The ID of the curiosity to apply the color to."
}, },
"color": { "color": {
"$ref": "#/$defs/color", "$ref": "#/$defs/color",
"description": "The color to apply to entries with this curiosity" "description": "The color to apply to entries with this curiosity."
}, },
"highlightColor": { "highlightColor": {
"$ref": "#/$defs/color", "$ref": "#/$defs/color",
"description": "The color to apply to highlighted entries with this curiosity" "description": "The color to apply to highlighted entries with this curiosity."
} }
} }
} }