ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/Deliantra-Client/pod/manual.pod
(Generate patch)

Comparing deliantra/Deliantra-Client/pod/manual.pod (file contents):
Revision 1.1 by root, Sun Aug 13 01:44:25 2006 UTC vs.
Revision 1.15 by root, Wed Apr 2 14:42:30 2008 UTC

1=head1 CFPlus Manual 1=head1 Deliantra Manual
2 2
3=head2 Features 3=head2 Features
4 4
5=over 4 5=over 4
6 6
7=item Fullscreen Map 7=item Fullscreen Map
8 8
9CF+ can uses a fullscreen map, which greatly enhances how much of the 9Deliantra uses a fullscreen map, which greatly enhances how much of the
10game world you can see. 10game world you can see.
11 11
12=item Persistent Map Cache (Crossfire+ only) 12=item Persistent Map Cache
13 13
14CF+ can persistently cache all map data it received from the 14Deliantra can persistently cache all map data it received from the
15server. This not only allows it to display an overview map, but also 15server. This not only allows it to display an overview map, but also
16ensures that once-explored areas will be available the next time you want 16ensures that once-explored areas will be available the next time you want
17to explore more. 17to explore more.
18 18
19=item Hardware acceleration 19=item Hardware acceleration
20 20
21Unlike most Crossfire clients, CF+ take advantage of OpenGL hardware 21Deliantra can take advantage of OpenGL hardware acceleration. Most modern
22acceleration. Most modern graphics cards have difficulties with 2D 22graphics cards have difficulties with 2D acceleration, while 3D graphics
23acceleration, while 3D graphics is accelerated well. 23is accelerated well.
24 24
25=item No arbitrary limits 25=item No arbitrary limits
26 26
27Unlike other Crossfire clients, CF+ does not suffer from arbitrary 27Deliantra does not suffer from arbitrary limits (like a fixed amount of
28limits (like a fixed amount of face numbers). There are still limits, but 28face numbers). There are still limits, but they are not arbitrarily low :)
29they are not arbitrarily low :)
30 29
31=item High quality text rendering 30=item High quality text rendering
32 31
33Although surprising at first, high quality text rendering is a real 32Although surprising at first, high quality text rendering is a real
34must have feature. For this, CF+ leverages Παν語 (PanGo) to offer 33must have feature. For this, Deliantra leverages Παν語 (PanGo) to offer
35real-world text output quality, so you can chat in 日本語 (japanese), 34real-world text output quality, so you can chat in 日本語 (japanese),
36ﺎﻠﻋﺮﺒﻳﺓ (arabic) or most any other language/script, as long 35ﺎﻠﻋﺮﺒﻳﺓ (arabic) or most any other language/script, as long
37as suitable fonts are installed. 36as suitable fonts are installed.
38 37
39=back 38=back
40 39
41=head1 Usage 40=head1 Usage
41
42=head2 X<the_keyboard>Keyboard/Keymappings
43
44The keyboard works quite similar to other programs: If a widget (e.g. a text entry) has the focus,
45you can enter and edit text there.
46
47Special key bindings apply to the playing area. It needs to be focused to
48work. If it doesn't have the focus, it will be tinted in red, in that case
49you can focus it by clicking into it.
50
51The 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=item B<Left-Shift-Tab> - toggle (make visible/invisible) the message window.
60
61=item B<Spacebar> - apply the item below you (selected by the server, usually the topmost item).
62
63=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
67=item B<Left-Alt-x> - close the currently active tab in the message window.
68
69=item B<,> (the comma) - take the item below you (selected by the server, usually the topmost item).
70
71=item Cursor/Arrow Keys, Keypad-B<12346789> - directional movement/attack.
72
73If you press the Alt-Modifier together with a Cursor/Arrow-Key, then you
74will use the next direction counterclockwise, this gives you access to the
75diagonal directions on keyboards without a numeric keypad. This works together
76with 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
84=back
85
86=item Keypad-B<5> - use your current range slot on yourself or the space where you are standing.
87
88=item Keypad-B<+> - toggle between your range and combat slots
89
90Only one of them can be active at any specific time. Deliantra
91automatically switches to the right slot when you attack, but sometimes a
92weapon (combat slot) has some specific effect (for example, lets you heal
93faster) which would not be working when your range slot is active.
94
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=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=back
42 112
43=head2 The Map 113=head2 The Map
44 114
45The map is always displayed in the background, behind all other windows and UI elements. 115The map is always displayed in the background, behind all other windows and UI elements.
46 116
107It displays what is on the tile your character stands on. If there are very many 177It displays what is on the tile your character stands on. If there are very many
108items there will be a "More..." button which will open up the Inventory. 178items there will be a "More..." button which will open up the Inventory.
109 179
110If you opened a container a button "Close container" will show up. 180If you opened a container a button "Close container" will show up.
111 181
112=head1 FAQ 182=head2 Setup
113 183
114=over 4 184This is the main setup window (opened via the I<Setup> button on the top of
185the client window), with following sub-windows:
115 186
116=item The client is very sluggish and slow, what can I do about this? 187=head3 Server
117 188
118Most likely, you don't have accelerated OpenGL support. Try to find a 189This window is for editing the connection settings and shows
119newer driver, or a driver from your hardware vendor, that features OpenGL 190some information about the currently connected server.
120support.
121 191
122If this is not an option, the following Setup options reduce the load and 192=head3 Pickup
123will likely make the client playable with software rendering (it will
124still be slow, though):
125 193
126=over 4 194Here you can configure your automatic pickup configuration.
127 195
128=item B<Video Mode> should be set as low as possible (e.g. 640x480) 196=head3 Graphics
129 197
130=item Enable B<Fast & Ugly> mode 198Here you can configure some aspects of the graphical appearance
199of the client.
131 200
132=item Disable B<Fog of War> 201=head3 Audio
133 202
134=item Increase B<Map Scale> 203This window lets you enable/disable audio and set the background music
204volume.
135 205
136=back 206=head3 Keyboard
137 207
138=back 208Here you can edit the key bindings you have made.
139 209
210B<PLEASE DON'T FORGET TO PRESS> I<Save Config> on the top of the client window
211after you are finished.
212
213=head3 Debug
214
215Here are some debugging options, which are maybe only interesting to the developers
216of the client.
217
218=head2 The Playerbook
219
220You can open the Playerbook by pressing B<tab> or by pressing B<F2> for
221the Statistics, B<F3> for the Skills, B<F4> for the Spellbook or B<F5> for the
222Inventory.
223
224What these are is explained below:
225
226=head3 Statistics
227
228=for image sc_statistics.jpg
229
230You can toggle this windows via B<F2>.
231
232This page tells you about your current status and statistics.
233The B<Player> frame shows your name, title and current map, and your
234current weight and maximum weight.
235
236The B<Primary/Secondary Statistics> informs you about the status of
237your L<primary statistics|glossary/primary statistics>, which is the group on the left and about the
238L<secondary statistics|glossary/secondary statistics> which is the group on the right.
239
240=head3 Skills
241
242=for image sc_skill_list.jpg
243
244You can toggle this windows via B<F3>.
245
246TBD
247
248=head3 Spellbook
249
250=for image sc_spellbook.jpg
251
252You can toggle this windows via B<F4>.
253
254=head3 X<playerbook_inventory>Inventory
255
256=for image sc_inventory.jpg
257
258You can toggle this windows via B<F5>.
259
260On the left side of this windows you see the player's inventory.
261On top the current weight and maximum weight are listed on the right
262of the B<sort order button>, which reveals following possible orders:
263
264=over 4
265
266=item Type/Name
267
268This order sorts the items first by type, and then by name.
269
270=item Recent/Normal/Locked
271
272This order puts the recently picked up or applied items to the top,
273then it displays the normal not so recently changed items, and to the last
274it displays the locked items.
275
276=item Weight/Type
277
278This order first sorts by weight and then by type.
279
280=back
281
282Below the sort order button there is the item list. You can hover the mouse cursor over
283the items to see what actions you can do with the mouse. Right click will
284show you the B<context menu>, with the following actions:
285
286=over 4
287
288=item examine
289
290This 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
300This marks the item for further operations, like L<thawing or igniting
301something with a flint and steel|faq_igniteandthaw>.
302
303=item ignite/thaw
304
305This will ignite for example a torch or thaw an icecube with a B<flint &
306steel> L<$ARCH/flint_and_steel.x11>, which is B<required to be in your
307inventory> for this to work.
308
309=item inscribe
310
311This will let you write on something (eg. scrolls) with a B<pen>
312L<$ARCH/stylus.x11>, which is I<required to be in your inventory> for this
313to work.
314
315When you click on this context menu entry a small popup window will open
316where you can type in what you want to inscribe.
317
318=item rename
319
320This lets you rename an item. When you click on this context menu entry
321a small popup window will open and let you type in the new name for the
322item.
323
324=item apply
325
326This 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
336On the right side there will be displayed the currently open container
337or the floor on which you stand. There are nearly the same context menu
338operation aviable. On the top the is the name of the currently opened
339container or just 'Floor'.
340
341If a container is open, there will be a button 'Close container' which
342will apply the container in your inventory again to close it.
343
344=head2 X<binding_recorder>Binding Recorder
345
346This is a special facility which lets you record commands issued via the
347completer or the message window and bind them to a key.
348
349(I<Note:> as this facility is quite complicated it might change in future).
350
351It mainly works this way:
352
353First you have to I<start recording> via the button on the top.
354
355Then you can issue commands via the completer, or just run around, the
356commands will be recorded in the background.
357
358If you are finished with the command sequence click on I<stop recording>
359(the same button you used to start recording).
360
361Then you can see a list of the commands you issued and delete them if you
362want.
363
364Next you have to click on I<bind>, which will open a key query, where you
365have to press the corresponding key combination which you want to bind to
366this command sequence.
367
368After you are finished you have to click on B<OK>.
369
370B<Don't forget to> I<Save Config> B<!>
371

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines