2018-09-03 09:25:44 -07:00
# Baritone
2020-04-18 22:07:18 -07:00
[](http://hits.dwyl.com/cabaletta/baritone/)
[](https://github.com/cabaletta/baritone/releases/)
2019-06-21 03:59:10 -05:00
[](https://travis-ci.com/cabaletta/baritone/)
[](https://github.com/cabaletta/baritone/releases/)
2019-02-26 17:29:50 -06:00
[](LICENSE)
2018-10-13 12:36:05 -07: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-23 22:30:04 -07:00
[](https://github.com/cabaletta/baritone/tree/master/)
2019-06-16 23:06:57 -07:00
[](https://github.com/cabaletta/baritone/tree/1.13.2/)
2019-07-23 22:30:04 -07:00
[](https://github.com/cabaletta/baritone/tree/1.14.4/)
2020-02-14 13:49:53 -08:00
[](https://github.com/cabaletta/baritone/tree/1.15.2/)
2019-03-02 22:40:42 -08:00
[](https://github.com/cabaletta/baritone/blob/master/CODE_OF_CONDUCT.md)
2018-12-13 14:43:32 -08:00
[](https://snyk.io/test/github/cabaletta/baritone?targetFile=build.gradle)
2019-06-21 03:59:10 -05:00
[](https://github.com/cabaletta/baritone/issues/)
2019-01-24 16:06:53 -08:00
[](https://github.com/cabaletta/baritone/issues/)
2019-01-24 16:25:35 -08:00
[](https://github.com/cabaletta/baritone/issues?q=is%3Aissue+is%3Aclosed)
2019-01-24 16:06:53 -08:00
[](https://github.com/cabaletta/baritone/pulls/)
2019-01-24 16:31:12 -08:00
2019-01-24 16:06:53 -08:00
2019-06-08 23:13:27 -07:00
2019-01-24 16:06:53 -08:00
[](https://github.com/cabaletta/baritone/graphs/contributors/)
[](https://github.com/cabaletta/baritone/commit/)
2020-07-29 12:52:19 -07:00
[](https://impactclient.net/)
2020-06-04 11:32:20 -07:00
[](https://github.com/kami-blue/client)
2019-06-17 22:44:38 -07:00
[](https://github.com/fr1kin/ForgeHax/)
2019-08-21 23:50:13 -07:00
[](https://gitlab.com/emc-mods-indrit/baritone_api)
2020-02-01 16:42:14 -08:00
[](https://rootnet.dev/)
2019-03-12 23:29:08 -07:00
[](https://wweclient.com/)
2020-07-16 14:35:17 -03:00
[](https://futureclient.net/)
2020-07-20 03:12:24 -04:00
[](https://rusherhack.org/)
2019-06-18 23:15:47 -07:00
[](http://forthebadge.com/)
2019-06-19 20:41:21 -07:00
[](http://forthebadge.com/)
2019-01-24 16:10:21 -08:00
2018-11-06 20:12:02 -08:00
A Minecraft pathfinder bot.
2018-08-26 08:45:02 -07:00
2020-02-22 18:37:29 -08: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.
2018-10-15 17:01:29 -07:00
2020-05-03 18:51:21 -07: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-02 22:13:17 -07:00
2020-04-26 13:22:55 -07: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.
2020-02-14 13:49:15 -08:00
2018-11-06 20:12:02 -08:00
This project is an updated version of [MineBot ](https://github.com/leijurv/MineBot/ ),
2020-02-14 13:49:53 -08:00
the original version of the bot for Minecraft 1.8.9, rebuilt for 1.12.2 through 1.15.2. 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-06 20:12:02 -08:00
2019-08-01 23:47:32 -07:00
Have committed at least once a day from Aug 1 2018 to Aug 1 2019.
2019-02-01 22:54:14 -08:00
2019-02-11 19:21:08 -08:00
1Leijurv3DWTrGAfmmiTphjhXLvQiHg7K2
2019-02-22 18:12:04 -06:00
# Getting Started
2018-09-23 19:39:04 -05:00
Here are some links to help to get started:
2018-09-02 11:15:43 -07:00
2018-09-23 19:39:04 -05:00
- [Features ](FEATURES.md )
2018-09-03 10:04:48 -07:00
2019-02-27 15:46:28 -08:00
- [Installation & setup ](SETUP.md )
2018-09-13 12:14:10 -05:00
2019-06-21 03:59:10 -05:00
- [API Javadocs ](https://baritone.leijurv.com/ )
2019-01-28 11:57:58 -08:00
2019-02-22 23:32:23 -08:00
- [Settings ](https://baritone.leijurv.com/baritone/api/Settings.html#field.detail )
2019-02-10 16:44:09 -08:00
2019-07-04 15:52:09 -07:00
- [Usage (chat control) ](USAGE.md )
2019-02-04 21:23:19 -08:00
2020-02-22 22:42:22 -08:00
## Stars over time
[](https://starchart.cc/cabaletta/baritone)
2019-02-22 18:12:04 -06:00
# API
2019-06-20 23:48:02 -07:00
The API is heavily documented, you can find the Javadocs for the latest release [here ](https://baritone.leijurv.com/ ).
2019-02-22 18:12:04 -06:00
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 a X/Z goal.
2018-08-27 12:02:51 -07:00
```
2018-09-23 19:23:57 -05:00
BaritoneAPI.getSettings().allowSprint.value = true;
2019-01-28 10:59:08 -08:00
BaritoneAPI.getSettings().primaryTimeoutMS.value = 2000L;
2018-08-27 12:02:51 -07:00
2018-11-18 17:32:16 -08:00
BaritoneAPI.getProvider().getPrimaryBaritone().getCustomGoalProcess().setGoalAndPath(new GoalXZ(10000, 20000));
2018-08-29 12:25:03 -07:00
```
2018-09-02 18:01:41 -05:00
# FAQ
2018-11-19 17:14:54 -08:00
## Can I use Baritone as a library in my custom utility client?
2018-08-29 12:25:03 -07:00
2019-06-09 23:56:54 -07:00
That's what it's for, sure! (As long as usage is in compliance with the LGPL 3.0 License)
2018-08-29 12:25:03 -07:00
2018-09-02 18:01:41 -05:00
## How is it so fast?
2018-08-29 12:25:03 -07:00
2019-06-21 03:59:10 -05:00
Magic. (Hours of [leijurv ](https://github.com/leijurv/ ) enduring excruciating pain)
2018-09-15 08:14:57 -07:00
2020-07-06 17:07:59 -07: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 08:14:57 -07:00
## Why is it called Baritone?
2020-07-06 17:07:59 -07:00
It's named for FitMC's deep sultry voice.
