.. _tba-01-setup: Setup ===== Organisation ------------ Le mini projet est réalisé en binôme (nommés par la suite ``Alice`` et ``Bob``), dont la constitution est libre. Il est préférable de constituer les binomes à partir d'élèves du même groupe pédagogique. Puisqu'il y a un seul et unique référentiel (repo distant) pour le projet, le repo distant sera celui d'un des élèves. Par convention, on considère que : - ``Alice`` est propriétaire du projet. Elle invite ``Bob`` comme collaborateur ; - ``Bob`` est collaborateur du projet. Il doit répondre à l'invitation émise par ``Alice`` pour contribuer au projet. Dans le binôme, identifier : - qui va jouer le rôle d'``Alice`` ; - qui va jouer le rôle de ``Bob`` ; Stocker cette information dans le fichier ``tba/students.csv``. Par exemple : .. rubric:: Contributeurs au projet .. csv-table:: :header-rows: 1 :widths: 20, 20, 20, 20 "Nickname", "Nom", "Prénom", "login" "Alice", "Garcin", "Lazare", "garcinl" "Bob", "Labrosse", "Adam", "labrossa" Ajouter un collaborateur ------------------------ ``Alice`` se connecte sur son compte https://git.esiee.fr en fournissant l'adresse mail de ``Bob`` : ``Manage > Members > Invite members``. Le rôle de Bob doit être ``Développeur``. ``Bob`` accepte l'invitation dans sa boite mail. Progression ----------- Le développement du jeu se fait dans le répertoire ``e3-programmation-labs-student/tba``. Le travail effectué lors de chacune des séances devra être "pushé" sur ``https://git.esiee.fr//e3-programmation-labs-student``. Voilà les différentes étapes principales et secondaires du jeu. - Une première version - Passage interdit - Sens unique - Commande vide - Votre propre univers - Ajouter des lieux - Gestion direction inconnue - Ajouter un historique - Construire un historique - Revenir en arrière - Ajouter des objets - Ajouter un inventaire (joueur) - Ajouter un inventaire (lieu) - Observer l'environnement - Prendre / reposer un item - Vérifier son inventaire - Ajouter des PNJ - Créer un PNJ - Intégrer les PNJ à la map - Déplacer les PNJ - Interagir avec les PNJ - Ajouter des quêtes - ajouter une quête de lieux - ajouter une quête d'objets - ajouter une quête de PNJ Il doit y avoir : - un commit par étape principale (a minima) - ou un commit pour chaque étape secondaire (conseillé) Remise du travail ----------------- Lé dépôt distant est mis à jour en continu. Aucune démarche spécifique de remise du projet n'est donc nécessaire. **Le projet sera évalué sur le dernier commit** dont le timestamp fera foi pour les conditions de bonus/malus. .. warning:: Aucun commit ne doit être pushé après la date limite de remise du projet sous peine de malus. Structure du répertoire ``tba`` ------------------------------- Le répertoire ``tba`` doit être structuré et contenir les seuls fichiers strictement nécessaires pour exécuter le code (et uniquement ceux là). Un exemple :: tba | |-- README.md |-- actions.py # classe Actions : les interactions |-- character.py # classe Character : les PNJ |-- command.py # classe Command : la structure d'une commande |-- game.py # classe Game : la classe principale |-- item.py # classe Item : les objets |-- player.py # classe Player : le joueur |-- quest.py # classe Quest : les quêtes |-- room.py # classe Room : les lieux |-- video.link # lien vers la vidéo YouTube de présentation Le fichier principal ``game.py`` permet de lancer le jeu avec la commande :: $ python game.py Le fichier ``README.md`` décrit entièrement le projet. Il doit être rédigé en `Markdown `_ et structuré en sections : - le guide utilisateur : comment installer votre jeu, sa description (l'univers, les conditions de victoire/défaite, les commandes, la quête, etc.), comment y jouer, etc. ; - le guide développeur : le diagramme de classes. `Mermaid `_ est un outil pratique pour générer des diagrammes à partir de représentation textuelles ; - les perspectives de développement (ce que vous imaginez pour améliorer votre jeu) ; La vidéo (3 mn max) doit montrer la map du jeu, les personnages, les objets, les PNJ, un parcours gagnant et un parcours perdant. Elle doit être commentée. `OBS Studio `_ est une solution open source performante pour réaliser cette vidéo. .. important:: L'activité du dépôt sera analysée pour identifier le travail de chacun. Les commits doivent être réguliers et équilibrés entre les membres du binôme.