2018-09-03 16:25:44 +00:00
# Baritone
2018-09-17 03:23:08 +00:00
[](https://travis-ci.com/cabaletta/baritone)
2018-10-18 21:36:14 +00:00
[](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)
2018-10-27 16:25:53 +00:00
[](http://hits.dwyl.com/cabaletta/baritone)
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)
2018-10-27 16:25:53 +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-02-12 06:26:49 +00:00
2018-11-01 03:37:18 +00:00
[](https://minecraft.gamepedia.com/1.12.2)
2019-01-25 00:06:53 +00:00
[](https://github.com/cabaletta/baritone/graphs/contributors/)
[](https://github.com/cabaletta/baritone/commit/)
2019-03-24 20:50:50 +00:00
[](https://impactdevelopment.github.io/)
2019-03-13 06:29:08 +00:00
[](https://wweclient.com/)
2019-03-04 05:29:31 +00:00
[](https://github.com/zeroeightysix/KAMI/)
2019-01-20 23:31:30 +00:00
[](https://futureclient.net/)
2019-01-22 07:32:41 +00:00
[](https://github.com/fr1kin/ForgeHax)
2019-03-21 23:58:31 +00:00
[](http://forthebadge.com)
[](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
2018-10-27 03:04:12 +00:00
Baritone is the pathfinding system used in [Impact ](https://impactdevelopment.github.io/ ) since 4.4. There's a [showcase video ](https://www.youtube.com/watch?v=yI8hgW_m6dQ ) made by @Adovin#3153 on Baritone's integration into Impact. [Here's ](https://www.youtube.com/watch?v=StquF69-_wI ) a video I made showing off what it can do.
2018-10-16 00:01:29 +00:00
2018-11-07 04:12:02 +00:00
This project is an updated version of [MineBot ](https://github.com/leijurv/MineBot/ ),
2019-03-11 06:43:00 +00:00
the original version of the bot for Minecraft 1.8.9, rebuilt for 1.12.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-07 04:12:02 +00:00
2019-04-02 06:30:33 +00:00
Have committed at least once a day for the last 8 months =D 🦀
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-04-27 06:17:18 +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-02-05 20:34:29 +00:00
- [Baritone chat control usage ](USAGE.md )
2019-02-05 05:23:19 +00:00
2019-02-23 00:12:04 +00:00
# API
The API is heavily documented, you can find the Javadocs for the latest release [here ](https://baritone.leijurv.com/ ).
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 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-02-12 17:58:44 +00:00
That's what it's for, sure! (As long as usage is in compliance with the LGPL 3 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-03-12 05:21:35 +00:00
Magic. (Hours of [leijurv ](https://github.com/leijurv ) enduring excruciating pain)
2018-09-15 15:14:57 +00:00
## Why is it called Baritone?
2018-09-26 00:04:34 +00:00
It's named for FitMC's deep sultry voice.
