forked from RepoMirrors/baritone
76 lines
3.6 KiB
Markdown
76 lines
3.6 KiB
Markdown
# Baritone
|
|
[](https://travis-ci.com/cabaletta/baritone)
|
|
[](https://github.com/cabaletta/baritone/releases)
|
|
[](LICENSE)
|
|
[](https://www.codacy.com/app/leijurv/baritone?utm_source=github.com&utm_medium=referral&utm_content=cabaletta/baritone&utm_campaign=Badge_Grade)
|
|
[](http://hits.dwyl.com/cabaletta/baritone)
|
|
[](https://github.com/cabaletta/baritone/issues)
|
|
[](https://minecraft.gamepedia.com/1.12.2)
|
|
|
|
A Minecraft pathfinder bot. This project is an updated version of [MineBot](https://github.com/leijurv/MineBot/),
|
|
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 [29x faster](https://github.com/cabaletta/baritone/pull/180#issuecomment-423822928) than MineBot at calculating paths).
|
|
|
|
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.
|
|
|
|
Here are some links to help to get started:
|
|
|
|
- [Features](FEATURES.md)
|
|
|
|
- [Installation](INSTALL.md)
|
|
|
|
There's also some useful information down below
|
|
|
|
# Setup
|
|
|
|
## Command Line
|
|
On Mac OSX and Linux, use `./gradlew` instead of `gradlew`.
|
|
|
|
Running Baritone:
|
|
|
|
```
|
|
$ gradlew runClient
|
|
```
|
|
|
|
Building Baritone:
|
|
```
|
|
$ gradlew build
|
|
```
|
|
|
|
For example, to replace out Impact 4.4's Baritone build with a customized one, build Baritone as above then copy `dist/baritone-api-$VERSION$.jar` into `minecraft/libraries/cabaletta/baritone-api/$VERSION$/baritone-api-$VERSION$.jar`, replacing the jar that was previously there. You also need to edit `minecraft/versions/1.12.2-Impact_4.4/1.12.2-Impact_4.4.json`, find the line `"name": "cabaletta:baritone-api:$VERSION$"`, remove the comma from the end, and entirely remove the line that's immediately after (starts with `"url"`).
|
|
|
|
## IntelliJ's Gradle UI
|
|
- Open the project in IntelliJ as a Gradle project
|
|
- Run the Gradle tasks `setupDecompWorkspace` then `genIntellijRuns`
|
|
- Refresh the Gradle project (or, to be safe, just restart IntelliJ)
|
|
- Select the "Minecraft Client" launch config
|
|
- In `Edit Configurations...` you may need to select `baritone_launch` for `Use classpath of module:`.
|
|
|
|
# Chat control
|
|
[Defined Here](src/main/java/baritone/utils/ExampleBaritoneControl.java)
|
|
|
|
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
|
|
|
|
```
|
|
BaritoneAPI.getSettings().allowSprint.value = true;
|
|
BaritoneAPI.getSettings().pathTimeoutMS.value = 2000L;
|
|
|
|
BaritoneAPI.getPathingBehavior().setGoal(new GoalXZ(10000, 20000));
|
|
BaritoneAPI.getPathingBehavior().path();
|
|
```
|
|
|
|
# FAQ
|
|
|
|
## Can I use Baritone as a library in my hacked client?
|
|
|
|
Sure! (As long as usage is in compliance with the LGPL 3 License)
|
|
|
|
## How is it so fast?
|
|
|
|
Magic. (Hours of [Leijurv](https://github.com/leijurv) enduring excruciating pain)
|
|
|
|
## Why is it called Baritone?
|
|
|
|
It's named for FitMC's deep sultry voice.
|