baritone/USAGE.md
millennIumAMbiguity 0a27c0b6e4
Added missing information to USAGE.md
Added missing information about the `farm` command.
2021-04-07 18:12:47 +02:00

7.2 KiB

(assuming you already have Baritone set up)

Prefix

Baritone's chat control prefix is # by default. In Impact, you can also use .b as a prefix. (for example, .b click instead of #click)

Baritone commands can also by default be typed in the chatbox. However if you make a typo, like typing "gola 10000 10000" instead of "goal" it goes into public chat, which is bad, so using # is suggested.

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+

Lots of the commands have changed, BUT #help is improved vastly (its clickable! commands have tab completion! oh my!).

Try #help I promise it won't just send you back here =)

"wtf where is cleararea" -> look at #help sel

"wtf where is goto death, goto waypoint" -> look at #help wp

just look at #help lmao

Watch this showcase video!

Commands

Tutorial playlist

All of these commands may need a prefix before them, as above ^.

help

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.

Some common examples:

  • 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
  • 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 <range> or farm <range> <waypoint> 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.
  • version to get the version of Baritone you're running
  • damn daniel

For the rest of the commands, you can take a look at the code here.

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

Why doesn't Baritone respond to any of my chat commands?

This could be one of many things.

First, make sure it's actually installed. An easy way to check is seeing if it created the folder baritone in your Minecraft folder.

Second, make sure that you're using the prefix properly, and that chat control is enabled in the way you expect.

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).

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.