diff options
Diffstat (limited to 'data/help')
| -rw-r--r-- | data/help/alias.yaml | 15 | ||||
| -rw-r--r-- | data/help/attack.yaml | 4 | ||||
| -rw-r--r-- | data/help/drop.yaml | 6 | ||||
| -rw-r--r-- | data/help/equipment.yaml | 2 | ||||
| -rw-r--r-- | data/help/fishing.yaml | 22 | ||||
| -rw-r--r-- | data/help/gathering.yaml | 24 | ||||
| -rw-r--r-- | data/help/get.yaml | 2 | ||||
| -rw-r--r-- | data/help/look.yaml | 11 | ||||
| -rw-r--r-- | data/help/mining.yaml | 8 | ||||
| -rw-r--r-- | data/help/movement.yaml | 4 | ||||
| -rw-r--r-- | data/help/quit.yaml | 7 | ||||
| -rw-r--r-- | data/help/remove.yaml | 11 | ||||
| -rw-r--r-- | data/help/search.yaml | 12 | ||||
| -rw-r--r-- | data/help/style.yaml | 3 | ||||
| -rw-r--r-- | data/help/toggle.yaml | 3 | ||||
| -rw-r--r-- | data/help/wear.yaml | 16 | ||||
| -rw-r--r-- | data/help/woodcutting.yaml | 22 |
17 files changed, 142 insertions, 30 deletions
diff --git a/data/help/alias.yaml b/data/help/alias.yaml new file mode 100644 index 0000000..4be2f98 --- /dev/null +++ b/data/help/alias.yaml @@ -0,0 +1,15 @@ +name: "alias" +category: "General" +description: | + Create and manage command aliases. + + Usage: alias - List all aliases + alias <name> <cmd> - Create an alias (e.g. alias k kill) + unalias <name> - Remove an alias + + Aliases are account-wide and shared by all your characters. They + support argument passthrough: "alias k kill" means "k man" expands + to "kill man". + + Aliases resolve before built-in commands. An alias can shadow an + existing command name. diff --git a/data/help/attack.yaml b/data/help/attack.yaml index 8c0bec3..96a4bcd 100644 --- a/data/help/attack.yaml +++ b/data/help/attack.yaml @@ -3,7 +3,7 @@ category: "Combat" description: | Attack a mob in the current room. - Usage: attack <mob>, kill <mob>, fight <mob> + Usage: attack <mob>, kill <mob> attack 1.man, kill 2.man Enter combat with the named mob. If multiple mobs with different names @@ -12,4 +12,4 @@ description: | name (e.g. "attack 1.man"). Plain "attack man" targets the first. Attacks occur at weapon speed on the 600ms tick. Use "style" to change - combat style. You are locked in place for 15 ticks when combat starts. + combat style. You are locked in place when combat starts. diff --git a/data/help/drop.yaml b/data/help/drop.yaml index b4e1a95..a4f2d5c 100644 --- a/data/help/drop.yaml +++ b/data/help/drop.yaml @@ -4,6 +4,10 @@ description: | Drop an item from your inventory. Usage: drop <item> + drop all Drops one unit of the named item onto the ground in your current room. - Other players can then pick it up. + Other players can then pick it up. "drop all" drops your entire + inventory after confirmation. + + Dropping an item cancels any active gathering or crafting action. diff --git a/data/help/equipment.yaml b/data/help/equipment.yaml index b2224a4..1a4b229 100644 --- a/data/help/equipment.yaml +++ b/data/help/equipment.yaml @@ -6,3 +6,5 @@ description: | Usage: equipment, eq Shows what you have equipped in each slot (main hand, head, torso, etc.). + Use "wear <item>" or "wield <item>" to equip items from your inventory. + Use "remove <item>" to unequip. diff --git a/data/help/fishing.yaml b/data/help/fishing.yaml index 60f2d6a..cf2ea95 100644 --- a/data/help/fishing.yaml +++ b/data/help/fishing.yaml @@ -1,14 +1,22 @@ name: "fishing" category: "Skills" description: | - Fish from fishing spots. + Fish from fishing spots at the water's edge. Usage: fish <spot>, fish <N.spot> - Fishing requires a tool matching the spot's tool type (e.g. fishing_rod). - Better rods have higher tool_speed, reducing the wait between casts. + Fishing requires the correct tool for the spot you're using. Different + spots call for different equipment — nets, rods, harpoons, or pots. + Some spots also require bait (fishing bait or feathers), which is + consumed each cast whether you catch anything or not. - Each cast has a chance to catch fish based on your fishing level. - Fishing spots never deplete — you fish until your inventory fills or - the spot wanders away. Fishing spots move between predefined rooms, - simulating wandering fish schools. + If you run out of bait, fishing stops. Better tools have higher + tool_speed, reducing wait time. A wielded tool takes priority over + inventory tools. + + Each spot type can yield different fish depending on your fishing + level. Higher level unlocks more valuable catches. + + Look at a spot to see what equipment it needs. + + Enable the "xpdrops" toggle to see XP gains with each catch. diff --git a/data/help/gathering.yaml b/data/help/gathering.yaml index 57c317e..876f92f 100644 --- a/data/help/gathering.yaml +++ b/data/help/gathering.yaml @@ -5,18 +5,32 @@ description: | Usage: mine <object> - Mine ore from rocks (requires pickaxe) chop <object> - Chop logs from trees (requires axe) - fish <object> - Fish from fishing spots (requires rod/net) + cut <object> - Same as chop + fish <object> - Fish from fishing spots (requires correct tool) Gathering skills use a tick-based action system: 1. You begin the action (e.g. "You swing your pickaxe...") 2. After a wait (reduced by tool speed), the game rolls for success 3. Success picks a weighted random drop from the object's drop table - 4. Depleting drops remove the resource temporarily; rare drops don't - Tools: Items with tool_type and tool_speed. The best matching tool in - your inventory or toolbelt is used automatically. Higher tool_speed - means faster gathering. + Tools: Items with tool_type and tool_speed. A wielded tool always takes + priority. Otherwise the first matching tool in your inventory is used. + Higher tool_speed means faster gathering. + + Bait: Some fishing spots consume bait each attempt. If you run out, + the action stops. + + XP: All successful gathers award XP. Enable the "xpdrops" toggle to + see XP gains with each drop (e.g. "+37xp wct"). Fishing catches award + XP based on the specific fish caught. Numbered targeting: "mine 1.rock" targets a specific instance when multiple objects of the same name are present. "look" shows instance indices and depletion status. + + Two depletion mechanics: + - Per-drop (rocks): Depletes on first successful gather. Respawns + after a fixed delay. + - Shared (trees): A despawn timer counts down while being chopped. + When it hits 0, the next successful gather depletes it for everyone. + If no one is chopping, the timer regenerates back up. diff --git a/data/help/get.yaml b/data/help/get.yaml index abd416e..777541b 100644 --- a/data/help/get.yaml +++ b/data/help/get.yaml @@ -8,3 +8,5 @@ description: | "get all" picks up everything on the ground. Credits are automatically added to your credit balance and never take inventory space. + + Picking up an item cancels any active gathering or crafting action. diff --git a/data/help/look.yaml b/data/help/look.yaml index b1d7a6d..2be3d30 100644 --- a/data/help/look.yaml +++ b/data/help/look.yaml @@ -8,16 +8,19 @@ description: | Without a target, shows: room name, description, objects (with instance indices and depletion status), mobs (with HP and combat level), ground - items (with reservation info), exits, and other players. + items (alphabetically sorted, with reservation info), exits, and other + players. Players are shown with their current action (e.g. "Bob is here, mining a copper rock [1]") or combat status ("Bob is here (fighting a man [2])"). - Instance indices appear when multiple objects or mobs of the same type - are present. + Instance indices appear only when multiple objects or mobs of the same + type are present and differ in state. With a target, shows details about: - Mobs: stats and combat level - - Objects: description and depletion timers (per instance) + - Objects: description and, with the depletion toggle on, timers - Items (ground or inventory): description and value - Players: stats, equipment, and description - Directions: shows the adjacent room as if you were there + + Use "toggle depletion" to show depletion and despawn timers on objects. diff --git a/data/help/mining.yaml b/data/help/mining.yaml index b883465..231027f 100644 --- a/data/help/mining.yaml +++ b/data/help/mining.yaml @@ -4,9 +4,9 @@ description: | Mine ore from rocks. Usage: mine <rock>, mine <N.rock> - mine 1.rock, mine 2.rock + mine 1.rock, mine copper - Mining requires a pickaxe in your inventory or toolbelt. Better pickaxes + Mining requires a pickaxe, either wielded or in your inventory. Better pickaxes have higher tool_speed, which reduces the wait between swings. Each swing has a chance to yield ore based on your mining level. If you @@ -14,8 +14,8 @@ description: | mining the same rock are interrupted when it depletes. If you get a gem or other rare drop, the rock does not deplete and you - continue mining. Type "mine rock" again during a wait to restart the - swing cycle immediately. + continue mining. Enable the "xpdrops" toggle to see XP gains. Use numbered targeting (e.g. "mine 2.rock") when multiple rocks of the same type are present. "look rock" shows which rocks are depleted. + Use "toggle depletion" to see exact respawn timers. diff --git a/data/help/movement.yaml b/data/help/movement.yaml index 239220f..91aefa6 100644 --- a/data/help/movement.yaml +++ b/data/help/movement.yaml @@ -6,8 +6,8 @@ description: | Usage: north, south, east, west, up, down Aliases: n, s, e, w, u, d - You cannot move for 15 ticks after combat starts. Moving interrupts - combat and any active gathering or crafting action. + You cannot move during the combat lock period after combat starts. + Moving interrupts combat and any active gathering or crafting action. With "description" toggled on, moving shows the full room description instead of just the room name. Use "toggle" to change this setting. diff --git a/data/help/quit.yaml b/data/help/quit.yaml index c41771b..ce45c34 100644 --- a/data/help/quit.yaml +++ b/data/help/quit.yaml @@ -5,11 +5,12 @@ description: | Usage: quit - Cannot be used during combat. Starts a 10-tick rest sequence: + Stops your current action (gathering, crafting, etc.). Cannot be used + during combat. Starts a 10-tick rest sequence: 10 ticks: "You sit down to rest..." 6 ticks: "You catch your breath..." 3 ticks: "You close your eyes..." 0 ticks: Returns to account menu - The rest is cancelled if you take any action or if combat starts. - Saves your character when the timer completes. + The rest is cancelled if you take any action. Saves your character + when the timer completes. diff --git a/data/help/remove.yaml b/data/help/remove.yaml new file mode 100644 index 0000000..757bb27 --- /dev/null +++ b/data/help/remove.yaml @@ -0,0 +1,11 @@ +name: "remove" +category: "Items" +description: | + Unequip an item and return it to your inventory. + + Usage: remove <item>, unwear <item>, unwield <item> + + Removes the named item (or the item in the named slot) and places it + in your inventory. If your inventory is full, you cannot remove it. + + Examples: remove axe, remove main_hand diff --git a/data/help/search.yaml b/data/help/search.yaml new file mode 100644 index 0000000..42eec52 --- /dev/null +++ b/data/help/search.yaml @@ -0,0 +1,12 @@ +name: "search" +category: "Items" +description: | + Search an item in your inventory. + + Usage: search <item> + + Example: search nest, search birds nest + + Opens a searchable item (currently only bird's nests) and rolls on its + drop table for loot. The item is consumed in the process. Items found + go to inventory or fall to the ground if full. diff --git a/data/help/style.yaml b/data/help/style.yaml index 3016013..50b4a38 100644 --- a/data/help/style.yaml +++ b/data/help/style.yaml @@ -10,4 +10,5 @@ description: | Defensive - +3 defense bonus, trains Defense (75%) and Hitpoints (25%) Balanced - +1 all bonuses, trains all combat skills evenly (25% each) - XP is awarded per hit: 4 XP per point of damage. + XP is awarded per hit: 4 XP per point of damage. Enable "xpdrops" to + see XP gains in combat messages. diff --git a/data/help/toggle.yaml b/data/help/toggle.yaml index 44a2b33..27080be 100644 --- a/data/help/toggle.yaml +++ b/data/help/toggle.yaml @@ -9,9 +9,10 @@ description: | Toggles: description - Long room descriptions when moving between rooms tinymap - Mini-map display (not yet implemented) - xpdrops - Show XP gained in combat hit messages + xpdrops - Show XP gained in gather, crafting, and combat messages exits - Show exit destinations in look output mobenter - Notify when a mob enters the room mobleave - Notify when a mob leaves the room mobspawn - Notify when a mob spawns in the area reserve - Show full reserved item details in look + depletion - Show depletion and despawn timers on objects diff --git a/data/help/wear.yaml b/data/help/wear.yaml new file mode 100644 index 0000000..d0b665d --- /dev/null +++ b/data/help/wear.yaml @@ -0,0 +1,16 @@ +name: "wear" +category: "Items" +description: | + Equip weapons and tools from your inventory. + + Usage: wear <item>, wield <item> + wear all + + Equips the named item into its appropriate equipment slot. If something + is already in that slot, they are swapped. "wear all" equips the + highest-value item for each slot from your inventory. + + Equipped tools (pickaxes, axes, fishing rods) are used for gathering + actions and always take priority over inventory tools. + + Worn items appear on the equipment/eq screen. diff --git a/data/help/woodcutting.yaml b/data/help/woodcutting.yaml new file mode 100644 index 0000000..80179a9 --- /dev/null +++ b/data/help/woodcutting.yaml @@ -0,0 +1,22 @@ +name: "woodcutting" +category: "Skills" +description: | + Chop logs from trees. + + Usage: chop <tree>, cut <tree> + chop 1.oak, chop oak tree + + Woodcutting requires an axe, either wielded or in your inventory. Better axes + have higher tool_speed, reducing the wait between swings. Axes can + also be equipped as melee weapons. + + Regular trees deplete on first successful chop and respawn after a + delay. Higher-tier trees (oak and above) use shared depletion: a + despawn timer counts down while anyone chops. When it reaches 0, the + next successful gather depletes the tree for all choppers. If no one + is chopping, the timer regenerates back toward its maximum. + + All trees except regular trees have a 1/256 chance to drop a bird's + nest alongside the logs. Use "search nest" to open a nest for loot. + + Use the "depletion" toggle to see timers on trees and rocks. |