Deliantra-Client/pod/manual.pod

=head1 Deliantra Manual

=head2 Features

=over 4

=item Fullscreen Map

Deliantra uses a fullscreen map, which greatly enhances how much of the
game world you can see.

=item Persistent Map Cache

Deliantra can persistently cache all map data it received from the
server. This not only allows it to display an overview map, but also
ensures that once-explored areas will be available the next time you want
to explore more.

=item Hardware acceleration

Deliantra can take advantage of OpenGL hardware acceleration. Most modern
graphics cards have difficulties with 2D acceleration, while 3D graphics
is accelerated well.

=item No arbitrary limits

Deliantra does not suffer from arbitrary limits (like a fixed amount of
face numbers). There are still limits, but they are not arbitrarily low :)

=item High quality text rendering

Although surprising at first, high quality text rendering is a real
must have feature.  For this, Deliantra leverages Παν語 (PanGo) to offer
real-world text output quality, so you can chat in 日本語 (japanese),
ﺎﻠﻋﺮﺒﻳﺓ (arabic) or most any other language/script, as long
as suitable fonts are installed.

=back

=head1 Usage

=head2 X<the_keyboard>Keyboard/Keymappings

The keyboard works quite similar to other programs: If a widget (e.g. a text entry) has the focus,
you can enter and edit text there.

Special key bindings apply to the playing area. It needs to be focused to
work. If it doesn't have the focus, it will be tinted in red, in that case
you can focus it by clicking into it.

The following keys are available in the playing area:

=over 4

=item B<F1>..B<F9> - open various dialogs (use the right mouse button menu to see which).

=item B<Tab> - toggle (make visible/invisible) the playerbook window.

=item B<Left-Shift-Tab> - toggle (make visible/invisible) the message window.

=item B<Spacebar> - apply the item below you (selected by the server, usually the topmost item).

=item B<Return> - activate the currently-visible entry in the message window.

=item B<Left-Alt-1..9> - activate the nth tab in the message window.

=item B<Left-Alt-x> - close the currently active tab in the message window.

=item B<,> (the comma) - take the item below you (selected by the server, usually the topmost item).

=item Cursor/Arrow Keys, Keypad-B<12346789> - directional movement/attack.

If you press the Alt-Modifier together with a Cursor/Arrow-Key, then you
will use the next direction counterclockwise, this gives you access to the
diagonal directions on keyboards without a numeric keypad. This works together
with other modifiers, too.

=over 4

=item B<Shift>-I<direction> - use your ranged weapon slot to attack the space indicated by the direction key.

=item B<Ctrl>-I<direction> - run into the indicate direction as fast as possible, attacking everything in your way.

=back

=item Keypad-B<5> - use your current range slot on yourself or the space where you are standing.

=item Keypad-B<+> - toggle between your range and combat slots

Only one of them can be active at any specific time. Deliantra
automatically switches to the right slot when you attack, but sometimes a
weapon (combat slot) has some specific effect (for example, lets you heal
faster) which would not be working when your range slot is active.

=item B<'> - open the completer.

=item B<"> - open the completer, presetting it with your current communication command.

=item B<a>-B<z> (lowercase characters) - open the completer, presetting it with the character types.

=item B<Ctrl>-B<Insert> - open the macro recorder/key binding editor and start recording.

=item Keypad-B<enter> - examine item on floor.

=item B<Left-Alt-s> - ready_skill find traps

=item B<Left-Alt-d> - ready_skill disarm traps

=item B<Left-Alt-p> - ready_skill praying

=back

=head2 The Map

The map is always displayed in the background, behind all other windows and UI elements.

#TODO# middle-click scrolls
#
# keys:
#
# a apply
# keypad moves, kp_5 applies ranged attack to self

Starting to type enters the I<completion mode>. In that mode, you can type
abbreviations or commands and have them executed as soon as they match a
valid command. This is best explained by a few examples:

Typing B<climb> will display a list of commands with I<climb> in their
name, such as I<ready_skill climbing> and I<use_skill climbing>.

You can abbreviate commands by typing only the first character of every
word (or even characters within the word - the client will try to make
a good guess, as long as the characters are in order). For example,
typing I<iwor> will likely select I<invoke word of recall>, while I<ccfo>
will select I<cast create food>. Likewise, I<rscli> will likely select
I<ready_skill climbing> and I<usl> will give you I<use_skill levitation>.

You can enter space and other text as arguemnt to the command. For
example, C<cfoo waybread> will expand to C<cast create food waybread>.

=head2 The map overview

This is the small mini map in the upper left corner. It displays the areas which
you already visited before.

=head2 The Status area in the lower right corner

The area in the lower right corner displays the most interesting
stats while playing. The 4 gauges: Health, Mana/Spellpoints,
Grace and Food. The top of each gauge shows the current value
and the bottom value is the maximum value.

Going over each gauge with the mouse cursor will show a tooltip
with a detailed explanation of each stat.

Below the gauges there is a line that looks like this:

   Exp: ######## (lvl ####)

The former number are the experience points and the number in the parents
is the level of your character.
The level of the character depends on the experience points you have.
If the experience points reach a certain value your level rises or falls.
This depends on the experience table of the server you are currently playing on.

On the bottom there is a line:

   Rng: xxxxxxxxx

It tells you have you have in your range slot. The range slot is activated
if you "fire" (by pressing ctrl+direction key). For example there could be a spell
in your range slot or a weapon (like a bow) you will fire with.

=head2 The Floorbox

Right to the left of the status area there is the floorbox.
It displays what is on the tile your character stands on. If there are very many
items there will be a "More..." button which will open up the Inventory.

If you opened a container a button "Close container" will show up.

=head2 Setup

This is the main setup window (opened via the I<Setup> button on the top of
the client window), with following sub-windows:

=head3 Server

This window is for editing the connection settings and shows
some information about the currently connected server.

=head3 Pickup

Here you can configure your automatic pickup configuration.

=head3 Graphics

Here you can configure some aspects of the graphical appearance
of the client.

=head3 Audio

This window lets you enable/disable audio and set the background music
volume.

=head3 Keyboard

Here you can edit the key bindings you have made.

B<PLEASE DON'T FORGET TO PRESS> I<Save Config> on the top of the client window
after you are finished.

=head3 Debug

Here are some debugging options, which are maybe only interesting to the developers
of the client.

=head2 The Playerbook

You can open the Playerbook by pressing B<tab> or by pressing B<F2> for 
the Statistics, B<F3> for the Skills, B<F4> for the Spellbook or B<F5> for the
Inventory.

What these are is explained below:

=head3 Statistics

=for image sc_statistics.jpg

You can toggle this windows via B<F2>.

This page tells you about your current status and statistics. 
The B<Player> frame shows your name, title and current map, and your
current weight and maximum weight.

The B<Primary/Secondary Statistics> informs you about the status of
your L<primary statistics|glossary/primary statistics>, which is the group on the left and about the
L<secondary statistics|glossary/secondary statistics> which is the group on the right.

=head3 Skills

=for image sc_skill_list.jpg

You can toggle this windows via B<F3>.

TBD

=head3 Spellbook

=for image sc_spellbook.jpg

You can toggle this windows via B<F4>.

=head3 X<playerbook_inventory>Inventory

=for image sc_inventory.jpg

You can toggle this windows via B<F5>.

On the left side of this windows you see the player's inventory.
On top the current weight and maximum weight are listed on the right
of the B<sort order button>, which reveals following possible orders:

=over 4

=item Type/Name

This order sorts the items first by type, and then by name.

=item Recent/Normal/Locked

This order puts the recently picked up or applied items to the top,
then it displays the normal not so recently changed items, and to the last
it displays the locked items.

=item Weight/Type

This order first sorts by weight and then by type.

=back

Below the sort order button there is the item list. You can hover the mouse cursor over
the items to see what actions you can do with the mouse. Right click will 
show you the B<context menu>, with the following actions:

=over 4

=item examine

This will let you examine the item further and print informations like this:

   That is cloak (unidentified)
   It is made of: leather.
   It goes around your shoulders.
   It weights 5.000 kg.
   You reckon it is worth between 1 gold coin and 1 gold coin.

=item mark

This marks the item for further operations, like L<thawing or igniting
something with a flint and steel|faq_igniteandthaw>.

=item ignite/thaw

This will ignite for example a torch or thaw an icecube with a B<flint &
steel> L<$ARCH/flint_and_steel.x11>, which is B<required to be in your
inventory> for this to work.

=item inscribe

This will let you write on something (eg. scrolls) with a B<pen>
L<$ARCH/stylus.x11>, which is I<required to be in your inventory> for this
to work.

When you click on this context menu entry a small popup window will open
where you can type in what you want to inscribe.

=item rename

This lets you rename an item. When you click on this context menu entry
a small popup window will open and let you type in the new name for the
item.

=item apply

This L<applies|command/apply> an object.

=item lock/unlock

=item drop/put/take all

=item drop/put/take <n>

=back

On the right side there will be displayed the currently open container
or the floor on which you stand. There are nearly the same context menu
operation aviable. On the top the is the name of the currently opened
container or just 'Floor'.

If a container is open, there will be a button 'Close container' which
will apply the container in your inventory again to close it.

=head2 X<binding_recorder>Binding Recorder

This is a special facility which lets you record commands issued via the
completer or the message window and bind them to a key.

(I<Note:> as this facility is quite complicated it might change in future).

It mainly works this way:

First you have to I<start recording> via the button on the top.

Then you can issue commands via the completer, or just run around, the
commands will be recorded in the background.

If you are finished with the command sequence click on I<stop recording>
(the same button you used to start recording).

Then you can see a list of the commands you issued and delete them if you
want.

Next you have to click on I<bind>, which will open a key query, where you
have to press the corresponding key combination which you want to bind to
this command sequence.

After you are finished you have to click on B<OK>.

B<Don't forget to> I<Save Config> B<!>

Revision:	1.15
Committed:	Wed Apr 2 14:42:30 2008 UTC (16 years, 2 months ago) by root
Branch:	MAIN
CVS Tags:	rel-2_03, rel-2_02, rel-2_05, rel-2_04, rel-2_0, rel-2_10, rel-2_11, rel-0_9972, rel-0_9973, rel-0_9974, rel-0_9975, rel-0_9976, rel-0_9977, rel-0_9978, rel-0_9971, rel-1_21
Changes since 1.14:	+4 -4 lines
Log Message:	better arch import
#	User	Rev	Content
1	root	1.12	=head1 Deliantra Manual
2	root	1.1
3			=head2 Features
4
5			=over 4
6
7			=item Fullscreen Map
8
9	elmex	1.13	Deliantra uses a fullscreen map, which greatly enhances how much of the
10	root	1.1	game world you can see.
11
12	root	1.12	=item Persistent Map Cache
13	root	1.1
14	elmex	1.13	Deliantra can persistently cache all map data it received from the
15	root	1.1	server. This not only allows it to display an overview map, but also
16			ensures that once-explored areas will be available the next time you want
17			to explore more.
18
19			=item Hardware acceleration
20
21	elmex	1.13	Deliantra can take advantage of OpenGL hardware acceleration. Most modern
22	root	1.12	graphics cards have difficulties with 2D acceleration, while 3D graphics
23			is accelerated well.
24	root	1.1
25			=item No arbitrary limits
26
27	root	1.12	Deliantra does not suffer from arbitrary limits (like a fixed amount of
28			face numbers). There are still limits, but they are not arbitrarily low :)
29	root	1.1
30			=item High quality text rendering
31
32			Although surprising at first, high quality text rendering is a real
33	elmex	1.13	must have feature. For this, Deliantra leverages Παν語 (PanGo) to offer
34	root	1.1	real-world text output quality, so you can chat in 日本語 (japanese),
35			ﺎﻠﻋﺮﺒﻳﺓ (arabic) or most any other language/script, as long
36			as suitable fonts are installed.
37
38			=back
39
40			=head1 Usage
41
42	root	1.6	=head2 X<the_keyboard>Keyboard/Keymappings
43
44			The keyboard works quite similar to other programs: If a widget (e.g. a text entry) has the focus,
45			you can enter and edit text there.
46
47			Special key bindings apply to the playing area. It needs to be focused to
48			work. If it doesn't have the focus, it will be tinted in red, in that case
49			you can focus it by clicking into it.
50
51			The following keys are available in the playing area:
52
53			=over 4
54
55			=item B<F1>..B<F9> - open various dialogs (use the right mouse button menu to see which).
56
57			=item B<Tab> - toggle (make visible/invisible) the playerbook window.
58
59	root	1.10	=item B<Left-Shift-Tab> - toggle (make visible/invisible) the message window.
60
61	root	1.6	=item B<Spacebar> - apply the item below you (selected by the server, usually the topmost item).
62
63	root	1.10	=item B<Return> - activate the currently-visible entry in the message window.
64
65			=item B<Left-Alt-1..9> - activate the nth tab in the message window.
66	root	1.6
67	root	1.11	=item B<Left-Alt-x> - close the currently active tab in the message window.
68
69	root	1.6	=item B<,> (the comma) - take the item below you (selected by the server, usually the topmost item).
70
71	root	1.10	=item Cursor/Arrow Keys, Keypad-B<12346789> - directional movement/attack.
72	root	1.6
73	root	1.8	If you press the Alt-Modifier together with a Cursor/Arrow-Key, then you
74			will use the next direction counterclockwise, this gives you access to the
75			diagonal directions on keyboards without a numeric keypad. This works together
76			with other modifiers, too.
77
78			=over 4
79
80			=item B<Shift>-I<direction> - use your ranged weapon slot to attack the space indicated by the direction key.
81
82			=item B<Ctrl>-I<direction> - run into the indicate direction as fast as possible, attacking everything in your way.
83	root	1.6
84	root	1.8	=back
85	root	1.6
86	root	1.8	=item Keypad-B<5> - use your current range slot on yourself or the space where you are standing.
87	root	1.6
88	root	1.14	=item Keypad-B<+> - toggle between your range and combat slots
89	root	1.6
90	root	1.14	Only one of them can be active at any specific time. Deliantra
91			automatically switches to the right slot when you attack, but sometimes a
92			weapon (combat slot) has some specific effect (for example, lets you heal
93			faster) which would not be working when your range slot is active.
94	root	1.6
95			=item B<'> - open the completer.
96
97			=item B<"> - open the completer, presetting it with your current communication command.
98
99			=item B<a>-B<z> (lowercase characters) - open the completer, presetting it with the character types.
100
101			=item B<Ctrl>-B<Insert> - open the macro recorder/key binding editor and start recording.
102
103	root	1.9	=item Keypad-B<enter> - examine item on floor.
104
105			=item B<Left-Alt-s> - ready_skill find traps
106
107			=item B<Left-Alt-d> - ready_skill disarm traps
108
109			=item B<Left-Alt-p> - ready_skill praying
110
111	root	1.6	=back
112
113	root	1.1	=head2 The Map
114
115			The map is always displayed in the background, behind all other windows and UI elements.
116
117			#TODO# middle-click scrolls
118			#
119			# keys:
120			#
121			# a apply
122			# keypad moves, kp_5 applies ranged attack to self
123
124			Starting to type enters the I<completion mode>. In that mode, you can type
125			abbreviations or commands and have them executed as soon as they match a
126			valid command. This is best explained by a few examples:
127
128			Typing B<climb> will display a list of commands with I<climb> in their
129			name, such as I<ready_skill climbing> and I<use_skill climbing>.
130
131			You can abbreviate commands by typing only the first character of every
132			word (or even characters within the word - the client will try to make
133			a good guess, as long as the characters are in order). For example,
134			typing I<iwor> will likely select I<invoke word of recall>, while I<ccfo>
135			will select I<cast create food>. Likewise, I<rscli> will likely select
136			I<ready_skill climbing> and I<usl> will give you I<use_skill levitation>.
137
138			You can enter space and other text as arguemnt to the command. For
139			example, C<cfoo waybread> will expand to C<cast create food waybread>.
140
141			=head2 The map overview
142
143			This is the small mini map in the upper left corner. It displays the areas which
144			you already visited before.
145
146			=head2 The Status area in the lower right corner
147
148			The area in the lower right corner displays the most interesting
149			stats while playing. The 4 gauges: Health, Mana/Spellpoints,
150			Grace and Food. The top of each gauge shows the current value
151			and the bottom value is the maximum value.
152
153			Going over each gauge with the mouse cursor will show a tooltip
154			with a detailed explanation of each stat.
155
156			Below the gauges there is a line that looks like this:
157
158			Exp: ######## (lvl ####)
159
160			The former number are the experience points and the number in the parents
161			is the level of your character.
162			The level of the character depends on the experience points you have.
163			If the experience points reach a certain value your level rises or falls.
164			This depends on the experience table of the server you are currently playing on.
165
166			On the bottom there is a line:
167
168			Rng: xxxxxxxxx
169
170			It tells you have you have in your range slot. The range slot is activated
171			if you "fire" (by pressing ctrl+direction key). For example there could be a spell
172			in your range slot or a weapon (like a bow) you will fire with.
173
174			=head2 The Floorbox
175
176			Right to the left of the status area there is the floorbox.
177			It displays what is on the tile your character stands on. If there are very many
178			items there will be a "More..." button which will open up the Inventory.
179
180			If you opened a container a button "Close container" will show up.
181
182	elmex	1.2	=head2 Setup
183
184			This is the main setup window (opened via the I<Setup> button on the top of
185			the client window), with following sub-windows:
186
187			=head3 Server
188
189			This window is for editing the connection settings and shows
190			some information about the currently connected server.
191
192			=head3 Pickup
193
194			Here you can configure your automatic pickup configuration.
195
196			=head3 Graphics
197
198			Here you can configure some aspects of the graphical appearance
199			of the client.
200
201			=head3 Audio
202
203			This window lets you enable/disable audio and set the background music
204			volume.
205
206			=head3 Keyboard
207
208			Here you can edit the key bindings you have made.
209
210			B<PLEASE DON'T FORGET TO PRESS> I<Save Config> on the top of the client window
211			after you are finished.
212
213			=head3 Debug
214
215			Here are some debugging options, which are maybe only interesting to the developers
216			of the client.
217
218			=head2 The Playerbook
219
220			You can open the Playerbook by pressing B<tab> or by pressing B<F2> for
221			the Statistics, B<F3> for the Skills, B<F4> for the Spellbook or B<F5> for the
222			Inventory.
223
224			What these are is explained below:
225
226			=head3 Statistics
227
228	root	1.7	=for image sc_statistics.jpg
229	elmex	1.2
230			You can toggle this windows via B<F2>.
231
232			This page tells you about your current status and statistics.
233			The B<Player> frame shows your name, title and current map, and your
234			current weight and maximum weight.
235
236			The B<Primary/Secondary Statistics> informs you about the status of
237	root	1.5	your L<primary statistics\|glossary/primary statistics>, which is the group on the left and about the
238			L<secondary statistics\|glossary/secondary statistics> which is the group on the right.
239	elmex	1.2
240			=head3 Skills
241
242	root	1.7	=for image sc_skill_list.jpg
243	elmex	1.2
244			You can toggle this windows via B<F3>.
245
246			TBD
247
248			=head3 Spellbook
249
250	root	1.7	=for image sc_spellbook.jpg
251	elmex	1.2
252			You can toggle this windows via B<F4>.
253
254	elmex	1.3	=head3 X<playerbook_inventory>Inventory
255	elmex	1.2
256	root	1.7	=for image sc_inventory.jpg
257	elmex	1.2
258			You can toggle this windows via B<F5>.
259
260			On the left side of this windows you see the player's inventory.
261			On top the current weight and maximum weight are listed on the right
262			of the B<sort order button>, which reveals following possible orders:
263
264			=over 4
265
266			=item Type/Name
267
268			This order sorts the items first by type, and then by name.
269
270			=item Recent/Normal/Locked
271
272			This order puts the recently picked up or applied items to the top,
273			then it displays the normal not so recently changed items, and to the last
274			it displays the locked items.
275
276			=item Weight/Type
277
278			This order first sorts by weight and then by type.
279
280			=back
281
282			Below the sort order button there is the item list. You can hover the mouse cursor over
283			the items to see what actions you can do with the mouse. Right click will
284			show you the B<context menu>, with the following actions:
285
286			=over 4
287
288			=item examine
289
290			This will let you examine the item further and print informations like this:
291
292			That is cloak (unidentified)
293			It is made of: leather.
294			It goes around your shoulders.
295			It weights 5.000 kg.
296			You reckon it is worth between 1 gold coin and 1 gold coin.
297
298			=item mark
299
300	root	1.4	This marks the item for further operations, like L<thawing or igniting
301			something with a flint and steel\|faq_igniteandthaw>.
302	elmex	1.2
303			=item ignite/thaw
304
305	root	1.4	This will ignite for example a torch or thaw an icecube with a B<flint &
306	root	1.15	steel> L<$ARCH/flint_and_steel.x11>, which is B<required to be in your
307			inventory> for this to work.
308	elmex	1.2
309			=item inscribe
310
311	root	1.4	This will let you write on something (eg. scrolls) with a B<pen>
312	root	1.15	L<$ARCH/stylus.x11>, which is I<required to be in your inventory> for this
313			to work.
314	elmex	1.2
315	root	1.4	When you click on this context menu entry a small popup window will open
316			where you can type in what you want to inscribe.
317	elmex	1.2
318			=item rename
319
320	root	1.4	This lets you rename an item. When you click on this context menu entry
321			a small popup window will open and let you type in the new name for the
322			item.
323	elmex	1.2
324			=item apply
325
326			This L<applies\|command/apply> an object.
327
328			=item lock/unlock
329
330			=item drop/put/take all
331
332			=item drop/put/take <n>
333
334			=back
335
336	root	1.4	On the right side there will be displayed the currently open container
337			or the floor on which you stand. There are nearly the same context menu
338			operation aviable. On the top the is the name of the currently opened
339			container or just 'Floor'.
340	elmex	1.2
341	root	1.4	If a container is open, there will be a button 'Close container' which
342			will apply the container in your inventory again to close it.
343	elmex	1.2
344			=head2 X<binding_recorder>Binding Recorder
345
346	root	1.4	This is a special facility which lets you record commands issued via the
347			completer or the message window and bind them to a key.
348	elmex	1.2
349			(I<Note:> as this facility is quite complicated it might change in future).
350
351			It mainly works this way:
352
353			First you have to I<start recording> via the button on the top.
354
355	root	1.4	Then you can issue commands via the completer, or just run around, the
356			commands will be recorded in the background.
357	elmex	1.2
358	root	1.4	If you are finished with the command sequence click on I<stop recording>
359			(the same button you used to start recording).
360	elmex	1.2
361	root	1.4	Then you can see a list of the commands you issued and delete them if you
362			want.
363	elmex	1.2
364	root	1.4	Next you have to click on I<bind>, which will open a key query, where you
365			have to press the corresponding key combination which you want to bind to
366			this command sequence.
367	elmex	1.2
368			After you are finished you have to click on B<OK>.
369
370			B<Don't forget to> I<Save Config> B<!>
371