Difference between revisions of "Headless Client"

From Neos Wiki
Jump to navigation Jump to search
(Created page with "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...")
 
Line 8: Line 8:
 
# Using Steam's Graphical Interface
 
# Using Steam's Graphical Interface
 
# Using Steam's Command Line Interface - Common for within Docker files and Linux servers.
 
# Using Steam's Command Line Interface - Common for within Docker files and Linux servers.
 +
 +
=== Using Steam's Graphical Interface ===
 +
 +
# Open Steam
 +
# Find Neos in your Installed Games list
 +
# Right Click Neos and select "Properties"
 +
# Click the "Betas" option in the window which appears
 +
# Enter your code from the pinned message on the "#headless-client" channel into the "beta access code" field.
 +
# This will grant you access to the headless-client build.
 +
# Switch to the headless-client build
 +
 +
=== Using Steam's Command Line Interface ===
 +
# [https://developer.valvesoftware.com/wiki/SteamCMD install SteamCMD]
 +
# Run Steam CMD with: <code>steamcmd</code>
 +
# Paste the following command into SteamCMD: <code>app_update 740250 -beta headless-client -betapassword <beta access code></code>

Revision as of 08:55, 24 October 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). It is common to use a Headless Client to run events or servers for large volume applications within Neos. Headless Clients can run on Windows and Linux servers wherever they may be, including your own computer.

Access to Headless Client Builds

The Headless Client feature is currently in preview and due to this you will need to have a Neos Pro License or to be a Neos Patreon at the Gunter level or higher. Once this is done, check the pins in the #headless-client channel in the Neos Discord server, or contact a Neos administrator to get your access code.

Getting the files

There are two options for getting the files required to run a headless client:

  1. Using Steam's Graphical Interface
  2. Using Steam's Command Line Interface - Common for within Docker files and Linux servers.

Using Steam's Graphical Interface

  1. Open Steam
  2. Find Neos in your Installed Games list
  3. Right Click Neos and select "Properties"
  4. Click the "Betas" option in the window which appears
  5. Enter your code from the pinned message on the "#headless-client" channel into the "beta access code" field.
  6. This will grant you access to the headless-client build.
  7. Switch to the headless-client build

Using Steam's Command Line Interface

  1. install SteamCMD
  2. Run Steam CMD with: steamcmd
  3. Paste the following command into SteamCMD: app_update 740250 -beta headless-client -betapassword <beta access code>