| 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 | |
| 16 | Accepts an invitation previously issued by another player using the invite |
13 | Accepts an invitation previously issued by another player using the invite |
| 17 | command. This will transfer you to the location you were invited to. |
14 | command. This will transfer you to the location you were invited to. |
| … | |
… | |
| 263 | =head2 gsay |
260 | =head2 gsay |
| 264 | |
261 | |
| 265 | If you are in a party (party join or party form), you will be able to message |
262 | If you are in a party (party join or party form), you will be able to message |
| 266 | only your party. Even people standing right next to you can't hear it. |
263 | only your party. Even people standing right next to you can't hear it. |
| 267 | |
264 | |
| 268 | =head2 golem |
|
|
| 269 | |
|
|
| 270 | ERROR: not a command, but another help topic => move to a different file maybe? |
|
|
| 271 | |
|
|
| 272 | Golems are creatures that the player has some control over. Note that many |
|
|
| 273 | summoned creatures are considered golems, even if they are not called |
|
|
| 274 | golems. |
|
|
| 275 | |
|
|
| 276 | If you have a golem in control your spell type will be listed as golem, |
|
|
| 277 | with the creature name in parantheses. |
|
|
| 278 | |
|
|
| 279 | To control your golem, just press the fire key in the direction you want |
|
|
| 280 | your golem to move. Your golem will then start moving in that direction, |
|
|
| 281 | and keep moving in that direction until you change its direction. |
|
|
| 282 | |
|
|
| 283 | Note that once you leave the map that the golem is on, the golem will |
|
|
| 284 | disappear. Also, once you select another spell to cast, or change your |
|
|
| 285 | range type, your golem will disappear. |
|
|
| 286 | |
|
|
| 287 | =head2 help |
265 | =head2 help |
| 288 | |
266 | |
| 289 | Gives you online help for the command or help topic specified. |
267 | Gives you online help for the command or help topic specified. |
|
|
268 | |
|
|
269 | =head2 hintmode (show|mark|hide) |
|
|
270 | |
|
|
271 | hintmode show|mark|hide |
|
|
272 | |
|
|
273 | Sets the I<hint mode> to the given value: Throughout the game you can find |
|
|
274 | hints that sometimes help you to solve a puzzle or manage a situation |
|
|
275 | better than without. You can change the display of these hints with this |
|
|
276 | command: |
|
|
277 | |
|
|
278 | =over 4 |
|
|
279 | |
|
|
280 | =item show |
|
|
281 | |
|
|
282 | Show the hints (the default mode). |
|
|
283 | |
|
|
284 | =item mark |
|
|
285 | |
|
|
286 | Do not show the hints themselves, but notify you when a hint would have |
|
|
287 | been available. |
|
|
288 | |
|
|
289 | =item hide |
|
|
290 | |
|
|
291 | Hide all hints: You will not be able to tell wether there is a hint |
|
|
292 | available or not. |
|
|
293 | |
|
|
294 | =back |
| 290 | |
295 | |
| 291 | =head2 hiscore |
296 | =head2 hiscore |
| 292 | |
297 | |
| 293 | Shows a list of the highest level players in the game. |
298 | Shows a list of the highest level players in the game. |
| 294 | |
299 | |
| … | |
… | |
| 353 | One can never transport from nor to an unholy place. That means, one can |
358 | One can never transport from nor to an unholy place. That means, one can |
| 354 | not be saved out of jail using invite. |
359 | not be saved out of jail using invite. |
| 355 | |
360 | |
| 356 | =head2 invoke |
361 | =head2 invoke |
| 357 | |
362 | |
| 358 | The invoke command is used |
363 | The invoke command is used to cast a spell immediately, or when it is |
| 359 | to cast a spell immediately, |
364 | necessary to give a parameter to the spell. Invoke will not set the range |
| 360 | or when it is necessary to give |
365 | weapon. |
| 361 | a parameter to the spell. Invoke |
|
|
| 362 | will not set the range weapon. |
|
|
| 363 | |
366 | |
| 364 | Examples: |
367 | Examples: |
|
|
368 | |
| 365 | 'invoke restoration |
369 | invoke restoration |
| 366 | 'invoke magic rune of large fireball |
370 | invoke magic rune of large fireball |
| 367 | 'invoke reincarnation of Iamdead |
371 | invoke reincarnation of Iamdead |
| 368 | 'invoke create food of waybread |
372 | invoke create food of waybread |
| 369 | |
373 | |
| 370 | It is very helpful to bind healing |
374 | It is very helpful to bind healing spells to keys, for example go to your |
| 371 | spells to keys like this: |
375 | I<playerbook>, tab I<spells>, the press the right mosue button on the |
|
|
376 | spell I<medium healing> and choose C<bind invoke ... to a key>. It is |
|
|
377 | recommended to bind a healing spell or potion to an easily-accessible-key, |
|
|
378 | such as '1'. |
| 372 | |
379 | |
| 373 | 'bind invoke medium healing |
|
|
| 374 | c |
|
|
| 375 | |
|
|
| 376 | the c key now casts medium healing |
|
|
| 377 | instantly |
|
|
| 378 | |
|
|
| 379 | =head2 keys |
|
|
| 380 | |
|
|
| 381 | ERROR: not a command, but another help topic => move to a different file maybe? |
|
|
| 382 | ERROR: its wrong anyways |
|
|
| 383 | |
|
|
| 384 | These are the basic movement |
|
|
| 385 | keys: |
|
|
| 386 | yku |
|
|
| 387 | h l |
|
|
| 388 | bjn |
|
|
| 389 | |
|
|
| 390 | Running is done by holding |
|
|
| 391 | control and move. Running |
|
|
| 392 | is recommended. |
|
|
| 393 | |
|
|
| 394 | Firing the range weapon (help range) |
|
|
| 395 | is done by holding shift and |
|
|
| 396 | move. |
|
|
| 397 | |
|
|
| 398 | 'help mouse for help on what the |
|
|
| 399 | mouse buttons do. |
|
|
| 400 | |
|
|
| 401 | 'help melee for advice on how to |
|
|
| 402 | fight |
|
|
| 403 | |
|
|
| 404 | 'help traps for help with finding |
|
|
| 405 | and disarming traps |
|
|
| 406 | |
380 | |
| 407 | =head2 killpets |
381 | =head2 killpets |
|
|
382 | |
|
|
383 | killpets [name] |
| 408 | |
384 | |
| 409 | The killpets command is a quick and convenient way |
385 | The killpets command is a quick and convenient way |
| 410 | to get rid of all your pets when they are no longer |
386 | to get rid of all your pets when they are no longer |
| 411 | useful or are getting in the way. Any equipment |
387 | useful or are getting in the way. Any equipment |
| 412 | they had will be left behind, but you will get no |
388 | they had will be left behind, but you will get no |
| … | |
… | |
| 418 | but not bees. If a number is specified, the pet |
394 | but not bees. If a number is specified, the pet |
| 419 | corresponding to that number is killed. |
395 | corresponding to that number is killed. |
| 420 | |
396 | |
| 421 | =head2 listen |
397 | =head2 listen |
| 422 | |
398 | |
|
|
399 | listen <listen-level> |
|
|
400 | |
| 423 | Listen, sets the level of messages you will hear. |
401 | Listen sets the level of messages you will hear. |
| 424 | Priorities are defined as follows: |
402 | Priorities are defined as follows: |
| 425 | |
403 | |
| 426 | 0 - Nothing, not even "You punch kobold." or "You say: hi". |
404 | 0 - Nothing, not even "You punch kobold." or "You say: hi". |
| 427 | 1 - Only messages that have to do with yourself. |
405 | 1 - Only messages that have to do with yourself. |
| 428 | 2 - Emergency calls from other users |
406 | 2 - Emergency calls from other users |
| … | |
… | |
| 450 | The rest is information the mapper may or may not provide. Often, this is |
428 | The rest is information the mapper may or may not provide. Often, this is |
| 451 | the mapper's name, email and map creation date as this example shows. |
429 | the mapper's name, email and map creation date as this example shows. |
| 452 | |
430 | |
| 453 | =head2 maps |
431 | =head2 maps |
| 454 | |
432 | |
| 455 | Shows a list of maps that are currently being visited or have been visited. |
433 | [crossfire+] |
| 456 | The different fields are Path, Pl, PlM, IM, TO, Dif and Reset. They mean: |
|
|
| 457 | |
434 | |
| 458 | Path: The last part of the map path |
435 | maps <mapname> |
| 459 | Pl: Players on the map. |
436 | |
| 460 | PlM: Players on the map recounted (should be the same as Pl). |
437 | Shows a list of maps matching the regex <mapname> that are currently being |
| 461 | IM: In memory means whether the map is: 1) in memory, 2) swapped to disk, |
438 | known to the server. The different fields are Pl, I, Svd, Reset and Path: |
| 462 | 3) currently loading or 4) currently saving. |
439 | |
| 463 | TO: Timeout, when the map is swapped to disk. |
440 | =over 4 |
| 464 | Dif: Map difficulty. |
441 | |
| 465 | Reset: 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 | |
|
|
446 | The server keeps maps in memory only for a short time (by default about |
|
|
447 | 40 seconds). After that time, it saves them to disk. As the server loads |
|
|
448 | most maps in the background it is possible that you can see a map that is |
|
|
449 | currently 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 | |
|
|
453 | The server by default tries to save each map at least every 20 seconds if |
|
|
454 | it changed, so in case of a disastrous crash (one where the server cannot |
|
|
455 | emergency 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 | |
|
|
459 | Most maps will not reset as long as players are on it, and usually the |
|
|
460 | reset 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 | |
| 466 | |
466 | |
| 467 | =head2 mark |
467 | =head2 mark |
| 468 | |
468 | |
| 469 | B<mark> is used to mark items for items that apply other items. Examples of |
469 | B<mark> is used to mark items for items that apply other items. Examples of |
| 470 | these are flint & steel marked for apply torches, a weapon marked for |
470 | these are flint & steel marked for apply torches, a weapon marked for |
| … | |
… | |
| 484 | |
484 | |
| 485 | =head2 motd |
485 | =head2 motd |
| 486 | |
486 | |
| 487 | Shows the message of the day. It takes no arguments. |
487 | Shows the message of the day. It takes no arguments. |
| 488 | |
488 | |
| 489 | =head2 melee |
|
|
| 490 | |
|
|
| 491 | ERROR: not a command, but another help topic => move to a different file maybe? |
|
|
| 492 | |
|
|
| 493 | You fight to kill monsters. You can either use magic or weapons. |
|
|
| 494 | |
|
|
| 495 | To use weapons, simply wield a weapon (and armour!) and move into the |
|
|
| 496 | monster you want to attack. |
|
|
| 497 | |
|
|
| 498 | To use magic or bows, read |
|
|
| 499 | 'help spells |
|
|
| 500 | and |
|
|
| 501 | 'help range |
|
|
| 502 | and |
|
|
| 503 | 'help cast |
|
|
| 504 | and |
|
|
| 505 | 'help invoke |
|
|
| 506 | |
|
|
| 507 | =head2 mode |
|
|
| 508 | |
|
|
| 509 | ERROR: not a command, but another help topic => move to a different file maybe? |
|
|
| 510 | |
|
|
| 511 | The mode commands are as follows: |
|
|
| 512 | |
|
|
| 513 | Applymode, adjusts how items are applied |
|
|
| 514 | Bowmode, adjusts the way bows work |
|
|
| 515 | Peaceful, sets how you react to other players |
|
|
| 516 | Petmode, adjusts how your pets behave |
|
|
| 517 | |
|
|
| 518 | =head2 mouse |
|
|
| 519 | |
|
|
| 520 | ERROR: not a command, but another help topic => move to a different file maybe? |
|
|
| 521 | |
|
|
| 522 | The mouse isn't a great way to move your character. It'll work, but you'll |
|
|
| 523 | be handicapped unless you use the keyboard for this. However, the mouse |
|
|
| 524 | has the following inventory uses: |
|
|
| 525 | |
|
|
| 526 | Middle button on item: apply |
|
|
| 527 | or equip |
|
|
| 528 | |
|
|
| 529 | Right button: drop or pickup |
|
|
| 530 | item on ground |
|
|
| 531 | |
|
|
| 532 | Left button: info on item |
|
|
| 533 | |
|
|
| 534 | =head2 move |
|
|
| 535 | |
|
|
| 536 | ERROR: not a command, but another help topic => move to a different file maybe? |
|
|
| 537 | ERROR: same as "keys"? |
|
|
| 538 | |
|
|
| 539 | These are the basic movement |
|
|
| 540 | keys: |
|
|
| 541 | yku |
|
|
| 542 | h l |
|
|
| 543 | bjn |
|
|
| 544 | |
|
|
| 545 | Running is done by holding |
|
|
| 546 | control and move. Running |
|
|
| 547 | is recommended. |
|
|
| 548 | |
|
|
| 549 | Firing the range weapon (help range) |
|
|
| 550 | is done by holding shift and |
|
|
| 551 | move. |
|
|
| 552 | |
|
|
| 553 | 'help mouse for help on what the |
|
|
| 554 | mouse buttons do. |
|
|
| 555 | |
|
|
| 556 | 'help melee for advice on how to |
|
|
| 557 | fight |
|
|
| 558 | |
|
|
| 559 | 'help traps for help with finding |
|
|
| 560 | and disarming traps |
|
|
| 561 | |
|
|
| 562 | =head2 output-count |
489 | =head2 output-count |
| 563 | |
490 | |
| 564 | output-sync controls how often information is sent to the screen. Each |
491 | output-count [lines] |
| 565 | buffer has its own time value, and will be flushed independantly. The |
|
|
| 566 | default value is 16 ticks (about 2 seconds). |
|
|
| 567 | |
492 | |
| 568 | output-count sets after how many messages of the same type, they are |
493 | output-count sets after how many messages of the same type, they are |
| 569 | then printed out. If the value was 10, then after killing ten orcs, the |
494 | then printed out. If the value was 10, then after killing ten orcs, the |
| 570 | message '10 times you kill orc' would be printed out. The default value is |
495 | message '10 times you kill orc' would be printed out. The default value is |
| 571 | 1 - this means that all messages get printed out as they are requested - |
496 | 1 - this means that all messages get printed out as they are requested - |
| 572 | buffering is disabled in this regard. |
497 | buffering is disabled in this regard. |
| 573 | |
498 | |
| 574 | See also L<output-sync>. |
|
|
| 575 | |
|
|
| 576 | =head2 output-sync |
|
|
| 577 | |
|
|
| 578 | output-sync controls how often information is sent to the screen. Each |
499 | output-sync controls how often information is sent to the screen. Each |
| 579 | buffer has its own time value, and will be flushed independantly. The |
500 | buffer has its own time value, and will be flushed independantly. The |
| 580 | default value is 16 ticks (about 2 seconds). |
501 | default value is usually less than a second. |
|
|
502 | |
|
|
503 | See also L<output-sync>. |
|
|
504 | |
|
|
505 | =head2 output-rate [bytes per second] |
|
|
506 | |
|
|
507 | Show the current setting of the output-rate, or set it to the provided |
|
|
508 | value. The server will try not to send (much) more than this many bytes |
|
|
509 | per second to your client. If the rate is exceeded, the server tries to |
|
|
510 | hold back less important information (such as new images), to increase |
|
|
511 | responsiveness. The server-side default is usually quite high, around |
|
|
512 | 100000, so if you have a slow link and want to be able to control your |
|
|
513 | character even when downloading faces, set this to a lower value, such as |
|
|
514 | 7000 (for ISDN). |
|
|
515 | |
|
|
516 | =head2 output-sync |
|
|
517 | |
|
|
518 | output-sync [seconds] |
|
|
519 | |
|
|
520 | output-sync controls how often information is sent to the screen. Each |
|
|
521 | buffer has its own time value, and will be flushed independantly. The |
|
|
522 | default value is usually less than a second. |
| 581 | |
523 | |
| 582 | output-count sets after how many messages of the same type, they are |
524 | output-count sets after how many messages of the same type, they are |
| 583 | then printed out. If the value was 10, then after killing ten orcs, the |
525 | then printed out. If the value was 10, then after killing ten orcs, the |
| 584 | message '10 times you kill orc' would be printed out. The default value is |
526 | message '10 times you kill orc' would be printed out. The default value is |
| 585 | 1 - this means that all messages get printed out as they are requested - |
527 | 1 - this means that all messages get printed out as they are requested - |
| … | |
… | |
| 753 | |
695 | |
| 754 | If either of the names contain spaces, you have to use the C<">-form, |
696 | If either of the names contain spaces, you have to use the C<">-form, |
| 755 | otherwise you can just write the name as-is. If you omit the old name, the |
697 | otherwise you can just write the name as-is. If you omit the old name, the |
| 756 | marked item will be used instead. |
698 | marked item will be used instead. |
| 757 | |
699 | |
| 758 | If the new name is empty (i.e. C<"">), then the custom name will be |
700 | If the new name is empty (i.e. C<"">), then the original (unrenamed) name |
| 759 | removed from the item. |
701 | will be restored. |
| 760 | |
702 | |
| 761 | Note: maximum allowed name length is 127 characters. |
703 | Note: maximum allowed name length is 127 characters. |
| 762 | |
704 | |
| 763 | =head2 reply |
705 | =head2 reply |
| 764 | |
706 | |
| … | |
… | |
| 879 | Toggles between sound enabled and disabled. This has no relevance to the |
821 | Toggles between sound enabled and disabled. This has no relevance to the |
| 880 | sound settings of the client, it only governs wether the server will send |
822 | sound settings of the client, it only governs wether the server will send |
| 881 | sound effect command to the client and is enabled if the client supports |
823 | sound effect command to the client and is enabled if the client supports |
| 882 | sound (i.e. always for cfplus). |
824 | sound (i.e. always for cfplus). |
| 883 | |
825 | |
|
|
826 | =head2 sourcecode |
|
|
827 | |
|
|
828 | This command displays the means to download the sourcecode (server code, |
|
|
829 | maps and archetypes) used to implement this version of the game. |
|
|
830 | |
|
|
831 | Every player has the right to download and modify the source code of the |
|
|
832 | server, as required by both the GNU General Public License and the GNU |
|
|
833 | Affero General Public license. |
|
|
834 | |
|
|
835 | If you modify your version of the server, you will have to provide a means |
|
|
836 | to download the modified sources (and resources) via this command. If you |
|
|
837 | run an unmodified version of the server, the default will do. |
|
|
838 | |
| 884 | =head2 statistics |
839 | =head2 statistics |
| 885 | |
840 | |
| 886 | B<statistics> shows various useful information about your character. |
841 | B<statistics> shows various useful information about your character. |
| 887 | None of the information it shows is stuff that is not contained in the |
842 | None of the information it shows is stuff that is not contained in the |
| 888 | documentation. |
843 | documentation. |
| … | |
… | |
| 957 | title <new title> |
912 | title <new title> |
| 958 | title clear # Sets your title back to your race. |
913 | title clear # Sets your title back to your race. |
| 959 | |
914 | |
| 960 | Dragons cannot set their title because it changes during the game. |
915 | Dragons cannot set their title because it changes during the game. |
| 961 | |
916 | |
| 962 | =head2 traps |
|
|
| 963 | |
|
|
| 964 | ERROR: not a command, but another help topic => move to a different file maybe? |
|
|
| 965 | |
|
|
| 966 | I recommend the following |
|
|
| 967 | keybindings |
|
|
| 968 | 'bind search |
|
|
| 969 | s |
|
|
| 970 | 'bind disarm |
|
|
| 971 | d |
|
|
| 972 | Then you can use the 's' and |
|
|
| 973 | 'd' keys for searching for and |
|
|
| 974 | disarming traps. |
|
|
| 975 | |
|
|
| 976 | Traps appear at random in doors and in chests. Search those before you |
|
|
| 977 | open them up. Search by going near where you suspect a trap, and type 's' |
|
|
| 978 | |
|
|
| 979 | =head2 unignore |
917 | =head2 unignore |
| 980 | |
918 | |
| 981 | unignore <login> |
919 | unignore <login> |
| 982 | |
920 | |
| 983 | Cancels all ignores set for the specified login. See B<ignore>. |
921 | Cancels all ignores set for the specified login. See B<ignore>. |
|
|
922 | |
|
|
923 | =head2 uptime |
|
|
924 | |
|
|
925 | Tells you something about the time the server was started and how long ago |
|
|
926 | that was. |
| 984 | |
927 | |
| 985 | =head2 use_skill |
928 | =head2 use_skill |
| 986 | |
929 | |
| 987 | use_skill <name of skill> |
930 | use_skill <name of skill> |
| 988 | |
931 | |
| … | |
… | |
| 1039 | |
982 | |
| 1040 | The wimpy level is the amount of health points (hp) that may be left before you |
983 | The wimpy level is the amount of health points (hp) that may be left before you |
| 1041 | automatically run away. This may be useful in hand-to-hand combats but should |
984 | automatically run away. This may be useful in hand-to-hand combats but should |
| 1042 | not be used when the opponent attacks with spells. |
985 | not be used when the opponent attacks with spells. |
| 1043 | |
986 | |
|
|
987 | |
| 1044 | =head1 Authors |
988 | =head1 Authors |
| 1045 | |
989 | |
| 1046 | Parts of this document were originally taken from the crossfire server |
990 | Parts of this document were originally taken from the crossfire server |
| 1047 | help files with unknwon authors. |
991 | help files with unknwon authors. |
| 1048 | |
992 | |
