diff options
Diffstat (limited to 'report/userguide.tex')
| -rw-r--r-- | report/userguide.tex | 61 |
1 files changed, 59 insertions, 2 deletions
diff --git a/report/userguide.tex b/report/userguide.tex index 4d2ad5d..c607d4d 100644 --- a/report/userguide.tex +++ b/report/userguide.tex | |||
| @@ -2,15 +2,72 @@ | |||
| 2 | 2 | ||
| 3 | \section{Running the game} | 3 | \section{Running the game} |
| 4 | 4 | ||
| 5 | [versions features comparison] | 5 | \begin{tabular}{ l | l | l | l } |
| 6 | Feature & Web & App & Console\\ | ||
| 7 | \hline | ||
| 8 | Animations & YES & NO & NO\\ | ||
| 9 | Sound & YES & YES & NO\\ | ||
| 10 | Illustrations & YES & YES & NO\\ | ||
| 11 | Visual inventory & YES & YES & NO\\ | ||
| 12 | Keyboard shortcuts & YES & YES & NO\\ | ||
| 13 | \end{tabular} | ||
| 6 | 14 | ||
| 7 | \subsection{Web version} | 15 | \subsection{Web version} |
| 8 | 16 | ||
| 17 | To start the web version of the game, simply go to the | ||
| 18 | \href{http://esieequest.pacien.net/#play}{project's website} using an up to date | ||
| 19 | web browser. | ||
| 20 | |||
| 21 | |||
| 9 | \subsection{Standalone app} | 22 | \subsection{Standalone app} |
| 10 | 23 | ||
| 24 | An offline version of the game referred as ``standalone app'' can be executed by | ||
| 25 | opening the .jar. The Java Runtime Environment is required. | ||
| 26 | |||
| 27 | \subsubsection{Applet} | ||
| 28 | |||
| 29 | This interface can be executed as an applet on the | ||
| 30 | \href{http://esieequest.pacien.net/applet.html}{project's website /applet.html}. | ||
| 31 | |||
| 32 | |||
| 11 | \subsection{Console mode} | 33 | \subsection{Console mode} |
| 12 | 34 | ||
| 35 | To start the game in the console mode, open the .jar via the command line with | ||
| 36 | the ``--console'' argument. | ||
| 37 | |||
| 38 | \subsubsection{Test mode} | ||
| 39 | |||
| 40 | To execute the commands contained in a test file, execute the game from the | ||
| 41 | command line with the ``--file'' argument, followed by the path to the test | ||
| 42 | file. | ||
| 43 | |||
| 13 | 44 | ||
| 14 | \section{Commands} | 45 | \section{Commands} |
| 15 | 46 | ||
| 16 | [a big table] | 47 | \begin{tabular}{ l | l | p{8cm} } |
| 48 | Command & Argument & Description\\ | ||
| 49 | \hline | ||
| 50 | alea & <room name> & Force the destination of the transporter doors.\\ | ||
| 51 | back & none & Go back to the previous room.\\ | ||
| 52 | do & none & Automatically take an item or talk to a character, | ||
| 53 | according to the context.\\ | ||
| 54 | drop & <item> & Drop an item in the current side of the current | ||
| 55 | room.\\ | ||
| 56 | go & <cardinal direction|none> & Go in the given direction or | ||
| 57 | forward (in the direction of the current side)\\ | ||
| 58 | help & none & Display the available commands.\\ | ||
| 59 | inventory & none & Display the inventory.\\ | ||
| 60 | load & <file path> & Load a saved game from a file.\\ | ||
| 61 | look & none & Display informations about the current room.\\ | ||
| 62 | new & <challenge|none> & Create a new game, optionally in challenge | ||
| 63 | mode.\\ | ||
| 64 | quit & none & Quit the game.\\ | ||
| 65 | save & <file path> & Save the game to a file.\\ | ||
| 66 | sound & none & Toggle the sound (GUI and web only).\\ | ||
| 67 | take & <item|none> & Take an item from the room. Take one of the item | ||
| 68 | of the current side if no name specified.\\ | ||
| 69 | talk & <character|none> & Talk to a character in the room. Talk to the | ||
| 70 | character directly facing the player if no name specified.\\ | ||
| 71 | turn & <left|right> & Turn in the given direction.\\ | ||
| 72 | use & <item> & Use an item.\\ | ||
| 73 | \end{tabular} | ||