Setting up a Multiplayer Server/de: Difference between revisions

== Einfache Einrichtung ==

===Lokaler Server===

Wenn du ein temporäres Multiplayer-Erlebnis haben möchtest, reicht es, eine Einzelspielerwelt zu öffnen und dann im Escape-Menü auf "Open to Lan" zu klicken. Dies ermöglicht es Spielern in Ihrem lokalen Netzwerk, dem Spiel beizutreten.

Wenn du Spielern außerhalb deines lokalen Netzwerks den Beitritt ermöglichen willst, kannst du auch auf "Open to Internet" klicken, wodurch versucht wird, eine externe Verbindung zu deinem Server aus dem Internet herzustellen. Dies geschieht über eine Technik namens UPnP, die auf deinem Internet-Router aktiviert sein muss, was oft standardmäßig der Fall ist. Kurz gesagt, wir schätzen, dass die Wahrscheinlichkeit, dass "Open to Internet" sofort und ohne Probleme funktioniert, bei etwa 60 % liegt. Wenn dies nicht der Fall ist, musst du eine so genannte "Portweiterleitung" auf deinem Internet-Router einrichten, was leider manchmal sehr schwierig und frustrierend sein kann. In diesem Fall musst du den TCP-Port 42420 an deinen Computer weiterleiten. (Google 'Portweiterleitung' mit dem Namen oder Modell Ihres Internet-Routers, um Hilfe zu finden.)

----

Alternatively the game ships with a dedicated server program that you can start and leave on permanently without needing to log in yourself.

There are several ways to get a dedicated server up and running.

----

   mkdir server && cd server

Goto http://account.vintagestory.at/downloads<br>

For security reasons you should not run the server as root user, so by default USERNAME is set to vintagestory.

On most linux operating systems you can create a user with the command adduser.

Then change these options for your needs:

   VSPATH='<your-vs-directory>'

firewalld

   firewall-cmd --permanent --zone=public --add-port=42420/tcp

iptables

   iptables -A INPUT -p tcp -m tcp --dport 42420 -j ACCEPT

   ./server.sh start

   Wait for the startup to finish, then you can give yourself OP with

   ./server.sh command "/op <youusername>"

----

== Basic Configuration ==

On windows, by default this file is located at '''%appdata%/VintageStoryData/serverconfig.json'''.

On Linux it's located at '''./data/serverconfig.json''' of your server directory (e.g. ''/home/vintagestory/server/data/serverconfig.json'' if setup like described here)

''Explanation of values in serverconfig.json you can find here: [[Server Config]]''

Here are some of the configurations set by commands, that you'd typically want to set.

* <code>/serverconfig upnp [0|1]</code><br>If set to one, the game server will attempt to set up port forwarding for you

* <code>/serverconfig name Peaceful PvE Server</code><br>Set up the server name, visible in the public server listing

* <code>/serverconfig password asdaf</code><br>Require a password for players to log in, if desired. Use <code>/serverconfig nopassword</code> to remove again.

* <code>/serverconfig advertise (1|0)</code><br>Whether or not add this server to the public server listing

Lastly, you can configure a server that was created with the 'Open to Lan' method in the same way as you do for dedicated ones, be aware though, in that case a few of the configurations are overridden by the client, such as the save file location.

== Advanced Dedicated Server ==

===Debian with systemd service and rsyslog===

If you prefer using systemd instead of screen to run your VS Server, you can follow these Instructions.<br>

We also will setup rsyslog to split all logs into separate files.<br>

==== Installation ====

   adduser --shell /bin/bash --disabled-password gameserver

   mkdir -p /srv/gameserver/vintagestory

   mkdir -p /srv/gameserver/data/vs

   mkdir -p /usr/lib/systemd/system

'''3. Download the game'''

   cd /srv/gameserver/vintagestory

Goto http://account.vintagestory.at/downloads<br>

'''4. Extract tar.gz package'''

'''5. Change owner'''

You have to set the owner of your gameserver directory to avoid write permission errors

   chown -R gameserver:gameserver /srv/gameserver

'''6. Create systemd service unit file'''

Use your favourite tool to create a service unit file (this example uses nano)

   nano /usr/lib/systemd/system/vintagestoryserver.service

   [Service]

   WorkingDirectory=/srv/gameserver/vintagestory

   Restart=always

   RestartSec=30

   [Install]

   WantedBy=multi-user.target

'''7. Create config file for rsyslog'''

Use your favourite tool to create a rsyslog config file (this example uses nano)

   nano /etc/rsyslog.d/vintagestoryserver.conf

   # Discard  

   if $programname == 'VSSRV' then ~

'''8. restart rsyslog / enable service'''

To activate rsyslog and your vintagestory server type these commands

   systemctl enable vintagestoryserver.service

   systemctl start vintagestoryserver.service

----

==== Stop, Start, Disable Server ====

To manually stop your VS Server use this command

   systemctl stop vintagestoryserver.service

To disable the service use

   systemctl disable vintagestoryserver.service

==== Config ====

to change your servers configuration, stop the server and edit

   nano /srv/gameserver/data/vs/serverconfig.json

After you saved your changes, start server again.

==== Restart schedule ====

If you want your server to restart every day, you can setup a cronjob for this

   crontab -e

If you just want to restart the server this line instead of the other two should be fine

   30 4 * * *      systemctl restart vintagestoryserver.service

==== Logging ====

The rsyslog config splits the output logs into seperate files that you can watch with tail command<br>

For Login/Logout see

For all other messages see

   tail -f /var/log/vintagestory-server/other.log

==== Multiple Server Instances ====

If you want to run multiple instances on the same machine you just have to redo some of the steps above. This is just an example for a second instance:

   nano /usr/lib/systemd/system/vintagestoryserver2.service

Copy from step 6 and change these lines:

   Description=Vintage Story Server 2 Unit

   SyslogIdentifier=VSSRV2

Create rsyslog file and copy code from step 7

Insert

   30 4 * * *      systemctl restart vintagestoryserver2.service

Have Fun!