new-horizons/NewHorizons/Schemas/star_system_schema.json
github-actions[bot] 038275eb11 Updated Schemas
2022-06-14 00:23:00 +00:00

74 lines
2.5 KiB
JSON

{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Star System Schema",
"type": "object",
"description": "Configuration for a specific star system",
"additionalProperties": false,
"properties": {
"canEnterViaWarpDrive": {
"type": "boolean",
"description": "Whether this system can be warped to via the warp drive"
},
"destroyStockPlanets": {
"type": "boolean",
"description": "Do you want a clean slate for this star system? Or will it be a modified version of the original."
},
"enableTimeLoop": {
"type": "boolean",
"description": "Should the time loop be enabled in this system?",
"default": true
},
"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\nyou're using this, that would make no sense."
},
"mapRestricted": {
"type": "boolean",
"description": "Should the player not be able to view the map in this system?"
},
"skybox": {
"description": "Customize the skybox for this system",
"$ref": "#/definitions/SkyboxConfig"
},
"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\nsystem."
},
"travelAudioClip": {
"type": "string",
"description": "Name of an existing AudioClip in the game that will play when travelling in space."
},
"travelAudioFilePath": {
"type": "string",
"description": "Relative filepath to the .wav file to use as the audio. Mutually exclusive with travelAudioClip."
},
"$schema": {
"type": "string",
"description": "The schema to validate with"
}
},
"definitions": {
"SkyboxConfig": {
"type": "object",
"additionalProperties": false,
"properties": {
"assetBundle": {
"type": "string",
"description": "Path to the Unity asset bundle to load the skybox material from"
},
"destroyStarField": {
"type": "boolean",
"description": "Whether to destroy the star field around the player"
},
"path": {
"type": "string",
"description": "Path to the material within the asset bundle specified by `assetBundle` to use for the skybox"
}
}
}
},
"$docs": {
"title": "Star System Schema",
"description": "Schema for a star system in New Horizons"
}
}