2018-09-03 16:25:44 +00:00
# Baritone
2021-03-25 18:51:18 +00:00
< p align = "center" >
< a href = "https://github.com/cabaletta/baritone/releases/" > < img src = "https://img.shields.io/github/downloads/cabaletta/baritone/total.svg" alt = "GitHub All Releases" / > < / a >
< / p >
< p align = "center" >
2023-06-14 04:32:21 +00:00
< a href = "#Baritone" > < img src = "https://img.shields.io/badge/MC-1.12.2-brightgreen.svg" alt = "Minecraft" / > < / a >
< a href = "#Baritone" > < img src = "https://img.shields.io/badge/MC-1.13.2-yellow.svg" alt = "Minecraft" / > < / a >
< a href = "#Baritone" > < img src = "https://img.shields.io/badge/MC-1.14.4-yellow.svg" alt = "Minecraft" / > < / a >
< a href = "#Baritone" > < img src = "https://img.shields.io/badge/MC-1.15.2-yellow.svg" alt = "Minecraft" / > < / a >
< a href = "#Baritone" > < img src = "https://img.shields.io/badge/MC-1.16.5-brightgreen.svg" alt = "Minecraft" / > < / a >
< a href = "#Baritone" > < img src = "https://img.shields.io/badge/MC-1.17.1-yellow.svg" alt = "Minecraft" / > < / a >
< a href = "#Baritone" > < img src = "https://img.shields.io/badge/MC-1.18.2-brightgreen.svg" alt = "Minecraft" / > < / a >
< a href = "#Baritone" > < img src = "https://img.shields.io/badge/MC-1.19.2-brightgreen.svg" alt = "Minecraft" / > < / a >
< a href = "#Baritone" > < img src = "https://img.shields.io/badge/MC-1.19.4-brightgreen.svg" alt = "Minecraft" / > < / a >
< a href = "#Baritone" > < img src = "https://img.shields.io/badge/MC-1.20.1-brightgreen.svg" alt = "Minecraft" / > < / a >
2021-03-25 18:51:18 +00:00
< / p >
< p align = "center" >
< a href = "https://travis-ci.com/cabaletta/baritone/" > < img src = "https://travis-ci.com/cabaletta/baritone.svg?branch=master" alt = "Build Status" / > < / a >
< a href = "https://github.com/cabaletta/baritone/releases/" > < img src = "https://img.shields.io/github/release/cabaletta/baritone.svg" alt = "Release" / > < / a >
< a href = "LICENSE" > < img src = "https://img.shields.io/badge/license-LGPL--3.0%20with%20anime%20exception-green.svg" alt = "License" / > < / a >
2022-03-08 23:14:00 +00:00
< a href = "https://www.codacy.com/gh/cabaletta/baritone/dashboard?utm_source=github.com&utm_medium=referral&utm_content=cabaletta/baritone&utm_campaign=Badge_Grade" > < img src = "https://app.codacy.com/project/badge/Grade/cadab857dab049438b6e28b3cfc5570e" alt = "Codacy Badge" / > < / a >
2021-03-25 18:51:18 +00:00
< a href = "https://github.com/cabaletta/baritone/blob/master/CODE_OF_CONDUCT.md" > < img src = "https://img.shields.io/badge/%E2%9D%A4-code%20of%20conduct-blue.svg?style=flat" alt = "Code of Conduct" / > < / a >
< a href = "https://snyk.io/test/github/cabaletta/baritone?targetFile=build.gradle" > < img src = "https://snyk.io/test/github/cabaletta/baritone/badge.svg?targetFile=build.gradle" alt = "Known Vulnerabilities" / > < / a >
< a href = "https://github.com/cabaletta/baritone/issues/" > < img src = "https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat" alt = "Contributions welcome" / > < / a >
< a href = "https://github.com/cabaletta/baritone/issues/" > < img src = "https://img.shields.io/github/issues/cabaletta/baritone.svg" alt = "Issues" / > < / a >
< a href = "https://github.com/cabaletta/baritone/issues?q=is%3Aissue+is%3Aclosed" > < img src = "https://img.shields.io/github/issues-closed/cabaletta/baritone.svg" alt = "GitHub issues-closed" / > < / a >
< a href = "https://github.com/cabaletta/baritone/pulls/" > < img src = "https://img.shields.io/github/issues-pr/cabaletta/baritone.svg" alt = "Pull Requests" / > < / a >
< a href = "https://github.com/cabaletta/baritone/graphs/contributors/" > < img src = "https://img.shields.io/github/contributors/cabaletta/baritone.svg" alt = "GitHub contributors" / > < / a >
< a href = "https://github.com/cabaletta/baritone/commit/" > < img src = "https://img.shields.io/github/commits-since/cabaletta/baritone/v1.0.0.svg" alt = "GitHub commits" / > < / a >
< img src = "https://img.shields.io/github/languages/code-size/cabaletta/baritone.svg" alt = "Code size" / >
< img src = "https://img.shields.io/github/repo-size/cabaletta/baritone.svg" alt = "GitHub repo size" / >
< img src = "https://tokei.rs/b1/github/cabaletta/baritone?category=code" alt = "Lines of Code" / >
< / p >
< p align = "center" >
< a href = "https://impactclient.net/" > < img src = "https://img.shields.io/badge/Impact%20integration-v1.2.14%20/%20v1.3.8%20/%20v1.4.6%20/%20v1.5.3%20/%20v1.6.3-brightgreen.svg" alt = "Impact integration" / > < / a >
2023-03-01 07:56:34 +00:00
< a href = "https://github.com/lambda-client/lambda" > < img src = "https://img.shields.io/badge/Lambda%20integration-v1.2.17-brightgreen.svg" alt = "Lambda integration" / > < / a >
2021-03-25 18:51:18 +00:00
< a href = "https://github.com/fr1kin/ForgeHax/" > < img src = "https://img.shields.io/badge/ForgeHax%20%22integration%22-scuffed-yellow.svg" alt = "ForgeHax integration" / > < / a >
< a href = "https://aristois.net/" > < img src = "https://img.shields.io/badge/Aristois%20add--on%20integration-v1.6.3-green.svg" alt = "Aristois add-on integration" / > < / a >
< a href = "https://rootnet.dev/" > < img src = "https://img.shields.io/badge/rootNET%20integration-v1.2.14-green.svg" alt = "rootNET integration" / > < / a >
< a href = "https://futureclient.net/" > < img src = "https://img.shields.io/badge/Future%20integration-v1.2.12%20%2F%20v1.3.6%20%2F%20v1.4.4-red" alt = "Future integration" / > < / a >
< a href = "https://rusherhack.org/" > < img src = "https://img.shields.io/badge/RusherHack%20integration-v1.2.14-green" alt = "RusherHack integration" / > < / a >
< / p >
< p align = "center" >
< a href = "http://forthebadge.com/" > < img src = "https://forthebadge.com/images/badges/built-with-swag.svg" alt = "forthebadge" / > < / a >
< a href = "http://forthebadge.com/" > < img src = "https://forthebadge.com/images/badges/mom-made-pizza-rolls.svg" alt = "forthebadge" / > < / a >
< / p >
2019-01-25 00:10:21 +00:00
2021-03-21 20:52:27 +00:00
A Minecraft pathfinder bot.
2023-03-21 05:07:51 +00:00
Baritone is the pathfinding system used in [Impact ](https://impactclient.net/ ) since 4.4. [Here's ](https://www.youtube.com/watch?v=StquF69-_wI ) a (very old!) video I made showing off what it can do.
2022-02-08 06:03:31 +00:00
2023-02-19 00:42:05 +00:00
[**Baritone Discord Server** ](http://discord.gg/s6fRBAUpmr )
2019-07-03 05:13:17 +00:00
2023-02-19 00:42:05 +00:00
**Quick download links:**
2023-06-14 04:33:12 +00:00
2023-02-19 00:42:05 +00:00
| Forge | Fabric |
|---------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
| [1.12.2 Forge ](https://github.com/cabaletta/baritone/releases/download/v1.2.17/baritone-api-forge-1.2.17.jar ) | |
| [1.16.5 Forge ](https://github.com/cabaletta/baritone/releases/download/v1.6.4/baritone-api-forge-1.6.4.jar ) | [1.16.5 Fabric ](https://github.com/cabaletta/baritone/releases/download/v1.6.4/baritone-api-fabric-1.6.4.jar ) |
| [1.17.1 Forge ](https://github.com/cabaletta/baritone/releases/download/v1.7.3/baritone-api-forge-1.7.3.jar ) | [1.17.1 Fabric ](https://github.com/cabaletta/baritone/releases/download/v1.7.3/baritone-api-fabric-1.7.3.jar ) |
| [1.18.2 Forge ](https://github.com/cabaletta/baritone/releases/download/v1.8.4/baritone-api-forge-1.8.4.jar ) | [1.18.2 Fabric ](https://github.com/cabaletta/baritone/releases/download/v1.8.4/baritone-api-fabric-1.8.4.jar ) |
2023-04-12 03:36:29 +00:00
| [1.19.2 Forge ](https://github.com/cabaletta/baritone/releases/download/v1.9.4/baritone-api-forge-1.9.4.jar ) | [1.19.2 Fabric ](https://github.com/cabaletta/baritone/releases/download/v1.9.4/baritone-api-fabric-1.9.4.jar ) |
2023-02-19 00:42:05 +00:00
| [1.19.3 Forge ](https://github.com/cabaletta/baritone/releases/download/v1.9.1/baritone-api-forge-1.9.1.jar ) | [1.19.3 Fabric ](https://github.com/cabaletta/baritone/releases/download/v1.9.1/baritone-api-fabric-1.9.1.jar ) |
2023-04-11 23:00:22 +00:00
| [1.19.4 Forge ](https://github.com/cabaletta/baritone/releases/download/v1.9.3/baritone-api-forge-1.9.3.jar ) | [1.19.4 Fabric ](https://github.com/cabaletta/baritone/releases/download/v1.9.3/baritone-api-fabric-1.9.3.jar ) |
2023-06-14 04:30:31 +00:00
| [1.20.1 Forge ](https://github.com/cabaletta/baritone/releases/download/v1.10.1/baritone-api-forge-1.10.1.jar ) | [1.20.1 Fabric ](https://github.com/cabaletta/baritone/releases/download/v1.10.1/baritone-api-fabric-1.10.1.jar ) |
2023-06-14 04:33:12 +00:00
2023-02-19 00:42:05 +00:00
**How to immediately get started:** Type `#goto 1000 500` in chat to go to x=1000 z=500. Type `#mine diamond_ore` to mine diamond ore. Type `#stop` to stop. For more, read [the usage page ](USAGE.md ) and/or watch this [tutorial playlist ](https://www.youtube.com/playlist?list=PLnwnJ1qsS7CoQl9Si-RTluuzCo_4Oulpa )
2021-12-06 05:54:37 +00:00
2023-03-21 05:07:51 +00:00
For other versions of Minecraft or more complicated situations or for development, see [Installation & setup ](SETUP.md ). Also consider just installing [Impact ](https://impactclient.net/ ), which comes with Baritone and is easier to install than wrangling with version JSONs and zips. For 1.16.5, [click here ](https://www.youtube.com/watch?v=_4eVJ9Qz2J8 ) and see description. Once Baritone is installed, look [here ](USAGE.md ) for instructions on how to use it. There's a [showcase video ](https://youtu.be/CZkLXWo4Fg4 ) made by @Adovin#6313 on Baritone which I recommend.
2023-02-18 23:12:17 +00:00
2018-11-07 04:12:02 +00:00
This project is an updated version of [MineBot ](https://github.com/leijurv/MineBot/ ),
2022-02-02 08:50:48 +00:00
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 ](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
2022-02-09 05:13:51 +00:00
```java
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.
