Difference between revisions of "Headless Client/Server/cs"
(Created page with "=== Metoda 1 === Pomocí Steamu: * Jděte do Steamu, otevřete vlastnosti Neosu a přejděte na záložku Beta verze * Použijte váš kód pro aktivaci beta větve * Přepně...") |
(Created page with "=== Metoda 2 === Pomocí SteamCMD: * Vložte následující příkaz do SteamCMD: * <code>app_update 740250 -beta headless-client -betapassword your_code</code>") |
||
Line 11: | Line 11: | ||
− | === | + | === Metoda 2 === |
− | + | Pomocí SteamCMD: | |
− | * | + | * Vložte následující příkaz do SteamCMD: |
* <code>app_update 740250 -beta headless-client -betapassword your_code</code> | * <code>app_update 740250 -beta headless-client -betapassword your_code</code> | ||
Revision as of 23:15, 10 April 2021
Headless klienti jsou verze Neosu postrádající grafické uživatelské rozhraní, což jim umožňuje běžet efektivně ve scénářích kde není potřeba renderovat (jako například při použití jako server). Uživatelé Neos Pro a patroni třídy a výše mají přístup k headless klientu. Podívejte se na piny v kanálu #headless-client v Neos Discord serveru, nebo kontaktujte Neos administrátora pro získání vašeho kódu.
Instalace
Metoda 1
Pomocí Steamu:
- Jděte do Steamu, otevřete vlastnosti Neosu a přejděte na záložku Beta verze
- Použijte váš kód pro aktivaci beta větve
- Přepněte na větev headless-client
Metoda 2
Pomocí SteamCMD:
- Vložte následující příkaz do 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.