Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
HerbigniauxBenoit committed Mar 26, 2024
2 parents 9b78aac + 787c9c8 commit 545e58b
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# 🎮 Guide d'utilisation de votre projet Godot

Ce guide vous aidera à démarrer avec un nouveau projet Godot et la mise en place d'une CI vers un déploiement vers itch.io. Il permet de simplifier vos développements/tests lors de vos game jam.
Il se base sur le template que vous pouvez trouver ici: https://github.com/bitbrain/godot-gamejam avec mes commandaires/améliorations sur ça mise en place.

## 1. 🚧 Création de votre nouveau repository

Dans cette première étape, on doit mettre en place notre nouveau repository dans github.
Pour cela suivez ces étapes :
1. **Créez un nouveau repository sur GitHub :**
- Accédez à votre compte GitHub.
- Cliquez sur "Nouveau" pour créer un nouveau repository.
- Donnez-lui un nom, une description et choisissez les options appropriées.
- Cliquez sur "Create repository" pour le créer.

2. **Clonez votre repository sur votre machine locale :**
```bash
git clone <URL_de_votre_repository>
```

## 2. ⛔ Ajouter le .gitignore
Ajoutez votre fichiers .gitignore pour ignorer les fichiers non nécessaires. J'ai pris l'exemple du contenue du .gitignore fournis ici : https://github.com/github/gitignore/blob/main/Godot.gitignore pour m'inspirer. Je l'ai un peu modifier pour faire fonctionner la CI (lier a un problème d'un fichier export_presets.cfg, je reviens dessus plus tard), mon fichier est comme celui-ci :
```
# Godot 4+ specific ignores
.godot/
# Godot-specific ignores
.import/
export.cfg
# Imported translations (automatically generated from CSV files)
*.translation
# Mono-specific ignores
.mono/
data_*/
mono_crash.*.json
```

## 3. 📁 Créer un projet Godot
1. **Ouvrir Godot :** Lancez l'application Godot sur votre ordinateur.
2. **Créer un nouveau projet :** Sur l'écran d'accueil de Godot, cliquez sur "Nouveau projet".
3. **Configurer les paramètres du projet :** Choisissez l'emplacement où vous avez créer votre repository pour votre projet et donnez-lui un nom.
4. **Choisir un modèle de projet :** Sélectionnez le modèle de projet qui correspond le mieux à vos besoins. Vous pouvez choisir entre "Projet 2D", "Projet 3D", "Projet 2D et 3D" ou "Modèle vide".
5. **Créer le projet :** Cliquez sur "Créer le projet" pour créer votre nouveau projet Godot.
6. **Explorez le projet :** Une fois le projet créé, vous serez dirigé vers l'interface de Godot où vous pourrez commencer à travailler sur votre jeu ou votre application.


Todo:
- Explications de la configuration de la pipelines
- Explications de la structure des fichiers
-

0 comments on commit 545e58b

Please sign in to comment.