No edit summary |
No edit summary |
||
Line 2: | Line 2: | ||
== Minimal == | == Minimal == | ||
The bare minimum required to run a single headless world | The bare minimum required to run a single headless world. In this case it just runs a Grid world with a name of "Testing" | ||
<syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
{ | { | ||
"$schema": "https://raw.githubusercontent.com/Yellow-Dog-Man/JSONSchemas/main/schemas/HeadlessConfig.schema.json", | "$schema": "https://raw.githubusercontent.com/Yellow-Dog-Man/JSONSchemas/main/schemas/HeadlessConfig.schema.json", | ||
"startWorlds": [ | |||
{ | |||
"isEnabled": true, | |||
"sessionName": "Testing", | |||
"accessLevel": "Anyone", | |||
"loadWorldPresetName": "Grid" | |||
} | |||
] | |||
} | |||
</syntaxhighlight> | |||
== Minimal with Login == | |||
This is an exact copy of the Minimal config but includes a User Login. For user management make sure to checkout [[Headless Client/Recommendations#Users| our recommendations for users on Headless]] | |||
<syntaxhighlight lang="json"> | |||
{ | |||
"$schema": "https://raw.githubusercontent.com/Yellow-Dog-Man/JSONSchemas/main/schemas/HeadlessConfig.schema.json", | |||
"loginCredential": "<username>", | |||
"loginPassword": "<password>", | |||
"startWorlds": [ | "startWorlds": [ | ||
{ | { | ||
"isEnabled": true, | "isEnabled": true, | ||
"sessionName": "Cheese Testing", | "sessionName": "Cheese Testing", | ||
"accessLevel": "Anyone", | "accessLevel": "Anyone", | ||
"loadWorldPresetName": "Grid" | "loadWorldPresetName": "Grid" | ||
Line 18: | Line 36: | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== Default == | == Default == |
Revision as of 00:40, 1 March 2024
To help our users with Headless Client configuration here are some example files:
Minimal
The bare minimum required to run a single headless world. In this case it just runs a Grid world with a name of "Testing"
{
"$schema": "https://raw.githubusercontent.com/Yellow-Dog-Man/JSONSchemas/main/schemas/HeadlessConfig.schema.json",
"startWorlds": [
{
"isEnabled": true,
"sessionName": "Testing",
"accessLevel": "Anyone",
"loadWorldPresetName": "Grid"
}
]
}
Minimal with Login
This is an exact copy of the Minimal config but includes a User Login. For user management make sure to checkout our recommendations for users on Headless
{
"$schema": "https://raw.githubusercontent.com/Yellow-Dog-Man/JSONSchemas/main/schemas/HeadlessConfig.schema.json",
"loginCredential": "<username>",
"loginPassword": "<password>",
"startWorlds": [
{
"isEnabled": true,
"sessionName": "Cheese Testing",
"accessLevel": "Anyone",
"loadWorldPresetName": "Grid"
}
]
}
Default
The default configuration file from the Resonite Installation.
{
"$schema": "https://raw.githubusercontent.com/Yellow-Dog-Man/JSONSchemas/main/schemas/HeadlessConfig.schema.json",
"comment": "DO NOT EDIT THIS FILE! Your changes will be lost. Copy it over and create a new file called Config.json",
"universeId": null,
"tickRate": 60.0,
"maxConcurrentAssetTransfers": 4,
"usernameOverride": null,
"loginCredential": null,
"loginPassword": null,
"startWorlds": [
{
"isEnabled": true,
"sessionName": null,
"customSessionId": null,
"description": null,
"maxUsers": 16,
"accessLevel": "Anyone",
"useCustomJoinVerifier": false,
"hideFromPublicListing": null,
"tags": null,
"mobileFriendly": false,
"loadWorldURL": null,
"loadWorldPresetName": "Grid",
"overrideCorrespondingWorldId": null,
"forcePort": null,
"keepOriginalRoles": false,
"defaultUserRoles": null,
"roleCloudVariable": null,
"allowUserCloudVariable": null,
"denyUserCloudVariable": null,
"requiredUserJoinCloudVariable": null,
"requiredUserJoinCloudVariableDenyMessage": null,
"awayKickMinutes": -1.0,
"parentSessionIds": null,
"autoInviteUsernames": null,
"autoInviteMessage": null,
"saveAsOwner": null,
"autoRecover": true,
"idleRestartInterval": -1.0,
"forcedRestartInterval": -1.0,
"saveOnExit": false,
"autosaveInterval": -1.0,
"autoSleep": true
}
],
"dataFolder": null,
"cacheFolder": null,
"logsFolder": null,
"allowedUrlHosts": null,
"autoSpawnItems": null
}