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 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.png

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.png

You can toggle this windows via B<F3>.

TBD

=head3 Spellbook

=for image sc_spellbook.png

You can toggle this windows via B<F4>.

=head3 X<playerbook_inventory>Inventory

=for image sc_inventory.png

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.5
Committed:	Mon Aug 14 23:05:19 2006 UTC (17 years, 10 months ago) by root
Branch:	MAIN
CVS Tags:	rel-0_52, rel-0_51, rel-0_5
Changes since 1.4:	+2 -2 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			=head2 The Map
44
45			The map is always displayed in the background, behind all other windows and UI elements.
46
47			#TODO# middle-click scrolls
48			#
49			# keys:
50			#
51			# a apply
52			# keypad moves, kp_5 applies ranged attack to self
53
54			Starting to type enters the I<completion mode>. In that mode, you can type
55			abbreviations or commands and have them executed as soon as they match a
56			valid command. This is best explained by a few examples:
57
58			Typing B<climb> will display a list of commands with I<climb> in their
59			name, such as I<ready_skill climbing> and I<use_skill climbing>.
60
61			You can abbreviate commands by typing only the first character of every
62			word (or even characters within the word - the client will try to make
63			a good guess, as long as the characters are in order). For example,
64			typing I<iwor> will likely select I<invoke word of recall>, while I<ccfo>
65			will select I<cast create food>. Likewise, I<rscli> will likely select
66			I<ready_skill climbing> and I<usl> will give you I<use_skill levitation>.
67
68			You can enter space and other text as arguemnt to the command. For
69			example, C<cfoo waybread> will expand to C<cast create food waybread>.
70
71			=head2 The map overview
72
73			This is the small mini map in the upper left corner. It displays the areas which
74			you already visited before.
75
76			=head2 The Status area in the lower right corner
77
78			The area in the lower right corner displays the most interesting
79			stats while playing. The 4 gauges: Health, Mana/Spellpoints,
80			Grace and Food. The top of each gauge shows the current value
81			and the bottom value is the maximum value.
82
83			Going over each gauge with the mouse cursor will show a tooltip
84			with a detailed explanation of each stat.
85
86			Below the gauges there is a line that looks like this:
87
88			Exp: ######## (lvl ####)
89
90			The former number are the experience points and the number in the parents
91			is the level of your character.
92			The level of the character depends on the experience points you have.
93			If the experience points reach a certain value your level rises or falls.
94			This depends on the experience table of the server you are currently playing on.
95
96			On the bottom there is a line:
97
98			Rng: xxxxxxxxx
99
100			It tells you have you have in your range slot. The range slot is activated
101			if you "fire" (by pressing ctrl+direction key). For example there could be a spell
102			in your range slot or a weapon (like a bow) you will fire with.
103
104			=head2 The Floorbox
105
106			Right to the left of the status area there is the floorbox.
107			It displays what is on the tile your character stands on. If there are very many
108			items there will be a "More..." button which will open up the Inventory.
109
110			If you opened a container a button "Close container" will show up.
111
112	elmex	1.2	=head2 Setup
113
114			This is the main setup window (opened via the I<Setup> button on the top of
115			the client window), with following sub-windows:
116
117			=head3 Server
118
119			This window is for editing the connection settings and shows
120			some information about the currently connected server.
121
122			=head3 Pickup
123
124			Here you can configure your automatic pickup configuration.
125
126			=head3 Graphics
127
128			Here you can configure some aspects of the graphical appearance
129			of the client.
130
131			=head3 Audio
132
133			This window lets you enable/disable audio and set the background music
134			volume.
135
136			=head3 Keyboard
137
138			Here you can edit the key bindings you have made.
139
140			B<PLEASE DON'T FORGET TO PRESS> I<Save Config> on the top of the client window
141			after you are finished.
142
143			=head3 Debug
144
145			Here are some debugging options, which are maybe only interesting to the developers
146			of the client.
147
148			=head2 The Playerbook
149
150			You can open the Playerbook by pressing B<tab> or by pressing B<F2> for
151			the Statistics, B<F3> for the Skills, B<F4> for the Spellbook or B<F5> for the
152			Inventory.
153
154			What these are is explained below:
155
156			=head3 Statistics
157
158			=for image sc_statistics.png
159
160			You can toggle this windows via B<F2>.
161
162			This page tells you about your current status and statistics.
163			The B<Player> frame shows your name, title and current map, and your
164			current weight and maximum weight.
165
166			The B<Primary/Secondary Statistics> informs you about the status of
167	root	1.5	your L<primary statistics\|glossary/primary statistics>, which is the group on the left and about the
168			L<secondary statistics\|glossary/secondary statistics> which is the group on the right.
169	elmex	1.2
170			=head3 Skills
171
172			=for image sc_skill_list.png
173
174			You can toggle this windows via B<F3>.
175
176			TBD
177
178			=head3 Spellbook
179
180			=for image sc_spellbook.png
181
182			You can toggle this windows via B<F4>.
183
184	elmex	1.3	=head3 X<playerbook_inventory>Inventory
185	elmex	1.2
186			=for image sc_inventory.png
187
188			You can toggle this windows via B<F5>.
189
190			On the left side of this windows you see the player's inventory.
191			On top the current weight and maximum weight are listed on the right
192			of the B<sort order button>, which reveals following possible orders:
193
194			=over 4
195
196			=item Type/Name
197
198			This order sorts the items first by type, and then by name.
199
200			=item Recent/Normal/Locked
201
202			This order puts the recently picked up or applied items to the top,
203			then it displays the normal not so recently changed items, and to the last
204			it displays the locked items.
205
206			=item Weight/Type
207
208			This order first sorts by weight and then by type.
209
210			=back
211
212			Below the sort order button there is the item list. You can hover the mouse cursor over
213			the items to see what actions you can do with the mouse. Right click will
214			show you the B<context menu>, with the following actions:
215
216			=over 4
217
218			=item examine
219
220			This will let you examine the item further and print informations like this:
221
222			That is cloak (unidentified)
223			It is made of: leather.
224			It goes around your shoulders.
225			It weights 5.000 kg.
226			You reckon it is worth between 1 gold coin and 1 gold coin.
227
228			=item mark
229
230	root	1.4	This marks the item for further operations, like L<thawing or igniting
231			something with a flint and steel\|faq_igniteandthaw>.
232	elmex	1.2
233			=item ignite/thaw
234
235	root	1.4	This will ignite for example a torch or thaw an icecube with a B<flint &
236			steel> L<$ARCH/light/flint_and_steel.base.111.png>, which is B<required to
237			be in your inventory> for this to work.
238	elmex	1.2
239			=item inscribe
240
241	root	1.4	This will let you write on something (eg. scrolls) with a B<pen>
242			L<$ARCH/skills/Skill_Tools/stylus.base.111.png>, which is I<required to
243			be in your inventory> for this to work.
244	elmex	1.2
245	root	1.4	When you click on this context menu entry a small popup window will open
246			where you can type in what you want to inscribe.
247	elmex	1.2
248			=item rename
249
250	root	1.4	This lets you rename an item. When you click on this context menu entry
251			a small popup window will open and let you type in the new name for the
252			item.
253	elmex	1.2
254			=item apply
255
256			This L<applies\|command/apply> an object.
257
258			=item lock/unlock
259
260			=item drop/put/take all
261
262			=item drop/put/take <n>
263
264			=back
265
266	root	1.4	On the right side there will be displayed the currently open container
267			or the floor on which you stand. There are nearly the same context menu
268			operation aviable. On the top the is the name of the currently opened
269			container or just 'Floor'.
270	elmex	1.2
271	root	1.4	If a container is open, there will be a button 'Close container' which
272			will apply the container in your inventory again to close it.
273	elmex	1.2
274			=head2 X<binding_recorder>Binding Recorder
275
276	root	1.4	This is a special facility which lets you record commands issued via the
277			completer or the message window and bind them to a key.
278	elmex	1.2
279			(I<Note:> as this facility is quite complicated it might change in future).
280
281			It mainly works this way:
282
283			First you have to I<start recording> via the button on the top.
284
285	root	1.4	Then you can issue commands via the completer, or just run around, the
286			commands will be recorded in the background.
287	elmex	1.2
288	root	1.4	If you are finished with the command sequence click on I<stop recording>
289			(the same button you used to start recording).
290	elmex	1.2
291	root	1.4	Then you can see a list of the commands you issued and delete them if you
292			want.
293	elmex	1.2
294	root	1.4	Next you have to click on I<bind>, which will open a key query, where you
295			have to press the corresponding key combination which you want to bind to
296			this command sequence.
297	elmex	1.2
298			After you are finished you have to click on B<OK>.
299
300			B<Don't forget to> I<Save Config> B<!>
301