Deliantra-Client/pod/manual.pod

=head1 CFPlus 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 (Crossfire+ only)

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

Unlike most Crossfire clients, CF+ 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

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