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.9 by root, Mon Dec 11 02:43:21 2006 UTC vs.
Revision 1.23 by root, Mon Jul 30 02:16:16 2007 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 Crossfire TRT 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.
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
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 388
407=head2 killpets 389=head2 killpets
408 390
409 killpets [name] 391 killpets [name]
410 392
454The rest is information the mapper may or may not provide. Often, this is 436The rest is information the mapper may or may not provide. Often, this is
455the mapper's name, email and map creation date as this example shows. 437the mapper's name, email and map creation date as this example shows.
456 438
457=head2 maps 439=head2 maps
458 440
459Shows a list of maps that are currently being visited or have been visited. 441[crossfire+]
460The different fields are Path, Pl, PlM, IM, TO, Dif and Reset. They mean:
461 442
462Path: The last part of the map path 443 maps <mapname>
463Pl: Players on the map. 444
464PlM: Players on the map recounted (should be the same as Pl). 445Shows a list of maps matching the regex <mapname> that are currently being
465IM: In memory means whether the map is: 1) in memory, 2) swapped to disk, 446known to the server. The different fields are Pl, I, Svd, Reset and Path:
4663) currently loading or 4) currently saving. 447
467TO: Timeout, when the map is swapped to disk. 448=over 4
468Dif: Map difficulty. 449
469Reset: Real server time when the map is going to reset. 450=item Pl: the number of players on that map currently.
451
452=item I: B<I>n memory, B<S>wapped out or B<L>oading.
453
454The server keeps maps in memory only for a short time (by default about
45540 seconds). After that time, it saves them to disk. As the server loads
456most maps in the background it is possible that you can see a map that is
457currently being loaded, but thats rare, as loading a map is fast.
458
459=item Svd: the amount of seconds the map was last saved (++ means >99).
460
461The server by default tries to save each map at least every 20 seconds if
462it changed, so in case of a disastrous crash (one where the server cannot
463emergency save), at most 20 seconds of gameplay are lost.
464
465=item Reset: the minimum number of seconds the map will stay as is (will not reset).
466
467Most maps will not reset as long as players are on it, and usually the
468reset counter only starts going down when all players left the map. Some
469maps will never reset in the common sense, these are usually marked with a
470very high number (sucha s C<1e+99>).
471
472=item Path: the name that uniquely identifies the map, can be used for goto etc.
473
474=back
475
470 476
471=head2 mark 477=head2 mark
472 478
473B<mark> is used to mark items for items that apply other items. Examples of 479B<mark> is used to mark items for items that apply other items. Examples of
474these are flint & steel marked for apply torches, a weapon marked for 480these are flint & steel marked for apply torches, a weapon marked for
488 494
489=head2 motd 495=head2 motd
490 496
491Shows the message of the day. It takes no arguments. 497Shows the message of the day. It takes no arguments.
492 498
493=head2 melee
494
495ERROR: not a command, but another help topic => move to a different file maybe?
496
497You fight to kill monsters. You can either use magic or weapons.
498
499To use weapons, simply wield a weapon (and armour!) and move into the
500monster you want to attack.
501
502To use magic or bows, read
503'help spells
504and
505'help range
506and
507'help cast
508and
509'help invoke
510
511=head2 mode
512
513ERROR: not a command, but another help topic => move to a different file maybe?
514
515The mode commands are as follows:
516
517Applymode, adjusts how items are applied
518Bowmode, adjusts the way bows work
519Peaceful, sets how you react to other players
520Petmode, adjusts how your pets behave
521
522=head2 mouse
523
524ERROR: not a command, but another help topic => move to a different file maybe?
525
526The mouse isn't a great way to move your character. It'll work, but you'll
527be handicapped unless you use the keyboard for this. However, the mouse
528has the following inventory uses:
529
530Middle button on item: apply
531or equip
532
533Right button: drop or pickup
534item on ground
535
536Left button: info on item
537
538=head2 move
539
540ERROR: not a command, but another help topic => move to a different file maybe?
541ERROR: same as "keys"?
542
543These are the basic movement
544keys:
545 yku
546 h l
547 bjn
548
549Running is done by holding
550control and move. Running
551is recommended.
552
553Firing the range weapon (help range)
554is done by holding shift and
555move.
556
557'help mouse for help on what the
558mouse buttons do.
559
560'help melee for advice on how to
561fight
562
563'help traps for help with finding
564and disarming traps
565
566=head2 output-count 499=head2 output-count
567 500
568output-sync controls how often information is sent to the screen. Each 501 output-count [lines]
569buffer has its own time value, and will be flushed independantly. The
570default value is 16 ticks (about 2 seconds).
571 502
572output-count sets after how many messages of the same type, they are 503output-count sets after how many messages of the same type, they are
573then printed out. If the value was 10, then after killing ten orcs, the 504then printed out. If the value was 10, then after killing ten orcs, the
574message '10 times you kill orc' would be printed out. The default value is 505message '10 times you kill orc' would be printed out. The default value is
5751 - this means that all messages get printed out as they are requested - 5061 - this means that all messages get printed out as they are requested -
576buffering is disabled in this regard. 507buffering is disabled in this regard.
577 508
578See also L<output-sync>.
579
580=head2 output-sync
581
582output-sync controls how often information is sent to the screen. Each 509output-sync controls how often information is sent to the screen. Each
583buffer has its own time value, and will be flushed independantly. The 510buffer has its own time value, and will be flushed independantly. The
584default value is 16 ticks (about 2 seconds). 511default value is usually less than a second.
512
513See also L<output-sync>.
514
515=head2 output-rate
516
517 output-rate [bytes per second]
518
519Show the current setting of the output-rate, or set it to the provided
520value. The server will try very hard not to send more than this many bytes
521per second to your client. If the rate is exceeded, the server tries to
522hold back less important information (such as new images) to increase
523responsiveness.
524
525The server-side default is usually quite high, around 100000. If the
526server is running on a Linux kernel, it will adjust to the actual
527bandwidth available, and output-rate only sets an upper bound. That is,
528the server will automatically set an optimal send rate and adjusting your
529output-rate is not required.
530
531=head2 output-sync
532
533 output-sync [seconds]
534
535output-sync controls how often information is sent to the screen. Each
536buffer has its own time value, and will be flushed independantly. The
537default value is usually less than a second.
585 538
586output-count sets after how many messages of the same type, they are 539output-count sets after how many messages of the same type, they are
587then printed out. If the value was 10, then after killing ten orcs, the 540then printed out. If the value was 10, then after killing ten orcs, the
588message '10 times you kill orc' would be printed out. The default value is 541message '10 times you kill orc' would be printed out. The default value is
5891 - this means that all messages get printed out as they are requested - 5421 - this means that all messages get printed out as they are requested -
698Goldcoins have a value density of 66, 651Goldcoins have a value density of 66,
699 652
700Density 10 will pickup silver, gold, rings, wands, books, and scrolls. 653Density 10 will pickup silver, gold, rings, wands, books, and scrolls.
701Artifacts are also picked up. 654Artifacts are also picked up.
702 655
656
703=head2 prepare 657=head2 prepare
704 658
705The same as cast. Usage: 659The same as cast. Usage:
706 660
707 prepare <spell> 661 prepare <spell>
708 662
709=head2 X<quests>quests (|finished|.*)
710
711The quests command lists the quests you are doing or have completed.
712
713Parameters are:
714
715=over 4
716
717=item no arguments: displays current quests.
718
719=item B<finished>: displays finished quests;
720
721=item anything else: displays details for quests (finished or not) with name containing the given string.
722
723=back
724 663
725=head2 quit 664=head2 quit
726 665
727Deletes your character from the server. If you want to quit the session 666Deletes your character from the server. If you want to quit the session
728without deleting your character, you must use a I<Bed to Reality>. Find a 667without deleting your character, you must use a I<Bed to Reality>. Find a
729bed (probably in a building close to where you entered the game), get on 668bed (probably in a building close to where you entered the game), get on
730top of it, and apply it using B<Tab> ro the B<apply> command. 669top of it, and apply it using B<Tab> ro the B<apply> command.
731 670
671
732=head2 range 672=head2 range
733 673
734Your range weapon can be one of several weapons, a spell you cast, a 674Your range weapon can be one of several weapons, a spell you cast, a
735bow-and-arrow, a rod, or a wand, to name a few. 675bow-and-arrow, a rod, or a wand, to name a few.
736 676
737Your range weapon is fired when you press SHIFT-direction, and will be 677Your range weapon is fired when you press SHIFT-direction, and will be
738fired in that direction. 678fired in that direction.
679
739 680
740=head2 ready_skill 681=head2 ready_skill
741 682
742 ready_skill <name of skill> 683 ready_skill <name of skill>
743 684
746readied, some need to be actively used by "firing" them. 687readied, some need to be actively used by "firing" them.
747 688
748If you just want to invoke a skill once, leaving your range slot 689If you just want to invoke a skill once, leaving your range slot
749untouched, use L<use_skill> instead. 690untouched, use L<use_skill> instead.
750 691
692
751=head2 rename 693=head2 rename
752 694
753Changes/removes the custom name of given item (or the marked one). 695Changes/removes the custom name of given item (or the marked one).
754 696
755 rename oldname to newname 697 rename oldname to newname
757 699
758If either of the names contain spaces, you have to use the C<">-form, 700If either of the names contain spaces, you have to use the C<">-form,
759otherwise you can just write the name as-is. If you omit the old name, the 701otherwise you can just write the name as-is. If you omit the old name, the
760marked item will be used instead. 702marked item will be used instead.
761 703
762If the new name is empty (i.e. C<"">), then the custom name will be 704If the new name is empty (i.e. C<"">), then the original (unrenamed) name
763removed from the item. 705will be restored.
764 706
765Note: maximum allowed name length is 127 characters. 707Note: maximum allowed name length is 127 characters.
766 708
767=head2 reply
768
769 reply <message>
770
771Similar to tell, but instead of having to supply a username, it replies
772to the last player that sent you a tell. This is a bit racy (e.g. when
773somebody else tells you something while you type and you do not realise
774that), so be careful not to supply confidential information in the
775message.
776 709
777=head2 resistances 710=head2 resistances
778 711
779This shows you the resistances you have to specific attack types. 712This shows you the resistances you have to specific attack types.
780If you have for example "cold +20", it means you get 20% damage done 713If you have for example "cold +20", it means you get 20% damage done
883Toggles between sound enabled and disabled. This has no relevance to the 816Toggles between sound enabled and disabled. This has no relevance to the
884sound settings of the client, it only governs wether the server will send 817sound settings of the client, it only governs wether the server will send
885sound effect command to the client and is enabled if the client supports 818sound effect command to the client and is enabled if the client supports
886sound (i.e. always for cfplus). 819sound (i.e. always for cfplus).
887 820
821=head2 sourcecode
822
823This command displays the means to download the sourcecode (server code,
824maps and archetypes) used to implement this version of the game.
825
826Every player has the right to download and modify the source code of the
827server, as required by both the GNU General Public License and the GNU
828Affero General Public license.
829
830If you modify your version of the server, you will have to provide a means
831to download the modified sources (and resources) via this command. If you
832run an unmodified version of the server, the default will do.
833
888=head2 statistics 834=head2 statistics
889 835
890B<statistics> shows various useful information about your character. 836B<statistics> shows various useful information about your character.
891None of the information it shows is stuff that is not contained in the 837None of the information it shows is stuff that is not contained in the
892documentation. 838documentation.
961 title <new title> 907 title <new title>
962 title clear # Sets your title back to your race. 908 title clear # Sets your title back to your race.
963 909
964Dragons cannot set their title because it changes during the game. 910Dragons cannot set their title because it changes during the game.
965 911
966=head2 traps
967
968ERROR: not a command, but another help topic => move to a different file maybe?
969
970I recommend the following
971keybindings
972'bind search
973s
974'bind disarm
975d
976Then you can use the 's' and
977'd' keys for searching for and
978disarming traps.
979
980Traps appear at random in doors and in chests. Search those before you
981open them up. Search by going near where you suspect a trap, and type 's'
982
983=head2 unignore 912=head2 unignore
984 913
985 unignore <login> 914 unignore <login>
986 915
987Cancels all ignores set for the specified login. See B<ignore>. 916Cancels all ignores set for the specified login. See B<ignore>.
1048 977
1049The wimpy level is the amount of health points (hp) that may be left before you 978The wimpy level is the amount of health points (hp) that may be left before you
1050automatically run away. This may be useful in hand-to-hand combats but should 979automatically run away. This may be useful in hand-to-hand combats but should
1051not be used when the opponent attacks with spells. 980not be used when the opponent attacks with spells.
1052 981
982
1053=head1 Authors 983=head1 Authors
1054 984
1055Parts of this document were originally taken from the crossfire server 985Parts of this document were originally taken from the crossfire server
1056help files with unknwon authors. 986help files with unknwon authors.
1057 987

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines