ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/Deliantra-Client/pod/manual.pod
Revision: 1.10
Committed: Sun Sep 2 08:33:51 2007 UTC (16 years, 9 months ago) by root
Branch: MAIN
CVS Tags: rel-0_99
Changes since 1.9: +6 -2 lines
Log Message:
*** empty log message ***

File Contents

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