baritone/README.md

105 lines
7.4 KiB
Markdown
Raw Normal View History

2018-09-03 21:55:44 +05:30
# Baritone
2020-04-19 10:37:18 +05:30
[![HitCount](http://hits.dwyl.com/cabaletta/baritone.svg)](http://hits.dwyl.com/cabaletta/baritone/)
[![GitHub All Releases](https://img.shields.io/github/downloads/cabaletta/baritone/total.svg)](https://github.com/cabaletta/baritone/releases/)
2019-06-21 14:29:10 +05:30
[![Build Status](https://travis-ci.com/cabaletta/baritone.svg?branch=master)](https://travis-ci.com/cabaletta/baritone/)
[![Release](https://img.shields.io/github/release/cabaletta/baritone.svg)](https://github.com/cabaletta/baritone/releases/)
2019-02-27 04:59:50 +05:30
[![License](https://img.shields.io/badge/license-LGPL--3.0%20with%20anime%20exception-green.svg)](LICENSE)
2018-10-14 01:06:05 +05:30
[![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)
2019-07-24 11:00:04 +05:30
[![Minecraft](https://img.shields.io/badge/MC-1.12.2-brightgreen.svg)](https://github.com/cabaletta/baritone/tree/master/)
2019-06-17 11:36:57 +05:30
[![Minecraft](https://img.shields.io/badge/MC-1.13.2-brightgreen.svg)](https://github.com/cabaletta/baritone/tree/1.13.2/)
2019-07-24 11:00:04 +05:30
[![Minecraft](https://img.shields.io/badge/MC-1.14.4-brightgreen.svg)](https://github.com/cabaletta/baritone/tree/1.14.4/)
2020-02-15 03:19:53 +05:30
[![Minecraft](https://img.shields.io/badge/MC-1.15.2-brightgreen.svg)](https://github.com/cabaletta/baritone/tree/1.15.2/)
2019-03-03 12:10:42 +05:30
[![Code of Conduct](https://img.shields.io/badge/%E2%9D%A4-code%20of%20conduct-blue.svg?style=flat)](https://github.com/cabaletta/baritone/blob/master/CODE_OF_CONDUCT.md)
2018-12-14 04:13:32 +05:30
[![Known Vulnerabilities](https://snyk.io/test/github/cabaletta/baritone/badge.svg?targetFile=build.gradle)](https://snyk.io/test/github/cabaletta/baritone?targetFile=build.gradle)
2019-06-21 14:29:10 +05:30
[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/cabaletta/baritone/issues/)
2019-01-25 05:36:53 +05:30
[![Issues](https://img.shields.io/github/issues/cabaletta/baritone.svg)](https://github.com/cabaletta/baritone/issues/)
2019-01-25 05:55:35 +05:30
[![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 05:36:53 +05:30
[![Pull Requests](https://img.shields.io/github/issues-pr/cabaletta/baritone.svg)](https://github.com/cabaletta/baritone/pulls/)
2019-01-25 06:01:12 +05:30
![Code size](https://img.shields.io/github/languages/code-size/cabaletta/baritone.svg)
2019-01-25 05:36:53 +05:30
![GitHub repo size](https://img.shields.io/github/repo-size/cabaletta/baritone.svg)
2019-06-09 11:43:27 +05:30
![Lines of Code](https://tokei.rs/b1/github/cabaletta/baritone?category=code)
2019-01-25 05:36:53 +05:30
[![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/)
2020-07-30 01:22:19 +05:30
[![Impact integration](https://img.shields.io/badge/Impact%20integration-v1.2.14%20/%20v1.3.8%20/%20v1.4.6%20/%20v1.5.3-brightgreen.svg)](https://impactclient.net/)
[![KAMI Blue integration](https://img.shields.io/badge/KAMI%20Blue%20integration-v1.2.14--master-green)](https://github.com/kami-blue/client)
2019-06-18 11:14:38 +05:30
[![ForgeHax integration](https://img.shields.io/badge/ForgeHax%20%22integration%22-scuffed-yellow.svg)](https://github.com/fr1kin/ForgeHax/)
2019-08-22 12:20:13 +05:30
[![Aristois add-on integration](https://img.shields.io/badge/Aristois%20add--on%20integration-v1.3.4%20/%20v1.4.1-green.svg)](https://gitlab.com/emc-mods-indrit/baritone_api)
2020-02-02 06:12:14 +05:30
[![rootNET integration](https://img.shields.io/badge/rootNET%20integration-v1.2.11-green.svg)](https://rootnet.dev/)
[![Future integration](https://img.shields.io/badge/Future%20integration-v1.2.12%20%2F%20v1.3.6%20%2F%20v1.4.4-red)](https://futureclient.net/)
[![RusherHack integration](https://img.shields.io/badge/RusherHack%20integration-v1.2.14-green)](https://rusherhack.org/)
2019-06-19 11:45:47 +05:30
[![forthebadge](https://forthebadge.com/images/badges/built-with-swag.svg)](http://forthebadge.com/)
2019-06-20 09:11:21 +05:30
[![forthebadge](https://forthebadge.com/images/badges/mom-made-pizza-rolls.svg)](http://forthebadge.com/)
2019-01-25 05:40:21 +05:30
2018-11-07 09:42:02 +05:30
A Minecraft pathfinder bot.
2018-08-26 21:15:02 +05:30
2020-09-12 10:22:43 +05:30
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)
2018-10-16 05:31:29 +05:30
2020-05-04 07:21:21 +05:30
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-03 10:43:17 +05:30
2020-04-27 01:52:55 +05:30
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.
2019-07-24 11:00:04 +05:30
2018-11-07 09:42:02 +05:30
This project is an updated version of [MineBot](https://github.com/leijurv/MineBot/),
2020-02-15 03:19:53 +05:30
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-07 09:42:02 +05:30
2019-10-15 15:34:22 +05:30
Have committed at least once a day from Aug 1, 2018, to Aug 1, 2019.
2019-02-02 12:24:14 +05:30
2019-02-12 08:51:08 +05:30
1Leijurv3DWTrGAfmmiTphjhXLvQiHg7K2
# Getting Started
2018-09-24 06:09:04 +05:30
Here are some links to help to get started:
2018-09-02 23:45:43 +05:30
2018-09-24 06:09:04 +05:30
- [Features](FEATURES.md)
2018-09-03 22:34:48 +05:30
2019-02-28 05:16:28 +05:30
- [Installation & setup](SETUP.md)
2018-09-13 22:44:10 +05:30
2019-06-21 14:29:10 +05:30
- [API Javadocs](https://baritone.leijurv.com/)
2019-01-29 01:27:58 +05:30
2019-02-23 13:02:23 +05:30
- [Settings](https://baritone.leijurv.com/baritone/api/Settings.html#field.detail)
2019-02-11 06:14:09 +05:30
2019-07-05 04:22:09 +05:30
- [Usage (chat control)](USAGE.md)
2019-02-05 10:53:19 +05:30
2020-02-23 12:12:22 +05:30
## Stars over time
[![Stargazers over time](https://starchart.cc/cabaletta/baritone.svg)](https://starchart.cc/cabaletta/baritone)
# API
2019-06-21 12:18:02 +05:30
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.
2019-10-15 15:34:22 +05:30
Below is an example of basic usage for changing some settings, and then pathing to an X/Z goal.
2018-08-28 00:32:51 +05:30
```
2018-09-24 05:53:57 +05:30
BaritoneAPI.getSettings().allowSprint.value = true;
2019-01-29 00:29:08 +05:30
BaritoneAPI.getSettings().primaryTimeoutMS.value = 2000L;
2018-08-28 00:32:51 +05:30
2018-11-19 07:02:16 +05:30
BaritoneAPI.getProvider().getPrimaryBaritone().getCustomGoalProcess().setGoalAndPath(new GoalXZ(10000, 20000));
2018-08-30 00:55:03 +05:30
```
2018-09-03 04:31:41 +05:30
# FAQ
2018-11-20 06:44:54 +05:30
## Can I use Baritone as a library in my custom utility client?
2018-08-30 00:55:03 +05:30
2019-10-15 15:34:22 +05:30
That's what it's for, sure! (As long as usage complies with the LGPL 3.0 License)
2018-08-30 00:55:03 +05:30
2018-09-03 04:31:41 +05:30
## How is it so fast?
2018-08-30 00:55:03 +05:30
2019-06-21 14:29:10 +05:30
Magic. (Hours of [leijurv](https://github.com/leijurv/) enduring excruciating pain)
2020-07-07 05:37:59 +05:30
### Additional Special Thanks To:
![YourKit-Logo](https://www.yourkit.com/images/yklogo.png)
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?
2020-07-07 05:37:59 +05:30
It's named for FitMC's deep sultry voice.