projet-programmation-orient.../docs/iteration2/manuel-utilisateur2.tex

194 lines
7.3 KiB
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/}
{../screenshots/}
}
\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°2
\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 (préciser version?) 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}
\textbf{Le jeu est basé sur openJDK 8 et libGDX, pour le lancer il vous faut la version correspondante du JDK\\
Nous vous recommandons aussi de le lancer avec Visual Studio Code en pressant Ctrl + F5}
\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 tous les menus sont proposés SAUF le mnu de configuration de parties. Notez aussi que les crédits sont vides pour le moment.
\begin{figure}[H]
\centering
\includegraphics[width=20cm]{MenuPrincipal.png}
\caption{Menu Principal de l'itération 2}
\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 apparaître au cours des prochaines versions regroupées dans plusieurs catégories.
\\ 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...
\\ Une catégorie Joueurs dans laquelle l'utilisateur pourra changer le nom/ la couleur de chaque joueur. Enfin il devrait y avoir une catégorie poussant les paramètres de la partie. En effet, les joueurs pourront changer la constante de gravitation G, changer le temps de vie maximale d'une flèche, changer la taille de la carte, la densité de planètes par joueur dans l'univers, le nombre de lunes ...
\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}
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é (FPS), la quantité de détails présent à l'écran (décor et particules), le volume sonore de la musique et des effets. Le joueur aura aussi la possibilité de changer les contrôles pour jouer.
\\ En l'état actuel le joueur peut seulement lancer le mode debug, changer la constante gravitationnelle G et intervenir sur les paramètres audios.
\begin{figure}[h]
\centering
\includegraphics[width=14cm]{menu_parametre.png}
\caption{Menu paramètres actuel}
\end{figure}
\newpage
\section{Partie}
Une fois la partie lancée, si l'utilisateur lance le mode debug, il tombe sur l'écran ci dessous.
\begin{figure}[H]
\centering
\includegraphics[width=18cm]{mode_debug.png}
\caption{Exemple d'ecran au lancement d'une partie (version debug)}
\end{figure}
Dans ce mode il peut alors observer toutes les trajectoires ainsi que les forces d'attraction comme ci-dessous :
\begin{figure}[H]
\centering
\includegraphics[width=16cm]{trajectoire_debug.png}
\caption{Exemple d''un tir (version debug)}
\end{figure}
Dans une partie normale, l'utilisateur tombe plutôt sur un écran qui ressemble à celui-ci (si on excepte les flèches plantées dans la planète) :
\begin{figure}[H]
\centering
\includegraphics[width=16cm]{fleche_plantee.png}
\caption{Exemple d'un lancement normal de partie}
\end{figure}
En dézoomant (avec les flèches directionnelles haut et bas) il peut alors jouer avec la caméra et se rendre compte de la position de ses ennemis. Evidemment, s'agissant d'un jeu au tour par tour, chaque participant choisit une couleur et joue uniquement le personnage correspondant. \\
Ainsi dans notre exemple, le joueur jaune commence. 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.Une fois bien positionné, pour tirer, le joueur clique sur un endroit de l'écran et maintient le clic pour choisir la direction et la puissance de la flèche. En mode de jeu normal cette information n'est pas affichée pour le moment. Elle le sera dans la prochaine version.\\
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 celeste elle disparait. Si la flèche touche un joueur, celui-ci perd un point de vie, une fois le compteur de vie (non affiché et égal à 1 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_fleche.png}
\caption{Exemple d'un tir de joueur}
\end{figure}
\section{Menu pause}
Lors d'une partie, si l'utilisateur appuie sur la touche "Échap", un menu apparait. Depuis ce menu, le joueur peut retourner au jeu, changer quelques paramètres généraux ou revenir au menu princiapl.
\begin{figure}[H]
\centering
\includegraphics[width=16cm]{menu_pause.png}
\caption{Menu pause }
\end{figure}
\end{document}