Documentation on maps

This commit is contained in:
Yohann D'ANELLO 2020-11-19 22:21:03 +01:00
parent d4570828e2
commit 6b2e420efe
3 changed files with 55 additions and 0 deletions

View File

@ -41,6 +41,7 @@ Bienvenue dans la documentation de Squirrel Battle !
:caption: Jouer
install
maps
entities/index
texture-pack
troubleshooting

46
docs/map.rst Normal file
View File

@ -0,0 +1,46 @@
Carte
=====
.. _entités: entity/index.html
.. _pack de textures: texture-pack.html
Dans Squirrel game, le joueur se déplace dans un donjon, constitué de plusieurs
cartes. Pour le moment, le jeu se déroule sur une unique carte pré-définie,
non générée aléatoirement.
Une carte est un rectangle composé de tuiles_.
La carte est chargée depuis sa représentation ASCII dans un fichier texte.
Au lancement du jeu, une quantité aléatoire d'entités_ sont générées et placées
aléatoirement sur la carte.
Tuiles
------
Une tuile représente une case du jeu, avec ses différentes propriétés physiques.
On compte actuellement 3 types de tuiles :
Vide
~~~~
Le vide est représenté par un espace vide quelque que soit le `pack de textures`_
utilisé. Cette tuile n'est utilisée que pour délimiter les bords de la carte,
aucune entité ne peut se trouver sur cette tuile.
Sol
~~~
Le sol représente les emplacements où les entités peuvent se déplacer librement.
Il est représenté par un point ``.`` dans le `pack de textures`_ ASCII et par
deux caractères rectangulaires blancs ``██`` dans le `pack de textures`_
écureuil.
Mur
~~~
Les murs délimitent les salles du donjon. Personne ne peut les traverser.
Ils sont représentés par un dièse ``#`` dans le `pack de textures`_ ASCII et
par une brique carrée ``🧱`` dans le `pack de textures`_ écureuil.

View File

@ -3,6 +3,7 @@ Pack de textures
.. _entité: entity/index.html
.. _tuile: map.html#tuiles
.. _tuiles: map.html#tuiles
.. _carte: map.html
.. _paramètres: settings.html
@ -21,11 +22,16 @@ packs de textures sont proposés.
Il est possible de changer de pack dans les paramètres.
Les packs de textures peuvent influencer la taille que prennent les tuiles_,
en raison du fait que les émojis ne sont pas monospace.
Les packs de textures sont au nombre de deux :
Pack ASCII
----------
Chaque tuile fait un caractère de large.
* Tuiles
* Vide : *espace*
* Mur : ``#``
@ -43,6 +49,8 @@ Pack ASCII
Pack Écureuil
-------------
Chaque tuile fait 2 caractères de large pour afficher les émojis proprement.
* Tuiles
* Vide : *espace*
* Mur : ``🧱``