Wiki 9Minecraft Baritone 9minecraft Client Mod Wiki
Baritone 9minecraft Client Mod Wiki › Guide

Baritone 9minecraft Client Mod — Guide

Getting Started

  1. Install the mod. Drop the Fabric or NeoForge jar into your mods folder (see the How to Install section on the main download page). Baritone has no other dependencies.
  2. Launch the game and join any single-player world or server.
  3. Open chat (press T) and type a command. Every Baritone command starts with the prefix #.
  4. Type #help first — the command list is clickable and supports tab-completion.

A good first test:

#goto 100 64 100

Baritone immediately starts walking to those coordinates, tracing a glowing path as it goes. Type #stop at any time to cancel.

Tip: by default you can also type commands directly without the #, but that risks a typo leaking into public chat, so the # prefix is recommended.

Command What it does
#goto <x> <y> <z> Path to an exact coordinate and start moving immediately.
#goto <x> <z> Path to an X/Z column at any height.
#goto <block> Walk to the nearest block of a type, e.g. #goto ender_chest.
#goal <x> <y> <z> Set a goal without moving yet; run #path to start.
#goal Set the goal to your current position.
#goal clear Remove the current goal.
#path Begin pathing toward the active goal.
#thisway <distance> Make a goal <distance> blocks ahead in the direction you face.
#come Path toward your camera (handy with freecam).
#stop / #cancel Stop everything Baritone is doing.
#forcecancel Hard-cancel if a process refuses to stop.

Mining & Building

Command What it does
#mine <block> [block...] Auto-mine one or more block types, e.g. #mine diamond_ore iron_ore.
#mine <count> <block> Mine until you have a target amount, e.g. #mine 64 diamond_ore.
#build <name> Load schematics/<name>.schematic and build it where you stand.
#build <name> <x> <y> <z> Build a schematic at a fixed coordinate.
#schematica Build whatever schematic is currently open in Schematica.
#tunnel Dig a straight 1x2 tunnel ahead of you.
#tunnel <height> <width> <length> Dig a tunnel of custom dimensions.
#farm [range] [waypoint] Auto-harvest, replant, and bonemeal nearby crops.
#sel Selection commands for area builds, fills, and cleanup.

Following & Waypoints

Command What it does
#follow player <name> Follow a specific player.
#follow players Follow any nearby players.
#follow entity <type> Follow a chosen entity type.
#follow entities Follow any nearby entities.
#wp save user <tag> Save a waypoint with a tag.
#wp goal <tag> Set your goal to a saved waypoint, e.g. #wp goal home or #wp goal death.

Exploration & Utility

Command What it does
#explore [x z] Continuously path to the nearest never-seen chunk (optionally from an origin).
#explorefilter <file.json> [invert] Explore only the chunks listed in a filter file.
#axis Path to the nearest axis line at y=120.
#surface / #top Head to the nearest open surface.
#find <block> Search Baritone's chunk cache for a block's location.
#click Path to the spot you click on screen.
#invert Invert the current goal (flee instead of approach).
#blacklist Temporarily forbid the nearest target block.

System & Info

Command What it does
#help Clickable list of every command with tab-completion.
#version Show the installed Baritone version.
#eta Estimated time to reach the current goal.
#proc Info about the process currently controlling Baritone.
#modified List every setting you have changed from default.
#reset Reset all settings (or one) to defaults.
#repack / #render Re-cache or re-render nearby chunks.
#saveall / #reloadall Save or reload the world cache.
#gc Force a garbage-collection pass.

Goals

A goal is the objective Baritone tries to reach. Most commands create a goal for you, but understanding goal types helps when using the API or composite objectives.

  • GoalBlock(x, y, z) — reach one exact block position.
  • GoalXZ(x, z) — reach an X/Z column at any Y (best for long travel).
  • GoalYLevel(y) — reach a specific height.
  • GoalNear(x, y, z, range) — get within range blocks of a position.
  • GoalGetToBlock(x, y, z) — stand adjacent to a block (used by #goto <block>).
  • GoalComposite(...) — satisfy any one of several goals (closest wins).
  • GoalRunAway(...) — maximize distance from a point (used by #invert).

#goal sets a goal and waits; #goto sets a goal and starts pathing immediately.

Usage Examples

Strip-mine for diamonds, then stop after 32:

#mine 32 diamond_ore

Travel ten thousand blocks out without micromanaging:

#allowParkour true
#goto 10000 ~ 10000

Build a base from a schematic file you placed in schematics/:

#build mybase

Follow a friend across the map:

#follow player Steve

Auto-farm a wheat field within 20 blocks:

#farm 20

Explore to reveal new terrain (great for map-makers):

#explore

Developer API (for Modders)

Because Baritone ships an api artifact under LGPL 3.0, other mods and custom clients can drive it programmatically. Add the baritone-api jar as a dependency (compile against the API package baritone.api), then control the primary Baritone instance.

Minimal example

import baritone.api.BaritoneAPI;
import baritone.api.pathing.goals.GoalXZ;
import baritone.api.pathing.goals.GoalBlock;

// Tune settings
BaritoneAPI.getSettings().allowSprint.value = true;
BaritoneAPI.getSettings().primaryTimeoutMS.value = 2000L;

// Send Baritone to an X/Z coordinate
BaritoneAPI.getProvider().getPrimaryBaritone()
    .getCustomGoalProcess()
    .setGoalAndPath(new GoalXZ(10000, 20000));

Key entry points

  • BaritoneAPI.getProvider().getPrimaryBaritone() → the active IBaritone.
  • IBaritone.getCustomGoalProcess() → setGoalAndPath(Goal), setGoal(Goal), path().
  • IBaritone.getPathingBehavior() → cancel, status, current path.
  • IBaritone.getMineProcess().mine(...) → start an auto-mine task.
  • IBaritone.getBuilderProcess().build(...) → build a schematic.
  • IBaritone.getExploreProcess() / getFollowProcess() → exploration and following.
  • BaritoneAPI.getSettings() → every setting as a typed, mutable field.

Goal classes (package baritone.api.pathing.goals)

GoalBlock, GoalXZ, GoalYLevel, GoalNear, GoalGetToBlock, GoalComposite, GoalRunAway — construct one and hand it to setGoalAndPath.

Remember: distributing a client that bundles Baritone means complying with LGPL 3.0 (keep Baritone's source available and attributed).