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.3 by root, Thu Sep 14 19:22:05 2006 UTC vs.
Revision 1.15 by root, Fri Dec 28 12:44:45 2007 UTC

1=begin comment 1=begin comment
2
3*** 2***
4*** WARNING: 3*** WARNING: THIS IS A GENERATED FILE - CHANGES WILL BE LOST
5*** This file resides in both CFPlus/pod/ and server/pod/ 4*** The source for this file is in CFPlus/pod/command_help.pod
6*** Only ever edit the version in CFPlus/pod/ and run 5*** Make any changes there and then run ./copy_doc
7*** ./copy_pod inside server/pod/ to update that copy.
8*** 6***
7=end comment
9 8
10=end
11
12=head1 Crossfire+ Command ListingX<command> 9=head1 Deliantra Command ListingX<command>
13 10
14=head2 accept-invitation 11=head2 accept-invitation
15 12
16Accepts an invitation previously issued by another player using the invite 13Accepts an invitation previously issued by another player using the invite
17command. This will transfer you to the location you were invited to. 14command. This will transfer you to the location you were invited to.
186will be dropped. A collection of 5 scrolls will not be dropped. 183will be dropped. A collection of 5 scrolls will not be dropped.
187 184
188See also B<dropall> and mouse button control within client for dropping 185See also B<dropall> and mouse button control within client for dropping
189objects. 186objects.
190 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
191=head2 dropall 204=head2 dropall
192 205
193 dropall [type] 206 dropall [type]
194 207
195B<dropall> drops all items in your inventory to the ground, excepting 208B<dropall> drops all items in your inventory to the ground, excepting
263=head2 gsay 276=head2 gsay
264 277
265If you are in a party (party join or party form), you will be able to message 278If you are in a party (party join or party form), you will be able to message
266only 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.
267 280
268=head2 golem
269
270ERROR: not a command, but another help topic => move to a different file maybe?
271
272Golems are creatures that the player has some control over. Note that many
273summoned creatures are considered golems, even if they are not called
274golems.
275
276If you have a golem in control your spell type will be listed as golem,
277with the creature name in parantheses.
278
279To control your golem, just press the fire key in the direction you want
280your golem to move. Your golem will then start moving in that direction,
281and keep moving in that direction until you change its direction.
282
283Note that once you leave the map that the golem is on, the golem will
284disappear. Also, once you select another spell to cast, or change your
285range type, your golem will disappear.
286
287=head2 help 281=head2 help
288 282
289Gives 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
290 311
291=head2 hiscore 312=head2 hiscore
292 313
293Shows a list of the highest level players in the game. 314Shows a list of the highest level players in the game.
294 315
353One can never transport from nor to an unholy place. That means, one can 374One can never transport from nor to an unholy place. That means, one can
354not be saved out of jail using invite. 375not be saved out of jail using invite.
355 376
356=head2 invoke 377=head2 invoke
357 378
358The invoke command is used 379The invoke command is used to cast a spell immediately, or when it is
359to cast a spell immediately, 380necessary to give a parameter to the spell. Invoke will not set the range
360or when it is necessary to give 381weapon.
361a parameter to the spell. Invoke
362will not set the range weapon.
363 382
364Examples: 383Examples:
384
365'invoke restoration 385 invoke restoration
366'invoke magic rune of large fireball 386 invoke magic rune of large fireball
367'invoke reincarnation of Iamdead 387 invoke reincarnation of Iamdead
368'invoke create food of waybread 388 invoke create food of waybread
369 389
370It is very helpful to bind healing 390It is very helpful to bind healing spells to keys, for example go to your
371spells to keys like this: 391I<playerbook>, tab I<spells>, the press the right mosue button on the
392spell 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,
394such as '1'.
372 395
373'bind invoke medium healing
374c
375
376the c key now casts medium healing
377instantly
378
379=head2 keys
380
381ERROR: not a command, but another help topic => move to a different file maybe?
382ERROR: its wrong anyways
383
384These are the basic movement
385keys:
386 yku
387 h l
388 bjn
389
390Running is done by holding
391control and move. Running
392is recommended.
393
394Firing the range weapon (help range)
395is done by holding shift and
396move.
397
398'help mouse for help on what the
399mouse buttons do.
400
401'help melee for advice on how to
402fight
403
404'help traps for help with finding
405and disarming traps
406 396
407=head2 killpets 397=head2 killpets
398
399 killpets [name]
408 400
409The killpets command is a quick and convenient way 401The killpets command is a quick and convenient way
410to get rid of all your pets when they are no longer 402to get rid of all your pets when they are no longer
411useful or are getting in the way. Any equipment 403useful or are getting in the way. Any equipment
412they had will be left behind, but you will get no 404they had will be left behind, but you will get no
418but not bees. If a number is specified, the pet 410but not bees. If a number is specified, the pet
419corresponding to that number is killed. 411corresponding to that number is killed.
420 412
421=head2 listen 413=head2 listen
422 414
415 listen <listen-level>
416
423Listen, sets the level of messages you will hear. 417Listen sets the level of messages you will hear.
424Priorities are defined as follows: 418Priorities are defined as follows:
425 419
426 0 - Nothing, not even "You punch kobold." or "You say: hi". 420 0 - Nothing, not even "You punch kobold." or "You say: hi".
427 1 - Only messages that have to do with yourself. 421 1 - Only messages that have to do with yourself.
428 2 - Emergency calls from other users 422 2 - Emergency calls from other users
450The rest is information the mapper may or may not provide. Often, this is 444The rest is information the mapper may or may not provide. Often, this is
451the mapper's name, email and map creation date as this example shows. 445the mapper's name, email and map creation date as this example shows.
452 446
453=head2 maps 447=head2 maps
454 448
455Shows a list of maps that are currently being visited or have been visited. 449 maps <mapname>
456The different fields are Path, Pl, PlM, IM, TO, Dif and Reset. They mean:
457 450
458Path: The last part of the map path 451Shows a list of maps matching the regex <mapname> that are currently being
459Pl: Players on the map. 452known to the server. The different fields are Pl, I, Svd, Reset and Path:
460PlM: Players on the map recounted (should be the same as Pl). 453
461IM: In memory means whether the map is: 1) in memory, 2) swapped to disk, 454=over 4
4623) currently loading or 4) currently saving. 455
463TO: Timeout, when the map is swapped to disk. 456=item Pl: the number of players on that map currently.
464Dif: Map difficulty. 457
465Reset: Real server time when the map is going to reset. 458=item I: B<I>n memory, B<S>wapped out or B<L>oading.
459
460The server keeps maps in memory only for a short time (by default about
46140 seconds). After that time, it saves them to disk. As the server loads
462most maps in the background it is possible that you can see a map that is
463currently being loaded, but thats rare, as loading a map is fast.
464
465=item Svd: the amount of seconds the map was last saved (++ means >99).
466
467The server by default tries to save each map at least every 20 seconds if
468it changed, so in case of a disastrous crash (one where the server cannot
469emergency save), at most 20 seconds of gameplay are lost.
470
471=item Reset: the minimum number of seconds the map will stay as is (will not reset).
472
473Most maps will not reset as long as players are on it, and usually the
474reset counter only starts going down when all players left the map. Some
475maps will never reset in the common sense, these are usually marked with a
476very high number (sucha s C<1e+99>).
477
478=item Path: the name that uniquely identifies the map, can be used for goto etc.
479
480=back
481
466 482
467=head2 mark 483=head2 mark
468 484
469B<mark> is used to mark items for items that apply other items. Examples of 485B<mark> is used to mark items for items that apply other items. Examples of
470these are flint & steel marked for apply torches, a weapon marked for 486these are flint & steel marked for apply torches, a weapon marked for
484 500
485=head2 motd 501=head2 motd
486 502
487Shows the message of the day. It takes no arguments. 503Shows the message of the day. It takes no arguments.
488 504
489=head2 melee
490
491ERROR: not a command, but another help topic => move to a different file maybe?
492
493You fight to kill monsters. You can either use magic or weapons.
494
495To use weapons, simply wield a weapon (and armour!) and move into the
496monster you want to attack.
497
498To use magic or bows, read
499'help spells
500and
501'help range
502and
503'help cast
504and
505'help invoke
506
507=head2 mode
508
509ERROR: not a command, but another help topic => move to a different file maybe?
510
511The mode commands are as follows:
512
513Applymode, adjusts how items are applied
514Bowmode, adjusts the way bows work
515Peaceful, sets how you react to other players
516Petmode, adjusts how your pets behave
517
518=head2 mouse
519
520ERROR: not a command, but another help topic => move to a different file maybe?
521
522The mouse isn't a great way to move your character. It'll work, but you'll
523be handicapped unless you use the keyboard for this. However, the mouse
524has the following inventory uses:
525
526Middle button on item: apply
527or equip
528
529Right button: drop or pickup
530item on ground
531
532Left button: info on item
533
534=head2 move
535
536ERROR: not a command, but another help topic => move to a different file maybe?
537ERROR: same as "keys"?
538
539These are the basic movement
540keys:
541 yku
542 h l
543 bjn
544
545Running is done by holding
546control and move. Running
547is recommended.
548
549Firing the range weapon (help range)
550is done by holding shift and
551move.
552
553'help mouse for help on what the
554mouse buttons do.
555
556'help melee for advice on how to
557fight
558
559'help traps for help with finding
560and disarming traps
561
562=head2 output-count 505=head2 output-count
563 506
564output-sync controls how often information is sent to the screen. Each 507 output-count [lines]
565buffer has its own time value, and will be flushed independantly. The
566default value is 16 ticks (about 2 seconds).
567 508
568output-count sets after how many messages of the same type, they are 509output-count sets after how many messages of the same type, they are
569then printed out. If the value was 10, then after killing ten orcs, the 510then printed out. If the value was 10, then after killing ten orcs, the
570message '10 times you kill orc' would be printed out. The default value is 511message '10 times you kill orc' would be printed out. The default value is
5711 - this means that all messages get printed out as they are requested - 5121 - this means that all messages get printed out as they are requested -
572buffering is disabled in this regard. 513buffering is disabled in this regard.
573 514
574See also L<output-sync>.
575
576=head2 output-sync
577
578output-sync controls how often information is sent to the screen. Each 515output-sync controls how often information is sent to the screen. Each
579buffer has its own time value, and will be flushed independantly. The 516buffer has its own time value, and will be flushed independantly. The
580default value is 16 ticks (about 2 seconds). 517default value is usually less than a second.
518
519See also L<output-sync>.
520
521=head2 output-rate
522
523 output-rate [bytes per second]
524
525Show the current setting of the output-rate, or set it to the provided
526value. The server will try very hard not to send more than this many bytes
527per second to your client. If the rate is exceeded, the server tries to
528hold back less important information (such as new images) to increase
529responsiveness.
530
531The server-side default is usually quite high, around 100000. If the
532server is running on a Linux kernel, it will adjust to the actual
533bandwidth available, and output-rate only sets an upper bound. That is,
534the server will automatically set an optimal send rate and adjusting your
535output-rate is not required.
536
537=head2 output-sync
538
539 output-sync [seconds]
540
541output-sync controls how often information is sent to the screen. Each
542buffer has its own time value, and will be flushed independantly. The
543default value is usually less than a second.
581 544
582output-count sets after how many messages of the same type, they are 545output-count sets after how many messages of the same type, they are
583then printed out. If the value was 10, then after killing ten orcs, the 546then printed out. If the value was 10, then after killing ten orcs, the
584message '10 times you kill orc' would be printed out. The default value is 547message '10 times you kill orc' would be printed out. The default value is
5851 - this means that all messages get printed out as they are requested - 5481 - this means that all messages get printed out as they are requested -
613party leave 576party leave
614 takes you out of current party 577 takes you out of current party
615 578
616=head2 peaceful 579=head2 peaceful
617 580
618TODO: rework for cf.schmorp.de, intended future behaviour is to toggle 581TODO: rework for deliantra, intended future behaviour is to toggle
619peaceful mode with regards to npc and monsters only, not with regards to 582peaceful mode with regards to npc and monsters only, not with regards to
620players (which will be controlled by priests). 583players (which will be controlled by priests).
621 584
622The B<peaceful> command will switch you between peaceful and hostile attack 585The B<peaceful> command will switch you between peaceful and hostile attack
623modes. 586modes.
694Goldcoins have a value density of 66, 657Goldcoins have a value density of 66,
695 658
696Density 10 will pickup silver, gold, rings, wands, books, and scrolls. 659Density 10 will pickup silver, gold, rings, wands, books, and scrolls.
697Artifacts are also picked up. 660Artifacts are also picked up.
698 661
662
699=head2 prepare 663=head2 prepare
700 664
701The same as cast. Usage: 665The same as cast. Usage:
702 666
703 prepare <spell> 667 prepare <spell>
704 668
705=head2 X<quests>quests (|finished|.*)
706
707The quests command lists the quests you are doing or have completed.
708
709Parameters are:
710
711=over 4
712
713=item no arguments: displays current quests.
714
715=item B<finished>: displays finished quests;
716
717=item anything else: displays details for quests (finished or not) with name containing the given string.
718
719=back
720 669
721=head2 quit 670=head2 quit
722 671
723Deletes your character from the server. If you want to quit the session 672Deletes your character from the server. If you want to quit the session
724without deleting your character, you must use a I<Bed to Reality>. Find a 673without deleting your character, you must use a I<Bed to Reality>. Find a
725bed (probably in a building close to where you entered the game), get on 674bed (probably in a building close to where you entered the game), get on
726top of it, and apply it using B<Tab> ro the B<apply> command. 675top of it, and apply it using B<Tab> ro the B<apply> command.
727 676
677
728=head2 range 678=head2 range
729 679
730Your range weapon can be one of several weapons, a spell you cast, a 680Your range weapon can be one of several weapons, a spell you cast, a
731bow-and-arrow, a rod, or a wand, to name a few. 681bow-and-arrow, a rod, or a wand, to name a few.
732 682
733Your range weapon is fired when you press SHIFT-direction, and will be 683Your range weapon is fired when you press SHIFT-direction, and will be
734fired in that direction. 684fired in that direction.
685
735 686
736=head2 ready_skill 687=head2 ready_skill
737 688
738 ready_skill <name of skill> 689 ready_skill <name of skill>
739 690
742readied, some need to be actively used by "firing" them. 693readied, some need to be actively used by "firing" them.
743 694
744If you just want to invoke a skill once, leaving your range slot 695If you just want to invoke a skill once, leaving your range slot
745untouched, use L<use_skill> instead. 696untouched, use L<use_skill> instead.
746 697
698
747=head2 rename 699=head2 rename
748 700
749Changes/removes the custom name of given item (or the marked one). 701Changes/removes the custom name of given item (or the marked one).
750 702
751 rename oldname to newname 703 rename oldname to newname
753 705
754If either of the names contain spaces, you have to use the C<">-form, 706If either of the names contain spaces, you have to use the C<">-form,
755otherwise you can just write the name as-is. If you omit the old name, the 707otherwise you can just write the name as-is. If you omit the old name, the
756marked item will be used instead. 708marked item will be used instead.
757 709
758If the new name is empty (i.e. C<"">), then the custom name will be 710If the new name is empty (i.e. C<"">), then the original (unrenamed) name
759removed from the item. 711will be restored.
760 712
761Note: maximum allowed name length is 127 characters. 713Note: maximum allowed name length is 127 characters.
762 714
763=head2 reply
764
765 reply <message>
766
767Similar to tell, but instead of having to supply a username, it replies
768to the last player that sent you a tell. This is a bit racy (e.g. when
769somebody else tells you something while you type and you do not realise
770that), so be careful not to supply confidential information in the
771message.
772 715
773=head2 resistances 716=head2 resistances
774 717
775This shows you the resistances you have to specific attack types. 718This shows you the resistances you have to specific attack types.
776If you have for example "cold +20", it means you get 20% damage done 719If you have for example "cold +20", it means you get 20% damage done
879Toggles between sound enabled and disabled. This has no relevance to the 822Toggles between sound enabled and disabled. This has no relevance to the
880sound settings of the client, it only governs wether the server will send 823sound settings of the client, it only governs wether the server will send
881sound effect command to the client and is enabled if the client supports 824sound effect command to the client and is enabled if the client supports
882sound (i.e. always for cfplus). 825sound (i.e. always for cfplus).
883 826
827=head2 sourcecode
828
829This command displays the means to download the sourcecode (server code,
830maps and archetypes) used to implement this version of the game.
831
832Every player has the right to download and modify the source code of the
833server, as required by both the GNU General Public License and the GNU
834Affero General Public license.
835
836If you modify your version of the server, you will have to provide a means
837to download the modified sources (and resources) via this command. If you
838run an unmodified version of the server, the default will do.
839
884=head2 statistics 840=head2 statistics
885 841
886B<statistics> shows various useful information about your character. 842B<statistics> shows various useful information about your character.
887None of the information it shows is stuff that is not contained in the 843None of the information it shows is stuff that is not contained in the
888documentation. 844documentation.
937thrown away. God-given items can not be thrown. You need the skill throwing 893thrown away. God-given items can not be thrown. You need the skill throwing
938for this to work. 894for this to work.
939 895
940=head2 time 896=head2 time
941 897
942Shows the Crossfire in-game time, not the server time. It looks like this: 898Shows the Deliantra in-game time, not the server time. It looks like this:
943 899
944 It is 52 minutes past 8 o'clock am, on the Day of the Bull 900 It is 52 minutes past 8 o'clock am, on the Day of the Bull
945 The 2nd Day of the Month of the Frost Giant, Year 63 901 The 2nd Day of the Month of the Frost Giant, Year 63
946 Time of Year: The Season of New Year 902 Time of Year: The Season of New Year
947 903
957 title <new title> 913 title <new title>
958 title clear # Sets your title back to your race. 914 title clear # Sets your title back to your race.
959 915
960Dragons cannot set their title because it changes during the game. 916Dragons cannot set their title because it changes during the game.
961 917
962=head2 traps
963
964ERROR: not a command, but another help topic => move to a different file maybe?
965
966I recommend the following
967keybindings
968'bind search
969s
970'bind disarm
971d
972Then you can use the 's' and
973'd' keys for searching for and
974disarming traps.
975
976Traps appear at random in doors and in chests. Search those before you
977open them up. Search by going near where you suspect a trap, and type 's'
978
979=head2 unignore 918=head2 unignore
980 919
981 unignore <login> 920 unignore <login>
982 921
983Cancels all ignores set for the specified login. See B<ignore>. 922Cancels all ignores set for the specified login. See B<ignore>.
923
924=head2 uptime
925
926Tells you something about the time the server was started and how long ago
927that was.
984 928
985=head2 use_skill 929=head2 use_skill
986 930
987 use_skill <name of skill> 931 use_skill <name of skill>
988 932
1039 983
1040The wimpy level is the amount of health points (hp) that may be left before you 984The wimpy level is the amount of health points (hp) that may be left before you
1041automatically run away. This may be useful in hand-to-hand combats but should 985automatically run away. This may be useful in hand-to-hand combats but should
1042not be used when the opponent attacks with spells. 986not be used when the opponent attacks with spells.
1043 987
988
1044=head1 Authors 989=head1 Authors
1045 990
1046Parts of this document were originally taken from the crossfire server 991Parts of this document were originally taken from the crossfire server
1047help files with unknwon authors. 992help files with unknwon authors.
1048 993
1049Adapted for use by I<cfplus>, enhanced and corrected by Pippijn van 994Adapted for use by I<deliantra>, enhanced and corrected by Pippijn van
1050Steenhoven and Marc A. Lehmann. 995Steenhoven and Marc A. Lehmann.
1051 996

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines