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.25 by elmex, Wed Oct 17 11:51:11 2007 UTC vs.
Revision 1.39 by root, Sat Sep 5 21:09:40 2009 UTC

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 (and what) you are wielding on certain body parts.
75
75fireborn, you have 4 fingers to put rings on. If you have 3 rings on it will 76For example as fireborn, you have 4 fingers to put rings on. If you have
76say: "on your finger 3 1", meaning you have 3 fingers full and one free. 773 rings on it will say: "on your finger 3 1", meaning you have 3 fingers
78full and one free.
79
80Both items as well as skills and other more esoteric objects can use those
81body parts.
77 82
78=head2 X<bowmode>bowmode (normal|threewide|spreadshot|bestarrow|.*) 83=head2 X<bowmode>bowmode (normal|threewide|spreadshot|bestarrow|.*)
79 84
80Bowmode controls how you will fire arrows and bolts. 85The C<bowmode> controls how you will fire arrows and bolts.
81 86
82The options are: 87The options are:
83 88
84=over 4 89=over 4
85 90
110 115
111When you enter the B<brace> command to brace your character, your 116When you enter the B<brace> command to brace your character, your
112character will no longer move. It can still attack adjoining 117character will no longer move. It can still attack adjoining
113spaces. Bracing can be useful to hold a location. 118spaces. Bracing can be useful to hold a location.
114 119
115When you are braced, you lose your dex bonus and incur a 2 point 120When 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 121ac 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 122fact come out ahead. You also only get 20% of the normal experience
118for killing creatures, and incure a 4 point wc (to hit) penalty. 123for killing creatures, and incur a 4 point WC (to hit) penalty.
119 124
120=head2 chat 125=head2 chat
121 126
122 chat <message> 127 chat <message>
123 128
124Sends a message to all players on the server that have 129Sends a message to all players on the server. This is the normal way to
125L<listen|command/listen> level B<10> or higher. 130chat with others.
126 131
127=head2 cast 132=head2 cast
128 133
129You use the cast command to set your range-weapon to the spell you 134You use the cast command to set your range-action-slot to the spell you
130want. Example: 135want. Example:
131 136
132 cast burning hands 137 cast burning hands
133 138
134sets your I<range> weapon to B<spell: burning hands>. 139sets your I<range> slot to B<spell: burning hands>.
135 140
136If you don't know the spell, shows which spells you do know. 141If you don't know the spell, shows which spells you do know.
137 142
138It is helpful to bind string like B<cast burning hands> to keys. 143It is helpful to bind string like B<cast burning hands> to keys.
139 144
140See B<range> for more information on range weapons. 145See C<help range> for more information on range weapons.
141 146
142=head2 X<drop>drop (all|unpaid|cursed|unlocked|.*) 147=head2 X<drop>drop (all|unpaid|cursed|unlocked|.*)
143 148
144 drop [number] name 149 drop [number] name
145 150
146B<name> is the name of the item(s) to drop. It may match multiple items. 151B<name> is the name of the item(s) to drop. It may match multiple items.
147The name is matched against the start of the objects in your inventory. 152An object name matches when it contains the name. The name matching is
148The name matching is case insensitive. 153case insensitive.
149 154
150There are a few special name values: 155There are a few special name values:
151 156
152=over 4 157=over 4
153 158
154=item B<all> 159=item B<all>: matches any item.
155 160
156matches any item. 161=item B<unpaid>: matches unpaid items.
157 162
158=item B<unpaid> 163=item B<cursed>: drops items known to be cursed or damned.
159 164
160matches unpaid items 165=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 166
170=back 167=back
171 168
172B<number> is optional. This acts as the number of the object to drop. The 169B<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 170objects number must be at least the number for it to be dropped. For
294Do not show the hints themselves, but notify you when a hint would have 291Do not show the hints themselves, but notify you when a hint would have
295been available. 292been available.
296 293
297=item hide 294=item hide
298 295
299Hide all hints: You will not be able to tell wether there is a hint 296Hide all hints: You will not be able to tell whether there is a hint
300available or not. 297available or not.
301 298
302=back 299=back
303 300
304=head2 hiscore 301=head2 hiscore
312Lists all players that you currently ignore. 309Lists all players that you currently ignore.
313 310
314 ignore <player> <tell|shout|all> [timeout] 311 ignore <player> <tell|shout|all> [timeout]
315 312
316This command ignores the specified messages (B<tell> ignores tells, 313This command ignores the specified messages (B<tell> ignores tells,
317B<shout> ignores chat and shout and all ignores everything from the given 314B<shout> ignores chat and shout and B<all> ignores everything from the given
318user). 315user).
319 316
320The optional timeout (specified in hours) specifies then the ignore entry 317The optional timeout (specified in hours) specifies when the ignore entry
321expires. The default is 24 (one day). The reason why all ignores expire 318expires. The default is 24 (one day). The reason why all ignore entries
322after a day by default is that most troublemakers stop soon after they are 319expire after a day by default is that most troublemakers stop soon after
323being ignored. 320they are being ignored.
324 321
325To revoke an ignore, use the B<unignore> command. 322To revoke an ignore, use the B<unignore> command.
326 323
327=head2 inventory 324=head2 inventory
328 325
330status. Example: 327status. Example:
331 328
332 inventory 329 inventory
333 330
334 Inventory: 331 Inventory:
335 - arrow 0.1 332 - arrow 0.1
336 - Knife * 2 333 - Knife * 2
337 - long sword (wielded) 15 334 - long sword (wielded) 15
338 335
339This shows that you have one arrow which weighs 0.1kg and one Knife which you 336This shows that you have one arrow which weighs 0.1kg and one Knife which you
340protected from dropping by locking it as well as a long sword which you are 337protected from dropping by locking it as well as a long sword which you are
341currently using to attack. 338currently using to attack.
342 339
378 invoke magic rune of large fireball 375 invoke magic rune of large fireball
379 invoke reincarnation of Iamdead 376 invoke reincarnation of Iamdead
380 invoke create food of waybread 377 invoke create food of waybread
381 378
382It is very helpful to bind healing spells to keys, for example go to your 379It is very helpful to bind healing spells to keys, for example go to your
383I<playerbook>, tab I<spells>, the press the right mosue button on the 380I<playerbook>, tab I<spells>, the press the right mouse button on the
384spell I<medium healing> and choose C<bind invoke ... to a key>. It is 381spell I<medium healing> and choose C<bind invoke ... to a key>. It is
385recommended to bind a healing spell or potion to an easily-accessible-key, 382recommended to bind a healing spell or potion to an easily-accessible-key,
386such as '1'. 383such as '1'.
387 384
388 385
396they had will be left behind, but you will get no 393they had will be left behind, but you will get no
397experience for their death. However, it kills them 394experience for their death. However, it kills them
398instantaneously. 395instantaneously.
399 396
400If a name is specified then only pets with that 397If a name is specified then only pets with that
401name will be killed, eg killpets bat will kill bats 398name will be killed, e.g. killpets bat will kill bats
402but not bees. If a number is specified, the pet 399but not bees. If a number is specified, the pet
403corresponding to that number is killed. 400corresponding to that number is killed.
404
405=head2 listen
406
407 listen <listen-level>
408
409Listen sets the level of messages you will hear.
410Priorities are defined as follows:
411
412 0 - Nothing, not even "You punch kobold." or "You say: hi".
413 1 - Only messages that have to do with yourself.
414 2 - Emergency calls from other users
415 10 - General chatter with the 'chat' command.
416 11 - See what players kill what monster with what attack/spell. Very
417 verbose - only for the fanatics.
418
419=head2 logs
420
421TODO
422 401
423=head2 mapinfo 402=head2 mapinfo
424 403
425Shows some information about the map like this: 404Shows some information about the map like this:
426 405
450=item I: B<I>n memory, B<S>wapped out or B<L>oading. 429=item I: B<I>n memory, B<S>wapped out or B<L>oading.
451 430
452The server keeps maps in memory only for a short time (by default about 431The server keeps maps in memory only for a short time (by default about
45340 seconds). After that time, it saves them to disk. As the server loads 43240 seconds). After that time, it saves them to disk. As the server loads
454most maps in the background it is possible that you can see a map that is 433most maps in the background it is possible that you can see a map that is
455currently being loaded, but thats rare, as loading a map is fast. 434currently being loaded, but that's rare, as loading a map is fast.
456 435
457=item Svd: the amount of seconds the map was last saved (++ means >99). 436=item Svd: the amount of seconds the map was last saved (++ means >99).
458 437
459The server by default tries to save each map at least every 20 seconds if 438The server by default tries to save each map at least every 20 seconds if
460it changed, so in case of a disastrous crash (one where the server cannot 439it changed, so in case of a disastrous crash (one where the server cannot
463=item Reset: the minimum number of seconds the map will stay as is (will not reset). 442=item Reset: the minimum number of seconds the map will stay as is (will not reset).
464 443
465Most maps will not reset as long as players are on it, and usually the 444Most maps will not reset as long as players are on it, and usually the
466reset counter only starts going down when all players left the map. Some 445reset counter only starts going down when all players left the map. Some
467maps will never reset in the common sense, these are usually marked with a 446maps will never reset in the common sense, these are usually marked with a
468very high number (sucha s C<1e+99>). 447very high number (such as C<1e+99>).
469 448
470=item Path: the name that uniquely identifies the map, can be used for goto etc. 449=item Path: the name that uniquely identifies the map, can be used for goto etc.
471 450
472=back 451=back
473 452
487 mark sword 466 mark sword
488 467
489B<mark> will look for best match first, and then look for matches based 468B<mark> will look for best match first, and then look for matches based
490on shortened name, object name, archetype name. It prints the match it 469on shortened name, object name, archetype name. It prints the match it
491finds. 470finds.
471
472=head2 me
473
474 me <message>
475
476Sends a message to all players on the server, similar to chat, but instead
477of using C<name chats: message>, the form C<* name message> is used, which
478is useful to describe yourself, such as:
479
480 me feels lonely
481 =>
482 * schmorp feels lonely
483
492 484
493=head2 motd 485=head2 motd
494 486
495Shows the message of the day. It takes no arguments. 487Shows the message of the day. It takes no arguments.
496 488
503message '10 times you kill orc' would be printed out. The default value is 495message '10 times you kill orc' would be printed out. The default value is
5041 - this means that all messages get printed out as they are requested - 4961 - this means that all messages get printed out as they are requested -
505buffering is disabled in this regard. 497buffering is disabled in this regard.
506 498
507output-sync controls how often information is sent to the screen. Each 499output-sync controls how often information is sent to the screen. Each
508buffer has its own time value, and will be flushed independantly. The 500buffer has its own time value, and will be flushed independently. The
509default value is usually less than a second. 501default value is usually less than a second.
510 502
511See also L<output-sync>. 503See also L<output-sync>.
512 504
513=head2 output-rate 505=head2 output-rate
529=head2 output-sync 521=head2 output-sync
530 522
531 output-sync [seconds] 523 output-sync [seconds]
532 524
533output-sync controls how often information is sent to the screen. Each 525output-sync controls how often information is sent to the screen. Each
534buffer has its own time value, and will be flushed independantly. The 526buffer has its own time value, and will be flushed independently. The
535default value is usually less than a second. 527default value is usually less than a second.
536 528
537output-count sets after how many messages of the same type, they are 529output-count sets after how many messages of the same type, they are
538then printed out. If the value was 10, then after killing ten orcs, the 530then printed out. If the value was 10, then after killing ten orcs, the
539message '10 times you kill orc' would be printed out. The default value is 531message '10 times you kill orc' would be printed out. The default value is
568party leave 560party leave
569 takes you out of current party 561 takes you out of current party
570 562
571=head2 peaceful 563=head2 peaceful
572 564
573TODO: rework for cf.schmorp.de, intended future behaviour is to toggle 565TODO: rework for deliantra, intended future behaviour is to toggle
574peaceful mode with regards to npc and monsters only, not with regards to 566peaceful mode with regards to npc and monsters only, not with regards to
575players (which will be controlled by priests). 567players (which will be controlled by priests).
576 568
577The B<peaceful> command will switch you between peaceful and hostile attack 569The B<peaceful> command will switch you between peaceful and hostile attack
578modes. 570modes.
600 592
601=over 4 593=over 4
602 594
603=item B<normal> 595=item B<normal>
604 596
605As you would expect. 597Monsters behave normally, i.e. according to their own character.
606 598
607=item B<sad> (search and destroy) 599=item B<sad> (search and destroy)
608 600
609Pets will roam and seek out things to attack. 601Pets will roam and seek out things to attack.
610 602
618 610
619=back 611=back
620 612
621=head2 pickup 613=head2 pickup
622 614
615 pickup +mode
616 pickup -mode
617 pickup density
618
623B<pickup> changes how you pick up items when you step on them. to pickup 619B<pickup> changes whether you pick up items when you step on them. To
624an item manually, use the ',' key. 620pickup an item manually, use the ',' key.
625 621
626Mode 0: Don't pick up items. 622The B<Pickup> tab in the playerbook is usually a better way to modify your
623autopickup settings than using this command.
627 624
628Mode 1: Pick up one item 625Mode can be one of:
629 626
630Mode 2: Pickup up one item and stop 627 "debug", "inhibit", "stop", "food", "drink", "valuables", "bow",
628 "arrow", "helmet", "shield", "armour", "boots", "gloves", "cloak",
629 "key", "missile", "allweapon", "magical", "potion", "spellbook",
630 "skillscroll", "readables", "magicdevice", "notcursed", "jewels",
631 "flesh"
631 632
632Mode 3: Stop before picking up items 633If a number (C<density>, must be 0..15) is specified, then items of at
633 634least the specified value density are picked up. Value density is given as
634Mode 4: Pick up all items 635gold/weight in kilograms.
635
636Mode 5: Pick up all items and stop
637
638Mode 6: Pick up all magical items
639
640Mode 7: Pick up all coins and gems
641
642Modes above 7: Pickup items with
643a value density greater than the pickup mode.
644
645Value density is value in gold/weight in kilograms.
646 636
647The value in gold is what the item is worth if you sold it in the shop. 637The value in gold is what the item is worth if you sold it in the shop.
648
649Goldcoins have a value density of 66,
650
651Density 10 will pickup silver, gold, rings, wands, books, and scrolls.
652Artifacts are also picked up.
653
654 638
655=head2 prepare 639=head2 prepare
656 640
657The same as cast. Usage: 641The same as cast. Usage:
658 642
697 681
698If either of the names contain spaces, you have to use the C<">-form, 682If either of the names contain spaces, you have to use the C<">-form,
699otherwise you can just write the name as-is. If you omit the old name, the 683otherwise you can just write the name as-is. If you omit the old name, the
700marked item will be used instead. 684marked item will be used instead.
701 685
702If the new name is empty (i.e. C<"">), then the original (unrenamed) name 686If the new name is empty (i.e. C<"">), then the original (before the
703will be restored. 687rename) name will be restored.
704 688
705Note: maximum allowed name length is 127 characters. 689Note: maximum allowed name length is 127 characters.
706 690
707 691
708=head2 resistances 692=head2 resistances
748 732
749=head2 search-items 733=head2 search-items
750 734
751 search-items <word> 735 search-items <word>
752 736
753Automatically picks up all items with <word> in their name. search-items rod 737Automatically picks up all items with <word> in their name. C<search-items
754will pick up all rods and heavy rods. search-items of Fire will pick up all 738rod> will pick up all rods and heavy rods. C<search-items of Fire> will
755bolts, arrows, swords, etc. of Fire. 739pick up all bolts, arrows, swords, etc. of Fire, C<search-items magic+1>
740will pick up all items with magic+1, and so on, and so on.
741
742While this mode is active, you will be slower and the normal autopickup is
743disabled. To disable search mode again, execute C<search-items> without
744any arguments.
756 745
757=head2 seen 746=head2 seen
758 747
759 seen <login> 748 seen <login>
760 749
763 752
764=head2 shout 753=head2 shout
765 754
766 shout <message> 755 shout <message>
767 756
768Sends a message to all players on the server that have 757Sends a message to all players on the server. It is mainly useful for
769L<listen|command/listen> level B<10> or higher. It is mainly useful for
770emergency messages ("I am trapped on xxx, can somebody help me?") and 758emergency messages ("I am trapped on xxx, can somebody help me?") and
771should not be used for general chat. Use L<chat|command/chat> instead. 759should not be used for general chat. Use L<chat|command/chat> instead.
772 760
773=head2 showpets 761=head2 showpets
774 762
801applies to new items you pick up - items that you are already holding will 789applies to new items you pick up - items that you are already holding will
802not be sorted. 790not be sorted.
803 791
804If sort_inventory is not set (default), items will be inserted via type, 792If sort_inventory is not set (default), items will be inserted via type,
805subtype and magic. This, all axes will be grouped together in magic order, 793subtype and magic. This, all axes will be grouped together in magic order,
806all daggers by magic order, etc. Unforunately, for scrolls and rings, new 794all daggers by magic order, etc. Unfortunately, for scrolls and rings, new
807ones just get inserted last. 795ones just get inserted last.
808 796
809If you have a lot of stuff that is not in alphabetical order but you would 797If you have a lot of stuff that is not in alphabetical order but you would
810like it to be, the best method is to drop all of it and then pick it up. 798like it to be, the best method is to drop all of it and then pick it up.
811 799
812=head2 sound 800=head2 sound
813 801
814Toggles between sound enabled and disabled. This has no relevance to the 802Toggles between sound enabled and disabled. This has no relevance to the
815sound settings of the client, it only governs wether the server will send 803sound settings of the client, it only governs whether the server will send
816sound effect command to the client and is enabled if the client supports 804sound effect command to the client and is enabled if the client supports
817sound (i.e. always for cfplus). 805sound (i.e. always for the deliantra client).
818 806
819=head2 sourcecode 807=head2 sourcecode
820 808
821This command displays the means to download the sourcecode (server code, 809This command displays the means to download the source code (server code,
822maps and archetypes) used to implement this version of the game. 810maps and archetypes) used to implement this version of the game.
823 811
824Every player has the right to download and modify the source code of the 812Every player has the right to download and modify the source code of the
825server, as required by both the GNU General Public License and the GNU 813server, as required by both the GNU General Public License and the GNU
826Affero General Public license. 814Affero General Public license.
849Kills yourself. No, really. 837Kills yourself. No, really.
850 838
851This command might not look useful at first, but sometimes you can get 839This command might not look useful at first, but sometimes you can get
852yourself into a corner you can't escape anymore, either due to a map 840yourself into a corner you can't escape anymore, either due to a map
853bug or your own stupidity. Killing oneself can be difficult and time 841bug or your own stupidity. Killing oneself can be difficult and time
854consuming, thats why this command is provided. It is fast, painless, 842consuming, that's why this command is provided. It is fast, painless,
855effective, humane. 843effective, humane.
856 844
857=head2 take 845=head2 take
858 846
859The take commands take object(s) on the space the player is standing on, 847The take commands take object(s) on the space the player is standing on,
887 875
888=head2 time 876=head2 time
889 877
890Shows the Deliantra in-game time, not the server time. It looks like this: 878Shows the Deliantra in-game time, not the server time. It looks like this:
891 879
892 It is 52 minutes past 8 o'clock am, on the Day of the Bull 880 It is 52 minutes past 8 o'clock am, on the Day of the Bull,
893 The 2nd Day of the Month of the Frost Giant, Year 63 881 the 2nd Day of the Month of the Frost Giant, Year 63.
894 Time of Year: The Season of New Year 882 Time of Year: The Season of New Year.
895 883
896It is partially just for fun but it affects the darkness outside and the 884An hour of game time passes in 3 minutes of real time. The time and
897weather if weather is enabled in the server. 885calendar uses 60 minutes per hour, 28 hours per day, seven days per week,
886five weeks per month, and 17 months per year. The year is additionally
887split into four seasons of 4 months each, except the season of the
888Blizzard, which is 5 months long.
889
890The number "zero" is unknown, which is why the minutes go from 1 to 60.
891
892Seasons and the time of the day affect the overall outdoor daylight.
898 893
899=head2 title 894=head2 title
895
896 title <new title>
897 title clear # Sets your title back to your race.
900 898
901Players can change their title. For example you called yourself Gandalf and 899Players can change their title. For example you called yourself Gandalf and
902your race is elf, you can use the title command to change your name from 900your race is elf, you can use the title command to change your name from
903"Gandalf the elf" to "Gandalf the white". Usage: 901"Gandalf the elf" to "Gandalf the white" by using C<title the white>.
904
905 title <new title>
906 title clear # Sets your title back to your race.
907 902
908Dragons cannot set their title because it changes during the game. 903Dragons cannot set their title because it changes during the game.
909 904
910=head2 unignore 905=head2 unignore
911 906
929 924
930The B<usekeys> option determines the behaviour of using keys. 925The B<usekeys> option determines the behaviour of using keys.
931 926
932Values are: 927Values are:
933 928
929=over 4
930
934inventory: Only keys in the top level inventory are used (default) 931=item B<inventory>: Only keys in the top level inventory are used (default)
935 932
936keyrings: Only keys in active keyrings are used. 933=item B<keyrings>: Only keys in active key rings are used.
937 934
938containers: Only keys in active containers are used. 935=item B<containers>: Only keys in active containers are used.
939 936
937=back
938
940Note that keyrings are just a specialized container, so the containers 939Note that key rings are just a specialized container, so the containers
941will also find keys in keyrings. 940will also find keys in key rings.
942 941
943Only active containers are used - keys will not jump out of closed 942Only active containers are used - keys will not jump out of closed
944containers, but hints will be given if you have keys in such containers. 943containers, but hints will be given if you have keys in such containers.
945 944
946=head2 version 945=head2 version
979 978
980 979
981=head1 Authors 980=head1 Authors
982 981
983Parts of this document were originally taken from the crossfire server 982Parts of this document were originally taken from the crossfire server
984help files with unknwon authors. 983help files with unknown authors.
985 984
986Adapted for use by I<deliantra>, enhanced and corrected by Pippijn van 985Adapted for use by I<deliantra>, enhanced and corrected by Pippijn van
987Steenhoven and Marc A. Lehmann. 986Steenhoven and Marc A. Lehmann.
988 987

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines