Setting up a Multiplayer Server/fr

Installation Basique

Serveur Ad-hoc

Si vous cherchez une expérience multijoueur temporaire il est possible d'ouvrir un monde en mode solo et de cliquer sur "Ouvrir au LAN" dans le menu des options. Cela permettra aux joueurs sur le même réseau local de vous rejoindre. Si vous souhaitez ouvrir votre partie à des joueurs au-delà de votre connexion locale, vous pouvez aussi cliquer sur "Ouvrir à internet", ce qui tentera d'établir une connexion externe pour rejoindre votre serveur depuis internet. Cela est possible par une technique appelée UPnP et doit être activé sur votre box internet, l'UPnP est souvent activé par défaut sur la plupart des fournisseurs d'accès. Il y a 60 % de chances que "Ouvrir à internet" fonctionne instantanément sans problème. Sinon, vous devrez effectuer une "Redirection de ports" depuis votre box. Vous devrez rediriger le port TCP 42420 afin de permettre l'accès extérieur. (Vous pouvez trouver des renseignements supplémentaires sur internet en recherchant "Redirection de ports" avec le modèle de votre box internet).

Pour que ce serveur fonctionne, une partie solo doit être lancée en continu sur l'ordinateur d'un des joueurs.

---

Serveur Dédié

Quand le jeu est installé, il installe également un programme de serveur dédié que vous pouvez exécuter et laisser activé en permanence sans avoir besoin d'être présent sur le jeu vous-même. Il existe différentes manières d'installer et de lancer un serveur dédié.

Hôtes payants

See List of server hosting providers

Serveurs dédiés sur Windows

To keep your multiplayer server's settings from interfering with your single-player settings, use a custom --dataPath argument.

Shortcut method:

1. Navigate to the location where you will store the server's data, such as a new VintagestoryServer folder created in C:\Users\YourUsername\AppData\Roaming
2. Create a folder for the server's data and give it a clear name, such as VSserverData
3. Open that folder and copy the entire path from the address bar of File Explorer. (example: C:\Users\YourUsername\AppData\Roaming\VintagestoryServer\VSserverData)
4. Open the game's application folder, it is %appdata%/VintageStory by default.
5. Create a shortcut of VintagestoryServer.exe. This can usually be accomplished through the right-click menu; google instructions specific to your operating system version if needed.
6. Open the Properties of the new shortcut. This can usually be accomplished through the right-click menu.
7. Click in the Target field of the shortcut's Properties, then go to the very end of what's written there. Add one space, then --dataPath=, then Paste the folder path you copied earlier, in quotes. The entire contents of the Target field should now be something like this: "C:\Users\YourUsername\AppData\Roaming\Vintagestory\VintagestoryServer.exe" --dataPath="C:\Users\YourUsername\AppData\Roaming\VintagestoryServer\VSserverData"

• Optional: you can move/copy the shortcut, to your desktop and/or your new VintagestoryServer folder

Batch script method (functionally equivalent to the shortcut method above):

1. To create a batch script, simply create a blank text document and rename it with the .bat file extension.
2. You can edit it by right clicking and selecting edit. Then just type %appdata%/Vintagestory/VintagestoryServer.exe --dataPath "[PATH]" replacing [PATH] with the desired path for the server's data, then save and close.

Running the script will run the server with the alternate datapath, and will generate its own collection of config files there. This is functionally equivalent to the modified link.

• Ouvrez le dossier contenant le jeu (%appdata%/VintageStory par défaut)
• Lancez VintagestoryServer.exe.
• Vous pouvez configurer une redirection des ports de votre routeur internet si vous voulez que votre serveur soit accessible au-delà de votre réseau local.

---

Using Windows on a virtual machine

There are some reports that LAN connection to a Vintage Story server running inside a Windows virtual machine (VM) can be slow, even when internet (WAN) connections have normal performance. This may depend on VM solution and network drivers. If this affects you, a suggested workaround is to use the Paravirtualized network adapter (virtio-net) for network adapters. The drivers are located here.

---

Serveurs dédiés sur Linux

Cette section explique comment mettre en place un serveur dédié en tant que service sur les systèmes Linux.
Remarque : Ce qui suit fonctionne uniquement pour les processeurs x64. Si vous utilisez ARM, veuillez vous référer à la section suivante.

Prérequis

• .NET Runtime 7.0 Ceci devrait être tout ce qui est nécessaire pour faire fonctionner un serveur Vintagestory. Tout le reste ne sert qu'à faciliter le démarrage et la gestion du serveur.
• installez pgrep, screen et wget en utilisant le gestionnaire de paquets de votre système.

Mise en place du serveur

1. Télécharger le jeu

Conseil : Créez un dossier différent pour Vintage Story étant donné que le tar.gz ne contient pas de sous-dossier.

 mkdir server && cd server

Allez sur http://account.vintagestory.at/downloads
Copiez le lien du dernier paquet "vs_server_linux-x64_*.*.*.tar.gz" (Linux Server (.tar.gz) dans la partie Show other available downloads of Vintage Story)
Téléchargez avec "wget" depuis la console (Vintage Story version 1.18.8 dans cet exemple).

 wget https://cdn.vintagestory.at/gamefiles/stable/vs_server_linux-x64_1.18.8.tar.gz

2. Extraire le paquet tar.gz

 tar xzf vs_server_linux-x64_*.*.*.tar.gz

3. Faire de server.sh un script exécutable

 chmod +x server.sh

4. Éditer le fichier server.sh

Pour des raisons de sécurité, vous ne devriez pas lancer votre serveur en tant que root, le nom d'utilisateur par défaut USERNAME sera défini sur "vintagestory". Sur la plupart des systèmes d'exploitations Linux, vous pouvez créer un nouvel utilisateur avec la commande "adduser".

 adduser vintagestory

Puis changez ces options par rapport à vos besoins :

 USERNAME='<le-nom-d'utilisateur-pour-votre-serveur-VS>'
 VSPATH='<le-chemin-du-dossier-du-jeu>'

5. Ouvrir les ports sur votre pare-feu (si nécessaire)

firewalld

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

iptables

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

6. Lancement du serveur et premiers pas

 ./server.sh start

 Attendez la fin du démarrage puis donnez vous les droits administrateurs (OP) avec :
 ./server.sh command "/op <votre_nom_d'utilisateur>"

7. Connectez vous à votre IP/Domaine et amusez-vous !

---

Serveur dédié sur ARM64

Remarque : Notez que la version ARM64 est EXPÉRIMENTALE. Merci de signaler les problèmes éventuels sur le discord

Currently (in game version 1.19.3 - 1.19.4, February 2024) no ARM64 .NET7 version of the Harmony patching library is available. Therefore coded mods which use Harmony will not work on an ARM64 server. If a beta of the Harmony library becomes available in future, server owners can try installing it for themselves.

La version ARM64 est disponible sur GitHub

Il est recommandé d'utiliser le script d'installation situé sur GitHub. Ce qui suit est un guide étape par étape sur la façon d'utiliser le script sur un système basé sur Debian (Ubuntu, Debian, Rasbian, etc).

1. Installez les dépendances nécessaires à l'utilisation de ce script en procédant comme suit apt -y install curl jq

2. Créez un nouveau fichier nommé arminstall.sh en exécutant vim arminstall.sh ou nano arminstall.sh

3. Copiez le contenu du fichier arminstall.sh depuis GitHub vers le fichier que vous venez de créer et faites une sauvegarde en faisant :wq avec Vim ou Ctrl + X, puis Y, puis Enter avec Nano.

4. Rendez le script exécutable en tapant chmod +x arminstall.sh

5. Lancez le script en tapant ./arminstall.sh

6. Démarrez le serveur en tapant ./VintagestoryServer ou dotnet VintagestoryServer.dll

Ceci téléchargera la dernière version de Vintagestory dans le répertoire de travail actuel, puis remplacera les fichiers nécessaires pour fonctionner avec ARM.

Si, à un moment donné, vous souhaitez mettre à jour la dernière version de Vintage Story, il vous suffit de relancer le script.

---

Commande simple de démarrage du serveur

Si vous souhaitez utiliser un script personnalisé ou simplement démarrer manuellement votre serveur, vous pouvez lancer

dotnet VintagestoryServer.dll --dataPath /path/to/data

Ou

./VintagestoryServer --dataPath /path/to/data

si la variable d'environnement DOTNET_ROOT est définie.

Mettre à jour le serveur

Si vous souhaitez installer une version plus récente, retirez tous les fichiers de l'ancienne installation. Si vous avez choisi de mettre vos données de jeu dans le dossier d'installation, faites attention à ne pas le supprimer ou vous pourriez perdre vos sauvegardes, configurations et données de joueur. Téléchargez le dernier fichier "Tar.gz Archive/Linux (server only)" et extrayez-le. Si vous ne possédez qu'une connexion FTP à votre serveur distant, vous devrez extraire localement le serveur et transférer chaque fichier un par un.

Configuration Basique

Une fois votre serveur lancé, vous pourriez chercher à modifier certaines options de configuration. Vous pouvez configurer votre serveur pendant son fonctionnement à travers des commandes ou lorsque le serveur est arrêté en éditant le fichier serverconfig.json . Sur Windows, le fichier se trouve par défaut à %appdata%/VintageStoryData/serverconfig.json. Sur Linux, le fichier se trouve à ./data/serverconfig.json du dossier de votre serveur (par exemple : /home/vintagestory/server/data/serverconfig.json si installé de la même manière qu'ici).

Remarque : La manière la plus facile de configurer les paramètres de votre monde est de le créer en mode solo en utilisant les options avancées de création de monde, pour ensuite envoyer ses fichiers pour l'utiliser en tant que monde de serveur.

Des explications sur les données de "serverconfig.json" peuvent être trouvées ici : Configuration Serveur

Voici quelques configurations par commandes que vous souhaiteriez typiquement mettre.

• /serverconfig upnp [0|1]
  Si paramétré sur 1, le serveur de jeu tentera de rediriger les ports à votre place.
• /serverconfig name Serveur PvE Pacifique
  Paramètre le nom du serveur visible sur la liste des serveurs publics.
• /serverconfig description Ceci est un serveur de survie médiévale, PvE uniquement, bienvenue à tous ! <3
  Paramètre la description du serveur visible sur la liste des serveurs publics.
• /serverconfig motd Salut {playername} ! N'oublie pas de suivre les règles du serveur !
  Le message de bienvenue quand un joueur rejoint le serveur.
• /serverconfig password azerty
  Permet d'empêcher l'accès au serveur par un mot de passe. Utilisez /serverconfig nopassword pour de nouveau donner l'accès public.
• /serverconfig advertise (1|0)
  Permet d'afficher ou non le serveur sur la liste des serveurs publics.

Pour terminer, vous pouvez de la même manière configurer un serveur créé avec "Ouvrir au LAN", attention cependant, certaines configurations seront directement remises par défaut, par exemple l'emplacement des fichiers de sauvegarde.

Acquérir les droits administrateurs

Si vous avez accès à la console du serveur, tapez directement /op nom_du_joueur. Sinon, ouvrez le "serverconfig.json" et remplacez : "StartupCommands": null, avec : "StartupCommands": "/op nom_du_joueur",

Dans les deux cas, vous devez remplacer nom_du_joueur avec votre véritable nom de joueur.

Serveur dédié avancé

Debian avec systemd et rsyslog

Si vous préférez utiliser systemd au lieu de screen pour faire fonctionner votre serveur VS, vous pouvez suivre ces instructions.
Nous allons également configurer rsyslog pour séparer tous les journaux d'états dans des fichiers distincts.

Installation

1. Créer un utilisateur

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

2. Créer les dossiers

 mkdir -p /srv/gameserver/vintagestory
 mkdir -p /srv/gameserver/data/vs
 mkdir -p /usr/lib/systemd/system

3. Télécharger le jeu

 cd /srv/gameserver/vintagestory

Allez sur http://account.vintagestory.at/downloads
Copiez le lien du dernier paquet "vs_server_linux-x64_*.*.*.tar.gz" (Linux Server (.tar.gz) dans la partie Show other available downloads of Vintage Story)
Téléchargez avec "wget" depuis la console (Vintage Story version 1.18.8 dans cet exemple).

 wget https://cdn.vintagestory.at/gamefiles/stable/vs_server_linux-x64_1.18.8.tar.gz

4. Extraire le paquet tar.gz

 tar xzf vs_server_linux-x64_1.18.8.tar.gz

5. Changer les paramètres d'accès

Vous devez définir les droits d'accès du répertoire de votre serveur de jeux pour éviter les erreurs d'autorisations.

 chown -R gameserver:gameserver /srv/gameserver

6. Créer le fichier de service systemd

Utilisez votre logiciel de modification de fichier préféré pour créer un fichier de service (dans cet exemple nano).

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

Insérez le contenu suivant :

 [Unit]
 Description=Unite Serveur Vintage Story
 After=network.target
 
 [Service]
 WorkingDirectory=/srv/gameserver/vintagestory
 ExecStart=dotnet VintagestoryServer.dll --dataPath /srv/gameserver/data/vs
 Restart=always
 RestartSec=30
 StandardOutput=syslog
 StandardError=syslog
 SyslogIdentifier=VSSRV
 User=gameserver
 Group=gameserver
 
 [Install]
 WantedBy=multi-user.target

Assurez-vous que le nouvel utilisateur a accès à la commande dotnet ou remplacez la commande avec le chemin complet là où vous avez installé la routine dotnet (si vous avez utilisé une installation personnalisée). Ou bien vous pouvez aussi utiliser ExecStart=VintagestoryServer --dataPath /srv/gameserver/data/vs si la variable d'environnement DOTNET_ROOT a été définie.

7. Créer un fichier de configuration pour rsyslog

Utilisez votre logiciel de modification de fichier préféré pour créer un fichier de service (dans cet exemple nano).

 nano /etc/rsyslog.d/vintagestoryserver.conf

Insérez le contenu suivant :

 if $programname == 'VSSRV' then {
     if($msg contains "Chat") then {
         action(type="omfile" dirCreateMode="0755" FileCreateMode="0644" File="/var/log/vintagestory-server/chat.log")
     } else if($msg contains "verließ") then {
         action(type="omfile" dirCreateMode="0755" FileCreateMode="0644" File="/var/log/vintagestory-server/login.log")
     } else if($msg contains "join") then {
         action(type="omfile" dirCreateMode="0755" FileCreateMode="0644" File="/var/log/vintagestory-server/login.log")
     } else if($msg contains "Server Warning") then {
         action(type="omfile" dirCreateMode="0755" FileCreateMode="0644" File="/var/log/vintagestory-server/warn.log")
     } else if($msg contains "Server Notification") then {
         action(type="omfile" dirCreateMode="0755" FileCreateMode="0644" File="/var/log/vintagestory-server/info.log")
     } else if($msg contains "Server Debug") then {
         action(type="omfile" dirCreateMode="0755" FileCreateMode="0644" File="/var/log/vintagestory-server/debug.log")
     } else if($msg contains "Server Event") then {
         action(type="omfile" dirCreateMode="0755" FileCreateMode="0644" File="/var/log/vintagestory-server/event.log")
     } else {
         action(type="omfile" dirCreateMode="0755" FileCreateMode="0644" File="/var/log/vintagestory-server/other.log")
     }
 }
 # Discard 
 if $programname == 'VSSRV' then ~

8. Redémarrer rsyslog / activer le service Pour activer rsyslog et votre serveur vintagestory, tapez les commandes suivantes :

 systemctl restart rsyslog.service;
 systemctl enable vintagestoryserver.service
 systemctl start vintagestoryserver.service

---

Arrêter, Démarrer, Désactiver le Serveur

Pour arrêter manuellement votre serveur VS, utilisez la commande suivante :

 systemctl stop vintagestoryserver.service

Pour redémarrer manuellement votre serveur VS, tapez :

 systemctl start vintagestoryserver.service

Pour désactiver le service, utilisez :

 systemctl disable vintagestoryserver.service

Configuration

Pour modifier la configuration de votre serveur, arrêtez-le et modifiez le fichier suivant :

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

Après avoir enregistré vos modifications, redémarrez le serveur.

Redémarrage programmé

Si vous souhaitez que votre serveur redémarre tous les jours, vous pouvez créer un cronjob de la manière suivante :

 crontab -e

Insérez cette ligne pour arrêter le serveur à 04h30 :

 30 4 * * *      systemctl stop vintagestoryserver.service

Vous pouvez maintenant exécuter des tâches de sauvegarde et les relancer avec la ligne suivante à 04:32 (si vous exécutez une sauvegarde, planifiez un peu plus de temps) :

 32 4 * * *      systemctl start vintagestoryserver

Si vous souhaitez simplement redémarrer le serveur, utilisez plutôt cette ligne :

 30 4 * * *      systemctl restart vintagestoryserver.service

Journalisation

La configuration de rsyslog divise les journaux du serveur en fichiers distincts que vous pouvez consulter avec la commande "tail".
Pour les connexions et déconnexions :

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

Pour tous les messages de chat :

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

Pour tous les messages contenant [Server Warning] :

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

Pour tous les messages contenant [Server Notification] :

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

Pour tous les messages contenant [Server Debug] :

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

Pour tous les messages contenant [Server Event] :

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

Pour tous les autres messages :

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

Instances multiples de serveurs

Si vous souhaitez utiliser plusieurs instances sur la même machine, il vous suffit de refaire certaines des étapes ci-dessus. Voici un exemple pour une deuxième instance :

 mkdir -p /srv/gameserver/data/vs2
 nano /usr/lib/systemd/system/vintagestoryserver2.service

Copiez le texte de l'étape 6 et modifiez ces lignes :

 Description=Vintage Story Server 2 Unit
 ExecStart=dotnet VintagestoryServer.dll --dataPath /srv/gameserver/data/vs2
 SyslogIdentifier=VSSRV2

Créez un fichier rsyslog et copiez le code de l'étape 7 :

 nano /etc/rsyslog.d/vintagestoryserver2.conf

Changez VSSRV en VSSRV2 et /var/log/vintagestory-server en /var/log/vintagestory-server2
Avant de procéder, faites une copie de votre première configuration de serveur et modifiez-la en fonction de vos besoins (n'oubliez pas de changer les ports !!!).

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

Démarrez maintenant le service :

 systemctl restart rsyslog.service;
 systemctl enable vintagestoryserver2.service
 systemctl start vintagestoryserver2.service

Installez cronjob :

 crontab -e

Terminez avec :

 30 4 * * *      systemctl restart vintagestoryserver2.service

Amusez-vous bien !

Configuration avancée

Utilisation d'un enregistrement SRV pour diriger un domaine vers votre serveur

Dans certains cas, il se peut que vous ne puissiez pas obtenir un serveur avec le port par défaut (instances multiples sur le même serveur, hôtes payants...), et vous devrez ajouter le port à la fin de l'adresse du serveur afin de vous y connecter.
Mais il se peut que vous souhaitiez éviter d'avoir à spécifier le port (plus facile à retenir, plus propre). Il existe un moyen de faire pointer un domaine vers votre serveur et d'éviter d'avoir à ajouter le port : les enregistrements SRV

Les enregistrements SRV vous permettent de faire pointer un domaine/sous-domaine vers votre instance, tout en indiquant au jeu le port à utiliser.
La manière de configurer les enregistrements SRV dépend de votre fournisseur de domaine, et vous devriez consulter sa documentation avant d'effectuer des changements. Cependant, l'idée et les valeurs restent les mêmes pour chaque fournisseur.

Prenons un serveur avec les détails suivants :

• Addresse : play.example.com
• Port : 50030
• Domaine propre : mydomain.com
• Sous-domaine souhaité : vintagestory.mydomain.com

Vos enregistrements SRV bruts devraient ressembler à ceci :

 _vintagestory._tcp.vintagestory.mydomain.com.   IN  SRV 10 10 50030 server.example.com.

Les traits de soulignement et les points sont importants ! Voici quelques détails :

• _vintagestory définit le service, dans notre cas, Vintage Story
  
• _tcp définit le protocole, Vintage Story utilise TCP
  
• vintagestory.mydomain.com. est le sous-domaine que nous voulons utiliser. Le point final est important !
  
• IN SRV Définit le type d'enregistrement, ne modifiez pas ceci
  
• 10 10 sont dans l'ordre, la priorité et la pondération de notre enregistrement, dans notre cas ils ne sont pas important, car vous n'allez probablement pas équilibrer la charge d'un serveur Vintage Story
  
• 50030 est le port que notre instance va écouter
  
• server.example.com. est la cible, où notre serveur est situé. Le point final est obligatoire puisque le serveur ciblé n'est pas dans le même domaine que nous. Si c'était le cas, vous n'auriez besoin que d'ajouter le sous-domaine de la cible sans le point final
  

Si vous vouliez pointer votre enregistrement directement à votre domaine, vous auriez mydomain.com. au lieu de vintagestory.mydomain.com.

Voici comment procéder pour OVH et Hetzner (N'oubliez pas de modifier les valeurs pour les adapter à votre configuration !) :

OVH

Vous devrez aller dans votre zone DNS et ajouter une entrée, sélectionner le type d'enregistrement SRV :

• Sous-domaine : _vintagestory._tcp.vintagestory Vous n'avez pas besoin d'ajouter votre domaine, car leur formulaire le fait pour vous.
• TTL : Il n'est pas nécessaire de modifier ceci
• Priorité : 10
• Pondération : 10
• Port : 50030
• Cible : server.example.com.

Hetzner

Vous devrez créer un enregistrement à partir de leur console DNS :

• Type : SRV
• Nom : _vintagestory._tcp.vintagestory.mydomain.com.

Cliquez sur le champ Valeur pour entrer les détails :

• Priorité : 10
• Pondération : 10
• Port : 50030
• Cible : server.example.com.

Attendez quelques minutes pour que votre enregistrement se propage et essayez ensuite de l'utiliser pour vous connecter au serveur, en utilisant vintagestory.mydomain.com comme adresse.

Vous êtes maintenant prêt à partager votre serveur avec votre domaine personnalisé.