Skip to content
Snippets Groups Projects
Commit 9ac29728 authored by GRON Cyann's avatar GRON Cyann
Browse files

Modification README.md

parent 0116233e
No related branches found
No related tags found
No related merge requests found
# Escape Game VR/AR
Bienvenue dans le projet collaboratif **Escape Game VR/AR** ! Ce dépôt contient la base de code pour la création d'un jeu d'escape game en réalité virtuelle (RV) ou augmentée (RA). Chaque binôme contribuera en développant une salle interactive unique. Ce guide décrit comment configurer votre environnement, travailler sur vos tâches, et contribuer efficacement au projet.
Bienvenue dans le projet collaboratif **Escape Game VR/AR** ! Ce dépôt contient la base de code pour la création d'un jeu d'escape game en réalité virtuelle (RV). Notre binôme a développé une salle interactive unique. Ce guide décrit comment configurer votre environnement, travailler sur nos tâches, et contribuer efficacement au projet.
---
## 📂 Structure du projet
- **Assets/** : Contient tous les assets nécessaires au projet (scripts, modèles 3D, textures, etc.).
- **Scenes/** : Répertoire pour les scènes Unity. Chaque binôme doit créer une scène individuelle dans un sous-dossier nommé après leur binôme.
- **Scenes/** : Répertoire pour les scènes Unity.
- **Scripts/** : Scripts partagés ou spécifiques.
- ...
- **Packages & ProjectSettings/** : Fichiers spécifiques à Unity.
......@@ -29,7 +29,7 @@ Bienvenue dans le projet collaboratif **Escape Game VR/AR** ! Ce dépôt contien
1. Clonez le dépôt :
```bash
git clone https://gitlab.imt-atlantique.fr/e20peill/rvsi-project/
git clone https://gitlab.imt-atlantique.fr/c23gron/tp-escape-game
```
2. Ouvrez le projet dans Unity :
......@@ -37,73 +37,25 @@ Bienvenue dans le projet collaboratif **Escape Game VR/AR** ! Ce dépôt contien
- Lancez Unity Hub.
- Cliquez sur **Open** et sélectionnez le dossier du projet.
3. Configurez votre branche :
- Créez une branche spécifique à votre binôme à partir de la branche principale (`main`) :
```bash
git checkout -b binome-nom1-nom2
```
- Poussez votre branche sur le dépôt distant :
```bash
git push origin binome-nom1-nom2
```
---
## ✍️ Règles pour contribuer
### Avant de commencer
1. **Mettez à jour la branche principale :**
Avant toute modification, synchronisez votre projet local avec la branche principale :
```bash
git pull origin main
```
2. **Travaillez sur votre propre branche :**
Ne faites pas de changements directement sur la branche `main`.
### Développement
1. **Créer une salle :**
- Votre scène doit être ajoutée dans le dossier `Scenes/` sous un sous-dossier nommé après votre binôme.
- Exemple : `Scenes/binome-nom1-nom2/`.
- Notre scène est ajoutée dans le dossier `Scenes/` sous un sous-dossier nommé après notre binôme : `Scenes/binome-OUHADDOU-GRON/`.
2. **Respecter les conventions :**
2. **Documentation :**
- **Nom des scripts** : Préfixez les noms de vos scripts avec un identifiant de binôme (ex. : `BN1N2_MechanismController.cs`).
- **Organisation des assets** : Rangez les assets spécifiques à votre salle dans le sous-dossier correspondant à votre scène.
3. **Documentation :**
- Ajoutez un fichier `README.md` dans votre dossier pour décrire brièvement votre scène et vos scripts.
- Utilisez des commentaires dans vos scripts pour expliquer les fonctions importantes.
- un fichier `README.md` est ajouté dans notre dossier pour décrire brièvement notre scène et nos scripts.
- Des commentaires sont utilisés dans nos scripts pour expliquer les fonctions importantes.
### Tests et validation
1. **Tests locaux :**
- Vérifiez que votre salle fonctionne sans bugs majeurs.
- Testez l'intégration avec les autres scènes si possible.
2. **Création d'une Pull Request :**
- Une fois votre travail terminé, ouvrez une Pull Request vers la branche `main`.
- Suivez le modèle de PR fourni pour détailler vos modifications :
- **Description :** Décrivez brièvement votre contribution.
- **Checklist :** Assurez-vous que votre contribution respecte les critères d'évaluation.
- Exemple :
```
# Pull Request : Ajout de la salle pour le binôme nom1-nom2
## Description
Salle interactive où les joueurs doivent résoudre un casse-tête mécanique pour avancer.
**Tests locaux :**
## Checklist
- [x] Tests locaux effectués.
- [x] Documentation ajoutée.
- [x] Respect des conventions de nommage et d'organisation.
```
- Vérification que notre salle fonctionne sans bugs majeurs.
---
......@@ -119,9 +71,7 @@ Des guides détaillés sur l'utilisation des briques logicielles sont disponible
## 🛠️ Support
Pour toute question ou problème, contactez un membre de l'équipe encadrante ou ouvrez une issue dans le dépôt.
---
Pour toute question ou problème, contactez un membre de l'équipe.
Merci pour votre contribution au projet Escape Game VR/AR ! 🎉
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment