83 lines
3.4 KiB
Markdown
83 lines
3.4 KiB
Markdown
# Baritone
|
|
|
|
<p align="center">
|
|
<a href="http://forthebadge.com/"><img src="https://forthebadge.com/images/badges/not-a-bug-a-feature.svg" alt="forthebadge"/></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>
|
|
|
|
|
|
A Minecraft pathfinder bot.
|
|
|
|
The best way to install it is to run `./gradlew build` and drop `build/libs/baritone-standalone-*.jar` into your mods folder (use `baritone-api-*.jar` if your other mods use/integrate with baritone, use `baritone-*-forge-*.jar` if using forge).
|
|
|
|
[**Baritone Discord Server**](http://discord.gg/s6fRBAUpmr)
|
|
|
|
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)
|
|
|
|
This project is an updated version of [MineBot](https://github.com/leijurv/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](https://github.com/cabaletta/baritone/pull/180#issuecomment-423822928) 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:
|
|
|
|
- [Features](FEATURES.md)
|
|
|
|
- [Installation & setup](SETUP.md)
|
|
|
|
- [API Javadocs](https://baritone.leijurv.com/)
|
|
|
|
- [Settings](https://baritone.leijurv.com/baritone/api/Settings.html#field.detail) (note that the 0xf8 fork adds more settings)
|
|
|
|
- [Usage (chat control)](USAGE.md)
|
|
|
|
|
|
# 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 an X/Z goal.
|
|
|
|
```java
|
|
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](https://github.com/leijurv/) enduring excruciating pain)
|
|
|
|
### 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.
|
|
|
|
## Why is it called Baritone?
|
|
|
|
It's named for FitMC's deep sultry voice.
|