baritone/README.md

93 lines
6.3 KiB
Markdown
Raw Normal View History

2018-09-03 16:25:44 +00:00
# Baritone
2019-06-21 08:59:10 +00:00
[![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-26 23:29:50 +00:00
[![License](https://img.shields.io/badge/license-LGPL--3.0%20with%20anime%20exception-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)
2019-06-21 08:59:10 +00:00
[![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-07-24 05:30:04 +00:00
[![Minecraft](https://img.shields.io/badge/MC-1.12.2-brightgreen.svg)](https://github.com/cabaletta/baritone/tree/master/)
2019-06-17 06:06:57 +00:00
[![Minecraft](https://img.shields.io/badge/MC-1.13.2-brightgreen.svg)](https://github.com/cabaletta/baritone/tree/1.13.2/)
2019-07-24 05:30:04 +00:00
[![Minecraft](https://img.shields.io/badge/MC-1.14.4-brightgreen.svg)](https://github.com/cabaletta/baritone/tree/1.14.4/)
2020-02-14 21:49:53 +00:00
[![Minecraft](https://img.shields.io/badge/MC-1.15.2-brightgreen.svg)](https://github.com/cabaletta/baritone/tree/1.15.2/)
2019-03-03 06:40:42 +00:00
[![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-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)
2019-06-21 08:59:10 +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)
2019-06-09 06:13:27 +00:00
![Lines of Code](https://tokei.rs/b1/github/cabaletta/baritone?category=code)
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-10-28 17:47:20 +00:00
[![Impact integration](https://img.shields.io/badge/Impact%20integration-v1.2.10%20/%20v1.3.5%20/%20v1.4.3-brightgreen.svg)](https://impactclient.net/)
2019-06-18 05:44:38 +00:00
[![ForgeHax integration](https://img.shields.io/badge/ForgeHax%20%22integration%22-scuffed-yellow.svg)](https://github.com/fr1kin/ForgeHax/)
2019-08-22 06:50:13 +00:00
[![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 00:42:14 +00:00
[![rootNET integration](https://img.shields.io/badge/rootNET%20integration-v1.2.11-green.svg)](https://rootnet.dev/)
2019-03-13 06:29:08 +00:00
[![WWE integration](https://img.shields.io/badge/WWE%20%22integration%22-master%3F-green.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-06-19 06:15:47 +00:00
[![forthebadge](https://forthebadge.com/images/badges/built-with-swag.svg)](http://forthebadge.com/)
2019-06-20 03:41:21 +00:00
[![forthebadge](https://forthebadge.com/images/badges/mom-made-pizza-rolls.svg)](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
2020-02-23 02:37:29 +00:00
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.
2018-10-16 00:01:29 +00:00
2019-09-05 00:15:27 +00:00
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.* forge api jar from [releases](https://github.com/cabaletta/baritone/releases). Otherwise, see [Installation & setup](SETUP.md). Once Baritone is installed, look [here](USAGE.md) for instructions on how to use it.
2019-07-03 05:13:17 +00:00
2020-02-14 21:49:15 +00:00
For 1.15.2, [click here](https://www.youtube.com/watch?v=j1qKtCZFURM) and see description.
2018-11-07 04:12:02 +00:00
This project is an updated version of [MineBot](https://github.com/leijurv/MineBot/),
2020-02-14 21:49:53 +00:00
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 04:12:02 +00:00
2019-08-02 06:47:32 +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
# 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
[![Stargazers over time](https://starchart.cc/cabaletta/baritone.svg)](https://starchart.cc/cabaletta/baritone)
# 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/).
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-06-10 06:56:54 +00:00
That's what it's for, sure! (As long as usage is in compliance 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)
## Why is it called Baritone?
2018-09-26 00:04:34 +00:00
It's named for FitMC's deep sultry voice.