Difference between revisions of "Headless Client/Example Configurations"
Jump to navigation
Jump to search
(One intermediate revision by one other user not shown) | |||
Line 5: | Line 5: | ||
<pre> | <pre> | ||
{ | { | ||
− | "$schema":"https://raw.githubusercontent.com/Neos-Metaverse/JSONSchemas/main/schemas/ | + | "$schema":"https://raw.githubusercontent.com/Neos-Metaverse/JSONSchemas/main/schemas/NeosHeadlessConfig.schema.json" |
"comment": "DO NOT EDIT THIS FILE! Your changes will be lost. Copy it over and create a new file called Config.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, | "universeId": null, | ||
Line 51: | Line 51: | ||
"cacheFolder": null, | "cacheFolder": null, | ||
"logsFolder": null, | "logsFolder": null, | ||
+ | "allowedUrlHosts": null, | ||
+ | "autoSpawnItems": null, | ||
+ | "metamovieRoles": null | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | |||
+ | == Local Storage == | ||
+ | An example configuration file using local storage and friend invitations. | ||
+ | <pre> | ||
+ | { | ||
+ | "$schema":"https://raw.githubusercontent.com/Neos-Metaverse/JSONSchemas/main/schemas/NeosHeadlessConfig.schema.json", | ||
+ | "comment": "Example Local Storage Config", | ||
+ | "universeId": null, | ||
+ | "tickRate": 60.0, | ||
+ | "maxConcurrentAssetTransfers": 4, | ||
+ | "usernameOverride": null, | ||
+ | "loginCredential": "yourUsername", | ||
+ | "loginPassword": "yourPassword", | ||
+ | "startWorlds": [ | ||
+ | { | ||
+ | "isEnabled": true, | ||
+ | "saveAsOwner": "LocalMachine", | ||
+ | "autoInviteUsernames": ["friendUsername1", "friendUsername2"], | ||
+ | "parentSessionIds": null, | ||
+ | "autoInviteMessage": "Welcome to my local world!", | ||
+ | "autoRecover": true, | ||
+ | "idleRestartInterval": 300.0, | ||
+ | "forcedRestartInterval": -1.0, | ||
+ | "saveOnExit": true, | ||
+ | "autosaveInterval": 600.0, | ||
+ | "autoSleep": true, | ||
+ | "sessionName": "MyLocalSession", | ||
+ | "customSessionId": null, | ||
+ | "description": "My own local world", | ||
+ | "maxUsers": 32, | ||
+ | "accessLevel": "Friends", | ||
+ | "hideFromPublicListing": null, | ||
+ | "tags": ["local", "test"], | ||
+ | "mobileFriendly": false, | ||
+ | "loadWorldURL": null, | ||
+ | "loadWorldPresetName": "SpaceWorld", | ||
+ | "overrideCorrespondingWorldId": null, | ||
+ | "forcePort": null, | ||
+ | "keepOriginalRoles": false, | ||
+ | "defaultUserRoles": null, | ||
+ | "roleCloudVariable": null, | ||
+ | "allowUserCloudVariable": null, | ||
+ | "denyUserCloudVariable": null, | ||
+ | "requiredUserJoinCloudVariable": null, | ||
+ | "requiredUserJoinCloudVariableDenyMessage": null, | ||
+ | "awayKickMinutes": -1.0 | ||
+ | } | ||
+ | ], | ||
+ | "dataFolder": "C:/NeosLocal/Data", | ||
+ | "cacheFolder": "C:/NeosLocal/Cache", | ||
+ | "logsFolder": "C:/NeosLocal/Logs", | ||
"allowedUrlHosts": null, | "allowedUrlHosts": null, | ||
"autoSpawnItems": null, | "autoSpawnItems": null, |
Latest revision as of 01:16, 12 July 2023
To help our users with Headless Client configuration here are some example files:
Default
The default configuration file from the Neos Installation.
{ "$schema":"https://raw.githubusercontent.com/Neos-Metaverse/JSONSchemas/main/schemas/NeosHeadlessConfig.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, "saveAsOwner": null, "autoInviteUsernames": null, "parentSessionIds": null, "autoInviteMessage": null, "autoRecover": true, "idleRestartInterval": -1.0, "forcedRestartInterval": -1.0, "saveOnExit": false, "autosaveInterval": -1.0, "autoSleep": true, "sessionName": null, "customSessionId": null, "description": null, "maxUsers": 32, "accessLevel": "Anyone", "hideFromPublicListing": null, "tags": null, "mobileFriendly": false, "loadWorldURL": null, "loadWorldPresetName": "SpaceWorld", "overrideCorrespondingWorldId": null, "forcePort": null, "keepOriginalRoles": false, "defaultUserRoles": null, "roleCloudVariable": null, "allowUserCloudVariable": null, "denyUserCloudVariable": null, "requiredUserJoinCloudVariable": null, "requiredUserJoinCloudVariableDenyMessage": null, "awayKickMinutes": -1.0 } ], "dataFolder": null, "cacheFolder": null, "logsFolder": null, "allowedUrlHosts": null, "autoSpawnItems": null, "metamovieRoles": null }
Local Storage
An example configuration file using local storage and friend invitations.
{ "$schema":"https://raw.githubusercontent.com/Neos-Metaverse/JSONSchemas/main/schemas/NeosHeadlessConfig.schema.json", "comment": "Example Local Storage Config", "universeId": null, "tickRate": 60.0, "maxConcurrentAssetTransfers": 4, "usernameOverride": null, "loginCredential": "yourUsername", "loginPassword": "yourPassword", "startWorlds": [ { "isEnabled": true, "saveAsOwner": "LocalMachine", "autoInviteUsernames": ["friendUsername1", "friendUsername2"], "parentSessionIds": null, "autoInviteMessage": "Welcome to my local world!", "autoRecover": true, "idleRestartInterval": 300.0, "forcedRestartInterval": -1.0, "saveOnExit": true, "autosaveInterval": 600.0, "autoSleep": true, "sessionName": "MyLocalSession", "customSessionId": null, "description": "My own local world", "maxUsers": 32, "accessLevel": "Friends", "hideFromPublicListing": null, "tags": ["local", "test"], "mobileFriendly": false, "loadWorldURL": null, "loadWorldPresetName": "SpaceWorld", "overrideCorrespondingWorldId": null, "forcePort": null, "keepOriginalRoles": false, "defaultUserRoles": null, "roleCloudVariable": null, "allowUserCloudVariable": null, "denyUserCloudVariable": null, "requiredUserJoinCloudVariable": null, "requiredUserJoinCloudVariableDenyMessage": null, "awayKickMinutes": -1.0 } ], "dataFolder": "C:/NeosLocal/Data", "cacheFolder": "C:/NeosLocal/Cache", "logsFolder": "C:/NeosLocal/Logs", "allowedUrlHosts": null, "autoSpawnItems": null, "metamovieRoles": null }