--- deliantra/server/pod/command_help.pod 2007/01/05 22:46:39 1.5 +++ deliantra/server/pod/command_help.pod 2008/12/28 10:20:29 1.20 @@ -6,7 +6,7 @@ *** =end comment -=head1 Crossfire+ Command ListingX +=head1 Deliantra Command ListingX =head2 accept-invitation @@ -36,7 +36,7 @@ =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: @@ -79,13 +79,13 @@ =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 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: @@ -120,32 +120,32 @@ 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 Xdrop (all|unpaid|cursed|unlocked|.*) @@ -159,21 +159,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 @@ -185,6 +177,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] @@ -262,28 +270,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 -ERROR: not a command, but another help topic => move to a different file maybe? +Gives you online help for the command or help topic specified. -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. +=head2 hintmode (show|mark|hide) -If you have a golem in control your spell type will be listed as golem, -with the creature name in parantheses. + hintmode show|mark|hide -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. +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: -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. +=over 4 -=head2 help +=item show -Gives you online help for the command or help topic specified. +Show the hints (the default mode). + +=item mark + +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 @@ -298,13 +314,13 @@ 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. @@ -316,9 +332,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 @@ -352,54 +368,23 @@ =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 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'. -'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 @@ -413,28 +398,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 - -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: @@ -453,8 +420,6 @@ =head2 maps -[crossfire+] - maps Shows a list of maps matching the regex that are currently being @@ -469,7 +434,7 @@ 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. +currently being loaded, but that's rare, as loading a map is fast. =item Svd: the amount of seconds the map was last saved (++ means >99). @@ -480,7 +445,9 @@ =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. +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. @@ -509,84 +476,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 @@ -594,13 +486,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 @@ -638,7 +552,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). @@ -688,58 +602,36 @@ =head2 pickup -B changes how you pick up items when you step on them. to pickup -an item manually, use the ',' key. - -Mode 0: Don't pick up items. - -Mode 1: Pick up one item - -Mode 2: Pickup up one item and stop - -Mode 3: Stop before picking up items - -Mode 4: Pick up all items - -Mode 5: Pick up all items and stop - -Mode 6: Pick up all magical items - -Mode 7: Pick up all coins and gems - -Modes above 7: Pickup items with -a value density greater than the pickup mode. - -Value density is value in gold/weight in kilograms. + pickup +mode + pickup -mode + pickup density + +B changes whether you pick up items when you step on them. To +pickup an item manually, use the ',' key. + +The B tab in the playerbook is usually a better way to modify your +autopickup settings than using this command. + +Mode can be one of: + + "debug", "inhibit", "stop", "food", "drink", "valuables", "bow", + "arrow", "helmet", "shield", "armour", "boots", "gloves", "cloak", + "key", "missile", "allweapon", "magical", "potion", "spellbook", + "skillscroll", "readables", "magicdevice", "notcursed", "jewels", + "flesh" + +If a number (C) is specified, then items of at least the +specified value density are picked up. Value density is given as +gold/weight in kilograms. The value in gold is what the item is worth if you sold it in the shop. -Goldcoins have a value density of 66, - -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 Xquests (|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 @@ -748,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 @@ -756,6 +649,7 @@ Your range weapon is fired when you press SHIFT-direction, and will be fired in that direction. + =head2 ready_skill ready_skill @@ -767,6 +661,7 @@ If you just want to invoke a skill once, leaving your range slot untouched, use L instead. + =head2 rename Changes/removes the custom name of given item (or the marked one). @@ -778,20 +673,11 @@ otherwise you can just write the name as-is. If you omit the old name, the marked item will be used instead. -If the new name is empty (i.e. C<"">), then the original (unrenamed) name -will be restored. +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. -=head2 reply - - reply - -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 @@ -838,9 +724,14 @@ search-items -Automatically picks up all items with in their name. search-items rod -will pick up all rods and heavy rods. search-items of Fire will pick up all -bolts, arrows, swords, etc. of Fire. +Automatically picks up all items with in their name. C will pick up all rods and heavy rods. C will +pick up all bolts, arrows, swords, etc. of Fire, C +will pick up all items with magic+1, and so on, and so on. + +While this mode is active, you will be slower and the normal autopickup is +disabled. To disable search mode again, execute C without +any arguments. =head2 seen @@ -853,8 +744,7 @@ shout -Sends a message to all players on the server that have -L level B<10> or higher. It is mainly useful for +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. @@ -891,7 +781,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 @@ -900,9 +790,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 @@ -926,7 +829,7 @@ This command might not look useful at first, but sometimes you can get yourself into a corner you can't escape anymore, either due to a map bug or your own stupidity. Killing oneself can be difficult and time -consuming, thats why this command is provided. It is fast, painless, +consuming, that's why this command is provided. It is fast, painless, effective, humane. =head2 take @@ -962,42 +865,32 @@ =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 - Time of Year: The Season of New Year + 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. + Time of Year: The Season of New Year. -It is partially just for fun but it affects the darkness outside and the -weather if weather is enabled in the server. +An hour of game time passes in 3 minutes of real time. The time and +calendar uses 60 minutes per hour, 28 hours per day, seven days per week, +five weeks per month, and 17 months per year. The year is additionally +split into four seasons of 4 months each, except the season of the +Blizzard, which is 5 months long. -=head2 title +The number "zero" is unknown, which is why the minutes go from 1 to 60. -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: +Seasons and the time of the day affect the overall outdoor daylight. + +=head2 title title title clear # Sets your title back to your race. -Dragons cannot set their title because it changes during the game. - -=head2 traps - -ERROR: not a command, but another help topic => move to a different file maybe? - -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. +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. -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' +Dragons cannot set their title because it changes during the game. =head2 unignore @@ -1023,14 +916,18 @@ Values are: -inventory: Only keys in the top level inventory are used (default) +=over 4 -keyrings: Only keys in active keyrings are used. +=item B<inventory>: Only keys in the top level inventory are used (default) -containers: Only keys in active containers are used. +=item B<keyrings>: Only keys in active key rings are used. -Note that keyrings are just a specialized container, so the containers -will also find keys in keyrings. +=item B<containers>: Only keys in active containers are used. + +=back + +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. @@ -1069,11 +966,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.