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.8 by root, Wed Apr 18 18:16:34 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+ 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
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.
279 268
280=head2 hiscore 269=head2 hiscore
342One can never transport from nor to an unholy place. That means, one can 331One can never transport from nor to an unholy place. That means, one can
343not be saved out of jail using invite. 332not be saved out of jail using invite.
344 333
345=head2 invoke 334=head2 invoke
346 335
347The invoke command is used 336The invoke command is used to cast a spell immediately, or when it is
348to cast a spell immediately, 337necessary to give a parameter to the spell. Invoke will not set the range
349or when it is necessary to give 338weapon.
350a parameter to the spell. Invoke
351will not set the range weapon.
352 339
353Examples: 340Examples:
341
354'invoke restoration 342 invoke restoration
355'invoke magic rune of large fireball 343 invoke magic rune of large fireball
356'invoke reincarnation of Iamdead 344 invoke reincarnation of Iamdead
357'invoke create food of waybread 345 invoke create food of waybread
358 346
359It is very helpful to bind healing 347It is very helpful to bind healing spells to keys, for example go to your
360spells to keys like this: 348I<playerbook>, tab I<spells>, the press the right mosue button on the
349spell I<medium healing> and choose C<bind invoke ... to a key>. It is
350recommended to bind a healing spell or potion to an easily-accessible-key,
351such as '1'.
361 352
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 353
396=head2 killpets 354=head2 killpets
355
356 killpets [name]
397 357
398The killpets command is a quick and convenient way 358The killpets command is a quick and convenient way
399to get rid of all your pets when they are no longer 359to get rid of all your pets when they are no longer
400useful or are getting in the way. Any equipment 360useful or are getting in the way. Any equipment
401they had will be left behind, but you will get no 361they had will be left behind, but you will get no
407but not bees. If a number is specified, the pet 367but not bees. If a number is specified, the pet
408corresponding to that number is killed. 368corresponding to that number is killed.
409 369
410=head2 listen 370=head2 listen
411 371
372 listen <listen-level>
373
412Listen, sets the level of messages you will hear. 374Listen sets the level of messages you will hear.
413Priorities are defined as follows: 375Priorities are defined as follows:
414 376
415 0 - Nothing, not even "You punch kobold." or "You say: hi". 377 0 - Nothing, not even "You punch kobold." or "You say: hi".
416 1 - Only messages that have to do with yourself. 378 1 - Only messages that have to do with yourself.
417 2 - Emergency calls from other users 379 2 - Emergency calls from other users
439The rest is information the mapper may or may not provide. Often, this is 401The 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. 402the mapper's name, email and map creation date as this example shows.
441 403
442=head2 maps 404=head2 maps
443 405
444Shows a list of maps that are currently being visited or have been visited. 406[crossfire+]
445The different fields are Path, Pl, PlM, IM, TO, Dif and Reset. They mean:
446 407
447Path: The last part of the map path 408 maps <mapname>
448Pl: Players on the map. 409
449PlM: Players on the map recounted (should be the same as Pl). 410Shows 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, 411known to the server. The different fields are Pl, I, Svd, Reset and Path:
4513) currently loading or 4) currently saving. 412
452TO: Timeout, when the map is swapped to disk. 413=over 4
453Dif: Map difficulty. 414
454Reset: Real server time when the map is going to reset. 415=item Pl: the number of players on that map currently.
416
417=item I: B<I>n memory, B<S>wapped out or B<L>oading.
418
419The server keeps maps in memory only for a short time (by default about
42040 seconds). After that time, it saves them to disk. As the server loads
421most maps in the background it is possible that you can see a map that is
422currently being loaded, but thats rare, as loading a map is fast.
423
424=item Svd: the amount of seconds the map was last saved (++ means >99).
425
426The server by default tries to save each map at least every 20 seconds if
427it changed, so in case of a disastrous crash (one where the server cannot
428emergency save), at most 20 seconds of gameplay are lost.
429
430=item Reset: the minimum number of seconds the map will stay as is (will not reset).
431
432Most maps will not reset as long as players are on it, and usually the
433reset counter only starts going down when all players left the map.
434
435=item Path: the name that uniquely identifies the map, can be used for goto etc.
436
437=back
438
455 439
456=head2 mark 440=head2 mark
457 441
458B<mark> is used to mark items for items that apply other items. Examples of 442B<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 443these are flint & steel marked for apply torches, a weapon marked for
473 457
474=head2 motd 458=head2 motd
475 459
476Shows the message of the day. It takes no arguments. 460Shows the message of the day. It takes no arguments.
477 461
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 462=head2 output-count
552 463
553output-sync controls how often information is sent to the screen. Each 464 output-count [lines]
554buffer has its own time value, and will be flushed independantly. The
555default value is 16 ticks (about 2 seconds).
556 465
557output-count sets after how many messages of the same type, they are 466output-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 467then 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 468message '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 - 4691 - this means that all messages get printed out as they are requested -
561buffering is disabled in this regard. 470buffering is disabled in this regard.
562 471
563See also L<output-sync>.
564
565=head2 output-sync
566
567output-sync controls how often information is sent to the screen. Each 472output-sync controls how often information is sent to the screen. Each
568buffer has its own time value, and will be flushed independantly. The 473buffer has its own time value, and will be flushed independantly. The
569default value is 16 ticks (about 2 seconds). 474default value is usually less than a second.
475
476See also L<output-sync>.
477
478=head2 output-rate [bytes per second]
479
480Show the current setting of the output-rate, or set it to the provided
481value. The server will try not to send (much) more than this many bytes
482per second to your client. If the rate is exceeded, the server tries to
483hold back less important information (such as new images), to increase
484responsiveness. The server-side default is usually quite high, around
485100000, so if you have a slow link and want to be able to control your
486character even when downloading faces, set this to a lower value, such as
4877000 (for ISDN).
488
489=head2 output-sync
490
491 output-sync [seconds]
492
493output-sync controls how often information is sent to the screen. Each
494buffer has its own time value, and will be flushed independantly. The
495default value is usually less than a second.
570 496
571output-count sets after how many messages of the same type, they are 497output-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 498then 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 499message '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 - 5001 - 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 659If you just want to invoke a skill once, leaving your range slot
734untouched, use L<use_skill> instead. 660untouched, use L<use_skill> instead.
735 661
736=head2 rename 662=head2 rename
737 663
738Changes the custom name of an item. 664Changes/removes the custom name of given item (or the marked one).
739 665
740 rename <item name> to <new name> 666 rename oldname to newname
667 rename "old item name" to "new item name"
741 668
742(Note: the angle brackets (<>) are mandatory and part of the syntax) 669If either of the names contain spaces, you have to use the C<">-form,
670otherwise you can just write the name as-is. If you omit the old name, the
671marked item will be used instead.
743 672
744If '<item name>' is omitted, defaults to marked item. 673If the new name is empty (i.e. C<"">), then the original (unrenamed) name
745 674will be restored.
746If 'to <new name>' is omitted, clears the custom name.
747 675
748Note: maximum allowed name length is 127 characters. 676Note: maximum allowed name length is 127 characters.
749 677
750=head2 reply 678=head2 reply
751 679
944 title <new title> 872 title <new title>
945 title clear # Sets your title back to your race. 873 title clear # Sets your title back to your race.
946 874
947Dragons cannot set their title because it changes during the game. 875Dragons cannot set their title because it changes during the game.
948 876
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 877=head2 unignore
967 878
968 unignore <login> 879 unignore <login>
969 880
970Cancels all ignores set for the specified login. See B<ignore>. 881Cancels all ignores set for the specified login. See B<ignore>.
882
883=head2 uptime
884
885Tells you something about the time the server was started and how long ago
886that was.
971 887
972=head2 use_skill 888=head2 use_skill
973 889
974 use_skill <name of skill> 890 use_skill <name of skill>
975 891
1026 942
1027The wimpy level is the amount of health points (hp) that may be left before you 943The 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 944automatically run away. This may be useful in hand-to-hand combats but should
1029not be used when the opponent attacks with spells. 945not be used when the opponent attacks with spells.
1030 946
947
1031=head1 Authors 948=head1 Authors
1032 949
1033Parts of this document were originally taken from the crossfire server 950Parts of this document were originally taken from the crossfire server
1034help files with unknwon authors. 951help files with unknwon authors.
1035 952

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines