Differences

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

--- player_commands [2022/05/07 02:24]
leaf [usekeys]
+++ player_commands [2024/03/25 17:41]
leaf [pickup] Update the command to match commit 900867
@@ Line 407: / Line 407: @@
 ==== forget_spell ====
-Syntax: forget_spell <spell name>
+The forget_spell command will cause your currently logged-in character to permanently lose knowledge of the specified spell.
-This will cause you to permanently lose knowledge of a spell.
+Usage:
+  forget_spell <spell name>
+Example:
+  forget_spell light
+  You lose knowledge of light.
 ==== get ====
@@ Line 458: / Line 464: @@
 See Also: [[player_commands#cast|cast]]
-==== keys ====
-These are the basic movement keys:
-    yku
-    h l
-    bjn
-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]]
 ==== killpets ====
@@ Line 532: / Line 516: @@
 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:
@@ Line 678: / Line 664: @@
 The command motd displays the server's Message Of The Day file
-=== mouse ====
+==== mouse ====
 The mouse is one possible way to move your character. But is primarily used to interface with objects and items in the game.
@@ Line 690: / Line 676: @@
 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
+  * 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:
@@ Line 698: / Line 688: @@
   * Right button: picks up the item(s) and adds it to your inventory
-FIXME - Expand the summary and uses such as middle click on a scroll
+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]]
-==== move ====
-These are the basic movement keys:
-    yku
-    h l
-    bjn
-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:
-- northwest
-- north
-- northeast
-- west
-- not used
-- east
-- southwest
-- south
-- 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
-'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]]
 ==== news ====
@@ Line 757: / Line 712: @@
 This is just like the down arrow under most command-line interfaces (CLI).
-See Also: [[player_commands#prevkey|prevkey]]
+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.
+See Also: [[player_commands#prevkey|prevkey]]
+See Also: [[player_commands#bind|bind]]
@@ Line 936: / Line 893: @@
   - key
   - missile
-  - allweapon
+  - melee
   - magical
   - potion
@@ Line 946: / Line 903: @@
   - 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#get|get]]\\
 See Also: [[player_commands#take|take]]
 ==== prepare ====
@@ Line 983: / Line 941: @@
 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]]
 ==== printlos ====
@@ Line 1578: / Line 1539: @@
 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?
@@ Line 1583: / Line 1549: @@
 ==== 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
-FIXME - Add documentation here and in the server help.
+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]]
+==== usekeys ====
+The usekeys option determines the behavior of using keys when encountering locked doors.
+Usage:
+  usekeys
+  usekeys <value>
+Values are:
+  * usekeys: displays that the current value is set to
+  * 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.
+Example:
+  usekeys 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
+==== 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:
+players in The Kingdom of Scorn
+players in The Sultanate of Darcap
 ==== 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.
+Example:
   Your current wimpy level is 0.
 If a numeric argument is specified, the wimpy level is set and shown:
+Example:
+  wimpy 10
   Your new wimpy level is 10.
-FIXME - Clarify documentation here and in the server help.  Server help says it is a 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 =====
@@ Line 1632: / Line 1660: @@
 ==== 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
-    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
-    You are already fully healed.
-FIXME - Add documentation in the server help.
+  You are already fully healed.
 ===== Information =====
@@ Line 1648: / Line 1681: @@
 'help commands for help to list available commands.
-=== help keys ===
+==== keys ====
-=== help move ===
 These are the basic movement keys:
-    yku
+    y k u
-    h l
+    h   l
-    bjn
+    b j n
-Running is done by holding control and move.  Running is recommended.
+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 the range weapon (help range) is done by holding shift and move.
+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 [[player_commands#mouse]] for help on what the mouse buttons do.
+'help mouse for help on what the mouse buttons do.
-  * 'help [[player_commands#melee]] for advice on how to fight
-  * 'help [[player_commands#traps]] for help with finding and disarming traps
+'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:
+- northwest
+- north
+- northeast
+- west
+- not used
+- east
+- southwest
+- south
+- 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
+'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]]
 === help mouse ===
@@ Line 1679: / Line 1762: @@
 The hiscore command shows the top fifty scores on the server.
-Usage:
+Usage:\\
- hiscore
+ hiscore\\
- hiscore <player name>
+ hiscore <player name>\\
- hiscore <title>
+ hiscore <title>\\
+ hiscore -s\\
+ hiscore -s:<skill_name>
@@ Line 1720: / Line 1805: @@
         246 Moh the human was last seen on map Hall of Dungeon Masters <43><1><32>.
         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>.
+      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>
+        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>
+      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>
+        555 Jose the human left the game on map Wanderer Inn <49><1><1>.
 ==== inv ====
@@ Line 1965: / Line 2089: @@
 ==== 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 [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.

Crossfire Wiki

User Tools

Site Tools

Differences

Page Tools