HeadlessConfig.schema.json

{
  "description": "Options used to configure a Headless server. Read in from a JSON file on Headless start.",
  "type": [
    "object",
    "null"
  ],
  "properties": {
    "SourceFile": {
      "type": [
        "string",
        "null"
      ]
    },
    "Schema": {
      "type": [
        "string",
        "null"
      ],
      "description": "JSONSchema for this file, used for external users to validate and test this file."
    },
    "Comment": {
      "type": [
        "string",
        "null"
      ],
      "description": "An optional free form comment for this file. Used for identification for your configuration."
    },
    "UniverseID": {
      "type": [
        "string",
        "null"
      ],
      "description": "Optionally, specifies which universe this Headless Server will be in. See \u003Csee href=\u0022https://wiki.resonite.com/Universes\u0022\u003Eour wiki article on Universes\u003C/see\u003E for more info."
    },
    "TickRate": {
      "type": "number",
      "description": "Configures how many ticks(updates), should occur per second. Default is 60."
    },
    "MaxConcurrentAssetTransfers": {
      "type": "integer",
      "description": "Specifies the maximum concurrent asset transfers for this headless server. Default is 4."
    },
    "UsernameOverride": {
      "type": [
        "string",
        "null"
      ],
      "description": "Configures a username which will override \u003Csee cref=\u0022P:FrooxEngine.Headless.HeadlessConfig.LoginCredential\u0022 /\u003E, within the world browser etc."
    },
    "LoginCredential": {
      "type": [
        "string",
        "null"
      ],
      "description": "Username for this Headless Server to use."
    },
    "LoginPassword": {
      "type": [
        "string",
        "null"
      ],
      "description": "User password for the Headless Server to use."
    },
    "StartWorlds": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "properties": {
          "isEnabled": {
            "$ref": "#/$defs/boolean"
          },
          "sessionName": {
            "$ref": "#/$defs/string"
          },
          "customSessionId": {
            "$ref": "#/$defs/string1"
          },
          "description": {
            "$ref": "#/$defs/string2"
          },
          "maxUsers": {
            "$ref": "#/$defs/integer"
          },
          "accessLevel": {
            "$ref": "#/$defs/sessionAccessLevel"
          },
          "useCustomJoinVerifier": {
            "$ref": "#/$defs/boolean1"
          },
          "hideFromPublicListing": {
            "$ref": "#/$defs/nullableOfBoolean"
          },
          "tags": {
            "$ref": "#/$defs/listOfString"
          },
          "mobileFriendly": {
            "$ref": "#/$defs/boolean2"
          },
          "loadWorldURL": {
            "$ref": "#/$defs/string3"
          },
          "loadWorldPresetName": {
            "$ref": "#/$defs/string4"
          },
          "overrideCorrespondingWorldId": {
            "$ref": "#/$defs/recordId"
          },
          "forcePort": {
            "$ref": "#/$defs/nullableOfUInt16"
          },
          "keepOriginalRoles": {
            "$ref": "#/$defs/boolean3"
          },
          "defaultUserRoles": {
            "$ref": "#/$defs/dictionaryOfStringAndString"
          },
          "roleCloudVariable": {
            "$ref": "#/$defs/string5"
          },
          "allowUserCloudVariable": {
            "$ref": "#/$defs/string6"
          },
          "denyUserCloudVariable": {
            "$ref": "#/$defs/string7"
          },
          "requiredUserJoinCloudVariable": {
            "$ref": "#/$defs/string7"
          },
          "requiredUserJoinCloudVariableDenyMessage": {
            "$ref": "#/$defs/string8"
          },
          "awayKickMinutes": {
            "$ref": "#/$defs/number"
          },
          "parentSessionIds": {
            "$ref": "#/$defs/listOfString1"
          },
          "autoInviteUsernames": {
            "$ref": "#/$defs/listOfString2"
          },
          "autoInviteMessage": {
            "$ref": "#/$defs/string9"
          },
          "saveAsOwner": {
            "$ref": "#/$defs/nullableOfSaveAsOwner"
          },
          "autoRecover": {
            "$ref": "#/$defs/boolean4"
          },
          "idleRestartInterval": {
            "$ref": "#/$defs/number1"
          },
          "forcedRestartInterval": {
            "$ref": "#/$defs/number2"
          },
          "saveOnExit": {
            "$ref": "#/$defs/boolean5"
          },
          "autosaveInterval": {
            "$ref": "#/$defs/number3"
          },
          "autoSleep": {
            "$ref": "#/$defs/boolean6"
          },
          "waitForLogin": {
            "$ref": "#/$defs/boolean7"
          }
        },
        "description": "A list of worlds/sessions to start/create when this Headless Server starts.",
        "title": "WorldStartupParameters"
      },
      "description": "A list of worlds/sessions to start/create when this Headless Server starts."
    },
    "DataFolder": {
      "type": [
        "string",
        "null"
      ],
      "description": "Optionally, override the folder which will be used to store data for this Headless Server."
    },
    "CacheFolder": {
      "type": [
        "string",
        "null"
      ],
      "description": "Optionally, override the folder which will be used to store cache for this Headless Server."
    },
    "LogsFolder": {
      "type": [
        "string",
        "null"
      ],
      "description": "Optionally, override the folder which will be used to store logs for this Headless Server."
    },
    "AllowedUrlHosts": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ],
        "description": "A list of hosts which will automatically be allowed for HTTP/WebSocket operations"
      },
      "description": "A list of hosts which will automatically be allowed for HTTP/WebSocket operations"
    },
    "AutoSpawnItems": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ],
        "description": "A list of item URIs to spawn in when a world starts."
      },
      "description": "A list of item URIs to spawn in when a world starts."
    }
  },
  "title": "HeadlessConfig",
  "$defs": {
    "boolean": {
      "type": "boolean",
      "description": "When set to false, this will disable this world entry from starting."
    },
    "string": {
      "type": [
        "string",
        "null"
      ],
      "description": "The name of the session as shown in the World/Session Browser"
    },
    "string1": {
      "type": [
        "string",
        "null"
      ],
      "description": "An \u003Cb\u003Eoptional\u003C/b\u003E custom session id for this session."
    },
    "string2": {
      "type": [
        "string",
        "null"
      ],
      "description": "An \u003Cb\u003Eoptional\u003C/b\u003E description of this session, displayed within the world/session browser."
    },
    "integer": {
      "type": "integer",
      "description": "The maximum number of users, allowed to join this session."
    },
    "sessionAccessLevel": {
      "enum": [
        "Private",
        "LAN",
        "Contacts",
        "ContactsPlus",
        "RegisteredUsers",
        "Anyone"
      ],
      "description": "The Access Level for this session please see \u003Csee cref=\u0022T:SkyFrost.Base.SessionAccessLevel\u0022 /\u003E for more information.",
      "title": "SessionAccessLevel"
    },
    "boolean1": {
      "type": "boolean",
      "description": "Determines whether custom join verifier should be enabled in this session"
    },
    "nullableOfBoolean": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Determines if this session should be hidden from the world/session browser or not."
    },
    "listOfString": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ],
        "description": "A list of tags, to assist with searching or discovering sessions. "
      },
      "description": "A list of tags, to assist with searching or discovering sessions. "
    },
    "boolean2": {
      "type": "boolean",
      "description": "Determines if this session is friendly for mobile/quest users."
    },
    "string3": {
      "type": [
        "string",
        "null"
      ],
      "description": "When provided with a world URL this will load this world for the session."
    },
    "string4": {
      "type": [
        "string",
        "null"
      ],
      "description": "When provided and valid, this will load the specified world preset into the session."
    },
    "recordId": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "recordId": {
          "type": [
            "string",
            "null"
          ]
        },
        "ownerId": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "description": "Overrides the world id for this session allowing it to be grouped and displayed with other sessions with this world id.",
      "title": "RecordId"
    },
    "nullableOfUInt16": {
      "type": [
        "integer",
        "null"
      ],
      "description": "\u003Cb\u003EOptional\u003C/b\u003E, If specified it will force this session to run on a specific network port."
    },
    "boolean3": {
      "type": "boolean",
      "description": "\u003Cb\u003EOptional\u003C/b\u003E, If specified will keep the original roles as saved in the world."
    },
    "dictionaryOfStringAndString": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "When provided with a list of username and permission pairs it will grant those users the listed permissions when they join."
    },
    "string5": {
      "type": [
        "string",
        "null"
      ],
      "description": "An \u003Cb\u003Eoptional\u003C/b\u003E name of a cloud variable to use to determine the role of this user. \r\nSee \u003Csee href=\u0022https://wiki.resonite.com/Cloud_Variables\u0022\u003Eour wiki article\u003C/see\u003E for more information."
    },
    "string6": {
      "type": [
        "string",
        "null"
      ],
      "description": "An \u003Cb\u003Eoptional\u003C/b\u003E name of a cloud variable to use to determine if this user is allowed in the session. \r\nSee \u003Csee href=\u0022https://wiki.resonite.com/Cloud_Variables\u0022\u003Eour wiki article\u003C/see\u003E for more information."
    },
    "string7": {
      "type": [
        "string",
        "null"
      ],
      "description": "An \u003Cb\u003Eoptional\u003C/b\u003E name of a cloud variable to use to determine if this user is denied access to the session. \r\nSee \u003Csee href=\u0022https://wiki.resonite.com/Cloud_Variables\u0022\u003Eour wiki article\u003C/see\u003E for more information."
    },
    "string8": {
      "type": [
        "string",
        "null"
      ],
      "description": "The name of a cloud variable whose value will be used, When a user is denied access by \u003Csee cref=\u0022P:SkyFrost.Base.WorldStartupParameters.RequiredUserJoinCloudVariable\u0022 /\u003E this message will be displayed to them if present.\r\nSee \u003Csee href=\u0022https://wiki.resonite.com/Cloud_Variables\u0022\u003Eour wiki article\u003C/see\u003E for more information."
    },
    "number": {
      "type": "number",
      "description": "Configures the number of minutes that a user can be away(shelled out) from a world before they are kicked. Setting this to -1 disables this option."
    },
    "listOfString1": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ],
        "description": "Provides a list of Parent Session Ids for this session. See \u003Csee href=\u0022https://wiki.resonite.com/Cloud_Variables\u0022\u003Eour wiki for more info\u003C/see\u003E."
      },
      "description": "Provides a list of Parent Session Ids for this session. See \u003Csee href=\u0022https://wiki.resonite.com/Cloud_Variables\u0022\u003Eour wiki for more info\u003C/see\u003E."
    },
    "listOfString2": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ],
        "description": "Users within this list will automatically be invited to this world when it starts."
      },
      "description": "Users within this list will automatically be invited to this world when it starts."
    },
    "string9": {
      "type": [
        "string",
        "null"
      ],
      "description": "An automatic message sent to the users on the \u003Csee cref=\u0022P:SkyFrost.Base.WorldStartupParameters.AutoInviteUsernames\u0022 /\u003E list along with their invite."
    },
    "nullableOfSaveAsOwner": {
      "enum": [
        "LocalMachine",
        "CloudUser"
      ],
      "title": "SaveAsOwner",
      "description": "Controls who saves this world when it is saved. See, \u003Csee cref=\u0022P:SkyFrost.Base.WorldStartupParameters.SaveAsOwner\u0022 /\u003E for more information."
    },
    "saveAsOwner": {
      "enum": [
        "LocalMachine",
        "CloudUser"
      ],
      "title": "SaveAsOwner"
    },
    "boolean4": {
      "type": "boolean",
      "description": "Headless only"
    },
    "number1": {
      "type": "number",
      "description": "If this is set(\u0026gt;0) and the world is empty, it will restart regularly using the value to determine the number of seconds between restarts.\r\nHeadless only"
    },
    "number2": {
      "type": "number",
      "description": "If this is set(\u0026gt;0), it will restart regularly using the value to determine the number of seconds between restarts.\r\nHeadless only"
    },
    "boolean5": {
      "type": "boolean",
      "description": "If set to true will save this world on exit."
    },
    "number3": {
      "type": "number",
      "description": "If this is set(\u0026gt;0), it will automatically save using the value to determine the number of seconds between saves.\r\nHeadless only"
    },
    "boolean6": {
      "type": "boolean",
      "description": "If set to true, will prevent an empty(or filled with away users) world from running a full update cycle regularily.\r\nHeadless only"
    },
    "boolean7": {
      "type": "boolean",
      "description": "When set to true, will wait for an active Resonite User session before loading this auto-start world."
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}