baritone/README.md

80 lines
5.1 KiB
Markdown
Raw Normal View History

2018-09-03 21:55:44 +05:30
# Baritone
2018-09-17 08:53:08 +05:30
[![Build Status](https://travis-ci.com/cabaletta/baritone.svg?branch=master)](https://travis-ci.com/cabaletta/baritone)
2018-10-19 03:06:14 +05:30
[![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)
2018-10-27 21:55:53 +05:30
[![HitCount](http://hits.dwyl.com/cabaletta/baritone.svg)](http://hits.dwyl.com/cabaletta/baritone)
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)
2018-10-27 21:55:53 +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-02-12 11:56:49 +05:30
![](https://tokei.rs/b1/github/cabaletta/baritone?category=code)
![](https://tokei.rs/b1/github/cabaletta/baritone?category=files)
2018-11-01 09:07:18 +05:30
[![Minecraft](https://img.shields.io/badge/MC-1.12.2-green.svg)](https://minecraft.gamepedia.com/1.12.2)
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/)
2019-03-02 00:52:21 +05:30
[![Impact integration](https://img.shields.io/badge/Impact%20integration-v1.2.3-brightgreen.svg)](https://impactdevelopment.github.io/)
2019-01-21 05:01:30 +05:30
[![Asuna integration](https://img.shields.io/badge/Asuna%20integration-builder%20branch-brightgreen.svg)](https://github.com/EmotionalLove/Asuna/)
2019-03-04 10:59:31 +05:30
[![KAMI integration](https://img.shields.io/badge/KAMI%20integration-v1.0.0-red.svg)](https://github.com/zeroeightysix/KAMI/)
[![WWE integration](https://img.shields.io/badge/WWE%20%22integration%22-v1.0.0%3F%3F%20smh%20license%20violations-red.svg)](https://wweclient.com/)
2019-01-21 05:01:30 +05:30
[![Future integration](https://img.shields.io/badge/Future%20integration-Soon™%3F%3F%3F-red.svg)](https://futureclient.net/)
2019-01-22 13:02:41 +05:30
[![ForgeHax integration](https://img.shields.io/badge/ForgeHax%20integration-Soon™-red.svg)](https://github.com/fr1kin/ForgeHax)
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
2018-10-27 08:34:12 +05:30
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 05:31:29 +05:30
2018-11-07 09:42:02 +05:30
This project is an updated version of [MineBot](https://github.com/leijurv/MineBot/),
2019-01-21 03:23:55 +05:30
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 09:42:02 +05:30
2019-03-08 07:48:31 +05:30
Have committed at least once a day for the last 7 months =D 🦀
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-02-28 05:16:28 +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-02-06 02:04:29 +05:30
- [Baritone chat control usage](USAGE.md)
2019-02-05 10:53:19 +05:30
# 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 a 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-02-12 23:28:44 +05:30
That's what it's for, sure! (As long as usage is in compliance with the LGPL 3 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
2018-09-24 06:04:04 +05:30
Magic. (Hours of [Leijurv](https://github.com/leijurv) enduring excruciating pain)
## Why is it called Baritone?
2018-09-26 05:34:34 +05:30
It's named for FitMC's deep sultry voice.