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.13 by root, Mon Jul 30 02:16:32 2007 UTC vs.
Revision 1.23 by root, Sun Jan 25 23:56:13 2009 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 (and what) you are wielding on certain body parts.
83
83fireborn, you have 4 fingers to put rings on. If you have 3 rings on it will 84For example as fireborn, you have 4 fingers to put rings on. If you have
84say: "on your finger 3 1", meaning you have 3 fingers full and one free. 853 rings on it will say: "on your finger 3 1", meaning you have 3 fingers
86full and one free.
87
88Both items as well as skills and other more esoteric objects can use those
89body parts.
85 90
86=head2 X<bowmode>bowmode (normal|threewide|spreadshot|bestarrow|.*) 91=head2 X<bowmode>bowmode (normal|threewide|spreadshot|bestarrow|.*)
87 92
88Bowmode controls how you will fire arrows and bolts. 93The C<bowmode> controls how you will fire arrows and bolts.
89 94
90The options are: 95The options are:
91 96
92=over 4 97=over 4
93 98
118 123
119When you enter the B<brace> command to brace your character, your 124When you enter the B<brace> command to brace your character, your
120character will no longer move. It can still attack adjoining 125character will no longer move. It can still attack adjoining
121spaces. Bracing can be useful to hold a location. 126spaces. Bracing can be useful to hold a location.
122 127
123When you are braced, you lose your dex bonus and incur a 2 point 128When 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 129ac 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 130fact come out ahead. You also only get 20% of the normal experience
126for killing creatures, and incure a 4 point wc (to hit) penalty. 131for killing creatures, and incur a 4 point WC (to hit) penalty.
127 132
128=head2 chat 133=head2 chat
129 134
130 chat <message> 135 chat <message>
131 136
132Sends a message to all players on the server that have 137Sends a message to all players on the server. This is the normal way to
133L<listen|command/listen> level B<10> or higher. 138chat with others.
134 139
135=head2 cast 140=head2 cast
136 141
137You use the cast command to set your range-weapon to the spell you 142You use the cast command to set your range-action-slot to the spell you
138want. Example: 143want. Example:
139 144
140 cast burning hands 145 cast burning hands
141 146
142sets your I<range> weapon to B<spell: burning hands>. 147sets your I<range> slot to B<spell: burning hands>.
143 148
144If you don't know the spell, shows which spells you do know. 149If you don't know the spell, shows which spells you do know.
145 150
146It is helpful to bind string like B<cast burning hands> to keys. 151It is helpful to bind string like B<cast burning hands> to keys.
147 152
148See B<range> for more information on range weapons. 153See C<help range> for more information on range weapons.
149 154
150=head2 X<drop>drop (all|unpaid|cursed|unlocked|.*) 155=head2 X<drop>drop (all|unpaid|cursed|unlocked|.*)
151 156
152 drop [number] name 157 drop [number] name
153 158
157 162
158There are a few special name values: 163There are a few special name values:
159 164
160=over 4 165=over 4
161 166
162=item B<all> 167=item B<all>: matches any item.
163 168
164matches any item. 169=item B<unpaid>: matches unpaid items.
165 170
166=item B<unpaid> 171=item B<cursed>: drops items known to be cursed or damned.
167 172
168matches unpaid items 173=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 174
178=back 175=back
179 176
180B<number> is optional. This acts as the number of the object to drop. The 177B<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 178objects 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 299Do not show the hints themselves, but notify you when a hint would have
303been available. 300been available.
304 301
305=item hide 302=item hide
306 303
307Hide all hints: You will not be able to tell wether there is a hint 304Hide all hints: You will not be able to tell whether there is a hint
308available or not. 305available or not.
309 306
310=back 307=back
311 308
312=head2 hiscore 309=head2 hiscore
320Lists all players that you currently ignore. 317Lists all players that you currently ignore.
321 318
322 ignore <player> <tell|shout|all> [timeout] 319 ignore <player> <tell|shout|all> [timeout]
323 320
324This command ignores the specified messages (B<tell> ignores tells, 321This command ignores the specified messages (B<tell> ignores tells,
325B<shout> ignores chat and shout and all ignores everything from the given 322B<shout> ignores chat and shout and B<all> ignores everything from the given
326user). 323user).
327 324
328The optional timeout (specified in hours) specifies then the ignore entry 325The optional timeout (specified in hours) specifies when the ignore entry
329expires. The default is 24 (one day). The reason why all ignores expire 326expires. 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 327expire after a day by default is that most troublemakers stop soon after
331being ignored. 328they are being ignored.
332 329
333To revoke an ignore, use the B<unignore> command. 330To revoke an ignore, use the B<unignore> command.
334 331
335=head2 inventory 332=head2 inventory
336 333
338status. Example: 335status. Example:
339 336
340 inventory 337 inventory
341 338
342 Inventory: 339 Inventory:
343 - arrow 0.1 340 - arrow 0.1
344 - Knife * 2 341 - Knife * 2
345 - long sword (wielded) 15 342 - long sword (wielded) 15
346 343
347This shows that you have one arrow which weighs 0.1kg and one Knife which you 344This 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 345protected from dropping by locking it as well as a long sword which you are
349currently using to attack. 346currently using to attack.
350 347
386 invoke magic rune of large fireball 383 invoke magic rune of large fireball
387 invoke reincarnation of Iamdead 384 invoke reincarnation of Iamdead
388 invoke create food of waybread 385 invoke create food of waybread
389 386
390It is very helpful to bind healing spells to keys, for example go to your 387It 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 388I<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 389spell 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, 390recommended to bind a healing spell or potion to an easily-accessible-key,
394such as '1'. 391such as '1'.
395 392
396 393
404they had will be left behind, but you will get no 401they had will be left behind, but you will get no
405experience for their death. However, it kills them 402experience for their death. However, it kills them
406instantaneously. 403instantaneously.
407 404
408If a name is specified then only pets with that 405If a name is specified then only pets with that
409name will be killed, eg killpets bat will kill bats 406name will be killed, e.g. killpets bat will kill bats
410but not bees. If a number is specified, the pet 407but not bees. If a number is specified, the pet
411corresponding to that number is killed. 408corresponding 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 409
431=head2 mapinfo 410=head2 mapinfo
432 411
433Shows some information about the map like this: 412Shows some information about the map like this:
434 413
444The rest is information the mapper may or may not provide. Often, this is 423The 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. 424the mapper's name, email and map creation date as this example shows.
446 425
447=head2 maps 426=head2 maps
448 427
449[crossfire+]
450
451 maps <mapname> 428 maps <mapname>
452 429
453Shows a list of maps matching the regex <mapname> that are currently being 430Shows 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: 431known to the server. The different fields are Pl, I, Svd, Reset and Path:
455 432
460=item I: B<I>n memory, B<S>wapped out or B<L>oading. 437=item I: B<I>n memory, B<S>wapped out or B<L>oading.
461 438
462The server keeps maps in memory only for a short time (by default about 439The server keeps maps in memory only for a short time (by default about
46340 seconds). After that time, it saves them to disk. As the server loads 44040 seconds). After that time, it saves them to disk. As the server loads
464most maps in the background it is possible that you can see a map that is 441most maps in the background it is possible that you can see a map that is
465currently being loaded, but thats rare, as loading a map is fast. 442currently being loaded, but that's rare, as loading a map is fast.
466 443
467=item Svd: the amount of seconds the map was last saved (++ means >99). 444=item Svd: the amount of seconds the map was last saved (++ means >99).
468 445
469The server by default tries to save each map at least every 20 seconds if 446The server by default tries to save each map at least every 20 seconds if
470it changed, so in case of a disastrous crash (one where the server cannot 447it changed, so in case of a disastrous crash (one where the server cannot
473=item Reset: the minimum number of seconds the map will stay as is (will not reset). 450=item Reset: the minimum number of seconds the map will stay as is (will not reset).
474 451
475Most maps will not reset as long as players are on it, and usually the 452Most 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 453reset 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 454maps will never reset in the common sense, these are usually marked with a
478very high number (sucha s C<1e+99>). 455very high number (such as C<1e+99>).
479 456
480=item Path: the name that uniquely identifies the map, can be used for goto etc. 457=item Path: the name that uniquely identifies the map, can be used for goto etc.
481 458
482=back 459=back
483 460
497 mark sword 474 mark sword
498 475
499B<mark> will look for best match first, and then look for matches based 476B<mark> will look for best match first, and then look for matches based
500on shortened name, object name, archetype name. It prints the match it 477on shortened name, object name, archetype name. It prints the match it
501finds. 478finds.
479
480=head2 me
481
482 me <message>
483
484Sends a message to all players on the server, similar to chat, but instead
485of using C<name chats: message>, the form C<* name message> is used, which
486is useful to describe yourself, such as:
487
488 me feels lonely
489 =>
490 * schmorp feels lonely
491
502 492
503=head2 motd 493=head2 motd
504 494
505Shows the message of the day. It takes no arguments. 495Shows the message of the day. It takes no arguments.
506 496
513message '10 times you kill orc' would be printed out. The default value is 503message '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 - 5041 - this means that all messages get printed out as they are requested -
515buffering is disabled in this regard. 505buffering is disabled in this regard.
516 506
517output-sync controls how often information is sent to the screen. Each 507output-sync controls how often information is sent to the screen. Each
518buffer has its own time value, and will be flushed independantly. The 508buffer has its own time value, and will be flushed independently. The
519default value is usually less than a second. 509default value is usually less than a second.
520 510
521See also L<output-sync>. 511See also L<output-sync>.
522 512
523=head2 output-rate 513=head2 output-rate
539=head2 output-sync 529=head2 output-sync
540 530
541 output-sync [seconds] 531 output-sync [seconds]
542 532
543output-sync controls how often information is sent to the screen. Each 533output-sync controls how often information is sent to the screen. Each
544buffer has its own time value, and will be flushed independantly. The 534buffer has its own time value, and will be flushed independently. The
545default value is usually less than a second. 535default value is usually less than a second.
546 536
547output-count sets after how many messages of the same type, they are 537output-count sets after how many messages of the same type, they are
548then printed out. If the value was 10, then after killing ten orcs, the 538then printed out. If the value was 10, then after killing ten orcs, the
549message '10 times you kill orc' would be printed out. The default value is 539message '10 times you kill orc' would be printed out. The default value is
578party leave 568party leave
579 takes you out of current party 569 takes you out of current party
580 570
581=head2 peaceful 571=head2 peaceful
582 572
583TODO: rework for cf.schmorp.de, intended future behaviour is to toggle 573TODO: rework for deliantra, intended future behaviour is to toggle
584peaceful mode with regards to npc and monsters only, not with regards to 574peaceful mode with regards to npc and monsters only, not with regards to
585players (which will be controlled by priests). 575players (which will be controlled by priests).
586 576
587The B<peaceful> command will switch you between peaceful and hostile attack 577The B<peaceful> command will switch you between peaceful and hostile attack
588modes. 578modes.
610 600
611=over 4 601=over 4
612 602
613=item B<normal> 603=item B<normal>
614 604
615As you would expect. 605Monsters behave normally, i.e. according to their own character.
616 606
617=item B<sad> (search and destroy) 607=item B<sad> (search and destroy)
618 608
619Pets will roam and seek out things to attack. 609Pets will roam and seek out things to attack.
620 610
628 618
629=back 619=back
630 620
631=head2 pickup 621=head2 pickup
632 622
623 pickup +mode
624 pickup -mode
625 pickup density
626
633B<pickup> changes how you pick up items when you step on them. to pickup 627B<pickup> changes whether you pick up items when you step on them. To
634an item manually, use the ',' key. 628pickup an item manually, use the ',' key.
635 629
636Mode 0: Don't pick up items. 630The B<Pickup> tab in the playerbook is usually a better way to modify your
631autopickup settings than using this command.
637 632
638Mode 1: Pick up one item 633Mode can be one of:
639 634
640Mode 2: Pickup up one item and stop 635 "debug", "inhibit", "stop", "food", "drink", "valuables", "bow",
636 "arrow", "helmet", "shield", "armour", "boots", "gloves", "cloak",
637 "key", "missile", "allweapon", "magical", "potion", "spellbook",
638 "skillscroll", "readables", "magicdevice", "notcursed", "jewels",
639 "flesh"
641 640
642Mode 3: Stop before picking up items 641If a number (C<density>, must be 0..15) is specified, then items of at
643 642least the specified value density are picked up. Value density is given as
644Mode 4: Pick up all items 643gold/weight in kilograms.
645
646Mode 5: Pick up all items and stop
647
648Mode 6: Pick up all magical items
649
650Mode 7: Pick up all coins and gems
651
652Modes above 7: Pickup items with
653a value density greater than the pickup mode.
654
655Value density is value in gold/weight in kilograms.
656 644
657The value in gold is what the item is worth if you sold it in the shop. 645The value in gold is what the item is worth if you sold it in the shop.
658
659Goldcoins have a value density of 66,
660
661Density 10 will pickup silver, gold, rings, wands, books, and scrolls.
662Artifacts are also picked up.
663
664 646
665=head2 prepare 647=head2 prepare
666 648
667The same as cast. Usage: 649The same as cast. Usage:
668 650
707 689
708If either of the names contain spaces, you have to use the C<">-form, 690If either of the names contain spaces, you have to use the C<">-form,
709otherwise you can just write the name as-is. If you omit the old name, the 691otherwise you can just write the name as-is. If you omit the old name, the
710marked item will be used instead. 692marked item will be used instead.
711 693
712If the new name is empty (i.e. C<"">), then the original (unrenamed) name 694If the new name is empty (i.e. C<"">), then the original (before the
713will be restored. 695rename) name will be restored.
714 696
715Note: maximum allowed name length is 127 characters. 697Note: maximum allowed name length is 127 characters.
716 698
717 699
718=head2 resistances 700=head2 resistances
758 740
759=head2 search-items 741=head2 search-items
760 742
761 search-items <word> 743 search-items <word>
762 744
763Automatically picks up all items with <word> in their name. search-items rod 745Automatically picks up all items with <word> in their name. C<search-items
764will pick up all rods and heavy rods. search-items of Fire will pick up all 746rod> will pick up all rods and heavy rods. C<search-items of Fire> will
765bolts, arrows, swords, etc. of Fire. 747pick up all bolts, arrows, swords, etc. of Fire, C<search-items magic+1>
748will pick up all items with magic+1, and so on, and so on.
749
750While this mode is active, you will be slower and the normal autopickup is
751disabled. To disable search mode again, execute C<search-items> without
752any arguments.
766 753
767=head2 seen 754=head2 seen
768 755
769 seen <login> 756 seen <login>
770 757
773 760
774=head2 shout 761=head2 shout
775 762
776 shout <message> 763 shout <message>
777 764
778Sends a message to all players on the server that have 765Sends a message to all players on the server. It is mainly useful for
779L<listen|command/listen> level B<10> or higher. It is mainly useful for
780emergency messages ("I am trapped on xxx, can somebody help me?") and 766emergency messages ("I am trapped on xxx, can somebody help me?") and
781should not be used for general chat. Use L<chat|command/chat> instead. 767should not be used for general chat. Use L<chat|command/chat> instead.
782 768
783=head2 showpets 769=head2 showpets
784 770
811applies to new items you pick up - items that you are already holding will 797applies to new items you pick up - items that you are already holding will
812not be sorted. 798not be sorted.
813 799
814If sort_inventory is not set (default), items will be inserted via type, 800If sort_inventory is not set (default), items will be inserted via type,
815subtype and magic. This, all axes will be grouped together in magic order, 801subtype and magic. This, all axes will be grouped together in magic order,
816all daggers by magic order, etc. Unforunately, for scrolls and rings, new 802all daggers by magic order, etc. Unfortunately, for scrolls and rings, new
817ones just get inserted last. 803ones just get inserted last.
818 804
819If you have a lot of stuff that is not in alphabetical order but you would 805If you have a lot of stuff that is not in alphabetical order but you would
820like it to be, the best method is to drop all of it and then pick it up. 806like it to be, the best method is to drop all of it and then pick it up.
821 807
822=head2 sound 808=head2 sound
823 809
824Toggles between sound enabled and disabled. This has no relevance to the 810Toggles between sound enabled and disabled. This has no relevance to the
825sound settings of the client, it only governs wether the server will send 811sound settings of the client, it only governs whether the server will send
826sound effect command to the client and is enabled if the client supports 812sound effect command to the client and is enabled if the client supports
827sound (i.e. always for cfplus). 813sound (i.e. always for the deliantra client).
828 814
829=head2 sourcecode 815=head2 sourcecode
830 816
831This command displays the means to download the sourcecode (server code, 817This command displays the means to download the source code (server code,
832maps and archetypes) used to implement this version of the game. 818maps and archetypes) used to implement this version of the game.
833 819
834Every player has the right to download and modify the source code of the 820Every player has the right to download and modify the source code of the
835server, as required by both the GNU General Public License and the GNU 821server, as required by both the GNU General Public License and the GNU
836Affero General Public license. 822Affero General Public license.
859Kills yourself. No, really. 845Kills yourself. No, really.
860 846
861This command might not look useful at first, but sometimes you can get 847This command might not look useful at first, but sometimes you can get
862yourself into a corner you can't escape anymore, either due to a map 848yourself into a corner you can't escape anymore, either due to a map
863bug or your own stupidity. Killing oneself can be difficult and time 849bug or your own stupidity. Killing oneself can be difficult and time
864consuming, thats why this command is provided. It is fast, painless, 850consuming, that's why this command is provided. It is fast, painless,
865effective, humane. 851effective, humane.
866 852
867=head2 take 853=head2 take
868 854
869The take commands take object(s) on the space the player is standing on, 855The take commands take object(s) on the space the player is standing on,
895thrown away. God-given items can not be thrown. You need the skill throwing 881thrown away. God-given items can not be thrown. You need the skill throwing
896for this to work. 882for this to work.
897 883
898=head2 time 884=head2 time
899 885
900Shows the Crossfire in-game time, not the server time. It looks like this: 886Shows the Deliantra in-game time, not the server time. It looks like this:
901 887
902 It is 52 minutes past 8 o'clock am, on the Day of the Bull 888 It is 52 minutes past 8 o'clock am, on the Day of the Bull,
903 The 2nd Day of the Month of the Frost Giant, Year 63 889 the 2nd Day of the Month of the Frost Giant, Year 63.
904 Time of Year: The Season of New Year 890 Time of Year: The Season of New Year.
905 891
906It is partially just for fun but it affects the darkness outside and the 892An hour of game time passes in 3 minutes of real time. The time and
907weather if weather is enabled in the server. 893calendar uses 60 minutes per hour, 28 hours per day, seven days per week,
894five weeks per month, and 17 months per year. The year is additionally
895split into four seasons of 4 months each, except the season of the
896Blizzard, which is 5 months long.
897
898The number "zero" is unknown, which is why the minutes go from 1 to 60.
899
900Seasons and the time of the day affect the overall outdoor daylight.
908 901
909=head2 title 902=head2 title
903
904 title <new title>
905 title clear # Sets your title back to your race.
910 906
911Players can change their title. For example you called yourself Gandalf and 907Players can change their title. For example you called yourself Gandalf and
912your race is elf, you can use the title command to change your name from 908your race is elf, you can use the title command to change your name from
913"Gandalf the elf" to "Gandalf the white". Usage: 909"Gandalf the elf" to "Gandalf the white" by using C<title the white>.
914
915 title <new title>
916 title clear # Sets your title back to your race.
917 910
918Dragons cannot set their title because it changes during the game. 911Dragons cannot set their title because it changes during the game.
919 912
920=head2 unignore 913=head2 unignore
921 914
939 932
940The B<usekeys> option determines the behaviour of using keys. 933The B<usekeys> option determines the behaviour of using keys.
941 934
942Values are: 935Values are:
943 936
937=over 4
938
944inventory: Only keys in the top level inventory are used (default) 939=item B<inventory>: Only keys in the top level inventory are used (default)
945 940
946keyrings: Only keys in active keyrings are used. 941=item B<keyrings>: Only keys in active key rings are used.
947 942
948containers: Only keys in active containers are used. 943=item B<containers>: Only keys in active containers are used.
949 944
945=back
946
950Note that keyrings are just a specialized container, so the containers 947Note that key rings are just a specialized container, so the containers
951will also find keys in keyrings. 948will also find keys in key rings.
952 949
953Only active containers are used - keys will not jump out of closed 950Only active containers are used - keys will not jump out of closed
954containers, but hints will be given if you have keys in such containers. 951containers, but hints will be given if you have keys in such containers.
955 952
956=head2 version 953=head2 version
989 986
990 987
991=head1 Authors 988=head1 Authors
992 989
993Parts of this document were originally taken from the crossfire server 990Parts of this document were originally taken from the crossfire server
994help files with unknwon authors. 991help files with unknown authors.
995 992
996Adapted for use by I<cfplus>, enhanced and corrected by Pippijn van 993Adapted for use by I<deliantra>, enhanced and corrected by Pippijn van
997Steenhoven and Marc A. Lehmann. 994Steenhoven and Marc A. Lehmann.
998 995

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines