Unraid install guide / instructions

[ScrapyHD]

I had a rough time getting the SpaceEngineers container running on unraid, so I thought I'd type up a guide on how to install the container and get it working on unraid for anyone who's looking to do it. Apologies for any formatting issues in advance, this is my first time writing up a guide and a discussion on GitHub.

Guide

1. Open SpaceEngineersDedicatedServer from steam

2. Click run as administrator button (Right hand side)

3. Click Create New Instance
   -Note: the world name will need to be slightly modified, this is mentioned later on

4. Name your instance, and then click proceed

5. If you want to start with a fresh world, select whichever world you want to start with from the menu

6. If you want to port over your save, copy your save file and paste it into your instance's saves directory

   -Save File can be found here: C:\Users\Name\AppData\Roaming\SpaceEngineers\Saves\
   -Note: Replace "Name" with your windows username
   -Note: There will be a folder with a bunch of numbers as its name, open said folder and you will see your save files there

   -Instance save file directory: C:\ProgramData\SpaceEngineersDedicated\InstanceName\Saves
   -Note: Replace "InstanceName" with the name of the instance you just created
   -Note: ProgramData is hidden by default, click on the view pane in file explorer and enable "Show hidden items"

7. Rename your save file to be one word, Example: Original: Test World | Renamed: TestWorld

   • This is for our docker container in unraid, as having spaces in the world name causes issues
   • Capitalization matters, whatever you name the world as now, must be entered exactly in unraid later

8. In the dedicated server application, click refresh next to save world and then select the save world you just pasted and renamed

9. For the port, type 27017, we have to do this as the docker container port is set to 27017 and cannot be changed

10. Setup any settings you like, when done, click save

11. Then run the server and see if everything loads and that the server boots

If you are having steam or mod issues:
-Go to your steam folder: Usually in Program Files (x86)\Steam\ or if on separate drive G:\Steam
-Copy: steamclient.dll, steamclient64.dll, tier0_s.dll, tier0_s64.dll, vstdlib_s.dll, vstdlib_s64.dll
-Then, find SpaceEngineersDedicatedServer folder in steam, in my case:
G:\Steam\steamapps\common\SpaceEngineersDedicatedServer\DedicatedServer64
-Paste the files you just copied, select replace files
-This happens because the steam files the dedicated server application downloads are outdated, we are just updating them
-This is not an issue for the docker container, this is an issue for the steam dedicated server itself, I recommend doing this to test
run your server instance before running it on the docker container in unraid to ensure that if you run into any problems, the
instance itself is not the issue

11. In unraid, go to apps, search spaceengineers, and click on the app -> actions -> install

12. It will bring you into the template, we have a few things to setup here

    • Under Network Type, Select your custom docker network

    • Leave all the paths default

    • Click "Add another path, port, variable, Label, or device"

    • Steam Port Variable: This allows the container to access TCP port 8766, which is for steam's servers, it enables our container /
      server to access steam's servers and check for / update mods, without this the server will not start

      • For config type, select Port
      • For Name: Steam Port TCP
      • For Container Port: 8766
      • For Host Port: 8766
      • For Connection Type: TCP
      • Then click add

    • Again, Click "Add another path, port, variable, Label, or device

    • INSTANCE_NAME variable: This tells our container what instance it will be using, the original docker container has this in it's
      dockercompose.yml, without this, the server will be unstable or in most cases fail to boot

      • For config type, select Variable
      • For Name: INSTANCE_NAME
      • For Key: INSTANCE_NAME
      • For Value, enter the name of your instance
        -Remember: It must be one word, Capitalization matters
        -Going back to our example, "INSTANCE_NAME" would be "TestWorld"
      • Click add

13. Now Click apply, and wait for the docker container to download, when done, the container will start, check the logs and let it run for a bit as it has a lot to download on the first run

14. When its finished downloading, you will know since it will try to start the server and fail, stop the container

15. Now go back to the instance directory, copy your instance, and paste it in the SpaceEngineersDedicated Instances folder,
    Location: \\servername\appdata\SpaceEngineersDedicated\Instances

    -Certain docker containers have permissions which will not allow you to copy files over SMB (Windows File Explorer), this
    container is one of those. To copy, I recommend creating a temporary files folder in appdata, where you can copy files from
    your local pc. and then over terminal copy those files to where they need to go, in my case I've named my folder "filestomove".
    To do this, you either need to have your root share mapped as a network drive (I recommend doing this), or enable smb on your
    appdata share, after that go into your appdata folder and create a temporary files folder.

    -Copy your instance from C:\ProgramData\SpaceEngineersDedicated\InstanceName and paste it in S:\appdata\filestomove
    (S is the letter of my mapped network drive for my root share), if you enabled smb on your appdata share then you can copy to
    \\servername\appdata\filestomove

    -Now go to your unraid dashboard, open the terminal, type:
    mv /mnt/user/appdata/filestomove/InstanceName/ /mnt/user/appdata/SpaceEngineersDedicated/Instances/, remember to
    replace "InstanceName" with the actual name of your instance, and then hit enter. To check, open your temporary files folder
    and it should be empty, now go to the SpaceEngineersDedicated folder, in Instances there should be the instance your created
    earlier

16. That's it, now run the docker container again and it should boot!

Notes on changing instance files or server settings

-The container / server does not like you messing around / changing files, if you do this, it will most likely break and not boot, if you want to edit a file or roll back to a backup save, stop the server and then copy the instance folder from: \\servername\appdata\SpaceEngineersDedicated/Instances/ to your pc

-You are able to copy files from the container, just not able to upload to it. Note: to make changes to your instance/save you will have to delete the instance in the container, if you don't want to lose your current instance, then make 2 copies to your pc, 1 as a backup in case your changes break the server, and the other to edit

-Change whatever you want to, then copy and paste the edited instance to your temporary files folder in appdata
-Go to your unraid terminal again, type: cd /mnt/user/appdata/SpaceEngineersDedicated/Instances/ and hit enter
-Then type: mc and hit enter
-Use the arrow keys or your mouse to select your instance, then hit f8 on your keyboard (or click on delete at the bottom) and select yes, select yes again to delete recursively
-Now select quit at the bottom right of the screen, then type:
mv /mnt/user/appdata/filestomove/InstanceName/ /mnt/user/appdata/SpaceEngineersDedicated/Instances/
-Thats it! Now close the terminal and run the docker container