new-horizons/NewHorizons/Schemas/star_system_schema.json
2022-05-22 12:23:54 -04:00

58 lines
2.1 KiB
JSON

{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"title": "Star System",
"description": "Configuration for a specific star system",
"properties": {
"canEnterViaWarpDrive": {
"type": "boolean",
"description": "Whether this system can be warped to via the warp drive"
},
"startHere": {
"type": "boolean",
"description": "Set to true if you want to spawn here after dying, not Timber Hearth. You can still warp back to the main star system."
},
"factRequiredForWarp": {
"type": "string",
"description": "Set to the FactID that must be revealed before it can be warped to. Don't set `CanEnterViaWarpDrive` to false if you're using this, that would make no sense."
},
"destroyStockPlanets": {
"type": "bool",
"description": "Do you want a clean slate for this star system? Or will it be a modified version of the original."
},
"enableTimeLoop": {
"type": "bool",
"description": "Should the player be sent back in time after 22 minutes?",
"default": true
},
"mapRestricted": {
"type": "bool",
"description": "Should the player be unable to use their map in this system?",
"default": false
},
"subtitle": {
"type": "string",
"description": "Relative path to a subtitle image to be displayed on the main menu scene. The image should be 669x97 resolution."
},
"skybox": {
"type": "object",
"description": "Options for the skybox of your system",
"properties": {
"destroyStarField": {
"type": "boolean",
"description": "Whether to destroy the star field around the player (always set to true if `assetBundle` and `path` is set)",
"default": false
},
"assetBundle": {
"type": "string",
"description": "Path to the Unity asset bundle to load the skybox material from"
},
"path": {
"type": "string",
"description": "Path to the material within the asset bundle specified by `assetBundle` to use for the skybox"
}
}
}
}
}