From b403bc47842f891af2ce7e6694eef6cd4b9fc56f Mon Sep 17 00:00:00 2001 From: Eichhornchen Date: Wed, 6 Jan 2021 17:48:03 +0100 Subject: [PATCH] documentation --- docs/display/logs.rst | 2 +- docs/display/map.rst | 4 +++- docs/display/menu.rst | 12 ++++++++++- docs/display/stats.rst | 24 +++++++++++++++++++++- docs/entities/friendly.rst | 24 ++++++++++++++++++++-- docs/entities/items.rst | 42 +++++++++++++++++++++++++++++++++++--- docs/entities/monsters.rst | 15 +++++++++++++- docs/settings.rst | 36 +++++++++++++++++++++++++++++++- docs/texture-pack.rst | 17 ++++++++++++++- 9 files changed, 164 insertions(+), 12 deletions(-) diff --git a/docs/display/logs.rst b/docs/display/logs.rst index 3ad130d..9e925a3 100644 --- a/docs/display/logs.rst +++ b/docs/display/logs.rst @@ -1,4 +1,4 @@ Affichage de l'historique ========================= -Pas encore documenté. +L'historique des actions est affiché en bas de l'écran. À chaque action d'une entité, comme frapper quelqu'un, ou lorsque le joueur parle à une entité, cela s'affiche dans l'historique. diff --git a/docs/display/map.rst b/docs/display/map.rst index 1daa85a..749b32c 100644 --- a/docs/display/map.rst +++ b/docs/display/map.rst @@ -1,4 +1,6 @@ Affichage de la carte ===================== -Pas encore documenté. +La carte s'affiche dans la partie en haut à gauche de l'écran, sur la plus grande partie de l'écran. On affiche les tuiles une par une, selon le texture pack sélectionné. La map est actualisée à chaque action d'une entité. + +L'afffichage de la carte suit les déplacements du joueur. diff --git a/docs/display/menu.rst b/docs/display/menu.rst index 84be36c..30c4e98 100644 --- a/docs/display/menu.rst +++ b/docs/display/menu.rst @@ -1,4 +1,14 @@ Affichage des menus =================== -Pas encore documenté. +Les menus sont affichés dans une boîte. On peut naviguer dedans avec les flèches haut et bas, +et valider avec la touche entrée. + +Il y a plusieurs menus dans le jeu : + +* Le main menu, qui s'affiche au lancement du jeu. +* Le menu des paramètres : si on sélectionne un choix de touche et qu'on appuie sur entrée, on peut ensuite appuyer sur une touche pour remplacer la touche utilisée. +* Le menu des crédits : ce menu fonctionne avec la souris. En cliquant on affiche une image. +* Le menu d'inventaire : dans l'inventaire, on peut utiliser les touches pour utiliser un item ou l'équiper... +* Le menu de vente : on peut utiliser les touches gauche et droite pour switcher entre l'inventaire du joueur et celui du marchand. +* Menu des warnings : Pas vraiment un menu, mais affiche juste un message dans une petite boite pour prévenir le joueur que quelquechose ne va pas. diff --git a/docs/display/stats.rst b/docs/display/stats.rst index 1b5f697..e993c7f 100644 --- a/docs/display/stats.rst +++ b/docs/display/stats.rst @@ -1,4 +1,26 @@ Affichage des statistiques ========================== -Pas encore documenté. +.. _Hazel: ../index.html + +Les statistiques du joueur sont affichées en haut à droite de l'écran +et séparées du reste de l'affichage par une barre verticale. + +Les informations affichées sont : + +* **LVL** - le niveau du joueur +* **EXP** - la quantité d'expérience que le joueur a gagné et combien il lui en faut avant le prochain niveau. +* **HP** - la quantité de vie que le joueur a actuellement et combien il peut en avoir au maximum. +* **STR** - la force du joueur. +* **INT** - l'intelligence du joueur. +* **CHR** - le charisme du joueur. +* **DEX** - la dextérité du joueur. +* **CON** - la constitution du joueur. +* **CRI** - le pourcentage de chance de coup critique. +* **Inventory** - le contenu de l'inventaire du joueur. +* **Equipped main** - l'objet équipé dans la main principale. +* **Equipped secondary** - l'objet équipé dans la main secondaire. +* **Equipped armor** - le plastron porté par le joueur. +* **Equipped helmet** - le casque porté par le joueur. +* **Hazel** - le nombre d'Hazel_ que le joueur possède. +* **Vous êtes mort** - Éventuellement, si le joueur est mort. \ No newline at end of file diff --git a/docs/entities/friendly.rst b/docs/entities/friendly.rst index 11eea62..9fca40f 100644 --- a/docs/entities/friendly.rst +++ b/docs/entities/friendly.rst @@ -12,7 +12,12 @@ Il est possible d'interagir avec ces entités. En s'approchant d'elles, en appuyant sur la touche ``T`` suivie de la direction où regarder, un échange débute. -On dénombre actuellement 2 types d'entités pacifiques : +Si l'on s'adresse à un marchand, on devrait voir à l'écran l'inventaire du joueur +et l'inventaire du marchand. Les flèches haut et bas permettent de sélectionner +un objet, les touches droite et gauche de passer d'un inventaire à l'autre, et la +touche entrée valide l'action. + +On dénombre actuellement 3 types d'entités pacifiques : Tournesol --------- @@ -41,10 +46,25 @@ Les prix sont fixés : * Coeur : 3 Hazels * Potion d'arrachage de corps : 14 Hazels * Épée : 20 Hazels -* Bouclier : 18 Hazels +* Bouclier : 16 Hazels +* Casque : 18 Hazels +* Plastron : 30 Hazels Le marchand commence avec 75 Hazels en sa possession, contre 42 pour le joueur. Dans le `pack de textures`_ ASCII, il est représenté par le caractère ``M``. Dans le `pack de textures`_ écureuil, il est représenté par l'émoji ``🦜``. + +Trompette +--------- + +Son nom est fixé à 'trumpet'. Une trompette est un familier, c'est à dire que +c'est une entité attaquante qui suit globalement le joueurs et attaque les monstres +qui se rapprochent trop du joueur. + +Elle a 20 point de vie et une attaque de 3. + +Dans le `pack de textures`_ ASCII, elle est représentée par le caractère ``/``. + +Dans le `pack de textures`_ écureuil, elle est représentée par l'émoji ``🎺``. \ No newline at end of file diff --git a/docs/entities/items.rst b/docs/entities/items.rst index 918586c..e4f1c0a 100644 --- a/docs/entities/items.rst +++ b/docs/entities/items.rst @@ -19,7 +19,7 @@ Un objet dispose de deux paramètres : Si l'objet est dans l'inventaire, renvoie son propriétaire. -Deux types d'objets sont pour l'instant présents : +Il y a plusieurs types d'objets : Bombe @@ -79,7 +79,43 @@ Bouclier -------- Le bouclier est un objet que l'on peut trouver uniquement par achat auprès d'un -marchand pour le coût de 18 Hazels. Une fois équipé, le bouclier ajoute 2 de -constitution à son porteur, le permettant de parer plus de coups. +marchand pour le coût de 16 Hazels. Il s'équippe dans la main secondaire. +Une fois équipé, le bouclier ajoute 1 de +constitution à son porteur, lui permettant de parer mieux les coups. Il est représenté par les caractères ``D`` et ``🛡️``. + +Casque +------ + +Le casque est un objet que l'on peut trouver uniquement par achat auprès d'un +marchand pour le coût de 18 Hazels. Il s'équippe sur la tête. +Une fois équipé, le casque ajoute 2 de +constitution à son porteur, lui permettant de prendre moins de dêgats. + +Il est représenté par les caractères ``0`` et ``⛑️``. + +Plastron +-------- + +Le plastron est un objet que l'on peut trouver uniquement par achat auprès d'un +marchand pour le coût de 30 Hazels. Il s'équippe sur le corps. +Une fois équipé, le casque ajoute 4 de +constitution à son porteur, lui permettant de prendre moins de dêgats. + +Il est représenté par les caractères ``(`` et ``🦺``. + +Anneau +------ + +L'anneau est un objet que l'on peut trouver uniquement par achat auprès d'un +marchand. Il s'équippe sur la main secondaire. +Une fois équipé, l'anneau ajoute un bonus à une ou plusieurs statistiques du +joueur, améliorant sa capacité à se débarasser des monstres. + +Il y a plusieurs types d'anneaux : + +* **Anneau de coup critique**, qui augmente la chance de coup critique de 20%. Il coute 15 Hazels. +* **Anneau de gain d'expérience amélioré**, qui multiplie le gain d'expérience du joueur par 2. Il coûte 25 Hazels. + +Un anneau est représenté par les caractères ``o`` et ``💍``. \ No newline at end of file diff --git a/docs/entities/monsters.rst b/docs/entities/monsters.rst index b6f287c..31735bd 100644 --- a/docs/entities/monsters.rst +++ b/docs/entities/monsters.rst @@ -13,7 +13,7 @@ au plus vite sur le joueur pour le frapper selon l'algorithme de Dijkstra, et s'il est suffisamment proche frappe le joueur et lui fait autant de dégâts qu'il n'a de force. -On dénombre actuellement 4 types de monstres : +On dénombre actuellement 5 types de monstres : Hérisson -------- @@ -40,6 +40,8 @@ Lapin Son nom est fixé à `rabbit`. Il a par défaut une force à **1** et **15** points de vie. +Il a une chance de coup critique de 30%. + Dans le `pack de textures`_ ASCII, il est représenté par le caractère ``Y``. Dans le `pack de textures`_ écureuil, il est représenté par l'émoji ``🐇``. @@ -53,3 +55,14 @@ Son nom est fixé à `teddy_bear`. Il n'a pas de force et **50** points de vie. Dans le `pack de textures`_ ASCII, il est représenté par le caractère ``8``. Dans le `pack de textures`_ écureuil, il est représenté par l'émoji ``🧸``. + + +Pyguargue +--------- +Son nom est fixé à `eagle`. Il a par défaut une force à **1000** et **5000** points de vie. + +Il s'agit d'un boss difficilement tuable, qui apparait plus rarement que les autres monstres. + +Dans le `pack de textures`_ ASCII, il est représenté par le caractère ``µ``. + +Dans le `pack de textures`_ écureuil, il est représenté par l'émoji ``🦅``. diff --git a/docs/settings.rst b/docs/settings.rst index a8644d4..60fa5c1 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -1,4 +1,38 @@ Paramètres ========== -Pas encore documenté. +.. _pack de textures: texture-pack.html + +Il est possible de changer les touches utilisées dans le jeu dans le menu des paramètres. + +On peut aussi changer le `pack de textures`_ utilisé. + +Touches +------- + +Les touches utilisées de base sont : + +* **Aller vers le haut** : z +* **Aller vers le haut (secondaire)** : ↑ +* **Aller vers le bas** : s +* **Aller vers le bas (secondaire)** : ↓ +* **Aller à droite** : d +* **Aller à droite (secondaire)** : → +* **Aller à gauche** : q +* **Aller à gauche (secondaire)** : ← +* **Valider le choix** : Entrée +* **Inventaire** : i +* **Utiliser un objet** : u +* **Équiper un objet** : e +* **Lacher un objet** : r +* **Parler** : t +* **Attendre** : w + +Autres +------ + +.. _ascii: texture-pack.html#Pack ASCII +.. _squirrel: texture-pack.html#Pack Écureuil + +* **Texture pack utilisé** : parmi ascii_ et squirrel_ +* **Langue utilisée** : parmi anglais, français, espagnol, allemand \ No newline at end of file diff --git a/docs/texture-pack.rst b/docs/texture-pack.rst index c81e62a..072b6ff 100644 --- a/docs/texture-pack.rst +++ b/docs/texture-pack.rst @@ -21,6 +21,11 @@ Pack de textures .. _Épée: entities/items.html#epee .. _Bouclier: entities/items.html#bouclier .. _Hazel: ../index.html +.. _Plastron: ../entities/items.html#plastron +.. _Pyguargue: ../entities/monsters.html#Pyguargue +.. _Casque: ../entities/items.html#Casque +.. _Anneau: ../entities/items.html#Anneau +.. _Trompette: ../entities/items.html#Trompette Chaque entité_ et chaque tuile_ de la carte_ est associé à un caractère pour être affiché dans le terminal. Cependant, afin de pouvoir proposer plusieurs @@ -58,6 +63,11 @@ Chaque tuile fait un caractère de large. * Épée_ : ``†`` * Bouclier_ : ``D`` * Hazel_ : ``¤`` + * Plastron_ : ``(`` + * Pyguargue_ : ``µ`` + * Casque_ : ``0`` + * Anneau_ : ``o`` + * Trompette_ : ``/`` Pack Écureuil @@ -83,4 +93,9 @@ Chaque tuile fait 2 caractères de large pour afficher les émojis proprement. * `Potion d'arrachage de corps`_ : ``🔀`` * Épée_ : ``🗡️`` * Bouclier_ : ``🛡️`` - * Hazel : ``🌰`` + * Hazel_ : ``🌰`` + * Plastron_ : ``🦺`` + * Pyguargue_ : ``🦅`` + * Casque_ : ``⛑️`` + * Anneau_ : ``💍`` + * Trompette_ : ``🎺``