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.17 by root, Tue Jul 3 01:01:55 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
261=head2 hintmode [show|mark|hide] 269=head2 hintmode (show|mark|hide)
262 270
263 hintmode show|mark|hide 271 hintmode show|mark|hide
264 272
265Sets the I<hint mode> to the given value: Throughout the game you can find 273Sets the I<hint mode> to the given value: Throughout the game you can find
266hints that sometimes help you to solve a puzzle or manage a situation 274hints that sometimes help you to solve a puzzle or manage a situation
278Do not show the hints themselves, but notify you when a hint would have 286Do not show the hints themselves, but notify you when a hint would have
279been available. 287been available.
280 288
281=item hide 289=item hide
282 290
283Hide all hints: You will not be able to tell wether there is a hint 291Hide all hints: You will not be able to tell whether there is a hint
284available or not. 292available or not.
285 293
286=back 294=back
287 295
288=head2 hiscore 296=head2 hiscore
296Lists all players that you currently ignore. 304Lists all players that you currently ignore.
297 305
298 ignore <player> <tell|shout|all> [timeout] 306 ignore <player> <tell|shout|all> [timeout]
299 307
300This command ignores the specified messages (B<tell> ignores tells, 308This command ignores the specified messages (B<tell> ignores tells,
301B<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
302user). 310user).
303 311
304The optional timeout (specified in hours) specifies then the ignore entry 312The optional timeout (specified in hours) specifies when the ignore entry
305expires. 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
306after 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
307being ignored. 315they are being ignored.
308 316
309To revoke an ignore, use the B<unignore> command. 317To revoke an ignore, use the B<unignore> command.
310 318
311=head2 inventory 319=head2 inventory
312 320
314status. Example: 322status. Example:
315 323
316 inventory 324 inventory
317 325
318 Inventory: 326 Inventory:
319 - arrow 0.1 327 - arrow 0.1
320 - Knife * 2 328 - Knife * 2
321 - long sword (wielded) 15 329 - long sword (wielded) 15
322 330
323This 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
324protected 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
325currently using to attack. 333currently using to attack.
326 334
362 invoke magic rune of large fireball 370 invoke magic rune of large fireball
363 invoke reincarnation of Iamdead 371 invoke reincarnation of Iamdead
364 invoke create food of waybread 372 invoke create food of waybread
365 373
366It 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
367I<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
368spell 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
369recommended 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,
370such as '1'. 378such as '1'.
371 379
372 380
380they had will be left behind, but you will get no 388they had will be left behind, but you will get no
381experience for their death. However, it kills them 389experience for their death. However, it kills them
382instantaneously. 390instantaneously.
383 391
384If a name is specified then only pets with that 392If a name is specified then only pets with that
385name will be killed, eg killpets bat will kill bats 393name will be killed, e.g. killpets bat will kill bats
386but not bees. If a number is specified, the pet 394but not bees. If a number is specified, the pet
387corresponding to that number is killed. 395corresponding to that number is killed.
388
389=head2 listen
390
391 listen <listen-level>
392
393Listen sets the level of messages you will hear.
394Priorities are defined as follows:
395
396 0 - Nothing, not even "You punch kobold." or "You say: hi".
397 1 - Only messages that have to do with yourself.
398 2 - Emergency calls from other users
399 10 - General chatter with the 'chat' command.
400 11 - See what players kill what monster with what attack/spell. Very
401 verbose - only for the fanatics.
402
403=head2 logs
404
405TODO
406 396
407=head2 mapinfo 397=head2 mapinfo
408 398
409Shows some information about the map like this: 399Shows some information about the map like this:
410 400
420The 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
421the 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.
422 412
423=head2 maps 413=head2 maps
424 414
425[crossfire+]
426
427 maps <mapname> 415 maps <mapname>
428 416
429Shows 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
430known 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:
431 419
447emergency save), at most 20 seconds of gameplay are lost. 435emergency save), at most 20 seconds of gameplay are lost.
448 436
449=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).
450 438
451Most 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
452reset 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>).
453 443
454=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.
455 445
456=back 446=back
457 447
487message '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
4881 - 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 -
489buffering is disabled in this regard. 479buffering is disabled in this regard.
490 480
491output-sync controls how often information is sent to the screen. Each 481output-sync controls how often information is sent to the screen. Each
492buffer has its own time value, and will be flushed independantly. The 482buffer has its own time value, and will be flushed independently. The
493default value is usually less than a second. 483default value is usually less than a second.
494 484
495See also L<output-sync>. 485See also L<output-sync>.
496 486
487=head2 output-rate
488
497=head2 output-rate [bytes per second] 489 output-rate [bytes per second]
498 490
499Show 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
500value. 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
501per 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
502hold back less important information (such as new images), to increase 494hold back less important information (such as new images) to increase
495responsiveness.
496
503responsiveness. The server-side default is usually quite high, around 497The server-side default is usually quite high, around 100000. If the
504100000, 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
505character even when downloading faces, set this to a lower value, such as 499bandwidth available, and output-rate only sets an upper bound. That is,
5067000 (for ISDN). 500the server will automatically set an optimal send rate and adjusting your
501output-rate is not required.
507 502
508=head2 output-sync 503=head2 output-sync
509 504
510 output-sync [seconds] 505 output-sync [seconds]
511 506
512output-sync controls how often information is sent to the screen. Each 507output-sync controls how often information is sent to the screen. Each
513buffer has its own time value, and will be flushed independantly. The 508buffer has its own time value, and will be flushed independently. The
514default value is usually less than a second. 509default value is usually less than a second.
515 510
516output-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
517then 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
518message '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
547party leave 542party leave
548 takes you out of current party 543 takes you out of current party
549 544
550=head2 peaceful 545=head2 peaceful
551 546
552TODO: rework for cf.schmorp.de, intended future behaviour is to toggle 547TODO: rework for deliantra, intended future behaviour is to toggle
553peaceful 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
554players (which will be controlled by priests). 549players (which will be controlled by priests).
555 550
556The B<peaceful> command will switch you between peaceful and hostile attack 551The B<peaceful> command will switch you between peaceful and hostile attack
557modes. 552modes.
628Goldcoins have a value density of 66, 623Goldcoins have a value density of 66,
629 624
630Density 10 will pickup silver, gold, rings, wands, books, and scrolls. 625Density 10 will pickup silver, gold, rings, wands, books, and scrolls.
631Artifacts are also picked up. 626Artifacts are also picked up.
632 627
628
633=head2 prepare 629=head2 prepare
634 630
635The same as cast. Usage: 631The same as cast. Usage:
636 632
637 prepare <spell> 633 prepare <spell>
638 634
639=head2 X<quests>quests (|finished|.*)
640
641The quests command lists the quests you are doing or have completed.
642
643Parameters are:
644
645=over 4
646
647=item no arguments: displays current quests.
648
649=item B<finished>: displays finished quests;
650
651=item anything else: displays details for quests (finished or not) with name containing the given string.
652
653=back
654 635
655=head2 quit 636=head2 quit
656 637
657Deletes 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
658without 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
659bed (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
660top 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.
661 642
643
662=head2 range 644=head2 range
663 645
664Your 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
665bow-and-arrow, a rod, or a wand, to name a few. 647bow-and-arrow, a rod, or a wand, to name a few.
666 648
667Your 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
668fired in that direction. 650fired in that direction.
651
669 652
670=head2 ready_skill 653=head2 ready_skill
671 654
672 ready_skill <name of skill> 655 ready_skill <name of skill>
673 656
676readied, some need to be actively used by "firing" them. 659readied, some need to be actively used by "firing" them.
677 660
678If 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
679untouched, use L<use_skill> instead. 662untouched, use L<use_skill> instead.
680 663
664
681=head2 rename 665=head2 rename
682 666
683Changes/removes the custom name of given item (or the marked one). 667Changes/removes the custom name of given item (or the marked one).
684 668
685 rename oldname to newname 669 rename oldname to newname
687 671
688If 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,
689otherwise 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
690marked item will be used instead. 674marked item will be used instead.
691 675
692If 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
693will be restored. 677rename) name will be restored.
694 678
695Note: maximum allowed name length is 127 characters. 679Note: maximum allowed name length is 127 characters.
696 680
697=head2 reply
698
699 reply <message>
700
701Similar to tell, but instead of having to supply a username, it replies
702to the last player that sent you a tell. This is a bit racy (e.g. when
703somebody else tells you something while you type and you do not realise
704that), so be careful not to supply confidential information in the
705message.
706 681
707=head2 resistances 682=head2 resistances
708 683
709This shows you the resistances you have to specific attack types. 684This shows you the resistances you have to specific attack types.
710If 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
762 737
763=head2 shout 738=head2 shout
764 739
765 shout <message> 740 shout <message>
766 741
767Sends a message to all players on the server that have 742Sends a message to all players on the server. It is mainly useful for
768L<listen|command/listen> level B<10> or higher. It is mainly useful for
769emergency messages ("I am trapped on xxx, can somebody help me?") and 743emergency messages ("I am trapped on xxx, can somebody help me?") and
770should 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.
771 745
772=head2 showpets 746=head2 showpets
773 747
800applies 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
801not be sorted. 775not be sorted.
802 776
803If 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,
804subtype 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,
805all daggers by magic order, etc. Unforunately, for scrolls and rings, new 779all daggers by magic order, etc. Unfortunately, for scrolls and rings, new
806ones just get inserted last. 780ones just get inserted last.
807 781
808If 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
809like 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.
810 784
811=head2 sound 785=head2 sound
812 786
813Toggles between sound enabled and disabled. This has no relevance to the 787Toggles between sound enabled and disabled. This has no relevance to the
814sound 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
815sound 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
816sound (i.e. always for cfplus). 790sound (i.e. always for the deliantra client).
817 791
818=head2 sourcecode 792=head2 sourcecode
819 793
820This command displays the means to download the sourcecode (server code, 794This command displays the means to download the source code (server code,
821maps and archetypes) used to implement this version of the game. 795maps and archetypes) used to implement this version of the game.
822 796
823Every player has the right to download and modify the source code of the 797Every player has the right to download and modify the source code of the
824server, as required by both the GNU General Public License and the GNU 798server, as required by both the GNU General Public License and the GNU
825Affero General Public license. 799Affero General Public license.
884thrown 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
885for this to work. 859for this to work.
886 860
887=head2 time 861=head2 time
888 862
889Shows 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:
890 864
891 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
892 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
893 Time of Year: The Season of New Year 867 Time of Year: The Season of New Year
894 868
895It 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
896weather if weather is enabled in the server. 870weather if weather is enabled in the server.
897 871
898=head2 title 872=head2 title
899 873
874 title <new title>
875 title clear # Sets your title back to your race.
876
900Players can change their title. For example you called yourself Gandalf and 877Players can change their title. For example you called yourself Gandalf and
901your 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
902"Gandalf the elf" to "Gandalf the white". Usage: 879"Gandalf the elf" to "Gandalf the white" by using C<title the white>.
903
904 title <new title>
905 title clear # Sets your title back to your race.
906 880
907Dragons cannot set their title because it changes during the game. 881Dragons cannot set their title because it changes during the game.
908 882
909=head2 unignore 883=head2 unignore
910 884
928 902
929The B<usekeys> option determines the behaviour of using keys. 903The B<usekeys> option determines the behaviour of using keys.
930 904
931Values are: 905Values are:
932 906
907=over 4
908
933inventory: Only keys in the top level inventory are used (default) 909=item B<inventory>: Only keys in the top level inventory are used (default)
934 910
935keyrings: Only keys in active keyrings are used. 911=item B<keyrings>: Only keys in active key rings are used.
936 912
937containers: Only keys in active containers are used. 913=item B<containers>: Only keys in active containers are used.
938 914
915=back
916
939Note that keyrings are just a specialized container, so the containers 917Note that key rings are just a specialized container, so the containers
940will also find keys in keyrings. 918will also find keys in key rings.
941 919
942Only active containers are used - keys will not jump out of closed 920Only active containers are used - keys will not jump out of closed
943containers, 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.
944 922
945=head2 version 923=head2 version
978 956
979 957
980=head1 Authors 958=head1 Authors
981 959
982Parts of this document were originally taken from the crossfire server 960Parts of this document were originally taken from the crossfire server
983help files with unknwon authors. 961help files with unknown authors.
984 962
985Adapted for use by I<cfplus>, enhanced and corrected by Pippijn van 963Adapted for use by I<deliantra>, enhanced and corrected by Pippijn van
986Steenhoven and Marc A. Lehmann. 964Steenhoven and Marc A. Lehmann.
987 965

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines