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.4 by root, Thu Dec 21 03:34:51 2006 UTC vs.
Revision 1.15 by root, Fri Dec 28 12:44:45 2007 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.
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
451The 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
452the 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.
453 446
454=head2 maps 447=head2 maps
455 448
456Shows a list of maps that are currently being visited or have been visited. 449 maps <mapname>
457The different fields are Path, Pl, PlM, IM, TO, Dif and Reset. They mean:
458 450
459Path: The last part of the map path 451Shows a list of maps matching the regex <mapname> that are currently being
460Pl: Players on the map. 452known to the server. The different fields are Pl, I, Svd, Reset and Path:
461PlM: Players on the map recounted (should be the same as Pl). 453
462IM: In memory means whether the map is: 1) in memory, 2) swapped to disk, 454=over 4
4633) currently loading or 4) currently saving. 455
464TO: Timeout, when the map is swapped to disk. 456=item Pl: the number of players on that map currently.
465Dif: Map difficulty. 457
466Reset: 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
467 482
468=head2 mark 483=head2 mark
469 484
470B<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
471these are flint & steel marked for apply torches, a weapon marked for 486these are flint & steel marked for apply torches, a weapon marked for
485 500
486=head2 motd 501=head2 motd
487 502
488Shows the message of the day. It takes no arguments. 503Shows the message of the day. It takes no arguments.
489 504
490=head2 melee
491
492ERROR: not a command, but another help topic => move to a different file maybe?
493
494You fight to kill monsters. You can either use magic or weapons.
495
496To use weapons, simply wield a weapon (and armour!) and move into the
497monster you want to attack.
498
499To use magic or bows, read
500'help spells
501and
502'help range
503and
504'help cast
505and
506'help invoke
507
508=head2 mode
509
510ERROR: not a command, but another help topic => move to a different file maybe?
511
512The mode commands are as follows:
513
514Applymode, adjusts how items are applied
515Bowmode, adjusts the way bows work
516Peaceful, sets how you react to other players
517Petmode, adjusts how your pets behave
518
519=head2 mouse
520
521ERROR: not a command, but another help topic => move to a different file maybe?
522
523The mouse isn't a great way to move your character. It'll work, but you'll
524be handicapped unless you use the keyboard for this. However, the mouse
525has the following inventory uses:
526
527Middle button on item: apply
528or equip
529
530Right button: drop or pickup
531item on ground
532
533Left button: info on item
534
535=head2 move
536
537ERROR: not a command, but another help topic => move to a different file maybe?
538ERROR: same as "keys"?
539
540These are the basic movement
541keys:
542 yku
543 h l
544 bjn
545
546Running is done by holding
547control and move. Running
548is recommended.
549
550Firing the range weapon (help range)
551is done by holding shift and
552move.
553
554'help mouse for help on what the
555mouse buttons do.
556
557'help melee for advice on how to
558fight
559
560'help traps for help with finding
561and disarming traps
562
563=head2 output-count 505=head2 output-count
564 506
565output-sync controls how often information is sent to the screen. Each 507 output-count [lines]
566buffer has its own time value, and will be flushed independantly. The
567default value is 16 ticks (about 2 seconds).
568 508
569output-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
570then 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
571message '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
5721 - 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 -
573buffering is disabled in this regard. 513buffering is disabled in this regard.
574 514
575See also L<output-sync>.
576
577=head2 output-sync
578
579output-sync controls how often information is sent to the screen. Each 515output-sync controls how often information is sent to the screen. Each
580buffer has its own time value, and will be flushed independantly. The 516buffer has its own time value, and will be flushed independantly. The
581default 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.
582 544
583output-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
584then 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
585message '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
5861 - 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 -
614party leave 576party leave
615 takes you out of current party 577 takes you out of current party
616 578
617=head2 peaceful 579=head2 peaceful
618 580
619TODO: rework for cf.schmorp.de, intended future behaviour is to toggle 581TODO: rework for deliantra, intended future behaviour is to toggle
620peaceful 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
621players (which will be controlled by priests). 583players (which will be controlled by priests).
622 584
623The B<peaceful> command will switch you between peaceful and hostile attack 585The B<peaceful> command will switch you between peaceful and hostile attack
624modes. 586modes.
695Goldcoins have a value density of 66, 657Goldcoins have a value density of 66,
696 658
697Density 10 will pickup silver, gold, rings, wands, books, and scrolls. 659Density 10 will pickup silver, gold, rings, wands, books, and scrolls.
698Artifacts are also picked up. 660Artifacts are also picked up.
699 661
662
700=head2 prepare 663=head2 prepare
701 664
702The same as cast. Usage: 665The same as cast. Usage:
703 666
704 prepare <spell> 667 prepare <spell>
705 668
706=head2 X<quests>quests (|finished|.*)
707
708The quests command lists the quests you are doing or have completed.
709
710Parameters are:
711
712=over 4
713
714=item no arguments: displays current quests.
715
716=item B<finished>: displays finished quests;
717
718=item anything else: displays details for quests (finished or not) with name containing the given string.
719
720=back
721 669
722=head2 quit 670=head2 quit
723 671
724Deletes 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
725without 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
726bed (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
727top 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.
728 676
677
729=head2 range 678=head2 range
730 679
731Your 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
732bow-and-arrow, a rod, or a wand, to name a few. 681bow-and-arrow, a rod, or a wand, to name a few.
733 682
734Your 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
735fired in that direction. 684fired in that direction.
685
736 686
737=head2 ready_skill 687=head2 ready_skill
738 688
739 ready_skill <name of skill> 689 ready_skill <name of skill>
740 690
743readied, some need to be actively used by "firing" them. 693readied, some need to be actively used by "firing" them.
744 694
745If 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
746untouched, use L<use_skill> instead. 696untouched, use L<use_skill> instead.
747 697
698
748=head2 rename 699=head2 rename
749 700
750Changes/removes the custom name of given item (or the marked one). 701Changes/removes the custom name of given item (or the marked one).
751 702
752 rename oldname to newname 703 rename oldname to newname
754 705
755If 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,
756otherwise 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
757marked item will be used instead. 708marked item will be used instead.
758 709
759If 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
760removed from the item. 711will be restored.
761 712
762Note: maximum allowed name length is 127 characters. 713Note: maximum allowed name length is 127 characters.
763 714
764=head2 reply
765
766 reply <message>
767
768Similar to tell, but instead of having to supply a username, it replies
769to the last player that sent you a tell. This is a bit racy (e.g. when
770somebody else tells you something while you type and you do not realise
771that), so be careful not to supply confidential information in the
772message.
773 715
774=head2 resistances 716=head2 resistances
775 717
776This shows you the resistances you have to specific attack types. 718This shows you the resistances you have to specific attack types.
777If 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
880Toggles between sound enabled and disabled. This has no relevance to the 822Toggles between sound enabled and disabled. This has no relevance to the
881sound 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
882sound 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
883sound (i.e. always for cfplus). 825sound (i.e. always for cfplus).
884 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
885=head2 statistics 840=head2 statistics
886 841
887B<statistics> shows various useful information about your character. 842B<statistics> shows various useful information about your character.
888None 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
889documentation. 844documentation.
938thrown 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
939for this to work. 894for this to work.
940 895
941=head2 time 896=head2 time
942 897
943Shows 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:
944 899
945 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
946 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
947 Time of Year: The Season of New Year 902 Time of Year: The Season of New Year
948 903
958 title <new title> 913 title <new title>
959 title clear # Sets your title back to your race. 914 title clear # Sets your title back to your race.
960 915
961Dragons cannot set their title because it changes during the game. 916Dragons cannot set their title because it changes during the game.
962 917
963=head2 traps
964
965ERROR: not a command, but another help topic => move to a different file maybe?
966
967I recommend the following
968keybindings
969'bind search
970s
971'bind disarm
972d
973Then you can use the 's' and
974'd' keys for searching for and
975disarming traps.
976
977Traps appear at random in doors and in chests. Search those before you
978open them up. Search by going near where you suspect a trap, and type 's'
979
980=head2 unignore 918=head2 unignore
981 919
982 unignore <login> 920 unignore <login>
983 921
984Cancels all ignores set for the specified login. See B<ignore>. 922Cancels all ignores set for the specified login. See B<ignore>.
1045 983
1046The 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
1047automatically 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
1048not be used when the opponent attacks with spells. 986not be used when the opponent attacks with spells.
1049 987
988
1050=head1 Authors 989=head1 Authors
1051 990
1052Parts of this document were originally taken from the crossfire server 991Parts of this document were originally taken from the crossfire server
1053help files with unknwon authors. 992help files with unknwon authors.
1054 993
1055Adapted for use by I<cfplus>, enhanced and corrected by Pippijn van 994Adapted for use by I<deliantra>, enhanced and corrected by Pippijn van
1056Steenhoven and Marc A. Lehmann. 995Steenhoven and Marc A. Lehmann.
1057 996

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines