From 5f44f3fa36a213d8963f0a814cc46b7634cc36be Mon Sep 17 00:00:00 2001 From: tboy1337 Date: Sat, 16 Aug 2025 15:19:29 +0100 Subject: [PATCH 1/2] Update USAGE.md to enhance command documentation and add new features - Improved help command with clickable commands and tab completion. - Expanded command sections for basic movement, advanced movement, mining, building, selection, elytra flying, following, item management, world exploration, waypoints, information, and debugging. - Introduced new commands for selection and elytra functionalities. - Updated troubleshooting section for better clarity on common issues. --- USAGE.md | 340 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 262 insertions(+), 78 deletions(-) diff --git a/USAGE.md b/USAGE.md index 46241e3fe..962c704e4 100644 --- a/USAGE.md +++ b/USAGE.md @@ -8,100 +8,284 @@ Baritone commands can also by default be typed in the chatbox. However if you ma To disable direct chat control (with no prefix), turn off the `chatControl` setting. To disable chat control with the `#` prefix, turn off the `prefixControl` setting. In Impact, `.b` cannot be disabled. Be careful that you don't leave yourself with all control methods disabled (if you do, reset your settings by deleting the file `minecraft/baritone/settings.txt` and relaunching). -# For Baritone 1.2.10+, 1.3.5+, 1.4.2+ +# Getting Help -Lots of the commands have changed, BUT `#help` is improved vastly (its clickable! commands have tab completion! oh my!). +Try `#help` - it's vastly improved with clickable commands and tab completion! Different help sections are available: -Try `#help` I promise it won't just send you back here =) +- `#help` - Show all commands with pagination +- `#help ` - Show detailed help for a specific command (e.g., `#help sel`) +- `#help sel` - WorldEdit-like selection commands +- `#help wp` - Waypoint management +- `#help elytra` - Elytra flying commands -"wtf where is cleararea" -> look at `#help sel` +Watch this [showcase video](https://youtu.be/CZkLXWo4Fg4)! -"wtf where is goto death, goto waypoint" -> look at `#help wp` +# Settings -just look at `#help` lmao +To toggle a boolean setting, just say its name in chat (for example saying `allowBreak` toggles whether Baritone will consider breaking blocks). For a numeric setting, say its name then the new value (like `primaryTimeoutMS 250`). It's case insensitive. To reset a setting to its default value, say `acceptableThrowawayItems reset`. To reset all settings, say `reset`. To see all settings that have been modified from their default values, say `modified`. -Watch this [showcase video](https://youtu.be/CZkLXWo4Fg4)! +# Core Commands -# Commands +**All** commands may need a prefix before them (# by default). -[Tutorial playlist](https://www.youtube.com/playlist?list=PLnwnJ1qsS7CoQl9Si-RTluuzCo_4Oulpa) +## Basic Movement & Goals +- `goal x y z` or `goal x z` or `goal y` - Set a goal to coordinates, then use `path` to path to it +- `goal` - Set the goal to your current position +- `goal clear` - Clear the current goal +- `goto x y z` or `goto x z` or `goto y` - Go to coordinates immediately (combines goal + path) +- `goto ` - Go to the nearest block of that type (e.g., `goto diamond_ore`, `goto portal`) +- `thisway ` - Set goal in the direction you're facing, then `path` to start +- `path` - Start pathfinding to the current goal +- `cancel` or `stop` - Stop all current processes +- `forcecancel` - Force stop everything (more aggressive) +- `pause` - Pause the current process +- `resume` - Resume a paused process +- `come` - Head towards your camera position (useful with freecam) -**All** of these commands may need a prefix before them, as above ^. +## Advanced Movement +- `surface` or `top` - Go to the highest accessible block (surface or air pocket) +- `axis` - Go to world axis at configurable height (default y=120) +- `invert` - Invert current goal (go as far away as possible instead of close) +- `tunnel [width] [height] [length]` - Dig a tunnel (default 1x2, or specify dimensions) -`help` +## Mining & Building +- `mine ` - Mine specified blocks (e.g., `mine diamond_ore iron_ore`) +- `mine ` - Mine a specific amount (e.g., `mine 64 diamond_ore`) +- `build ` - Build a schematic from the schematics folder +- `build ` - Build at specific coordinates (can use relative: `~ ~1 ~-5`) +- `litematica [index]` - Build the currently loaded litematica schematic +- `farm [range] [waypoint]` - Automatically farm crops within range -To toggle a boolean setting, just say its name in chat (for example saying `allowBreak` toggles whether Baritone will consider breaking blocks). For a numeric setting, say its name then the new value (like `primaryTimeoutMS 250`). It's case insensitive. To reset a setting to its default value, say `acceptableThrowawayItems reset`. To reset all settings, say `reset`. To see all settings that have been modified from their default values, say `modified`. +## Selection & WorldEdit-like Commands (NEW!) +The `sel` command provides WorldEdit-like functionality for area manipulation: +- `sel pos1` or `sel p1` - Set position 1 to current location +- `sel pos2` or `sel p2` - Set position 2 to current location +- `sel pos1 ` - Set position 1 to specific coordinates +- `sel clear` or `sel c` - Clear all selections +- `sel undo` or `sel u` - Undo last selection action +- `sel set ` or `sel fill ` - Fill selection with blocks +- `sel cleararea` or `sel ca` - Clear area (set to air) +- `sel walls ` - Fill walls of selection +- `sel shell ` - Fill walls, floor, and ceiling +- `sel replace ` - Replace specific blocks +- `sel sphere ` - Fill with sphere shape +- `sel hsphere ` - Fill with hollow sphere +- `sel cylinder [axis]` - Fill with cylinder (default Y axis) +- `sel hcylinder [axis]` - Fill with hollow cylinder +- `sel copy [position]` - Copy selection to clipboard +- `sel paste [position]` - Paste from clipboard +- `sel expand ` - Expand selection +- `sel contract ` - Contract selection +- `sel shift ` - Shift selection + +## Elytra Flying (NEW!) +For automated nether travel using elytra and fireworks: +- `elytra` - Fly to current goal using elytra (nether only) +- `elytra reset` - Reset elytra state but keep same goal +- `elytra repack` - Queue chunks for repacking +- `elytra supported` - Check if your system supports elytra features + +**Important:** Elytra requires accepting terms and configuring seed settings. See detailed help with `#help elytra`. + +## Following & Item Management +- `follow player ` - Follow a specific player +- `follow players` - Follow any nearby players +- `follow entities` - Follow any nearby entities +- `follow entity ` - Follow specific entity type (e.g., `follow entity pig`) +- `pickup` - Pick up all nearby items +- `pickup ` - Pick up specific items only (e.g., `pickup diamond emerald`) + +## World Exploration +- `explore [x] [z]` - Explore world from origin point (default: current position) +- `explorefilter [invert]` - Apply exploration filter from JSON file +- `find ` - Search cache for block locations +- `click` - Click to set destinations (left/right click, drag for selections) + +## Waypoints +Full waypoint system for saving and navigating to locations: +- `wp` or `waypoints` - List all waypoints +- `wp save ` - Save current location as waypoint +- `wp goal ` - Set goal to waypoint +- `wp goto ` - Go to waypoint immediately +- `wp list [tag]` - List waypoints (optionally filtered by tag) +- `wp delete ` - Delete a waypoint +- `sethome` - Quick save home waypoint +- `home` - Quick go to home waypoint + +Common tags: `home` (bed locations), `death` (death locations), `user` (manual waypoints) + +## Information & Debugging +- `version` - Show Baritone version +- `proc` - Show information about current process +- `eta` - Show estimated time to goal +- `help [command]` - Show help (general or for specific command) + +## System Commands +- `repack` - Re-cache surrounding chunks +- `reloadall` - Reload world cache from disk +- `saveall` - Save world cache to disk +- `render` - Fix glitched chunk rendering +- `gc` - Call garbage collection +- `blacklist` - Blacklist current target block + +# Settings + +All the settings and documentation are available in the [Settings.java file](https://github.com/cabaletta/baritone/blob/master/src/api/java/baritone/api/Settings.java) and [online documentation](https://baritone.leijurv.com/baritone/api/Settings.html#field.detail). + +There are over 100 settings available. Here are the most important ones for general usage: + +## Core Behavior Settings +- `allowBreak` - Allow breaking blocks (default: true) +- `allowSprint` - Allow sprinting (default: true) +- `allowPlace` - Allow placing blocks (default: true) +- `allowInventory` - Allow moving items in inventory (default: false) +- `allowParkour` - Allow parkour movements (default: true) +- `allowParkourPlace` - Allow placing blocks for parkour (default: true) +- `allowDiagonalAscend` - Allow diagonal ascending movements (default: false) +- `allowDiagonalDescend` - Allow diagonal descending movements (default: false) + +## Pathing & Performance +- `primaryTimeoutMS` - Max time for pathfinding (default: 500ms) +- `costHeuristic` - A* heuristic value (default: 3.563) +- `blockPlacementPenalty` - Cost penalty for placing blocks (default: 20.0) +- `blockBreakAdditionalPenalty` - Additional cost for breaking blocks (default: 2.0) + +## Visual & Cache Settings +- `renderCachedChunks` - Render cached chunks (performance intensive) +- `cachedChunksOpacity` - Opacity of rendered cached chunks +- `chunkCaching` - Enable chunk caching for long-distance pathing (default: true) +- `renderPath` - Render the current path +- `renderGoal` - Render the current goal + +## Mining Settings +- `legitMine` - Only mine blocks you can see (default: false) +- `avoidance` - Avoid mobs and spawners (default: false, impacts performance) +- `mobSpawnerAvoidanceRadius` - Distance to avoid spawners (default: 16) +- `mineScanDroppedItems` - Scan for dropped items while mining + +## Building Settings +- `buildInLayers` - Build schematics layer by layer (default: false) +- `buildRepeatDistance` - Distance for repeating builds +- `buildRepeatDirection` - Direction for repeating builds +- `buildSkipBlocks` - Blocks to consider already correct +- `buildIgnoreBlocks` - Blocks to treat as air in schematics + +## Miscellaneous Settings +- `backfill` - Fill in tunnels behind you (default: false) +- `followRadius` - Radius for following entities (default: 3) +- `acceptableThrowawayItems` - Items Baritone can use for bridging/pillaring +- `blocksToAvoidBreaking` - Blocks to avoid breaking (chests, crafting tables, etc.) +- `chatControl` - Enable direct chat control (default: true) +- `prefixControl` - Enable prefix-based chat control (default: true) + +## Elytra Settings +- `elytraAutoJump` - Automatically jump to take off (default: false) +- `elytraFireworkSpeed` - Speed multiplier with fireworks (default: 1.0) +- `elytraPredictTerrain` - Use seed for terrain prediction (default: false) +- `elytraNetherSeed` - World seed for terrain prediction +- `elytraConserveFireworks` - Use fireworks more conservatively (default: false) +- `elytraTermsAccepted` - Accept elytra usage terms (required for elytra commands) -Commands in Baritone: -- `thisway 1000` then `path` to go in the direction you're facing for a thousand blocks -- `goal x y z` or `goal x z` or `goal y`, then `path` to set a goal to a certain coordinate then path to it -- `goto x y z` or `goto x z` or `goto y` to go to a certain coordinate (in a single step, starts going immediately) -- `goal` to set the goal to your player's feet -- `goal clear` to clear the goal -- `cancel` or `stop` to stop everything, `forcecancel` is also an option -- `goto portal` or `goto ender_chest` or `goto block_type` to go to a block. (in Impact, `.goto` is an alias for `.b goto` for the most part) -- `mine diamond_ore iron_ore` to mine diamond ore or iron ore (turn on the setting `legitMine` to only mine ores that it can actually see. It will explore randomly around y=11 until it finds them.) An amount of blocks can also be specified, for example, `mine 64 diamond_ore`. -- `click` to click your destination on the screen. Right click path to on top of the block, left click to path into it (either at foot level or eye level), and left click and drag to select an area (`#help sel` to see what you can do with that selection). -- `follow player playerName` to follow a player. `follow players` to follow any players in range (combine with Kill Aura for a fun time). `follow entities` to follow any entities. `follow entity pig` to follow entities of a specific type. -- `wp` for waypoints. A "tag" is like "home" (created automatically on right clicking a bed) or "death" (created automatically on death) or "user" (has to be created manually). So you might want `#wp save user coolbiome`, then to set the goal `#wp goal coolbiome` then `#path` to path to it. For death, `#wp goal death` will list waypoints under the "death" tag (remember stuff is clickable!) -- `build` to build a schematic. `build blah.schematic` will load `schematics/blah.schematic` and build it with the origin being your player feet. `build blah.schematic x y z` to set the origin. Any of those can be relative to your player (`~ 69 ~-420` would build at x=player x, y=69, z=player z-420). -- `schematica` to build the schematic that is currently open in schematica -- `tunnel` to dig and make a tunnel, 1x2. It will only deviate from the straight line if necessary such as to avoid lava. For a dumber tunnel that is really just cleararea, you can `tunnel 3 2 100`, to clear an area 3 high, 2 wide, and 100 deep. -- `farm` to automatically harvest, replant, or bone meal crops. Use `farm ` or `farm ` to limit the max distance from the starting point or a waypoint. -- `axis` to go to an axis or diagonal axis at y=120 (`axisHeight` is a configurable setting, defaults to 120). -- `explore x z` to explore the world from the origin of x,z. Leave out x and z to default to player feet. This will continually path towards the closest chunk to the origin that it's never seen before. `explorefilter filter.json` with optional invert can be used to load in a list of chunks to load. -- `invert` to invert the current goal and path. This gets as far away from it as possible, instead of as close as possible. For example, do `goal` then `invert` to run as far as possible from where you're standing at the start. -- `come` tells Baritone to head towards your camera, useful when freecam doesn't move your player position. -- `blacklist` will stop baritone from going to the closest block so it won't attempt to get to it. -- `eta` to get information about the estimated time until the next segment and the goal, be aware that the ETA to your goal is really unprecise. -- `proc` to view miscellaneous information about the process currently controlling Baritone. -- `repack` to re-cache the chunks around you. -- `gc` to call `System.gc()` which may free up some memory. -- `render` to fix glitched chunk rendering without having to reload all of them. -- `reloadall` to reload Baritone's world cache or `saveall` to save Baritone's world cache. -- `find` to search through Baritone's cache and attempt to find the location of the block. -- `surface` or `top` to tell Baritone to head towards the closest surface-like area, this can be the surface or highest available air space. -- `version` to get the version of Baritone you're running -- `damn` daniel - -All the settings and documentation are here. If you find HTML easier to read than Javadoc, you can look here. - -There are about a hundred settings, but here are some fun / interesting / important ones that you might want to look at changing in normal usage of Baritone. The documentation for each can be found at the above links. -- `allowBreak` -- `allowSprint` -- `allowPlace` -- `allowParkour` -- `allowParkourPlace` -- `blockPlacementPenalty` -- `renderCachedChunks` (and `cachedChunksOpacity`) <-- very fun but you need a beefy computer -- `avoidance` (avoidance of mobs / mob spawners) -- `legitMine` -- `followRadius` -- `backfill` (fill in tunnels behind you) -- `buildInLayers` -- `buildRepeatDistance` and `buildRepeatDirection` -- `worldExploringChunkOffset` -- `acceptableThrowawayItems` -- `blocksToAvoidBreaking` -- `mineScanDroppedItems` -- `allowDiagonalAscend` - - - - -# Troubleshooting / common issues + + + +# Process Management + +Baritone uses a process system where only one main process can be active at a time. Available processes include: + +- **Builder Process** - Building schematics and structures +- **Mine Process** - Mining specific blocks or quantities +- **Farm Process** - Automatic farming operations +- **Follow Process** - Following players, entities, or picking up items +- **Explore Process** - World exploration and chunk discovery +- **Elytra Process** - Automated elytra flying in the Nether +- **Custom Goal Process** - Manual goal setting and pathfinding +- **Get To Block Process** - Pathfinding to specific block types + +Use `proc` to see which process is currently active and get information about its state. + +# Troubleshooting / Common Issues ## Why doesn't Baritone respond to any of my chat commands? -This could be one of many things. +This could be several things: + +1. **Check Installation**: Make sure Baritone is installed. It should create a `baritone` folder in your Minecraft directory. + +2. **Check Prefix Settings**: Verify you're using the correct prefix: + - Default prefix is `#` (e.g., `#help`) + - Some clients like Impact use `.b` as an alias + - Check if direct chat control is enabled with `#chatControl` and `#prefixControl` + +3. **Client-Specific Issues**: Some clients like Impact disable direct chat control by default. This is a **saved setting** that persists across different clients. If `chatControl` was turned off in Impact, it will remain off in other clients too. + - Solution: Use the `#` prefix or edit `baritone/settings.txt` in your Minecraft folder + - Remove the line `chatControl false` and restart your client + +## Common Command Issues + +**Q: Why can I do `.goto x z` in Impact but not elsewhere?** +A: That's a custom command added by Impact, not a Baritone command. Use `goto x z` instead. + +**Q: Why can I do `-path to x z` in KAMI but not elsewhere?** +A: That's a KAMI-specific command. The Baritone equivalent is `goto x z`. + +## Performance Issues + +**Q: Baritone is running slowly or causing lag** +A: Try these settings: +- Disable `renderCachedChunks` if enabled +- Increase `primaryTimeoutMS` to give more time for pathfinding +- Disable `avoidance` (it impacts performance significantly) +- Reduce `followRadius` if using follow commands + +**Q: Pathfinding is taking too long** +A: Adjust timeout settings: +- Increase `primaryTimeoutMS` (default: 500ms) +- Increase `failureTimeoutMS` (default: 2000ms) +- Consider using `costHeuristic` > 3.563 for faster but suboptimal paths + +## Building & Mining Issues + +**Q: Builder is not placing blocks correctly** +A: Check these settings: +- Ensure `allowPlace` is enabled +- Verify you have the correct blocks in inventory +- Check `buildSkipBlocks` and `buildIgnoreBlocks` settings +- Try `buildInLayers` for complex builds + +**Q: Mining is not working efficiently** +A: Consider these settings: +- Enable `legitMine` to only mine visible ores +- Adjust `mineScanDroppedItems` to collect drops +- Use `backfill` to fill tunnels behind you +- Set appropriate `blocksToAvoidBreaking` list + +## Elytra Issues + +**Q: Elytra commands not working** +A: Elytra requires specific setup: +- Must be in the Nether dimension +- Set `elytraTermsAccepted` to true +- Configure `elytraNetherSeed` if using terrain prediction +- Check `elytra supported` to verify system compatibility -First, make sure it's actually installed. An easy way to check is seeing if it created the folder `baritone` in your Minecraft folder. +**Q: Elytra flying is unreliable** +A: Try these settings: +- Set `elytraPredictTerrain` to false if you don't know the seed +- Increase `elytraMinFireworksBeforeLanding` for safety +- Enable `elytraAllowEmergencyLand` to prevent crashes -Second, make sure that you're using the prefix properly, and that chat control is enabled in the way you expect. +## General Tips -For example, Impact disables direct chat control. (i.e. anything typed in chat without a prefix will be ignored and sent publicly). **This is a saved setting**, so if you run Impact once, `chatControl` will be off from then on, **even in other clients**. -So you'll need to use the `#` prefix or edit `baritone/settings.txt` in your Minecraft folder to undo that (specifically, remove the line `chatControl false` then restart your client). +1. **Use `#help `** for detailed information about specific commands +2. **Check `#modified`** to see what settings you've changed from defaults +3. **Use `#reset`** to restore all settings to defaults if things go wrong +4. **Enable `chatDebug`** temporarily to see what Baritone is doing +5. **Use `#proc`** to understand what process is currently running +6. **Try `#forcecancel`** if Baritone seems stuck +## Getting More Help -## Why can I do `.goto x z` in Impact but nowhere else? Why can I do `-path to x z` in KAMI but nowhere else? -These are custom commands that they added; those aren't from Baritone. -The equivalent you're looking for is `goto x z`. +- Use `#version` to check your Baritone version when reporting issues +- Check the [GitHub repository](https://github.com/cabaletta/baritone) for documentation and issue reports +- Join the community Discord for real-time help and discussion +- Browse the [Settings documentation](https://baritone.leijurv.com/baritone/api/Settings.html) for detailed configuration options From 2db7d9ad5f6399ff0d08e6f5754c649e06578eff Mon Sep 17 00:00:00 2001 From: tboy1337 Date: Sun, 17 Aug 2025 12:14:39 +0100 Subject: [PATCH 2/2] Update USAGE.md to include new settings and clarify command usage - Added `allowBreakAnyway` setting to the Core Behavior section. - Updated command usage examples to reflect the correct syntax for Baritone commands. - Removed outdated references to `costHeuristic` in the Performance Issues section. --- USAGE.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/USAGE.md b/USAGE.md index 962c704e4..4d8cd57bb 100644 --- a/USAGE.md +++ b/USAGE.md @@ -136,6 +136,7 @@ There are over 100 settings available. Here are the most important ones for gene ## Core Behavior Settings - `allowBreak` - Allow breaking blocks (default: true) +- `allowBreakAnyway` - Break blocks even if they're in the avoid list (default: false) - `allowSprint` - Allow sprinting (default: true) - `allowPlace` - Allow placing blocks (default: true) - `allowInventory` - Allow moving items in inventory (default: false) @@ -146,7 +147,6 @@ There are over 100 settings available. Here are the most important ones for gene ## Pathing & Performance - `primaryTimeoutMS` - Max time for pathfinding (default: 500ms) -- `costHeuristic` - A* heuristic value (default: 3.563) - `blockPlacementPenalty` - Cost penalty for placing blocks (default: 20.0) - `blockBreakAdditionalPenalty` - Additional cost for breaking blocks (default: 2.0) @@ -223,10 +223,10 @@ This could be several things: ## Common Command Issues **Q: Why can I do `.goto x z` in Impact but not elsewhere?** -A: That's a custom command added by Impact, not a Baritone command. Use `goto x z` instead. +A: That's a custom command added by Impact, not a Baritone command. Use `#goto x z` instead. **Q: Why can I do `-path to x z` in KAMI but not elsewhere?** -A: That's a KAMI-specific command. The Baritone equivalent is `goto x z`. +A: That's a KAMI-specific command. The Baritone equivalent is `#goto x z`. ## Performance Issues @@ -241,7 +241,6 @@ A: Try these settings: A: Adjust timeout settings: - Increase `primaryTimeoutMS` (default: 500ms) - Increase `failureTimeoutMS` (default: 2000ms) -- Consider using `costHeuristic` > 3.563 for faster but suboptimal paths ## Building & Mining Issues @@ -254,9 +253,7 @@ A: Check these settings: **Q: Mining is not working efficiently** A: Consider these settings: -- Enable `legitMine` to only mine visible ores - Adjust `mineScanDroppedItems` to collect drops -- Use `backfill` to fill tunnels behind you - Set appropriate `blocksToAvoidBreaking` list ## Elytra Issues