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.8 by root, Sun Dec 10 21:10:06 2006 UTC vs.
Revision 1.29 by root, Fri Aug 29 02:02:10 2008 UTC

1=begin comment
2
3***
4*** WARNING:
5*** This file resides in both CFPlus/pod/ and server/pod/
6*** Only ever edit the version in CFPlus/pod/ and run
7*** ./copy_pod inside server/pod/ to update that copy.
8***
9
10=end
11
12=head1 Crossfire+ Command ListingX<command> 1=head1 Deliantra Command ListingX<command>
13 2
14=head2 accept-invitation 3=head2 accept-invitation
15 4
16Accepts an invitation previously issued by another player using the invite 5Accepts an invitation previously issued by another player using the invite
17command. This will transfer you to the location you were invited to. 6command. This will transfer you to the location you were invited to.
130 119
131=head2 chat 120=head2 chat
132 121
133 chat <message> 122 chat <message>
134 123
135Sends 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
136L<listen|command/listen> level B<10> or higher. 125chat with others.
137 126
138=head2 cast 127=head2 cast
139 128
140You use the cast command to set your range-weapon to the spell you 129You use the cast command to set your range-weapon to the spell you
141want. Example: 130want. Example:
186will be dropped. A collection of 5 scrolls will not be dropped. 175will be dropped. A collection of 5 scrolls will not be dropped.
187 176
188See also B<dropall> and mouse button control within client for dropping 177See also B<dropall> and mouse button control within client for dropping
189objects. 178objects.
190 179
180
181=head2 cointoss
182
183Tosses a coin and reports the outcome to you and other players on the same
184map, much like the say command does.
185
186
187=head2 orcknuckle
188
189Throws your orcknuckle set and reports the outcome to you and other
190players on the same map, much like the say command does. Your first
191three orcknuckle throws can report I<beholder>, I<ghost>, I<knight>,
192I<princess>, I<dragon>, while the fourth can additionally roll up to
193I<orc>.
194
195
191=head2 dropall 196=head2 dropall
192 197
193 dropall [type] 198 dropall [type]
194 199
195B<dropall> drops all items in your inventory to the ground, excepting 200B<dropall> drops all items in your inventory to the ground, excepting
263=head2 gsay 268=head2 gsay
264 269
265If you are in a party (party join or party form), you will be able to message 270If 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. 271only your party. Even people standing right next to you can't hear it.
267 272
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 273=head2 help
288 274
289Gives you online help for the command or help topic specified. 275Gives you online help for the command or help topic specified.
276
277=head2 hintmode (show|mark|hide)
278
279 hintmode show|mark|hide
280
281Sets the I<hint mode> to the given value: Throughout the game you can find
282hints that sometimes help you to solve a puzzle or manage a situation
283better than without. You can change the display of these hints with this
284command:
285
286=over 4
287
288=item show
289
290Show the hints (the default mode).
291
292=item mark
293
294Do not show the hints themselves, but notify you when a hint would have
295been available.
296
297=item hide
298
299Hide all hints: You will not be able to tell wether there is a hint
300available or not.
301
302=back
290 303
291=head2 hiscore 304=head2 hiscore
292 305
293Shows a list of the highest level players in the game. 306Shows a list of the highest level players in the game.
294 307
353One can never transport from nor to an unholy place. That means, one can 366One can never transport from nor to an unholy place. That means, one can
354not be saved out of jail using invite. 367not be saved out of jail using invite.
355 368
356=head2 invoke 369=head2 invoke
357 370
358The invoke command is used 371The invoke command is used to cast a spell immediately, or when it is
359to cast a spell immediately, 372necessary to give a parameter to the spell. Invoke will not set the range
360or when it is necessary to give 373weapon.
361a parameter to the spell. Invoke
362will not set the range weapon.
363 374
364Examples: 375Examples:
376
365'invoke restoration 377 invoke restoration
366'invoke magic rune of large fireball 378 invoke magic rune of large fireball
367'invoke reincarnation of Iamdead 379 invoke reincarnation of Iamdead
368'invoke create food of waybread 380 invoke create food of waybread
369 381
370It is very helpful to bind healing 382It is very helpful to bind healing spells to keys, for example go to your
371spells to keys like this: 383I<playerbook>, tab I<spells>, the press the right mosue button on the
384spell 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,
386such as '1'.
372 387
373'bind invoke medium healing
374c
375 388
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
407=head2 killpets [name] 389=head2 killpets
390
391 killpets [name]
408 392
409The killpets command is a quick and convenient way 393The killpets command is a quick and convenient way
410to get rid of all your pets when they are no longer 394to get rid of all your pets when they are no longer
411useful or are getting in the way. Any equipment 395useful or are getting in the way. Any equipment
412they had will be left behind, but you will get no 396they had will be left behind, but you will get no
416If a name is specified then only pets with that 400If a name is specified then only pets with that
417name will be killed, eg killpets bat will kill bats 401name will be killed, eg killpets bat will kill bats
418but not bees. If a number is specified, the pet 402but not bees. If a number is specified, the pet
419corresponding to that number is killed. 403corresponding to that number is killed.
420 404
421=head2 listen
422
423Listen, sets the level of messages you will hear.
424Priorities are defined as follows:
425
426 0 - Nothing, not even "You punch kobold." or "You say: hi".
427 1 - Only messages that have to do with yourself.
428 2 - Emergency calls from other users
429 10 - General chatter with the 'chat' command.
430 11 - See what players kill what monster with what attack/spell. Very
431 verbose - only for the fanatics.
432
433=head2 logs
434
435TODO
436
437=head2 mapinfo 405=head2 mapinfo
438 406
439Shows some information about the map like this: 407Shows some information about the map like this:
440 408
441 world_105_115 (/world/world_105_115) in scorn 409 world_105_115 (/world/world_105_115) in scorn
450The rest is information the mapper may or may not provide. Often, this is 418The 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. 419the mapper's name, email and map creation date as this example shows.
452 420
453=head2 maps 421=head2 maps
454 422
455Shows a list of maps that are currently being visited or have been visited. 423 maps <mapname>
456The different fields are Path, Pl, PlM, IM, TO, Dif and Reset. They mean:
457 424
458Path: The last part of the map path 425Shows a list of maps matching the regex <mapname> that are currently being
459Pl: Players on the map. 426known 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). 427
461IM: In memory means whether the map is: 1) in memory, 2) swapped to disk, 428=over 4
4623) currently loading or 4) currently saving. 429
463TO: Timeout, when the map is swapped to disk. 430=item Pl: the number of players on that map currently.
464Dif: Map difficulty. 431
465Reset: Real server time when the map is going to reset. 432=item I: B<I>n memory, B<S>wapped out or B<L>oading.
433
434The server keeps maps in memory only for a short time (by default about
43540 seconds). After that time, it saves them to disk. As the server loads
436most maps in the background it is possible that you can see a map that is
437currently being loaded, but thats rare, as loading a map is fast.
438
439=item Svd: the amount of seconds the map was last saved (++ means >99).
440
441The server by default tries to save each map at least every 20 seconds if
442it changed, so in case of a disastrous crash (one where the server cannot
443emergency save), at most 20 seconds of gameplay are lost.
444
445=item Reset: the minimum number of seconds the map will stay as is (will not reset).
446
447Most maps will not reset as long as players are on it, and usually the
448reset counter only starts going down when all players left the map. Some
449maps will never reset in the common sense, these are usually marked with a
450very high number (sucha s C<1e+99>).
451
452=item Path: the name that uniquely identifies the map, can be used for goto etc.
453
454=back
455
466 456
467=head2 mark 457=head2 mark
468 458
469B<mark> is used to mark items for items that apply other items. Examples of 459B<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 460these are flint & steel marked for apply torches, a weapon marked for
484 474
485=head2 motd 475=head2 motd
486 476
487Shows the message of the day. It takes no arguments. 477Shows the message of the day. It takes no arguments.
488 478
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 479=head2 output-count
563 480
564output-sync controls how often information is sent to the screen. Each 481 output-count [lines]
565buffer has its own time value, and will be flushed independantly. The
566default value is 16 ticks (about 2 seconds).
567 482
568output-count sets after how many messages of the same type, they are 483output-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 484then 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 485message '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 - 4861 - this means that all messages get printed out as they are requested -
572buffering is disabled in this regard. 487buffering is disabled in this regard.
573 488
574See also L<output-sync>.
575
576=head2 output-sync
577
578output-sync controls how often information is sent to the screen. Each 489output-sync controls how often information is sent to the screen. Each
579buffer has its own time value, and will be flushed independantly. The 490buffer has its own time value, and will be flushed independantly. The
580default value is 16 ticks (about 2 seconds). 491default value is usually less than a second.
492
493See also L<output-sync>.
494
495=head2 output-rate
496
497 output-rate [bytes per second]
498
499Show the current setting of the output-rate, or set it to the provided
500value. The server will try very hard not to send more than this many bytes
501per second to your client. If the rate is exceeded, the server tries to
502hold back less important information (such as new images) to increase
503responsiveness.
504
505The server-side default is usually quite high, around 100000. If the
506server is running on a Linux kernel, it will adjust to the actual
507bandwidth available, and output-rate only sets an upper bound. That is,
508the server will automatically set an optimal send rate and adjusting your
509output-rate is not required.
510
511=head2 output-sync
512
513 output-sync [seconds]
514
515output-sync controls how often information is sent to the screen. Each
516buffer has its own time value, and will be flushed independantly. The
517default value is usually less than a second.
581 518
582output-count sets after how many messages of the same type, they are 519output-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 520then 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 521message '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 - 5221 - this means that all messages get printed out as they are requested -
613party leave 550party leave
614 takes you out of current party 551 takes you out of current party
615 552
616=head2 peaceful 553=head2 peaceful
617 554
618TODO: rework for cf.schmorp.de, intended future behaviour is to toggle 555TODO: rework for deliantra, intended future behaviour is to toggle
619peaceful mode with regards to npc and monsters only, not with regards to 556peaceful mode with regards to npc and monsters only, not with regards to
620players (which will be controlled by priests). 557players (which will be controlled by priests).
621 558
622The B<peaceful> command will switch you between peaceful and hostile attack 559The B<peaceful> command will switch you between peaceful and hostile attack
623modes. 560modes.
694Goldcoins have a value density of 66, 631Goldcoins have a value density of 66,
695 632
696Density 10 will pickup silver, gold, rings, wands, books, and scrolls. 633Density 10 will pickup silver, gold, rings, wands, books, and scrolls.
697Artifacts are also picked up. 634Artifacts are also picked up.
698 635
636
699=head2 prepare 637=head2 prepare
700 638
701The same as cast. Usage: 639The same as cast. Usage:
702 640
703 prepare <spell> 641 prepare <spell>
704 642
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 643
721=head2 quit 644=head2 quit
722 645
723Deletes your character from the server. If you want to quit the session 646Deletes 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 647without 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 648bed (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. 649top of it, and apply it using B<Tab> ro the B<apply> command.
727 650
651
728=head2 range 652=head2 range
729 653
730Your range weapon can be one of several weapons, a spell you cast, a 654Your 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. 655bow-and-arrow, a rod, or a wand, to name a few.
732 656
733Your range weapon is fired when you press SHIFT-direction, and will be 657Your range weapon is fired when you press SHIFT-direction, and will be
734fired in that direction. 658fired in that direction.
659
735 660
736=head2 ready_skill 661=head2 ready_skill
737 662
738 ready_skill <name of skill> 663 ready_skill <name of skill>
739 664
742readied, some need to be actively used by "firing" them. 667readied, some need to be actively used by "firing" them.
743 668
744If you just want to invoke a skill once, leaving your range slot 669If you just want to invoke a skill once, leaving your range slot
745untouched, use L<use_skill> instead. 670untouched, use L<use_skill> instead.
746 671
672
747=head2 rename 673=head2 rename
748 674
749Changes/removes the custom name of given item (or the marked one). 675Changes/removes the custom name of given item (or the marked one).
750 676
751 rename oldname to newname 677 rename oldname to newname
753 679
754If either of the names contain spaces, you have to use the C<">-form, 680If 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 681otherwise you can just write the name as-is. If you omit the old name, the
756marked item will be used instead. 682marked item will be used instead.
757 683
758If the new name is empty (i.e. C<"">), then the custom name will be 684If the new name is empty (i.e. C<"">), then the original (unrenamed) name
759removed from the item. 685will be restored.
760 686
761Note: maximum allowed name length is 127 characters. 687Note: maximum allowed name length is 127 characters.
762 688
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 689
773=head2 resistances 690=head2 resistances
774 691
775This shows you the resistances you have to specific attack types. 692This shows you the resistances you have to specific attack types.
776If you have for example "cold +20", it means you get 20% damage done 693If you have for example "cold +20", it means you get 20% damage done
828 745
829=head2 shout 746=head2 shout
830 747
831 shout <message> 748 shout <message>
832 749
833Sends a message to all players on the server that have 750Sends a message to all players on the server. It is mainly useful for
834L<listen|command/listen> level B<10> or higher. It is mainly useful for
835emergency messages ("I am trapped on xxx, can somebody help me?") and 751emergency messages ("I am trapped on xxx, can somebody help me?") and
836should not be used for general chat. Use L<chat|command/chat> instead. 752should not be used for general chat. Use L<chat|command/chat> instead.
837 753
838=head2 showpets 754=head2 showpets
839 755
879Toggles between sound enabled and disabled. This has no relevance to the 795Toggles between sound enabled and disabled. This has no relevance to the
880sound settings of the client, it only governs wether the server will send 796sound 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 797sound effect command to the client and is enabled if the client supports
882sound (i.e. always for cfplus). 798sound (i.e. always for cfplus).
883 799
800=head2 sourcecode
801
802This command displays the means to download the sourcecode (server code,
803maps and archetypes) used to implement this version of the game.
804
805Every player has the right to download and modify the source code of the
806server, as required by both the GNU General Public License and the GNU
807Affero General Public license.
808
809If you modify your version of the server, you will have to provide a means
810to download the modified sources (and resources) via this command. If you
811run an unmodified version of the server, the default will do.
812
884=head2 statistics 813=head2 statistics
885 814
886B<statistics> shows various useful information about your character. 815B<statistics> shows various useful information about your character.
887None of the information it shows is stuff that is not contained in the 816None of the information it shows is stuff that is not contained in the
888documentation. 817documentation.
937thrown away. God-given items can not be thrown. You need the skill throwing 866thrown away. God-given items can not be thrown. You need the skill throwing
938for this to work. 867for this to work.
939 868
940=head2 time 869=head2 time
941 870
942Shows the Crossfire in-game time, not the server time. It looks like this: 871Shows the Deliantra in-game time, not the server time. It looks like this:
943 872
944 It is 52 minutes past 8 o'clock am, on the Day of the Bull 873 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 874 The 2nd Day of the Month of the Frost Giant, Year 63
946 Time of Year: The Season of New Year 875 Time of Year: The Season of New Year
947 876
957 title <new title> 886 title <new title>
958 title clear # Sets your title back to your race. 887 title clear # Sets your title back to your race.
959 888
960Dragons cannot set their title because it changes during the game. 889Dragons cannot set their title because it changes during the game.
961 890
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 891=head2 unignore
980 892
981 unignore <login> 893 unignore <login>
982 894
983Cancels all ignores set for the specified login. See B<ignore>. 895Cancels all ignores set for the specified login. See B<ignore>.
896
897=head2 uptime
898
899Tells you something about the time the server was started and how long ago
900that was.
984 901
985=head2 use_skill 902=head2 use_skill
986 903
987 use_skill <name of skill> 904 use_skill <name of skill>
988 905
1039 956
1040The wimpy level is the amount of health points (hp) that may be left before you 957The 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 958automatically run away. This may be useful in hand-to-hand combats but should
1042not be used when the opponent attacks with spells. 959not be used when the opponent attacks with spells.
1043 960
961
1044=head1 Authors 962=head1 Authors
1045 963
1046Parts of this document were originally taken from the crossfire server 964Parts of this document were originally taken from the crossfire server
1047help files with unknwon authors. 965help files with unknown authors.
1048 966
1049Adapted for use by I<cfplus>, enhanced and corrected by Pippijn van 967Adapted for use by I<deliantra>, enhanced and corrected by Pippijn van
1050Steenhoven and Marc A. Lehmann. 968Steenhoven and Marc A. Lehmann.
1051 969

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines