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

Comparing deliantra/Deliantra-Client/pod/command_help.pod (file contents):
Revision 1.16 by root, Thu Jun 21 22:30:05 2007 UTC vs.
Revision 1.31 by root, Tue Sep 23 00:23:03 2008 UTC

1=head1 Crossfire TRT Command ListingX<command> 1=head1 Deliantra Command ListingX<command>
2 2
3=head2 accept-invitation 3=head2 accept-invitation
4 4
5Accepts an invitation previously issued by another player using the invite 5Accepts an invitation previously issued by another player using the invite
6command. This will transfer you to the location you were invited to. 6command. This will transfer you to the location you were invited to.
26 26
27These two options disable the toggling feature. 27These two options disable the toggling feature.
28 28
29=head2 X<applymode>applymode (nochoice|never|always) 29=head2 X<applymode>applymode (nochoice|never|always)
30 30
31Applymode controls what happens when you are equipping something that would 31the C<applymode> controls what happens when you are equipping something that would
32require something else to be unequipped. 32require something else to be unequipped.
33 33
34The options are: 34The options are:
35 35
36=over 4 36=over 4
69 69
70See L<apply|command/apply>. 70See L<apply|command/apply>.
71 71
72=head2 body 72=head2 body
73 73
74Shows how much you are wielding on certain bodyparts. For example as 74Shows how much you are wielding on certain body parts. For example as
75fireborn, you have 4 fingers to put rings on. If you have 3 rings on it will 75fireborn, you have 4 fingers to put rings on. If you have 3 rings on it will
76say: "on your finger 3 1", meaning you have 3 fingers full and one free. 76say: "on your finger 3 1", meaning you have 3 fingers full and one free.
77 77
78=head2 X<bowmode>bowmode (normal|threewide|spreadshot|bestarrow|.*) 78=head2 X<bowmode>bowmode (normal|threewide|spreadshot|bestarrow|.*)
79 79
80Bowmode controls how you will fire arrows and bolts. 80The C<bowmode> controls how you will fire arrows and bolts.
81 81
82The options are: 82The options are:
83 83
84=over 4 84=over 4
85 85
110 110
111When you enter the B<brace> command to brace your character, your 111When you enter the B<brace> command to brace your character, your
112character will no longer move. It can still attack adjoining 112character will no longer move. It can still attack adjoining
113spaces. Bracing can be useful to hold a location. 113spaces. Bracing can be useful to hold a location.
114 114
115When you are braced, you lose your dex bonus and incur a 2 point 115When you are braced, you lose your Dex bonus and incur a 2 point
116ac penalty beyond that (if you have a negative dex bonus, you may in 116ac penalty beyond that (if you have a negative Dex bonus, you may in
117fact come out ahead. You also only get 20% of the normal experience 117fact come out ahead. You also only get 20% of the normal experience
118for killing creatures, and incure a 4 point wc (to hit) penalty. 118for killing creatures, and incur a 4 point WC (to hit) penalty.
119 119
120=head2 chat 120=head2 chat
121 121
122 chat <message> 122 chat <message>
123 123
124Sends a message to all players on the server that have 124Sends a message to all players on the server. This is the normal way to
125L<listen|command/listen> level B<10> or higher. 125chat with others.
126 126
127=head2 cast 127=head2 cast
128 128
129You use the cast command to set your range-weapon to the spell you 129You use the cast command to set your range-action-slot to the spell you
130want. Example: 130want. Example:
131 131
132 cast burning hands 132 cast burning hands
133 133
134sets your I<range> weapon to B<spell: burning hands>. 134sets your I<range> slot to B<spell: burning hands>.
135 135
136If you don't know the spell, shows which spells you do know. 136If you don't know the spell, shows which spells you do know.
137 137
138It is helpful to bind string like B<cast burning hands> to keys. 138It is helpful to bind string like B<cast burning hands> to keys.
139 139
140See B<range> for more information on range weapons. 140See C<help range> for more information on range weapons.
141 141
142=head2 X<drop>drop (all|unpaid|cursed|unlocked|.*) 142=head2 X<drop>drop (all|unpaid|cursed|unlocked|.*)
143 143
144 drop [number] name 144 drop [number] name
145 145
149 149
150There are a few special name values: 150There are a few special name values:
151 151
152=over 4 152=over 4
153 153
154=item B<all> 154=item B<all>: matches any item.
155 155
156matches any item. 156=item B<unpaid>: matches unpaid items.
157 157
158=item B<unpaid> 158=item B<cursed>: drops items known to be cursed or damned.
159 159
160matches unpaid items 160=item B<unlocked>: drops items not locked in your inventory.
161
162=item B<cursed>
163
164drops items known to be cursed or damned.
165
166=item B<unlocked>
167
168drops items not locked in your inventory
169 161
170=back 162=back
171 163
172B<number> is optional. This acts as the number of the object to drop. The 164B<number> is optional. This acts as the number of the object to drop. The
173objects number must be at least the number for it to be dropped. For 165objects number must be at least the number for it to be dropped. For
175will be dropped. A collection of 5 scrolls will not be dropped. 167will be dropped. A collection of 5 scrolls will not be dropped.
176 168
177See also B<dropall> and mouse button control within client for dropping 169See also B<dropall> and mouse button control within client for dropping
178objects. 170objects.
179 171
172
173=head2 cointoss
174
175Tosses a coin and reports the outcome to you and other players on the same
176map, much like the say command does.
177
178
179=head2 orcknuckle
180
181Throws your orcknuckle set and reports the outcome to you and other
182players on the same map, much like the say command does. Your first
183three orcknuckle throws can report I<beholder>, I<ghost>, I<knight>,
184I<princess>, I<dragon>, while the fourth can additionally roll up to
185I<orc>.
186
187
180=head2 dropall 188=head2 dropall
181 189
182 dropall [type] 190 dropall [type]
183 191
184B<dropall> drops all items in your inventory to the ground, excepting 192B<dropall> drops all items in your inventory to the ground, excepting
256 264
257=head2 help 265=head2 help
258 266
259Gives you online help for the command or help topic specified. 267Gives you online help for the command or help topic specified.
260 268
269=head2 hintmode (show|mark|hide)
270
271 hintmode show|mark|hide
272
273Sets the I<hint mode> to the given value: Throughout the game you can find
274hints that sometimes help you to solve a puzzle or manage a situation
275better than without. You can change the display of these hints with this
276command:
277
278=over 4
279
280=item show
281
282Show the hints (the default mode).
283
284=item mark
285
286Do not show the hints themselves, but notify you when a hint would have
287been available.
288
289=item hide
290
291Hide all hints: You will not be able to tell whether there is a hint
292available or not.
293
294=back
295
261=head2 hiscore 296=head2 hiscore
262 297
263Shows a list of the highest level players in the game. 298Shows a list of the highest level players in the game.
264 299
265=head2 ignore 300=head2 ignore
269Lists all players that you currently ignore. 304Lists all players that you currently ignore.
270 305
271 ignore <player> <tell|shout|all> [timeout] 306 ignore <player> <tell|shout|all> [timeout]
272 307
273This command ignores the specified messages (B<tell> ignores tells, 308This command ignores the specified messages (B<tell> ignores tells,
274B<shout> ignores chat and shout and all ignores everything from the given 309B<shout> ignores chat and shout and B<all> ignores everything from the given
275user). 310user).
276 311
277The optional timeout (specified in hours) specifies then the ignore entry 312The optional timeout (specified in hours) specifies when the ignore entry
278expires. The default is 24 (one day). The reason why all ignores expire 313expires. The default is 24 (one day). The reason why all ignore entries
279after a day by default is that most troublemakers stop soon after they are 314expire after a day by default is that most troublemakers stop soon after
280being ignored. 315they are being ignored.
281 316
282To revoke an ignore, use the B<unignore> command. 317To revoke an ignore, use the B<unignore> command.
283 318
284=head2 inventory 319=head2 inventory
285 320
287status. Example: 322status. Example:
288 323
289 inventory 324 inventory
290 325
291 Inventory: 326 Inventory:
292 - arrow 0.1 327 - arrow 0.1
293 - Knife * 2 328 - Knife * 2
294 - long sword (wielded) 15 329 - long sword (wielded) 15
295 330
296This shows that you have one arrow which weighs 0.1kg and one Knife which you 331This shows that you have one arrow which weighs 0.1kg and one Knife which you
297protected from dropping by locking it as well as a long sword which you are 332protected from dropping by locking it as well as a long sword which you are
298currently using to attack. 333currently using to attack.
299 334
335 invoke magic rune of large fireball 370 invoke magic rune of large fireball
336 invoke reincarnation of Iamdead 371 invoke reincarnation of Iamdead
337 invoke create food of waybread 372 invoke create food of waybread
338 373
339It is very helpful to bind healing spells to keys, for example go to your 374It is very helpful to bind healing spells to keys, for example go to your
340I<playerbook>, tab I<spells>, the press the right mosue button on the 375I<playerbook>, tab I<spells>, the press the right mouse button on the
341spell I<medium healing> and choose C<bind invoke ... to a key>. It is 376spell I<medium healing> and choose C<bind invoke ... to a key>. It is
342recommended to bind a healing spell or potion to an easily-accessible-key, 377recommended to bind a healing spell or potion to an easily-accessible-key,
343such as '1'. 378such as '1'.
344 379
345 380
353they had will be left behind, but you will get no 388they had will be left behind, but you will get no
354experience for their death. However, it kills them 389experience for their death. However, it kills them
355instantaneously. 390instantaneously.
356 391
357If a name is specified then only pets with that 392If a name is specified then only pets with that
358name will be killed, eg killpets bat will kill bats 393name will be killed, e.g. killpets bat will kill bats
359but not bees. If a number is specified, the pet 394but not bees. If a number is specified, the pet
360corresponding to that number is killed. 395corresponding to that number is killed.
361
362=head2 listen
363
364 listen <listen-level>
365
366Listen sets the level of messages you will hear.
367Priorities are defined as follows:
368
369 0 - Nothing, not even "You punch kobold." or "You say: hi".
370 1 - Only messages that have to do with yourself.
371 2 - Emergency calls from other users
372 10 - General chatter with the 'chat' command.
373 11 - See what players kill what monster with what attack/spell. Very
374 verbose - only for the fanatics.
375
376=head2 logs
377
378TODO
379 396
380=head2 mapinfo 397=head2 mapinfo
381 398
382Shows some information about the map like this: 399Shows some information about the map like this:
383 400
393The rest is information the mapper may or may not provide. Often, this is 410The rest is information the mapper may or may not provide. Often, this is
394the mapper's name, email and map creation date as this example shows. 411the mapper's name, email and map creation date as this example shows.
395 412
396=head2 maps 413=head2 maps
397 414
398[crossfire+]
399
400 maps <mapname> 415 maps <mapname>
401 416
402Shows a list of maps matching the regex <mapname> that are currently being 417Shows a list of maps matching the regex <mapname> that are currently being
403known to the server. The different fields are Pl, I, Svd, Reset and Path: 418known to the server. The different fields are Pl, I, Svd, Reset and Path:
404 419
420emergency save), at most 20 seconds of gameplay are lost. 435emergency save), at most 20 seconds of gameplay are lost.
421 436
422=item Reset: the minimum number of seconds the map will stay as is (will not reset). 437=item Reset: the minimum number of seconds the map will stay as is (will not reset).
423 438
424Most maps will not reset as long as players are on it, and usually the 439Most maps will not reset as long as players are on it, and usually the
425reset counter only starts going down when all players left the map. 440reset counter only starts going down when all players left the map. Some
441maps will never reset in the common sense, these are usually marked with a
442very high number (such as C<1e+99>).
426 443
427=item Path: the name that uniquely identifies the map, can be used for goto etc. 444=item Path: the name that uniquely identifies the map, can be used for goto etc.
428 445
429=back 446=back
430 447
460message '10 times you kill orc' would be printed out. The default value is 477message '10 times you kill orc' would be printed out. The default value is
4611 - this means that all messages get printed out as they are requested - 4781 - this means that all messages get printed out as they are requested -
462buffering is disabled in this regard. 479buffering is disabled in this regard.
463 480
464output-sync controls how often information is sent to the screen. Each 481output-sync controls how often information is sent to the screen. Each
465buffer has its own time value, and will be flushed independantly. The 482buffer has its own time value, and will be flushed independently. The
466default value is usually less than a second. 483default value is usually less than a second.
467 484
468See also L<output-sync>. 485See also L<output-sync>.
469 486
487=head2 output-rate
488
470=head2 output-rate [bytes per second] 489 output-rate [bytes per second]
471 490
472Show the current setting of the output-rate, or set it to the provided 491Show the current setting of the output-rate, or set it to the provided
473value. The server will try not to send (much) more than this many bytes 492value. The server will try very hard not to send more than this many bytes
474per second to your client. If the rate is exceeded, the server tries to 493per second to your client. If the rate is exceeded, the server tries to
475hold back less important information (such as new images), to increase 494hold back less important information (such as new images) to increase
495responsiveness.
496
476responsiveness. The server-side default is usually quite high, around 497The server-side default is usually quite high, around 100000. If the
477100000, so if you have a slow link and want to be able to control your 498server is running on a Linux kernel, it will adjust to the actual
478character even when downloading faces, set this to a lower value, such as 499bandwidth available, and output-rate only sets an upper bound. That is,
4797000 (for ISDN). 500the server will automatically set an optimal send rate and adjusting your
501output-rate is not required.
480 502
481=head2 output-sync 503=head2 output-sync
482 504
483 output-sync [seconds] 505 output-sync [seconds]
484 506
485output-sync controls how often information is sent to the screen. Each 507output-sync controls how often information is sent to the screen. Each
486buffer has its own time value, and will be flushed independantly. The 508buffer has its own time value, and will be flushed independently. The
487default value is usually less than a second. 509default value is usually less than a second.
488 510
489output-count sets after how many messages of the same type, they are 511output-count sets after how many messages of the same type, they are
490then printed out. If the value was 10, then after killing ten orcs, the 512then printed out. If the value was 10, then after killing ten orcs, the
491message '10 times you kill orc' would be printed out. The default value is 513message '10 times you kill orc' would be printed out. The default value is
520party leave 542party leave
521 takes you out of current party 543 takes you out of current party
522 544
523=head2 peaceful 545=head2 peaceful
524 546
525TODO: rework for cf.schmorp.de, intended future behaviour is to toggle 547TODO: rework for deliantra, intended future behaviour is to toggle
526peaceful mode with regards to npc and monsters only, not with regards to 548peaceful mode with regards to npc and monsters only, not with regards to
527players (which will be controlled by priests). 549players (which will be controlled by priests).
528 550
529The B<peaceful> command will switch you between peaceful and hostile attack 551The B<peaceful> command will switch you between peaceful and hostile attack
530modes. 552modes.
601Goldcoins have a value density of 66, 623Goldcoins have a value density of 66,
602 624
603Density 10 will pickup silver, gold, rings, wands, books, and scrolls. 625Density 10 will pickup silver, gold, rings, wands, books, and scrolls.
604Artifacts are also picked up. 626Artifacts are also picked up.
605 627
628
606=head2 prepare 629=head2 prepare
607 630
608The same as cast. Usage: 631The same as cast. Usage:
609 632
610 prepare <spell> 633 prepare <spell>
611 634
612=head2 X<quests>quests (|finished|.*)
613
614The quests command lists the quests you are doing or have completed.
615
616Parameters are:
617
618=over 4
619
620=item no arguments: displays current quests.
621
622=item B<finished>: displays finished quests;
623
624=item anything else: displays details for quests (finished or not) with name containing the given string.
625
626=back
627 635
628=head2 quit 636=head2 quit
629 637
630Deletes your character from the server. If you want to quit the session 638Deletes your character from the server. If you want to quit the session
631without deleting your character, you must use a I<Bed to Reality>. Find a 639without deleting your character, you must use a I<Bed to Reality>. Find a
632bed (probably in a building close to where you entered the game), get on 640bed (probably in a building close to where you entered the game), get on
633top of it, and apply it using B<Tab> ro the B<apply> command. 641top of it, and apply it using B<Tab> ro the B<apply> command.
634 642
643
635=head2 range 644=head2 range
636 645
637Your range weapon can be one of several weapons, a spell you cast, a 646Your range weapon can be one of several weapons, a spell you cast, a
638bow-and-arrow, a rod, or a wand, to name a few. 647bow-and-arrow, a rod, or a wand, to name a few.
639 648
640Your range weapon is fired when you press SHIFT-direction, and will be 649Your range weapon is fired when you press SHIFT-direction, and will be
641fired in that direction. 650fired in that direction.
651
642 652
643=head2 ready_skill 653=head2 ready_skill
644 654
645 ready_skill <name of skill> 655 ready_skill <name of skill>
646 656
649readied, some need to be actively used by "firing" them. 659readied, some need to be actively used by "firing" them.
650 660
651If you just want to invoke a skill once, leaving your range slot 661If you just want to invoke a skill once, leaving your range slot
652untouched, use L<use_skill> instead. 662untouched, use L<use_skill> instead.
653 663
664
654=head2 rename 665=head2 rename
655 666
656Changes/removes the custom name of given item (or the marked one). 667Changes/removes the custom name of given item (or the marked one).
657 668
658 rename oldname to newname 669 rename oldname to newname
660 671
661If either of the names contain spaces, you have to use the C<">-form, 672If either of the names contain spaces, you have to use the C<">-form,
662otherwise you can just write the name as-is. If you omit the old name, the 673otherwise you can just write the name as-is. If you omit the old name, the
663marked item will be used instead. 674marked item will be used instead.
664 675
665If the new name is empty (i.e. C<"">), then the original (unrenamed) name 676If the new name is empty (i.e. C<"">), then the original (before the
666will be restored. 677rename) name will be restored.
667 678
668Note: maximum allowed name length is 127 characters. 679Note: maximum allowed name length is 127 characters.
669 680
670=head2 reply
671
672 reply <message>
673
674Similar to tell, but instead of having to supply a username, it replies
675to the last player that sent you a tell. This is a bit racy (e.g. when
676somebody else tells you something while you type and you do not realise
677that), so be careful not to supply confidential information in the
678message.
679 681
680=head2 resistances 682=head2 resistances
681 683
682This shows you the resistances you have to specific attack types. 684This shows you the resistances you have to specific attack types.
683If you have for example "cold +20", it means you get 20% damage done 685If you have for example "cold +20", it means you get 20% damage done
735 737
736=head2 shout 738=head2 shout
737 739
738 shout <message> 740 shout <message>
739 741
740Sends a message to all players on the server that have 742Sends a message to all players on the server. It is mainly useful for
741L<listen|command/listen> level B<10> or higher. It is mainly useful for
742emergency messages ("I am trapped on xxx, can somebody help me?") and 743emergency messages ("I am trapped on xxx, can somebody help me?") and
743should not be used for general chat. Use L<chat|command/chat> instead. 744should not be used for general chat. Use L<chat|command/chat> instead.
744 745
745=head2 showpets 746=head2 showpets
746 747
773applies to new items you pick up - items that you are already holding will 774applies to new items you pick up - items that you are already holding will
774not be sorted. 775not be sorted.
775 776
776If sort_inventory is not set (default), items will be inserted via type, 777If sort_inventory is not set (default), items will be inserted via type,
777subtype and magic. This, all axes will be grouped together in magic order, 778subtype and magic. This, all axes will be grouped together in magic order,
778all daggers by magic order, etc. Unforunately, for scrolls and rings, new 779all daggers by magic order, etc. Unfortunately, for scrolls and rings, new
779ones just get inserted last. 780ones just get inserted last.
780 781
781If you have a lot of stuff that is not in alphabetical order but you would 782If you have a lot of stuff that is not in alphabetical order but you would
782like it to be, the best method is to drop all of it and then pick it up. 783like it to be, the best method is to drop all of it and then pick it up.
783 784
784=head2 sound 785=head2 sound
785 786
786Toggles between sound enabled and disabled. This has no relevance to the 787Toggles between sound enabled and disabled. This has no relevance to the
787sound settings of the client, it only governs wether the server will send 788sound settings of the client, it only governs whether the server will send
788sound effect command to the client and is enabled if the client supports 789sound effect command to the client and is enabled if the client supports
789sound (i.e. always for cfplus). 790sound (i.e. always for the deliantra client).
791
792=head2 sourcecode
793
794This command displays the means to download the source code (server code,
795maps and archetypes) used to implement this version of the game.
796
797Every player has the right to download and modify the source code of the
798server, as required by both the GNU General Public License and the GNU
799Affero General Public license.
800
801If you modify your version of the server, you will have to provide a means
802to download the modified sources (and resources) via this command. If you
803run an unmodified version of the server, the default will do.
790 804
791=head2 statistics 805=head2 statistics
792 806
793B<statistics> shows various useful information about your character. 807B<statistics> shows various useful information about your character.
794None of the information it shows is stuff that is not contained in the 808None of the information it shows is stuff that is not contained in the
844thrown away. God-given items can not be thrown. You need the skill throwing 858thrown away. God-given items can not be thrown. You need the skill throwing
845for this to work. 859for this to work.
846 860
847=head2 time 861=head2 time
848 862
849Shows the Crossfire in-game time, not the server time. It looks like this: 863Shows the Deliantra in-game time, not the server time. It looks like this:
850 864
851 It is 52 minutes past 8 o'clock am, on the Day of the Bull 865 It is 52 minutes past 8 o'clock am, on the Day of the Bull
852 The 2nd Day of the Month of the Frost Giant, Year 63 866 The 2nd Day of the Month of the Frost Giant, Year 63
853 Time of Year: The Season of New Year 867 Time of Year: The Season of New Year
854 868
855It is partially just for fun but it affects the darkness outside and the 869It is partially just for fun but it affects the darkness outside and the
856weather if weather is enabled in the server. 870weather if weather is enabled in the server.
857 871
858=head2 title 872=head2 title
859 873
874 title <new title>
875 title clear # Sets your title back to your race.
876
860Players can change their title. For example you called yourself Gandalf and 877Players can change their title. For example you called yourself Gandalf and
861your race is elf, you can use the title command to change your name from 878your race is elf, you can use the title command to change your name from
862"Gandalf the elf" to "Gandalf the white". Usage: 879"Gandalf the elf" to "Gandalf the white" by using C<title the white>.
863
864 title <new title>
865 title clear # Sets your title back to your race.
866 880
867Dragons cannot set their title because it changes during the game. 881Dragons cannot set their title because it changes during the game.
868 882
869=head2 unignore 883=head2 unignore
870 884
888 902
889The B<usekeys> option determines the behaviour of using keys. 903The B<usekeys> option determines the behaviour of using keys.
890 904
891Values are: 905Values are:
892 906
907=over 4
908
893inventory: Only keys in the top level inventory are used (default) 909=item B<inventory>: Only keys in the top level inventory are used (default)
894 910
895keyrings: Only keys in active keyrings are used. 911=item B<keyrings>: Only keys in active key rings are used.
896 912
897containers: Only keys in active containers are used. 913=item B<containers>: Only keys in active containers are used.
898 914
915=back
916
899Note that keyrings are just a specialized container, so the containers 917Note that key rings are just a specialized container, so the containers
900will also find keys in keyrings. 918will also find keys in key rings.
901 919
902Only active containers are used - keys will not jump out of closed 920Only active containers are used - keys will not jump out of closed
903containers, but hints will be given if you have keys in such containers. 921containers, but hints will be given if you have keys in such containers.
904 922
905=head2 version 923=head2 version
938 956
939 957
940=head1 Authors 958=head1 Authors
941 959
942Parts of this document were originally taken from the crossfire server 960Parts of this document were originally taken from the crossfire server
943help files with unknwon authors. 961help files with unknown authors.
944 962
945Adapted for use by I<cfplus>, enhanced and corrected by Pippijn van 963Adapted for use by I<deliantra>, enhanced and corrected by Pippijn van
946Steenhoven and Marc A. Lehmann. 964Steenhoven and Marc A. Lehmann.
947 965

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines