Difference between revisions of "Dedicated Server"

From Interstellar Rift Wiki
Jump to: navigation, search
(Source for this guide: https://steamcommunity.com/app/363360/discussions/0/530645446313237874/ will be linked to the Tutorials via Server Tutorials)
 
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
This is a guide for setting up your own Interstellar Rift dedicated server on windows. If you have any questions or issues please reply to the steam thread [https://steamcommunity.com/app/363360/discussions/0/530645446313237874/ here] and the Developers will answer them as soon as possible. This guide is player made. It assumes you already know how to install the steam client and/or SteamCMD. It is based off the guide found here [https://steamcommunity.com/app/363360/discussions/0/530645446313237874/ here]
+
This is a guide for setting up your own Interstellar Rift dedicated server. If you have any questions or issues please post in the [https://steamcommunity.com/app/363360/discussions/5/ Steam forum] or ask in the #technicalsupport channel on [https://discord.gg/InterstellarRift Discord]. This guide assumes you already know how to install the Steam client and/or SteamCMD.  
  
 
<br>
 
<br>
  
−
= How to make a windows dedicated server=
+
= Server commands =
  
−
'''Step 1: Download the game'''
+
[[Admin/User Server Commands]]
−
<ul>
+
−
<li>You have 2 options when trying to download the game. You can either download it via your Steam Client or you can use SteamCMD.</li>
+
−
<li>If you want to download it via SteamCMD the Steam AppID is 363360</li>
+
−
</ul>
+
−
'''Step 2: Make a shortcut to start your server'''
+
−
<ol>
+
−
<li>We will need to make a shortcut of IR.exe. It is usually located in the folder: Steam/SteamApps/common/Interstellar Rift/Build/IR.exe</li>
+
−
<li>Create a shortcut by right clicking IR.exe and selecting create shortcut</li>
+
−
<li>Right click the shortcut you just made and go to properties</li>
+
−
<li>Change the target to included -server at the end of it</li>
+
−
<ul>
+
−
<li>example "Interstellar Rift\Build\IR.exe" -server</li>
+
−
<li>example2 [http://puu.sh/iCOH7/961cc4452a.png click here] to see an image of how it should look</li>
+
−
</ul>
+
−
                <li>Do Not close the steam client you made the SSK.txt. You must start your server once before you can close the steam client you make it with or it will be invalid and you will have to make a new one</li>
+
−
</ol>
+
−
'''Step 3: Validating Your Server'''
+
−
<ol>
+
−
<li>You will need an SSK (Standalone Server Key) to allow your server to be validated. To get one open your IR client and go to Play Interstellar Rift > Host Game. Then click the "Generate SSK" key, [http://puu.sh/iCPfC/b4d074e12c.jpg like this]</li>
+
−
<li>After that a file called SSK.txt will be generated in your Appdata folder at: *Your Drive*:/Users/*Your User*/AppData/Roaming/InterstellarRift/SSK.txt</li>
+
−
<ul>
+
−
<li>As as shortcut to get there you can hit window key + R or click your window key this go to run and type %appdata% and hit enter. Then go to InterstellarRift/SSK.txt</li>
+
−
<li>Please note if you are running the server on another computer you will need to copy and paste or create a folder named SSK.txt in appdata on your server and copy the number inside the SSK.txt over to that computer.</li>
+
−
<li>This key will associate any servers with it to the Steam account you generated it with; It will be valid for a maximum of 30 days and may be used in as many server instances as you'd like once it is associated.</li>
+
−
<li>If your client was exited please generate a new key.</li>
+
−
</ul>
+
−
</ol>
+
−
'''Step 4: Configuring Your Server'''
+
−
<ol>
+
−
<li>In that same folder as that SSK.txt is stored in (*Your Drive*:/Users/*Your User*/AppData/Roaming/InterstellarRift/) you will find a file called server.json. If you do not see that file you should see config.xml. This is your config file</li>
+
−
<li>Right click on it and go to open with and select notepad.</li>
+
−
<li>Lastly edit what you would like and then save and close it</li>
+
−
<ul>
+
−
<li>Note: After you start your server once your will need to use the server.json file as your confing file.</li>
+
−
        <li>If you change the starting ship in the server.json file the Store-o-Tron will still show the factions' starter ships rather then the new ship you put in. </li>
+
−
</ul>
+
−
</ol>
+
  
 
<br>
 
<br>
 +
 +
= Windows =
 +
 +
'''Step 1a: Download the game'''
 +
 +
You can either download the game through the Steam client, or you can use SteamCMD.
 +
 +
When using SteamCMD you need to customize and run the following command:
 +
.\steamcmd +login <steam_username> "<steam_password>" +force_install_dir <installation_path> +app_update 363360 validate +quit
 +
For example, the resulting command for a given user <code>dummy</code> with password <code>dummy password</code> installed to the subdirectory <code>ir</code> of the steamcmd location would be:
 +
.\steamcmd +login dummy "dummy password" +force_install_dir .\ir +app_update 363360 validate +quit
 +
(More info on SteamCMD usage can be found [https://developer.valvesoftware.com/wiki/SteamCMD here].
 +
 +
'''Step 1b: Download and install dependencies'''
 +
 +
# When using the Steam client dependencies should be installed by Steam on first run, if this does not happen, install the following dependencies:
 +
#* Microsoft .NET Framework 4.7.2: <code>%PROGRAMFILES(X86)%\Steam\steamapps\common\Steamworks Shared\_CommonRedist\DotNet\4.7\NDP472-KB4054530-x86-x64-AllOS-ENU.exe</code>
 +
#* Microsoft Visual C++ 2012 Redistributable (x86): <code>%PROGRAMFILES(X86)%\Steam\steamapps\common\Steamworks Shared\_CommonRedist\vcredist\2012\vcredist_x86.exe</code>
 +
# When using SteamCMD you will have to install the dependencies yourself, you have two options to download the installers:
 +
## '''Directly from Microsoft'''
 +
##* [https://steamcommunity.com/app/363360/discussions/1/1648791520848656353/ Microsoft .NET Framework 4.7.2]
 +
##* [https://www.microsoft.com/en-us/download/details.aspx?id=30679 Microsoft Visual C++]
 +
## '''Using SteamCMD'''
 +
##* Microsoft .NET Framework 4.7.2: <code>download_depot 228980 229006</code>
 +
##* Microsoft Visual C++ 2012 Redistributable (x86): <code>download_depot 228980 228984</code>
 +
'''Step 2: Validating your server'''
 +
 +
You will need an SSK (Standalone Server Key) to allow your server to be validated. To get one you need to use the full Interstellar Rift client, however it does not need to run on the same machine as the dedicated server. [[File:GenerateSSK.png|thumb|right|Where to find the "Generate SSK" button]]
 +
 +
# Open your IsR client and go to Play Interstellar Rift > Host Game and then click the "Generate SSK" button, don't close the client until you've reached the end of the guide
 +
# A file called <code>SSK.txt</code> will be generated at: <code>%APPDATA%\InterstellarRift</code>.
 +
# Copy this file to the same location on the server machine, this key will be valid for 30 days and then you will have to redo this step.
 +
'''Step 3: Configuring your server'''
 +
 +
Configuring your server is done by editing the <code>server.json</code> file located at: <code>%APPDATA%\InterstellarRift</code>.
 +
 +
'''Step 4: Running your server'''
 +
 +
The game folder contains an auto-restart script called <code>start_server_autorestart.ps1</code> that will automatically restart your server when it crashes, you can either use this script to run your server or use it as an example for making your own. To execute it, right click the script and then use the "Run with PowerShell" option.
 +
 +
'''Step 5: Forwarding ports'''
 +
 +
The Interstellar Rift server uses UDP over port 8905 by default. Make sure your router is forwarding this port to the machine your server is running on.
 +
<br>
 +
 +
= Linux =
 +
 +
Running a Linux server is not officially supported but the Steam user 7thCore has made a Steam Guide explaining how to set up a dedicated server on Linux through Wine [https://steamcommunity.com/sharedfiles/filedetails/?id=1774601676 here]
 +
 +
<br>
 +
 
= Troubleshooting and Errors =
 
= Troubleshooting and Errors =
  
Line 53: Line 67:
 
|'''How to Fix'''
 
|'''How to Fix'''
 
|-
 
|-
−
| announcing server to masterserver: invalid steam ticket
+
|Announcing server to masterserver: invalid steam ticket
 
|This  means your SSK is not valid
 
|This  means your SSK is not valid
−
|Repeat Step 3.
+
|Repeat Step 2. The server does not need to be shut down
−
|-
+
−
|Warning > No devices found which means the network is broken or there is no UPnP/PMP capable router OR UPNP: Failed to add mapping!
+
−
| This means your router was not able to forward the Server's port automatically, or it does have such a function to do so.
+
−
|If you are getting this message it will not away. Just make sure your ports are forwarded and you shouldn't have any issues.
+
 
|}
 
|}

Latest revision as of 17:45, 7 August 2019

This is a guide for setting up your own Interstellar Rift dedicated server. If you have any questions or issues please post in the Steam forum or ask in the #technicalsupport channel on Discord. This guide assumes you already know how to install the Steam client and/or SteamCMD.


Server commands

Admin/User Server Commands


Windows

Step 1a: Download the game

You can either download the game through the Steam client, or you can use SteamCMD.

When using SteamCMD you need to customize and run the following command: 

.\steamcmd +login <steam_username> "<steam_password>" +force_install_dir <installation_path> +app_update 363360 validate +quit

For example, the resulting command for a given user dummy with password dummy password installed to the subdirectory ir of the steamcmd location would be: 

.\steamcmd +login dummy "dummy password" +force_install_dir .\ir +app_update 363360 validate +quit

(More info on SteamCMD usage can be found here.

Step 1b: Download and install dependencies

  1. When using the Steam client dependencies should be installed by Steam on first run, if this does not happen, install the following dependencies:
    • Microsoft .NET Framework 4.7.2: %PROGRAMFILES(X86)%\Steam\steamapps\common\Steamworks Shared\_CommonRedist\DotNet\4.7\NDP472-KB4054530-x86-x64-AllOS-ENU.exe
    • Microsoft Visual C++ 2012 Redistributable (x86): %PROGRAMFILES(X86)%\Steam\steamapps\common\Steamworks Shared\_CommonRedist\vcredist\2012\vcredist_x86.exe
  2. When using SteamCMD you will have to install the dependencies yourself, you have two options to download the installers:
    1. Directly from Microsoft
    2. Using SteamCMD
      • Microsoft .NET Framework 4.7.2: download_depot 228980 229006
      • Microsoft Visual C++ 2012 Redistributable (x86): download_depot 228980 228984

Step 2: Validating your server

You will need an SSK (Standalone Server Key) to allow your server to be validated. To get one you need to use the full Interstellar Rift client, however it does not need to run on the same machine as the dedicated server.
Where to find the "Generate SSK" button
  1. Open your IsR client and go to Play Interstellar Rift > Host Game and then click the "Generate SSK" button, don't close the client until you've reached the end of the guide
  2. A file called SSK.txt will be generated at: %APPDATA%\InterstellarRift.
  3. Copy this file to the same location on the server machine, this key will be valid for 30 days and then you will have to redo this step.

Step 3: Configuring your server

Configuring your server is done by editing the server.json file located at: %APPDATA%\InterstellarRift.

Step 4: Running your server

The game folder contains an auto-restart script called start_server_autorestart.ps1 that will automatically restart your server when it crashes, you can either use this script to run your server or use it as an example for making your own. To execute it, right click the script and then use the "Run with PowerShell" option.

Step 5: Forwarding ports

The Interstellar Rift server uses UDP over port 8905 by default. Make sure your router is forwarding this port to the machine your server is running on.

Linux

Running a Linux server is not officially supported but the Steam user 7thCore has made a Steam Guide explaining how to set up a dedicated server on Linux through Wine here


Troubleshooting and Errors

Error Message Description How to Fix
Announcing server to masterserver: invalid steam ticket This means your SSK is not valid Repeat Step 2. The server does not need to be shut down
Retrieved from "http://www.interstellarrift.com/wiki/index.php?title=Dedicated_Server&oldid=2982"