projet-programmation-orientee-objet/docs/iteration1/manuel-utilisateur1.tex

\documentclass[a4paper, 12pt]{article}
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
\usepackage{graphicx}
\usepackage{amsmath}
\usepackage{amsfonts}
\usepackage{amssymb}
\usepackage{color}
\usepackage[french]{babel}
\usepackage[hidelinks]{hyperref}
\usepackage{mathtools}
\usepackage[nottoc, numbib]{tocbibind}
\usepackage{lipsum}

\usepackage{minted}
\newminted{bash}{numbersep=6pt}

\usepackage{contour}
\usepackage{ulem}
\renewcommand{\ULdepth}{1.8pt}
\contourlength{0.8pt}
\newcommand{\myuline}[1]{%
  \uline{\phantom{#1}}%
  \llap{\contour{white}{#1}}%
}

\usepackage[
    top=1.5cm,
    bottom=1.5cm,
    left=1.5cm,
    right=1.5cm
]{geometry}

\setlength{\parskip}{0.2cm}

\graphicspath{
    {../images/}
}

\begin{document}

\begin{figure}[t]
    \centering
    \includegraphics[width=5cm]{inp_n7.jpg}
\end{figure}

\title{
    \vspace{4cm}
    \textbf{Projet long de Technologie Objet} \\
    Manuel Utilisateur \\
    Itération n°1
    \vspace{2cm}
}
\author{
    \myuline{Groupe IJ-1}
    \vspace{2mm} \\
    Fainsin Laurent \\
    Guillemin Johan \\
    Guillotin Damien \\
    Heurtebise Tom \\
    Jourdan Pierre-eliot \\
    Kirupananthan Nadesan
}
\date{
    \vspace{7cm} Département Sciences du Numérique \\
    Première année \\
    2020 — 2021
}

\maketitle

\newpage

\tableofcontents

\newpage

\section{Présentation}

% inclure photo ici

Sagittarius est un jeu type arcade tour par tour pouvant être joué de 2 à 5 joueurs. Le but d'un joueur est d'éliminer ses adversaires grâce à un arc, des flèches et, la mécanique principale du jeu, la gravité !

% écrire plus ?

\section{Lancer l'application}

L'application est fournie dans un fichier .jar, celui contient l'ensemble des éléments nécéssaires au bon fonctionnement du jeu vidéo. Avant de pouvoir éxecuter l'application il vous faut d'abord vérifier dans un premier temps que Java soit installé sur votre ordinateur. Ensuite pour lancer le jeu, il vous faut entrer dans un terminal:

\begin{center}
    \textit{java -jar sagittarius.jar}
\end{center}

\section{Menu principal}

Ce menu est le menu principal qui s'affiche lors du lancement du jeu. Depuis celui-ci l'utilisateur pourra choisir de lancer une partie rapide (bouton play), d'accéder aux paramètres généraux du jeu, de configurer une partie, de voir les crédits du jeu ou bien de quitter l'application. \\
Pour cette itération seulement les sous-menus partie rapide (play), paramètres généraux (settings) et quitter (exit) ont été développés. 

\begin{figure}[h]
    \centering
    \includegraphics[width=18cm]{Menu_principal.png}
    \caption{Menu Principal de l'itération 1}
\end{figure}

\begin{figure}[h]
    \centering
    \includegraphics[width=14cm]{MenuPrincipalFinal.png}
    \caption{Menu Principal esperé pour la fin du projet}
\end{figure}

\section{Configuration d'une partie}

\textit{(Cette option n'apparaît pas encore pour cette itération et est encore en cours d'implémentation)}

Depuis ce menu, les joueurs peuvent choisir les différentes caractéristiques de la partie et ainsi modifier la manière de jouer.
Diverses sections devraient apparaitres au cours des prochaines versions, regroupées dans plusieurs catégories:
\begin{itemize}
    \item Une catégorie Mode de jeu (qui incluera un mode solo si le temps nous permet de le développer) dans laquelle le joueur pourra changer le nombre de joueurs, le nombre d'équipe etc...
    \item Une catégorie Joueurs dans laquelle l'utilisateur pourra changer le nom et la couleur des joueurs.
\end{itemize}
D'autres paramètres pourront aussi êtres changés, tel que la constante de gravitation G, le temps de vie maximale d'une flèche, la taille de la carte, la densité de planètes par joueur dans l'univers, le nombre de lunes maximales...

\begin{figure}[h]
    \centering
    \includegraphics[width=14cm]{menuConfig.png}
    \caption{Paramètres de configuration d'une partie, menu espéré}
\end{figure}

\newpage

\section{Paramètres généraux}

\textit{(Cette option n'apparaît pas encore pour cette itération et est encore en cours d'implémentation)}

Depuis ce menu, l'utilisateur pourra choisir de changer la résolution de la fenêtre de jeu, le nombre d'images par secondes souhaités (FPS), la quantité de détails présent à l'écran (décors et particules), le volume sonore de la musique et des effets... \\
Le joueur aura aussi la possibilité de changer ses contrôles, voire même d'utiliser une manette au lieu du clavier et de la souris (si le temps le permet). \\
En l'état actuel le joueur peut seulement activer le mode debug et changer la constante gravitationnelle G.

\begin{figure}[h]
    \centering
    \includegraphics[width=14cm]{Parametres.png}
    \caption{Menu paramètres actuel}
\end{figure}

\begin{figure}[h]
    \centering
    \includegraphics[width=14cm]{menuParamGeneraux.png}
    \caption{Menu paramètres esperé}
\end{figure}

\newpage 

\section{Partie}

\textit{(En l'état actuel des choses les joueurs sont représentés par des rectangles simples, les forces d'attraction sont affichées, il n'y a aucun arrière plan, les flèches sont des traits et les planètes des ronds. Tout ceci devrait évoluer...)}

Une fois la partie lancée, l'utilisateur tombe sur l'écran ci-dessous. 

\begin{figure}[H]
    \centering
    \includegraphics[width=18cm]{Lancement.png}
    \caption{Exemple d'écran au lancement d'une partie (version debug)}
\end{figure}

Ce joueur peut alors commencer la partie. Il peut choisir de se déplacer en suivant le contour de la planète ou de tirer. Pour se déplacer il utilise les flèches du clavier (ou d'autres boutons de son choix si les controles ont été personnalisés). 
Une fois bien positionné, pour tirer le joueur clique sur un endroit de l'écran et maintient le clic pour ainsi choisir la direction et la puissance de la flèche (cf figure pour un exemple de l'affichage actuel). 

\begin{figure}[H]
    \centering
    \includegraphics[width=18cm]{Visee.png}
    \caption{Exemple du système de visée actuel}
\end{figure}
En relachant le clic de la souris la flèche est lancée, celle-ci à une durée de vie de 20 secondes. Si au delà de ce temps la flèche n'a pas touché de joueur ou d'objets celestes, elle disparait. Si la flèche touche un joueur, celui-ci perd un point de vie, une fois le compteur de vie (non affiché pour le moment) d'un joueur à zéro, celui-ci meurt. Au cours d'un tour un joueur ne peut tirer qu'une flèche, après cela c'est au tour du joueur suivant.
Vous avez ci-dessous un exemple de tir par un joueur. 

\begin{figure}[H]
    \centering
    \includegraphics[width=18cm]{Tir.png}
    \caption{Exemple d'un tir de joueur (version debug)}
\end{figure}

\section{Menu pause}

\textit{(Cette option n'apparaît pas encore pour cette itération et est encore en cours d'implémentation)}

Lors d'une partie, si l'utilisateur appuie sur la touche "Échap", un menu apparaitra au dessus de l'écran de la partie. Depuis ce menu vous avez le choix de retourner au jeu, de sauvegarde la partie, d'aller dans le menu des paramètres généraux, de quitter la partie.
\begin{figure}[H]
    \centering
    \includegraphics[width=16cm]{menuPause.png}
    \caption{Menu pause espéré}
\end{figure}

\end{document}