Merge pull request #9 from Tracks12/dev

2.3

Author: Tracks12

.gitignore

@@ -1,2 +1,5 @@
+.venv/
 __pycache__/
 *.pyc
+
+saves/*.map

README.md

@@ -2,20 +2,23 @@
 
 Le jeu de la vie de John Horton Conway
 
-Pour en connaître un peu plus, vous pouvez visiter la page **[Wikipedia](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life)** du jeu de la vie.
+> [!Note]
+> Pour en connaître un peu plus, vous pouvez visiter la page **[Wikipedia](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life)** du jeu de la vie.
 
 ## Sommaire
 
-1. [Consignes](#consignes)
-2. [Pré-requis](#pré-requis)
-   - [Dépendances](#dépendances)
-3. [Utilisations](#utilisations)
-4. [Sauvegarde](#sauvegarde)
-   - [Les entités](#les-entités)
-5. [Exemples d'utilisations](#exemples-dutilisations)
-   - [Aperçu](#aperçu)
-   - [Remarque](#remarque)
-6. [Licence](#licence)
+- [**conwayGameOfLife**](#conwaygameoflife)
+  - [Sommaire](#sommaire)
+  - [Consignes](#consignes)
+  - [Pré-requis](#pré-requis)
+    - [Dépendances](#dépendances)
+  - [Utilisations](#utilisations)
+  - [Sauvegarde](#sauvegarde)
+    - [Les entités](#les-entités)
+  - [Exemples d'utilisations](#exemples-dutilisations)
+    - [Aperçu](#aperçu)
+    - [Remarque](#remarque)
+  - [Licence](#licence)
 
 ## Consignes
 
@@ -27,17 +30,23 @@ La liste des consignes du sujet est disponible dans le [todo.md](todo.md)
 
 L'installation de **[Python 3](https://www.python.org/downloads/)** est recommandé pour l'éxécution du script
 
+> [!Note]
+> Une fois l'installation de **[Python 3](https://www.python.org/downloads/)** terminée, tapez `$ pip install -r requirements.txt` dans un terminal à la racine du projets pour installer toutes les dépendances du projet
+
 [Sommaire](#sommaire)
 
 ### Dépendances
 
-- [base64.b64decode](https://docs.python.org/3/library/base64.html#base64.b64decode), [base64.b64encode](https://docs.python.org/3/library/base64.html#base64.b64encode)
-- [json.dumps](https://docs.python.org/3/library/json.html#json.dumps), [json.loads](https://docs.python.org/3/library/json.html#json.loads)
-- [os.system](https://docs.python.org/3/library/os.html#os.system)
-- [sys.argv](https://docs.python.org/3/library/sys.html#sys.argv), [sys.version_info](https://docs.python.org/3/library/sys.html#sys.version_info)
-- [platform.system](https://docs.python.org/3/library/platform.html#platform.system)
-- [time.sleep](https://docs.python.org/3/library/time.html#time.sleep)
-- [zlib.compress](https://docs.python.org/3/library/zlib.html#zlib.compress), [zlib.decompress](https://docs.python.org/3/library/zlib.html#zlib.decompress)
+- [base64](https://docs.python.org/3/library/base64.html)
+- [json](https://docs.python.org/3/library/json.html)
+- [keyboard](https://pypi.org/project/keyboard/) (For Windows system)
+- [os](https://docs.python.org/3/library/os.html)
+- [sys](https://docs.python.org/3/library/sys.html)
+- [platform](https://docs.python.org/3/library/platform.html)
+- [termios](https://docs.python.org/3/library/termios.html) (For Linux system)
+- [tty](https://docs.python.org/3/library/tty.html) (For Linux system)
+- [time](https://docs.python.org/3/library/time.html)
+- [zlib](https://docs.python.org/3/library/zlib.html)
 
 [Sommaire](#sommaire)
 
@@ -46,31 +55,31 @@ L'installation de **[Python 3](https://www.python.org/downloads/)** est recomman
 | Fonctionnalités                     | Commandes                                                                                                    |
 | ----------------------------------- | ------------------------------------------------------------------------------------------------------------ |
 | Exécuter le script                  | `$ python main.py`                                                                                           |
-| Créer une nouvelle map              | `$ python main.py -n <mapName> <x> <y>`<br />`$ python main.py --new <mapName> <x> <y>`                      |
 | Insérer une ou plusieurs cellule(s) | `$ python main.py -a <mapName> "[(x, y), ...]"`<br />`$ python main.py --add <mapName> "[(x, y), ...]"`      |
 | Insérer une entité                  | `$ python main.py -A <mapName> <type> <x> <y>`<br />`$ python main.py --add-entity <mapName> <type> <x> <y>` |
 | Afficher une map enregistrée        | `$ python main.py -d <mapName>`<br />`$ python main.py --display <mapName>`                                  |
+| Lister les maps sauvegardés         | `$ python main.py -l`<br />`$ python main.py --list`                                                         |
+| Créer une nouvelle map              | `$ python main.py -n <mapName> <x> <y>`<br />`$ python main.py --new <mapName> <x> <y>`                      |
 | Réinitialiser une map               | `$ python main.py -r <mapName>`<br />`$ python main.py --reset <mapName>`                                    |
 | Jouer une map                       | `$ python main.py -s <mapName>`<br />`$ python main.py --start <mapName>`                                    |
 
 [Sommaire](#sommaire)
 
 ## Sauvegarde
 
-Les maps générées sont sauvegardées de manière automatique après chaque mise à jour de celle-ci dans un fichier **.map** portant le nom de la map dans le répertoire **[saves/](saves/)** (_exemple: **[world.map](saves/world.map)**_)
+Les maps générées sont sauvegardées de manière automatique après chaque mise à jour de celle-ci dans un fichier **.map** portant le nom de la map dans le répertoire **[saves](saves/)** (_exemple: **[world.map](saves/world.map)**_)
 
 [Sommaire](#sommaire)
 
 ### Les entités
 
-De même que pour la map, les entités sont stockées dans le fichier **[entity.json](entity.json)**
+De même que pour la map, les entités sont stockées dans le dossier **[entities](entities/)**
 
-Si vous voulez ajouter des entités dans le fichier, vous pouvez le faire en suivant le formatage de positionnement relatif avec les coordonnées **x** et **y** comme dans l'exemple ci dessous:
+Si vous voulez ajouter des entités dans le fichier, vous pouvez le faire en suivant le formatage de positionnement relatif avec les coordonnées **x** et **y** comme dans l'exemple ci dessous pour l'entité "block":
 
 ```json
 {
-  "nom de l'entité": "[(x, y), (x, y+1), (x+1, y), (x+1, y+1)]",
-  ...
+  "block": "[(x, y), (x, y+1), (x+1, y), (x+1, y+1)]"
 }
 ```
 
@@ -99,11 +108,12 @@ Et on lance le jeu avec `$ python main.py` en entrant le nom de la map que l'on
 ### Remarque
 
 - Vous pouvez checker votre configuration avec `$ python main.py -d world` pour afficher la map avec vos cellules actives
-- Depuis la version 2.0, vous pouvez maintenant enregistrer une entité complète dans **[entity.json](entity.json)** et l'ajouter sur la map comme ceci:
+- Depuis la version 2.0, vous pouvez maintenant enregistrer une entité complète dans le dossier **[entities](entities)** et l'ajouter sur la map comme ceci:
   - **Départ de floraison**: `$ python main.py -A world flowering 25 25`
   - **Le clown**: `$ python main.py -A world clown 25 25`
 
-Si vous voulez entièrement la réinitialiser, `$ python main.py -r world` remet toutes les cellules d'une map à 0
+> [!Tip]
+> Si vous voulez entièrement la réinitialiser, `$ python main.py -r world` remet toutes les cellules d'une map à 0
 
 [Sommaire](#sommaire)
 

core/__init__.py

@@ -4,26 +4,28 @@
 from base64 import b64decode, b64encode
 from platform import system
 
-CMD_CLEAR = "clear" if(system() == "Linux") else "cls" # Commande de nettoyage de la console
+class SystemEnum:
+	LINUX	= "Linux"
+	WINDOWS	= "Windows"
 
-class Colors: # Module de coloration pour les système Linux/Unix
-	if(system() == "Linux"):
-		bold	= "\033[1m"
-		italic	= "\033[3m"
+SYSTEM = system()
+_isLinux = bool(SYSTEM == SystemEnum.LINUX)
+
+CMD_CLEAR = "clear" if(_isLinux) else "cls" # Commande de nettoyage de la console
 
-		red		= "\033[31m"
-		green	= "\033[32m"
-		yellow	= "\033[33m"
-		blue	= "\033[34m"
-		purple	= "\033[35m"
-		cyan	= "\033[36m"
-		white	= "\033[37m"
+class Colors: # Module de coloration pour les système Linux/Unix
+	bold	= "\033[1m"		if(_isLinux) else ""
+	italic	= "\033[3m"		if(_isLinux) else ""
 
-		end		= "\033[0m"
+	red		= "\033[31m"	if(_isLinux) else ""
+	green	= "\033[32m"	if(_isLinux) else ""
+	yellow	= "\033[33m"	if(_isLinux) else ""
+	blue	= "\033[34m"	if(_isLinux) else ""
+	purple	= "\033[35m"	if(_isLinux) else ""
+	cyan	= "\033[36m"	if(_isLinux) else ""
+	white	= "\033[37m"	if(_isLinux) else ""
 
-	else:
-		bold = italic = end = ""
-		red = green = yellow = blue = purple = cyan = white = ""
+	end		= "\033[0m"		if(_isLinux) else ""
 
 class Icons: # Module d'icône ascii
 	# Icônes fixes
@@ -33,11 +35,11 @@ class Icons: # Module d'icône ascii
 
 	# Icônes de chargement
 	succ	= f" [{Colors.bold}{Colors.green}*{Colors.end}] "
-	fail	= f" [{Colors.bold}{Colors.red}*{Colors.end}] "
+	fail	= f" [{Colors.bold}{Colors.red}x{Colors.end}] "
 
 class B64: # Encode/Decode ascii string in base64
-	def encode(str = ""):
+	def encode(str: str = "") -> bytes:
 		return(b64encode(str.encode("ascii")))
 
-	def decode(str = ""):
+	def decode(str: bytes = "") -> str:
 		return(b64decode(str).decode("ascii"))

core/entity.py

@@ -4,28 +4,32 @@
 # Module de l'objet Entity
 # ce module contient les fonctionnalités de chargement des entités
 
+from os import listdir
 from os.path import abspath, dirname
 
 from core.loader import Loader
 
 class Entity:
 	def __init__(self):
-		self.__path		= str(f"{dirname(abspath(__file__))}/../entity.json")
-		self.__entities	= dict({})
+		self.__path		= str(f"{abspath(dirname(__file__))}/../entities")
+		self.__entities	= dict[str, str]({})
 		self.loaded		= bool(self.__loadJSON())
 
-	def __loadJSON(self): # Chargement des entités depuis un fichier
+	def __loadJSON(self) -> bool: # Chargement des entités depuis le dossier "entities"
 		try:
-			with open(self.__path, 'r') as outFile:
-				self.__entities = dict(Loader.json(outFile, ["Loading entities ...", "Entities loaded !   ", "Entities loading Failed !"]))
+			print("Loading entities ...")
+			for entity in [ e.split(".")[0] for e in listdir(self.__path) ]:
+				with open(f"{self.__path}/{entity}.json", 'r') as outFile:
+					self.__entities[entity] = Loader.json(outFile, [f"Loading {entity} ...", f"{entity} loaded !   ", f"{entity} loading Failed !"])[entity]
 
+			print("Entities loaded !")
 			return(True)
 
 		except(Exception):
 			return(False)
 
-	def __build(self, coord): # Build with relative position
-		entities = dict(self.__entities)
+	def __build(self, coord: tuple[int]) -> dict[str, str]: # Build with relative position
+		entities = dict[str, str](self.__entities)
 
 		for name in entities:
 			entities[name]	= str(entities[name].replace("x", str(coord[0])))
@@ -34,13 +38,8 @@ def __build(self, coord): # Build with relative position
 
 		return(entities)
 
-	def getEntitiesName(self):
-		names = []
+	def getEntitiesName(self) -> list[str]:
+		return([ str(e) for e in self.__entities ])
 
-		for name in self.__entities:
-			names.append(str(name))
-
-		return(names)
-
-	def get(self, name, coord = (5, 5)): # Récupération d'une
+	def get(self, name: str, coord: tuple[int] = (5, 5)) -> str: # Récupération d'une entité
 		return(self.__build(coord)[name])

core/loader.py

@@ -8,12 +8,12 @@
 from core import B64, Colors, Icons
 
 class Loader: # Module de chargements
-	def anim(msg):
+	def anim(msg: str):
 		arr = ['\\', '|', '/', '-']
 
-		for i in range(0, 10):
+		for i in range(10):
 			print(f" [{Colors.bold}{Colors.yellow}{arr[i % len(arr)]}{Colors.end}] {msg}", end = "\r")
-			sleep(.05)
+			sleep(.005)
 
 	def map(file, msg = ["", "", ""]): # Méthode de chargement pour fichier MAP
 		Loader.anim(msg[0])