No edit summary |
m oopsie: mono -> dotnet |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
=== Windows Prerequisites === | === Windows Prerequisites === | ||
* [https://dotnet.microsoft.com/en-us/download/dotnet | * [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET Runtime 8.0] | ||
=== Linux Prerequisites === | === Linux Prerequisites === | ||
* | * .NET 8.0 Runtime | ||
** You can find instructions on [https:// | ** You can find instructions on [https://learn.microsoft.com/en-us/dotnet/core/install/linux Microsoft's website] | ||
** Follow instructions for the | ** Follow instructions for the distribution you are using | ||
* steamcmd | * steamcmd | ||
** 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 | == Access to Headless Software builds == | ||
To gain access to the Headless | 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 | == Getting the Headless Software files == | ||
There are two options for getting the files required to run a headless | 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 30: | Line 30: | ||
# Click the "Betas" option in the window which appears | # Click the "Betas" option in the window which appears | ||
# Enter your code from Resonite bot into the "beta access code" field. | # Enter your code from Resonite bot into the "beta access code" field. | ||
# This will grant you access to the headless | # This will grant you access to the headless build. | ||
# Switch to the headless | # Switch to the headless build | ||
=== Using Steam's Command Line Interface === | === Using Steam's Command Line Interface === | ||
| 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 | == 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 44: | Line 44: | ||
Once you've found them you can try running the "Resonite.exe" file in there: | Once you've found them you can try running the "Resonite.exe" file in there: | ||
* For Windows, we still recommend a terminal window. | * For Windows, we still recommend a terminal window. | ||
** Powershell or CMD works well | ** Powershell or CMD works well | ||
** This allows you to see any errors or problems in a much easier way. | ** This allows you to see any errors or problems in a much easier way. | ||
* For Linux you'll need | * For Linux you'll need dotnet: <code>dotnet Resonite.dll</code> | ||
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 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. | ||
| 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 | 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. | ||
Latest revision as of 22:55, 5 August 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
- .NET 8.0 Runtime
- You can find instructions on Microsoft's website
- Follow instructions for the distribution you are using
- steamcmd
- You can find instructions on the Valve Software Wiki.
Access to Headless Software builds
To gain access to the Headless Software you will need a headless steam beta code:
- Send
/headlessCodeto 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:
- Using Steam's Graphical Interface
- Using Steam's Command Line Interface - Common for within Docker files and Linux servers.
Using Steam's graphical interface
- Open Steam
- Find Resonite in your Installed Games list
- Right Click Resonite and select "Properties"
- Click the "Betas" option in the window which appears
- Enter your code from Resonite bot into the "beta access code" field.
- This will grant you access to the headless build.
- Switch to the headless build
Using Steam's Command Line Interface
- Run Steam CMD with:
steamcmd - Run:
app_license_request 2519830. - 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 dotnet:
dotnet Resonite.dll
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.