diff --git a/README.md b/README.md index 078f7d5..a4b76a5 100644 --- a/README.md +++ b/README.md @@ -1 +1,35 @@ -# Projet S6 \ No newline at end of file +# 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 + +
+ +### 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` + +
+ +## Linux + +
+ +- 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` + +
\ No newline at end of file diff --git a/assets/README.md b/assets/README.md new file mode 100644 index 0000000..c23b247 --- /dev/null +++ b/assets/README.md @@ -0,0 +1 @@ +Ce dossier contient toutes les ressources utilisées dans le jeu. \ No newline at end of file diff --git a/assets/font/README.md b/assets/font/README.md new file mode 100644 index 0000000..d25a1c7 --- /dev/null +++ b/assets/font/README.md @@ -0,0 +1,2 @@ +Source : +- CenturyGothicBold.ttf : https://ttfonts.net/fr/font/9526_CenturyGothic.htm \ No newline at end of file diff --git a/assets/image/README.md b/assets/image/README.md new file mode 100644 index 0000000..2c8f843 --- /dev/null +++ b/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) \ No newline at end of file diff --git a/assets/sound/README.md b/assets/sound/README.md index 03e6cd9..9618f6e 100644 --- a/assets/sound/README.md +++ b/assets/sound/README.md @@ -1,12 +1,9 @@ -Les effets sonores suivants ont été téléchargé sur le site freesound.org. - -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 : +- 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/ diff --git a/source/_test/README.md b/source/_test/README.md new file mode 100644 index 0000000..5b1c252 --- /dev/null +++ b/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/.py`. + diff --git a/source/core/README.md b/source/core/README.md new file mode 100644 index 0000000..14c0058 --- /dev/null +++ b/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`. diff --git a/source/event/README.md b/source/event/README.md new file mode 100644 index 0000000..12166a7 --- /dev/null +++ b/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. diff --git a/source/gui/README.md b/source/gui/README.md index 1b00464..a83180d 100644 --- a/source/gui/README.md +++ b/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. \ No newline at end of file +restant suffisamment rapide pour ne pas causer de problème de ralentissement. \ No newline at end of file diff --git a/source/gui/better_pyglet/README.md b/source/gui/better_pyglet/README.md new file mode 100644 index 0000000..774e06c --- /dev/null +++ b/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. \ No newline at end of file diff --git a/source/gui/event/README.md b/source/gui/event/README.md new file mode 100644 index 0000000..b8f9721 --- /dev/null +++ b/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. diff --git a/source/gui/media/README.md b/source/gui/media/README.md new file mode 100644 index 0000000..394cc7b --- /dev/null +++ b/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. diff --git a/source/gui/position/README.md b/source/gui/position/README.md new file mode 100644 index 0000000..4ac6f69 --- /dev/null +++ b/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. diff --git a/source/gui/scene/README.md b/source/gui/scene/README.md new file mode 100644 index 0000000..9f7d0a4 --- /dev/null +++ b/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). \ No newline at end of file diff --git a/source/gui/texture/README.md b/source/gui/texture/README.md new file mode 100644 index 0000000..b256ab9 --- /dev/null +++ b/source/gui/texture/README.md @@ -0,0 +1 @@ +Ce module implémente le chargement des textures et animations. diff --git a/source/gui/widget/README.md b/source/gui/widget/README.md new file mode 100644 index 0000000..a68f83f --- /dev/null +++ b/source/gui/widget/README.md @@ -0,0 +1 @@ +Ce module implémente les widgets, qui peuvent être placé sur une scène. \ No newline at end of file diff --git a/source/gui/window/README.md b/source/gui/window/README.md new file mode 100644 index 0000000..e761b38 --- /dev/null +++ b/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. diff --git a/source/network/README.md b/source/network/README.md new file mode 100644 index 0000000..9a52f79 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/source/network/packet/README.md b/source/network/packet/README.md new file mode 100644 index 0000000..f1dad6a --- /dev/null +++ b/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. \ No newline at end of file diff --git a/source/utils/README.md b/source/utils/README.md new file mode 100644 index 0000000..98bd881 --- /dev/null +++ b/source/utils/README.md @@ -0,0 +1 @@ +Ce module ajoute quelque fonctions mineures utilisées un peu partout dans le projet.