diff --git a/README.md b/README.md index c6a90ff93..7432b1d17 100644 --- a/README.md +++ b/README.md @@ -1,137 +1 @@ -# Baritone -

- GitHub All Releases -

- -

- Minecraft - Minecraft - Minecraft - Minecraft - Minecraft - Minecraft - Minecraft - Minecraft - Minecraft - Minecraft -

- -

- Build Status - Release - License - Codacy Badge - Code of Conduct - Known Vulnerabilities - Contributions welcome - Issues - GitHub issues-closed - Pull Requests - GitHub contributors - GitHub commits - Code size - GitHub repo size - Lines of Code -

- -

- Impact integration - Lambda integration - ForgeHax integration - Aristois add-on integration - rootNET integration - Future integration - RusherHack integration -

- -

- forthebadge - forthebadge -

- -A Minecraft pathfinder bot. - -Baritone is the pathfinding system used in [Impact](https://impactclient.net/) since 4.4. [Here's](https://www.youtube.com/watch?v=StquF69-_wI) a (very old!) video I made showing off what it can do. - -[**Baritone Discord Server**](http://discord.gg/s6fRBAUpmr) - -**Quick download links:** - -| Forge | Fabric | -|---------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| -| [1.12.2 Forge](https://github.com/cabaletta/baritone/releases/download/v1.2.17/baritone-api-forge-1.2.17.jar) | | -| [1.16.5 Forge](https://github.com/cabaletta/baritone/releases/download/v1.6.4/baritone-api-forge-1.6.4.jar) | [1.16.5 Fabric](https://github.com/cabaletta/baritone/releases/download/v1.6.4/baritone-api-fabric-1.6.4.jar) | -| [1.17.1 Forge](https://github.com/cabaletta/baritone/releases/download/v1.7.3/baritone-api-forge-1.7.3.jar) | [1.17.1 Fabric](https://github.com/cabaletta/baritone/releases/download/v1.7.3/baritone-api-fabric-1.7.3.jar) | -| [1.18.2 Forge](https://github.com/cabaletta/baritone/releases/download/v1.8.4/baritone-api-forge-1.8.4.jar) | [1.18.2 Fabric](https://github.com/cabaletta/baritone/releases/download/v1.8.4/baritone-api-fabric-1.8.4.jar) | -| [1.19.2 Forge](https://github.com/cabaletta/baritone/releases/download/v1.9.4/baritone-api-forge-1.9.4.jar) | [1.19.2 Fabric](https://github.com/cabaletta/baritone/releases/download/v1.9.4/baritone-api-fabric-1.9.4.jar) | -| [1.19.3 Forge](https://github.com/cabaletta/baritone/releases/download/v1.9.1/baritone-api-forge-1.9.1.jar) | [1.19.3 Fabric](https://github.com/cabaletta/baritone/releases/download/v1.9.1/baritone-api-fabric-1.9.1.jar) | -| [1.19.4 Forge](https://github.com/cabaletta/baritone/releases/download/v1.9.3/baritone-api-forge-1.9.3.jar) | [1.19.4 Fabric](https://github.com/cabaletta/baritone/releases/download/v1.9.3/baritone-api-fabric-1.9.3.jar) | -| [1.20.1 Forge](https://github.com/cabaletta/baritone/releases/download/v1.10.1/baritone-api-forge-1.10.1.jar) | [1.20.1 Fabric](https://github.com/cabaletta/baritone/releases/download/v1.10.1/baritone-api-fabric-1.10.1.jar) | - -**How to immediately get started:** Type `#goto 1000 500` in chat to go to x=1000 z=500. Type `#mine diamond_ore` to mine diamond ore. Type `#stop` to stop. For more, read [the usage page](USAGE.md) and/or watch this [tutorial playlist](https://www.youtube.com/playlist?list=PLnwnJ1qsS7CoQl9Si-RTluuzCo_4Oulpa) - -For other versions of Minecraft or more complicated situations or for development, see [Installation & setup](SETUP.md). Also consider just installing [Impact](https://impactclient.net/), which comes with Baritone and is easier to install than wrangling with version JSONs and zips. For 1.16.5, [click here](https://www.youtube.com/watch?v=_4eVJ9Qz2J8) and see description. Once Baritone is installed, look [here](USAGE.md) for instructions on how to use it. There's a [showcase video](https://youtu.be/CZkLXWo4Fg4) made by @Adovin#6313 on Baritone which I recommend. - -This project is an updated version of [MineBot](https://github.com/leijurv/MineBot/), -the original version of the bot for Minecraft 1.8.9, rebuilt for 1.12.2 onwards. 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). - -Have committed at least once a day from Aug 1, 2018, to Aug 1, 2019. - -1Leijurv3DWTrGAfmmiTphjhXLvQiHg7K2 - -# Getting Started - -Here are some links to help to get started: - -- [Features](FEATURES.md) - -- [Installation & setup](SETUP.md) - -- [API Javadocs](https://baritone.leijurv.com/) - -- [Settings](https://baritone.leijurv.com/baritone/api/Settings.html#field.detail) - -- [Usage (chat control)](USAGE.md) - -## Stars over time - -[![Stargazers over time](https://starchart.cc/cabaletta/baritone.svg)](https://starchart.cc/cabaletta/baritone) - -# 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 an X/Z goal. - -```java -BaritoneAPI.getSettings().allowSprint.value = true; -BaritoneAPI.getSettings().primaryTimeoutMS.value = 2000L; - -BaritoneAPI.getProvider().getPrimaryBaritone().getCustomGoalProcess().setGoalAndPath(new GoalXZ(10000, 20000)); -``` - -# FAQ - -## Can I use Baritone as a library in my custom utility client? - -That's what it's for, sure! (As long as usage complies with the LGPL 3.0 License) - -## How is it so fast? - -Magic. (Hours of [leijurv](https://github.com/leijurv/) enduring excruciating pain) - -### 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? - -It's named for FitMC's deep sultry voice. +This branch of Baritone is deprecated. It will no longer recieve updates. Updates to older versions of Minecraft will not be merged into this branch, even if a newer branch is not deprecated (this branch will be skipped). Bug reports that only affect deprecated branches will not be addressed.