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.5 by root, Fri Jan 5 22:46:39 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+ 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
260=head2 gsay 276=head2 gsay
261 277
262If 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
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 golem
266
267ERROR: not a command, but another help topic => move to a different file maybe?
268
269Golems are creatures that the player has some control over. Note that many
270summoned creatures are considered golems, even if they are not called
271golems.
272
273If you have a golem in control your spell type will be listed as golem,
274with the creature name in parantheses.
275
276To control your golem, just press the fire key in the direction you want
277your golem to move. Your golem will then start moving in that direction,
278and keep moving in that direction until you change its direction.
279
280Note that once you leave the map that the golem is on, the golem will
281disappear. Also, once you select another spell to cast, or change your
282range type, your golem will disappear.
283
284=head2 help 281=head2 help
285 282
286Gives 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
287 311
288=head2 hiscore 312=head2 hiscore
289 313
290Shows a list of the highest level players in the game. 314Shows a list of the highest level players in the game.
291 315
350One 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
351not be saved out of jail using invite. 375not be saved out of jail using invite.
352 376
353=head2 invoke 377=head2 invoke
354 378
355The invoke command is used 379The invoke command is used to cast a spell immediately, or when it is
356to cast a spell immediately, 380necessary to give a parameter to the spell. Invoke will not set the range
357or when it is necessary to give 381weapon.
358a parameter to the spell. Invoke
359will not set the range weapon.
360 382
361Examples: 383Examples:
384
362'invoke restoration 385 invoke restoration
363'invoke magic rune of large fireball 386 invoke magic rune of large fireball
364'invoke reincarnation of Iamdead 387 invoke reincarnation of Iamdead
365'invoke create food of waybread 388 invoke create food of waybread
366 389
367It is very helpful to bind healing 390It is very helpful to bind healing spells to keys, for example go to your
368spells 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'.
369 395
370'bind invoke medium healing
371c
372
373the c key now casts medium healing
374instantly
375
376=head2 keys
377
378ERROR: not a command, but another help topic => move to a different file maybe?
379ERROR: its wrong anyways
380
381These are the basic movement
382keys:
383 yku
384 h l
385 bjn
386
387Running is done by holding
388control and move. Running
389is recommended.
390
391Firing the range weapon (help range)
392is done by holding shift and
393move.
394
395'help mouse for help on what the
396mouse buttons do.
397
398'help melee for advice on how to
399fight
400
401'help traps for help with finding
402and disarming traps
403 396
404=head2 killpets 397=head2 killpets
405 398
406 killpets [name] 399 killpets [name]
407 400
415If a name is specified then only pets with that 408If a name is specified then only pets with that
416name will be killed, eg killpets bat will kill bats 409name will be killed, eg killpets bat will kill bats
417but not bees. If a number is specified, the pet 410but not bees. If a number is specified, the pet
418corresponding to that number is killed. 411corresponding to that number is killed.
419 412
420=head2 listen
421
422 listen <listen-level>
423
424Listen sets the level of messages you will hear.
425Priorities are defined as follows:
426
427 0 - Nothing, not even "You punch kobold." or "You say: hi".
428 1 - Only messages that have to do with yourself.
429 2 - Emergency calls from other users
430 10 - General chatter with the 'chat' command.
431 11 - See what players kill what monster with what attack/spell. Very
432 verbose - only for the fanatics.
433
434=head2 logs
435
436TODO
437
438=head2 mapinfo 413=head2 mapinfo
439 414
440Shows some information about the map like this: 415Shows some information about the map like this:
441 416
442 world_105_115 (/world/world_105_115) in scorn 417 world_105_115 (/world/world_105_115) in scorn
451The 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
452the 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.
453 428
454=head2 maps 429=head2 maps
455 430
456[crossfire+]
457
458 maps <mapname> 431 maps <mapname>
459 432
460Shows 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
461known 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:
462 435
478emergency save), at most 20 seconds of gameplay are lost. 451emergency save), at most 20 seconds of gameplay are lost.
479 452
480=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).
481 454
482Most 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
483reset 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>).
484 459
485=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.
486 461
487=back 462=back
488 463
507 482
508=head2 motd 483=head2 motd
509 484
510Shows the message of the day. It takes no arguments. 485Shows the message of the day. It takes no arguments.
511 486
512=head2 melee
513
514ERROR: not a command, but another help topic => move to a different file maybe?
515
516You fight to kill monsters. You can either use magic or weapons.
517
518To use weapons, simply wield a weapon (and armour!) and move into the
519monster you want to attack.
520
521To use magic or bows, read
522'help spells
523and
524'help range
525and
526'help cast
527and
528'help invoke
529
530=head2 mode
531
532ERROR: not a command, but another help topic => move to a different file maybe?
533
534The mode commands are as follows:
535
536Applymode, adjusts how items are applied
537Bowmode, adjusts the way bows work
538Peaceful, sets how you react to other players
539Petmode, adjusts how your pets behave
540
541=head2 mouse
542
543ERROR: not a command, but another help topic => move to a different file maybe?
544
545The mouse isn't a great way to move your character. It'll work, but you'll
546be handicapped unless you use the keyboard for this. However, the mouse
547has the following inventory uses:
548
549Middle button on item: apply
550or equip
551
552Right button: drop or pickup
553item on ground
554
555Left button: info on item
556
557=head2 move
558
559ERROR: not a command, but another help topic => move to a different file maybe?
560ERROR: same as "keys"?
561
562These are the basic movement
563keys:
564 yku
565 h l
566 bjn
567
568Running is done by holding
569control and move. Running
570is recommended.
571
572Firing the range weapon (help range)
573is done by holding shift and
574move.
575
576'help mouse for help on what the
577mouse buttons do.
578
579'help melee for advice on how to
580fight
581
582'help traps for help with finding
583and disarming traps
584
585=head2 output-count 487=head2 output-count
586 488
587output-sync controls how often information is sent to the screen. Each 489 output-count [lines]
588buffer has its own time value, and will be flushed independantly. The
589default value is 16 ticks (about 2 seconds).
590 490
591output-count sets after how many messages of the same type, they are 491output-count sets after how many messages of the same type, they are
592then printed out. If the value was 10, then after killing ten orcs, the 492then printed out. If the value was 10, then after killing ten orcs, the
593message '10 times you kill orc' would be printed out. The default value is 493message '10 times you kill orc' would be printed out. The default value is
5941 - this means that all messages get printed out as they are requested - 4941 - this means that all messages get printed out as they are requested -
595buffering is disabled in this regard. 495buffering is disabled in this regard.
596 496
597See also L<output-sync>.
598
599=head2 output-sync
600
601output-sync controls how often information is sent to the screen. Each 497output-sync controls how often information is sent to the screen. Each
602buffer has its own time value, and will be flushed independantly. The 498buffer has its own time value, and will be flushed independantly. The
603default value is 16 ticks (about 2 seconds). 499default value is usually less than a second.
500
501See also L<output-sync>.
502
503=head2 output-rate
504
505 output-rate [bytes per second]
506
507Show the current setting of the output-rate, or set it to the provided
508value. The server will try very hard not to send more than this many bytes
509per second to your client. If the rate is exceeded, the server tries to
510hold back less important information (such as new images) to increase
511responsiveness.
512
513The server-side default is usually quite high, around 100000. If the
514server is running on a Linux kernel, it will adjust to the actual
515bandwidth available, and output-rate only sets an upper bound. That is,
516the server will automatically set an optimal send rate and adjusting your
517output-rate is not required.
518
519=head2 output-sync
520
521 output-sync [seconds]
522
523output-sync controls how often information is sent to the screen. Each
524buffer has its own time value, and will be flushed independantly. The
525default value is usually less than a second.
604 526
605output-count sets after how many messages of the same type, they are 527output-count sets after how many messages of the same type, they are
606then printed out. If the value was 10, then after killing ten orcs, the 528then printed out. If the value was 10, then after killing ten orcs, the
607message '10 times you kill orc' would be printed out. The default value is 529message '10 times you kill orc' would be printed out. The default value is
6081 - this means that all messages get printed out as they are requested - 5301 - this means that all messages get printed out as they are requested -
636party leave 558party leave
637 takes you out of current party 559 takes you out of current party
638 560
639=head2 peaceful 561=head2 peaceful
640 562
641TODO: rework for cf.schmorp.de, intended future behaviour is to toggle 563TODO: rework for deliantra, intended future behaviour is to toggle
642peaceful 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
643players (which will be controlled by priests). 565players (which will be controlled by priests).
644 566
645The B<peaceful> command will switch you between peaceful and hostile attack 567The B<peaceful> command will switch you between peaceful and hostile attack
646modes. 568modes.
717Goldcoins have a value density of 66, 639Goldcoins have a value density of 66,
718 640
719Density 10 will pickup silver, gold, rings, wands, books, and scrolls. 641Density 10 will pickup silver, gold, rings, wands, books, and scrolls.
720Artifacts are also picked up. 642Artifacts are also picked up.
721 643
644
722=head2 prepare 645=head2 prepare
723 646
724The same as cast. Usage: 647The same as cast. Usage:
725 648
726 prepare <spell> 649 prepare <spell>
727 650
728=head2 X<quests>quests (|finished|.*)
729
730The quests command lists the quests you are doing or have completed.
731
732Parameters are:
733
734=over 4
735
736=item no arguments: displays current quests.
737
738=item B<finished>: displays finished quests;
739
740=item anything else: displays details for quests (finished or not) with name containing the given string.
741
742=back
743 651
744=head2 quit 652=head2 quit
745 653
746Deletes 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
747without 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
748bed (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
749top 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.
750 658
659
751=head2 range 660=head2 range
752 661
753Your 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
754bow-and-arrow, a rod, or a wand, to name a few. 663bow-and-arrow, a rod, or a wand, to name a few.
755 664
756Your 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
757fired in that direction. 666fired in that direction.
667
758 668
759=head2 ready_skill 669=head2 ready_skill
760 670
761 ready_skill <name of skill> 671 ready_skill <name of skill>
762 672
765readied, some need to be actively used by "firing" them. 675readied, some need to be actively used by "firing" them.
766 676
767If 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
768untouched, use L<use_skill> instead. 678untouched, use L<use_skill> instead.
769 679
680
770=head2 rename 681=head2 rename
771 682
772Changes/removes the custom name of given item (or the marked one). 683Changes/removes the custom name of given item (or the marked one).
773 684
774 rename oldname to newname 685 rename oldname to newname
781If 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
782will be restored. 693will be restored.
783 694
784Note: maximum allowed name length is 127 characters. 695Note: maximum allowed name length is 127 characters.
785 696
786=head2 reply
787
788 reply <message>
789
790Similar to tell, but instead of having to supply a username, it replies
791to the last player that sent you a tell. This is a bit racy (e.g. when
792somebody else tells you something while you type and you do not realise
793that), so be careful not to supply confidential information in the
794message.
795 697
796=head2 resistances 698=head2 resistances
797 699
798This shows you the resistances you have to specific attack types. 700This shows you the resistances you have to specific attack types.
799If 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
851 753
852=head2 shout 754=head2 shout
853 755
854 shout <message> 756 shout <message>
855 757
856Sends a message to all players on the server that have 758Sends a message to all players on the server. It is mainly useful for
857L<listen|command/listen> level B<10> or higher. It is mainly useful for
858emergency messages ("I am trapped on xxx, can somebody help me?") and 759emergency messages ("I am trapped on xxx, can somebody help me?") and
859should 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.
860 761
861=head2 showpets 762=head2 showpets
862 763
902Toggles between sound enabled and disabled. This has no relevance to the 803Toggles between sound enabled and disabled. This has no relevance to the
903sound 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
904sound 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
905sound (i.e. always for cfplus). 806sound (i.e. always for cfplus).
906 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
907=head2 statistics 821=head2 statistics
908 822
909B<statistics> shows various useful information about your character. 823B<statistics> shows various useful information about your character.
910None 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
911documentation. 825documentation.
960thrown 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
961for this to work. 875for this to work.
962 876
963=head2 time 877=head2 time
964 878
965Shows 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:
966 880
967 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
968 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
969 Time of Year: The Season of New Year 883 Time of Year: The Season of New Year
970 884
980 title <new title> 894 title <new title>
981 title clear # Sets your title back to your race. 895 title clear # Sets your title back to your race.
982 896
983Dragons cannot set their title because it changes during the game. 897Dragons cannot set their title because it changes during the game.
984 898
985=head2 traps
986
987ERROR: not a command, but another help topic => move to a different file maybe?
988
989I recommend the following
990keybindings
991'bind search
992s
993'bind disarm
994d
995Then you can use the 's' and
996'd' keys for searching for and
997disarming traps.
998
999Traps appear at random in doors and in chests. Search those before you
1000open them up. Search by going near where you suspect a trap, and type 's'
1001
1002=head2 unignore 899=head2 unignore
1003 900
1004 unignore <login> 901 unignore <login>
1005 902
1006Cancels all ignores set for the specified login. See B<ignore>. 903Cancels all ignores set for the specified login. See B<ignore>.
1067 964
1068The wimpy level is the amount of health points (hp) that may be left before you 965The wimpy level is the amount of health points (hp) that may be left before you
1069automatically run away. This may be useful in hand-to-hand combats but should 966automatically run away. This may be useful in hand-to-hand combats but should
1070not be used when the opponent attacks with spells. 967not be used when the opponent attacks with spells.
1071 968
969
1072=head1 Authors 970=head1 Authors
1073 971
1074Parts of this document were originally taken from the crossfire server 972Parts of this document were originally taken from the crossfire server
1075help files with unknwon authors. 973help files with unknown authors.
1076 974
1077Adapted for use by I<cfplus>, enhanced and corrected by Pippijn van 975Adapted for use by I<deliantra>, enhanced and corrected by Pippijn van
1078Steenhoven and Marc A. Lehmann. 976Steenhoven and Marc A. Lehmann.
1079 977

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines