--- deliantra/Deliantra-Client/pod/command_help.pod 2006/08/13 01:44:25 1.1 +++ deliantra/Deliantra-Client/pod/command_help.pod 2007/04/18 18:16:16 1.15 @@ -1,4 +1,4 @@ -=head1 Crossfire+ Command ListingX +=head1 Crossfire+ Command ListingX =head2 accept-invitation @@ -26,7 +26,7 @@ These two options disable the toggling feature. -=head2 applymode (nochoice|never|always) +=head2 Xapplymode (nochoice|never|always) Applymode controls what happens when you are equipping something that would require something else to be unequipped. @@ -67,7 +67,7 @@ equip another suit, both B and B will cause the new suit to get equipped. -See L. +See L. =head2 body @@ -75,7 +75,7 @@ fireborn, you have 4 fingers to put rings on. If you have 3 rings on it will say: "on your finger 3 1", meaning you have 3 fingers full and one free. -=head2 bowmode (normal|threewide|spreadshot|bestarrow|.*) +=head2 Xbowmode (normal|threewide|spreadshot|bestarrow|.*) Bowmode controls how you will fire arrows and bolts. @@ -121,8 +121,8 @@ chat -Sends a message to all players on the server that have L level -B<10> or higher. +Sends a message to all players on the server that have +L level B<10> or higher. =head2 cast @@ -139,7 +139,7 @@ See B for more information on range weapons. -=head2 drop (all|unpaid|cursed|unlocked|.*) +=head2 Xdrop (all|unpaid|cursed|unlocked|.*) drop [number] name @@ -195,7 +195,7 @@ Drops weapons, bows, and arrows. =item B (armour) - + Drops armor, shield, and helmets. =item B @@ -254,25 +254,6 @@ If you are in a party (party join or party form), you will be able to message only your party. Even people standing right next to you can't hear it. -=head2 golem - -ERROR: not a command, but another help topic => move to a different file maybe? - -Golems are creatures that the player has some control over. Note that many -summoned creatures are considered golems, even if they are not called -golems. - -If you have a golem in control your spell type will be listed as golem, -with the creature name in parantheses. - -To control your golem, just press the fire key in the direction you want -your golem to move. Your golem will then start moving in that direction, -and keep moving in that direction until you change its direction. - -Note that once you leave the map that the golem is on, the golem will -disappear. Also, once you select another spell to cast, or change your -range type, your golem will disappear. - =head2 help Gives you online help for the command or help topic specified. @@ -283,6 +264,10 @@ =head2 ignore + ignore list + +Lists all players that you currently ignore. + ignore [timeout] This command ignores the specified messages (B ignores tells, @@ -296,10 +281,6 @@ To revoke an ignore, use the B command. -=head2 ignore list - -Lists all players that you currently ignore. - =head2 inventory Lists all items in your inventory along with their locked/applied/wielded @@ -344,57 +325,28 @@ =head2 invoke -The invoke command is used -to cast a spell immediately, -or when it is necessary to give -a parameter to the spell. Invoke -will not set the range weapon. +The invoke command is used to cast a spell immediately, or when it is +necessary to give a parameter to the spell. Invoke will not set the range +weapon. Examples: -'invoke restoration -'invoke magic rune of large fireball -'invoke reincarnation of Iamdead -'invoke create food of waybread - -It is very helpful to bind healing -spells to keys like this: - -'bind invoke medium healing -c - -the c key now casts medium healing -instantly - -=head2 keys - -ERROR: not a command, but another help topic => move to a different file maybe? -ERROR: its wrong anyways - -These are the basic movement -keys: - yku - h l - bjn - -Running is done by holding -control and move. Running -is recommended. -Firing the range weapon (help range) -is done by holding shift and -move. + invoke restoration + invoke magic rune of large fireball + invoke reincarnation of Iamdead + invoke create food of waybread + +It is very helpful to bind healing spells to keys, for example go to your +I, tab I, the press the right mosue button on the +spell I and choose C. It is +recommended to bind a healing spell or potion to an easily-accessible-key, +such as '1'. -'help mouse for help on what the -mouse buttons do. - -'help melee for advice on how to -fight - -'help traps for help with finding -and disarming traps =head2 killpets + killpets [name] + The killpets command is a quick and convenient way to get rid of all your pets when they are no longer useful or are getting in the way. Any equipment @@ -409,7 +361,9 @@ =head2 listen -Listen, sets the level of messages you will hear. + listen + +Listen sets the level of messages you will hear. Priorities are defined as follows: 0 - Nothing, not even "You punch kobold." or "You say: hi". @@ -441,17 +395,39 @@ =head2 maps -Shows a list of maps that are currently being visited or have been visited. -The different fields are Path, Pl, PlM, IM, TO, Dif and Reset. They mean: +[crossfire+] + + maps + +Shows a list of maps matching the regex that are currently being +known to the server. The different fields are Pl, I, Svd, Reset and Path: + +=over 4 + +=item Pl: the number of players on that map currently. + +=item I: Bn memory, Bwapped out or Boading. + +The server keeps maps in memory only for a short time (by default about +40 seconds). After that time, it saves them to disk. As the server loads +most maps in the background it is possible that you can see a map that is +currently being loaded, but thats rare, as loading a map is fast. + +=item Svd: the amount of seconds the map was last saved (++ means >99). + +The server by default tries to save each map at least every 20 seconds if +it changed, so in case of a disastrous crash (one where the server cannot +emergency save), at most 20 seconds of gameplay are lost. + +=item Reset: the minimum number of seconds the map will stay as is (will not reset). + +Most maps will not reset as long as players are on it, and usually the +reset counter only starts going down when all players left the map. + +=item Path: the name that uniquely identifies the map, can be used for goto etc. + +=back -Path: The last part of the map path -Pl: Players on the map. -PlM: Players on the map recounted (should be the same as Pl). -IM: In memory means whether the map is: 1) in memory, 2) swapped to disk, -3) currently loading or 4) currently saving. -TO: Timeout, when the map is swapped to disk. -Dif: Map difficulty. -Reset: Real server time when the map is going to reset. =head2 mark @@ -475,84 +451,9 @@ Shows the message of the day. It takes no arguments. -=head2 melee - -ERROR: not a command, but another help topic => move to a different file maybe? - -You fight to kill monsters. You can either use magic or weapons. - -To use weapons, simply wield a weapon (and armour!) and move into the -monster you want to attack. - -To use magic or bows, read -'help spells -and -'help range -and -'help cast -and -'help invoke - -=head2 mode - -ERROR: not a command, but another help topic => move to a different file maybe? - -The mode commands are as follows: - -Applymode, adjusts how items are applied -Bowmode, adjusts the way bows work -Peaceful, sets how you react to other players -Petmode, adjusts how your pets behave - -=head2 mouse - -ERROR: not a command, but another help topic => move to a different file maybe? - -The mouse isn't a great way to move your character. It'll work, but you'll -be handicapped unless you use the keyboard for this. However, the mouse -has the following inventory uses: - -Middle button on item: apply -or equip - -Right button: drop or pickup -item on ground - -Left button: info on item - -=head2 move - -ERROR: not a command, but another help topic => move to a different file maybe? -ERROR: same as "keys"? - -These are the basic movement -keys: - yku - h l - bjn - -Running is done by holding -control and move. Running -is recommended. - -Firing the range weapon (help range) -is done by holding shift and -move. - -'help mouse for help on what the -mouse buttons do. - -'help melee for advice on how to -fight - -'help traps for help with finding -and disarming traps - =head2 output-count -output-sync controls how often information is sent to the screen. Each -buffer has its own time value, and will be flushed independantly. The -default value is 16 ticks (about 2 seconds). + output-count [lines] output-count sets after how many messages of the same type, they are then printed out. If the value was 10, then after killing ten orcs, the @@ -560,13 +461,30 @@ 1 - this means that all messages get printed out as they are requested - buffering is disabled in this regard. +output-sync controls how often information is sent to the screen. Each +buffer has its own time value, and will be flushed independantly. The +default value is usually less than a second. + See also L. +=head2 output-rate [bytes per second] + +Show the current setting of the output-rate, or set it to the provided +value. The server will try not to send (much) more than this many bytes +per second to your client. If the rate is exceeded, the server tries to +hold back less important information (such as new images), to increase +responsiveness. The server-side default is usually quite high, around +100000, so if you have a slow link and want to be able to control your +character even when downloading faces, set this to a lower value, such as +7000 (for ISDN). + =head2 output-sync + output-sync [seconds] + output-sync controls how often information is sent to the screen. Each buffer has its own time value, and will be flushed independantly. The -default value is 16 ticks (about 2 seconds). +default value is usually less than a second. output-count sets after how many messages of the same type, they are then printed out. If the value was 10, then after killing ten orcs, the @@ -626,7 +544,7 @@ detonations, fireballs, poisons, cloud or swarm attacks, runes or disease are not modified by peaceful/hostile mode. -=head2 petmode (normal|sad|defend|arena) +=head2 Xpetmode (normal|sad|defend|arena) B controls how your pets (charmed monsters) will behave. @@ -691,7 +609,7 @@ prepare -=head2 quests (|finished|.*) +=head2 Xquests (|finished|.*) The quests command lists the quests you are doing or have completed. @@ -722,17 +640,30 @@ Your range weapon is fired when you press SHIFT-direction, and will be fired in that direction. -=head2 rename +=head2 ready_skill + + ready_skill + +Readies the given L by putting it in your L. Some skills are used automatically when +readied, some need to be actively used by "firing" them. -Changes the custom name of an item. +If you just want to invoke a skill once, leaving your range slot +untouched, use L instead. - rename to +=head2 rename + +Changes/removes the custom name of given item (or the marked one). -(Note: the angle brackets (<>) are mandatory and part of the syntax) + rename oldname to newname + rename "old item name" to "new item name" -If '' is omitted, defaults to marked item. +If either of the names contain spaces, you have to use the C<">-form, +otherwise you can just write the name as-is. If you omit the old name, the +marked item will be used instead. -If 'to ' is omitted, clears the custom name. +If the new name is empty (i.e. C<"">), then the original (unrenamed) name +will be restored. Note: maximum allowed name length is 127 characters. @@ -806,10 +737,10 @@ shout -Sends a message to all players on the server that have L level -B<10> or higher. It is mainly useful for emergency messages ("I am trapped -on xxx, can somebody help me?") and should not be used for general -chat. Use L instead. +Sends a message to all players on the server that have +L level B<10> or higher. It is mainly useful for +emergency messages ("I am trapped on xxx, can somebody help me?") and +should not be used for general chat. Use L instead. =head2 showpets @@ -935,28 +866,23 @@ Dragons cannot set their title because it changes during the game. -=head2 traps +=head2 unignore + + unignore -ERROR: not a command, but another help topic => move to a different file maybe? +Cancels all ignores set for the specified login. See B. -I recommend the following -keybindings -'bind search -s -'bind disarm -d -Then you can use the 's' and -'d' keys for searching for and -disarming traps. +=head2 uptime -Traps appear at random in doors and in chests. Search those before you -open them up. Search by going near where you suspect a trap, and type 's' +Tells you something about the time the server was started and how long ago +that was. -=head2 unignore +=head2 use_skill - unignore + use_skill -Cancels all ignores set for the specified login. See B. +Uses the given L immediately, once. See also +L. =head2 usekeys (inventory|keyrings|containers) @@ -998,7 +924,7 @@ =head2 who Shows what players are playing in the world and where they are. It may also -show their levels and race or title. (See the L command) +show their levels and race or title. (See the L<title|command/title> command) B<who> optionally takes an argument that limits the players shown to the specified region, e.g. B<who brest> will show all players playing @@ -1010,6 +936,7 @@ automatically run away. This may be useful in hand-to-hand combats but should not be used when the opponent attacks with spells. + =head1 Authors Parts of this document were originally taken from the crossfire server