Headless Server Software/Setup: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page Headless Client/Setup to Headless Server Software/Setup: Clarifying our terminology.
No edit summary
Line 13: Line 13:
** You can find instructions on the [https://developer.valvesoftware.com/wiki/SteamCMD#Downloading_SteamCMD Valve Software Wiki].
** You can find instructions on the [https://developer.valvesoftware.com/wiki/SteamCMD#Downloading_SteamCMD Valve Software Wiki].


== Access to Headless client builds ==
== Access to Headless Software builds ==
To gain access to the Headless client you will need a headless steam beta code:
To gain access to the Headless Software you will need a headless steam beta code:
* Send <code>/headlessCode</code> to the [[Resonite Bot | Resonite bot]] in-game.
* Send <code>/headlessCode</code> to the [[Resonite Bot | Resonite bot]] in-game.
* You'll get a headless beta code for steam. With this in hand you need to proceed to getting the files.
* You'll get a headless beta code for steam. With this in hand you need to proceed to getting the files.


== Getting the Headless client files ==
== Getting the Headless Software files ==
There are two options for getting the files required to run a headless client:
There are two options for getting the files required to run a headless server:
# 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.
Line 38: Line 38:
# Run: <code>app_update 2519830 -beta headless -betapassword <headless beta access code></code>
# Run: <code>app_update 2519830 -beta headless -betapassword <headless beta access code></code>


== Your first time running a Headless Client ==  
== Your first time running a Headless Server ==  
First, look for the files you've installed. Look for Resonite.exe:
First, look for the files you've installed. Look for Resonite.exe:
* For SteamCMD it will be in the location which you downloaded the files to with SteamCMD
* For SteamCMD it will be in the location which you downloaded the files to with SteamCMD
Line 53: Line 53:
This isn't that useful but it does verify that everything is installed and setup correctly. After it starts up you should see "World Running" and something along the lines of "<your computers name> World 0>_".
This isn't that useful but it does verify that everything is installed and setup correctly. After it starts up you should see "World Running" and something along the lines of "<your computers name> World 0>_".


If you see this, you're good to go! You've got a running Headless Client. You'll probably want to create a [[Headless Client/Configuration File|Configuration File]] next.
If you see this, you're good to go! You've got a running Headless Server. You'll probably want to create a [[Headless Server Software/Configuration File|Configuration File]] next.

Revision as of 00:16, 19 April 2024

Prerequisites

  • Be a Resonite Patron at the Discoverer level or higher.
  • Have a Windows or Linux server or machine ready to go

Windows Prerequisites

Linux Prerequisites

  • Mono (mono-complete)
    • You can find instructions on Mono's website
    • Follow instructions for the mono-complete package
  • steamcmd

Access to Headless Software builds

To gain access to the Headless Software you will need a headless steam beta code:

  • Send /headlessCode to the Resonite bot in-game.
  • You'll get a headless beta code for steam. With this in hand you need to proceed to getting the files.

Getting the Headless Software files

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

  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 Resonite in your Installed Games list
  3. Right Click Resonite and select "Properties"
  4. Click the "Betas" option in the window which appears
  5. Enter your code from Resonite bot 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. Run Steam CMD with: steamcmd
  2. Run: app_license_request 2519830.
  3. Run: app_update 2519830 -beta headless -betapassword <headless beta access code>

Your first time running a Headless Server

First, look for the files you've installed. Look for Resonite.exe:

  • For SteamCMD it will be in the location which you downloaded the files to with SteamCMD
  • For Steam's GUI it will be in the regular Steam installation folder for Resonite inside a folder called "Headless"

Once you've found them you can try running the "Resonite.exe" file in there:

  • For Windows, we still recommend a terminal window.
    • Powershell or CMD works well
    • This allows you to see any errors or problems in a much easier way.
  • For Linux you'll need mono: mono Resonite.exe

This will run a default Resonite Headless, as we haven't specified any configuration properties it will just open a default world using a non-logged in user.

This isn't that useful but it does verify that everything is installed and setup correctly. After it starts up you should see "World Running" and something along the lines of "<your computers name> World 0>_".

If you see this, you're good to go! You've got a running Headless Server. You'll probably want to create a Configuration File next.