floppyrj45/dauphincraft
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

86
docs/joueur/controles.rst Normal file
View File

@@ -0,0 +1,86 @@
Contrôles
=========
Toutes les touches sont configurables dans les paramètres du jeu (**Échap → Paramètres → Touches**).
Voici la configuration par défaut.
Déplacement
-----------
+---------------------+------------------+
| Action | Touche par défaut|
+=====================+==================+
| Nager en avant | W |
+---------------------+------------------+
| Reculer | S |
+---------------------+------------------+
| Strafe gauche | A |
+---------------------+------------------+
| Strafe droit | D |
+---------------------+------------------+
| Monter | Espace |
+---------------------+------------------+
| Descendre | Shift |
+---------------------+------------------+
| Boost de nage | Ctrl |
+---------------------+------------------+
.. note::
Le **boost** consomme de l'énergie (jauge bleue en bas à droite du HUD). Il se recharge
automatiquement au repos.
Capacités spéciales
-------------------
+-----------------------------+------------------+
| Action | Touche par défaut|
+=============================+==================+
| Écholocation | E |
+-----------------------------+------------------+
| Activer / Désactiver la HUD | H |
+-----------------------------+------------------+
L'**écholocation** envoie une impulsion sonore qui révèle les blocs et mobs environnants
dans un rayon de 20 unités, même dans les zones sombres.
Interaction avec le monde
--------------------------
+----------------------------+------------------+
| Action | Touche par défaut|
+============================+==================+
| Casser un bloc | Clic gauche |
+----------------------------+------------------+
| Poser un bloc | Clic droit |
+----------------------------+------------------+
| Changer de slot (hotbar) | Molette souris |
+----------------------------+------------------+
| Ouvrir l'inventaire | Tab |
+----------------------------+------------------+
Interface
---------
+----------------------------+------------------+
| Action | Touche par défaut|
+============================+==================+
| Ouvrir le chat | F2 |
+----------------------------+------------------+
| Menu pause | Échap |
+----------------------------+------------------+
Chat
----
En multijoueur, appuyez sur **F2** pour ouvrir la fenêtre de chat. Tapez votre message et
validez avec **Entrée**. Appuyez sur **Échap** pour fermer le chat sans envoyer.
Menu pause
----------
Appuyez sur **Échap** pour mettre le jeu en pause. Le menu propose :
- **Reprendre** : retour au jeu.
- **Paramètres** : audio, vidéo, contrôles.
- **Quitter** : retour au menu principal.

112
docs/joueur/craft.rst Normal file
View File

@@ -0,0 +1,112 @@
Crafting — Recettes
===================
Le système de crafting permet de transformer des ressources collectées en objets utiles.
Ouvrez l'inventaire (**Tab**), puis accédez à l'onglet **Crafting** pour voir les recettes disponibles.
Comment crafter
---------------
1. Ouvrez l'inventaire avec **Tab**.
2. Sélectionnez l'onglet **Crafting**.
3. Les recettes disponibles (ingrédients présents en inventaire) s'affichent en surbrillance.
4. Cliquez sur la recette souhaitée pour fabriquer l'objet.
Recettes disponibles
--------------------
Lampe bio
~~~~~~~~~
Éclaire une zone de 10 blocs de rayon. Indispensable dans les abysses.
+------------------+----------+----------------------+
| Ingrédient | Quantité | Résultat |
+==================+==========+======================+
| Corail Bleu | 2 | Lampe bio × 1 |
+------------------+----------+ |
| Kelp | 1 | |
+------------------+----------+----------------------+
Harpon
~~~~~~
Arme à distance. Permet d'attaquer les mobs de loin (portée 12 unités, dégâts −4 PV).
+------------------+----------+----------------------+
| Ingrédient | Quantité | Résultat |
+==================+==========+======================+
| Roche | 2 | Harpon × 1 |
+------------------+----------+ |
| Épave | 2 | |
+------------------+----------+----------------------+
Bulle d'air
~~~~~~~~~~~
Consommable d'urgence. Recharge instantanément 50 % de la jauge d'oxygène.
+------------------+----------+----------------------+
| Ingrédient | Quantité | Résultat |
+==================+==========+======================+
| Kelp | 3 | Bulle d'air × 1 |
+------------------+----------+ |
| Glace | 1 | |
+------------------+----------+----------------------+
.. note::
La **Glace** se trouve uniquement dans les zones profondes (abysses, 80 m+).
Algue cuisinée
~~~~~~~~~~~~~~
Nourriture. Restaure 30 % de la jauge de faim.
+------------------+----------+----------------------+
| Ingrédient | Quantité | Résultat |
+==================+==========+======================+
| Kelp | 2 | Algue cuisinée × 2 |
+------------------+----------+----------------------+
.. tip::
Recette très accessible dès le début. La forêt de kelp est le meilleur endroit pour
farmer le Kelp.
Armure écailles
~~~~~~~~~~~~~~~
Protection passive. Réduit les dégâts reçus de 25 % (toutes sources).
+------------------+----------+----------------------+
| Ingrédient | Quantité | Résultat |
+==================+==========+======================+
| Corail Rouge | 4 | Armure écailles × 1 |
+------------------+----------+ |
| Épave | 2 | |
+------------------+----------+----------------------+
.. warning::
L'armure se casse après 50 impacts. Craftez-en une de rechange avant de partir
explorer les épaves ou les abysses.
Ressources et où les trouver
----------------------------
+-------------------+---------------------------+
| Ressource | Biome / Source |
+===================+===========================+
| Corail Bleu | Récif corallien |
+-------------------+---------------------------+
| Corail Rouge | Récif corallien |
+-------------------+---------------------------+
| Kelp | Forêt de kelp |
+-------------------+---------------------------+
| Roche | Épaves, fond marin |
+-------------------+---------------------------+
| Épave | Zones d'épaves |
+-------------------+---------------------------+
| Glace | Abysses (80 m+) |
+-------------------+---------------------------+

74
docs/joueur/installation.rst Normal file
View File

@@ -0,0 +1,74 @@
Installation — Guide joueur
===========================
Configuration minimale requise
-------------------------------
+--------------------+-----------------------------------------------+
| Composant | Minimum requis |
+====================+===============================================+
| Système | Windows 10 / Windows 11 (64 bits) |
+--------------------+-----------------------------------------------+
| RAM | 4 Go |
+--------------------+-----------------------------------------------+
| GPU | Compatible Vulkan 1.0 ou DirectX 12 |
+--------------------+-----------------------------------------------+
| Stockage | 500 Mo d'espace libre |
+--------------------+-----------------------------------------------+
| Réseau | Connexion Internet (multijoueur uniquement) |
+--------------------+-----------------------------------------------+
Téléchargement
--------------
La dernière version de DauphinCraft est disponible sur le dépôt officiel :
.. code-block:: text
http://<gitea-host>/dauphincraft/releases
Téléchargez l'archive ``DauphinCraft-v0.1.0-windows.zip`` correspondant à votre système.
.. note::
Remplacez ``<gitea-host>`` par l'adresse fournie par votre administrateur ou la communauté.
Procédure d'installation
------------------------
1. Décompressez l'archive ``DauphinCraft-v0.1.0-windows.zip`` dans le dossier de votre choix.
2. Ouvrez le dossier extrait.
3. Double-cliquez sur ``DauphinCraft.exe`` pour lancer le jeu.
Aucune installation supplémentaire n'est nécessaire. Le jeu est autonome (portable).
Dépannage antivirus
-------------------
Windows Defender ou votre antivirus peut bloquer le lancement car l'exécutable n'est pas signé.
**Solution :**
1. Clic droit sur ``DauphinCraft.exe`` → **Propriétés**.
2. En bas de l'onglet *Général*, cochez **Débloquer** si la case est présente.
3. Cliquez sur **Appliquer**, puis **OK**.
4. Relancez ``DauphinCraft.exe``.
Si votre antivirus met en quarantaine le fichier, ajoutez une exception pour le dossier
d'installation de DauphinCraft.
.. warning::
Téléchargez toujours DauphinCraft depuis le dépôt officiel. Ne faites pas confiance à des
sources tierces inconnues.
Première connexion
------------------
Au premier lancement, le jeu vous propose trois modes :
- **Solo** : jouer seul en monde local.
- **Héberger** : créer une partie multijoueur sur votre machine.
- **Rejoindre** : rejoindre une partie existante avec une IP et un port.
Voir :doc:`multijoueur` pour les détails réseau.

86
docs/joueur/mecaniques.rst Normal file
View File

@@ -0,0 +1,86 @@
Mécaniques de jeu
=================
Jauges du joueur
----------------
Trois jauges sont visibles en permanence dans le HUD (en bas de l'écran) :
**Oxygène (jauge bleue)**
Représente l'air restant dans les poumons du dauphin. Elle diminue lorsque vous évoluez
sous l'eau sans remonter à la surface. À zéro, vous perdez de la vie rapidement.
Remontez à la surface pour la recharger instantanément.
**Vie (jauge rouge)**
Points de vie du dauphin. Diminue en cas d'attaque par un mob hostile ou de manque
d'oxygène prolongé. Se régénère lentement en nageant sans contrainte, ou plus vite
en consommant de la nourriture.
**Faim (jauge orange)**
Représente la satiété. Diminue au fil du temps et lors d'actions intenses (boost, écholocation).
Si la jauge de faim atteint zéro, la régénération de vie s'arrête.
Gestion de l'oxygène
--------------------
Votre dauphin a besoin de respirer. La surface de l'eau correspond à la limite supérieure
du monde. Remontez régulièrement pour éviter de vous noyer.
- Sous **50 % d'oxygène** : la jauge clignote doucement.
- Sous **20 % d'oxygène** : la jauge clignote rapidement et un son d'alerte retentit.
- À **0 %** : vous perdez 1 PV par seconde jusqu'à la remontée.
.. tip::
Craftez une **Bulle d'air** (voir :doc:`craft`) pour obtenir une réserve d'oxygène
supplémentaire d'urgence.
Biomes sous-marins
------------------
Le monde est généré de façon procédurale et comporte quatre biomes principaux :
**Récif corallien**
Zone peu profonde (0–30 m), lumineuse, riche en coraux et poissons. Idéal pour débuter.
On y trouve du **Corail Bleu** et du **Corail Rouge**.
**Forêt de kelp**
Zone intermédiaire (20–60 m). Grandes algues offrant une visibilité réduite.
Source principale de **Kelp** et de **Kelp_Food**.
**Abysses**
Zone profonde (80 m et plus). Obscurité totale sans lampe bio. Ressources rares
mais mobs dangereux (Requins).
**Épaves**
Zones ponctuelles à toutes profondeurs. Recèlent de la **Roche** et de l'**Épave**
(matériaux pour recettes avancées). Attention aux Requins patrouillant les épaves.
Mobs
----
Trois types de créatures peuplent les océans de DauphinCraft :
**Bancs de poissons (FishSchool)**
Neutres. Nagent en groupe de manière aléatoire. Source de nourriture si attaqués.
Comportement de fuite à l'approche du joueur.
**Méduses (Jellyfish)**
Passives mais infligent des dégâts de contact si on les touche (−1 PV par contact).
Lumineuses, elles sont utiles comme repères dans les abysses.
**Requin (Shark)**
Hostile. Attaque le joueur à vue dans un rayon de 15 unités. Inflige −3 PV par morsure.
Peut être repoussé avec une **impulsion d'écholocation** (touche E).
Mort et respawn
---------------
Quand vos points de vie atteignent zéro, vous mourez. Un écran de mort s'affiche.
- Vos blocs posés dans le monde restent en place.
- Votre inventaire est conservé.
- Vous réapparaissez au point de spawn initial (centre du monde, en surface).
En multijoueur, les autres joueurs continuent de jouer pendant votre respawn. Le délai
de respawn est de **3 secondes**.

78
docs/joueur/multijoueur.rst Normal file
View File

@@ -0,0 +1,78 @@
Multijoueur
===========
DauphinCraft supporte jusqu'à **16 joueurs simultanés** via une architecture réseau ENet UDP.
Modes de jeu
------------
**Solo**
Jouer seul en monde local. Aucune connexion réseau requise. La partie n'est pas accessible
aux autres joueurs.
**Héberger une partie**
Lancez un serveur depuis votre propre machine. Les joueurs de votre réseau local (ou Internet
si vous configurez votre routeur) peuvent vous rejoindre.
**Rejoindre une partie**
Entrez l'adresse IP et le port d'une partie existante pour la rejoindre.
Port réseau
-----------
DauphinCraft utilise le port **UDP 7777** par défaut.
Pour héberger une partie accessible depuis Internet :
1. Ouvrez les paramètres de votre box/routeur.
2. Créez une règle de redirection de port (NAT/PAT) :
- **Port externe** : 7777 (UDP)
- **Port interne** : 7777 (UDP)
- **IP locale cible** : l'adresse IP locale de votre machine (ex. 192.168.1.10)
3. Communiquez votre **IP publique** et le port **7777** à vos amis.
.. tip::
Pour trouver votre IP publique, allez sur ``https://ifconfig.me`` dans un navigateur.
Rejoindre une partie
--------------------
Dans le menu principal, choisissez **Rejoindre**, puis entrez :
- **Adresse IP** : l'IP fournie par l'hôte (ex. ``203.0.113.42``).
- **Port** : ``7777`` (ou le port personnalisé communiqué par l'hôte).
Cliquez sur **Connexion**. Si le serveur est disponible, vous rejoindrez la partie en quelques
secondes.
Héberger depuis le jeu
-----------------------
Choisissez **Héberger** dans le menu principal. Le jeu démarre un serveur intégré (écoute sur
le port 7777 UDP) tout en vous permettant de jouer simultanément.
.. note::
L'hébergement intégré est pratique pour des sessions entre amis. Pour un serveur permanent
24h/24, consultez :doc:`../admin/installation_serveur`.
Serveur public officiel
------------------------
Un serveur public de démonstration est disponible à l'adresse :
.. code-block:: text
http://example.invalid (à remplacer lors du déploiement)
.. warning::
Ce serveur est fourni à titre de démonstration. Il peut être indisponible ou réinitialisé
sans préavis.
Limite de joueurs
-----------------
La limite par défaut est **16 joueurs** par session. Elle peut être modifiée par l'administrateur
du serveur (voir :doc:`../admin/configuration`).