Skip to content

Latest commit

 

History

History
77 lines (48 loc) · 3.58 KB

hosting-a-server.md

File metadata and controls

77 lines (48 loc) · 3.58 KB
description
For the purpose of debugging (maybe even playing some day), this page explain how you can host a SS3D server, in or outside the Unity editor.

Hosting a server

{% hint style="warning" %} We don't have the SS3D Hub yet, so this is only valid before we have that. {% endhint %}

The process of hosting a server, where you can play and have players connected to your server is possible via two paths:

Pre-launch instructions

Using the .bat file

Assuming you built the game and have a SS3D.exe file in the Builds folder, you can simply double left click on the Start SS3D Host.bat to launch a server, with john as a username.

Using the Command Line Args

{% hint style="danger" %} This is only applicable for Built Executables. {% endhint %}

To host a server outside the Unity Editor, first you have to build SS3D in the Builds folder of your SS3D project. You can then open a command prompt, move to the Builds folder and type :

start SS3D.exe -host -ckey=hostUsername -skipintro

Replace hostUsername by whatever username you want to use. Don't hit enter yet and skip to launch instructions.

Using Application Settings window

{% hint style="danger" %} This is only applicable when using the Unity Engine for hosting, which should be avoided if you're not developing. {% endhint %}

You can set the Network Type to Host, the Editor Server Address to your server IP, or your local IP (127.0.0.1) if hosting from the same machine, and the Ckey to your desired Ckey.

{% hint style="info" %} You can hover the parameters in Application Settings to get a description on what it does and how to use it. {% endhint %}

Launch Instructions

{% hint style="info" %} This is valid for Unity Editor and Built Executable usage. {% endhint %}

In the permissions.txt file, inside the Builds/Config folder. The username should have Administrator written on the same line in the permissions.txt file, otherwise it will not able to host the server. This should probably be automated eventually.

You can now hit enter or hit play depending on your case. The server will be launched and you can join with a client now.

Once started, go to server settings and click on start round like in the picture below.

Troubleshooting

Nothing appearing on the server page when hosting

Check the host username in the command:

start SS3D.exe -host -ckey=hostUsername -skipintro

It must exactly correspond to whatever username is present in the permissions.txt file, in the Builds/Config folder.