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

Comparing deliantra/server/pod/command_help.pod (file contents):
Revision 1.12 by root, Fri Jul 20 18:43:04 2007 UTC vs.
Revision 1.17 by root, Tue Sep 23 00:22:41 2008 UTC

4*** The source for this file is in CFPlus/pod/command_help.pod 4*** The source for this file is in CFPlus/pod/command_help.pod
5*** Make any changes there and then run ./copy_doc 5*** Make any changes there and then run ./copy_doc
6*** 6***
7=end comment 7=end comment
8 8
9=head1 Crossfire TRT Command ListingX<command> 9=head1 Deliantra Command ListingX<command>
10 10
11=head2 accept-invitation 11=head2 accept-invitation
12 12
13Accepts an invitation previously issued by another player using the invite 13Accepts an invitation previously issued by another player using the invite
14command. This will transfer you to the location you were invited to. 14command. This will transfer you to the location you were invited to.
34 34
35These two options disable the toggling feature. 35These two options disable the toggling feature.
36 36
37=head2 X<applymode>applymode (nochoice|never|always) 37=head2 X<applymode>applymode (nochoice|never|always)
38 38
39Applymode controls what happens when you are equipping something that would 39the C<applymode> controls what happens when you are equipping something that would
40require something else to be unequipped. 40require something else to be unequipped.
41 41
42The options are: 42The options are:
43 43
44=over 4 44=over 4
77 77
78See L<apply|command/apply>. 78See L<apply|command/apply>.
79 79
80=head2 body 80=head2 body
81 81
82Shows how much you are wielding on certain bodyparts. For example as 82Shows how much you are wielding on certain body parts. For example as
83fireborn, you have 4 fingers to put rings on. If you have 3 rings on it will 83fireborn, you have 4 fingers to put rings on. If you have 3 rings on it will
84say: "on your finger 3 1", meaning you have 3 fingers full and one free. 84say: "on your finger 3 1", meaning you have 3 fingers full and one free.
85 85
86=head2 X<bowmode>bowmode (normal|threewide|spreadshot|bestarrow|.*) 86=head2 X<bowmode>bowmode (normal|threewide|spreadshot|bestarrow|.*)
87 87
88Bowmode controls how you will fire arrows and bolts. 88The C<bowmode> controls how you will fire arrows and bolts.
89 89
90The options are: 90The options are:
91 91
92=over 4 92=over 4
93 93
118 118
119When you enter the B<brace> command to brace your character, your 119When you enter the B<brace> command to brace your character, your
120character will no longer move. It can still attack adjoining 120character will no longer move. It can still attack adjoining
121spaces. Bracing can be useful to hold a location. 121spaces. Bracing can be useful to hold a location.
122 122
123When you are braced, you lose your dex bonus and incur a 2 point 123When you are braced, you lose your Dex bonus and incur a 2 point
124ac penalty beyond that (if you have a negative dex bonus, you may in 124ac penalty beyond that (if you have a negative Dex bonus, you may in
125fact come out ahead. You also only get 20% of the normal experience 125fact come out ahead. You also only get 20% of the normal experience
126for killing creatures, and incure a 4 point wc (to hit) penalty. 126for killing creatures, and incur a 4 point WC (to hit) penalty.
127 127
128=head2 chat 128=head2 chat
129 129
130 chat <message> 130 chat <message>
131 131
132Sends a message to all players on the server that have 132Sends a message to all players on the server. This is the normal way to
133L<listen|command/listen> level B<10> or higher. 133chat with others.
134 134
135=head2 cast 135=head2 cast
136 136
137You use the cast command to set your range-weapon to the spell you 137You use the cast command to set your range-action-slot to the spell you
138want. Example: 138want. Example:
139 139
140 cast burning hands 140 cast burning hands
141 141
142sets your I<range> weapon to B<spell: burning hands>. 142sets your I<range> slot to B<spell: burning hands>.
143 143
144If you don't know the spell, shows which spells you do know. 144If you don't know the spell, shows which spells you do know.
145 145
146It is helpful to bind string like B<cast burning hands> to keys. 146It is helpful to bind string like B<cast burning hands> to keys.
147 147
148See B<range> for more information on range weapons. 148See C<help range> for more information on range weapons.
149 149
150=head2 X<drop>drop (all|unpaid|cursed|unlocked|.*) 150=head2 X<drop>drop (all|unpaid|cursed|unlocked|.*)
151 151
152 drop [number] name 152 drop [number] name
153 153
157 157
158There are a few special name values: 158There are a few special name values:
159 159
160=over 4 160=over 4
161 161
162=item B<all> 162=item B<all>: matches any item.
163 163
164matches any item. 164=item B<unpaid>: matches unpaid items.
165 165
166=item B<unpaid> 166=item B<cursed>: drops items known to be cursed or damned.
167 167
168matches unpaid items 168=item B<unlocked>: drops items not locked in your inventory.
169
170=item B<cursed>
171
172drops items known to be cursed or damned.
173
174=item B<unlocked>
175
176drops items not locked in your inventory
177 169
178=back 170=back
179 171
180B<number> is optional. This acts as the number of the object to drop. The 172B<number> is optional. This acts as the number of the object to drop. The
181objects number must be at least the number for it to be dropped. For 173objects number must be at least the number for it to be dropped. For
302Do not show the hints themselves, but notify you when a hint would have 294Do not show the hints themselves, but notify you when a hint would have
303been available. 295been available.
304 296
305=item hide 297=item hide
306 298
307Hide all hints: You will not be able to tell wether there is a hint 299Hide all hints: You will not be able to tell whether there is a hint
308available or not. 300available or not.
309 301
310=back 302=back
311 303
312=head2 hiscore 304=head2 hiscore
320Lists all players that you currently ignore. 312Lists all players that you currently ignore.
321 313
322 ignore <player> <tell|shout|all> [timeout] 314 ignore <player> <tell|shout|all> [timeout]
323 315
324This command ignores the specified messages (B<tell> ignores tells, 316This command ignores the specified messages (B<tell> ignores tells,
325B<shout> ignores chat and shout and all ignores everything from the given 317B<shout> ignores chat and shout and B<all> ignores everything from the given
326user). 318user).
327 319
328The optional timeout (specified in hours) specifies then the ignore entry 320The optional timeout (specified in hours) specifies when the ignore entry
329expires. The default is 24 (one day). The reason why all ignores expire 321expires. The default is 24 (one day). The reason why all ignore entries
330after a day by default is that most troublemakers stop soon after they are 322expire after a day by default is that most troublemakers stop soon after
331being ignored. 323they are being ignored.
332 324
333To revoke an ignore, use the B<unignore> command. 325To revoke an ignore, use the B<unignore> command.
334 326
335=head2 inventory 327=head2 inventory
336 328
338status. Example: 330status. Example:
339 331
340 inventory 332 inventory
341 333
342 Inventory: 334 Inventory:
343 - arrow 0.1 335 - arrow 0.1
344 - Knife * 2 336 - Knife * 2
345 - long sword (wielded) 15 337 - long sword (wielded) 15
346 338
347This shows that you have one arrow which weighs 0.1kg and one Knife which you 339This shows that you have one arrow which weighs 0.1kg and one Knife which you
348protected from dropping by locking it as well as a long sword which you are 340protected from dropping by locking it as well as a long sword which you are
349currently using to attack. 341currently using to attack.
350 342
386 invoke magic rune of large fireball 378 invoke magic rune of large fireball
387 invoke reincarnation of Iamdead 379 invoke reincarnation of Iamdead
388 invoke create food of waybread 380 invoke create food of waybread
389 381
390It is very helpful to bind healing spells to keys, for example go to your 382It is very helpful to bind healing spells to keys, for example go to your
391I<playerbook>, tab I<spells>, the press the right mosue button on the 383I<playerbook>, tab I<spells>, the press the right mouse button on the
392spell I<medium healing> and choose C<bind invoke ... to a key>. It is 384spell I<medium healing> and choose C<bind invoke ... to a key>. It is
393recommended to bind a healing spell or potion to an easily-accessible-key, 385recommended to bind a healing spell or potion to an easily-accessible-key,
394such as '1'. 386such as '1'.
395 387
396 388
404they had will be left behind, but you will get no 396they had will be left behind, but you will get no
405experience for their death. However, it kills them 397experience for their death. However, it kills them
406instantaneously. 398instantaneously.
407 399
408If a name is specified then only pets with that 400If a name is specified then only pets with that
409name will be killed, eg killpets bat will kill bats 401name will be killed, e.g. killpets bat will kill bats
410but not bees. If a number is specified, the pet 402but not bees. If a number is specified, the pet
411corresponding to that number is killed. 403corresponding to that number is killed.
412
413=head2 listen
414
415 listen <listen-level>
416
417Listen sets the level of messages you will hear.
418Priorities are defined as follows:
419
420 0 - Nothing, not even "You punch kobold." or "You say: hi".
421 1 - Only messages that have to do with yourself.
422 2 - Emergency calls from other users
423 10 - General chatter with the 'chat' command.
424 11 - See what players kill what monster with what attack/spell. Very
425 verbose - only for the fanatics.
426
427=head2 logs
428
429TODO
430 404
431=head2 mapinfo 405=head2 mapinfo
432 406
433Shows some information about the map like this: 407Shows some information about the map like this:
434 408
444The rest is information the mapper may or may not provide. Often, this is 418The rest is information the mapper may or may not provide. Often, this is
445the mapper's name, email and map creation date as this example shows. 419the mapper's name, email and map creation date as this example shows.
446 420
447=head2 maps 421=head2 maps
448 422
449[crossfire+]
450
451 maps <mapname> 423 maps <mapname>
452 424
453Shows a list of maps matching the regex <mapname> that are currently being 425Shows a list of maps matching the regex <mapname> that are currently being
454known to the server. The different fields are Pl, I, Svd, Reset and Path: 426known to the server. The different fields are Pl, I, Svd, Reset and Path:
455 427
473=item Reset: the minimum number of seconds the map will stay as is (will not reset). 445=item Reset: the minimum number of seconds the map will stay as is (will not reset).
474 446
475Most maps will not reset as long as players are on it, and usually the 447Most maps will not reset as long as players are on it, and usually the
476reset counter only starts going down when all players left the map. Some 448reset counter only starts going down when all players left the map. Some
477maps will never reset in the common sense, these are usually marked with a 449maps will never reset in the common sense, these are usually marked with a
478very high number (sucha s C<1e+99>). 450very high number (such as C<1e+99>).
479 451
480=item Path: the name that uniquely identifies the map, can be used for goto etc. 452=item Path: the name that uniquely identifies the map, can be used for goto etc.
481 453
482=back 454=back
483 455
513message '10 times you kill orc' would be printed out. The default value is 485message '10 times you kill orc' would be printed out. The default value is
5141 - this means that all messages get printed out as they are requested - 4861 - this means that all messages get printed out as they are requested -
515buffering is disabled in this regard. 487buffering is disabled in this regard.
516 488
517output-sync controls how often information is sent to the screen. Each 489output-sync controls how often information is sent to the screen. Each
518buffer has its own time value, and will be flushed independantly. The 490buffer has its own time value, and will be flushed independently. The
519default value is usually less than a second. 491default value is usually less than a second.
520 492
521See also L<output-sync>. 493See also L<output-sync>.
522 494
495=head2 output-rate
496
523=head2 output-rate [bytes per second] 497 output-rate [bytes per second]
524 498
525Show the current setting of the output-rate, or set it to the provided 499Show the current setting of the output-rate, or set it to the provided
526value. The server will try not to send (much) more than this many bytes 500value. The server will try very hard not to send more than this many bytes
527per second to your client. If the rate is exceeded, the server tries to 501per second to your client. If the rate is exceeded, the server tries to
528hold back less important information (such as new images), to increase 502hold back less important information (such as new images) to increase
503responsiveness.
504
529responsiveness. The server-side default is usually quite high, around 505The server-side default is usually quite high, around 100000. If the
530100000, so if you have a slow link and want to be able to control your 506server is running on a Linux kernel, it will adjust to the actual
531character even when downloading faces, set this to a lower value, such as 507bandwidth available, and output-rate only sets an upper bound. That is,
5327000 (for ISDN). 508the server will automatically set an optimal send rate and adjusting your
509output-rate is not required.
533 510
534=head2 output-sync 511=head2 output-sync
535 512
536 output-sync [seconds] 513 output-sync [seconds]
537 514
538output-sync controls how often information is sent to the screen. Each 515output-sync controls how often information is sent to the screen. Each
539buffer has its own time value, and will be flushed independantly. The 516buffer has its own time value, and will be flushed independently. The
540default value is usually less than a second. 517default value is usually less than a second.
541 518
542output-count sets after how many messages of the same type, they are 519output-count sets after how many messages of the same type, they are
543then printed out. If the value was 10, then after killing ten orcs, the 520then printed out. If the value was 10, then after killing ten orcs, the
544message '10 times you kill orc' would be printed out. The default value is 521message '10 times you kill orc' would be printed out. The default value is
573party leave 550party leave
574 takes you out of current party 551 takes you out of current party
575 552
576=head2 peaceful 553=head2 peaceful
577 554
578TODO: rework for cf.schmorp.de, intended future behaviour is to toggle 555TODO: rework for deliantra, intended future behaviour is to toggle
579peaceful mode with regards to npc and monsters only, not with regards to 556peaceful mode with regards to npc and monsters only, not with regards to
580players (which will be controlled by priests). 557players (which will be controlled by priests).
581 558
582The B<peaceful> command will switch you between peaceful and hostile attack 559The B<peaceful> command will switch you between peaceful and hostile attack
583modes. 560modes.
654Goldcoins have a value density of 66, 631Goldcoins have a value density of 66,
655 632
656Density 10 will pickup silver, gold, rings, wands, books, and scrolls. 633Density 10 will pickup silver, gold, rings, wands, books, and scrolls.
657Artifacts are also picked up. 634Artifacts are also picked up.
658 635
636
659=head2 prepare 637=head2 prepare
660 638
661The same as cast. Usage: 639The same as cast. Usage:
662 640
663 prepare <spell> 641 prepare <spell>
664 642
665=head2 X<quests>quests (|finished|.*)
666
667The quests command lists the quests you are doing or have completed.
668
669Parameters are:
670
671=over 4
672
673=item no arguments: displays current quests.
674
675=item B<finished>: displays finished quests;
676
677=item anything else: displays details for quests (finished or not) with name containing the given string.
678
679=back
680 643
681=head2 quit 644=head2 quit
682 645
683Deletes your character from the server. If you want to quit the session 646Deletes your character from the server. If you want to quit the session
684without deleting your character, you must use a I<Bed to Reality>. Find a 647without deleting your character, you must use a I<Bed to Reality>. Find a
685bed (probably in a building close to where you entered the game), get on 648bed (probably in a building close to where you entered the game), get on
686top of it, and apply it using B<Tab> ro the B<apply> command. 649top of it, and apply it using B<Tab> ro the B<apply> command.
687 650
651
688=head2 range 652=head2 range
689 653
690Your range weapon can be one of several weapons, a spell you cast, a 654Your range weapon can be one of several weapons, a spell you cast, a
691bow-and-arrow, a rod, or a wand, to name a few. 655bow-and-arrow, a rod, or a wand, to name a few.
692 656
693Your range weapon is fired when you press SHIFT-direction, and will be 657Your range weapon is fired when you press SHIFT-direction, and will be
694fired in that direction. 658fired in that direction.
659
695 660
696=head2 ready_skill 661=head2 ready_skill
697 662
698 ready_skill <name of skill> 663 ready_skill <name of skill>
699 664
702readied, some need to be actively used by "firing" them. 667readied, some need to be actively used by "firing" them.
703 668
704If you just want to invoke a skill once, leaving your range slot 669If you just want to invoke a skill once, leaving your range slot
705untouched, use L<use_skill> instead. 670untouched, use L<use_skill> instead.
706 671
672
707=head2 rename 673=head2 rename
708 674
709Changes/removes the custom name of given item (or the marked one). 675Changes/removes the custom name of given item (or the marked one).
710 676
711 rename oldname to newname 677 rename oldname to newname
713 679
714If either of the names contain spaces, you have to use the C<">-form, 680If either of the names contain spaces, you have to use the C<">-form,
715otherwise you can just write the name as-is. If you omit the old name, the 681otherwise you can just write the name as-is. If you omit the old name, the
716marked item will be used instead. 682marked item will be used instead.
717 683
718If the new name is empty (i.e. C<"">), then the original (unrenamed) name 684If the new name is empty (i.e. C<"">), then the original (before the
719will be restored. 685rename) name will be restored.
720 686
721Note: maximum allowed name length is 127 characters. 687Note: maximum allowed name length is 127 characters.
722 688
723 689
724=head2 resistances 690=head2 resistances
779 745
780=head2 shout 746=head2 shout
781 747
782 shout <message> 748 shout <message>
783 749
784Sends a message to all players on the server that have 750Sends a message to all players on the server. It is mainly useful for
785L<listen|command/listen> level B<10> or higher. It is mainly useful for
786emergency messages ("I am trapped on xxx, can somebody help me?") and 751emergency messages ("I am trapped on xxx, can somebody help me?") and
787should not be used for general chat. Use L<chat|command/chat> instead. 752should not be used for general chat. Use L<chat|command/chat> instead.
788 753
789=head2 showpets 754=head2 showpets
790 755
817applies to new items you pick up - items that you are already holding will 782applies to new items you pick up - items that you are already holding will
818not be sorted. 783not be sorted.
819 784
820If sort_inventory is not set (default), items will be inserted via type, 785If sort_inventory is not set (default), items will be inserted via type,
821subtype and magic. This, all axes will be grouped together in magic order, 786subtype and magic. This, all axes will be grouped together in magic order,
822all daggers by magic order, etc. Unforunately, for scrolls and rings, new 787all daggers by magic order, etc. Unfortunately, for scrolls and rings, new
823ones just get inserted last. 788ones just get inserted last.
824 789
825If you have a lot of stuff that is not in alphabetical order but you would 790If you have a lot of stuff that is not in alphabetical order but you would
826like it to be, the best method is to drop all of it and then pick it up. 791like it to be, the best method is to drop all of it and then pick it up.
827 792
828=head2 sound 793=head2 sound
829 794
830Toggles between sound enabled and disabled. This has no relevance to the 795Toggles between sound enabled and disabled. This has no relevance to the
831sound settings of the client, it only governs wether the server will send 796sound settings of the client, it only governs whether the server will send
832sound effect command to the client and is enabled if the client supports 797sound effect command to the client and is enabled if the client supports
833sound (i.e. always for cfplus). 798sound (i.e. always for the deliantra client).
834 799
835=head2 sourcecode 800=head2 sourcecode
836 801
837This command displays the means to download the sourcecode (server code, 802This command displays the means to download the source code (server code,
838maps and archetypes) used to implement this version of the game. 803maps and archetypes) used to implement this version of the game.
839 804
840Every player has the right to download and modify the source code of the 805Every player has the right to download and modify the source code of the
841server, as required by both the GNU General Public License and the GNU 806server, as required by both the GNU General Public License and the GNU
842Affero General Public license. 807Affero General Public license.
901thrown away. God-given items can not be thrown. You need the skill throwing 866thrown away. God-given items can not be thrown. You need the skill throwing
902for this to work. 867for this to work.
903 868
904=head2 time 869=head2 time
905 870
906Shows the Crossfire in-game time, not the server time. It looks like this: 871Shows the Deliantra in-game time, not the server time. It looks like this:
907 872
908 It is 52 minutes past 8 o'clock am, on the Day of the Bull 873 It is 52 minutes past 8 o'clock am, on the Day of the Bull
909 The 2nd Day of the Month of the Frost Giant, Year 63 874 The 2nd Day of the Month of the Frost Giant, Year 63
910 Time of Year: The Season of New Year 875 Time of Year: The Season of New Year
911 876
912It is partially just for fun but it affects the darkness outside and the 877It is partially just for fun but it affects the darkness outside and the
913weather if weather is enabled in the server. 878weather if weather is enabled in the server.
914 879
915=head2 title 880=head2 title
916 881
882 title <new title>
883 title clear # Sets your title back to your race.
884
917Players can change their title. For example you called yourself Gandalf and 885Players can change their title. For example you called yourself Gandalf and
918your race is elf, you can use the title command to change your name from 886your race is elf, you can use the title command to change your name from
919"Gandalf the elf" to "Gandalf the white". Usage: 887"Gandalf the elf" to "Gandalf the white" by using C<title the white>.
920
921 title <new title>
922 title clear # Sets your title back to your race.
923 888
924Dragons cannot set their title because it changes during the game. 889Dragons cannot set their title because it changes during the game.
925 890
926=head2 unignore 891=head2 unignore
927 892
945 910
946The B<usekeys> option determines the behaviour of using keys. 911The B<usekeys> option determines the behaviour of using keys.
947 912
948Values are: 913Values are:
949 914
915=over 4
916
950inventory: Only keys in the top level inventory are used (default) 917=item B<inventory>: Only keys in the top level inventory are used (default)
951 918
952keyrings: Only keys in active keyrings are used. 919=item B<keyrings>: Only keys in active key rings are used.
953 920
954containers: Only keys in active containers are used. 921=item B<containers>: Only keys in active containers are used.
955 922
923=back
924
956Note that keyrings are just a specialized container, so the containers 925Note that key rings are just a specialized container, so the containers
957will also find keys in keyrings. 926will also find keys in key rings.
958 927
959Only active containers are used - keys will not jump out of closed 928Only active containers are used - keys will not jump out of closed
960containers, but hints will be given if you have keys in such containers. 929containers, but hints will be given if you have keys in such containers.
961 930
962=head2 version 931=head2 version
995 964
996 965
997=head1 Authors 966=head1 Authors
998 967
999Parts of this document were originally taken from the crossfire server 968Parts of this document were originally taken from the crossfire server
1000help files with unknwon authors. 969help files with unknown authors.
1001 970
1002Adapted for use by I<cfplus>, enhanced and corrected by Pippijn van 971Adapted for use by I<deliantra>, enhanced and corrected by Pippijn van
1003Steenhoven and Marc A. Lehmann. 972Steenhoven and Marc A. Lehmann.
1004 973

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines