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.23 by root, Mon Jul 30 02:16:16 2007 UTC vs.
Revision 1.33 by pippijn, Tue Dec 23 18:52:54 2008 UTC

1=head1 Crossfire TRT Command ListingX<command> 1=head1 Deliantra Command ListingX<command>
2 2
3=head2 accept-invitation 3=head2 accept-invitation
4 4
5Accepts an invitation previously issued by another player using the invite 5Accepts an invitation previously issued by another player using the invite
6command. This will transfer you to the location you were invited to. 6command. This will transfer you to the location you were invited to.
26 26
27These two options disable the toggling feature. 27These two options disable the toggling feature.
28 28
29=head2 X<applymode>applymode (nochoice|never|always) 29=head2 X<applymode>applymode (nochoice|never|always)
30 30
31Applymode controls what happens when you are equipping something that would 31the C<applymode> controls what happens when you are equipping something that would
32require something else to be unequipped. 32require something else to be unequipped.
33 33
34The options are: 34The options are:
35 35
36=over 4 36=over 4
69 69
70See L<apply|command/apply>. 70See L<apply|command/apply>.
71 71
72=head2 body 72=head2 body
73 73
74Shows how much you are wielding on certain bodyparts. For example as 74Shows how much you are wielding on certain body parts. For example as
75fireborn, you have 4 fingers to put rings on. If you have 3 rings on it will 75fireborn, you have 4 fingers to put rings on. If you have 3 rings on it will
76say: "on your finger 3 1", meaning you have 3 fingers full and one free. 76say: "on your finger 3 1", meaning you have 3 fingers full and one free.
77 77
78=head2 X<bowmode>bowmode (normal|threewide|spreadshot|bestarrow|.*) 78=head2 X<bowmode>bowmode (normal|threewide|spreadshot|bestarrow|.*)
79 79
80Bowmode controls how you will fire arrows and bolts. 80The C<bowmode> controls how you will fire arrows and bolts.
81 81
82The options are: 82The options are:
83 83
84=over 4 84=over 4
85 85
110 110
111When you enter the B<brace> command to brace your character, your 111When you enter the B<brace> command to brace your character, your
112character will no longer move. It can still attack adjoining 112character will no longer move. It can still attack adjoining
113spaces. Bracing can be useful to hold a location. 113spaces. Bracing can be useful to hold a location.
114 114
115When you are braced, you lose your dex bonus and incur a 2 point 115When you are braced, you lose your Dex bonus and incur a 2 point
116ac penalty beyond that (if you have a negative dex bonus, you may in 116ac penalty beyond that (if you have a negative Dex bonus, you may in
117fact come out ahead. You also only get 20% of the normal experience 117fact come out ahead. You also only get 20% of the normal experience
118for killing creatures, and incure a 4 point wc (to hit) penalty. 118for killing creatures, and incur a 4 point WC (to hit) penalty.
119 119
120=head2 chat 120=head2 chat
121 121
122 chat <message> 122 chat <message>
123 123
124Sends a message to all players on the server that have 124Sends a message to all players on the server. This is the normal way to
125L<listen|command/listen> level B<10> or higher. 125chat with others.
126 126
127=head2 cast 127=head2 cast
128 128
129You use the cast command to set your range-weapon to the spell you 129You use the cast command to set your range-action-slot to the spell you
130want. Example: 130want. Example:
131 131
132 cast burning hands 132 cast burning hands
133 133
134sets your I<range> weapon to B<spell: burning hands>. 134sets your I<range> slot to B<spell: burning hands>.
135 135
136If you don't know the spell, shows which spells you do know. 136If you don't know the spell, shows which spells you do know.
137 137
138It is helpful to bind string like B<cast burning hands> to keys. 138It is helpful to bind string like B<cast burning hands> to keys.
139 139
140See B<range> for more information on range weapons. 140See C<help range> for more information on range weapons.
141 141
142=head2 X<drop>drop (all|unpaid|cursed|unlocked|.*) 142=head2 X<drop>drop (all|unpaid|cursed|unlocked|.*)
143 143
144 drop [number] name 144 drop [number] name
145 145
149 149
150There are a few special name values: 150There are a few special name values:
151 151
152=over 4 152=over 4
153 153
154=item B<all> 154=item B<all>: matches any item.
155 155
156matches any item. 156=item B<unpaid>: matches unpaid items.
157 157
158=item B<unpaid> 158=item B<cursed>: drops items known to be cursed or damned.
159 159
160matches unpaid items 160=item B<unlocked>: drops items not locked in your inventory.
161
162=item B<cursed>
163
164drops items known to be cursed or damned.
165
166=item B<unlocked>
167
168drops items not locked in your inventory
169 161
170=back 162=back
171 163
172B<number> is optional. This acts as the number of the object to drop. The 164B<number> is optional. This acts as the number of the object to drop. The
173objects number must be at least the number for it to be dropped. For 165objects number must be at least the number for it to be dropped. For
294Do not show the hints themselves, but notify you when a hint would have 286Do not show the hints themselves, but notify you when a hint would have
295been available. 287been available.
296 288
297=item hide 289=item hide
298 290
299Hide all hints: You will not be able to tell wether there is a hint 291Hide all hints: You will not be able to tell whether there is a hint
300available or not. 292available or not.
301 293
302=back 294=back
303 295
304=head2 hiscore 296=head2 hiscore
312Lists all players that you currently ignore. 304Lists all players that you currently ignore.
313 305
314 ignore <player> <tell|shout|all> [timeout] 306 ignore <player> <tell|shout|all> [timeout]
315 307
316This command ignores the specified messages (B<tell> ignores tells, 308This command ignores the specified messages (B<tell> ignores tells,
317B<shout> ignores chat and shout and all ignores everything from the given 309B<shout> ignores chat and shout and B<all> ignores everything from the given
318user). 310user).
319 311
320The optional timeout (specified in hours) specifies then the ignore entry 312The optional timeout (specified in hours) specifies when the ignore entry
321expires. The default is 24 (one day). The reason why all ignores expire 313expires. The default is 24 (one day). The reason why all ignore entries
322after a day by default is that most troublemakers stop soon after they are 314expire after a day by default is that most troublemakers stop soon after
323being ignored. 315they are being ignored.
324 316
325To revoke an ignore, use the B<unignore> command. 317To revoke an ignore, use the B<unignore> command.
326 318
327=head2 inventory 319=head2 inventory
328 320
330status. Example: 322status. Example:
331 323
332 inventory 324 inventory
333 325
334 Inventory: 326 Inventory:
335 - arrow 0.1 327 - arrow 0.1
336 - Knife * 2 328 - Knife * 2
337 - long sword (wielded) 15 329 - long sword (wielded) 15
338 330
339This shows that you have one arrow which weighs 0.1kg and one Knife which you 331This shows that you have one arrow which weighs 0.1kg and one Knife which you
340protected from dropping by locking it as well as a long sword which you are 332protected from dropping by locking it as well as a long sword which you are
341currently using to attack. 333currently using to attack.
342 334
378 invoke magic rune of large fireball 370 invoke magic rune of large fireball
379 invoke reincarnation of Iamdead 371 invoke reincarnation of Iamdead
380 invoke create food of waybread 372 invoke create food of waybread
381 373
382It is very helpful to bind healing spells to keys, for example go to your 374It is very helpful to bind healing spells to keys, for example go to your
383I<playerbook>, tab I<spells>, the press the right mosue button on the 375I<playerbook>, tab I<spells>, the press the right mouse button on the
384spell I<medium healing> and choose C<bind invoke ... to a key>. It is 376spell I<medium healing> and choose C<bind invoke ... to a key>. It is
385recommended to bind a healing spell or potion to an easily-accessible-key, 377recommended to bind a healing spell or potion to an easily-accessible-key,
386such as '1'. 378such as '1'.
387 379
388 380
396they had will be left behind, but you will get no 388they had will be left behind, but you will get no
397experience for their death. However, it kills them 389experience for their death. However, it kills them
398instantaneously. 390instantaneously.
399 391
400If a name is specified then only pets with that 392If a name is specified then only pets with that
401name will be killed, eg killpets bat will kill bats 393name will be killed, e.g. killpets bat will kill bats
402but not bees. If a number is specified, the pet 394but not bees. If a number is specified, the pet
403corresponding to that number is killed. 395corresponding 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 396
423=head2 mapinfo 397=head2 mapinfo
424 398
425Shows some information about the map like this: 399Shows some information about the map like this:
426 400
436The rest is information the mapper may or may not provide. Often, this is 410The rest is information the mapper may or may not provide. Often, this is
437the mapper's name, email and map creation date as this example shows. 411the mapper's name, email and map creation date as this example shows.
438 412
439=head2 maps 413=head2 maps
440 414
441[crossfire+]
442
443 maps <mapname> 415 maps <mapname>
444 416
445Shows a list of maps matching the regex <mapname> that are currently being 417Shows a list of maps matching the regex <mapname> that are currently being
446known to the server. The different fields are Pl, I, Svd, Reset and Path: 418known to the server. The different fields are Pl, I, Svd, Reset and Path:
447 419
452=item I: B<I>n memory, B<S>wapped out or B<L>oading. 424=item I: B<I>n memory, B<S>wapped out or B<L>oading.
453 425
454The server keeps maps in memory only for a short time (by default about 426The server keeps maps in memory only for a short time (by default about
45540 seconds). After that time, it saves them to disk. As the server loads 42740 seconds). After that time, it saves them to disk. As the server loads
456most maps in the background it is possible that you can see a map that is 428most maps in the background it is possible that you can see a map that is
457currently being loaded, but thats rare, as loading a map is fast. 429currently being loaded, but that's rare, as loading a map is fast.
458 430
459=item Svd: the amount of seconds the map was last saved (++ means >99). 431=item Svd: the amount of seconds the map was last saved (++ means >99).
460 432
461The server by default tries to save each map at least every 20 seconds if 433The server by default tries to save each map at least every 20 seconds if
462it changed, so in case of a disastrous crash (one where the server cannot 434it changed, so in case of a disastrous crash (one where the server cannot
465=item Reset: the minimum number of seconds the map will stay as is (will not reset). 437=item Reset: the minimum number of seconds the map will stay as is (will not reset).
466 438
467Most maps will not reset as long as players are on it, and usually the 439Most maps will not reset as long as players are on it, and usually the
468reset counter only starts going down when all players left the map. Some 440reset counter only starts going down when all players left the map. Some
469maps will never reset in the common sense, these are usually marked with a 441maps will never reset in the common sense, these are usually marked with a
470very high number (sucha s C<1e+99>). 442very high number (such as C<1e+99>).
471 443
472=item Path: the name that uniquely identifies the map, can be used for goto etc. 444=item Path: the name that uniquely identifies the map, can be used for goto etc.
473 445
474=back 446=back
475 447
505message '10 times you kill orc' would be printed out. The default value is 477message '10 times you kill orc' would be printed out. The default value is
5061 - this means that all messages get printed out as they are requested - 4781 - this means that all messages get printed out as they are requested -
507buffering is disabled in this regard. 479buffering is disabled in this regard.
508 480
509output-sync controls how often information is sent to the screen. Each 481output-sync controls how often information is sent to the screen. Each
510buffer has its own time value, and will be flushed independantly. The 482buffer has its own time value, and will be flushed independently. The
511default value is usually less than a second. 483default value is usually less than a second.
512 484
513See also L<output-sync>. 485See also L<output-sync>.
514 486
515=head2 output-rate 487=head2 output-rate
531=head2 output-sync 503=head2 output-sync
532 504
533 output-sync [seconds] 505 output-sync [seconds]
534 506
535output-sync controls how often information is sent to the screen. Each 507output-sync controls how often information is sent to the screen. Each
536buffer has its own time value, and will be flushed independantly. The 508buffer has its own time value, and will be flushed independently. The
537default value is usually less than a second. 509default value is usually less than a second.
538 510
539output-count sets after how many messages of the same type, they are 511output-count sets after how many messages of the same type, they are
540then printed out. If the value was 10, then after killing ten orcs, the 512then printed out. If the value was 10, then after killing ten orcs, the
541message '10 times you kill orc' would be printed out. The default value is 513message '10 times you kill orc' would be printed out. The default value is
570party leave 542party leave
571 takes you out of current party 543 takes you out of current party
572 544
573=head2 peaceful 545=head2 peaceful
574 546
575TODO: rework for cf.schmorp.de, intended future behaviour is to toggle 547TODO: rework for deliantra, intended future behaviour is to toggle
576peaceful mode with regards to npc and monsters only, not with regards to 548peaceful mode with regards to npc and monsters only, not with regards to
577players (which will be controlled by priests). 549players (which will be controlled by priests).
578 550
579The B<peaceful> command will switch you between peaceful and hostile attack 551The B<peaceful> command will switch you between peaceful and hostile attack
580modes. 552modes.
699 671
700If either of the names contain spaces, you have to use the C<">-form, 672If either of the names contain spaces, you have to use the C<">-form,
701otherwise you can just write the name as-is. If you omit the old name, the 673otherwise you can just write the name as-is. If you omit the old name, the
702marked item will be used instead. 674marked item will be used instead.
703 675
704If the new name is empty (i.e. C<"">), then the original (unrenamed) name 676If the new name is empty (i.e. C<"">), then the original (before the
705will be restored. 677rename) name will be restored.
706 678
707Note: maximum allowed name length is 127 characters. 679Note: maximum allowed name length is 127 characters.
708 680
709 681
710=head2 resistances 682=head2 resistances
765 737
766=head2 shout 738=head2 shout
767 739
768 shout <message> 740 shout <message>
769 741
770Sends a message to all players on the server that have 742Sends a message to all players on the server. It is mainly useful for
771L<listen|command/listen> level B<10> or higher. It is mainly useful for
772emergency messages ("I am trapped on xxx, can somebody help me?") and 743emergency messages ("I am trapped on xxx, can somebody help me?") and
773should not be used for general chat. Use L<chat|command/chat> instead. 744should not be used for general chat. Use L<chat|command/chat> instead.
774 745
775=head2 showpets 746=head2 showpets
776 747
803applies to new items you pick up - items that you are already holding will 774applies to new items you pick up - items that you are already holding will
804not be sorted. 775not be sorted.
805 776
806If sort_inventory is not set (default), items will be inserted via type, 777If sort_inventory is not set (default), items will be inserted via type,
807subtype and magic. This, all axes will be grouped together in magic order, 778subtype and magic. This, all axes will be grouped together in magic order,
808all daggers by magic order, etc. Unforunately, for scrolls and rings, new 779all daggers by magic order, etc. Unfortunately, for scrolls and rings, new
809ones just get inserted last. 780ones just get inserted last.
810 781
811If you have a lot of stuff that is not in alphabetical order but you would 782If you have a lot of stuff that is not in alphabetical order but you would
812like it to be, the best method is to drop all of it and then pick it up. 783like it to be, the best method is to drop all of it and then pick it up.
813 784
814=head2 sound 785=head2 sound
815 786
816Toggles between sound enabled and disabled. This has no relevance to the 787Toggles between sound enabled and disabled. This has no relevance to the
817sound settings of the client, it only governs wether the server will send 788sound settings of the client, it only governs whether the server will send
818sound effect command to the client and is enabled if the client supports 789sound effect command to the client and is enabled if the client supports
819sound (i.e. always for cfplus). 790sound (i.e. always for the deliantra client).
820 791
821=head2 sourcecode 792=head2 sourcecode
822 793
823This command displays the means to download the sourcecode (server code, 794This command displays the means to download the source code (server code,
824maps and archetypes) used to implement this version of the game. 795maps and archetypes) used to implement this version of the game.
825 796
826Every player has the right to download and modify the source code of the 797Every player has the right to download and modify the source code of the
827server, as required by both the GNU General Public License and the GNU 798server, as required by both the GNU General Public License and the GNU
828Affero General Public license. 799Affero General Public license.
851Kills yourself. No, really. 822Kills yourself. No, really.
852 823
853This command might not look useful at first, but sometimes you can get 824This command might not look useful at first, but sometimes you can get
854yourself into a corner you can't escape anymore, either due to a map 825yourself into a corner you can't escape anymore, either due to a map
855bug or your own stupidity. Killing oneself can be difficult and time 826bug or your own stupidity. Killing oneself can be difficult and time
856consuming, thats why this command is provided. It is fast, painless, 827consuming, that's why this command is provided. It is fast, painless,
857effective, humane. 828effective, humane.
858 829
859=head2 take 830=head2 take
860 831
861The take commands take object(s) on the space the player is standing on, 832The take commands take object(s) on the space the player is standing on,
887thrown away. God-given items can not be thrown. You need the skill throwing 858thrown away. God-given items can not be thrown. You need the skill throwing
888for this to work. 859for this to work.
889 860
890=head2 time 861=head2 time
891 862
892Shows the Crossfire in-game time, not the server time. It looks like this: 863Shows the Deliantra in-game time, not the server time. It looks like this:
893 864
894 It is 52 minutes past 8 o'clock am, on the Day of the Bull 865 It is 52 minutes past 8 o'clock am, on the Day of the Bull,
895 The 2nd Day of the Month of the Frost Giant, Year 63 866 the 2nd Day of the Month of the Frost Giant, Year 63.
896 Time of Year: The Season of New Year 867 Time of Year: The Season of New Year.
897 868
898It is partially just for fun but it affects the darkness outside and the 869An hour of game time passes in 3 minutes of real time. The time and
899weather if weather is enabled in the server. 870calendar uses 60 minutes per hour, 28 hours per day, seven days per week,
871five weeks per month, and 17 months per year. The year is additionally
872split into four seasons of 4 months each, except the season of the
873Blizzard, which is 5 months long.
874
875The number "zero" is unknown, which is why the minutes go from 1 to 60.
876
877Seasons and the time of the day affect the overall outdoor daylight.
900 878
901=head2 title 879=head2 title
880
881 title <new title>
882 title clear # Sets your title back to your race.
902 883
903Players can change their title. For example you called yourself Gandalf and 884Players can change their title. For example you called yourself Gandalf and
904your race is elf, you can use the title command to change your name from 885your race is elf, you can use the title command to change your name from
905"Gandalf the elf" to "Gandalf the white". Usage: 886"Gandalf the elf" to "Gandalf the white" by using C<title the white>.
906
907 title <new title>
908 title clear # Sets your title back to your race.
909 887
910Dragons cannot set their title because it changes during the game. 888Dragons cannot set their title because it changes during the game.
911 889
912=head2 unignore 890=head2 unignore
913 891
931 909
932The B<usekeys> option determines the behaviour of using keys. 910The B<usekeys> option determines the behaviour of using keys.
933 911
934Values are: 912Values are:
935 913
914=over 4
915
936inventory: Only keys in the top level inventory are used (default) 916=item B<inventory>: Only keys in the top level inventory are used (default)
937 917
938keyrings: Only keys in active keyrings are used. 918=item B<keyrings>: Only keys in active key rings are used.
939 919
940containers: Only keys in active containers are used. 920=item B<containers>: Only keys in active containers are used.
941 921
922=back
923
942Note that keyrings are just a specialized container, so the containers 924Note that key rings are just a specialized container, so the containers
943will also find keys in keyrings. 925will also find keys in key rings.
944 926
945Only active containers are used - keys will not jump out of closed 927Only active containers are used - keys will not jump out of closed
946containers, but hints will be given if you have keys in such containers. 928containers, but hints will be given if you have keys in such containers.
947 929
948=head2 version 930=head2 version
981 963
982 964
983=head1 Authors 965=head1 Authors
984 966
985Parts of this document were originally taken from the crossfire server 967Parts of this document were originally taken from the crossfire server
986help files with unknwon authors. 968help files with unknown authors.
987 969
988Adapted for use by I<cfplus>, enhanced and corrected by Pippijn van 970Adapted for use by I<deliantra>, enhanced and corrected by Pippijn van
989Steenhoven and Marc A. Lehmann. 971Steenhoven and Marc A. Lehmann.
990 972

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines