cafdb7d27e
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>
111 lines
2.9 KiB
ReStructuredText
111 lines
2.9 KiB
ReStructuredText
Contribuer au projet
|
|
====================
|
|
|
|
Outils nécessaires
|
|
------------------
|
|
|
|
- **Godot Engine 4.6.2** : téléchargez depuis https://godotengine.org/download
|
|
- **Git** : version 2.x ou supérieure
|
|
- Accès au dépôt Gitea de DauphinCraft
|
|
|
|
Cloner le dépôt
|
|
---------------
|
|
|
|
.. code-block:: bash
|
|
|
|
git clone http://<gitea-host>/dauphincraft/dauphincraft.git
|
|
cd dauphincraft
|
|
|
|
.. note::
|
|
|
|
Remplacez ``<gitea-host>`` par l'adresse du serveur Gitea communautaire.
|
|
|
|
Ouvrir le projet dans Godot
|
|
-----------------------------
|
|
|
|
1. Lancez Godot Engine 4.6.2.
|
|
2. Dans le gestionnaire de projets, cliquez sur **Import**.
|
|
3. Naviguez jusqu'au dossier cloné et sélectionnez ``project.godot``.
|
|
4. Cliquez sur **Import & Edit**.
|
|
|
|
Le projet s'ouvre directement dans l'éditeur. Appuyez sur **F5** pour lancer le jeu en mode éditeur.
|
|
|
|
Build et export
|
|
---------------
|
|
|
|
Les présets d'export sont configurés dans ``export_presets.cfg``.
|
|
|
|
**Exporter pour Windows :**
|
|
|
|
1. Menu **Projet → Exporter**.
|
|
2. Sélectionnez le préset **Windows Desktop**.
|
|
3. Cliquez sur **Exporter le projet** et choisissez un dossier de sortie.
|
|
|
|
**Exporter le serveur Linux :**
|
|
|
|
1. Menu **Projet → Exporter**.
|
|
2. Sélectionnez le préset **Linux Server**.
|
|
3. Cliquez sur **Exporter le projet**.
|
|
|
|
.. note::
|
|
|
|
Pour exporter vers Linux, vous devez avoir installé le template d'export Linux dans Godot
|
|
(**Éditeur → Gérer les modèles d'exportation**).
|
|
|
|
Style de code
|
|
-------------
|
|
|
|
- **Typage strict** : déclarez toujours les types explicitement (``var x: int = 0``).
|
|
- **Pas de TODO** laissé dans le code soumis — ouvrez une issue à la place.
|
|
- **Nommage** : ``snake_case`` pour les variables et fonctions, ``PascalCase`` pour les classes.
|
|
- **Commentaires** : en français, concis.
|
|
- **Signals** : préfixez les signaux avec le nom du composant (``dolphin_died``, ``chunk_loaded``).
|
|
|
|
Exemple de code conforme :
|
|
|
|
.. code-block:: gdscript
|
|
|
|
class_name DolphinController
|
|
extends CharacterBody3D
|
|
|
|
@export var speed: float = 5.0
|
|
var _oxygen: float = 1.0
|
|
|
|
func take_damage(amount: int) -> void:
|
|
# Réduit les PV et déclenche le signal si mort
|
|
health -= amount
|
|
if health <= 0:
|
|
emit_signal("dolphin_died")
|
|
|
|
Soumettre une contribution
|
|
---------------------------
|
|
|
|
1. Créez une branche depuis ``main`` :
|
|
|
|
.. code-block:: bash
|
|
|
|
git checkout -b feat/ma-fonctionnalite
|
|
|
|
2. Faites vos modifications et committez :
|
|
|
|
.. code-block:: bash
|
|
|
|
git add .
|
|
git commit -m "feat: description courte"
|
|
|
|
3. Poussez votre branche :
|
|
|
|
.. code-block:: bash
|
|
|
|
git push origin feat/ma-fonctionnalite
|
|
|
|
4. Ouvrez une **Pull Request** sur le Gitea de DauphinCraft.
|
|
|
|
5. Un mainteneur relit et fusionne après validation.
|
|
|
|
Discussion et support
|
|
----------------------
|
|
|
|
Rejoignez le serveur Discord communautaire et consultez le canal **#dauphincraft-dev**
|
|
pour poser vos questions, proposer des idées ou signaler des bugs.
|