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.9 by root, Thu Jun 21 22:30:15 2007 UTC vs.
Revision 1.16 by root, Fri Aug 29 02:02:52 2008 UTC

4*** The source for this file is in CFPlus/pod/command_help.pod 4*** The source for this file is in CFPlus/pod/command_help.pod
5*** Make any changes there and then run ./copy_doc 5*** Make any changes there and then run ./copy_doc
6*** 6***
7=end comment 7=end comment
8 8
9=head1 Crossfire TRT Command ListingX<command> 9=head1 Deliantra Command ListingX<command>
10 10
11=head2 accept-invitation 11=head2 accept-invitation
12 12
13Accepts an invitation previously issued by another player using the invite 13Accepts an invitation previously issued by another player using the invite
14command. This will transfer you to the location you were invited to. 14command. This will transfer you to the location you were invited to.
127 127
128=head2 chat 128=head2 chat
129 129
130 chat <message> 130 chat <message>
131 131
132Sends a message to all players on the server that have 132Sends a message to all players on the server. This is the normal way to
133L<listen|command/listen> level B<10> or higher. 133chat with others.
134 134
135=head2 cast 135=head2 cast
136 136
137You use the cast command to set your range-weapon to the spell you 137You use the cast command to set your range-weapon to the spell you
138want. Example: 138want. Example:
183will be dropped. A collection of 5 scrolls will not be dropped. 183will be dropped. A collection of 5 scrolls will not be dropped.
184 184
185See also B<dropall> and mouse button control within client for dropping 185See also B<dropall> and mouse button control within client for dropping
186objects. 186objects.
187 187
188
189=head2 cointoss
190
191Tosses a coin and reports the outcome to you and other players on the same
192map, much like the say command does.
193
194
195=head2 orcknuckle
196
197Throws your orcknuckle set and reports the outcome to you and other
198players on the same map, much like the say command does. Your first
199three orcknuckle throws can report I<beholder>, I<ghost>, I<knight>,
200I<princess>, I<dragon>, while the fourth can additionally roll up to
201I<orc>.
202
203
188=head2 dropall 204=head2 dropall
189 205
190 dropall [type] 206 dropall [type]
191 207
192B<dropall> drops all items in your inventory to the ground, excepting 208B<dropall> drops all items in your inventory to the ground, excepting
263only your party. Even people standing right next to you can't hear it. 279only your party. Even people standing right next to you can't hear it.
264 280
265=head2 help 281=head2 help
266 282
267Gives you online help for the command or help topic specified. 283Gives you online help for the command or help topic specified.
284
285=head2 hintmode (show|mark|hide)
286
287 hintmode show|mark|hide
288
289Sets the I<hint mode> to the given value: Throughout the game you can find
290hints that sometimes help you to solve a puzzle or manage a situation
291better than without. You can change the display of these hints with this
292command:
293
294=over 4
295
296=item show
297
298Show the hints (the default mode).
299
300=item mark
301
302Do not show the hints themselves, but notify you when a hint would have
303been available.
304
305=item hide
306
307Hide all hints: You will not be able to tell wether there is a hint
308available or not.
309
310=back
268 311
269=head2 hiscore 312=head2 hiscore
270 313
271Shows a list of the highest level players in the game. 314Shows a list of the highest level players in the game.
272 315
365If a name is specified then only pets with that 408If a name is specified then only pets with that
366name will be killed, eg killpets bat will kill bats 409name will be killed, eg killpets bat will kill bats
367but not bees. If a number is specified, the pet 410but not bees. If a number is specified, the pet
368corresponding to that number is killed. 411corresponding to that number is killed.
369 412
370=head2 listen
371
372 listen <listen-level>
373
374Listen sets the level of messages you will hear.
375Priorities are defined as follows:
376
377 0 - Nothing, not even "You punch kobold." or "You say: hi".
378 1 - Only messages that have to do with yourself.
379 2 - Emergency calls from other users
380 10 - General chatter with the 'chat' command.
381 11 - See what players kill what monster with what attack/spell. Very
382 verbose - only for the fanatics.
383
384=head2 logs
385
386TODO
387
388=head2 mapinfo 413=head2 mapinfo
389 414
390Shows some information about the map like this: 415Shows some information about the map like this:
391 416
392 world_105_115 (/world/world_105_115) in scorn 417 world_105_115 (/world/world_105_115) in scorn
401The rest is information the mapper may or may not provide. Often, this is 426The rest is information the mapper may or may not provide. Often, this is
402the mapper's name, email and map creation date as this example shows. 427the mapper's name, email and map creation date as this example shows.
403 428
404=head2 maps 429=head2 maps
405 430
406[crossfire+]
407
408 maps <mapname> 431 maps <mapname>
409 432
410Shows a list of maps matching the regex <mapname> that are currently being 433Shows a list of maps matching the regex <mapname> that are currently being
411known to the server. The different fields are Pl, I, Svd, Reset and Path: 434known to the server. The different fields are Pl, I, Svd, Reset and Path:
412 435
428emergency save), at most 20 seconds of gameplay are lost. 451emergency save), at most 20 seconds of gameplay are lost.
429 452
430=item Reset: the minimum number of seconds the map will stay as is (will not reset). 453=item Reset: the minimum number of seconds the map will stay as is (will not reset).
431 454
432Most maps will not reset as long as players are on it, and usually the 455Most maps will not reset as long as players are on it, and usually the
433reset counter only starts going down when all players left the map. 456reset 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
458very high number (sucha s C<1e+99>).
434 459
435=item Path: the name that uniquely identifies the map, can be used for goto etc. 460=item Path: the name that uniquely identifies the map, can be used for goto etc.
436 461
437=back 462=back
438 463
473buffer has its own time value, and will be flushed independantly. The 498buffer has its own time value, and will be flushed independantly. The
474default value is usually less than a second. 499default value is usually less than a second.
475 500
476See also L<output-sync>. 501See also L<output-sync>.
477 502
503=head2 output-rate
504
478=head2 output-rate [bytes per second] 505 output-rate [bytes per second]
479 506
480Show the current setting of the output-rate, or set it to the provided 507Show the current setting of the output-rate, or set it to the provided
481value. The server will try not to send (much) more than this many bytes 508value. The server will try very hard not to send more than this many bytes
482per second to your client. If the rate is exceeded, the server tries to 509per second to your client. If the rate is exceeded, the server tries to
483hold back less important information (such as new images), to increase 510hold back less important information (such as new images) to increase
511responsiveness.
512
484responsiveness. The server-side default is usually quite high, around 513The server-side default is usually quite high, around 100000. If the
485100000, so if you have a slow link and want to be able to control your 514server is running on a Linux kernel, it will adjust to the actual
486character even when downloading faces, set this to a lower value, such as 515bandwidth available, and output-rate only sets an upper bound. That is,
4877000 (for ISDN). 516the server will automatically set an optimal send rate and adjusting your
517output-rate is not required.
488 518
489=head2 output-sync 519=head2 output-sync
490 520
491 output-sync [seconds] 521 output-sync [seconds]
492 522
528party leave 558party leave
529 takes you out of current party 559 takes you out of current party
530 560
531=head2 peaceful 561=head2 peaceful
532 562
533TODO: rework for cf.schmorp.de, intended future behaviour is to toggle 563TODO: rework for deliantra, intended future behaviour is to toggle
534peaceful mode with regards to npc and monsters only, not with regards to 564peaceful mode with regards to npc and monsters only, not with regards to
535players (which will be controlled by priests). 565players (which will be controlled by priests).
536 566
537The B<peaceful> command will switch you between peaceful and hostile attack 567The B<peaceful> command will switch you between peaceful and hostile attack
538modes. 568modes.
609Goldcoins have a value density of 66, 639Goldcoins have a value density of 66,
610 640
611Density 10 will pickup silver, gold, rings, wands, books, and scrolls. 641Density 10 will pickup silver, gold, rings, wands, books, and scrolls.
612Artifacts are also picked up. 642Artifacts are also picked up.
613 643
644
614=head2 prepare 645=head2 prepare
615 646
616The same as cast. Usage: 647The same as cast. Usage:
617 648
618 prepare <spell> 649 prepare <spell>
619 650
620=head2 X<quests>quests (|finished|.*)
621
622The quests command lists the quests you are doing or have completed.
623
624Parameters are:
625
626=over 4
627
628=item no arguments: displays current quests.
629
630=item B<finished>: displays finished quests;
631
632=item anything else: displays details for quests (finished or not) with name containing the given string.
633
634=back
635 651
636=head2 quit 652=head2 quit
637 653
638Deletes your character from the server. If you want to quit the session 654Deletes your character from the server. If you want to quit the session
639without deleting your character, you must use a I<Bed to Reality>. Find a 655without deleting your character, you must use a I<Bed to Reality>. Find a
640bed (probably in a building close to where you entered the game), get on 656bed (probably in a building close to where you entered the game), get on
641top of it, and apply it using B<Tab> ro the B<apply> command. 657top of it, and apply it using B<Tab> ro the B<apply> command.
642 658
659
643=head2 range 660=head2 range
644 661
645Your range weapon can be one of several weapons, a spell you cast, a 662Your range weapon can be one of several weapons, a spell you cast, a
646bow-and-arrow, a rod, or a wand, to name a few. 663bow-and-arrow, a rod, or a wand, to name a few.
647 664
648Your range weapon is fired when you press SHIFT-direction, and will be 665Your range weapon is fired when you press SHIFT-direction, and will be
649fired in that direction. 666fired in that direction.
667
650 668
651=head2 ready_skill 669=head2 ready_skill
652 670
653 ready_skill <name of skill> 671 ready_skill <name of skill>
654 672
657readied, some need to be actively used by "firing" them. 675readied, some need to be actively used by "firing" them.
658 676
659If you just want to invoke a skill once, leaving your range slot 677If you just want to invoke a skill once, leaving your range slot
660untouched, use L<use_skill> instead. 678untouched, use L<use_skill> instead.
661 679
680
662=head2 rename 681=head2 rename
663 682
664Changes/removes the custom name of given item (or the marked one). 683Changes/removes the custom name of given item (or the marked one).
665 684
666 rename oldname to newname 685 rename oldname to newname
673If the new name is empty (i.e. C<"">), then the original (unrenamed) name 692If the new name is empty (i.e. C<"">), then the original (unrenamed) name
674will be restored. 693will be restored.
675 694
676Note: maximum allowed name length is 127 characters. 695Note: maximum allowed name length is 127 characters.
677 696
678=head2 reply
679
680 reply <message>
681
682Similar to tell, but instead of having to supply a username, it replies
683to the last player that sent you a tell. This is a bit racy (e.g. when
684somebody else tells you something while you type and you do not realise
685that), so be careful not to supply confidential information in the
686message.
687 697
688=head2 resistances 698=head2 resistances
689 699
690This shows you the resistances you have to specific attack types. 700This shows you the resistances you have to specific attack types.
691If you have for example "cold +20", it means you get 20% damage done 701If you have for example "cold +20", it means you get 20% damage done
743 753
744=head2 shout 754=head2 shout
745 755
746 shout <message> 756 shout <message>
747 757
748Sends a message to all players on the server that have 758Sends a message to all players on the server. It is mainly useful for
749L<listen|command/listen> level B<10> or higher. It is mainly useful for
750emergency messages ("I am trapped on xxx, can somebody help me?") and 759emergency messages ("I am trapped on xxx, can somebody help me?") and
751should not be used for general chat. Use L<chat|command/chat> instead. 760should not be used for general chat. Use L<chat|command/chat> instead.
752 761
753=head2 showpets 762=head2 showpets
754 763
794Toggles between sound enabled and disabled. This has no relevance to the 803Toggles between sound enabled and disabled. This has no relevance to the
795sound settings of the client, it only governs wether the server will send 804sound settings of the client, it only governs wether the server will send
796sound effect command to the client and is enabled if the client supports 805sound effect command to the client and is enabled if the client supports
797sound (i.e. always for cfplus). 806sound (i.e. always for cfplus).
798 807
808=head2 sourcecode
809
810This command displays the means to download the sourcecode (server code,
811maps and archetypes) used to implement this version of the game.
812
813Every 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
815Affero General Public license.
816
817If you modify your version of the server, you will have to provide a means
818to download the modified sources (and resources) via this command. If you
819run an unmodified version of the server, the default will do.
820
799=head2 statistics 821=head2 statistics
800 822
801B<statistics> shows various useful information about your character. 823B<statistics> shows various useful information about your character.
802None of the information it shows is stuff that is not contained in the 824None of the information it shows is stuff that is not contained in the
803documentation. 825documentation.
852thrown away. God-given items can not be thrown. You need the skill throwing 874thrown away. God-given items can not be thrown. You need the skill throwing
853for this to work. 875for this to work.
854 876
855=head2 time 877=head2 time
856 878
857Shows the Crossfire in-game time, not the server time. It looks like this: 879Shows the Deliantra in-game time, not the server time. It looks like this:
858 880
859 It is 52 minutes past 8 o'clock am, on the Day of the Bull 881 It is 52 minutes past 8 o'clock am, on the Day of the Bull
860 The 2nd Day of the Month of the Frost Giant, Year 63 882 The 2nd Day of the Month of the Frost Giant, Year 63
861 Time of Year: The Season of New Year 883 Time of Year: The Season of New Year
862 884
946 968
947 969
948=head1 Authors 970=head1 Authors
949 971
950Parts of this document were originally taken from the crossfire server 972Parts of this document were originally taken from the crossfire server
951help files with unknwon authors. 973help files with unknown authors.
952 974
953Adapted for use by I<cfplus>, enhanced and corrected by Pippijn van 975Adapted for use by I<deliantra>, enhanced and corrected by Pippijn van
954Steenhoven and Marc A. Lehmann. 976Steenhoven and Marc A. Lehmann.
955 977

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines