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.16 by root, Fri Aug 29 02:02:52 2008 UTC vs.
Revision 1.28 by root, Mon Jun 21 22:52:51 2010 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=encoding utf-8
10
9=head1 Deliantra Command ListingX<command> 11=head1 Deliantra Command ListingX<command>
10 12
11=head2 accept-invitation 13=head2 accept-invitation
12 14
13Accepts an invitation previously issued by another player using the invite 15Accepts an invitation previously issued by another player using the invite
34 36
35These two options disable the toggling feature. 37These two options disable the toggling feature.
36 38
37=head2 X<applymode>applymode (nochoice|never|always) 39=head2 X<applymode>applymode (nochoice|never|always)
38 40
39Applymode controls what happens when you are equipping something that would 41the C<applymode> controls what happens when you are equipping something that would
40require something else to be unequipped. 42require something else to be unequipped.
41 43
42The options are: 44The options are:
43 45
44=over 4 46=over 4
77 79
78See L<apply|command/apply>. 80See L<apply|command/apply>.
79 81
80=head2 body 82=head2 body
81 83
82Shows how much you are wielding on certain bodyparts. For example as 84Shows how much (and what) you are wielding on certain body parts.
85
83fireborn, you have 4 fingers to put rings on. If you have 3 rings on it will 86For 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. 873 rings on it will say: "on your finger 3 1", meaning you have 3 fingers
88full and one free.
89
90Both items as well as skills and other more esoteric objects can use those
91body parts.
85 92
86=head2 X<bowmode>bowmode (normal|threewide|spreadshot|bestarrow|.*) 93=head2 X<bowmode>bowmode (normal|threewide|spreadshot|bestarrow|.*)
87 94
88Bowmode controls how you will fire arrows and bolts. 95The C<bowmode> controls how you will fire arrows and bolts.
89 96
90The options are: 97The options are:
91 98
92=over 4 99=over 4
93 100
118 125
119When you enter the B<brace> command to brace your character, your 126When you enter the B<brace> command to brace your character, your
120character will no longer move. It can still attack adjoining 127character will no longer move. It can still attack adjoining
121spaces. Bracing can be useful to hold a location. 128spaces. Bracing can be useful to hold a location.
122 129
123When you are braced, you lose your dex bonus and incur a 2 point 130When 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 131ac 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 132fact come out ahead. You also only get 20% of the normal experience
126for killing creatures, and incure a 4 point wc (to hit) penalty. 133for killing creatures, and incur a 4 point WC (to hit) penalty.
127 134
128=head2 chat 135=head2 chat
129 136
130 chat <message> 137 chat <message>
131 138
132Sends a message to all players on the server. This is the normal way to 139Sends a message to all players on the server. This is the normal way to
133chat with others. 140chat with others.
134 141
135=head2 cast 142=head2 cast
136 143
137You use the cast command to set your range-weapon to the spell you 144You use the cast command to set your range-action-slot to the spell you
138want. Example: 145want. Example:
139 146
140 cast burning hands 147 cast burning hands
141 148
142sets your I<range> weapon to B<spell: burning hands>. 149sets your I<range> slot to B<spell: burning hands>.
143 150
144If you don't know the spell, shows which spells you do know. 151If you don't know the spell, shows which spells you do know.
145 152
146It is helpful to bind string like B<cast burning hands> to keys. 153It is helpful to bind string like B<cast burning hands> to keys.
147 154
148See B<range> for more information on range weapons. 155See C<help range> for more information on range weapons.
149 156
150=head2 X<drop>drop (all|unpaid|cursed|unlocked|.*) 157=head2 X<drop>drop (all|unpaid|cursed|unlocked|.*)
151 158
152 drop [number] name 159 drop [number] name
153 160
157 164
158There are a few special name values: 165There are a few special name values:
159 166
160=over 4 167=over 4
161 168
162=item B<all> 169=item B<all>: matches any item.
163 170
164matches any item. 171=item B<unpaid>: matches unpaid items.
165 172
166=item B<unpaid> 173=item B<cursed>: drops items known to be cursed or damned.
167 174
168matches unpaid items 175=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 176
178=back 177=back
179 178
180B<number> is optional. This acts as the number of the object to drop. The 179B<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 180objects 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 301Do not show the hints themselves, but notify you when a hint would have
303been available. 302been available.
304 303
305=item hide 304=item hide
306 305
307Hide all hints: You will not be able to tell wether there is a hint 306Hide all hints: You will not be able to tell whether there is a hint
308available or not. 307available or not.
309 308
310=back 309=back
311 310
312=head2 hiscore 311=head2 hiscore
320Lists all players that you currently ignore. 319Lists all players that you currently ignore.
321 320
322 ignore <player> <tell|shout|all> [timeout] 321 ignore <player> <tell|shout|all> [timeout]
323 322
324This command ignores the specified messages (B<tell> ignores tells, 323This command ignores the specified messages (B<tell> ignores tells,
325B<shout> ignores chat and shout and all ignores everything from the given 324B<shout> ignores chat and shout and B<all> ignores everything from the given
326user). 325user).
327 326
328The optional timeout (specified in hours) specifies then the ignore entry 327The optional timeout (specified in hours) specifies when the ignore entry
329expires. The default is 24 (one day). The reason why all ignores expire 328expires. 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 329expire after a day by default is that most troublemakers stop soon after
331being ignored. 330they are being ignored.
332 331
333To revoke an ignore, use the B<unignore> command. 332To revoke an ignore, use the B<unignore> command.
334 333
335=head2 inventory 334=head2 inventory
336 335
338status. Example: 337status. Example:
339 338
340 inventory 339 inventory
341 340
342 Inventory: 341 Inventory:
343 - arrow 0.1 342 - arrow 0.1
344 - Knife * 2 343 - Knife * 2
345 - long sword (wielded) 15 344 - long sword (wielded) 15
346 345
347This shows that you have one arrow which weighs 0.1kg and one Knife which you 346This 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 347protected from dropping by locking it as well as a long sword which you are
349currently using to attack. 348currently using to attack.
350 349
386 invoke magic rune of large fireball 385 invoke magic rune of large fireball
387 invoke reincarnation of Iamdead 386 invoke reincarnation of Iamdead
388 invoke create food of waybread 387 invoke create food of waybread
389 388
390It is very helpful to bind healing spells to keys, for example go to your 389It 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 390I<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 391spell 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, 392recommended to bind a healing spell or potion to an easily-accessible-key,
394such as '1'. 393such as '1'.
395 394
396 395
404they had will be left behind, but you will get no 403they had will be left behind, but you will get no
405experience for their death. However, it kills them 404experience for their death. However, it kills them
406instantaneously. 405instantaneously.
407 406
408If a name is specified then only pets with that 407If a name is specified then only pets with that
409name will be killed, eg killpets bat will kill bats 408name will be killed, e.g. killpets bat will kill bats
410but not bees. If a number is specified, the pet 409but not bees. If a number is specified, the pet
411corresponding to that number is killed. 410corresponding to that number is killed.
411
412=head2 lock
413
414 lock [object]
415
416The lock command is a quick and convenient way to
417lock items in your inventory.
418
419If a object name is specified then only the
420objects that match that name are locked.
421e.g. lock materials will lock any materials
422in your inventory and not touch anything else.
423
424lock by itself will lock everything in your
425inventory.
412 426
413=head2 mapinfo 427=head2 mapinfo
414 428
415Shows some information about the map like this: 429Shows some information about the map like this:
416 430
440=item I: B<I>n memory, B<S>wapped out or B<L>oading. 454=item I: B<I>n memory, B<S>wapped out or B<L>oading.
441 455
442The server keeps maps in memory only for a short time (by default about 456The server keeps maps in memory only for a short time (by default about
44340 seconds). After that time, it saves them to disk. As the server loads 45740 seconds). After that time, it saves them to disk. As the server loads
444most maps in the background it is possible that you can see a map that is 458most maps in the background it is possible that you can see a map that is
445currently being loaded, but thats rare, as loading a map is fast. 459currently being loaded, but that's rare, as loading a map is fast.
446 460
447=item Svd: the amount of seconds the map was last saved (++ means >99). 461=item Svd: the amount of seconds since the map was last saved (++ means >99).
448 462
449The server by default tries to save each map at least every 20 seconds if 463The server by default tries to save each map at least every 20 seconds if
450it changed, so in case of a disastrous crash (one where the server cannot 464it changed, so in case of a disastrous crash (one where the server cannot
451emergency save), at most 20 seconds of gameplay are lost. 465emergency save), at most 20 seconds of gameplay are lost.
452 466
453=item Reset: the minimum number of seconds the map will stay as is (will not reset). 467=item Reset: the minimum number of seconds the map will stay as is (will not reset).
454 468
455Most maps will not reset as long as players are on it, and usually the 469Most maps will not reset as long as players are on it, and usually the
456reset counter only starts going down when all players left the map. Some 470reset counter only starts going down when all players left the map. Some
457maps will never reset in the common sense, these are usually marked with a 471maps will never reset in the common sense, these are usually marked with a
458very high number (sucha s C<1e+99>). 472very high number (such as C<1e+99>).
459 473
460=item Path: the name that uniquely identifies the map, can be used for goto etc. 474=item Path: the name that uniquely identifies the map, can be used for goto etc.
461 475
462=back 476=back
463 477
477 mark sword 491 mark sword
478 492
479B<mark> will look for best match first, and then look for matches based 493B<mark> will look for best match first, and then look for matches based
480on shortened name, object name, archetype name. It prints the match it 494on shortened name, object name, archetype name. It prints the match it
481finds. 495finds.
496
497=head2 me
498
499 me <message>
500
501Sends a message to all players on the server, similar to chat, but instead
502of using C<name chats: message>, the form C<* name message> is used, which
503is useful to describe yourself, such as:
504
505 me feels lonely
506 =>
507 * schmorp feels lonely
508
482 509
483=head2 motd 510=head2 motd
484 511
485Shows the message of the day. It takes no arguments. 512Shows the message of the day. It takes no arguments.
486 513
493message '10 times you kill orc' would be printed out. The default value is 520message '10 times you kill orc' would be printed out. The default value is
4941 - this means that all messages get printed out as they are requested - 5211 - this means that all messages get printed out as they are requested -
495buffering is disabled in this regard. 522buffering is disabled in this regard.
496 523
497output-sync controls how often information is sent to the screen. Each 524output-sync controls how often information is sent to the screen. Each
498buffer has its own time value, and will be flushed independantly. The 525buffer has its own time value, and will be flushed independently. The
499default value is usually less than a second. 526default value is usually less than a second.
500 527
501See also L<output-sync>. 528See also L<output-sync>.
502 529
503=head2 output-rate 530=head2 output-rate
519=head2 output-sync 546=head2 output-sync
520 547
521 output-sync [seconds] 548 output-sync [seconds]
522 549
523output-sync controls how often information is sent to the screen. Each 550output-sync controls how often information is sent to the screen. Each
524buffer has its own time value, and will be flushed independantly. The 551buffer has its own time value, and will be flushed independently. The
525default value is usually less than a second. 552default value is usually less than a second.
526 553
527output-count sets after how many messages of the same type, they are 554output-count sets after how many messages of the same type, they are
528then printed out. If the value was 10, then after killing ten orcs, the 555then printed out. If the value was 10, then after killing ten orcs, the
529message '10 times you kill orc' would be printed out. The default value is 556message '10 times you kill orc' would be printed out. The default value is
590 617
591=over 4 618=over 4
592 619
593=item B<normal> 620=item B<normal>
594 621
595As you would expect. 622Monsters behave normally, i.e. according to their own character.
596 623
597=item B<sad> (search and destroy) 624=item B<sad> (search and destroy)
598 625
599Pets will roam and seek out things to attack. 626Pets will roam and seek out things to attack.
600 627
608 635
609=back 636=back
610 637
611=head2 pickup 638=head2 pickup
612 639
640 pickup +mode
641 pickup -mode
642 pickup density
643
613B<pickup> changes how you pick up items when you step on them. to pickup 644B<pickup> changes whether you pick up items when you step on them. To
614an item manually, use the ',' key. 645pickup an item manually, use the ',' key.
615 646
616Mode 0: Don't pick up items. 647The B<Pickup> tab in the playerbook is usually a better way to modify your
648autopickup settings than using this command.
617 649
618Mode 1: Pick up one item 650Mode can be one of:
619 651
620Mode 2: Pickup up one item and stop 652 "debug", "inhibit", "stop", "food", "drink", "valuables", "bow",
653 "arrow", "helmet", "shield", "armour", "boots", "gloves", "cloak",
654 "key", "missile", "allweapon", "magical", "potion", "spellbook",
655 "skillscroll", "readables", "magicdevice", "notcursed", "jewels",
656 "flesh"
621 657
622Mode 3: Stop before picking up items 658If a number (C<density>, must be 0..15) is specified, then items of at
623 659least the specified value density are picked up. Value density is given as
624Mode 4: Pick up all items 660gold/weight in kilograms.
625
626Mode 5: Pick up all items and stop
627
628Mode 6: Pick up all magical items
629
630Mode 7: Pick up all coins and gems
631
632Modes above 7: Pickup items with
633a value density greater than the pickup mode.
634
635Value density is value in gold/weight in kilograms.
636 661
637The value in gold is what the item is worth if you sold it in the shop. 662The value in gold is what the item is worth if you sold it in the shop.
638
639Goldcoins have a value density of 66,
640
641Density 10 will pickup silver, gold, rings, wands, books, and scrolls.
642Artifacts are also picked up.
643
644 663
645=head2 prepare 664=head2 prepare
646 665
647The same as cast. Usage: 666The same as cast. Usage:
648 667
687 706
688If either of the names contain spaces, you have to use the C<">-form, 707If 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 708otherwise you can just write the name as-is. If you omit the old name, the
690marked item will be used instead. 709marked item will be used instead.
691 710
692If the new name is empty (i.e. C<"">), then the original (unrenamed) name 711If the new name is empty (i.e. C<"">), then the original (before the
693will be restored. 712rename) name will be restored.
694 713
695Note: maximum allowed name length is 127 characters. 714Note: maximum allowed name length is 127 characters.
696 715
697 716
698=head2 resistances 717=head2 resistances
738 757
739=head2 search-items 758=head2 search-items
740 759
741 search-items <word> 760 search-items <word>
742 761
743Automatically picks up all items with <word> in their name. search-items rod 762Automatically picks up all items with <word> in their name. C<search-items
744will pick up all rods and heavy rods. search-items of Fire will pick up all 763rod> will pick up all rods and heavy rods. C<search-items of Fire> will
745bolts, arrows, swords, etc. of Fire. 764pick up all bolts, arrows, swords, etc. of Fire, C<search-items magic+1>
765will pick up all items with magic+1, and so on, and so on.
766
767While this mode is active, you will be slower and the normal autopickup is
768disabled. To disable search mode again, execute C<search-items> without
769any arguments.
746 770
747=head2 seen 771=head2 seen
748 772
749 seen <login> 773 seen <login>
750 774
790applies to new items you pick up - items that you are already holding will 814applies to new items you pick up - items that you are already holding will
791not be sorted. 815not be sorted.
792 816
793If sort_inventory is not set (default), items will be inserted via type, 817If sort_inventory is not set (default), items will be inserted via type,
794subtype and magic. This, all axes will be grouped together in magic order, 818subtype and magic. This, all axes will be grouped together in magic order,
795all daggers by magic order, etc. Unforunately, for scrolls and rings, new 819all daggers by magic order, etc. Unfortunately, for scrolls and rings, new
796ones just get inserted last. 820ones just get inserted last.
797 821
798If you have a lot of stuff that is not in alphabetical order but you would 822If you have a lot of stuff that is not in alphabetical order but you would
799like it to be, the best method is to drop all of it and then pick it up. 823like it to be, the best method is to drop all of it and then pick it up.
800 824
801=head2 sound 825=head2 sound
802 826
803Toggles between sound enabled and disabled. This has no relevance to the 827Toggles between sound enabled and disabled. This has no relevance to the
804sound settings of the client, it only governs wether the server will send 828sound settings of the client, it only governs whether the server will send
805sound effect command to the client and is enabled if the client supports 829sound effect command to the client and is enabled if the client supports
806sound (i.e. always for cfplus). 830sound (i.e. always for the deliantra client).
807 831
808=head2 sourcecode 832=head2 sourcecode
809 833
810This command displays the means to download the sourcecode (server code, 834This command displays the means to download the source code (server code,
811maps and archetypes) used to implement this version of the game. 835maps and archetypes) used to implement this version of the game.
812 836
813Every player has the right to download and modify the source code of the 837Every player has the right to download and modify the source code of the
814server, as required by both the GNU General Public License and the GNU 838server, as required by both the GNU General Public License and the GNU
815Affero General Public license. 839Affero General Public license.
838Kills yourself. No, really. 862Kills yourself. No, really.
839 863
840This command might not look useful at first, but sometimes you can get 864This command might not look useful at first, but sometimes you can get
841yourself into a corner you can't escape anymore, either due to a map 865yourself into a corner you can't escape anymore, either due to a map
842bug or your own stupidity. Killing oneself can be difficult and time 866bug or your own stupidity. Killing oneself can be difficult and time
843consuming, thats why this command is provided. It is fast, painless, 867consuming, that's why this command is provided. It is fast, painless,
844effective, humane. 868effective, humane.
845 869
846=head2 take 870=head2 take
847 871
848The take commands take object(s) on the space the player is standing on, 872The take commands take object(s) on the space the player is standing on,
876 900
877=head2 time 901=head2 time
878 902
879Shows the Deliantra in-game time, not the server time. It looks like this: 903Shows the Deliantra in-game time, not the server time. It looks like this:
880 904
881 It is 52 minutes past 8 o'clock am, on the Day of the Bull 905 It is 52 minutes past 8 o'clock am, on the Day of the Bull,
882 The 2nd Day of the Month of the Frost Giant, Year 63 906 the 2nd Day of the Month of the Frost Giant, Year 63.
883 Time of Year: The Season of New Year 907 Time of Year: The Season of New Year.
884 908
885It is partially just for fun but it affects the darkness outside and the 909An hour of game time passes in 3 minutes of real time. The time and
886weather if weather is enabled in the server. 910calendar uses 60 minutes per hour, 28 hours per day, seven days per week,
911five weeks per month, and 17 months per year. The year is additionally
912split into four seasons of 4 months each, except the season of the
913Blizzard, which is 5 months long.
914
915The number "zero" is unknown, which is why the minutes go from 1 to 60.
916
917Seasons and the time of the day affect the overall outdoor daylight.
887 918
888=head2 title 919=head2 title
920
921 title <new title>
922 title clear # Sets your title back to your race.
889 923
890Players can change their title. For example you called yourself Gandalf and 924Players can change their title. For example you called yourself Gandalf and
891your race is elf, you can use the title command to change your name from 925your race is elf, you can use the title command to change your name from
892"Gandalf the elf" to "Gandalf the white". Usage: 926"Gandalf the elf" to "Gandalf the white" by using C<title the white>.
893
894 title <new title>
895 title clear # Sets your title back to your race.
896 927
897Dragons cannot set their title because it changes during the game. 928Dragons cannot set their title because it changes during the game.
898 929
899=head2 unignore 930=head2 unignore
900 931
901 unignore <login> 932 unignore <login>
902 933
903Cancels all ignores set for the specified login. See B<ignore>. 934Cancels all ignores set for the specified login. See B<ignore>.
935
936=head2 unlock
937
938 unlock [object]
939
940The unlock command is a quick and convenient way
941to unlock items in your inventory.
942
943If a object name is specified then only the
944objects that match that name are unlocked.
945
946e.g. unlock materials will unlock any materials
947in your inventory and not touch anything else.
948
949unlock by itself will unlock everything in your
950inventory.
904 951
905=head2 uptime 952=head2 uptime
906 953
907Tells you something about the time the server was started and how long ago 954Tells you something about the time the server was started and how long ago
908that was. 955that was.
918 965
919The B<usekeys> option determines the behaviour of using keys. 966The B<usekeys> option determines the behaviour of using keys.
920 967
921Values are: 968Values are:
922 969
970=over 4
971
923inventory: Only keys in the top level inventory are used (default) 972=item B<inventory>: Only keys in the top level inventory are used (default)
924 973
925keyrings: Only keys in active keyrings are used. 974=item B<keyrings>: Only keys in active key rings are used.
926 975
927containers: Only keys in active containers are used. 976=item B<containers>: Only keys in active containers are used.
928 977
978=back
979
929Note that keyrings are just a specialized container, so the containers 980Note that key rings are just a specialized container, so the containers
930will also find keys in keyrings. 981will also find keys in key rings.
931 982
932Only active containers are used - keys will not jump out of closed 983Only active containers are used - keys will not jump out of closed
933containers, but hints will be given if you have keys in such containers. 984containers, but hints will be given if you have keys in such containers.
934 985
935=head2 version 986=head2 version

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines