docs: Sphinx manuel joueur/admin/dev + build HTML

Manuel complet DauphinCraft v0.1.0 : 14 pages RST (joueur, admin,
dev, annexes), conf.py rtd-theme, Makefile/make.bat, build HTML propre.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Floppyrj45
2026-04-19 17:57:47 +02:00
parent 9429360966
commit cafdb7d27e
128 changed files with 14093 additions and 0 deletions

View File

@@ -0,0 +1,79 @@
Configuration du serveur
========================
Fichier de service systemd
---------------------------
Le service est défini dans :
.. code-block:: text
/etc/systemd/system/dauphincraft.service
Contenu type :
.. code-block:: ini
[Unit]
Description=DauphinCraft Game Server
After=network.target
[Service]
User=dauphincraft
WorkingDirectory=/opt/dauphincraft
ExecStart=/opt/dauphincraft/DauphinCraft.x86_64 --headless --port 7777
Restart=on-failure
RestartSec=5s
StandardOutput=append:/var/log/dauphincraft.log
StandardError=append:/var/log/dauphincraft.log
[Install]
WantedBy=multi-user.target
Modifier le port d'écoute
--------------------------
1. Éditez le fichier service :
.. code-block:: bash
sudo nano /etc/systemd/system/dauphincraft.service
2. Modifiez la ligne ``ExecStart`` pour changer le port :
.. code-block:: text
ExecStart=/opt/dauphincraft/DauphinCraft.x86_64 --headless --port 9999
3. Rechargez la configuration et redémarrez le service :
.. code-block:: bash
sudo systemctl daemon-reload
sudo systemctl restart dauphincraft
4. N'oubliez pas d'ouvrir le nouveau port dans le pare-feu (voir :doc:`installation_serveur`).
Nombre maximum de joueurs
--------------------------
La limite de joueurs est définie à **16** par défaut dans le code source
(``scripts/net/NetworkManager.gd``). Cette valeur sera exposée en paramètre
de ligne de commande dans une version future.
Pour modifier temporairement la limite, il est actuellement nécessaire de recompiler
le projet avec la valeur souhaitée.
.. note::
Une option ``--max-players <N>`` sera ajoutée dans la version 0.2.0.
Sauvegarde du monde
-------------------
.. warning::
La sauvegarde persistante du monde n'est pas encore implémentée dans la version 0.1.0.
Le monde est régénéré à chaque redémarrage du serveur.
Cette fonctionnalité est prévue pour une version future.

View File

@@ -0,0 +1,96 @@
Installation du serveur
=======================
Ce guide décrit l'installation du serveur dédié DauphinCraft sur une machine Linux.
Prérequis
---------
+--------------------+-----------------------------------------------+
| Composant | Requis |
+====================+===============================================+
| Système | Debian 11+ ou Ubuntu 22.04 LTS (64 bits) |
+--------------------+-----------------------------------------------+
| RAM | 1 Go minimum |
+--------------------+-----------------------------------------------+
| Stockage | 500 Mo libres |
+--------------------+-----------------------------------------------+
| Réseau | IP publique ou réseau local avec NAT |
+--------------------+-----------------------------------------------+
| Port | UDP 7777 ouvert en entrée |
+--------------------+-----------------------------------------------+
| Droits | Accès root ou sudo |
+--------------------+-----------------------------------------------+
Extraction de l'archive
-----------------------
Téléchargez l'archive serveur depuis le dépôt officiel :
.. code-block:: bash
wget http://<gitea-host>/dauphincraft/releases/download/v0.1.0/DauphinCraft-Server-v0.1.tar.gz
Extrayez-la dans ``/opt`` :
.. code-block:: bash
sudo tar -xzf DauphinCraft-Server-v0.1.tar.gz -C /opt/
sudo mv /opt/DauphinCraft-Server /opt/dauphincraft
Installation
------------
Lancez le script d'installation fourni en tant que root :
.. code-block:: bash
cd /opt/dauphincraft
sudo bash install.sh
Ce script :
1. Crée un utilisateur système ``dauphincraft``.
2. Installe le fichier de service systemd dans ``/etc/systemd/system/dauphincraft.service``.
3. Active et démarre le service automatiquement.
Vérification du service
-----------------------
.. code-block:: bash
systemctl status dauphincraft
Une sortie de type ``Active: active (running)`` confirme que le serveur tourne correctement.
Ouverture du port pare-feu
---------------------------
Avec **ufw** (Ubuntu) :
.. code-block:: bash
sudo ufw allow 7777/udp
sudo ufw reload
Avec **iptables** :
.. code-block:: bash
sudo iptables -A INPUT -p udp --dport 7777 -j ACCEPT
sudo iptables-save > /etc/iptables/rules.v4
Consultation des logs
---------------------
Via **journalctl** (en temps réel) :
.. code-block:: bash
journalctl -u dauphincraft -f
Via le fichier de log :
.. code-block:: bash
tail -f /var/log/dauphincraft.log

View File

@@ -0,0 +1,96 @@
Maintenance du serveur
======================
Mise à jour du serveur
----------------------
Pour mettre à jour DauphinCraft vers une nouvelle version :
1. Téléchargez le nouveau tarball depuis le dépôt officiel :
.. code-block:: bash
wget http://<gitea-host>/dauphincraft/releases/download/vX.Y.Z/DauphinCraft-Server-vX.Y.Z.tar.gz
2. Arrêtez le service :
.. code-block:: bash
sudo systemctl stop dauphincraft
3. Sauvegardez l'ancienne version (optionnel mais recommandé) :
.. code-block:: bash
sudo cp -r /opt/dauphincraft /opt/dauphincraft.bak
4. Extrayez la nouvelle version :
.. code-block:: bash
sudo tar -xzf DauphinCraft-Server-vX.Y.Z.tar.gz -C /opt/
sudo rsync -a --exclude='logs' /opt/DauphinCraft-Server/ /opt/dauphincraft/
5. Relancez le service :
.. code-block:: bash
sudo systemctl start dauphincraft
systemctl status dauphincraft
Surveillance et logs
---------------------
**Consultation des logs en direct :**
.. code-block:: bash
journalctl -u dauphincraft -f
**Consultation des dernières lignes :**
.. code-block:: bash
tail -n 100 /var/log/dauphincraft.log
**Rotation des logs :** le service redirige stdout/stderr vers ``/var/log/dauphincraft.log``.
Pour éviter que ce fichier grossisse indéfiniment, configurez ``logrotate`` :
.. code-block:: bash
sudo nano /etc/logrotate.d/dauphincraft
Contenu suggéré :
.. code-block:: text
/var/log/dauphincraft.log {
daily
rotate 7
compress
missingok
notifempty
}
Vérification de l'état du serveur
-----------------------------------
.. code-block:: bash
systemctl is-active dauphincraft
Retourne ``active`` si le serveur est opérationnel, ``failed`` sinon.
Redémarrage automatique
------------------------
Le fichier de service inclut ``Restart=on-failure`` avec un délai de 5 secondes.
Le serveur redémarre donc automatiquement en cas de crash.
Gestion des joueurs (Kick / Ban)
----------------------------------
.. note::
Les commandes d'administration en jeu (kick, ban) sont prévues pour la version 0.2.0.
Aucune interface d'administration n'est disponible dans la version actuelle.