User Tools

Site Tools


player_commands

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
player_commands [2020/08/23 00:25]
leaf Document the dip command
player_commands [2024/03/29 00:23] (current)
leaf [follow] Summary update for accessing apartments
Line 16: Line 16:
   You are no longer AFK   You are no longer AFK
  
-The AFK status affects the output of the 'who command. ​ For example:+The AFK status affects the output of the 'who command. For example:
  
   Total Players in The World. (2) -- WIZ(0) AFK(1) BOT(0)   Total Players in The World. (2) -- WIZ(0) AFK(1) BOT(0)
Line 27: Line 27:
 Apply applies an object. Apply applies an object.
  
-If no options are given, it applies ​the first object you are standing on or in the open container (if any).+If no options are given, it applies ​to an object you are standing on.
  
-Consumable items will be used up (foodpotions, balms, etc.) Wearables (armor, weapons, wands, etc.) will toggle between applied/​unapplied state.+If a name follows the commandan object of that name is affected The name does not have to be complete as long as the text uniquely matches the first part of an item name.
  
-If an object name is given, it will apply that object. If more than one item matches the given name it will apply the first one it encounters. You may want to [[#rename]] your items conveniently. +Apply options:
- +
-Extra options ​to apply: +
-  * -a: Always applies the object (disabling toggle feature). +
-  * -u: Always unapplies the object (disabling toggle feature). Containers are opened if they were applied and closed if they were open. +
-  * -b: Only apply an item on the ground or in the open container. Containers on the ground switch between open and closed.+
  
 +  * -a: Always apply an object and never unapplies it when already applied.
 +  * -u: Always unapply an object and never apply it when already unapplied.
 +  * -o: Always open a container regardless of the previous state.
 +  * -b: Apply an item on the ground or in the active container, but not one in the character'​s main inventory.
  
 +As -a and -u do not toggle the applied status of an item, they are useful for making keybindings that work even when the current state of the object is unknown.
 ==== applymode ==== ==== applymode ====
  
Line 45: Line 45:
 The options are: The options are:
  
-  * nochoice: ​ In this case, if there is no choice for the item(s) being removed in order to equip your new item.  An example of this is a wand - there can only be one other item needed to be unequipped for the new item to be equipped. ​ Note that in the case of two handed objects, like bows, it can result in two (or more) items being unequipped to equip your new item. +  * nochoice: ​ In this case, if there is no choice for the item(s) being removed in order to equip your new item. An example of this is a wand - there can only be one other item needed to be unequipped for the new item to be equipped. Note that in the case of two handed objects, like bows, it can result in two (or more) items being unequipped to equip your new item. 
-  * never: In this case, it will never unequip something for you.  It will instead tell you want you need to unequip - this can be a list of many objects.+  * never: In this case, it will never unequip something for you. It will instead tell you what you need to unequip - this can be a list of many objects.
   * always: This will unequip whatever is needed to equip your new item.   * always: This will unequip whatever is needed to equip your new item.
  
 An example of how the above works: An example of how the above works:
  
-If your character currently has two ringsand tries to equip a third, the nochoice mode will print the two rings you currently have equipped. ​ The always mode will unequip one of the rings in your inventory. ​ The ring unequipped is fairly indeterminate - it depends on how the server has ordered your inventory (which is not the same as the order your window displays).+If your character currently has two rings and tries to equip a third, the nochoice mode will print the two rings you currently have equipped. The always mode will unequip one of the rings in your inventory. The ring unequipped is fairly indeterminate - it depends on how the server has ordered your inventory (which is not the same as the order your window displays).
  
 If your character is currently wearing a suit of armor, and you try to equip another suit, both nochoice and always will cause the new suit to get equipped. If your character is currently wearing a suit of armor, and you try to equip another suit, both nochoice and always will cause the new suit to get equipped.
 +
  
 See Also: [[player_commands#​apply]] See Also: [[player_commands#​apply]]
Line 59: Line 60:
  
 ==== bind ==== ==== bind ====
 +
 +The bind command is used to associate a skill or skills, action, command, alias, or shortcut to a keyboard key or key sequence (i.e., shift + F3).
  
 Syntax: Syntax:
   bind [-nfregc] <​command>​   bind [-nfregc] <​command>​
 +  ​
 Flags (default -nrf): Flags (default -nrf):
   * n - used in normal-mode   * n - used in normal-mode
Line 79: Line 83:
   * bind runkey1 - sets first runkey   * bind runkey1 - sets first runkey
   * bind runkey2 - sets second runkey   * bind runkey2 - sets second runkey
-  * bind [[player_commands#​prevkey|prevkey]] - shows last cmdline ​command from history +  * bind [[player_commands#​prevkey|prevkey]] - shows last commandline ​command from history 
-  * bind nextkey - when have used prevkey, goes forth in cmdline ​history+  * bind nextkey - when have used prevkey, goes forward ​in commandline ​history
  
 == Examples: == == Examples: ==
Line 87: Line 91:
 will typically mean that Shift-F3 is used to select that spell (Shift being the fire key) will typically mean that Shift-F3 is used to select that spell (Shift being the fire key)
  
-  bind use_skill sense curse; use_skill sense magic (S+  bind use_skill sense curse; use_skill sense magic (f
-will bind those two commands to the key.+will bind those two commands to the key.
  
 The keybindings are stored in the [[:​client:​keys]] file inside the hidden **.**[[:​client:​crossfire]] directory of your HOME folder. \\ The keybindings are stored in the [[:​client:​keys]] file inside the hidden **.**[[:​client:​crossfire]] directory of your HOME folder. \\
Line 99: Line 103:
 ==== body ==== ==== body ====
  
-Displays three columns of information about the character'​s body notably slots where equipment may be applied.+Syntax: 
 + 
 +  body 
 + 
 +Displays three columns of information about the character'​s body and notably slots where equipment may be applied. 
 The first column is the name of the body location. The first column is the name of the body location.
 The second column is how many of those locations your body has. The second column is how many of those locations your body has.
Line 119: Line 128:
   around your legs                   ​2 ​    2   around your legs                   ​2 ​    2
  
-FIXME - clarify documentation here and in the server help ​Server help does not existbut the command outputs help when it is run.+From the example above, this character is NOT wearing anything on their feet (i.e., no boots) and not wearing anything on their legs (i.eno pants).
  
 ==== bowmode ==== ==== bowmode ====
Line 129: Line 138:
   * Normal: As you would expect.   * Normal: As you would expect.
   * Threewide: Fires three arrows in parallel.   * Threewide: Fires three arrows in parallel.
-  * Spreadshot: Fires three arrows ​which spread out over distance. +  * Spreadshot: Fires three arrows ​that spread out over distance. 
-  * Fire<​direction>: ​ Locks in the direction the missiles will fire,  specify by compas position: ​ firenorth, firene, fireeast, firese, firesouth, firesw, firewest, firenw +  * Fire<​direction>: ​ Locks in the direction the missiles will fire, specify by compas position: ​ firenorth, firene, fireeast, firese, firesouth, firesw, firewest, firenw 
-  * Bestarrow: Selects and fires the probable best arrow for from your inventory.+  * Bestarrow: Selects and fires the probable best arrow from your inventory.
  
 ==== brace ==== ==== brace ====
  
-When you enter the '​brace'​ command to brace your character, your character will no longer move. \\ +When you enter the '​brace'​ command to brace your character, your character will no longer move. You can still attack adjoining spaces. Bracing can be useful to hold a location.
-It can still attack adjoining spaces. ​\\ +
-Bracing can be useful to hold a location.+
  
-When you are braced, you lose your [[:​characters:​dex]] bonus and incur a 2 point [[:​characters:​ac]] penalty beyond that (if you have a negative dex bonus, you may in fact come out ahead. ​\\  +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 [[:​characters:​wc]] (to hit) penalty.  ​+ 
 +You also only get 20% of the normal experience for killing creatures, and incur a 4-point wc (to hit) penalty.  ​ 
 + 
 +See also [[:​characters:​braced]]
  
-See also [[:​characters:​braced]] . 
 ==== cast ==== ==== cast ====
  
Line 153: Line 162:
 sets your RANGE weapon to '​spell:​ burning hands' sets your RANGE weapon to '​spell:​ burning hands'
  
-If you don't know the spell, ​shows which spells you do  know.+If you don't know the spell, ​the command output will show which spells you do know.
  
-It is helpful to bind strings like 'cast burning hands' to keys.  see 'help bind'+It is helpful to bind strings like 'cast burning hands' to keys. 
  
-'​help ​[[player_commands#​range]] +See Also: [[player_commands#​bind]]\\ 
-for more information ​on range weapons.+See Also: [[player_commands#​range]]\\ 
 +See Also: [[player_commands#​invoke]] 
 + 
 +==== chat ==== 
 + 
 +Sends a message to all players ​on the server. 
 + 
 +NOTE: Dialog with NPCs, they will only use and respond to the say command, so make sure to reference that when interacting with them. 
 + 
 +See Also: [[player_commands#​say]]\\ 
 +See Also: [[player_commands#​tell]]\\ 
 +See Also: [[player_commands#​shout]]
  
 ==== clearinfo ==== ==== clearinfo ====
 +
 +Usage: clearinfo
  
 Cause all text (chat, shouts, attack and action information,​ et al.) displayed in the client to be removed or purged. Cause all text (chat, shouts, attack and action information,​ et al.) displayed in the client to be removed or purged.
  
-Client-specific command: gtk-v2, gtk, <​del>​x11</​del>​+Client-specific command: gtk-v2
  
-FIXME - clarify documentation ​here and in the server ​help.+FIXME - clarify documentation
 + 
 +==== death ==== 
 + 
 +Death is not the final end for your character! 
 + 
 +When your character reaches -1 hit points or less, they experience death in the game. 
 + 
 +The first effect of death is, they are automatically transported back to their last used savebed (bed to reality). Pretty much means they are safely removed from the danger of the attacking monster or trap.  Careful of your own spells though! 
 + 
 +Next, your character has lost some percentage of experience points in all skills. This amount will vary by server configuration. 
 +The only way to restore the lost experience is to regain it by slaying monsters, disarming traps, using spells to slay monsters, etc. 
 + 
 +Your character has also lost stat (as in Str, Dex, Con, etc.) points. More stats are lost at higher character levels. But, this can vary based on server settings. 
 +Don't worry, this stat loss is not permanent. You can restore the lost stats in a couple of ways. 
 + 
 +One way is to consume a Potion of Life which can be found in various shops (Such as House of Healing in Scorn), as quest rewards, or as random treasure. Which type of Potion of Life you need will depend on your character level. 
 + 
 +High-level characters will need a Supreme Potion of Life while a low-level character will need a Minor Potion of Life. A single potion will restore any and all lost stats from any and all character deaths they accumulated. 
 + 
 +Another way to restore lost stats is if you have the Praying skill, at a certain level in that skill, and follow a cult that grants Restoration. 
 +That means, having your character pray long enough on your cult's altar can eventually restore all the lost stats from all deaths. 
 + 
 +==== delete ==== 
 + 
 +The delete command will permanently delete the active character (or, who you are logged in as) from the server. 
 + 
 +Usage 
 +  delete 
 + 
 +When the command is executed, you will be prompted with a yes or no response to confirm character deletion. 
 + 
 +Hit '​y'​ to proceed with the character removal 
 +Hit '​n'​ to cancel the process 
 +Hit enter again to exit the process and you will see a message "OK, continuing to play."​ 
 + 
 +The JX Client will display a popup window to ask you to hit y or n. The GTKv2 Client asks y or n in the Messages window. 
 + 
 +This will not delete your login account or any of your other characters associated with your player account, just the active character file along with any of their apartments and the content of those unique maps. 
 + 
 +NOTE: On older servers, this command does not exist. The delete command was added to avoid confusion with the quit command which back then was used to purge the active character file in those older servers. 
 + 
 +See also: [[player_commands#​quit|quit]]
  
 ==== dip ==== ==== dip ====
Line 174: Line 238:
 Lore Lore
  
-Travelers refilling their empty bottles at fountains around the world often claim that water from their home town tastes the best. This apparent conundrum was settled by leading alchemists from Nurnberg, who found no material differences between bottles of water collected from various fountains around the world.+Travelers refilling their empty bottles at fountains around the world often claim that water from their hometown ​tastes the best. This apparent conundrum was settled by leading alchemists from Nurnberg, who found no material differences between bottles of water collected from various fountains around the world.
  
 Still, this was not enough reason to sway the fanciful; some claim that fantastic things happen when they '​dip'​ their empty bottles or other belongings into fountains. Still, this was not enough reason to sway the fanciful; some claim that fantastic things happen when they '​dip'​ their empty bottles or other belongings into fountains.
Line 224: Line 288:
 ==== drop ==== ==== drop ====
  
-Drop usage:+The "​drop"​ removes objects from the player'​s inventory and puts them on the floor or in an opened container.
  
-  'drop [number] name+Multiple formats are possible. 
 + 
 +  ​drop [number] name 
 + 
 +name is the name of the item(s) to drop. It may match multiple items. The name is matched against the start of the objects in your inventory. The name matching is case insensitive.
  
-name is the name of the item(s) to drop.  It may match multiple items. The name is matched against the start of the objects in your inventory. The name matching is case insensitive. 
  
 == There are a few special name values: == == There are a few special name values: ==
Line 234: Line 301:
   * all - matches any item.   * all - matches any item.
   * unpaid - matches unpaid items   * unpaid - matches unpaid items
-  * cursed - drops items known to be cursed or damned.+  * cursed - drops items known to be cursed or damned
   * unlocked - drops items not locked in your inventory   * unlocked - drops items not locked in your inventory
  
-number is optional. ​ This acts as the number of the object to drop. The objects ​number must be at least the number for it to be dropped. For example, if you do 'drop 10 scroll',​ only groupings of 10 or more scrolsl ​will be dropped. ​ A collection of 5 scrolls will not be dropped.+number is optional. This acts as the number of the object to drop. The object'​s ​number must be at least the number for it to be dropped. For example, if you do 'drop 10 scroll',​ only groupings of 10 or more scrolls ​will be dropped. A collection of 5 scrolls will not be dropped
 + 
 +  drop * <item type> 
 + 
 +Drop all items of the specified type. Types are the same as the "​pickup"​ command. 
 + 
 +  drop # <item index> 
 + 
 +Drop the item at the specified index. Index 1 is the last item taken, and so on.
  
 See also '​[[player_commands#​dropall]]'​ and [[player_commands#​mouse|mouse button control]] within client for dropping objects. See also '​[[player_commands#​dropall]]'​ and [[player_commands#​mouse|mouse button control]] within client for dropping objects.
Line 243: Line 318:
 ==== dropall ==== ==== dropall ====
  
-DROPALL help:+Syntax:
  
-dropall [type]+  ​dropall [type] 
 +   
 +The dropall command drops all items in your inventory to the ground, except locked items. The type parameter will also control what is dropped:
  
-dropall ​drops all items in your inventory to the groundexcepting locked items. ​ The type parameter will also control what is dropped:+  * '​empty'​ (e.g., nothing specified): ​drops all objects except foodmoney, keys, and containers 
 +  * weaponsdrops weapons, bows, and arrows 
 +  * armor (armor): drops armor, shield, and helmets 
 +  * misc: drop horns, books, girdles, amulets, rings, cloaks, boots, gloves, bracers, scrolls, wands, rods, and potions 
 +  * food: drops food and drink 
 +  * flesh: drops all flesh
  
-  * '​empty'​ (eg, nothing speciified) - drops all objects except food, money, keys, and containers. +See also [[player_commands#​drop|drop]] and mouse button control ​within the client ​for dropping objects
-  * weapons - drops weapons, bows, and arrows. +
-  * armor (armour) - drops armor, shield, and helmets. +
-  * misc - drops horns, books, girdles, amulets, rings, cloaks, boots, gloves, bracers, scrolls, wands, rods, and potions. +
- +
-See also 'drop' ​and mouse button control for dropping objects.+
  
 ==== empty ==== ==== empty ====
  
-Usage: +Empty will put all contents of the specified container either on the ground or in your opened container.
-  empty item+
  
-//item// should be a container.+  Syntax: empty <item>
  
-If "​all"​ is specified, all containers are emptied.+<​item>​ should be a container. 
 + 
 +If "​all"​ is specified ​(i.e., empty all), all containers are emptied.
  
 ==== examine ==== ==== examine ====
  
 Usage: Usage:
-  examine 
-  examine item 
  
-Show detailed information about an item.  ​If the item is not specified, the information will be about an item the character is standing on. + ​examine 
-If //item// is specified, information about one thing is shown.  //item// may be a partial match. ​ Ie. //examine ​scrol// ​shows information about a scroll+ ​examine item 
 + 
 +Show detailed information about an item 
 + 
 +If the item name is not specified, the information will be about an item the character is standing on 
 + 
 +If the item name is specified, information about one item is shown 
 + 
 +The item name may be a partial match. ​For instance, ​examine ​scroll ​shows information about a scroll
  
 ==== explore ==== ==== explore ====
Line 281: Line 365:
 This command must be enabled by a crossfire server administrator. ​ The default settings leave this command disabled such that the server responds //Explore mode is disabled on this server, sorry.//. This command must be enabled by a crossfire server administrator. ​ The default settings leave this command disabled such that the server responds //Explore mode is disabled on this server, sorry.//.
  
-FIXME - Add documentation here and in the server help.+==== face ==== 
 + 
 +Usage: 
 +  face <​direction>​ 
 + 
 +face <​direction>​ changes ​the direction you are facing without taking any other action.
  
 ==== fire ==== ==== fire ====
  
-Turns on fire mode.  Normally this is done automatically when using the fire key + direction combination. ​ However, it is possible to invoke it manually, in which case the character will commence firing as quickly as possible in whatever direction is specified after the command is issued, either by the arrow keysor by typing it out.+Turns on fire mode. Normally this is done automatically when using the fire key + direction combination. However, it is possible to invoke it manually, in which case the character will commence firing as quickly as possible in whatever direction is specified after the command is issued, either by the arrow keys or by typing it out.
  
-To cease fireuse the command fire_stop.+To fire only once you can use <​direction ​command> f. 
 +For example: "fire 1" starts to fire northeast until "fire_stop". The command "​northeast f" fires once to the northeast.
  
-To make a script or keybinding fire a single time in a particular direction, prefix the direction to the fire command. ​ ​Exemplia gratia"east fire"+Use "stay f" to target yourself. 
 + 
 +You can turn off the fire command with fire_stop. 
 +To make a script or keybinding fire a single time in a particular direction, prefix the direction to the fire command. ​For instanceeast fire” 
 + 
 +See Also: [[player_commands#​fire_stop|fire_stop]]
  
 ==== fire_stop ==== ==== fire_stop ====
  
-Cancels fire mode.  Normally this is done automatically when using the fire key+direction combination. ​ However, if one's character becomes stuck in fire mode, issuing this command should return it to normal.+Usage: 
 + 
 +  fire_stop 
 + 
 +Cancels fire mode. Normally this is done automatically when using the fire key+direction combination. However, if one's character becomes stuck in fire mode, issuing this command should return it to normal. 
 + 
 +Especially useful when using the fire command in scripts, to fire a skill like punching onto a spot, then the fire command should be terminated by fire_stop immediately. When a script exits then the player is still firing and they are in a distressed situation, it is very uncomfortable to type in fire_stop in the command line. 
 + 
 +See Also: [[player_commands#​fire|fire]]
  
-Especially when using the fire command in scripts, to fire a skill like punching onto a spot, 
-then the fire command should be terminated by fire_stop immediately. 
-When a script exits then the player is still firing and he is in a distressed situation, 
-it is very uncomfortable to type in fire_stop in the command line.  ​ 
 ==== fix_me ==== ==== fix_me ====
  
Line 305: Line 404:
 FIXME - Add documentation here and in the server help. FIXME - Add documentation here and in the server help.
  
 +
 +==== follow ====
 +
 +syntax: follow <player name>
 +
 +Follow another player, including through exits and into permanent apartments. The player you are following must be in the same party as you. You can only start following another player if they are adjacent to you. To stop following, type '​follow'​ without any arguments.
 +
 +The '​follow'​ command can be used with a willing party member to visit their permanent apartments. To prevent party members from following you, you must leave the party.
 +
 +==== forget_spell ====
 +
 +The forget_spell command will cause your currently logged-in character to permanently lose knowledge of the specified spell.
 +
 +Usage:
 +  forget_spell <spell name>
 +
 +Example:
 +  forget_spell light
 +
 +  You lose knowledge of light.
 +  ​
 ==== get ==== ==== get ====
  
Line 315: Line 435:
   get all   get all
   ​   ​
-FIXME - Add documentation in the server help+See Also: [[player_commands#​take|take]]\\ 
 +See Also: [[player_commands#​pickup|pickup]]
  
 ==== give ==== ==== give ====
  
 FIXME - Add documentation here and in the server help.  The give command is not listed by //help commands//​. ​ FIXME - Add documentation here and in the server help.  The give command is not listed by //help commands//​. ​
 +
 +==== golem ====
 +
 +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 parentheses.
 +
 +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.
 +
  
 ==== invoke ==== ==== invoke ====
Line 337: Line 469:
   c   c
  
-the c key now casts medium healing +the c key now casts medium healing instantly 
-instantly+ 
 +See Also: [[player_commands#​cast|cast]] 
  
 ==== killpets ==== ==== killpets ====
 +
 +Usage:
 +
 +  killpets
 +  kippets <​petname>​
  
 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 they had will be left behind, but you will get no experience for their death. ​ However, it kills them instantaneously. 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 they had will be left behind, but you will get no experience for their death. ​ However, it kills them instantaneously.
  
 If a name is specified then only pets with that name will be killed, eg killpets bat will kill bats but not bees. If a number is specified, the pet corresponding to that number is killed. If a name is specified then only pets with that name will be killed, eg killpets bat will kill bats but not bees. If a number is specified, the pet corresponding to that number is killed.
 +
 +==== knowledge ====
 +
 +Displays known relevant information.
 +
 +Without any parameter, displays this help text.
 +
 +When using  "​knowledge list", you can see all you know. An additional parameter can restrict the output to a specific knowledge type. The available types are:
 +  * alchemy
 +  * god
 +  * message
 +  * monster
 +
 +With "​knowledge show <​number>",​ displays details about the specified item.
 +
 +With "​knowledge search <​text>",​ displays things having <​text>​ in summary or detail.
 +
 +With "​knowledge attempt <​number>",​ attempts to do alchemy or equivalent based on that recipe.
  
 ==== language ==== ==== language ====
  
-Lists the player'​s current language settings and the server supported settings.+Lists the player'​s current language settings and the server-supported settings.
  
   language   language
Line 364: Line 521:
     Your language setting has been changed to: English     Your language setting has been changed to: English
  
-If translations for particular language are missing or incomplete, ​english ​messages are output by default.+If translations for particular language are missing or incomplete, ​English ​messages are output by default.
  
 ==== listen ==== ==== listen ====
  
 Listen, sets the level of messages you will hear. Listen, sets the level of messages you will hear.
 +
 +Adjust the listening level to determine the messages visible to the player. Set it to 1 for only important messages, like when a player shouts, or choose 15 for verbose mode, displaying every message.
  
 If no parameters are set, the current listen level is shown: If no parameters are set, the current listen level is shown:
Line 383: Line 542:
  
 ==== lock ==== ==== lock ====
 +    ​
 +Toggle the lock status of an item inventory. Locked items cannot be accidentally dropped.
  
-Toggle the lock status ​of an item inventory. ​ Locked items cannot ​be accidentally ​dropped.+Usage: 
 + 
 +  ​lock <item name> 
 + 
 +<item name> can be either all or part of an item's name. If multiple items could meet the partial name's criteria, the first one encountered will be selected. 
 +It should be noted that the first item encountered in inventory may not correspond to the first item listed in the inventory ​window. 
 + 
 +Locked items need to be unlocked in order to be dropped. ​Using the locked command a second time on the same item name will unlock the item. 
 + 
 +Locked items appear with an asterisk (*) next to the item in your inventory view. 
 + 
 +  shield * 
  
 Specify the name of the item to lock or unlock as a parameter. Specify the name of the item to lock or unlock as a parameter.
Line 390: Line 562:
   lock   lock
     Lock what item?     Lock what item?
 +
   lock rucksack   lock rucksack
     Locked rucksack     Locked rucksack
 +
   lock rucksack   lock rucksack
     Unlocked rucksack     Unlocked rucksack
 +  ​
 +It is also possible to lock or unlock items by holding down the shift key and left-clicking with your mouse on the item or items in your inventory.
  
 +==== mapedit ====
 +
 +The '​mapedit'​ client command obtains the map the player is currently on using '​mapinfo'​ and launches the map editor given by the environment variable CF_MAP_EDITOR on the path.
 +
 +This is intended to make launching the map editor easier.
 +
 +This is a GTKv2 Client only command.
 +
 +==== mapinfo ====
 +
 +The command mapinfo gives information about the map you are currently on.
 +
 +Output format:\\
 +
 +<map name> (<map path>) in <map region>​\\
 +Created: <​date>​ <​developer name> [<​developer email>​]\\
 +[Modified: <​date>​ <​developer name> [<​developer email>​]]\\
 +
 +This information is predominantly used for bug reports and similar development operations.
 +
 +==== maps ====
 +
 +Use the maps command to check on whether or not a map or several maps are in use.
 +
 +Usage:
 +  maps
 +  maps <region short name>
 +  maps <partial file name>
 +  maps <partial folder path name>
 +
 +Examples: ​
 +
 +  'maps brest
 +  'maps shop
 +  'maps apart
 +
 +The headers shown are:
 +
 +  Current time is = current real time on the server
 +
 +  Path = the map file path on the server
 +  Reset In (HH:MM:SS) = real time on server when the map will reset
 +  Pl = players
 +  IM = in memory
 +  TO = timeout until the map is saved to disk
 +  ​
 ==== mark ==== ==== mark ====
  
-mark is used to mark items for items that apply other items. ​ Examples of these are flint & steel marked for apply torches, a weapon marked for improve weapon scrolls.+The command ​mark is used to mark items for items that apply to other items. Examples of these are flint & steel marked for applying ​torches, ​or a weapon marked for improve weapon scrolls
 + 
 +Examples of use: 
 + 
 +    mark sword +3 
 +    mark three torches 
 +    mark broadsword 
 + 
 +mark will look for the best match first and then look for matches based on shortened name, object name, or archetype name. It prints the match it finds.
  
 mark without options shows your currently marked item. mark without options shows your currently marked item.
  
-usage is as follows:+  '​mark 
 +    broadsword (wielded) ​is marked 
 + 
 +It is also possible to mark or unmark an item by holding down the shift key and middle-clicking with your mouse on the item in your inventory. 
 + 
 +==== melee ==== 
 + 
 +You fight to kill monsters. You can either use magic or weapons. 
 + 
 +To use weapons, simply wield a weapon (and wear armor!) 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 
 +     
 +See Also: [[player_commands#​spells|spells]]\\ 
 +See Also: [[player_commands#​range|range]]\\ 
 +See Also: [[player_commands#​cast|cast]]\\ 
 +See Also: [[player_commands#​invoke|invoke]] 
 + 
 +==== mode ==== 
 + 
 +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 
 + 
 +See Also: [[player_commands#​applymode|applymode]]\\ 
 +See Also: [[player_commands#​bowmode|bowmode]]\\ 
 +See Also: [[player_commands#​peaceful|peaceful]]\\ 
 +See Also: [[player_commands#​petmode|petmode]] 
 + 
 +==== motd ==== 
 + 
 +The command motd displays the server'​s Message Of The Day file 
 + 
 +==== mouse ==== 
 + 
 +The mouse is one possible way to move your character. But is primarily used to interface with objects and items in the game.  
 + 
 +In the map view: 
 +  * Left-click: shows what the distant object is by name  (i.e., sign or monster name) 
 +  * Middle-click:​ use an active range attack such as fire arrows or cast a spell in the direction you click relative to your character 
 +  * Right click on the map view and a yellow square will appear on the map, your character will attempt to move to that location by taking the shortest possible path.  
 +  * Right click on a monster and your character will attack that monster 
 + 
 +Also, the mouse has the following inventory uses: 
 +  * Left button: identify or examine the item 
 +  * Middle button on item: apply or equip or consume the item (i.e., eat food item, read a scroll or book or spellbook) 
 +  * Right button: drop the item(s) from your inventory to the ground or places the item(s) in an open or active container (i.e., pouch or chest or sack) 
 + 
 +The mouse command can use use keyboard commands for special applications in the Inventory window: 
 +  * Left button + shift key: lock or unlock a clicked inventory item, see lock 
 +  * Middle button + shift key: mark a clicked item (i.e., mark a torch & then apply flint and steel to light the torch), see mark 
 + 
 +The mouse has the following uses of items in the You see window: 
 +  * Left button: identify or examine the item 
 +  * Middle button: apply item (i.e., lever) if possible or applicable 
 +  * Right button: picks up the item(s) and adds it to your inventory 
 + 
 +See Also: [[player_commands#​lock|lock]]\\ 
 +See Also: [[player_commands#​mark|mark]]\\ 
 +See Also: [[player_commands#​apply|apply]]\\ 
 +See Also: [[player_commands#​drop|drop]]\\ 
 +See Also: [[player_commands#​get|get]]\\ 
 +See Also: [[player_commands#​take|take]] 
 + 
 +==== news ==== 
 + 
 +The news command will display the server news file. 
 + 
 +See Also: [[player_commands#​motd|motd]]\\ 
 +See Also: [[player_commands#​rules|rules]] 
 + 
 +==== nextkey ==== 
 + 
 +This bound key allows you to move back through your previously used commands. This works best if you already have a key bound to the command called prevkey. 
 + 
 +You can also edit the command from the prevkey command list before you run it. 
 + 
 +This is just like the down arrow under most command-line interfaces (CLI).
  
-  * mark sword +3 +Special note for GTKV2, one has to use the bind command (i.e., 'bind nextkey) as the the keybinding GUI does not work with this command.
-  * mark three torches +
-  * mark sword+
  
-mark will look for best match first, and then look for matches based on shortened name, object name, archetype name. It prints the match it finds.+See Also: [[player_commands#​prevkey|prevkey]]\\ 
 +See Also: [[player_commands#​bind|bind]]
  
 ==== output ==== ==== output ====
Line 425: Line 741:
  
 see [[player_commands#​output]] see [[player_commands#​output]]
 +
 +==== partial_commands ====
 +
 +Control whether commands can match partially or not.
 +
 +When disabled, a command must match exactly to be executed.
 +
 +When enabled, the first letters of a command are enough if there is no ambiguity with other commands.
 +
 +  Usage: partial_commands <1 or on, or 0 or off>
 +
 +Without any argument, the command displays the current status.
 +
 +Example:
 +  * when disabled, pe and pet are unknown commands
 +  * when enabled, pe is an unknown command, because it can mean peaceful or petmode, but pet will be equivalent to petmode
 +
  
 ==== party ==== ==== party ====
  
-  * party join partyname+The 'party' command enables the creation of adventurer groups.
  
-Puts you in party, prompts you for passwd if there is one+A group of adventurers shares gained experience between members and has private communication channel. You can't be member of multiple parties. Note that a party is not a guild.
  
-  * party form partyname+Party membership is not saved between sessions by default, but this behavior may be changed through the '​party_rejoin'​ command.
  
-Forms a party and puts you as leader, 32 character max. At the moment, being party leader does nothing. ​ May be used in the future.+  ​party join <​partyname>​
  
-  * party list+Puts you in a party, and prompts you for a password if there is one.
  
-Lists currently formed parties and their '​leader'​+  party form <​partyname>​
  
-  * party passwd <​password>​+Forms a party and puts you as the leader, partyname has a maximum of 32 characters. At the moment, being a party leader does nothing. May be used in the future.
  
-Changes the passwd for the party you are in, 8 character max.+  ​party list
  
-  * party who+Lists currently formed parties and their '​leader'​.
  
-lists the members of the party you are in+  ​party passwd <​password>​
  
-  * party say <msg>+Changes the password for the party you are a member of, 8 character max.
  
-sends messsage to party members. One may also use [[player_commands#​gsay]] instead.+  ​party who
  
-  * party leave+List the members of the party you are in.
  
-takes you out of current party+  party say <​message>​ 
 + 
 +Sends the message to party members. 
 + 
 +  party leave 
 + 
 +Takes you out of the current party.
  
 ==== party_rejoin ==== ==== party_rejoin ====
Line 469: Line 808:
 ==== passwd ==== ==== passwd ====
  
-Change the character'​s ​password.+The passwd command allows you to change your server or game account ​password
  
-Command to request a password change. ​ Either enter a new password at the resulting prompt, or simply press <​Enter>​ to cancel. ​+Usage: 
 +  passwd
  
-  Password change. +It prompts you for your current password, ​your new password, and a confirmation of your new password.
-  Please enter your current password, ​or empty string to cancel. +
-   +
-  Password changed canceled.+
  
-FIXME - Add documentation here and in the server help.+Leaving any of these prompts blank cancels ​the password change operation.
  
 ==== peaceful ==== ==== peaceful ====
Line 484: Line 821:
 The '​peaceful'​ command will switch you between peaceful and hostile attack modes. The '​peaceful'​ command will switch you between peaceful and hostile attack modes.
  
-When peaceful is on you will not automatically attack other player ​when bumping into them and will do reduced damage against other players if you do attack them (friendly fire). Having peaceful mode on only lowers damage against other players, it has no effect on damage done to monsters or other NPCs, so it is generally advisable to remain in peaceful mode unless you are looking for trouble. It is still entirely possible to kill other players when in peaceful mode so you should still be careful when interacting with other players. Hostile mode (peaceful off) will enable melee combat when bumping into other players and does normal damage for other attacks as well.+Usage 
 +  peaceful 
 + 
 +When peaceful is on you will not automatically attack other players ​when bumping into them and will do reduced damage against other players if you do attack them (friendly fire). 
 + 
 +Having peaceful mode enabled ​only lowers damage against other players, it does not affect ​damage done to monsters or other NPCs, so it is generally advisable to remain in peaceful mode unless you are looking for trouble. 
 + 
 +It is still entirely possible to kill other players when in peaceful mode so you should still be careful when interacting with other players. 
 + 
 +Hostile mode (peaceful off) will enable melee combat when bumping into other players and does normal damage for other attacks as well.
  
-Damage done by area effect attacks like cone spells, explosive detonations,​ fireballs, poisons, cloud or swarm attacks, runes or disease ​are not modified by peaceful/​hostile mode.+Damage done by area effect attacks like cone spells, explosive detonations,​ fireballs, poisons, cloud or swarm attacks, runesor disease ​is not modified by peaceful/​hostile mode.
  
 **WARNING: Running around with hostile on means other players AUTOMATICALLY hit back when you bump them. If your low level character bumps into a high enough level melee character your character //will// die. Using hostile on servers that frown on player killing (PK) is just not smart and will likely result in your being banned from that server.** **WARNING: Running around with hostile on means other players AUTOMATICALLY hit back when you bump them. If your low level character bumps into a high enough level melee character your character //will// die. Using hostile on servers that frown on player killing (PK) is just not smart and will likely result in your being banned from that server.**
 +
 +FIXME - Add a help file for hostile? It is not an actual command, but is often referenced so might be a good idea to have an explanation on that command?
  
 ==== petmode ==== ==== petmode ====
  
 Petmode controls how your pets (charmed monsters) will behave. Petmode controls how your pets (charmed monsters) will behave.
 +
 +Usage
 +  petmode normal
 +  petmode sad
 +  petmode defend
 +  petmode arena
  
 == The options are: == == The options are: ==
Line 498: Line 852:
   * Normal: As you would expect.   * Normal: As you would expect.
   * SAD (Search and Destroy): Pets will roam and seek out things to attack.   * SAD (Search and Destroy): Pets will roam and seek out things to attack.
-  * Defend: ​ Pets will try to stay close and defend you.+  * Defend: Pets will try to stay close and defend you.
   * Arena: As normal, except that pets will attack other players in the arena.   * Arena: As normal, except that pets will attack other players in the arena.
 +
 +FIXME - improve summary of petmode normal
  
 ==== pickup ==== ==== pickup ====
  
-To pickup items manually, use the ','​ key, or see the player commands [[player_commands#​get|get]] and [[player_commands#​take|take]].+The pickup ​command changes how you pick up items when you step on them.
  
-The pickup ​command configures if a character automatically picks items up when stepping on them, and configures what kinds of items are automatically picked up.+To pickup items manuallyuse the ','​ (comma) key, or see the player commands [[player_commands#​get|get]] ​and [[player_commands#​take|take]].
  
   * Mode 0: Don't pick up items.   * Mode 0: Don't pick up items.
-  * Mode 1: Pick up one item  +  * Mode 1: Pick up one item 
-  * Mode 2: Pick up one item and stop+  * Mode 2: Pickup ​up one item and stop
   * Mode 3: Stop before picking up items   * Mode 3: Stop before picking up items
   * Mode 4: Pick up all items   * Mode 4: Pick up all items
Line 515: Line 871:
   * Mode 6: Pick up all magical items   * Mode 6: Pick up all magical items
   * Mode 7: Pick up all coins and gems   * Mode 7: Pick up all coins and gems
-  * Modes above 7: Pick up items with a value density greater than the pickup mode.+ 
 +Modes above 7: Pickup ​items with a value density greater than the pickup mode.
  
 Value density is value in gold/weight in kilograms. Value density is value in 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.+The value in gold is what the item is worth if you sold it in the shop. 
 + 
 +Gold coins have a value density of 66, 
 + 
 +Density 10 will pickup silver, gold, rings, wands, books, and scrolls. Artifacts are also picked up. 
 + 
 +You can also use the syntax '​pickup +<​type>'​ to just add the specified type to what you pickup. 
 + 
 +Valid types are: 
 +  - debug: used in case of troubles only 
 +  - inhibit: if chosen, then no object is ever picked up 
 +  - stop: if chosen, you will stop moving instead of picking up items 
 +  - food 
 +  - drink 
 +  - valuables 
 +  - bow 
 +  - arrow 
 +  - helmet 
 +  - shield 
 +  - armour 
 +  - boots 
 +  - gloves 
 +  - cloak 
 +  - key 
 +  - missile 
 +  - melee 
 +  - magical 
 +  - potion 
 +  - spellbook 
 +  - skillscroll 
 +  - readables 
 +  - magicdevice 
 +  - notcursed 
 +  - jewels 
 +  - flesh 
 +  - container 
 +  - cursed 
 + 
 +Three options are possible for the first character: + will make you pick the item type, - will make you stop picking the item type and ! will toggle the pick mode. 
 + 
 +See Also: [[player_commands#​get|get]]\\ 
 +See Also: [[player_commands#​take|take]]
  
 ==== prepare ==== ==== prepare ====
Line 525: Line 923:
 The prepare command is identical to the [[player_commands#​cast|cast]] command. The prepare command is identical to the [[player_commands#​cast|cast]] command.
  
 +You use the prepare command to set your range to the spell you want.
 +
 +== Example: ==
 +
 +  '​prepare burning hands
 +
 +sets your RANGE weapon to '​spell:​ burning hands'
 +
 +If you don't know the spell, the command output will show which spells you do know.
 +
 +It is helpful to bind strings like '​prepare burning hands' to keys. 
 +
 +See Also: [[player_commands#​cast|cast]]\\
 +See Also: [[player_commands#​bind]]\\
 +See Also: [[player_commands#​range]]\\
 +See Also: [[player_commands#​invoke]]
  
 ==== prevkey ==== ==== prevkey ====
  
-Provides the last command input made. This is just like the up arrow under most command line interfaces (CLI).+Provides the last command input made and allows you to cycle through numerous previously entered commands 
 + 
 +So if you wanted to run the second to last command you just ran, just hit this bound key twice and then hit Enter. 
 + 
 +You can also edit the command before you run it. 
 + 
 +This is just like the up arrow under most command-line interfaces (CLI). 
 + 
 +Special note for GTKV2, one has to use the bind command (i.e., 'bind prevkey) as the the keybinding GUI does not work with this command. 
 + 
 +See Also: [[player_commands#​nextkey|nextkey]]\\ 
 +See Also: [[player_commands#​bind|bind]]
  
-FIXME That command was introduced / scrapped in which version of the client ? 
 ==== printlos ==== ==== printlos ====
  
-Output a table that indicates Line-Of-Sight around the character. ​ ​Show ​a grid of map squares the character can see through (//0//) and cannot see through (//1//).+Output ​shows a table that indicates Line-Of-Sight around the character. 
 + 
 +The command shows a grid of map squares the character can see through (//0//) and cannot see through (//1//). 
 + 
 +Example output:
  
       0 1 2 3 4 5 6 7 8 91011121314151617       0 1 2 3 4 5 6 7 8 91011121314151617
Line 557: Line 985:
 The character is standing at row 10, column 8. The character is standing at row 10, column 8.
  
-FIXME - Add documentation here and in the server help.+==== quest ====
  
 +The quest command displays quest-related information.
  
 +Usage:
 +  * quest list
 +  * quest list all
 +  * quest info
 +
 +Available sub-commands:​
 +  * list: displays quests you are currently doing
 +  * list all: displays quests you completed
 +  * info: displays information about the specified (by number) quest
  
 ==== quit ==== ==== quit ====
  
-**WARNINGThe //'quit// command will delete your character!**+CRITICALIf using a game client and/or server compiled or released before 2019-Dec-27,​ the quit command will permanently ​delete your game character!
 + 
 +The quit command will exit or close out your game client session. 
 + 
 +Usage: 
 +  ​quit 
 +  
 +GTKv2 CLient Usage: 
 +   File -> Quit 
 + 
 +When the quit command is used when logging back in you can find your character back at their last used save bed (aka Bed to Reality) or in the game map where you left the game at. This depends on how long you logged out of the game. 
 +  
 +WARNING: The map can reset while you were away and you may find yourself behind locked/​closed doors, and/or surrounded by monsters. 
 + 
 +To safely leave and log out of the game, you must use a 'Bed to Reality'​.  
 + 
 +Find a bed (probably in a building close to where you entered the game), place your character so they are "​standing"​ on top of it, and apply the bed using the apply command or hitting the '​a"​ (for apply) key. 
 + 
 +See Also: [[player_commands#​apply|apply]]\\ 
 +See Also: [[player_commands#​delete|delete]] 
 + 
 +==== range ==== 
 + 
 +Your range weapon can be one of several weapons, a spell you cast, a bow-and-arrow,​ a rod, or a wand, to name a few. 
 + 
 +Your range weapon is fired when you press SHIFT+direction and will be fired in that direction.
  
-If you want to quit without deleting your character, you must use a 'Bed to Reality'​. ​ Find a bed (probably in a building close to where you entered the game), get on top of it, and Apply it using shift-A (capital A).+See Also: [[player_commands#​keys|keys]]\\ 
 +See Also: [[player_commands#​move|move]]\\ 
 +See also: [[player_commands#​cast|cast]]\\
  
 ==== ready_skill ==== ==== ready_skill ====
  
-ready_skill ​<skill name>+The ready_skill ​command will make the specified ​skill active for your next set of actions. The specified skill will be set as your active skill.
  
-Skill name may be the minimum unique identifier for the desired ​skill Eg, 'ready_skill ​alch' for alchemy.+Syntax: 
 +  * ready_skill <skill name> 
 +     
 +Example: 
 +  ready_skill ​punching
  
-This command places the named skill into the ready skill slot, and makes the skill slot active.  ​The skill may then be used via the fire key + direction combination.+The skill must be used by firing in a direction; ready_skill does not directly activate ​the skill.
  
-FIXME - Add documentation here and in the server help.+The result depends on the skill selected and what items are around you. 
 + 
 +See Also: [[player_commands#​skills|skills]]\\ 
 +See Also: [[player_commands#​use_skill|use_skill]]
  
 ==== rename ==== ==== rename ====
  
-Changes the custom name of an item.+The rename command gives a custom name to the specified ​item in your inventory.
  
 Syntax: Syntax:
  
-  ​rename <item name> to <new name>+    ​rename <item name> to <new name>
  
 (Note: <> are mandatory) (Note: <> are mandatory)
  
-If '<​item name>'​ is omitted, defaults to marked item.+Example: 
 +  * rename <​shield>​ to <​defense2>​ 
 +  * Your shield will now be called defense2 
 +   
 +If '<​item name>'​ is omitted, ​the rename command ​defaults to the marked item.
  
-If 'to <new name>' is omitted, clears the custom name.+Example: 
 +  * (mark the recently renamed shield called defense2 in your inventory) 
 +  * rename ​to <defense3> 
 +  * Your shield will now be called defense3 ​
  
-Note: maximum allowed ​name length ​is 127 characters.+If 'to <​new ​name>' ​is omitted, the rename command clears the custom name.
  
 +Example:
 +  * rename <​defense3>​
 +  * You stop calling your shield with weird names.
 +  * (The item is now shown as shield in your inventory again)
 +
 +Note: maximum allowed name length is for the new name is 127 characters.
 +
 +See Also: [[player_commands#​mark|mark]]
 +
 +==== report ====
 +
 +Report a bug or ask for help from a dungeon master.
 +
 +Usage: report <​description of issue>
 +
 +If enabled, this command sends a bug report or request for help to the dungeon masters. The report contains your character name, current map location, and issue description.
 +
 +If the command is not enabled, you will see:
 +  '​report'​ is not a valid command.
 +  ​
 ==== rotateshoottype ==== ==== rotateshoottype ====
  
-Cycle through all ranged attacks that are readied.  ​For example, if a spell has been prepared (cast), a bow equipped, a rod readied, etc., then //rotateshoottype// cycles through them to select which one will will be used when the player fires an attack.+The command allows your character to cycle through all ranged attacks that are readied. 
 + 
 +Usage: 
 +  rotateshoottype 
 +  * rotateshoottype - 
 +  * rotateshoottype + 
 +  * rotateshoottype [number] 
  
-An optional parameter may be specified.  ​For example//​rotateshoottype -// swaps the direction of the rotation //rotateshoottype// with no parameters is similar ​to //​rotateshoottype +//.+For instanceif a spell has been prepared (cast), a bow equipped, a rod readied, etc., then rotateshoottype ​cycles through them to select which one will will be used when the player fires an attack.
  
   apply bow   apply bow
Line 624: Line 1130:
     No ranged attack chosen.     No ranged attack chosen.
  
-FIXME Add documentation here and in the server help.+An optional parameter may be specified, such as (minus) or + (plus).
  
 +For example, rotateshoottype - swaps the direction of the rotation.
 +
 +rotateshoottype with no parameters is similar to rotateshoottype +.
 +
 +Example:
 +  rotateshoottype [number]
 +
 +[number] will rotate through the shoot-types for the designated number of iterations.\\
 +[number] can be positive or negative to affect the direction of rotation.\\
 +If [number] is greater than the number of shoot-types available, it will rotate as if [number] was -1.\\
 +If no [number] is provided, 1 is used as a default.
 +
 +==== rules ====
  
 +The rules command will display the server rules file.
  
 +See Also: [[player_commands#​news|news]]\\
 +See Also: [[player_commands#​motd|motd]]
  
 ==== run ==== ==== run ====
  
-"​Run"​ functions ​in two ways+The run command causes your character to run in a direction until instructed otherwise.
  
-1) When the "​run"​ command without any parameters is entered, the play enters run mode. The player will continually run in any direction pressed. ​Hitting ​wall will not end run modeTo stop this behavior use [[player_commands#​run_stop|run_stop]].+Run functions in two ways 
 + 
 +  - When the "​run"​ command without any parameters is entered, the play enters run mode. The player will continually run in any direction pressed. 
 +  - When the "​run"​ command is entered with parameter of 1 through 8 (e.g. "run 1") the player will begin running in the corresponding directionSee below.
  
-2) When the "​run"​ command is entered with a parameter of 1 though 8 (e.g. "run 1") the player will begin running in the corresponding direction. See below. 
  
   8 1 2   8 1 2
Line 645: Line 1169:
 "run 1" for example will begin running north. "run 1" for example will begin running north.
  
-When you hit a wall you will stop running.+Alternatively,​ "<​direction command> r" also can be used like the run command. For example, "​northeast r" will cause you to run northeast until another direction is supplied. 
 + 
 +If no direction is given, you will start to run in a direction starting with your next direction command. 
 + 
 +Hitting ​a wall will not end run mode. To stop this run behavior use [[player_commands#​run_stop|run_stop]].
  
-Additionally,​ depending on client implementation,​ you may stop running if you release the runkey ​(default "​control"​ key). See [[player_commands#​bind|bind]]. At time of writing the Java client seems to stop running when the runkey is released but the GTK client does not.+Additionally,​ depending on client implementation,​ you may stop running if you release the run key (default "​control"​ key). See [[player_commands#​bind|bind]].
  
-FIXME - Add documentation ​to the server help.+At the time of writing the JX Client seems to stop running when the run key is released but the GTK client does not.
  
 +See Also: [[player_commands#​bind|bind]]\\
 +See Also: [[player_commands#​run_stop|run_stop]]
  
 ==== run_stop ==== ==== run_stop ====
  
-Stop running.  See [[player_commands#​run|run]].+The run_stop command will make your character stop running ​when using the run command.
  
-FIXME - Add documentation in the server help.+See Also: [[player_commands#​run|run]]\\ 
 +See Also: [[player_commands#​bind|bind]]
  
 ==== save ==== ==== save ====
  
-No parameters. +The save command updates a character'​s ​status ​on the server ​disk
-Updates players ​status ​to disk. +
-This can be useful for making backup copies if you fear the server ​is about to crash.+
  
-WARNING--if you want to leave the game without ​destroying ​your player, you must find a 'Bed to Reality' ​ and hit A on the bed to apply it Doing 'save and then quitting ​will still delete your character.+Usage: 
 +  save 
 + 
 +This can be useful for making sure your character'​s recent achievement (i.e., level up or learning a new spell) or item find (i.e., relic ring or weapon) is saved if you fear or worry that the server is about to crash. 
 + 
 +WARNING ​– if you want to leave the game without ​losing progress or other accomplishments with your character, you must find a 'Bed to Reality' ​(probably in a building close to where you entered the game), place your character so they are "​standing" ​on top of it, and apply the bed using the apply command or hitting the '​a"​ (for apply) key. 
 + 
 +Doing 'save and then quitting ​the client or using the [[player_commands#​quit|quit]] command (see warnings about using the [[player_commands#​quit|quit]] command!) may very well result in lost experience, levels, items, and/or other character ​accomplishments and improvementsStill, see the warning about the [[player_commands#​quit|quit]] command on older versions of the game. 
 + 
 +See Also: [[player_commands#​apply|apply]]\\ 
 +See Also: [[player_commands#​quit|quit]]
  
 ==== search ==== ==== search ====
  
-Searches for traps, runes, and other hidden object in the tiles immediately surrounding the character Odds of finding hidden objects are dependant upon the player'​s ​search skill.+An alternative form of use_skill find traps. ​The default key for his command is 's'.
  
-==== search-items====+Searches for traps and other hidden objects in the tiles immediately surrounding the character and under the character. The odds of finding hidden traps are dependent upon the player'​s find traps skill.
  
-Issuing '​search-items <​list-of-item-names>​ causes the character to examine the contents of every tile he enters and pick up any objects which match. ​ Using this is a fast way to grab specific wanted items from large piles of junk, but it reduces movement speed significantly when active.+See Also: [[player_commands#​skills|skills]]\\ 
 +See Also: [[player_commands#​disarm|disarm]]
  
-Search-items ​with no arguments clears the search.+==== search-items====
  
-==== show ==== +Issuing ​the search-items command causes the character ​to examine ​the contents of every tile they enter and pick up any objects which match a specified item name or partial name.
-Without parameter, toggles through ​the various inventory windows. \\ +
-By default bound to the **x** key.+
  
 Usage: Usage:
-   ​show ​<Notebook_Info>+  search-items ​<list-of-item-names
  
-Available parameters+Example
-  ​* **all** ​"All Items"​ +  ​search-items ​ring 
-  * **applied** - "​Applied Items"​ + 
-  * **unapplied** - "​Unapplied Items"​ +The character will now pick up any rings and ringmail armor they walk over. 
-  * **unpaid** - "​Unpaid ​items" + 
-  * **cursed** - "​Cursed items" +Using this is a fast way to grab specific wanted ​items from large piles of junk, but it reduces movement speed significantly when active.
-  * **magical** - "​Magical items" +
-  * **nonmagical** - "​Nonmagical items" +
-  * **locked** - "​Inventory locked ​items+
-  * **unlocked** - "​Inventory unlocked items"​ +
-  * **unidentified** - "​Inventory unidentified items" ( since version 1.60.0 ) +
-  * **icons** - "Quick icon view"+
  
 ==== showpets ==== ==== showpets ====
 +
 +The showpets command displays a numbered list of charmed or summoned pets that are under the character'​s control.
 +
 +If no pets are in use, the player will see the message: You have no pets.
 +
 +Usage:
 +
 +  showpets
 +
 +Example output:
 +
 +  Pets:
 +  1  greater dwarven guard - level 20
 +  2  greater dwarven guard - level 20
 +  3  greater dwarven guard - level 20
 +  4  dwarf priest - level 15
 +  5  dwarf priest - level 15
 +  6  dwarf priest - level 15
 +  7  dwarf priest - level 15
 +  8  dwarf priest - level 15
 +
 +When a number is specified with the command, it instead shows a detailed printout about that pet
  
 Usage: Usage:
Line 702: Line 1256:
   showpets <​number>​   showpets <​number>​
  
-Shows numbered list of the pets owned by the player.  ​If a number ​is specified, instead shows detailed printout about that pet  +Example: 
 + 
 +  showpets 3 
 + 
 +Example Output: 
 + 
 +  level 20 greater dwarven guard 
 +  600/600 HP, 9/9 SP 
 +  Str 30 
 +  Dex 14 
 +  Con 0 
 +  Int 9 
 +  Wis 0 
 +  Cha 0 
 +  Pow 43 
 +  wc 2  damage 35 ac -11 
 + 
 +==== show ==== 
 + 
 +The show command toggles through the various inventory windows or activates ​specific inventory tab. 
 + 
 +NOTE: This is a gtkv2 client command only 
 + 
 +Usage: 
 +  show 
 +  show <​parameter>​ 
 + 
 +Available parameters:​ 
 +  * all - All Items 
 +  * applied - Applied Items 
 +  * unapplied - Unapplied Items 
 +  * unpaid - Unpaid items 
 +  * cursed - Cursed items 
 +  * magical - Magical items 
 +  * nonmagical - Nonmagical items 
 +  * locked - Inventory locked items 
 +  * unlocked - Inventory unlocked items 
 +  * unidentified - Inventory unidentified items 
 +  * icons - Quick icon view 
 + 
 +See Also: [[player_commands#​apply|apply]]\\ 
 +See Also: [[player_commands#​lock|lock]] 
 + 
 +==== skills ==== 
 + 
 +Use the skills command to display your character'​s available skills and what level you are in each skill.  
 + 
 +Usage 
 +  skills 
 + 
 +The values shown are: 
 +  * The name of the skillYou use this name for commands like use_skill or ready_skill. 
 +  * The skill level. 
 +  * The current experience. 
 +  * The experience needed to level up. 
 +  * The permanent experience ratio is relative to current experience. You'll never fall below permanent experience even if you die over and over. 
 + 
 +Example output: 
 + 
 +  Player skills: 
 +  disarm traps        lvl: 15 (xp:​3300556/​4100000/​50%) 
 +  find traps          lvl: 15 (xp:​3300934/​4100000/​50%) 
 +  one handed weapons ​ lvl: 56 (xp:​103300018/​109100000/​50%) 
 +  oratory ​            ​lvl: ​ 1 (xp:​0/​2000/​0%) 
 +  praying ​            lvl: 57 (xp:​113301000/​115200000/​50%) 
 +  two handed weapons ​ lvl: 57 (xp:​113350025/​115200000/​50%) 
 + 
 +You can optionally add parameter of '​-l'​ for a longer display with more details on permanent experience. 
 + 
 +Usage 
 + 
 +  skills -l 
 + 
 +Example output: 
 + 
 +  Player skills (long format): 
 +  disarm traps        lvl: 15 (xp:​3300556/​4100000) ​    perm lvl: 12 (xp:​1650278/​2000000) 
 +  find traps          lvl: 15 (xp:​3300934/​4100000) ​    perm lvl: 12 (xp:​1650467/​2000000) 
 +  one handed weapons ​ lvl: 56 (xp:​103300018/​109100000) perm lvl: 43 (xp:​51650009/​52000000) 
 +  oratory ​            ​lvl: ​ 1 (xp:​0/​2000) ​             perm lvl:  1 (xp:​0/​2000) 
 +  praying ​            lvl: 57 (xp:​113301000/​115200000) perm lvl: 45 (xp:​56650500/​58600000) 
 +  two handed weapons ​ lvl: 57 (xp:​113350025/​115200000) perm lvl: 45 (xp:​56675012/​58600000) 
 + 
 +You can optionally add a search string to only show skills ​that include the matched text. 
 + 
 +Usage 
 + 
 +  skills -l <​string>​ 
 + 
 +Example: 
 + 
 +  skills -l traps 
 +   
 +Example output: 
 + 
 +  Player skills (long format): (matching '​traps'​) 
 +  disarm traps        lvl: 15 (xp:​3300556/​4100000) ​    perm lvl: 12 (xp:​1650278/​2000000) 
 +  find traps          lvl: 15 (xp:​3300934/​4100000) ​    perm lvl: 12 (xp:​1650467/​2000000)
  
 ==== sort_inventory ==== ==== sort_inventory ====
Line 713: Line 1364:
  
 If you have a lot of stuff that is not in alphabetical order but you would like it to be, the best method is to drop all of it and then pick it up. If you have a lot of stuff that is not in alphabetical order but you would like it to be, the best method is to drop all of it and then pick it up.
 +
 +FIXME - Is this command still valid?\\
 +Looks like the sort_inventory command, added in v0.92.6, is no longer a valid command. Both GTKv2 and JX Client show: '​sort_inventory'​ is not a valid command.
  
 ==== sound ==== ==== sound ====
  
-Toggles sound support ​on and off.+Toggles sound on/off.
  
 +Usage
 + sound
 + 
 + ​Example output:
 +  The sounds are enabled.
 +  Sounds are turned off.
 +
 +==== spells ====
 +
 +To cast a spell, you must first learn it.
 +
 +To learn prayers:
 +  * The praying skill or a holy symbol in your inventory
 +  * A relatively high Wisdom score
 +  * A prayerbook with a prayer level relative to your skill level in praying.
 +
 +To learn spells:
 +  * One of the wizardry based skills (i.e., summoning, invoker, pyromancy, etc.) or related talisman for one of the wizardry based skills
 +  * A relatively high Intelligence score
 +  * A spellbook (or flametome, grimoire, codex, etc.) relative to your skill level in your wizardry skill
 +
 +Apply the spellbook or prayerbook for a chance to learn the spell.
 +
 +To cast a spell, you can either use the cast or invoke commands.
 +
 +See Also: [[player_commands#​apply|apply]]\\
 +See Also: [[player_commands#​cast|cast]]\\
 +See Also: [[player_commands#​invoke|invoke]]\\
 +See Also: [[player_commands#​skills|skills]]
 +
 +FIXME - Make prayer references it's own help file entry?
 +
 +==== statistics ====
 +
 +The statistics command shows various useful information about your character. ​
 +
 +Usage
 +  statistics
 +
 +The output displays:
 +  * How much experience your character has and what is needed for your next level
 +  * Shows natural, real, and maximum statistic values
 +      * Your natural stat is the stat without any items/​spells applied
 +      * Real is what the current value is (same as in the stat window in the game client)
 +      * Maximum is the maximum value for your natural stat which is based on your character race
 +  * Attack mode, which is either peaceful or hostile
 +  * Dam/Sec is a calculation of your character'​s current Damage per Second (dps) that assumes every attack hits the target or foe and does *not* take into account partial resistance values, misses, or other protection such as Armor and Ac
 +  * The command will also display the total amount of time this particular character has been logged in to the server using the internal time tracking of the server (ticks) and also converting the ticks to hours and minutes.
 +
 +Example output:
 +
 +  Experience: 150
 +  Next Level: 2000
 +
 +  Stat       ​Nat/​Real/​Max
 +  Str         ​24/ ​ 24/ 23
 +  Dex         ​18/ ​ 18/ 18
 +  Con         ​25/ ​ 25/ 24
 +  Int         ​10/ ​ 10/ 18
 +  Wis          2/   2/ 19
 +  Pow          1/   1/ 18
 +  Cha          1/   1/ 19
 +
 +  Attack Mode: Peaceful
 +
 +  Dam/​Sec: ​  80
 +
 +  You have played this character for 327 ticks, which amounts to 0 hours and 0 minutes.
 +
 +See Also: [[player_commands#​peaceful|peaceful]]
  
 ==== take ==== ==== take ====
Line 727: Line 1451:
 A parameter can be given to take.  In this case, all object that have names that match the parameter will be picked up.  Thus, if there is a 'sword of WOE', and 'sword +1' and a 'sword -3' on the ground, 'take sword' will pick all of them up. A parameter can be given to take.  In this case, all object that have names that match the parameter will be picked up.  Thus, if there is a 'sword of WOE', and 'sword +1' and a 'sword -3' on the ground, 'take sword' will pick all of them up.
  
-By default, take is bound to the comma key, with no parameters. ​ To change this, look at the [[#bind]] command.+By default, take is bound to the comma key, with no parameters. To change this, look at the [[#bind]] command. 
 + 
 +See Also: [[player_commands#​bind|bind]]
  
 ==== throw ==== ==== throw ====
  
-Throw a marked, or random item in the direction the character is facing.+Throw a marked, or randomitem in the direction the character is facing. 
 + 
 +Usage: 
 +  throw 
 + 
 +Only items that have a throwing property to them can be used with the throw command. To name a few: throwing dagger, throwing star, spear, trident
  
-FIXME: Add help in server.+FIXME - clarify on how to find throwing items and identify themDoes the mark command apply? What about quivers for throwing items?
  
 ==== title ==== ==== title ====
  
-Add/change ​title appended to the character name.  The title is displayed alongside the character name in some clients and on the [[player_commands#​hiscore|hiscore]] list.+The title command will add or change ​the title appended to the character name. The title is displayed alongside the character name in some clients and on the [[player_commands#​hiscore|hiscore]] list.
  
-When you start a new character, the character'​s title is "the <​race>​".+When you start a new character, the character'​s title defaults to “the <​race>​This is also the title that your character will default to when using the clear or default command option. 
 + 
 +Usage 
 +  * title 
 +  * title <new title> 
 +  * title clear 
 +  * title default 
 + 
 +title - If no new title is specified your current title is printed. 
 +  
 +title <new title> - will set your title to 'new title'​ 
 + 
 +title clear - resets the title to its default value 
 + 
 +title default -  resets the title to its default value 
 + 
 +Example:
  
   title   title
     Your title is 'the gnome'​.     Your title is 'the gnome'​.
 +
   title the fierce   title the fierce
 +
   title   title
     Your title is 'the fierce'​.     Your title is 'the fierce'​.
  
-FIXME: Add help in server.+  title clear 
 +    Your title is 'the gnome'. 
 + 
 +See Also: [[player_commands#​hiscore|hiscore]]
  
 ==== unarmed_skill ==== ==== unarmed_skill ====
Line 760: Line 1512:
  
 This value is saved and is persistent across logins. ​ It is a property of the character, so different characters can be set with different unarmed_skill values. This value is saved and is persistent across logins. ​ It is a property of the character, so different characters can be set with different unarmed_skill values.
 +
 +Suggestions for unarmed_skills based on race & class:
 +
 +  Dragons: unarmed_skill clawing
 +  Fireborn: unarmed_skill flame touch
 +  Wraith: unarmed_skill wraith feed
 +  Monks: unarmed_skill karate or unarmed_skill punching
 +
 +
 +See Also: [[player_commands#​bind|bind]]
  
 ==== unbind ==== ==== unbind ====
  
-Syntax:+The unbind command is used to remove a shortcut, alias, or key sequence associated with a key (i.e., F3) or keyboard combination (i.e., shift + F3).  
 + 
 +Usage: 
 +  * unbind 
 +  * unbind # 
 +  * unbind -g # 
 +  * unbind reset 
 + 
 +Summary:
  
- ​unbind ​[-g] [#] +  * unbind - lists all available keybindings that are enabled 
- ​unbind reset+  * unbind # - will reset the character keybinding of the specified number (i.e., unbind 23 will unbind keybinding number 23) 
 +  * unbind -g - will use the global bindings, which means a binding that is based on your login account and applies to all your characters 
 +  * unbind -g # - will reset the global keybinding of the specified number (i.e., unbind -g 23 will unbind keybinding number 23) 
 +  ​* ​unbind reset - will reset your character to all default keybindings
  
-Without -g command uses user's binding, with -g global binding. Without number it displays current bindings, with it unbinds it. '​reset'​ resets default bindings.+See Also: [[player_commands#bind|bind]]
  
 ==== use ==== ==== use ====
Line 781: Line 1554:
 The order is important. The order is important.
  
-FIXMEAdd more detail here and in server help.+Example: 
 +  use slicing knife with apple 
 +   
 +This will turn a whole apple into two apple halves 
 + 
 +Example: 
 +  use file with silver bar 
 + 
 +This will turn the silver bar into 1000 silver filings ​  
 + 
 +FIXME - More details needed or wanted for the use command?
  
 ==== use_skill ==== ==== use_skill ====
  
-'use_skill ​skillname+The use_skill ​command will apply the designated skill to all objects in your inventory, or on objects located under your character. ​
  
-Performs the default action for the specified ​skill.+Usage: 
 +  use_skill <skill name>
  
-Skillname may be the minimum unique identifier ​for the skill in question.+The use_skill command is also used for crafting. For instance, by placing specific items in a cauldron, you would apply the alchemy ​skill to try and create something new in the cauldron
  
-Example:  ​'use_skill alchemy ​will attempt to identify nearby items that can be identified ​with the alchemy ​skill, or attempt to process the recipe in a cauldron.+Example: 
 +  ​use_skill alchemy 
 + 
 +This command is best used with keybindings (see help bind), as it does not set the designated ​skill as your active skill (see help ready_skill). 
 + 
 +See Also: [[player_commands#​bind|bind]]\\ 
 +See Also: [[player_commands#​skills|skills]]\\ 
 +See Also: [[player_commands#​ready_skill|ready_skill]]
  
-FIXME - Add documentation here and in the server help. 
  
 ==== usekeys ==== ==== usekeys ====
  
-The usekeys option determines the behaviour ​of using keys.+The usekeys option determines the behavior ​of using keys when encountering locked doors.
  
-== Values are==+Usage: 
 +  usekeys 
 +  usekeys <​value>​
  
-  ​* inventory: Only keys in the top level inventory are used (default) +Values are: 
-  * keyrings: Only keys in active keyrings are used. +  * usekeys: displays that the current value is set to 
-  * containers: Only keys in active containers are used.+  ​* inventory: Only keys in the top-level inventory are used (default) 
 +  * keyrings: Only keys inside of active keyrings are used. 
 +  * containers: Only keys inside ​active containers are used.
  
-Note that keyrings are just a specialized container, so the containers will also  find keys in keyrings.+Example: 
 +  usekeys containers
  
-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.+Note that keyrings are just specialized containers, so the containers will also find keys in keyrings. Meaning, that if containers are the active setting the game client will check all active keyrings and all active containers (i.e., chests, backpacks, sacks, pouches, etc.) 
 + 
 +Only active containers are used - keys will not jump out of closed containers, but hints will be given if you have keys in closed ​containers. 
 + 
 +==== version ==== 
 + 
 +The version command displays the current version of the Crossfire server in use.  
 + 
 +Usage: 
 +  version 
 + 
 +This consists of the name and the version number of the server. 
 + 
 +Example: 
 + 
 +  Crossfire v1.75.0 
 + 
 +If the server is built from the Git repository, it will include a revision number in the version output. 
 + 
 +Example: 
 + 
 +  Crossfire v1.75.0-ga725943 
 + 
 +A summary of that output: 
 + 
 +  The first set of digits relates to the tagged release (i.e., 1.75.0) 
 +  The middle number of information (i.e. 1316) includes a commit number. That way the versions can still be sorted in chronological order. 
 +  The last string of text indicates a git commit (i.e., ge19bd3e61) 
 + 
 +==== whereabouts ==== 
 + 
 +The whereabouts command gives a summary of the regions in which players are currently occupying. 
 + 
 +Usage: 
 +  whereabouts 
 + 
 +Example: 
 +  In the world currently there are: 
 +  3 players in The Kingdom of Scorn 
 +  4 players in The Sultanate of Darcap
  
 ==== wimpy ==== ==== wimpy ====
  
-wimpy is a (?percentage/​number?​) ​of hitpoints left.  When hitpoits ​drop below this level the character will blindly run away automatically.+The wimpy command ​is a percentage of hitpoints left. When hitpoints ​drop below this level the character will blindly run away automatically. 
 + 
 +Usage: 
 +  wimpy 
 +  wimpy <#>
  
 wimpy without an argument shows the current setting. wimpy without an argument shows the current setting.
  
 +Example:
   Your current wimpy level is 0.   Your current wimpy level is 0.
  
 If a numeric argument is specified, the wimpy level is set and shown: If a numeric argument is specified, the wimpy level is set and shown:
- + 
 +Example: 
 +  wimpy 10
   Your new wimpy level is 10.   Your new wimpy level is 10.
  
-FIXME - Clarify documentation here and in the server help.  Server help says it is percentage, but numbers greater than 100 are accepted.+Your character will flee in a random direction when hit points fall to 10% total or lower
  
 ===== Debug ===== ===== Debug =====
Line 846: Line 1687:
 ==== stay ==== ==== stay ====
  
-A direction command ​that indicates the space that the character is standing on.  For example, to fire a rod of heal on the character:+A direction command ​which indicates the space that the character is standing on. 
 + 
 +Usage: 
 +  stay 
 + 
 +For example, to fire a rod of heal on the character:
  
   apply -a rod of heal   apply -a rod of heal
-    ​Readied skill: use magic item. +  ​Readied skill: use magic item. 
-    You ready rod of heal (lvl 60) * (readied).+  You ready rod of heal (lvl 60) * (readied). 
   stay fire   stay fire
-    You are already fully healed. 
  
-FIXME - Add documentation in the server help.+  You are already fully healed.
  
 ===== Information ===== ===== Information =====
Line 862: Line 1708:
 'help commands for help to list available commands. ​ 'help commands for help to list available commands. ​
  
-=== help keys === +===keys ====
-=== help move ===+
  
 These are the basic movement keys: These are the basic movement keys:
  
-    ​yku +    ​y k u 
-    h l +    h   ​
-    ​bjn+    ​b j n 
 + 
 +Running is done by holding the control key down, keeping it held down, and tapping a direction key once. Release the control key to stop running. Running is recommended - especially when attacking. 
 + 
 +Firing a ranged attack ('help range) such as a bow, crossbow, wand, staff, rod, throwing weapon, or spellcasting ('help cast) is done by holding down the shift key, keeping it held down, and tapping a direction key once to fire in that direction. 
 + 
 +'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 
 + 
 +See Also: [[player_commands#​range|range]]\\ 
 +See Also: [[player_commands#​mouse|mouse]]\\ 
 +See Also: [[player_commands#​melee|melee]]\\ 
 +See Also: [[player_commands#​traps|traps]]\\ 
 +See Also: [[player_commands#​cast|cast]] 
 + 
 + 
 +==== move ==== 
 + 
 +These are the basic movement keys: 
 + 
 +    y k u 
 +    h   l 
 +    b j n 
 + 
 +It is also possible to use the arrows keys to move, but that does not conveniently allow you to move diagonally (i.e., northwest, northeast, southwest, southeast) 
 + 
 +Numeric keypad: 
 + 
 +  7 - northwest 
 +  8 - north 
 +  9 - northeast 
 +  4 - west 
 +  5 - not used 
 +  6 - east 
 +  1 - southwest 
 +  2 - south 
 +  3 - southeast 
 + 
 +Important Note: certain clients in combination with certain operating systems may require you to enable or disable NumLock in order to actively use the numeric keypad for movement. 
 + 
 +Generally, one direction key press is one step in that direction. This is good for slow and careful movement. But this does NOT work well for combat and for that you should use the run key. 
 + 
 +Running is done by holding the control (ctrl) key down, keeping it held down, and tapping a direction key once. Release the control key to stop running. Running is recommended - especially when attacking. 
 + 
 +Firing a ranged attack ('help range) such as a bow, crossbow, wand, staff, rod, throwing weapon, or spellcasting ('help cast) is done by holding down the shift key, keeping it held down, and tapping a direction key once to fire in that direction. 
 + 
 +'help mouse for help on what the mouse buttons do
  
-Running is done by holding control and move.  Running is recommended.+'help melee for advice on how to fight
  
-Firing the range weapon (help range) is done by holding shift and move.+'help traps for help with finding ​and disarming traps
  
-  * '​help ​[[player_commands#​mouse]] for help on what the mouse buttons do. +See Also: [[player_commands#​range|range]]\\ 
-  * '​help ​[[player_commands#​melee]] ​for advice on how to fight +See Also: [[player_commands#​mouse|mouse]]\\ 
-  * '​help ​[[player_commands#​traps]] ​for help with finding and disarming traps+See Also: [[player_commands#​melee|melee]]\\ 
 +See Also: [[player_commands#​traps|traps]]\\ 
 +See Also: [[player_commands#​cast|cast]]
  
 === help mouse === === help mouse ===
  
-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:+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 an inventory item, or use an item on the ground.   * Middle button on item:  apply or equip an inventory item, or use an item on the ground.
Line 891: Line 1787:
 ==== hiscore ==== ==== hiscore ====
  
-Shows the top fifty scores on the server ​in the following format.+The hiscore command shows the top fifty scores on the server.
  
-  Nr    ​Score ​   Who <max hp><​max sp><​max grace> +Usage:\\ 
-  <​rank>​ <xp> <who> was killed by <calamity> on map <name of map> <max hp><​max sp><​max grace>+ ​hiscore\\ 
 + ​hiscore <player name>​\\ 
 + ​hiscore <​title>​\\ 
 + ​hiscore -s\\ 
 + ​hiscore -s:<​skill_name>​ 
 +  
 + 
 +Output: 
 + 
 +Number ​   ​Score ​        ​Who <max hp><​max sp><​max grace> 
 +<​rank> ​   <​xp ​total   <player name<​title>​ <last seen|left the game|quit the game> on map <name of map> <max hp><​max sp><​max grace> 
 + 
 +Example: 
 + 
 +  Overall high scores: 
 +  Rank     Score Who <max hp><​max sp><​max grace> 
 +    1  522489565 Sven the  Knight ​was last seen on map apartments ​<524><​38><​302>​. 
 +    2     ​868154 Wraith the wraith left the game on map world_105_115 ​<115><​1><​1>​. 
 +    3        246 Moh the human was last seen on map Hall of Dungeon Masters <​43><​1><​32>​. 
 +    4        150 test the dwarf left the game on map Wanderer Inn <​49><​1><​1>​. 
 +    5        135 Hahn the human quit the game on map Wanderer Inn <​42><​38><​33>​. 
 + 
 +You can also search the hiscore list by player ​name by adding the character name string to the end of the command. 
 + 
 +Example: 
 +   
 +  hiscore test 
 +   
 + Will display: 
 +   
 +   ​4 ​       150 test the dwarf left the game on map Wanderer Inn <49><​1><​1>​. 
 +    
 +It is also possible to search the hiscore list by title by adding the character name string to the end of the command. 
 + 
 +Example: 
 +   
 +  hiscore human 
 +   
 +Will display: 
 +   
 +   ​3 ​       246 Moh the human was last seen on map Hall of Dungeon Masters <​43><​1><​32>​. 
 +   ​5 ​       135 Hahn the human quit the game on map Wanderer Inn <​42><​38><​33>​. 
 + 
 +Another option is to get a hiscore list by skill name by adding -s to the command 
 + 
 +Example: 
 + 
 +  hiscore -s 
 + 
 +Will display: 
 + 
 +  High scores for the skill literacy: 
 +  Rank     Score Who <max hp><​max sp><​max grace>
 +    1      10461 Jose the human left the game on map Wanderer Inn <​49><​1><​1>​. 
 +  High scores for the skill one handed weapons: 
 +  Rank     Score Who <max hp><​max sp><​max grace> 
 +    1        555 Jose the human left the game on map Wanderer Inn <​49><​1><​1>​. 
 + 
 +It is also possible to get a hiscore list by skill category, but adding the skill name to the hiscore skill search, hiscore -s:<​skill_name>​ 
 + 
 +Example: 
 + 
 +  hiscore -s:​literacy 
 + 
 +Will display: 
 + 
 +  High scores for the skill literacy: 
 +  Rank     Score Who <max hp><​max sp><​max grace> 
 +    1      10461 Jose the human left the game on map Wanderer Inn <​49><​1><​1>​. 
 + 
 +Note: for multiple word skills (i.e., one handed weapons, missile weapons, et al.), you just use the first word with the hiscore -s:<​skill_name>​ command 
 + 
 +Example: 
 + 
 +  hiscore -s:one 
 + 
 +That will show: 
 + 
 +  High scores for the skill one handed weapons: 
 +  Rank     Score Who <max hp><​max sp><​max grace> 
 +    1        555 Jose the human left the game on map Wanderer Inn <​49><​1><​1>​.
  
 ==== inv ==== ==== inv ====
Line 918: Line 1894:
 ==== mapinfo ==== ==== mapinfo ====
  
-Displays ​information about the map the character is currently on. Data is shown as follows:+mapinfo gives information about the map you are currently on.
  
-  <name of map> (</path/to/map/on/server) in <name of the map region>​ +  ​Output format: 
-  Created: ​ <​date>​ <author+  ​<​map ​name> (<​map ​path>) in <map region>​ 
-  Modified: <​date>​ <last editor>+  Created: <​date>​ <developer name> [<​developer email>] 
 +  ​[Modified: <​date>​ <developer name[<​developer email>​]] 
 + 
 +This information is predominantly used for bug reports and similar development operations.
  
 ==== maps ==== ==== maps ====
Line 1002: Line 1981:
        
    ​Outcome:​ I have opened the final door, I should open the chest and claim my reward.    ​Outcome:​ I have opened the final door, I should open the chest and claim my reward.
 +
 +==== report ====
 +
 +Report a bug or ask for help from a dungeon master.
 +
 +Usage: report <​description of issue>
 +
 +If enabled, this command sends a bug report or request for help to the dungeon masters. The report contains your character name, current map location, and issue description.
  
 ==== resistances ==== ==== resistances ====
Line 1013: Line 2000:
 ==== skills ==== ==== skills ====
  
-FIXME Add documentation.+Use the skills command to learn your experience and level of your skills. 
 + 
 +The values shown are: 
 + 
 +  * The name of the skill. You use this name for commands like use_skill or ready_skill. 
 +  * The skill level. 
 +  * The current experience. 
 +  * The experience needed to level up. 
 +  * The permanent experience ratio relative to current experience. You'll never fall below permanent experience even if you die over and over. 
 + 
 +You can optionally add a parameter of '-l' for a longer display with more details on permanent experience. 
 + 
 +You can optionally add a search string to only show skills that include the match text. 
 + 
 +Example: 
 +  skills -l traps
  
 ==== statistics ==== ==== statistics ====
Line 1116: Line 2118:
 ==== gsay ==== ==== gsay ====
  
-gsay sends a message to all members of your current ​[[player_commands#​party]].+gsay 
 + 
 +This command requires that a party has been formed and you are a member of that party. 
 + 
 +The gsay command can be used in place of the command, party say <​message>​. 
 + 
 +gsay sends a message to all members of your current party.
  
 gsay usage: gsay usage:
-  * 'gsay [Message that you want all party members to see]+ 
 +    ​'gsay [Message that you want all party members to see] 
 + 
 +Example: 
 + 
 +  gsay hello 
 + 
 +Will display: 
 + 
 +  <​party_name>​ You say: hello
  
 FIXME - In the "help commands"​ output, the command is listed as a regular command and not a communication command. ​ The chat command appears in the communication command section. ​ Should only the emotes should be in the communication section? ​ If not at least the commands should be shown consistently in the help. FIXME - In the "help commands"​ output, the command is listed as a regular command and not a communication command. ​ The chat command appears in the communication command section. ​ Should only the emotes should be in the communication section? ​ If not at least the commands should be shown consistently in the help.
player_commands.1598160302.txt.gz · Last modified: 2020/08/23 00:25 by leaf