aboutsummaryrefslogtreecommitdiff
path: root/report/userguide.tex
blob: 5f73d38954fd6da129fbf8cdd17fefb6e4b33410 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
\chapter{User guide}

\section{Running the game}

\begin{tabular}{ l | l | l | l }
	Feature				&	Web		&	App		&	Console\\
	\hline
	Animations			&	YES		&	NO		&	NO\\
	Sound				&	YES		&	YES		&	NO\\
	Illustrations		&	YES		&	YES		&	NO\\
	Visual inventory	&	YES		&	YES		&	NO\\
	Keyboard shortcuts	&	YES		&	YES		&	NO\\
\end{tabular}

\subsection{Web version}

To start the web version of the game, simply go to the
\href{http://esieequest.pacien.net/#play}{project's website} using an up to date
web browser.


\subsection{Standalone app}

An offline version of the game referred as ``standalone app'' can be executed by
opening the .jar. The Java Runtime Environment is required.

Because of the size limit imposed by JNews, the version sent for evaluation does
not contain any image. To obtain the full version of the game, please go to
the project webpage.

\subsubsection{Applet}

This interface can be executed as an applet on the
\href{http://esieequest.pacien.net/applet.html}{project's website /applet.html}.


\subsection{Console mode}

To start the game in the console mode, open the .jar via the command line with
the ``--console'' argument.

\subsubsection{Test mode}

To execute the commands contained in a test file, execute the game from the
command line with the ``--file'' argument, followed by the path to the test
file.


\section{Commands}

\begin{tabular}{ l | l | p{8cm} }
	Command		&	Argument							&	Description\\
	\hline
	alea		&	<room name>							&	Force the destination of the transporter doors.\\
	back		&	none								&	Go back to the previous room.\\
	do			&	none								&	Automatically take an item or talk to a character,
	according to the context.\\
	drop		&	<item>								&	Drop an item in the current side of the current
	room.\\
	go			&	<cardinal direction|none>			&	Go in the given direction or
	forward (in the direction of the current side)\\
	help		&	none								&	Display the available commands.\\
	inventory	&	none								&	Display the inventory.\\
	load		&	<file path>							&	Load a saved game from a file.\\
	look		&	none								&	Display informations about the current room.\\
	new			&	<challenge|none>					&	Create a new game, optionally in challenge
	mode.\\
	quit		&	none								&	Quit the game.\\
	save		&	<file path>							&	Save the game to a file.\\
	sound		&	none								&	Toggle the sound (GUI and web only).\\
	take		&	<item|none>							&	Take an item from the room. Take one of the item
	of the current side if no name specified.\\
	talk		&	<character|none>					&	Talk to a character in the room. Talk to the
	character directly facing the player if no name specified.\\
	turn		&	<left|right>						&	Turn in the given direction.\\
	use			&	<item>								&	Use an item.\\
\end{tabular}

\section{Keyboard shortcuts}

\begin{tabular}{ l | l }
	Key			&	Action\\
	\hline
	Left arrow	&	Turn left\\
	Right arrow	&	Turn right\\
	Up arrow	&	Go forward\\
	Down arrow	&	Go back\\
	PgUp		&	Take/Talk\\
	Home		&	Open/Close the inventory\\
\end{tabular}