made the README files for every module

README.md

@@ -1 +1,35 @@
-# Projet S6
+# Bataille Navale (Projet S6)
+
+# Introduction
+Ce projet consiste à implémenter un jeu de bataille navale, jouable en multijoueur.  
+La librairie [Pyglet](https://github.com/pyglet/pyglet) a été utilisé pour l'interface graphique.  
+
+La bataille navale est un jeu constituant à TODO  
+
+# Installation
+Ce projet est compatible avec Windows et Linux.
+
+## Windows
+
+<details>
+
+### Builds
+- Télécharger un build windows dans les [releases du github](https://github.com/Faraphel/Projet_S6)
+- Lancer le jeu avec `Bataille Navale.exe`
+
+### Manuel
+- Installer [Python 3.11](https://www.python.org/downloads/windows/) (ou ultérieur)
+- Installer les dépendances avec `pip install -r requirements.txt`
+- Lancer le jeu avec `python3 main.pyw`
+
+</details>
+
+## Linux
+
+<details>
+
+- Installer Python 3.11 avec les commandes `sudo apt update && sudo apt install python3.11`
+- Installer les dépendances avec `pip install -r requirements.txt`
+- Lancer le jeu avec `python3 main.pyw`
+
+</details>

assets/README.md

@@ -0,0 +1 @@
+Ce dossier contient toutes les ressources utilisées dans le jeu.

assets/font/README.md

@@ -0,0 +1,2 @@
+Source :
+- CenturyGothicBold.ttf : https://ttfonts.net/fr/font/9526_CenturyGothic.htm

assets/image/README.md

@@ -0,0 +1,3 @@
+Logiciels :
+- Images créées avec [Paint.net](https://www.getpaint.net)
+- Animations créées avec [Kdenlive](https://kdenlive.org)

assets/sound/README.md

@@ -1,12 +1,9 @@
-Les effets sonores suivants ont été téléchargé sur le site freesound.org.
+Source : 
-
-Source individuelles : 
 - placed.wav : https://freesound.org/people/Kayyy/sounds/61015/
 - touched.wav : https://freesound.org/people/derplayer/sounds/587196/	
 - missed.wav : https://freesound.org/people/ComputerHotline/sounds/407060/
 - sunken.wav : https://freesound.org/people/Iwiploppenisse/sounds/156031/	
 - victory.wav : https://freesound.org/people/Sheyvan/sounds/470083/
 - defeat.wav : https://freesound.org/people/Unlistenable/sounds/391536/
-
 - menu.wav : https://freesound.org/people/levelclearer/sounds/424271/
 - sea.wav : https://freesound.org/people/Pfannkuchn/sounds/360630/

source/_test/README.md

@@ -0,0 +1,5 @@
+Ce module permet de vérifier que les fonctionnalités d'autre module fonctionnent correctement.
+
+Pour les utiliser, placer vous dans le dossier racine et lancer les fichiers de tests d'ici avec
+les commandes `python3 ./source/_test/<module>.py`.
+

source/core/README.md

@@ -0,0 +1,4 @@
+Ce module contient les fonctionnalités au cœur du fonctionnement de la bataille navale.  
+
+Il implémente les planches, les bateaux et les bombes, 
+basé sur les matrices avec la librairie `numpy`.

source/event/README.md

@@ -0,0 +1,2 @@
+Ce module permet d'implémenter des événements dans des classes.  
+Il devient alors possible de créer un événement, et d'y réagir.

source/gui/README.md

@@ -1,8 +1,8 @@
 Ce module est une "surcouche" pour le module pyglet afin d'implémenter quelques éléments qui
-ne sont pas déjà disponible nativement dans cette librairie, tel que :
+ne sont pas déjà disponibles nativement dans cette librairie, tel que :
 
 - Les scènes (attachable à une fenêtre afin de changer rapidement de menu / d'interface)
 - Les widgets (attachable à des scènes afin de rajouter des boutons, des textes, ...)
 
 Ces éléments permettent de plus facilement gérer le redimensionnement de la fenêtre tout en
-restant suffisament rapide pour ne pas causer de problème de ralentissement.
+restant suffisamment rapide pour ne pas causer de problème de ralentissement.

source/gui/better_pyglet/README.md

@@ -0,0 +1 @@
+Ce module améliore certain objet déjà disponible dans Pyglet afin de les rendre plus pratique.

source/gui/event/README.md

@@ -0,0 +1 @@
+Ce module implémente la propagation des événements entre les Windows, les Scenes et les Widgets.

source/gui/media/README.md

@@ -0,0 +1 @@
+Ce module implémente le chargement des medias comme les sons que l'on peut entendre dans le jeu.

source/gui/position/README.md

@@ -0,0 +1 @@
+Ce module implémente des types d'unité pouvant être utilisé pour placer un widget dans la fenêtre.

source/gui/scene/README.md

@@ -0,0 +1,2 @@
+Ce module implémente des scènes. Une scène représente un "écran" du jeu que l'on peut changer
+pour une autre scène (par exemple, passer du menu principal aux paramètres).

source/gui/texture/README.md

@@ -0,0 +1 @@
+Ce module implémente le chargement des textures et animations.

source/gui/widget/README.md

@@ -0,0 +1 @@
+Ce module implémente les widgets, qui peuvent être placé sur une scène.

source/gui/window/README.md

@@ -0,0 +1,2 @@
+Ce module améliore les Windows de base de pyglet afin qu'elles puissent accueillir les scènes
+et être facilement modifiable dans les paramètres.

source/network/README.md

@@ -0,0 +1 @@
+Ce module s'occupe de toute la gestion du réseau et de l'envoie de donnée entre tous les joueurs.

source/network/packet/README.md

@@ -0,0 +1 @@
+Ce module implémente des "Packet" qui peuvent être plus facilement envoyé et reçu sur le réseau.

source/utils/README.md

@@ -0,0 +1 @@
+Ce module ajoute quelque fonctions mineures utilisées un peu partout dans le projet.