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.3 by root, Thu Sep 14 19:22:05 2006 UTC vs.
Revision 1.9 by root, Thu Jun 21 22:30:15 2007 UTC

1=begin comment 1=begin comment
2
3*** 2***
4*** WARNING: 3*** WARNING: THIS IS A GENERATED FILE - CHANGES WILL BE LOST
5*** This file resides in both CFPlus/pod/ and server/pod/ 4*** The source for this file is in CFPlus/pod/command_help.pod
6*** Only ever edit the version in CFPlus/pod/ and run 5*** Make any changes there and then run ./copy_doc
7*** ./copy_pod inside server/pod/ to update that copy.
8*** 6***
7=end comment
9 8
10=end
11
12=head1 Crossfire+ Command ListingX<command> 9=head1 Crossfire TRT Command ListingX<command>
13 10
14=head2 accept-invitation 11=head2 accept-invitation
15 12
16Accepts an invitation previously issued by another player using the invite 13Accepts an invitation previously issued by another player using the invite
17command. This will transfer you to the location you were invited to. 14command. This will transfer you to the location you were invited to.
263=head2 gsay 260=head2 gsay
264 261
265If 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
266only 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.
267 264
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 265=head2 help
288 266
289Gives you online help for the command or help topic specified. 267Gives you online help for the command or help topic specified.
290 268
291=head2 hiscore 269=head2 hiscore
353One 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
354not be saved out of jail using invite. 332not be saved out of jail using invite.
355 333
356=head2 invoke 334=head2 invoke
357 335
358The invoke command is used 336The invoke command is used to cast a spell immediately, or when it is
359to cast a spell immediately, 337necessary to give a parameter to the spell. Invoke will not set the range
360or when it is necessary to give 338weapon.
361a parameter to the spell. Invoke
362will not set the range weapon.
363 339
364Examples: 340Examples:
341
365'invoke restoration 342 invoke restoration
366'invoke magic rune of large fireball 343 invoke magic rune of large fireball
367'invoke reincarnation of Iamdead 344 invoke reincarnation of Iamdead
368'invoke create food of waybread 345 invoke create food of waybread
369 346
370It is very helpful to bind healing 347It is very helpful to bind healing spells to keys, for example go to your
371spells 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'.
372 352
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 353
407=head2 killpets 354=head2 killpets
355
356 killpets [name]
408 357
409The killpets command is a quick and convenient way 358The killpets command is a quick and convenient way
410to get rid of all your pets when they are no longer 359to get rid of all your pets when they are no longer
411useful or are getting in the way. Any equipment 360useful or are getting in the way. Any equipment
412they had will be left behind, but you will get no 361they had will be left behind, but you will get no
418but not bees. If a number is specified, the pet 367but not bees. If a number is specified, the pet
419corresponding to that number is killed. 368corresponding to that number is killed.
420 369
421=head2 listen 370=head2 listen
422 371
372 listen <listen-level>
373
423Listen, sets the level of messages you will hear. 374Listen sets the level of messages you will hear.
424Priorities are defined as follows: 375Priorities are defined as follows:
425 376
426 0 - Nothing, not even "You punch kobold." or "You say: hi". 377 0 - Nothing, not even "You punch kobold." or "You say: hi".
427 1 - Only messages that have to do with yourself. 378 1 - Only messages that have to do with yourself.
428 2 - Emergency calls from other users 379 2 - Emergency calls from other users
450The 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
451the 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.
452 403
453=head2 maps 404=head2 maps
454 405
455Shows a list of maps that are currently being visited or have been visited. 406[crossfire+]
456The different fields are Path, Pl, PlM, IM, TO, Dif and Reset. They mean:
457 407
458Path: The last part of the map path 408 maps <mapname>
459Pl: Players on the map. 409
460PlM: Players on the map recounted (should be the same as Pl). 410Shows a list of maps matching the regex <mapname> that are currently being
461IM: 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:
4623) currently loading or 4) currently saving. 412
463TO: Timeout, when the map is swapped to disk. 413=over 4
464Dif: Map difficulty. 414
465Reset: 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
466 439
467=head2 mark 440=head2 mark
468 441
469B<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
470these are flint & steel marked for apply torches, a weapon marked for 443these are flint & steel marked for apply torches, a weapon marked for
484 457
485=head2 motd 458=head2 motd
486 459
487Shows the message of the day. It takes no arguments. 460Shows the message of the day. It takes no arguments.
488 461
489=head2 melee
490
491ERROR: not a command, but another help topic => move to a different file maybe?
492
493You fight to kill monsters. You can either use magic or weapons.
494
495To use weapons, simply wield a weapon (and armour!) and move into the
496monster you want to attack.
497
498To use magic or bows, read
499'help spells
500and
501'help range
502and
503'help cast
504and
505'help invoke
506
507=head2 mode
508
509ERROR: not a command, but another help topic => move to a different file maybe?
510
511The mode commands are as follows:
512
513Applymode, adjusts how items are applied
514Bowmode, adjusts the way bows work
515Peaceful, sets how you react to other players
516Petmode, adjusts how your pets behave
517
518=head2 mouse
519
520ERROR: not a command, but another help topic => move to a different file maybe?
521
522The mouse isn't a great way to move your character. It'll work, but you'll
523be handicapped unless you use the keyboard for this. However, the mouse
524has the following inventory uses:
525
526Middle button on item: apply
527or equip
528
529Right button: drop or pickup
530item on ground
531
532Left button: info on item
533
534=head2 move
535
536ERROR: not a command, but another help topic => move to a different file maybe?
537ERROR: same as "keys"?
538
539These are the basic movement
540keys:
541 yku
542 h l
543 bjn
544
545Running is done by holding
546control and move. Running
547is recommended.
548
549Firing the range weapon (help range)
550is done by holding shift and
551move.
552
553'help mouse for help on what the
554mouse buttons do.
555
556'help melee for advice on how to
557fight
558
559'help traps for help with finding
560and disarming traps
561
562=head2 output-count 462=head2 output-count
563 463
564output-sync controls how often information is sent to the screen. Each 464 output-count [lines]
565buffer has its own time value, and will be flushed independantly. The
566default value is 16 ticks (about 2 seconds).
567 465
568output-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
569then 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
570message '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
5711 - 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 -
572buffering is disabled in this regard. 470buffering is disabled in this regard.
573 471
574See also L<output-sync>.
575
576=head2 output-sync
577
578output-sync controls how often information is sent to the screen. Each 472output-sync controls how often information is sent to the screen. Each
579buffer has its own time value, and will be flushed independantly. The 473buffer has its own time value, and will be flushed independantly. The
580default 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.
581 496
582output-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
583then 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
584message '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
5851 - 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 -
753 668
754If either of the names contain spaces, you have to use the C<">-form, 669If either of the names contain spaces, you have to use the C<">-form,
755otherwise you can just write the name as-is. If you omit the old name, the 670otherwise you can just write the name as-is. If you omit the old name, the
756marked item will be used instead. 671marked item will be used instead.
757 672
758If the new name is empty (i.e. C<"">), then the custom name will be 673If the new name is empty (i.e. C<"">), then the original (unrenamed) name
759removed from the item. 674will be restored.
760 675
761Note: maximum allowed name length is 127 characters. 676Note: maximum allowed name length is 127 characters.
762 677
763=head2 reply 678=head2 reply
764 679
957 title <new title> 872 title <new title>
958 title clear # Sets your title back to your race. 873 title clear # Sets your title back to your race.
959 874
960Dragons cannot set their title because it changes during the game. 875Dragons cannot set their title because it changes during the game.
961 876
962=head2 traps
963
964ERROR: not a command, but another help topic => move to a different file maybe?
965
966I recommend the following
967keybindings
968'bind search
969s
970'bind disarm
971d
972Then you can use the 's' and
973'd' keys for searching for and
974disarming traps.
975
976Traps appear at random in doors and in chests. Search those before you
977open them up. Search by going near where you suspect a trap, and type 's'
978
979=head2 unignore 877=head2 unignore
980 878
981 unignore <login> 879 unignore <login>
982 880
983Cancels 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.
984 887
985=head2 use_skill 888=head2 use_skill
986 889
987 use_skill <name of skill> 890 use_skill <name of skill>
988 891
1039 942
1040The 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
1041automatically 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
1042not be used when the opponent attacks with spells. 945not be used when the opponent attacks with spells.
1043 946
947
1044=head1 Authors 948=head1 Authors
1045 949
1046Parts of this document were originally taken from the crossfire server 950Parts of this document were originally taken from the crossfire server
1047help files with unknwon authors. 951help files with unknwon authors.
1048 952

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines