Deliantra-Client/pod/manual.pod

=head1 Deliantra Manual

=head2 Features

=over 4

=item Fullscreen Map

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

=item Persistent Map Cache

CF+ 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

Deliantratake 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, CF+ 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 B<+>, Keypad-B<+> - rotate through your range weapons.

=item B<->, Keypad-B<-> - rotate through your range weapons, the other way round.

=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/light/flint_and_steel.base.111.png>, 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/skills/Skill_Tools/stylus.base.111.png>, 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.12
Committed:	Sun Oct 14 15:33:31 2007 UTC (16 years, 8 months ago) by root
Branch:	MAIN
Changes since 1.11:	+7 -8 lines
Log Message:	raw rename
#	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			CF+ can uses a fullscreen map, which greatly enhances how much of the
10			game world you can see.
11
12	root	1.12	=item Persistent Map Cache
13	root	1.1
14			CF+ can persistently cache all map data it received from the
15			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	root	1.12	Deliantratake advantage of OpenGL hardware acceleration. Most modern
22			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			must have feature. For this, CF+ leverages Παν語 (PanGo) to offer
34			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			=item B<+>, Keypad-B<+> - rotate through your range weapons.
89
90			=item B<->, Keypad-B<-> - rotate through your range weapons, the other way round.
91
92			=item B<'> - open the completer.
93
94			=item B<"> - open the completer, presetting it with your current communication command.
95
96			=item B<a>-B<z> (lowercase characters) - open the completer, presetting it with the character types.
97
98			=item B<Ctrl>-B<Insert> - open the macro recorder/key binding editor and start recording.
99
100	root	1.9	=item Keypad-B<enter> - examine item on floor.
101
102			=item B<Left-Alt-s> - ready_skill find traps
103
104			=item B<Left-Alt-d> - ready_skill disarm traps
105
106			=item B<Left-Alt-p> - ready_skill praying
107
108	root	1.6	=back
109
110	root	1.1	=head2 The Map
111
112			The map is always displayed in the background, behind all other windows and UI elements.
113
114			#TODO# middle-click scrolls
115			#
116			# keys:
117			#
118			# a apply
119			# keypad moves, kp_5 applies ranged attack to self
120
121			Starting to type enters the I<completion mode>. In that mode, you can type
122			abbreviations or commands and have them executed as soon as they match a
123			valid command. This is best explained by a few examples:
124
125			Typing B<climb> will display a list of commands with I<climb> in their
126			name, such as I<ready_skill climbing> and I<use_skill climbing>.
127
128			You can abbreviate commands by typing only the first character of every
129			word (or even characters within the word - the client will try to make
130			a good guess, as long as the characters are in order). For example,
131			typing I<iwor> will likely select I<invoke word of recall>, while I<ccfo>
132			will select I<cast create food>. Likewise, I<rscli> will likely select
133			I<ready_skill climbing> and I<usl> will give you I<use_skill levitation>.
134
135			You can enter space and other text as arguemnt to the command. For
136			example, C<cfoo waybread> will expand to C<cast create food waybread>.
137
138			=head2 The map overview
139
140			This is the small mini map in the upper left corner. It displays the areas which
141			you already visited before.
142
143			=head2 The Status area in the lower right corner
144
145			The area in the lower right corner displays the most interesting
146			stats while playing. The 4 gauges: Health, Mana/Spellpoints,
147			Grace and Food. The top of each gauge shows the current value
148			and the bottom value is the maximum value.
149
150			Going over each gauge with the mouse cursor will show a tooltip
151			with a detailed explanation of each stat.
152
153			Below the gauges there is a line that looks like this:
154
155			Exp: ######## (lvl ####)
156
157			The former number are the experience points and the number in the parents
158			is the level of your character.
159			The level of the character depends on the experience points you have.
160			If the experience points reach a certain value your level rises or falls.
161			This depends on the experience table of the server you are currently playing on.
162
163			On the bottom there is a line:
164
165			Rng: xxxxxxxxx
166
167			It tells you have you have in your range slot. The range slot is activated
168			if you "fire" (by pressing ctrl+direction key). For example there could be a spell
169			in your range slot or a weapon (like a bow) you will fire with.
170
171			=head2 The Floorbox
172
173			Right to the left of the status area there is the floorbox.
174			It displays what is on the tile your character stands on. If there are very many
175			items there will be a "More..." button which will open up the Inventory.
176
177			If you opened a container a button "Close container" will show up.
178
179	elmex	1.2	=head2 Setup
180
181			This is the main setup window (opened via the I<Setup> button on the top of
182			the client window), with following sub-windows:
183
184			=head3 Server
185
186			This window is for editing the connection settings and shows
187			some information about the currently connected server.
188
189			=head3 Pickup
190
191			Here you can configure your automatic pickup configuration.
192
193			=head3 Graphics
194
195			Here you can configure some aspects of the graphical appearance
196			of the client.
197
198			=head3 Audio
199
200			This window lets you enable/disable audio and set the background music
201			volume.
202
203			=head3 Keyboard
204
205			Here you can edit the key bindings you have made.
206
207			B<PLEASE DON'T FORGET TO PRESS> I<Save Config> on the top of the client window
208			after you are finished.
209
210			=head3 Debug
211
212			Here are some debugging options, which are maybe only interesting to the developers
213			of the client.
214
215			=head2 The Playerbook
216
217			You can open the Playerbook by pressing B<tab> or by pressing B<F2> for
218			the Statistics, B<F3> for the Skills, B<F4> for the Spellbook or B<F5> for the
219			Inventory.
220
221			What these are is explained below:
222
223			=head3 Statistics
224
225	root	1.7	=for image sc_statistics.jpg
226	elmex	1.2
227			You can toggle this windows via B<F2>.
228
229			This page tells you about your current status and statistics.
230			The B<Player> frame shows your name, title and current map, and your
231			current weight and maximum weight.
232
233			The B<Primary/Secondary Statistics> informs you about the status of
234	root	1.5	your L<primary statistics\|glossary/primary statistics>, which is the group on the left and about the
235			L<secondary statistics\|glossary/secondary statistics> which is the group on the right.
236	elmex	1.2
237			=head3 Skills
238
239	root	1.7	=for image sc_skill_list.jpg
240	elmex	1.2
241			You can toggle this windows via B<F3>.
242
243			TBD
244
245			=head3 Spellbook
246
247	root	1.7	=for image sc_spellbook.jpg
248	elmex	1.2
249			You can toggle this windows via B<F4>.
250
251	elmex	1.3	=head3 X<playerbook_inventory>Inventory
252	elmex	1.2
253	root	1.7	=for image sc_inventory.jpg
254	elmex	1.2
255			You can toggle this windows via B<F5>.
256
257			On the left side of this windows you see the player's inventory.
258			On top the current weight and maximum weight are listed on the right
259			of the B<sort order button>, which reveals following possible orders:
260
261			=over 4
262
263			=item Type/Name
264
265			This order sorts the items first by type, and then by name.
266
267			=item Recent/Normal/Locked
268
269			This order puts the recently picked up or applied items to the top,
270			then it displays the normal not so recently changed items, and to the last
271			it displays the locked items.
272
273			=item Weight/Type
274
275			This order first sorts by weight and then by type.
276
277			=back
278
279			Below the sort order button there is the item list. You can hover the mouse cursor over
280			the items to see what actions you can do with the mouse. Right click will
281			show you the B<context menu>, with the following actions:
282
283			=over 4
284
285			=item examine
286
287			This will let you examine the item further and print informations like this:
288
289			That is cloak (unidentified)
290			It is made of: leather.
291			It goes around your shoulders.
292			It weights 5.000 kg.
293			You reckon it is worth between 1 gold coin and 1 gold coin.
294
295			=item mark
296
297	root	1.4	This marks the item for further operations, like L<thawing or igniting
298			something with a flint and steel\|faq_igniteandthaw>.
299	elmex	1.2
300			=item ignite/thaw
301
302	root	1.4	This will ignite for example a torch or thaw an icecube with a B<flint &
303			steel> L<$ARCH/light/flint_and_steel.base.111.png>, which is B<required to
304			be in your inventory> for this to work.
305	elmex	1.2
306			=item inscribe
307
308	root	1.4	This will let you write on something (eg. scrolls) with a B<pen>
309			L<$ARCH/skills/Skill_Tools/stylus.base.111.png>, which is I<required to
310			be in your inventory> for this to work.
311	elmex	1.2
312	root	1.4	When you click on this context menu entry a small popup window will open
313			where you can type in what you want to inscribe.
314	elmex	1.2
315			=item rename
316
317	root	1.4	This lets you rename an item. When you click on this context menu entry
318			a small popup window will open and let you type in the new name for the
319			item.
320	elmex	1.2
321			=item apply
322
323			This L<applies\|command/apply> an object.
324
325			=item lock/unlock
326
327			=item drop/put/take all
328
329			=item drop/put/take <n>
330
331			=back
332
333	root	1.4	On the right side there will be displayed the currently open container
334			or the floor on which you stand. There are nearly the same context menu
335			operation aviable. On the top the is the name of the currently opened
336			container or just 'Floor'.
337	elmex	1.2
338	root	1.4	If a container is open, there will be a button 'Close container' which
339			will apply the container in your inventory again to close it.
340	elmex	1.2
341			=head2 X<binding_recorder>Binding Recorder
342
343	root	1.4	This is a special facility which lets you record commands issued via the
344			completer or the message window and bind them to a key.
345	elmex	1.2
346			(I<Note:> as this facility is quite complicated it might change in future).
347
348			It mainly works this way:
349
350			First you have to I<start recording> via the button on the top.
351
352	root	1.4	Then you can issue commands via the completer, or just run around, the
353			commands will be recorded in the background.
354	elmex	1.2
355	root	1.4	If you are finished with the command sequence click on I<stop recording>
356			(the same button you used to start recording).
357	elmex	1.2
358	root	1.4	Then you can see a list of the commands you issued and delete them if you
359			want.
360	elmex	1.2
361	root	1.4	Next you have to click on I<bind>, which will open a key query, where you
362			have to press the corresponding key combination which you want to bind to
363			this command sequence.
364	elmex	1.2
365			After you are finished you have to click on B<OK>.
366
367			B<Don't forget to> I<Save Config> B<!>
368