ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cf.schmorp.de/Deliantra-Client/pod/manual.pod
Revision: 1.16
Committed: Mon Jun 21 22:51:58 2010 UTC (14 years ago) by root
Branch: MAIN
CVS Tags: HEAD
Changes since 1.15: +2 -0 lines
Log Message:
*** empty log message ***

File Contents

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