diff --git a/README.md b/README.md index 9327cc03858d013e0abd8c545f650b4fb743429b..b4d95fdafb28fa651ee928720c130ddcac455671 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Motus Le **Motus** est un jeu de lettres, inspiré du célèbre jeu télévisé. -Le but est de **deviner un mot secret** en un nombre limité de tentatives, et ce dans un **temps imparti**. +Le but est de **deviner un mot secret** en un nombre limité de tentatives, et ce dans un **temps imparti**. --- @@ -9,8 +9,10 @@ Le but est de **deviner un mot secret** en un nombre limité de tentatives, et c ### Avant de démarrer une partie -- **Choix de la langue** : Des boutons permettent de choisir la langue (anglais et français), et mettent à jour l'interface dans la langue choisie -- **Choix du nombre de lettres** : Un autre bouton permet de choisir le nombre de lettres (entre 4 et 12) dont est composé le prochain mot à deviner. La difficulté à trouver le mot étant d'autant plus élevée que son nombre de lettres est grand, le nombre d'essais autorisé pour trouver le mot en dépend : +- **Choix de la langue** : + Des boutons permettent de choisir la langue (anglais et français) et mettent à jour l'interface dans la langue choisie. +- **Choix du nombre de lettres** : + Un autre bouton permet de choisir le nombre de lettres (entre 4 et 12) dont est composé le prochain mot à deviner. La difficulté à trouver le mot étant d'autant plus élevée que son nombre de lettres est grand, le nombre d'essais autorisé pour trouver le mot en dépend : - 4 lettres : 5 essais - 5-6 lettres : 6 essais - 7-8 lettres : 7 essais @@ -18,45 +20,52 @@ Le but est de **deviner un mot secret** en un nombre limité de tentatives, et c ### Lancer la partie -- **Génération aléatoire** d’un mot respectant les critères choisis via le bouton correspondant +- **Génération aléatoire** d’un mot respectant les critères choisis via le bouton correspondant. ### Saisie et interactions -- Pour taper un mot, il suffit d'utiliser le clavier de l'ordinateur ou de cliquer sur le clavier virtuel affiché -- Les lettres s’affichent automatiquement sur la rangée correspondant au numéro de l’essai en cours +- Pour taper un mot, il suffit d'utiliser le clavier de l'ordinateur ou de cliquer sur le clavier virtuel affiché. +- Les lettres s’affichent automatiquement sur la rangée correspondant au numéro de l’essai en cours. - Lorsqu’un mot est validé, son appartenance au dictionnaire de la langue choisie est vérifiée : - - S'il n'appartient pas au dictionnaire, le mot tapé est affiché en rouge, et n'est pas validé + - S'il n'appartient pas au dictionnaire, le mot tapé est affiché en rouge, et n'est pas validé. - Sinon, il est validé et : - - Une lettre est affichée en jaune si elle est présente dans le mot mais mal placée - - Elle est affichée en vert si elle est bien placée - - Le clavier virtuel est mis à jour pour sauvegarder les couleurs des lettres déjà essayées, une touche de ce clavier est : - - verte si la lettre a déjà bien été placée - - jaune si elle a été placée, qu'elle est présente dans le mot mais n'a jamais été bien placée - - sans couleur si elle a déjà été placée, mais qu'elle n'est pas présente dans le mot + - Une lettre est affichée en jaune si elle est présente dans le mot mais mal placée. + - Elle est affichée en vert si elle est bien placée. + - Le clavier virtuel est mis à jour pour sauvegarder les couleurs des lettres déjà essayées, une touche de ce clavier est : + - **verte** si la lettre a déjà bien été placée, + - **jaune** si la lettre est présente mais jamais correctement positionnée, + - **sans couleur** si la lettre a été testée mais n'est pas présente dans le mot. ### Règles de la partie -- **Minuteur intégré** : le temps commence à s'écouler dès que le mot est généré, le minuteur est de 2 minutes -- **Victoire** si le mot est trouvé à temps +- **Minuteur intégré** : + Le temps commence à s'écouler dès que le mot est généré, avec un minuteur de 2 minutes. +- **Victoire** si le mot est trouvé à temps. - **Défaite** si : - - le joueur abandonne en cliquant sur le bouton dédié - - le nombre maximal de tentatives est atteint - - le temps est écoulé - Dans tous les cas de défaite, le mot à trouver est révélé à la fin de la partie + - Le joueur abandonne en cliquant sur le bouton dédié. + - Le nombre maximal de tentatives est atteint. + - Le temps est écoulé. + Dans tous les cas de défaite, le mot à trouver est révélé à la fin de la partie. ### Statistiques +Le système de statistiques du jeu permet de suivre les performances du joueur à la fois de manière globale et locale. +#### Statistiques Globales -## Compilation et lancement +Pour chaque section (English, French et Combined), le jeu enregistre : +- **Parties jouées** +- **Victoires** +- **Win Streak Actuel** +- **Meilleur Win Streak** -### Via Qt Creator +Ces informations sont mises à jour à chaque fin de partie et présentées dans un overlay accessible via l'interface. -1. Ouvrir le fichier ``CMakeLists.txt` avec Qt Creator -2. Configurer un kit de compilation (Qt Desktop avec CMake), si besoin, cocher la case "Exécuter dans un terminal" dans Projets -> Exécuter -3. Lancer la compilation puis l'exécution depuis l'environnement +#### Statistiques Locales - - - ---- +Pour chaque configuration basée sur le nombre de lettres (allant de 4 à 12), les données locales suivantes sont recueillies : +- **Temps moyen** et **Meilleur temps** +- **Histogramme des victoires** + Cet histogramme montre le nombre de victoires obtenues pour chaque nombre d'essais. +- **Parties jouées** et **Parties gagnées** +- **Streaks locaux** : le streak actuel et le meilleur streak