Headless server software/ARM: Difference between revisions

From Resonite Wiki
VisualWikitext
add base of guide (via SublimeText.Mediawiker)
 
arm64 is officially supported now; remove outdated info
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{ note | While this method can work, it is currently not officially supported. See issue [https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/2555 GH-2555] for the status on official support | warning }}
The Headless Server Software is supported on ARM64-based Linux machines, such as the Oracle Cloud free tier.
 
With some work, it is possible to run the Headless Server Software on ARM-based machines, such as the Oracle Cloud free tier.
 
Do note this page concerns <code>aarch64</code> CPUs. If you are using a different kind of ARM CPU, those instructions will not apply and further steps will need to be taken.
 
Similarly, this page assumes you are using a Linux-based system.


== Steps ==
== Steps ==
Line 13: Line 7:
Several pre-requisites are needed to run the Headless:
Several pre-requisites are needed to run the Headless:


* [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 .NET 8 SDK]
* [https://dotnet.microsoft.com/en-us/download/dotnet/10.0 .NET 10 Runtime]
* [https://dotnet.microsoft.com/en-us/download/dotnet/9.0 .NET 9 Runtime]
* Either SteamCMD or [https://github.com/SteamRE/DepotDownloader DepotDownloader] to Download the headless, you can also copy the headless from your Resonite install if you're on the headless branch
* ILSpy Command Line Tool (<code>ilspycmd</code> on most distributions)
** SteamCMD is not officially supported on ARM but can be used through box64 [https://github.com/ptitSeb/box64/blob/main/docs/COMPILE.md#note-about-box32 built with the box32 flag]
** You can install it using <code>dotnet tool install --global ilspycmd</code>
* Either SteamCMD or [https://github.com/SteamRE/DepotDownloader DepotDownloader] to Download the headless
** SteamCMD is not officially supported on ARM


=== Downloading the Headless Server Software ===
=== Downloading the Headless Server Software ===
Line 44: Line 35:
</pre>
</pre>


==== Getting native libraries ====
The Headless Server Software needs a number of native libraries to function properly.
A set of libraries pre-compiled for ARM is available, courtesy of [[User:J4 | J4]]. More information is available on [https://j4.lc/resonite-arm-libraries.html its website].
First, download and unzip the libraries:
<pre>
wget https://i.j4.lc/resonite/libraries-arm.zip
unzip libraries-arm.zip
</pre>
Then copy the libraries to the directory in which the Headless Server Software is present:
<pre>
find . -type f -exec cp {} /path/to/install/ \;
</pre>
Finally, rename <code>libfreetype</code> to ensure compatibility with the one needed:
<pre>
mv /path/to/install/libfreetype.so /path/to/install/libfreetype6.so
</pre>
===== SteamWorks.NET =====
Among the libraries needed for the Headless Server Software, <code>SteamWorks.NET</code> is a special case as it is simply not available for ARM systems at the moment, due to some technical constrains.
You will need to recompile it with the correct architecture, which can be done like so:
Create a de-compilation directory, then de-compile SteamWorks.NET to it:
<pre>
mkdir decomp && cd decomp
ilspycmd /path/to/install/Headless/Steamworks.NET.dll -r ./ -p -o .
</pre>
Open the <code>Steamworks.NET.csproj</code> with a text editor (<code>nano</code> and <code>vim</code> are commonly used), and edit the <code>PlatformTarget</code> and <code>PlatformTarget</code> tags so they match the following:


<pre>
== Modding ==
<PlatformTarget>x86</PlatformTarget>
</pre>


And:
Linux aarch64 support for MonoMod [https://github.com/MonoMod/MonoMod/pull/241 has now been merged], so all your mods should work as expected!


<pre>
== Troubleshooting ==
<PlatformTarget>AnyCPU</PlatformTarget>
</pre>


You can then build the library using <code>dotnet build -c Release</code>.
If you are having any issues, please ask in the [[Resonite Discord]], in the "[https://canary.discord.com/channels/1040316820650991766/1158936045186973726 Headless on ARM]" thread (requires account).
 
Once the compilation is finished, you can copy the built DLL library file to the headless location:
 
<pre>
cp bin/Release/netstandard2.1/Steamworks.NET.dll /path/to/install/Headless/Steamworks.NET.dll
</pre>
 
=== Launching the Headless Server Software ===
 
You can now launch the Headless Server Software like on x64-based machines:
 
<pre>
dotnet /path/to/install/Headless/Resonite.dll
</pre>


== Acknowledgements ==
== Acknowledgements ==
Line 114: Line 48:
Several people made running Resonite on ARM-based machines possible:
Several people made running Resonite on ARM-based machines possible:


* [https://github.com/OrionMoonclaw Orion Moonclaw] for helping and testing native libraries
* [https://github.com/OrionMoonclaw Orion Moonclaw] for helping and testing native libraries, janky arm64 MonoMod branch
* [https://github.com/wattlefoxxo WattleFoxxo] for compiling the information and writing the original version of this guide on Discord
* [https://github.com/wattlefoxxo WattleFoxxo] for compiling the information and writing the original version of this guide on Discord
* [[User:J4 | J4]] for providing build processes and pre-compiled native libraries
* [[User:J4 | J4]] for providing build processes and pre-compiled native libraries

Latest revision as of 00:45, 12 December 2025

The Headless Server Software is supported on ARM64-based Linux machines, such as the Oracle Cloud free tier.

Steps

Pre-requisites

Several pre-requisites are needed to run the Headless:

Downloading the Headless Server Software

SteamCMD

Downloading the Headless Server Software through SteamCMD is done as following: 

steamcmd +force_install_dir /path/to/install \
  +login YOUR_STEAM_USERNAME YOUR_STEAM_PASSWORD \
  +app_update 2519830 -beta headless -betapassword HEADLESS_BETA_CODE validate \
  +quit

DepotDownloader

Downloading the Headless Server Software through DepotDownloader is done as following: 

DepotDownloader -app 2519830 \
  -username YOUR_STEAM_USERNAME -password YOUR_STEAM_PASSWORD \
  -branch headless -branchpassword HEADLESS_BETA_CODE \
  -dir /path/to/install


Modding

Linux aarch64 support for MonoMod has now been merged, so all your mods should work as expected!

Troubleshooting

If you are having any issues, please ask in the Resonite Discord, in the "Headless on ARM" thread (requires account).

Acknowledgements

Several people made running Resonite on ARM-based machines possible:

  • Orion Moonclaw for helping and testing native libraries, janky arm64 MonoMod branch
  • WattleFoxxo for compiling the information and writing the original version of this guide on Discord
  • J4 for providing build processes and pre-compiled native libraries
Retrieved from "https://wiki.resonite.com/index.php?title=Headless_server_software/ARM&oldid=114646"
Last modified
This page was last edited on 12 December 2025, at 00:45.