2018-09-03 16:25:44 +00:00
# Baritone
2020-04-19 05:07:18 +00:00
[](http://hits.dwyl.com/cabaletta/baritone/)
[](https://github.com/cabaletta/baritone/releases/)
2019-06-21 08:59:10 +00:00
[](https://travis-ci.com/cabaletta/baritone/)
[](https://github.com/cabaletta/baritone/releases/)
2019-02-26 23:29:50 +00:00
[](LICENSE)
2018-10-13 19:36:05 +00:00
[](https://www.codacy.com/app/leijurv/baritone?utm_source=github.com& utm_medium=referral& utm_content=cabaletta/baritone& utm_campaign=Badge_Grade)
2019-07-24 05:30:04 +00:00
[](https://github.com/cabaletta/baritone/tree/master/)
2019-06-17 06:06:57 +00:00
[](https://github.com/cabaletta/baritone/tree/1.13.2/)
2019-07-24 05:30:04 +00:00
[](https://github.com/cabaletta/baritone/tree/1.14.4/)
2020-02-14 21:49:53 +00:00
[](https://github.com/cabaletta/baritone/tree/1.15.2/)
2021-02-06 06:42:03 +00:00
[](https://github.com/cabaletta/baritone/tree/1.16.2/)
2020-12-25 05:34:02 +00:00
[](https://github.com/cabaletta/baritone/tree/1.16.4/)
2021-02-06 06:42:03 +00:00
[](https://github.com/cabaletta/baritone/tree/1.16.5/)
2019-03-03 06:40:42 +00:00
[](https://github.com/cabaletta/baritone/blob/master/CODE_OF_CONDUCT.md)
2018-12-13 22:43:32 +00:00
[](https://snyk.io/test/github/cabaletta/baritone?targetFile=build.gradle)
2019-06-21 08:59:10 +00:00
[](https://github.com/cabaletta/baritone/issues/)
2019-01-25 00:06:53 +00:00
[](https://github.com/cabaletta/baritone/issues/)
2019-01-25 00:25:35 +00:00
[](https://github.com/cabaletta/baritone/issues?q=is%3Aissue+is%3Aclosed)
2019-01-25 00:06:53 +00:00
[](https://github.com/cabaletta/baritone/pulls/)
2019-01-25 00:31:12 +00:00
2019-01-25 00:06:53 +00:00
2019-06-09 06:13:27 +00:00
2019-01-25 00:06:53 +00:00
[](https://github.com/cabaletta/baritone/graphs/contributors/)
[](https://github.com/cabaletta/baritone/commit/)
2020-07-29 19:52:19 +00:00
[](https://impactclient.net/)
2020-06-04 18:32:20 +00:00
[](https://github.com/kami-blue/client)
2019-06-18 05:44:38 +00:00
[](https://github.com/fr1kin/ForgeHax/)
2019-08-22 06:50:13 +00:00
[](https://gitlab.com/emc-mods-indrit/baritone_api)
2020-11-16 17:18:32 +00:00
[](https://rootnet.dev/)
2020-07-16 17:35:17 +00:00
[](https://futureclient.net/)
2020-07-20 07:12:24 +00:00
[](https://rusherhack.org/)
2019-06-19 06:15:47 +00:00
[](http://forthebadge.com/)
2019-06-20 03:41:21 +00:00
[](http://forthebadge.com/)
2019-01-25 00:10:21 +00:00
2018-11-07 04:12:02 +00:00
A Minecraft pathfinder bot.
2018-08-26 15:45:02 +00:00
2020-09-12 04:52:43 +00:00
Baritone is the pathfinding system used in [Impact ](https://impactclient.net/ ) since 4.4. There's a [showcase video ](https://youtu.be/CZkLXWo4Fg4 ) made by @Adovin#0730 on Baritone which I recommend. [Here's ](https://www.youtube.com/watch?v=StquF69-_wI ) a (very old!) video I made showing off what it can do. [Tutorial playlist ](https://www.youtube.com/playlist?list=PLnwnJ1qsS7CoQl9Si-RTluuzCo_4Oulpa )
2018-10-16 00:01:29 +00:00
2020-05-04 01:51:21 +00:00
The easiest way to install Baritone is to install [Impact ](https://impactclient.net/ ), which comes with Baritone. The second easiest way (for 1.12.2 only) is to install the v1.2.* `api-forge` jar from [releases ](https://github.com/cabaletta/baritone/releases ). **For 1.12.2 Forge, just click [here](https://github.com/cabaletta/baritone/releases/download/v1.2.14/baritone-api-forge-1.2.14.jar)** . Otherwise, see [Installation & setup ](SETUP.md ). Once Baritone is installed, look [here ](USAGE.md ) for instructions on how to use it.
2019-07-03 05:13:17 +00:00
2020-04-26 20:22:55 +00:00
For 1.15.2, [click here ](https://www.youtube.com/watch?v=j1qKtCZFURM ) and see description. If you need Forge 1.15.2, look [here ](https://github.com/cabaletta/baritone/releases/tag/v1.5.3 ), follow the instructions, and get the `api-forge` jar.
2019-07-24 05:30:04 +00:00
2021-02-06 06:41:52 +00:00
For 1.16.5, [click here ](https://www.youtube.com/watch?v=_4eVJ9Qz2J8 ) and see description. If you need Forge or Fabric 1.16.5, look [here ](https://github.com/cabaletta/baritone/releases/tag/v1.6.3 ) and get the `api-forge` or `api-fabric` jar. **For 1.16.5 Fabric, just click [here](https://github.com/cabaletta/baritone/releases/download/v1.6.3/baritone-api-fabric-1.6.3.jar)** .
2020-12-25 05:33:11 +00:00
2018-11-07 04:12:02 +00:00
This project is an updated version of [MineBot ](https://github.com/leijurv/MineBot/ ),
2021-02-06 06:41:52 +00:00
the original version of the bot for Minecraft 1.8.9, rebuilt for 1.12.2 through 1.16.5. Baritone focuses on reliability and particularly performance (it's over [30x faster ](https://github.com/cabaletta/baritone/pull/180#issuecomment-423822928 ) than MineBot at calculating paths).
2018-11-07 04:12:02 +00:00
2019-10-15 10:04:22 +00:00
Have committed at least once a day from Aug 1, 2018, to Aug 1, 2019.
2019-02-02 06:54:14 +00:00
2019-02-12 03:21:08 +00:00
1Leijurv3DWTrGAfmmiTphjhXLvQiHg7K2
2019-02-23 00:12:04 +00:00
# Getting Started
2018-09-24 00:39:04 +00:00
Here are some links to help to get started:
2018-09-02 18:15:43 +00:00
2018-09-24 00:39:04 +00:00
- [Features ](FEATURES.md )
2018-09-03 17:04:48 +00:00
2019-02-27 23:46:28 +00:00
- [Installation & setup ](SETUP.md )
2018-09-13 17:14:10 +00:00
2019-06-21 08:59:10 +00:00
- [API Javadocs ](https://baritone.leijurv.com/ )
2019-01-28 19:57:58 +00:00
2019-02-23 07:32:23 +00:00
- [Settings ](https://baritone.leijurv.com/baritone/api/Settings.html#field.detail )
2019-02-11 00:44:09 +00:00
2019-07-04 22:52:09 +00:00
- [Usage (chat control) ](USAGE.md )
2019-02-05 05:23:19 +00:00
2020-02-23 06:42:22 +00:00
## Stars over time
[](https://starchart.cc/cabaletta/baritone)
2019-02-23 00:12:04 +00:00
# API
2019-06-21 06:48:02 +00:00
The API is heavily documented, you can find the Javadocs for the latest release [here ](https://baritone.leijurv.com/ ).
2019-02-23 00:12:04 +00:00
Please note that usage of anything located outside of the ``baritone.api`` package is not supported by the API release
jar.
2019-10-15 10:04:22 +00:00
Below is an example of basic usage for changing some settings, and then pathing to an X/Z goal.
2018-08-27 19:02:51 +00:00
```
2018-09-24 00:23:57 +00:00
BaritoneAPI.getSettings().allowSprint.value = true;
2019-01-28 18:59:08 +00:00
BaritoneAPI.getSettings().primaryTimeoutMS.value = 2000L;
2018-08-27 19:02:51 +00:00
2018-11-19 01:32:16 +00:00
BaritoneAPI.getProvider().getPrimaryBaritone().getCustomGoalProcess().setGoalAndPath(new GoalXZ(10000, 20000));
2018-08-29 19:25:03 +00:00
```
2018-09-02 23:01:41 +00:00
# FAQ
2018-11-20 01:14:54 +00:00
## Can I use Baritone as a library in my custom utility client?
2018-08-29 19:25:03 +00:00
2019-10-15 10:04:22 +00:00
That's what it's for, sure! (As long as usage complies with the LGPL 3.0 License)
2018-08-29 19:25:03 +00:00
2018-09-02 23:01:41 +00:00
## How is it so fast?
2018-08-29 19:25:03 +00:00
2019-06-21 08:59:10 +00:00
Magic. (Hours of [leijurv ](https://github.com/leijurv/ ) enduring excruciating pain)
2018-09-15 15:14:57 +00:00
2020-07-07 00:07:59 +00:00
### Additional Special Thanks To:
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 ](https://www.yourkit.com/java/profiler/ ), [YourKit .NET Profiler ](https://www.yourkit.com/.net/profiler/ ), and [YourKit YouMonitor ](https://www.yourkit.com/youmonitor/ ).
We thank them for granting Baritone an OSS license so that we can make our software the best it can be.
2018-09-15 15:14:57 +00:00
## Why is it called Baritone?
2020-07-07 00:07:59 +00:00
It's named for FitMC's deep sultry voice.
