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.2 by root, Sat Sep 9 22:54:31 2006 UTC vs.
Revision 1.13 by root, Mon Jul 30 02:16:32 2007 UTC

1=begin comment
2***
3*** WARNING: THIS IS A GENERATED FILE - CHANGES WILL BE LOST
4*** The source for this file is in CFPlus/pod/command_help.pod
5*** Make any changes there and then run ./copy_doc
6***
7=end comment
8
1=head1 Crossfire+ Command ListingX<command> 9=head1 Crossfire TRT Command ListingX<command>
2 10
3=head2 accept-invitation 11=head2 accept-invitation
4 12
5Accepts an invitation previously issued by another player using the invite 13Accepts an invitation previously issued by another player using the invite
6command. This will transfer you to the location you were invited to. 14command. This will transfer you to the location you were invited to.
175will be dropped. A collection of 5 scrolls will not be dropped. 183will be dropped. A collection of 5 scrolls will not be dropped.
176 184
177See also B<dropall> and mouse button control within client for dropping 185See also B<dropall> and mouse button control within client for dropping
178objects. 186objects.
179 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
180=head2 dropall 204=head2 dropall
181 205
182 dropall [type] 206 dropall [type]
183 207
184B<dropall> drops all items in your inventory to the ground, excepting 208B<dropall> drops all items in your inventory to the ground, excepting
252=head2 gsay 276=head2 gsay
253 277
254If 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
255only 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.
256 280
257=head2 golem
258
259ERROR: not a command, but another help topic => move to a different file maybe?
260
261Golems are creatures that the player has some control over. Note that many
262summoned creatures are considered golems, even if they are not called
263golems.
264
265If you have a golem in control your spell type will be listed as golem,
266with the creature name in parantheses.
267
268To control your golem, just press the fire key in the direction you want
269your golem to move. Your golem will then start moving in that direction,
270and keep moving in that direction until you change its direction.
271
272Note that once you leave the map that the golem is on, the golem will
273disappear. Also, once you select another spell to cast, or change your
274range type, your golem will disappear.
275
276=head2 help 281=head2 help
277 282
278Gives 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
279 311
280=head2 hiscore 312=head2 hiscore
281 313
282Shows a list of the highest level players in the game. 314Shows a list of the highest level players in the game.
283 315
342One 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
343not be saved out of jail using invite. 375not be saved out of jail using invite.
344 376
345=head2 invoke 377=head2 invoke
346 378
347The invoke command is used 379The invoke command is used to cast a spell immediately, or when it is
348to cast a spell immediately, 380necessary to give a parameter to the spell. Invoke will not set the range
349or when it is necessary to give 381weapon.
350a parameter to the spell. Invoke
351will not set the range weapon.
352 382
353Examples: 383Examples:
384
354'invoke restoration 385 invoke restoration
355'invoke magic rune of large fireball 386 invoke magic rune of large fireball
356'invoke reincarnation of Iamdead 387 invoke reincarnation of Iamdead
357'invoke create food of waybread 388 invoke create food of waybread
358 389
359It is very helpful to bind healing 390It is very helpful to bind healing spells to keys, for example go to your
360spells 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'.
361 395
362'bind invoke medium healing
363c
364
365the c key now casts medium healing
366instantly
367
368=head2 keys
369
370ERROR: not a command, but another help topic => move to a different file maybe?
371ERROR: its wrong anyways
372
373These are the basic movement
374keys:
375 yku
376 h l
377 bjn
378
379Running is done by holding
380control and move. Running
381is recommended.
382
383Firing the range weapon (help range)
384is done by holding shift and
385move.
386
387'help mouse for help on what the
388mouse buttons do.
389
390'help melee for advice on how to
391fight
392
393'help traps for help with finding
394and disarming traps
395 396
396=head2 killpets 397=head2 killpets
398
399 killpets [name]
397 400
398The killpets command is a quick and convenient way 401The killpets command is a quick and convenient way
399to get rid of all your pets when they are no longer 402to get rid of all your pets when they are no longer
400useful or are getting in the way. Any equipment 403useful or are getting in the way. Any equipment
401they had will be left behind, but you will get no 404they had will be left behind, but you will get no
407but not bees. If a number is specified, the pet 410but not bees. If a number is specified, the pet
408corresponding to that number is killed. 411corresponding to that number is killed.
409 412
410=head2 listen 413=head2 listen
411 414
415 listen <listen-level>
416
412Listen, sets the level of messages you will hear. 417Listen sets the level of messages you will hear.
413Priorities are defined as follows: 418Priorities are defined as follows:
414 419
415 0 - Nothing, not even "You punch kobold." or "You say: hi". 420 0 - Nothing, not even "You punch kobold." or "You say: hi".
416 1 - Only messages that have to do with yourself. 421 1 - Only messages that have to do with yourself.
417 2 - Emergency calls from other users 422 2 - Emergency calls from other users
439The 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
440the 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.
441 446
442=head2 maps 447=head2 maps
443 448
444Shows a list of maps that are currently being visited or have been visited. 449[crossfire+]
445The different fields are Path, Pl, PlM, IM, TO, Dif and Reset. They mean:
446 450
447Path: The last part of the map path 451 maps <mapname>
448Pl: Players on the map. 452
449PlM: Players on the map recounted (should be the same as Pl). 453Shows a list of maps matching the regex <mapname> that are currently being
450IM: In memory means whether the map is: 1) in memory, 2) swapped to disk, 454known to the server. The different fields are Pl, I, Svd, Reset and Path:
4513) currently loading or 4) currently saving. 455
452TO: Timeout, when the map is swapped to disk. 456=over 4
453Dif: Map difficulty. 457
454Reset: Real server time when the map is going to reset. 458=item Pl: the number of players on that map currently.
459
460=item I: B<I>n memory, B<S>wapped out or B<L>oading.
461
462The server keeps maps in memory only for a short time (by default about
46340 seconds). After that time, it saves them to disk. As the server loads
464most maps in the background it is possible that you can see a map that is
465currently being loaded, but thats rare, as loading a map is fast.
466
467=item Svd: the amount of seconds the map was last saved (++ means >99).
468
469The server by default tries to save each map at least every 20 seconds if
470it changed, so in case of a disastrous crash (one where the server cannot
471emergency save), at most 20 seconds of gameplay are lost.
472
473=item Reset: the minimum number of seconds the map will stay as is (will not reset).
474
475Most maps will not reset as long as players are on it, and usually the
476reset counter only starts going down when all players left the map. Some
477maps will never reset in the common sense, these are usually marked with a
478very high number (sucha s C<1e+99>).
479
480=item Path: the name that uniquely identifies the map, can be used for goto etc.
481
482=back
483
455 484
456=head2 mark 485=head2 mark
457 486
458B<mark> is used to mark items for items that apply other items. Examples of 487B<mark> is used to mark items for items that apply other items. Examples of
459these are flint & steel marked for apply torches, a weapon marked for 488these are flint & steel marked for apply torches, a weapon marked for
473 502
474=head2 motd 503=head2 motd
475 504
476Shows the message of the day. It takes no arguments. 505Shows the message of the day. It takes no arguments.
477 506
478=head2 melee
479
480ERROR: not a command, but another help topic => move to a different file maybe?
481
482You fight to kill monsters. You can either use magic or weapons.
483
484To use weapons, simply wield a weapon (and armour!) and move into the
485monster you want to attack.
486
487To use magic or bows, read
488'help spells
489and
490'help range
491and
492'help cast
493and
494'help invoke
495
496=head2 mode
497
498ERROR: not a command, but another help topic => move to a different file maybe?
499
500The mode commands are as follows:
501
502Applymode, adjusts how items are applied
503Bowmode, adjusts the way bows work
504Peaceful, sets how you react to other players
505Petmode, adjusts how your pets behave
506
507=head2 mouse
508
509ERROR: not a command, but another help topic => move to a different file maybe?
510
511The mouse isn't a great way to move your character. It'll work, but you'll
512be handicapped unless you use the keyboard for this. However, the mouse
513has the following inventory uses:
514
515Middle button on item: apply
516or equip
517
518Right button: drop or pickup
519item on ground
520
521Left button: info on item
522
523=head2 move
524
525ERROR: not a command, but another help topic => move to a different file maybe?
526ERROR: same as "keys"?
527
528These are the basic movement
529keys:
530 yku
531 h l
532 bjn
533
534Running is done by holding
535control and move. Running
536is recommended.
537
538Firing the range weapon (help range)
539is done by holding shift and
540move.
541
542'help mouse for help on what the
543mouse buttons do.
544
545'help melee for advice on how to
546fight
547
548'help traps for help with finding
549and disarming traps
550
551=head2 output-count 507=head2 output-count
552 508
553output-sync controls how often information is sent to the screen. Each 509 output-count [lines]
554buffer has its own time value, and will be flushed independantly. The
555default value is 16 ticks (about 2 seconds).
556 510
557output-count sets after how many messages of the same type, they are 511output-count sets after how many messages of the same type, they are
558then printed out. If the value was 10, then after killing ten orcs, the 512then printed out. If the value was 10, then after killing ten orcs, the
559message '10 times you kill orc' would be printed out. The default value is 513message '10 times you kill orc' would be printed out. The default value is
5601 - this means that all messages get printed out as they are requested - 5141 - this means that all messages get printed out as they are requested -
561buffering is disabled in this regard. 515buffering is disabled in this regard.
562 516
563See also L<output-sync>.
564
565=head2 output-sync
566
567output-sync controls how often information is sent to the screen. Each 517output-sync controls how often information is sent to the screen. Each
568buffer has its own time value, and will be flushed independantly. The 518buffer has its own time value, and will be flushed independantly. The
569default value is 16 ticks (about 2 seconds). 519default value is usually less than a second.
520
521See also L<output-sync>.
522
523=head2 output-rate
524
525 output-rate [bytes per second]
526
527Show the current setting of the output-rate, or set it to the provided
528value. The server will try very hard not to send more than this many bytes
529per second to your client. If the rate is exceeded, the server tries to
530hold back less important information (such as new images) to increase
531responsiveness.
532
533The server-side default is usually quite high, around 100000. If the
534server is running on a Linux kernel, it will adjust to the actual
535bandwidth available, and output-rate only sets an upper bound. That is,
536the server will automatically set an optimal send rate and adjusting your
537output-rate is not required.
538
539=head2 output-sync
540
541 output-sync [seconds]
542
543output-sync controls how often information is sent to the screen. Each
544buffer has its own time value, and will be flushed independantly. The
545default value is usually less than a second.
570 546
571output-count sets after how many messages of the same type, they are 547output-count sets after how many messages of the same type, they are
572then printed out. If the value was 10, then after killing ten orcs, the 548then printed out. If the value was 10, then after killing ten orcs, the
573message '10 times you kill orc' would be printed out. The default value is 549message '10 times you kill orc' would be printed out. The default value is
5741 - this means that all messages get printed out as they are requested - 5501 - this means that all messages get printed out as they are requested -
683Goldcoins have a value density of 66, 659Goldcoins have a value density of 66,
684 660
685Density 10 will pickup silver, gold, rings, wands, books, and scrolls. 661Density 10 will pickup silver, gold, rings, wands, books, and scrolls.
686Artifacts are also picked up. 662Artifacts are also picked up.
687 663
664
688=head2 prepare 665=head2 prepare
689 666
690The same as cast. Usage: 667The same as cast. Usage:
691 668
692 prepare <spell> 669 prepare <spell>
693 670
694=head2 X<quests>quests (|finished|.*)
695
696The quests command lists the quests you are doing or have completed.
697
698Parameters are:
699
700=over 4
701
702=item no arguments: displays current quests.
703
704=item B<finished>: displays finished quests;
705
706=item anything else: displays details for quests (finished or not) with name containing the given string.
707
708=back
709 671
710=head2 quit 672=head2 quit
711 673
712Deletes your character from the server. If you want to quit the session 674Deletes your character from the server. If you want to quit the session
713without deleting your character, you must use a I<Bed to Reality>. Find a 675without deleting your character, you must use a I<Bed to Reality>. Find a
714bed (probably in a building close to where you entered the game), get on 676bed (probably in a building close to where you entered the game), get on
715top of it, and apply it using B<Tab> ro the B<apply> command. 677top of it, and apply it using B<Tab> ro the B<apply> command.
716 678
679
717=head2 range 680=head2 range
718 681
719Your range weapon can be one of several weapons, a spell you cast, a 682Your range weapon can be one of several weapons, a spell you cast, a
720bow-and-arrow, a rod, or a wand, to name a few. 683bow-and-arrow, a rod, or a wand, to name a few.
721 684
722Your range weapon is fired when you press SHIFT-direction, and will be 685Your range weapon is fired when you press SHIFT-direction, and will be
723fired in that direction. 686fired in that direction.
687
724 688
725=head2 ready_skill 689=head2 ready_skill
726 690
727 ready_skill <name of skill> 691 ready_skill <name of skill>
728 692
731readied, some need to be actively used by "firing" them. 695readied, some need to be actively used by "firing" them.
732 696
733If you just want to invoke a skill once, leaving your range slot 697If you just want to invoke a skill once, leaving your range slot
734untouched, use L<use_skill> instead. 698untouched, use L<use_skill> instead.
735 699
700
736=head2 rename 701=head2 rename
737 702
738Changes the custom name of an item. 703Changes/removes the custom name of given item (or the marked one).
739 704
740 rename <item name> to <new name> 705 rename oldname to newname
706 rename "old item name" to "new item name"
741 707
742(Note: the angle brackets (<>) are mandatory and part of the syntax) 708If either of the names contain spaces, you have to use the C<">-form,
709otherwise you can just write the name as-is. If you omit the old name, the
710marked item will be used instead.
743 711
744If '<item name>' is omitted, defaults to marked item. 712If the new name is empty (i.e. C<"">), then the original (unrenamed) name
745 713will be restored.
746If 'to <new name>' is omitted, clears the custom name.
747 714
748Note: maximum allowed name length is 127 characters. 715Note: maximum allowed name length is 127 characters.
749 716
750=head2 reply
751
752 reply <message>
753
754Similar to tell, but instead of having to supply a username, it replies
755to the last player that sent you a tell. This is a bit racy (e.g. when
756somebody else tells you something while you type and you do not realise
757that), so be careful not to supply confidential information in the
758message.
759 717
760=head2 resistances 718=head2 resistances
761 719
762This shows you the resistances you have to specific attack types. 720This shows you the resistances you have to specific attack types.
763If you have for example "cold +20", it means you get 20% damage done 721If you have for example "cold +20", it means you get 20% damage done
866Toggles between sound enabled and disabled. This has no relevance to the 824Toggles between sound enabled and disabled. This has no relevance to the
867sound settings of the client, it only governs wether the server will send 825sound settings of the client, it only governs wether the server will send
868sound effect command to the client and is enabled if the client supports 826sound effect command to the client and is enabled if the client supports
869sound (i.e. always for cfplus). 827sound (i.e. always for cfplus).
870 828
829=head2 sourcecode
830
831This command displays the means to download the sourcecode (server code,
832maps and archetypes) used to implement this version of the game.
833
834Every player has the right to download and modify the source code of the
835server, as required by both the GNU General Public License and the GNU
836Affero General Public license.
837
838If you modify your version of the server, you will have to provide a means
839to download the modified sources (and resources) via this command. If you
840run an unmodified version of the server, the default will do.
841
871=head2 statistics 842=head2 statistics
872 843
873B<statistics> shows various useful information about your character. 844B<statistics> shows various useful information about your character.
874None of the information it shows is stuff that is not contained in the 845None of the information it shows is stuff that is not contained in the
875documentation. 846documentation.
944 title <new title> 915 title <new title>
945 title clear # Sets your title back to your race. 916 title clear # Sets your title back to your race.
946 917
947Dragons cannot set their title because it changes during the game. 918Dragons cannot set their title because it changes during the game.
948 919
949=head2 traps
950
951ERROR: not a command, but another help topic => move to a different file maybe?
952
953I recommend the following
954keybindings
955'bind search
956s
957'bind disarm
958d
959Then you can use the 's' and
960'd' keys for searching for and
961disarming traps.
962
963Traps appear at random in doors and in chests. Search those before you
964open them up. Search by going near where you suspect a trap, and type 's'
965
966=head2 unignore 920=head2 unignore
967 921
968 unignore <login> 922 unignore <login>
969 923
970Cancels all ignores set for the specified login. See B<ignore>. 924Cancels all ignores set for the specified login. See B<ignore>.
925
926=head2 uptime
927
928Tells you something about the time the server was started and how long ago
929that was.
971 930
972=head2 use_skill 931=head2 use_skill
973 932
974 use_skill <name of skill> 933 use_skill <name of skill>
975 934
1026 985
1027The wimpy level is the amount of health points (hp) that may be left before you 986The wimpy level is the amount of health points (hp) that may be left before you
1028automatically run away. This may be useful in hand-to-hand combats but should 987automatically run away. This may be useful in hand-to-hand combats but should
1029not be used when the opponent attacks with spells. 988not be used when the opponent attacks with spells.
1030 989
990
1031=head1 Authors 991=head1 Authors
1032 992
1033Parts of this document were originally taken from the crossfire server 993Parts of this document were originally taken from the crossfire server
1034help files with unknwon authors. 994help files with unknwon authors.
1035 995

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines