Difference between revisions of "Headless Client/Server"
(Marked this version for translation) |
DoubleStyx (talk | contribs) m |
||
Line 21: | Line 21: | ||
After Steam finishes the update, open the [https://steamcommunity.com/sharedfiles/filedetails/?id=760447682 installation folder]. You can find the headless client in the "Headless Client" subfolder. You can use the Config/DefaultConfig.json file to configure a startup world or to have the server login into an account (please don't use your main Neos account). Here's a sample configuration you can use and modify: | After Steam finishes the update, open the [https://steamcommunity.com/sharedfiles/filedetails/?id=760447682 installation folder]. You can find the headless client in the "Headless Client" subfolder. You can use the Config/DefaultConfig.json file to configure a startup world or to have the server login into an account (please don't use your main Neos account). Here's a sample configuration you can use and modify: | ||
{ | { | ||
− | "comment": " | + | "comment": "", |
"tickRate": 60.0, | "tickRate": 60.0, | ||
"maxConcurrentAssetTransfers": 4, | "maxConcurrentAssetTransfers": 4, | ||
Line 30: | Line 30: | ||
{ | { | ||
"isEnabled": true, | "isEnabled": true, | ||
− | "sessionName": | + | "sessionName": "", |
"customSessionId": null, | "customSessionId": null, | ||
"description": null, | "description": null, | ||
− | "maxUsers": | + | "maxUsers": 12, |
"accessLevel": "Anyone", | "accessLevel": "Anyone", | ||
− | "hideFromPublicListing": | + | "hideFromPublicListing": false, |
− | "tags": | + | "tags": [ |
+ | "test1", | ||
+ | ], | ||
"mobileFriendly": false, | "mobileFriendly": false, | ||
− | "loadWorldURL": | + | "loadWorldURL": "", |
"saveAsOwner": null, | "saveAsOwner": null, | ||
− | "loadWorldPresetName": | + | "loadWorldPresetName": null, |
"forcePort": null, | "forcePort": null, | ||
"keepOriginalRoles": false, | "keepOriginalRoles": false, | ||
− | "defaultUserRoles": | + | "defaultUserRoles": { |
+ | "User": "Admin" | ||
+ | }, | ||
"autoInviteUsernames": null, | "autoInviteUsernames": null, | ||
"autoInviteMessage": null, | "autoInviteMessage": null, | ||
Line 60: | Line 64: | ||
"autoSpawnItems": null, | "autoSpawnItems": null, | ||
"metamovieRoles": null | "metamovieRoles": null | ||
− | + | } | |
<!--T:5--> | <!--T:5--> |
Revision as of 23:20, 6 March 2021
Headless Clients are versions of Neos that lack a graphical user interface, allowing them to run efficiently in scenarios where rendering is not needed (such as when used as a server). Neos Pro users and all Patrons at the level Gunter and up have access to Headless Client builds. Check the pins in the #headless-client channel in the Neos Discord server, or contact a Neos administrator to get your access code.
Installation
Method 1
If using Steam:
- Go to Steam, open Neos Properties, and go to the Betas tab
- Use your code to activate the beta branch
- Switch to the headless-client branch
Method 2
If using SteamCMD:
- Paste the following command into SteamCMD:
app_update 740250 -beta headless-client -betapassword your_code
Configuration
After Steam finishes the update, open the installation folder. You can find the headless client in the "Headless Client" subfolder. You can use the Config/DefaultConfig.json file to configure a startup world or to have the server login into an account (please don't use your main Neos account). Here's a sample configuration you can use and modify:
{ "comment": "", "tickRate": 60.0, "maxConcurrentAssetTransfers": 4, "usernameOverride": null, "loginCredential": null, "loginPassword": null, "startWorlds": [ { "isEnabled": true, "sessionName": "", "customSessionId": null, "description": null, "maxUsers": 12, "accessLevel": "Anyone", "hideFromPublicListing": false, "tags": [ "test1", ], "mobileFriendly": false, "loadWorldURL": "", "saveAsOwner": null, "loadWorldPresetName": null, "forcePort": null, "keepOriginalRoles": false, "defaultUserRoles": { "User": "Admin" }, "autoInviteUsernames": null, "autoInviteMessage": null, "autoRecover": true, "idleRestartInterval": -1.0, "forcedRestartInterval": -1.0, "saveOnExit": false, "autosaveInterval": -1.0, "awayKickMinutes": -1.0, "autoSleep": true } ], "dataFolder": null, "cacheFolder": null, "allowedUrlHosts": null, "autoSpawnItems": null, "metamovieRoles": null
}
- The
loadWorldPresetName
attribute loads a world based on Neos world templates. The available templates are "SpaceWorld", "Basic Empty", "GridSpace", "Microworld", "Testing Scaling", "ScratchSpace", "ScratchSpace (mobile)", "Instancing Test", "Physical Locomotion Test" and "UIX Test".
- The
"defaultUserRoles"
attribute defines the user and access level for the world. The format is "USERNAME": "ROLE". The roles are "Admin", "Builder", "Moderator", "Guest", and "Spectator". - Run the executable to start the client.
Configuration for a Local or Cloud World Save
To configure a Headless client to act as a local storage server, set your world to "saveAsOwner" : "LocalMachine"
(will be replaced after first execution with it's unique startWorldURL
) as well as "saveOnExit" : true
and your desired autoSaveInterval
.
If you want the world data saved to the cloud (a valid dedicated Neos account will be needed), set "saveAsOwner" : "CloudUser"
.
Please use the shutdown
command to allow the server to save any unsaved changes on shutdown.
Config file example:
{ "tickRate": 60.0, "usernameOverride": null, "loginCredential": null, "loginPassword": null, "startWorlds": [ { "sessionName": "My World 1", "description": null, "maxUsers": 32, "accessLevel": "LAN", "tags": null, "mobileFriendly": false, "loadWorldPresetName": "BasicEmpty", "saveAsOwner" : "LocalMachine", "autoRecover": true, "saveOnExit" : true, "autoSaveInterval" : 240, "forcedRestartInterval": -1.0 } ], "dataFolder": null, "cacheFolder": null }
Commands
See Headless Client Commands for a list of commands.