Merge pull request 'Rapport' (#53) from Rapport into master

Reviewed-on: #53
Reviewed-by: Mat_02 <diletomatteo@gmail.com>

JournalDeBord/rapport/.gitignore

@@ -0,0 +1,2 @@
+rapport.aux
+rapport.toc

JournalDeBord/rapport/rapport.tex

@@ -0,0 +1,278 @@
+\documentclass[12pt,a4paper]{article}
+
+\usepackage{amsmath}
+\usepackage{listings}
+\usepackage{tikz}
+\usepackage{csquotes}
+
+\begin{document}
+
+\title{Rapport du projet informatique 2023 \\ "Road to Master"}
+\author{Debucquoy Anthony \and Matteo Di Leto}
+\date{May 2023}
+
+\maketitle
+\newpage
+
+\tableofcontents
+\newpage
+
+
+\section*{Introduction}
+
+Lors de ce deuxième quadrimèstre, le projet Informatique proposé par notre université fut partie intégrante de notre emploi du temps.
+Régulièrement nous nous sommes rassemblés pour nous organiser et trouver une direction dans laquelle nous voulions voir notre projet évoluer.
+Grâce aux objectifs fixés par nos enseignants, nous sommes - je le pense - maintenant plus apte à nous confronter à ce genre d'objectifs. Tant au niveau personel qu'en tant que groupe.
+Il va sans dire que comme pour tout projets, notre chemin a été semé d'embuches. En l'occurence, nous souhaitons faire part de l'abandon d'un de nos membre. Eddy Jiofak qui souhaite se réorienter.
+Nous lui souhaitons une bonne reconversion.
+
+\section*{Objectifs}
+
+Voici l'objectif fixé par nos enseignants. (document de consignes)
+
+\begin{displayquote}
+
+Le but final de ce projet est de réaliser une application graphique en Java permettant de
+jouer au jeu "Cats Organized Neatly". Ce jeu est un jeu de type "puzzle" où le joueur doit
+placer des pièces de formes différentes pour combler l'aire de jeu. L'application devra permettre
+de sauvegarder et charger une partie et de créer des niveaux automatiquement.
+
+\end{displayquote}
+
+\newpage
+
+\section{Organisation}
+
+Lors de nos rassemblement pour le projet, toutes les idées émises se sont retrouvés sur un blog afin de pouvoir y accéder de manière efficace.
+Ce blog nous sert également à garder une trace de l'évolution du projet.
+
+\subsection{Choix}
+
+\begin{itemize}
+	\item{le VCS git pour garder une trace de l'avancement du projet. Avec comme remote une instance privée de gitea nous permettant de vérifier les MR/PR plus efficacement.}
+	\item{Une instance de DroneCI permettant de vérifier que le projet soit toujours compilable et que les tests ne soient pas ratés sans que nous nous en rendions compte.}
+	\item{Javafx, comme recommandé par nos enseignants.}
+	\item{Les pièces et niveaux sont stockées sous forme de matrice de booléen}
+	\item{Un parser de fichiers efficace et donnant des fichier légers.}
+\end{itemize}
+
+\subsubsection*{Shapes}
+
+Les pièces ainsi que la carte sont représentés par une matrice de booléen \verb|boolean[][]|.
+Nous avons donc une classe \verb|shape|, parent de \verb|Map| et de \verb|Piece| dans lequel nous stockons notre matrice.
+Ensuite, \verb|Map| Contient une liste de \verb|Piece|. Ces pièces contiennent une position représentée par la classe \verb|Vec2|.
+Cette position est la position du carré supérieur gauche dans la \verb|Map|.
+Avec toutes ces informations nous avons le nécessaire pour le moteur du jeu.
+
+Il est facilement possible de manipuler la carte et les pièces. Il nous suffit alors de faire correspondre l'affichage avec
+ces différentes classes. Ce qui est entrepris par la classe \verb|GameUI|.
+
+Le tout est géré par la classe \verb|Controller| qui permet de choisir entre l'affichage d'un menu ou d'une partie en cours.
+
+% \subsection{Difficultés}
+
+\section{Points Forts}
+
+\subsection{Parser de fichiers}
+
+Pour la rétention des niveaux, plusieurs possibilités s'offraient à nous. Nous avons alors décidés d'accomplir une série d'objectifs propre à notre projet avec un parser de fichiers dédié.
+Nous voulions que ce parser accomplisse les objectifs suivants:
+\begin{itemize}
+	\item{Les données du niveau seront encapsulées dans un header/footer pour laisser la possibilité d'enregistrer plus d'informations (images/musiques) dans un seul fichier dans le futur.}
+	\item{La taille du fichier devra être aussi petite que possible, tout en gardant les informations nécessaire au bon fonctionnement du jeu.}
+	\item{Il sera possible d'enregistrer l'état d'une partie en cours.}
+\end{itemize}
+
+Ce parser est implémenté par la classe \verb|BinaryParser|.
+
+\subsubsection*{spécification}
+
+\begin{description}
+	\item[Header/Footer]{ Les données du niveau commencent par les 3 \emph{caractères} 'S', 'M', 'S' (ou \verb|0x534D53|) et se terminent par les 3 \emph{caractères} 'S', 'M', 'E' (ou \verb|0x534D45|)}
+	\item[Taille de carte]{ Le premier octet des données représente la largeur de la carte, le second sa hauteur.}
+	\item[Forme de la carte]{ Chaques cellules de la carte est représenté par un 1 ou un 0. le 1 représente un emplacement libre, un 0 une cellule vide.
+		La forme de la carte peut alors être répartie sur un nombre indéterminé d'octets.
+		Nous pouvons déterminer ce nombre grace à
+		$$\frac{\text{largeur} * \text{hauteur } (+1 \text{ si multiple de } 8)}{8}$$ 
+		en division entière.}
+	\item[Nombre de pièce]{ L' (les) octet(s) qui forme(nt) la carte représente le nombre de pièce}
+	\item[Pour chaques pièces]{
+			\
+			\begin{description}
+				\item[Taille de la pièce]{La taille est représentée sur un seul octet sous forme de nibble\footnote{https://en.wikipedia.org/wiki/Nibble}. La première partie du nibble est la largeur. La seconde partie du nibble est la hauteur }
+				\item[Forme de la pièce]{ Chaques cellules de la pièce est représentée par un 1 ou un 0. la manière de le représenter et exactement la même que pour la forme de la carte }
+			\end{description}
+			Dans le cas où le fichier sauvegarde l'état de la partie, à la fin, et pour chaques pièces dans le même ordre que l'apparition des pièces:
+			\begin{description}
+				\item[Position de la pièce]{2 octets par pièces, 1 octet pour sa position en x et 1 octet pour sa position en y.
+					Dans le cas où la pièce est flotante (n'est pas placée dans la carte.), les octets contenant les caractères F puis L (0x464C) remplacent les coordonées}
+			\end{description}
+		}
+\end{description}
+
+\subsubsection*{Exemple}
+
+Voici le 'hexdump' du niveau 11
+
+\begin{verbatim}
+53 4d 53 05 05 e7 ff ff  80 06 33 ff 80 22 f0 22  |SMS.......3.."."|
+b0 22 70 22 b0 11 80 53  4d 45                    |."p"...SME|
+\end{verbatim}
+
+représente une carte de la forme :
+
+\begin{tikzpicture}
+	\filldraw[blue] (0,0) -- (0,5) -- (3,5) -- (3,4) -- (5,4) -- (5,0) -- cycle;
+	\draw[step=1cm,gray] (0, 0) grid (5,5);
+\end{tikzpicture}
+
+avec les pièces :
+
+\begin{tikzpicture}
+	\fill[red] (1,1) rectangle (4,4);
+	\fill[red] (5,1) rectangle (7,3);
+	\fill[red] (8,1) -- (8,3) -- (9,3) -- (9,2) -- (10,2) -- (10,1) -- cycle;
+	\fill[red] (11,1) -- (11,2) -- (12,2) -- (12,3) -- (13,3) -- (13,1) -- cycle;
+	\fill[red] (1,-2) -- (1,0) -- (2,0) -- (2,-1) -- (3,-1) -- (3,-2) -- cycle;
+	\fill[red] (4, -2) rectangle (5, -1);
+	\draw[step=1cm,gray] (0.5, -2.5) grid (13.5, 4.5);
+\end{tikzpicture}
+
+En plus de ce parser, et dans le cas où ce premier parser ne serait pas capable de stocker certaine carte (par exemple si une pièce mesure plus de 15x15).
+Nous avons également implémenté un parser très simple en utilisant l'interface \verb|Serialize| de java. Ce parser est implémenté et fonctionnel,
+mais n'est pas utilisé dans le projet à l'heure actuelle.
+
+Ces deux parseurs implémentent l'interface \verb|FileParser|.
+
+Finalement, La classe \verb|FileParserFactory| permet une utilisation simple de ces parseurs. Celle-ci contient deux fonctions statiques.
+\begin{itemize}
+	\item{\verb|Map loadMapFromFile(File)|}
+		permet de retourner la Map d'un fichier chargé.
+	\item{\verb|void saveFileFromMap(File, Map)|}
+		permet de sauvegarder une map dans un fichier.
+\end{itemize}
+
+Dans le cas d'une sauvegarde ou d'un chargement, le parser est choisi en fonction de l'extension de fichier ('.level', '.slevel', .'serialized', '.sserialized').
+
+L'avantage de ce system est que nous pouvons facilement ajouter d'autres parser de fichier dans le futurs.
+
+\subsection{Générateur de niveaux}
+
+Le générateur de niveaux a été conçu de sorte à proposer 3 difficultés différentes
+
+\begin{itemize}
+	\item{Niveau Facile}
+	\item{Niveau Moyen}
+	\item{Niveau Difficile}
+\end{itemize}
+
+L'algorithme derrière est le même en voici le principe :
+
+\subsubsection*{Gestion du plateau}
+
+Le joueur choisi une difficultée. En fonction de la difficultée choisie la grandeur du plateau de jeu sera différente.
+Si la difficulté choisie est facile ou moyenne, alors un curseur parcour les extrémités du niveau.
+Ce curseur sélectionne aléatoirement les cellules qui seront gardés ou non.
+Grâce à ça, la forme du plateau n'est pas trop carrée.
+
+Nous nous sommes basé sur le même principe pour le niveau de difficulté difficile mais en plus d'une taille encore plus grande,
+le curseur parcours les extrémités avec une profondeur de 2 afin de faire varier la carte plus grande.
+Cela introduit le problème des cases isolés. c'est pourquoi une boucle vérifie chaques cellules et la supprime si celle si est isolée.
+
+\subsubsection*{Gestion des pièces}
+
+Peu importe la difficulté du niveau voici le fonctionnement :
+
+Une taille maximum des pièces a été fixée au préalable à 3x3.
+Par la suite, un curseur parcours des cases de la carte préalablement conçue de manière aléatoire.
+Pour chaques cases, l'algorithme teste pour chaques cases de la pièce, si l'espace est disponible.
+Si ca n'est pas le cas, alors la pièce est modifiée afin de faire correspondre la pièce et la carte.
+
+L'avantage de cette méthode est que les niveaux sont tous très différents.
+Les désavantages sont que, par malchance, il est possible d'avoir énormément de piece 1x1.
+Ainsi qu'il est plus difficile d'appliquer des textures et dessins - à l'image du jeu de base - sur les pièces.
+
+Malgrés tout, avec nos nombreux test, ce générateur de niveaux nous satisfait vraiment bien et la difficultée des niveaux coorespond bien aux attentes.
+
+\subsection{Interface graphique}
+L'interface graphique du jeu tient sur 5 classes différentes.
+
+\subsubsection*{Controller}
+Classe principale. Elle s'occupe de la gestion des autres classe, et de la cohérence entre elles.
+Toutes les autres classes (présentes dans le package \verb|Scenes|) sont des sous classe de Parents.
+Celà permet de les afficher grace à la méthode statique \verb|switchRoot|.
+C'est aussi le point d'entrée du programme.
+
+\subsubsection*{MenuAccueil}
+Classe s'occupant de générer la page d'accueil du jeu.
+C'est-à-dire la première page que vera l'utilisateur.
+Cette page permet d'accéder aux niveaux du jeu de base, mais également de générer les niveaux aléatoires.
+De plus un dernier boutons "Load Game" permet de revenir sur la dernière partie en cours du joueur.
+
+\subsubsection*{MenuLevel}
+Classe s'occupant d'afficher les niveaux proposés dans le jeu, et qui,
+en fonction du jour choisir, change les boutons et les niveaux disponibles.
+
+\subsubsection*{ScreenLevelFinish}
+Classe qui s'affiche à l'écran dès que le joueur a fini le niveau.
+Celle-ci propose également de réessayer le niveau ou de retourner au menu principal.
+
+\subsubsection*{GameUI}
+Classe s'occupant de l'affichage d'un niveau.
+S'occupe dans un premier temps d'afficher le plateau au milieu de l'écrant.
+Par la suite, les pièces sont dispérsées à la gauche de l'écrant et sont rendu disponible à l'utilisateurs.
+Ces pièces sont déplacables à l'aide de la souris.
+Si elles sont lachées sur un emplacement disponible du plateau, alors elle vont s'alligner avec ses cellules.
+Pour se faire, nous regardons si le centre d'une cellule (la plus en haut à gauche) est présente dans une cellule du plateau.
+Ensuite, on vérifie que toutes les cellules de la pièces ont bien la place dans le plateau pour se poser. si c'est le cas, alors la pièce est posée.
+
+\section{Points Faibles}
+
+Bien que l'interface graphique permet de naviguer de manière fluide dans le jeu, il y a clairement un manque d'animation et de dynamisme
+\emph{i.e}: transition de page à une autre, apparition des boutons ainsi qu'un manque de musique.
+Toujours concernant l'affichage l'adaptation à la taille de l'écran peut être revue.
+
+De plus suite à la perte de notre membre nous n'avons pas su gérer la partie du projet qui concerne le design/textures des pièces ainsi que l'histoire jeu préparée auparavant.
+
+\section{Apports Positifs et négatifs}
+
+\subsection{Anthony}
+
+Personellement, ce projet m'a permis de me plonger dans la conception d'un format de fichier personnalisé.
+C'est une chôse que je n'avais pas encore fait jusqu'à maintenant.
+Et malgré mes efforts pour prévoir un maximum de choses à l'avance afin d'éviter de devoir 
+modifier ma spécification pendant le dévelopement. Je me suis vite rendu compte que je n'avais pas pensé
+à tout et que je devrais changer des choses pour pouvoir arriver à mes fins.
+Je pense que ce parser de fichier est vraiment améliorable mais je suis relativement fier du résultat.
+
+J'ai pu présenter ce parser à Dr Quoitin qui a pu me conseiller sur différentes approches à ce problème.
+J'en prend bonne notes.
+
+\subsection{Matteo}
+
+Il est clair que je peux tirer plusieurs enseignement grâce à la réalisation de notre projet.
+Tout d'abord, j'ai pu en apprendre beaucoup plus concernant la P.O.O en java, mais aussi  j'en ai appris
+d'avantage sur l'utilisation de la bibliotheque JavaFx.
+
+De plus, durant la réalisation du projet, comme dit précédemment nous avons utilisé plusieurs outils et dont la plus grande découverte pour moi :
+Git. Qui révèle son intérêt pour les travaux de groupes, et qui selon moi se révélera tout aussi essentiel pour mes futurs projets
+scolaires ainsi que professionnels.
+
+\section{conclusion}
+
+En conclusion nous pouvons séparer notre travail en trois partie différentes
+
+\begin{enumerate}
+	\item Le parser de fichier (gestion sauvegarder/charger partie)
+	\item Logique du jeu (Map,Vec2,Shapes)
+	\item Liaison à l'UI (Javafx)
+\end{enumerate}
+
+Malgré notre travail concentré sur le bon fonctionnement du jeu avec un parser suivant nos objectifs, une utilisation de la P.O.O de manière très efficace,
+ainsi qu'une approche correcte de l'utilisation du framework Javafx, d'autre améliorations sont toujours possible !
+En effet l'idée de rajouter une histoire, des trophées, un easter egg, des pièces spéciales ou un encore un table de score basée sur le temps,
+reste possible afin de rendre notre jeu encore plus complet.
+
+En conclusion, notre jeu a encore plein de possibilité afin d'être encore plus complet et amusant!
+
+\end{document}