--- deliantra/Deliantra-Client/pod/command_help.pod 2006/08/13 01:44:25 1.1 +++ deliantra/Deliantra-Client/pod/command_help.pod 2008/09/23 00:23:03 1.31 @@ -1,4 +1,4 @@ -=head1 Crossfire+ Command ListingX +=head1 Deliantra Command ListingX =head2 accept-invitation @@ -26,9 +26,9 @@ 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 +the C controls what happens when you are equipping something that would require something else to be unequipped. The options are: @@ -67,17 +67,17 @@ equip another suit, both B and B will cause the new suit to get equipped. -See L. +See L. =head2 body -Shows how much you are wielding on certain bodyparts. For example as +Shows how much you are wielding on certain body parts. For example as 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. +The C controls how you will fire arrows and bolts. The options are: @@ -112,34 +112,34 @@ character will no longer move. It can still attack adjoining spaces. Bracing can be useful to hold a location. -When you are braced, you lose your dex bonus and incur a 2 point -ac penalty beyond that (if you have a negative dex bonus, you may in +When you are braced, you lose your Dex bonus and incur a 2 point +ac penalty beyond that (if you have a negative Dex bonus, you may in fact come out ahead. You also only get 20% of the normal experience -for killing creatures, and incure a 4 point wc (to hit) penalty. +for killing creatures, and incur a 4 point WC (to hit) penalty. =head2 chat 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. This is the normal way to +chat with others. =head2 cast -You use the cast command to set your range-weapon to the spell you +You use the cast command to set your range-action-slot to the spell you want. Example: cast burning hands -sets your I weapon to B. +sets your I slot to B. If you don't know the spell, shows which spells you do know. It is helpful to bind string like B to keys. -See B for more information on range weapons. +See C for more information on range weapons. -=head2 drop (all|unpaid|cursed|unlocked|.*) +=head2 Xdrop (all|unpaid|cursed|unlocked|.*) drop [number] name @@ -151,21 +151,13 @@ =over 4 -=item B +=item B: matches any item. -matches any item. +=item B: matches unpaid items. -=item B +=item B: drops items known to be cursed or damned. -matches unpaid items - -=item B - -drops items known to be cursed or damned. - -=item B - -drops items not locked in your inventory +=item B: drops items not locked in your inventory. =back @@ -177,6 +169,22 @@ See also B and mouse button control within client for dropping objects. + +=head2 cointoss + +Tosses a coin and reports the outcome to you and other players on the same +map, much like the say command does. + + +=head2 orcknuckle + +Throws your orcknuckle set and reports the outcome to you and other +players on the same map, much like the say command does. Your first +three orcknuckle throws can report I, I, I, +I, I, while the fourth can additionally roll up to +I. + + =head2 dropall dropall [type] @@ -195,7 +203,7 @@ Drops weapons, bows, and arrows. =item B (armour) - + Drops armor, shield, and helmets. =item B @@ -254,28 +262,36 @@ 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 +=head2 help + +Gives you online help for the command or help topic specified. + +=head2 hintmode (show|mark|hide) -ERROR: not a command, but another help topic => move to a different file maybe? + hintmode show|mark|hide -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. +Sets the I to the given value: Throughout the game you can find +hints that sometimes help you to solve a puzzle or manage a situation +better than without. You can change the display of these hints with this +command: -If you have a golem in control your spell type will be listed as golem, -with the creature name in parantheses. +=over 4 -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. +=item show -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. +Show the hints (the default mode). -=head2 help +=item mark -Gives you online help for the command or help topic specified. +Do not show the hints themselves, but notify you when a hint would have +been available. + +=item hide + +Hide all hints: You will not be able to tell whether there is a hint +available or not. + +=back =head2 hiscore @@ -283,23 +299,23 @@ =head2 ignore + ignore list + +Lists all players that you currently ignore. + ignore [timeout] This command ignores the specified messages (B ignores tells, -B ignores chat and shout and all ignores everything from the given +B ignores chat and shout and B ignores everything from the given user). -The optional timeout (specified in hours) specifies then the ignore entry -expires. The default is 24 (one day). The reason why all ignores expire -after a day by default is that most troublemakers stop soon after they are -being ignored. +The optional timeout (specified in hours) specifies when the ignore entry +expires. The default is 24 (one day). The reason why all ignore entries +expire after a day by default is that most troublemakers stop soon after +they are being ignored. 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 @@ -308,9 +324,9 @@ inventory Inventory: - - arrow 0.1 - - Knife * 2 - - long sword (wielded) 15 + - arrow 0.1 + - Knife * 2 + - long sword (wielded) 15 This shows that you have one arrow which weighs 0.1kg and one Knife which you protected from dropping by locking it as well as a long sword which you are @@ -344,57 +360,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 + 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 mouse 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'. -=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. - -'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 @@ -403,26 +390,10 @@ instantaneously. If a name is specified then only pets with that -name will be killed, eg killpets bat will kill bats +name will be killed, e.g. killpets bat will kill bats but not bees. If a number is specified, the pet corresponding to that number is killed. -=head2 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". - 1 - Only messages that have to do with yourself. - 2 - Emergency calls from other users - 10 - General chatter with the 'chat' command. - 11 - See what players kill what monster with what attack/spell. Very - verbose - only for the fanatics. - -=head2 logs - -TODO - =head2 mapinfo Shows some information about the map like this: @@ -441,17 +412,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: + 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. Some +maps will never reset in the common sense, these are usually marked with a +very high number (such as C<1e+99>). + +=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 +468,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 +478,35 @@ 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 independently. The +default value is usually less than a second. + See also L. +=head2 output-rate + + output-rate [bytes per second] + +Show the current setting of the output-rate, or set it to the provided +value. The server will try very hard not to send 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. If the +server is running on a Linux kernel, it will adjust to the actual +bandwidth available, and output-rate only sets an upper bound. That is, +the server will automatically set an optimal send rate and adjusting your +output-rate is not required. + =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). +buffer has its own time value, and will be flushed independently. The +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 @@ -604,7 +544,7 @@ =head2 peaceful -TODO: rework for cf.schmorp.de, intended future behaviour is to toggle +TODO: rework for deliantra, intended future behaviour is to toggle peaceful mode with regards to npc and monsters only, not with regards to players (which will be controlled by priests). @@ -626,7 +566,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. @@ -685,27 +625,13 @@ Density 10 will pickup silver, gold, rings, wands, books, and scrolls. Artifacts are also picked up. + =head2 prepare The same as cast. Usage: prepare -=head2 quests (|finished|.*) - -The quests command lists the quests you are doing or have completed. - -Parameters are: - -=over 4 - -=item no arguments: displays current quests. - -=item B: displays finished quests; - -=item anything else: displays details for quests (finished or not) with name containing the given string. - -=back =head2 quit @@ -714,6 +640,7 @@ bed (probably in a building close to where you entered the game), get on top of it, and apply it using B ro the B command. + =head2 range Your range weapon can be one of several weapons, a spell you cast, a @@ -722,29 +649,35 @@ Your range weapon is fired when you press SHIFT-direction, and will be fired in that direction. -=head2 rename -Changes the custom name of an item. +=head2 ready_skill - rename to + ready_skill -(Note: the angle brackets (<>) are mandatory and part of the syntax) +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. -If '' is omitted, defaults to marked item. +If you just want to invoke a skill once, leaving your range slot +untouched, use L instead. -If 'to ' is omitted, clears the custom name. -Note: maximum allowed name length is 127 characters. +=head2 rename + +Changes/removes the custom name of given item (or the marked one). + + rename oldname to newname + rename "old item name" to "new item name" -=head2 reply +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. - reply +If the new name is empty (i.e. C<"">), then the original (before the +rename) name will be restored. + +Note: maximum allowed name length is 127 characters. -Similar to tell, but instead of having to supply a username, it replies -to the last player that sent you a tell. This is a bit racy (e.g. when -somebody else tells you something while you type and you do not realise -that), so be careful not to supply confidential information in the -message. =head2 resistances @@ -806,10 +739,9 @@ 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. 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 @@ -844,7 +776,7 @@ If sort_inventory is not set (default), items will be inserted via type, subtype and magic. This, all axes will be grouped together in magic order, -all daggers by magic order, etc. Unforunately, for scrolls and rings, new +all daggers by magic order, etc. Unfortunately, for scrolls and rings, new ones just get inserted last. If you have a lot of stuff that is not in alphabetical order but you would @@ -853,9 +785,22 @@ =head2 sound Toggles between sound enabled and disabled. This has no relevance to the -sound settings of the client, it only governs wether the server will send +sound settings of the client, it only governs whether the server will send sound effect command to the client and is enabled if the client supports -sound (i.e. always for cfplus). +sound (i.e. always for the deliantra client). + +=head2 sourcecode + +This command displays the means to download the source code (server code, +maps and archetypes) used to implement this version of the game. + +Every player has the right to download and modify the source code of the +server, as required by both the GNU General Public License and the GNU +Affero General Public license. + +If you modify your version of the server, you will have to provide a means +to download the modified sources (and resources) via this command. If you +run an unmodified version of the server, the default will do. =head2 statistics @@ -915,7 +860,7 @@ =head2 time -Shows the Crossfire in-game time, not the server time. It looks like this: +Shows the Deliantra in-game time, not the server time. It looks like this: It is 52 minutes past 8 o'clock am, on the Day of the Bull The 2nd Day of the Month of the Frost Giant, Year 63 @@ -926,37 +871,32 @@ =head2 title -Players can change their title. For example you called yourself Gandalf and -your race is elf, you can use the title command to change your name from -"Gandalf the elf" to "Gandalf the white". Usage: - title title clear # Sets your title back to your race. +Players can change their title. For example you called yourself Gandalf and +your race is elf, you can use the title command to change your name from +"Gandalf the elf" to "Gandalf the white" by using C. + Dragons cannot set their title because it changes during the game. -=head2 traps +=head2 unignore -ERROR: not a command, but another help topic => move to a different file maybe? + unignore <login> -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. +Cancels all ignores set for the specified login. See B<ignore>. -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' +=head2 uptime -=head2 unignore +Tells you something about the time the server was started and how long ago +that was. - unignore <login> +=head2 use_skill -Cancels all ignores set for the specified login. See B<ignore>. + use_skill <name of skill> + +Uses the given L<skill|pod/skill_help> immediately, once. See also +L<ready_skill>. =head2 usekeys (inventory|keyrings|containers) @@ -964,14 +904,18 @@ Values are: -inventory: Only keys in the top level inventory are used (default) +=over 4 + +=item B<inventory>: Only keys in the top level inventory are used (default) + +=item B<keyrings>: Only keys in active key rings are used. -keyrings: Only keys in active keyrings are used. +=item B<containers>: Only keys in active containers are used. -containers: Only keys in active containers are used. +=back -Note that keyrings are just a specialized container, so the containers -will also find keys in keyrings. +Note that key rings are just a specialized container, so the containers +will also find keys in key rings. Only active containers are used - keys will not jump out of closed containers, but hints will be given if you have keys in such containers. @@ -998,7 +942,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<title> 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,11 +954,12 @@ 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 -help files with unknwon authors. +help files with unknown authors. -Adapted for use by I<cfplus>, enhanced and corrected by Pippijn van +Adapted for use by I<deliantra>, enhanced and corrected by Pippijn van Steenhoven and Marc A. Lehmann.