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.4 by root, Thu Dec 21 03:34:51 2006 UTC vs.
Revision 1.11 by root, Tue Jul 3 01:05:07 2007 UTC

4*** The source for this file is in CFPlus/pod/command_help.pod 4*** The source for this file is in CFPlus/pod/command_help.pod
5*** Make any changes there and then run ./copy_doc 5*** Make any changes there and then run ./copy_doc
6*** 6***
7=end comment 7=end comment
8 8
9=head1 Crossfire+ Command ListingX<command> 9=head1 Crossfire TRT Command ListingX<command>
10 10
11=head2 accept-invitation 11=head2 accept-invitation
12 12
13Accepts an invitation previously issued by another player using the invite 13Accepts an invitation previously issued by another player using the invite
14command. This will transfer you to the location you were invited to. 14command. This will transfer you to the location you were invited to.
260=head2 gsay 260=head2 gsay
261 261
262If 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
263only 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.
264 264
265=head2 golem
266
267ERROR: not a command, but another help topic => move to a different file maybe?
268
269Golems are creatures that the player has some control over. Note that many
270summoned creatures are considered golems, even if they are not called
271golems.
272
273If you have a golem in control your spell type will be listed as golem,
274with the creature name in parantheses.
275
276To control your golem, just press the fire key in the direction you want
277your golem to move. Your golem will then start moving in that direction,
278and keep moving in that direction until you change its direction.
279
280Note that once you leave the map that the golem is on, the golem will
281disappear. Also, once you select another spell to cast, or change your
282range type, your golem will disappear.
283
284=head2 help 265=head2 help
285 266
286Gives 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
287 295
288=head2 hiscore 296=head2 hiscore
289 297
290Shows a list of the highest level players in the game. 298Shows a list of the highest level players in the game.
291 299
350One 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
351not be saved out of jail using invite. 359not be saved out of jail using invite.
352 360
353=head2 invoke 361=head2 invoke
354 362
355The invoke command is used 363The invoke command is used to cast a spell immediately, or when it is
356to cast a spell immediately, 364necessary to give a parameter to the spell. Invoke will not set the range
357or when it is necessary to give 365weapon.
358a parameter to the spell. Invoke
359will not set the range weapon.
360 366
361Examples: 367Examples:
368
362'invoke restoration 369 invoke restoration
363'invoke magic rune of large fireball 370 invoke magic rune of large fireball
364'invoke reincarnation of Iamdead 371 invoke reincarnation of Iamdead
365'invoke create food of waybread 372 invoke create food of waybread
366 373
367It is very helpful to bind healing 374It is very helpful to bind healing spells to keys, for example go to your
368spells 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'.
369 379
370'bind invoke medium healing
371c
372
373the c key now casts medium healing
374instantly
375
376=head2 keys
377
378ERROR: not a command, but another help topic => move to a different file maybe?
379ERROR: its wrong anyways
380
381These are the basic movement
382keys:
383 yku
384 h l
385 bjn
386
387Running is done by holding
388control and move. Running
389is recommended.
390
391Firing the range weapon (help range)
392is done by holding shift and
393move.
394
395'help mouse for help on what the
396mouse buttons do.
397
398'help melee for advice on how to
399fight
400
401'help traps for help with finding
402and disarming traps
403 380
404=head2 killpets 381=head2 killpets
405 382
406 killpets [name] 383 killpets [name]
407 384
451The 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
452the 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.
453 430
454=head2 maps 431=head2 maps
455 432
456Shows a list of maps that are currently being visited or have been visited. 433[crossfire+]
457The different fields are Path, Pl, PlM, IM, TO, Dif and Reset. They mean:
458 434
459Path: The last part of the map path 435 maps <mapname>
460Pl: Players on the map. 436
461PlM: Players on the map recounted (should be the same as Pl). 437Shows a list of maps matching the regex <mapname> that are currently being
462IM: 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:
4633) currently loading or 4) currently saving. 439
464TO: Timeout, when the map is swapped to disk. 440=over 4
465Dif: Map difficulty. 441
466Reset: 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
467 466
468=head2 mark 467=head2 mark
469 468
470B<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
471these are flint & steel marked for apply torches, a weapon marked for 470these are flint & steel marked for apply torches, a weapon marked for
485 484
486=head2 motd 485=head2 motd
487 486
488Shows the message of the day. It takes no arguments. 487Shows the message of the day. It takes no arguments.
489 488
490=head2 melee
491
492ERROR: not a command, but another help topic => move to a different file maybe?
493
494You fight to kill monsters. You can either use magic or weapons.
495
496To use weapons, simply wield a weapon (and armour!) and move into the
497monster you want to attack.
498
499To use magic or bows, read
500'help spells
501and
502'help range
503and
504'help cast
505and
506'help invoke
507
508=head2 mode
509
510ERROR: not a command, but another help topic => move to a different file maybe?
511
512The mode commands are as follows:
513
514Applymode, adjusts how items are applied
515Bowmode, adjusts the way bows work
516Peaceful, sets how you react to other players
517Petmode, adjusts how your pets behave
518
519=head2 mouse
520
521ERROR: not a command, but another help topic => move to a different file maybe?
522
523The mouse isn't a great way to move your character. It'll work, but you'll
524be handicapped unless you use the keyboard for this. However, the mouse
525has the following inventory uses:
526
527Middle button on item: apply
528or equip
529
530Right button: drop or pickup
531item on ground
532
533Left button: info on item
534
535=head2 move
536
537ERROR: not a command, but another help topic => move to a different file maybe?
538ERROR: same as "keys"?
539
540These are the basic movement
541keys:
542 yku
543 h l
544 bjn
545
546Running is done by holding
547control and move. Running
548is recommended.
549
550Firing the range weapon (help range)
551is done by holding shift and
552move.
553
554'help mouse for help on what the
555mouse buttons do.
556
557'help melee for advice on how to
558fight
559
560'help traps for help with finding
561and disarming traps
562
563=head2 output-count 489=head2 output-count
564 490
565output-sync controls how often information is sent to the screen. Each 491 output-count [lines]
566buffer has its own time value, and will be flushed independantly. The
567default value is 16 ticks (about 2 seconds).
568 492
569output-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
570then 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
571message '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
5721 - 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 -
573buffering is disabled in this regard. 497buffering is disabled in this regard.
574 498
575See also L<output-sync>.
576
577=head2 output-sync
578
579output-sync controls how often information is sent to the screen. Each 499output-sync controls how often information is sent to the screen. Each
580buffer has its own time value, and will be flushed independantly. The 500buffer has its own time value, and will be flushed independantly. The
581default 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.
582 523
583output-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
584then 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
585message '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
5861 - 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 -
754 695
755If either of the names contain spaces, you have to use the C<">-form, 696If either of the names contain spaces, you have to use the C<">-form,
756otherwise you can just write the name as-is. If you omit the old name, the 697otherwise you can just write the name as-is. If you omit the old name, the
757marked item will be used instead. 698marked item will be used instead.
758 699
759If the new name is empty (i.e. C<"">), then the custom name will be 700If the new name is empty (i.e. C<"">), then the original (unrenamed) name
760removed from the item. 701will be restored.
761 702
762Note: maximum allowed name length is 127 characters. 703Note: maximum allowed name length is 127 characters.
763 704
764=head2 reply 705=head2 reply
765 706
880Toggles between sound enabled and disabled. This has no relevance to the 821Toggles between sound enabled and disabled. This has no relevance to the
881sound 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
882sound 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
883sound (i.e. always for cfplus). 824sound (i.e. always for cfplus).
884 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
885=head2 statistics 839=head2 statistics
886 840
887B<statistics> shows various useful information about your character. 841B<statistics> shows various useful information about your character.
888None 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
889documentation. 843documentation.
958 title <new title> 912 title <new title>
959 title clear # Sets your title back to your race. 913 title clear # Sets your title back to your race.
960 914
961Dragons cannot set their title because it changes during the game. 915Dragons cannot set their title because it changes during the game.
962 916
963=head2 traps
964
965ERROR: not a command, but another help topic => move to a different file maybe?
966
967I recommend the following
968keybindings
969'bind search
970s
971'bind disarm
972d
973Then you can use the 's' and
974'd' keys for searching for and
975disarming traps.
976
977Traps appear at random in doors and in chests. Search those before you
978open them up. Search by going near where you suspect a trap, and type 's'
979
980=head2 unignore 917=head2 unignore
981 918
982 unignore <login> 919 unignore <login>
983 920
984Cancels all ignores set for the specified login. See B<ignore>. 921Cancels all ignores set for the specified login. See B<ignore>.
1045 982
1046The 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
1047automatically 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
1048not be used when the opponent attacks with spells. 985not be used when the opponent attacks with spells.
1049 986
987
1050=head1 Authors 988=head1 Authors
1051 989
1052Parts of this document were originally taken from the crossfire server 990Parts of this document were originally taken from the crossfire server
1053help files with unknwon authors. 991help files with unknwon authors.
1054 992

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines