From bc47b0c331fe8438671cba40693b7fe2873350e6 Mon Sep 17 00:00:00 2001 From: "camille.turpin-etienne" Date: Fri, 7 Jun 2024 16:36:44 +0200 Subject: [PATCH] ReadMe --- Documentation/doxygen/mainpage.md | 2 +- README.md | 29 +++++++++++------------------ 2 files changed, 12 insertions(+), 19 deletions(-) diff --git a/Documentation/doxygen/mainpage.md b/Documentation/doxygen/mainpage.md index c4c07a1..9c1f5a8 100644 --- a/Documentation/doxygen/mainpage.md +++ b/Documentation/doxygen/mainpage.md @@ -3,7 +3,7 @@ Main Page {#mainpage} # Bienvenue sur la documentation de Mastermind -Ce projet est la version 1.0.0 de Mastermind. Voici une brève description de votre projet. +Ce projet est la version 1.0.0 de Mastermind. Voici une brève description de notre projet. ## Introduction diff --git a/README.md b/README.md index 54fd107..90a9c34 100644 --- a/README.md +++ b/README.md @@ -30,16 +30,13 @@ ## Réalisation d'un jeu vidéo en .NET, C# & MAUI -### Rendu jalon 2 - #### Conception Voici le lien d'accès à notre [conception](https://codefirst.iut.uca.fr/git/nicolas.barbosa/mastermind/wiki/Conception) disponible sur le wiki. Le wiki dispose d'un sommaire permettant de naviguer facilement entre les différentes parties qui les composent. - #### Release -Vous trouverez en cliquant sur le lien ci-dessous, la version de notre application pour le jalon 2 téléchargeable. +Vous trouverez en cliquant sur le lien ci-dessous, la version final de notre application téléchargeable. Sinon, la branche master contient également la dernière version du projet. @@ -53,7 +50,12 @@ Pour accéder à la documentation doxygen de notre code, vous pouvez cliquer sur #### Ce qui fonctionne -Dans notre application Mastermind, nous avons une application console fonctionnelle à deux joueurs pour des règles classiques. +Dans notre application Mastermind, nous disposons de deux modes de jeu : Classique et Difficile. Le jeu est jouable à deux joueurs humains ou bien contre des robots. + +La persistance est bien implémentée, vous pouvez conserver votre profil. Vous pouvez également reprendre une partie en cours. + +Le classement permet de classer les joueurs selon les statistiques de jeu (parties gagnées, parties perdues, parties égalisées, coût moyen). +Nous classons les joueurs selon le mode de jeu choisi. #### Ce qui ne fonctionne pas et ce qui ne fonctionne pas tout à fait @@ -61,25 +63,16 @@ Selon nous, nous ne pensons pas qu'il y ait un quelconque problème dans notre c Nous n'avons pas trouvé de bug ou de fonctionnalité qui ne fonctionnait pas. - #### Mode d'emploi pour jouer -Pour jouer, il vous suffit de lancer ConsoleApp. Une fois lancer, il vous sera demandé de rentrer les noms des deux joueurs s'affrontant. Les noms sont rentrés, la partie se lance. Le joueur numéro un est toujours la première personne à commencer. - -Pour composer son code : - -Vous pouvez changer la couleur de votre jeton actuel en utilisant les flèches de gauche ou de droite présente sur votre clavier. - -Si vous faites une erreur et que vous souhaiter effacer le dernier jeton entré, il vous suffit de cliquer sur la touche Echap et le jeton sera supprimé. Il vous est possible de cliqué sur la touche Echap jusqu'à ne plus avoir de jeton séléctionné. -Une fois, la combinaison désirée, cliquée sur la touche Entrée et votre combinaison sera enregistrée. +Pour jouer, il vous suffit de lancer le projet MauiSpark. Une fois lancé, vous arriverez sur la page d'accueil. Vous pouvez lancer une nouvelle partie ou reprendre une ancienne. Ensuite, il vous suffit de rentrer le nom des joueurs humains ou de choisir l'option Robot pour jouer contre un bot. -Dès la combinaison validée, le tour passe au joueur suivant, qui répète les mêmes actions présentées ci-dessus. +Ensuite, vous choisissez votre code en cliquant sur une couleur. Une fois que vous avez choisi toutes vos couleurs, vous cliquez sur valider le code. Vous avez aussi la possibilité de supprimer les jetons de votre code en cours. -Une fois le tour du joueur adverse passé, il vous est possible de voir vos anciennes tentatives et à côté d'elles des indicateurs. +Des indicateurs sont affichés au cours de la partie : un indicateur blanc pour une bonne couleur et un indicateur noir pour une bonne place. -Un indicateur noir signifie qu'une des couleurs est à la bonne place et un indicateur blanc signifie qu'une des couleurs existe dans le code secret. +La partie se termine sous trois conditions : un joueur trouve le bon code, la partie arrive au dernier tour et les deux joueurs ont perdu, ou les deux joueurs ont trouvé le code secret. -Pour terminer une partie, il faut soit faire le nombre de tours maximum, dans notre cas douze, ou que l'un des joueurs trouve la combinaison secrète, ou bien qu'il y ait une égalité entre les deux joueurs. #### Sonar Pour accéder à sonar, il vous suffit de cliquer sur le lien ci-dessous.