2018-09-03 16:25:44 +00:00
# Baritone
2018-09-17 03:23:08 +00:00
[![Build Status ](https://travis-ci.com/cabaletta/baritone.svg?branch=master )](https://travis-ci.com/cabaletta/baritone)
2018-10-18 21:36:14 +00:00
[![Release ](https://img.shields.io/github/release/cabaletta/baritone.svg )](https://github.com/cabaletta/baritone/releases)
2018-12-11 20:21:24 +00:00
[![License ](https://img.shields.io/badge/license-LGPL--3.0-green.svg )](LICENSE)
2018-10-13 19:36:05 +00:00
[![Codacy Badge ](https://api.codacy.com/project/badge/Grade/a73d037823b64a5faf597a18d71e3400 )](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
[![HitCount ](http://hits.dwyl.com/cabaletta/baritone.svg )](http://hits.dwyl.com/cabaletta/baritone)
2018-12-13 22:43:32 +00:00
[![Known Vulnerabilities ](https://snyk.io/test/github/cabaletta/baritone/badge.svg?targetFile=build.gradle )](https://snyk.io/test/github/cabaletta/baritone?targetFile=build.gradle)
2018-10-27 16:25:53 +00:00
[![contributions welcome ](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat )](https://github.com/cabaletta/baritone/issues)
2019-01-25 00:06:53 +00:00
[![Issues ](https://img.shields.io/github/issues/cabaletta/baritone.svg )](https://github.com/cabaletta/baritone/issues/)
2019-01-25 00:25:35 +00:00
[![GitHub issues-closed ](https://img.shields.io/github/issues-closed/cabaletta/baritone.svg )](https://github.com/cabaletta/baritone/issues?q=is%3Aissue+is%3Aclosed)
2019-01-25 00:06:53 +00:00
[![Pull Requests ](https://img.shields.io/github/issues-pr/cabaletta/baritone.svg )](https://github.com/cabaletta/baritone/pulls/)
2019-01-25 00:31:12 +00:00
![Code size ](https://img.shields.io/github/languages/code-size/cabaletta/baritone.svg )
2019-01-25 00:06:53 +00:00
![GitHub repo size ](https://img.shields.io/github/repo-size/cabaletta/baritone.svg )
2018-11-01 03:37:18 +00:00
[![Minecraft ](https://img.shields.io/badge/MC-1.12.2-green.svg )](https://minecraft.gamepedia.com/1.12.2)
2019-01-25 00:06:53 +00:00
[![GitHub contributors ](https://img.shields.io/github/contributors/cabaletta/baritone.svg )](https://github.com/cabaletta/baritone/graphs/contributors/)
[![GitHub commits ](https://img.shields.io/github/commits-since/cabaletta/baritone/v1.0.0.svg )](https://github.com/cabaletta/baritone/commit/)
2019-01-20 23:31:30 +00:00
[![Asuna integration ](https://img.shields.io/badge/Asuna%20integration-builder%20branch-brightgreen.svg )](https://github.com/EmotionalLove/Asuna/)
[![Impact integration ](https://img.shields.io/badge/Impact%20integration-v1.0.0--hotfix--4-green.svg )](https://impactdevelopment.github.io/)
2018-12-11 20:23:26 +00:00
[![KAMI integration ](https://img.shields.io/badge/KAMI%20integration-v1.0.0-orange.svg )](https://github.com/zeroeightysix/KAMI/)
2019-01-21 00:26:23 +00:00
[![WWE integration ](https://img.shields.io/badge/WWE%20%22integration%22-v1.0.0%3F%3F%20smh%20license%20violations-orange.svg )](https://wweclient.com/)
2019-01-20 23:31:30 +00:00
[![Future integration ](https://img.shields.io/badge/Future%20integration-Soon™%3F%3F%3F-red.svg )](https://futureclient.net/)
2019-01-22 07:32:41 +00:00
[![ForgeHax integration ](https://img.shields.io/badge/ForgeHax%20integration-Soon™-red.svg )](https://github.com/fr1kin/ForgeHax)
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-01-20 21:53:55 +00:00
the original version of the bot for Minecraft 1.8, 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
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-01-24 21:21:16 +00:00
- [Setup ](SETUP.md )
2018-09-13 17:14:10 +00:00
2019-01-24 21:21:16 +00:00
- [Installation ](INSTALL.md )
2018-11-02 23:23:57 +00:00
2018-08-27 19:02:51 +00:00
# Chat control
2018-09-24 00:39:37 +00:00
[Defined Here ](src/main/java/baritone/utils/ExampleBaritoneControl.java )
2018-08-27 19:02:51 +00:00
Quick start example: `thisway 1000` or `goal 70` to set the goal, `path` to actually start pathing. Also try `mine diamond_ore` . `cancel` to cancel.
# API example
```
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
2018-09-17 23:11:54 +00:00
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
2018-09-24 00:34:04 +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.