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.11 by root, Tue Jul 3 01:05:07 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.
252=head2 gsay 260=head2 gsay
253 261
254If you are in a party (party join or party form), you will be able to message 262If 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. 263only your party. Even people standing right next to you can't hear it.
256 264
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 265=head2 help
277 266
278Gives you online help for the command or help topic specified. 267Gives you online help for the command or help topic specified.
268
269=head2 hintmode (show|mark|hide)
270
271 hintmode show|mark|hide
272
273Sets the I<hint mode> to the given value: Throughout the game you can find
274hints that sometimes help you to solve a puzzle or manage a situation
275better than without. You can change the display of these hints with this
276command:
277
278=over 4
279
280=item show
281
282Show the hints (the default mode).
283
284=item mark
285
286Do not show the hints themselves, but notify you when a hint would have
287been available.
288
289=item hide
290
291Hide all hints: You will not be able to tell wether there is a hint
292available or not.
293
294=back
279 295
280=head2 hiscore 296=head2 hiscore
281 297
282Shows a list of the highest level players in the game. 298Shows a list of the highest level players in the game.
283 299
342One can never transport from nor to an unholy place. That means, one can 358One can never transport from nor to an unholy place. That means, one can
343not be saved out of jail using invite. 359not be saved out of jail using invite.
344 360
345=head2 invoke 361=head2 invoke
346 362
347The invoke command is used 363The invoke command is used to cast a spell immediately, or when it is
348to cast a spell immediately, 364necessary to give a parameter to the spell. Invoke will not set the range
349or when it is necessary to give 365weapon.
350a parameter to the spell. Invoke
351will not set the range weapon.
352 366
353Examples: 367Examples:
368
354'invoke restoration 369 invoke restoration
355'invoke magic rune of large fireball 370 invoke magic rune of large fireball
356'invoke reincarnation of Iamdead 371 invoke reincarnation of Iamdead
357'invoke create food of waybread 372 invoke create food of waybread
358 373
359It is very helpful to bind healing 374It is very helpful to bind healing spells to keys, for example go to your
360spells to keys like this: 375I<playerbook>, tab I<spells>, the press the right mosue button on the
376spell I<medium healing> and choose C<bind invoke ... to a key>. It is
377recommended to bind a healing spell or potion to an easily-accessible-key,
378such as '1'.
361 379
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 380
396=head2 killpets 381=head2 killpets
382
383 killpets [name]
397 384
398The killpets command is a quick and convenient way 385The killpets command is a quick and convenient way
399to get rid of all your pets when they are no longer 386to get rid of all your pets when they are no longer
400useful or are getting in the way. Any equipment 387useful or are getting in the way. Any equipment
401they had will be left behind, but you will get no 388they had will be left behind, but you will get no
407but not bees. If a number is specified, the pet 394but not bees. If a number is specified, the pet
408corresponding to that number is killed. 395corresponding to that number is killed.
409 396
410=head2 listen 397=head2 listen
411 398
399 listen <listen-level>
400
412Listen, sets the level of messages you will hear. 401Listen sets the level of messages you will hear.
413Priorities are defined as follows: 402Priorities are defined as follows:
414 403
415 0 - Nothing, not even "You punch kobold." or "You say: hi". 404 0 - Nothing, not even "You punch kobold." or "You say: hi".
416 1 - Only messages that have to do with yourself. 405 1 - Only messages that have to do with yourself.
417 2 - Emergency calls from other users 406 2 - Emergency calls from other users
439The rest is information the mapper may or may not provide. Often, this is 428The 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. 429the mapper's name, email and map creation date as this example shows.
441 430
442=head2 maps 431=head2 maps
443 432
444Shows a list of maps that are currently being visited or have been visited. 433[crossfire+]
445The different fields are Path, Pl, PlM, IM, TO, Dif and Reset. They mean:
446 434
447Path: The last part of the map path 435 maps <mapname>
448Pl: Players on the map. 436
449PlM: Players on the map recounted (should be the same as Pl). 437Shows 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, 438known to the server. The different fields are Pl, I, Svd, Reset and Path:
4513) currently loading or 4) currently saving. 439
452TO: Timeout, when the map is swapped to disk. 440=over 4
453Dif: Map difficulty. 441
454Reset: Real server time when the map is going to reset. 442=item Pl: the number of players on that map currently.
443
444=item I: B<I>n memory, B<S>wapped out or B<L>oading.
445
446The server keeps maps in memory only for a short time (by default about
44740 seconds). After that time, it saves them to disk. As the server loads
448most maps in the background it is possible that you can see a map that is
449currently being loaded, but thats rare, as loading a map is fast.
450
451=item Svd: the amount of seconds the map was last saved (++ means >99).
452
453The server by default tries to save each map at least every 20 seconds if
454it changed, so in case of a disastrous crash (one where the server cannot
455emergency save), at most 20 seconds of gameplay are lost.
456
457=item Reset: the minimum number of seconds the map will stay as is (will not reset).
458
459Most maps will not reset as long as players are on it, and usually the
460reset counter only starts going down when all players left the map.
461
462=item Path: the name that uniquely identifies the map, can be used for goto etc.
463
464=back
465
455 466
456=head2 mark 467=head2 mark
457 468
458B<mark> is used to mark items for items that apply other items. Examples of 469B<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 470these are flint & steel marked for apply torches, a weapon marked for
473 484
474=head2 motd 485=head2 motd
475 486
476Shows the message of the day. It takes no arguments. 487Shows the message of the day. It takes no arguments.
477 488
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 489=head2 output-count
552 490
553output-sync controls how often information is sent to the screen. Each 491 output-count [lines]
554buffer has its own time value, and will be flushed independantly. The
555default value is 16 ticks (about 2 seconds).
556 492
557output-count sets after how many messages of the same type, they are 493output-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 494then 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 495message '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 - 4961 - this means that all messages get printed out as they are requested -
561buffering is disabled in this regard. 497buffering is disabled in this regard.
562 498
563See also L<output-sync>.
564
565=head2 output-sync
566
567output-sync controls how often information is sent to the screen. Each 499output-sync controls how often information is sent to the screen. Each
568buffer has its own time value, and will be flushed independantly. The 500buffer has its own time value, and will be flushed independantly. The
569default value is 16 ticks (about 2 seconds). 501default value is usually less than a second.
502
503See also L<output-sync>.
504
505=head2 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 not to send (much) 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. The server-side default is usually quite high, around
512100000, so if you have a slow link and want to be able to control your
513character even when downloading faces, set this to a lower value, such as
5147000 (for ISDN).
515
516=head2 output-sync
517
518 output-sync [seconds]
519
520output-sync controls how often information is sent to the screen. Each
521buffer has its own time value, and will be flushed independantly. The
522default value is usually less than a second.
570 523
571output-count sets after how many messages of the same type, they are 524output-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 525then 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 526message '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 - 5271 - this means that all messages get printed out as they are requested -
733If you just want to invoke a skill once, leaving your range slot 686If you just want to invoke a skill once, leaving your range slot
734untouched, use L<use_skill> instead. 687untouched, use L<use_skill> instead.
735 688
736=head2 rename 689=head2 rename
737 690
738Changes the custom name of an item. 691Changes/removes the custom name of given item (or the marked one).
739 692
740 rename <item name> to <new name> 693 rename oldname to newname
694 rename "old item name" to "new item name"
741 695
742(Note: the angle brackets (<>) are mandatory and part of the syntax) 696If either of the names contain spaces, you have to use the C<">-form,
697otherwise you can just write the name as-is. If you omit the old name, the
698marked item will be used instead.
743 699
744If '<item name>' is omitted, defaults to marked item. 700If the new name is empty (i.e. C<"">), then the original (unrenamed) name
745 701will be restored.
746If 'to <new name>' is omitted, clears the custom name.
747 702
748Note: maximum allowed name length is 127 characters. 703Note: maximum allowed name length is 127 characters.
749 704
750=head2 reply 705=head2 reply
751 706
866Toggles between sound enabled and disabled. This has no relevance to the 821Toggles between sound enabled and disabled. This has no relevance to the
867sound settings of the client, it only governs wether the server will send 822sound 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 823sound effect command to the client and is enabled if the client supports
869sound (i.e. always for cfplus). 824sound (i.e. always for cfplus).
870 825
826=head2 sourcecode
827
828This command displays the means to download the sourcecode (server code,
829maps and archetypes) used to implement this version of the game.
830
831Every player has the right to download and modify the source code of the
832server, as required by both the GNU General Public License and the GNU
833Affero General Public license.
834
835If you modify your version of the server, you will have to provide a means
836to download the modified sources (and resources) via this command. If you
837run an unmodified version of the server, the default will do.
838
871=head2 statistics 839=head2 statistics
872 840
873B<statistics> shows various useful information about your character. 841B<statistics> shows various useful information about your character.
874None of the information it shows is stuff that is not contained in the 842None of the information it shows is stuff that is not contained in the
875documentation. 843documentation.
944 title <new title> 912 title <new title>
945 title clear # Sets your title back to your race. 913 title clear # Sets your title back to your race.
946 914
947Dragons cannot set their title because it changes during the game. 915Dragons cannot set their title because it changes during the game.
948 916
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 917=head2 unignore
967 918
968 unignore <login> 919 unignore <login>
969 920
970Cancels all ignores set for the specified login. See B<ignore>. 921Cancels all ignores set for the specified login. See B<ignore>.
922
923=head2 uptime
924
925Tells you something about the time the server was started and how long ago
926that was.
971 927
972=head2 use_skill 928=head2 use_skill
973 929
974 use_skill <name of skill> 930 use_skill <name of skill>
975 931
1026 982
1027The wimpy level is the amount of health points (hp) that may be left before you 983The 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 984automatically run away. This may be useful in hand-to-hand combats but should
1029not be used when the opponent attacks with spells. 985not be used when the opponent attacks with spells.
1030 986
987
1031=head1 Authors 988=head1 Authors
1032 989
1033Parts of this document were originally taken from the crossfire server 990Parts of this document were originally taken from the crossfire server
1034help files with unknwon authors. 991help files with unknwon authors.
1035 992

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines