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.13 by elmex, Wed Oct 17 11:51:11 2007 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 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=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=back
42 109
43=head2 The Map 110=head2 The Map
44 111
45The map is always displayed in the background, behind all other windows and UI elements. 112The map is always displayed in the background, behind all other windows and UI elements.
46 113
107It displays what is on the tile your character stands on. If there are very many 174It 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. 175items there will be a "More..." button which will open up the Inventory.
109 176
110If you opened a container a button "Close container" will show up. 177If you opened a container a button "Close container" will show up.
111 178
112=head1 FAQ 179=head2 Setup
113 180
114=over 4 181This is the main setup window (opened via the I<Setup> button on the top of
182the client window), with following sub-windows:
115 183
116=item The client is very sluggish and slow, what can I do about this? 184=head3 Server
117 185
118Most likely, you don't have accelerated OpenGL support. Try to find a 186This window is for editing the connection settings and shows
119newer driver, or a driver from your hardware vendor, that features OpenGL 187some information about the currently connected server.
120support.
121 188
122If this is not an option, the following Setup options reduce the load and 189=head3 Pickup
123will likely make the client playable with software rendering (it will
124still be slow, though):
125 190
126=over 4 191Here you can configure your automatic pickup configuration.
127 192
128=item B<Video Mode> should be set as low as possible (e.g. 640x480) 193=head3 Graphics
129 194
130=item Enable B<Fast & Ugly> mode 195Here you can configure some aspects of the graphical appearance
196of the client.
131 197
132=item Disable B<Fog of War> 198=head3 Audio
133 199
134=item Increase B<Map Scale> 200This window lets you enable/disable audio and set the background music
201volume.
135 202
136=back 203=head3 Keyboard
137 204
138=back 205Here you can edit the key bindings you have made.
139 206
207B<PLEASE DON'T FORGET TO PRESS> I<Save Config> on the top of the client window
208after you are finished.
209
210=head3 Debug
211
212Here are some debugging options, which are maybe only interesting to the developers
213of the client.
214
215=head2 The Playerbook
216
217You can open the Playerbook by pressing B<tab> or by pressing B<F2> for
218the Statistics, B<F3> for the Skills, B<F4> for the Spellbook or B<F5> for the
219Inventory.
220
221What these are is explained below:
222
223=head3 Statistics
224
225=for image sc_statistics.jpg
226
227You can toggle this windows via B<F2>.
228
229This page tells you about your current status and statistics.
230The B<Player> frame shows your name, title and current map, and your
231current weight and maximum weight.
232
233The B<Primary/Secondary Statistics> informs you about the status of
234your L<primary statistics|glossary/primary statistics>, which is the group on the left and about the
235L<secondary statistics|glossary/secondary statistics> which is the group on the right.
236
237=head3 Skills
238
239=for image sc_skill_list.jpg
240
241You can toggle this windows via B<F3>.
242
243TBD
244
245=head3 Spellbook
246
247=for image sc_spellbook.jpg
248
249You can toggle this windows via B<F4>.
250
251=head3 X<playerbook_inventory>Inventory
252
253=for image sc_inventory.jpg
254
255You can toggle this windows via B<F5>.
256
257On the left side of this windows you see the player's inventory.
258On top the current weight and maximum weight are listed on the right
259of the B<sort order button>, which reveals following possible orders:
260
261=over 4
262
263=item Type/Name
264
265This order sorts the items first by type, and then by name.
266
267=item Recent/Normal/Locked
268
269This order puts the recently picked up or applied items to the top,
270then it displays the normal not so recently changed items, and to the last
271it displays the locked items.
272
273=item Weight/Type
274
275This order first sorts by weight and then by type.
276
277=back
278
279Below the sort order button there is the item list. You can hover the mouse cursor over
280the items to see what actions you can do with the mouse. Right click will
281show you the B<context menu>, with the following actions:
282
283=over 4
284
285=item examine
286
287This 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
297This marks the item for further operations, like L<thawing or igniting
298something with a flint and steel|faq_igniteandthaw>.
299
300=item ignite/thaw
301
302This will ignite for example a torch or thaw an icecube with a B<flint &
303steel> L<$ARCH/light/flint_and_steel.base.111.png>, which is B<required to
304be in your inventory> for this to work.
305
306=item inscribe
307
308This will let you write on something (eg. scrolls) with a B<pen>
309L<$ARCH/skills/Skill_Tools/stylus.base.111.png>, which is I<required to
310be in your inventory> for this to work.
311
312When you click on this context menu entry a small popup window will open
313where you can type in what you want to inscribe.
314
315=item rename
316
317This lets you rename an item. When you click on this context menu entry
318a small popup window will open and let you type in the new name for the
319item.
320
321=item apply
322
323This 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
333On the right side there will be displayed the currently open container
334or the floor on which you stand. There are nearly the same context menu
335operation aviable. On the top the is the name of the currently opened
336container or just 'Floor'.
337
338If a container is open, there will be a button 'Close container' which
339will apply the container in your inventory again to close it.
340
341=head2 X<binding_recorder>Binding Recorder
342
343This is a special facility which lets you record commands issued via the
344completer or the message window and bind them to a key.
345
346(I<Note:> as this facility is quite complicated it might change in future).
347
348It mainly works this way:
349
350First you have to I<start recording> via the button on the top.
351
352Then you can issue commands via the completer, or just run around, the
353commands will be recorded in the background.
354
355If you are finished with the command sequence click on I<stop recording>
356(the same button you used to start recording).
357
358Then you can see a list of the commands you issued and delete them if you
359want.
360
361Next you have to click on I<bind>, which will open a key query, where you
362have to press the corresponding key combination which you want to bind to
363this command sequence.
364
365After you are finished you have to click on B<OK>.
366
367B<Don't forget to> I<Save Config> B<!>
368

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines