baritone/README.md

9.2 KiB

Baritone

GitHub All Releases

Minecraft Minecraft Minecraft Minecraft Minecraft Minecraft Minecraft

Build Status Release License Codacy Badge Code of Conduct Known Vulnerabilities Contributions welcome Issues GitHub issues-closed Pull Requests GitHub contributors GitHub commits Code size GitHub repo size Lines of Code

Impact integration KAMI Blue integration ForgeHax integration Aristois add-on integration rootNET integration Future integration RusherHack integration

forthebadge forthebadge

A Minecraft pathfinder bot.

Baritone Discord Server

Baritone is the pathfinding system used in Impact since 4.4. There's a showcase video made by @Adovin#0730 on Baritone which I recommend. Here's a (very old!) video I made showing off what it can do. Tutorial playlist

The easiest way to install Baritone is to install Impact, which comes with Baritone. The second easiest way (for 1.12.2 only) is to install the v1.2.* api-forge jar from releases. For 1.12.2 Forge, just click here. Otherwise, see Installation & setup. Once Baritone is installed, look here for instructions on how to use it.

For 1.15.2, click here and see description. If you need Forge 1.15.2, look here, follow the instructions, and get the api-forge jar.

For 1.16.5, click here and see description. If you need Forge or Fabric 1.16.5, look here and get the api-forge or api-fabric jar. For 1.16.5 Fabric, just click here.

If you need Forge or Fabric 1.17.1, look here and get the api-forge or api-fabric jar. For 1.17.1 Fabric, just click here.

If you need Forge or Fabric 1.18.1, look here and get the api-forge or api-fabric jar. For 1.18.1 Fabric, just click here.

This project is an updated version of MineBot, the original version of the bot for Minecraft 1.8.9, rebuilt for 1.12.2 onwards. Baritone focuses on reliability and particularly performance (it's over 30x faster than MineBot at calculating paths).

Have committed at least once a day from Aug 1, 2018, to Aug 1, 2019.

1Leijurv3DWTrGAfmmiTphjhXLvQiHg7K2

Getting Started

Here are some links to help to get started:

Stars over time

Stargazers over time

API

The API is heavily documented, you can find the Javadocs for the latest release here. Please note that usage of anything located outside of the baritone.api package is not supported by the API release jar.

Below is an example of basic usage for changing some settings, and then pathing to an X/Z goal.

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

BaritoneAPI.getProvider().getPrimaryBaritone().getCustomGoalProcess().setGoalAndPath(new GoalXZ(10000, 20000));

FAQ

Can I use Baritone as a library in my custom utility client?

That's what it's for, sure! (As long as usage complies with the LGPL 3.0 License)

How is it so fast?

Magic. (Hours of leijurv enduring excruciating pain)

Additional Special Thanks To:

YourKit-Logo

YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications.

YourKit is the creator of the YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor.

We thank them for granting Baritone an OSS license so that we can make our software the best it can be.

Why is it called Baritone?

It's named for FitMC's deep sultry voice.