Skip to content

Commit bdebaa2

Browse files
committed
Address review
badges are back up top where they belong, with two version badges instead of eleven stale ones. client integration badges and the dead tokei one are gone. 1.12.2 is just a row in the table now impact is only mentioned for where baritone came from, elytra isn't nether only or platform dependent anymore, the seven year old command migration notes are gone, and it's `reset <setting>` / `reset all` (plain `reset` just asks you to say all) setup gets its sideways table back, the flavors list says which one to use right in each entry, and building mentions dist
1 parent efb8799 commit bdebaa2

4 files changed

Lines changed: 43 additions & 94 deletions

File tree

‎FEATURES.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
- **Avoiding dangerous blocks.** Obviously, it knows not to walk through fire or on magma, not to corner over lava (that deals some damage), not to break any blocks touching a liquid (it might drown), etc.
1313
- **Parkour.** Sprint jumping over 1, 2, or 3 block gaps.
1414
- **Parkour place.** Sprint jumping over a 3 block gap and placing the block to land on while executing the jump. It's really cool.
15-
- **Elytra.** Flying through the Nether with fireworks, see `#elytra`.
15+
- **Elytra.** Flying with fireworks, see `#elytra`.
1616
- **Pigs.** It can sort of control pigs. I wouldn't rely on it though.
1717

1818
# Pathing method

‎README.md‎

Lines changed: 25 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,33 @@
33
<p align="center"><b>A Minecraft pathfinder bot.</b></p>
44

55
<p align="center">
6-
<a href="https://github.com/cabaletta/baritone/releases/"><img src="https://img.shields.io/github/release/cabaletta/baritone.svg" alt="Release"/></a>
6+
<a href="#downloads"><img src="https://img.shields.io/badge/MC-1.12.2%20--%201.21.3-yellow.svg" alt="Minecraft 1.12.2 - 1.21.3"/></a>
7+
<a href="#downloads"><img src="https://img.shields.io/badge/MC-1.21.4%20--%2026.3-brightgreen.svg" alt="Minecraft 1.21.4 - 26.3"/></a>
8+
</p>
9+
10+
<p align="center">
711
<a href="https://github.com/cabaletta/baritone/releases/"><img src="https://img.shields.io/github/downloads/cabaletta/baritone/total.svg" alt="GitHub All Releases"/></a>
812
<a href="https://github.com/cabaletta/baritone/actions/workflows/gradle_build.yml"><img src="https://github.com/cabaletta/baritone/actions/workflows/gradle_build.yml/badge.svg" alt="Build Status"/></a>
13+
<a href="https://github.com/cabaletta/baritone/releases/"><img src="https://img.shields.io/github/release/cabaletta/baritone.svg" alt="Release"/></a>
914
<a href="LICENSE"><img src="https://img.shields.io/badge/license-LGPL--3.0%20with%20anime%20exception-green.svg" alt="License"/></a>
1015
<a href="http://discord.gg/s6fRBAUpmr"><img src="https://img.shields.io/badge/chat-discord-5865F2.svg" alt="Discord"/></a>
16+
<a href="https://www.codacy.com/gh/cabaletta/baritone/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=cabaletta/baritone&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/cadab857dab049438b6e28b3cfc5570e" alt="Codacy Badge"/></a>
17+
<a href="https://github.com/cabaletta/baritone/blob/master/CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/%E2%9D%A4-code%20of%20conduct-blue.svg?style=flat" alt="Code of Conduct"/></a>
18+
<a href="https://snyk.io/test/github/cabaletta/baritone?targetFile=build.gradle"><img src="https://snyk.io/test/github/cabaletta/baritone/badge.svg?targetFile=build.gradle" alt="Known Vulnerabilities"/></a>
19+
<a href="https://github.com/cabaletta/baritone/issues/"><img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat" alt="Contributions welcome"/></a>
20+
<a href="https://github.com/cabaletta/baritone/issues/"><img src="https://img.shields.io/github/issues/cabaletta/baritone.svg" alt="Issues"/></a>
21+
<a href="https://github.com/cabaletta/baritone/issues?q=is%3Aissue+is%3Aclosed"><img src="https://img.shields.io/github/issues-closed/cabaletta/baritone.svg" alt="GitHub issues-closed"/></a>
22+
<a href="https://github.com/cabaletta/baritone/pulls/"><img src="https://img.shields.io/github/issues-pr/cabaletta/baritone.svg" alt="Pull Requests"/></a>
23+
<a href="https://github.com/cabaletta/baritone/graphs/contributors/"><img src="https://img.shields.io/github/contributors/cabaletta/baritone.svg" alt="GitHub contributors"/></a>
24+
<a href="https://github.com/cabaletta/baritone/commit/"><img src="https://img.shields.io/github/commits-since/cabaletta/baritone/v1.0.0.svg" alt="GitHub commits"/></a>
25+
<img src="https://img.shields.io/github/languages/code-size/cabaletta/baritone.svg" alt="Code size"/>
26+
<img src="https://img.shields.io/github/repo-size/cabaletta/baritone.svg" alt="GitHub repo size"/>
27+
<img src="https://img.shields.io/badge/Badges-36-blue.svg" alt="yes"/>
28+
</p>
29+
30+
<p align="center">
31+
<a href="http://forthebadge.com/"><img src="https://web.archive.org/web/20230604002050/https://forthebadge.com/images/badges/built-with-swag.svg" alt="forthebadge"/></a>
32+
<a href="http://forthebadge.com/"><img src="https://web.archive.org/web/20230604002050/https://forthebadge.com/images/badges/mom-made-pizza-rolls.svg" alt="forthebadge"/></a>
1133
</p>
1234

1335
<p align="center">
@@ -30,7 +52,7 @@ It's the pathfinding system used in [Impact](https://impactclient.net/) since 4.
3052

3153
1. Download the jar for your Minecraft version and mod loader from [the table below](#downloads) and drop it in your `mods` folder.
3254
2. In game, type `#goto 1000 500` to go to x=1000 z=500, `#mine diamond_ore` to mine diamond ore, and `#stop` to stop.
33-
3. Try `#elytra` for Elytra flying in the Nether using fireworks ([trailer](https://youtu.be/4bGGPo8yiHo), [usage](https://youtu.be/NnSlQi-68eQ)).
55+
3. Try `#elytra` for Elytra flying using fireworks ([trailer](https://youtu.be/4bGGPo8yiHo), [usage](https://youtu.be/NnSlQi-68eQ)).
3456

3557
After that, `#help` lists every command (it's clickable!). There's also [the usage page](USAGE.md) and a [tutorial playlist](https://www.youtube.com/playlist?list=PLnwnJ1qsS7CoQl9Si-RTluuzCo_4Oulpa). Stuck? Ask in the [Discord](http://discord.gg/s6fRBAUpmr).
3658

@@ -75,8 +97,8 @@ These are the `api` jars, which is what you want unless you know otherwise. See
7597
| 1.18.2 | v1.8.6 | [Forge](https://github.com/cabaletta/baritone/releases/download/v1.8.6/baritone-api-forge-1.8.6.jar) · [Fabric](https://github.com/cabaletta/baritone/releases/download/v1.8.6/baritone-api-fabric-1.8.6.jar) |
7698
| 1.17.1 | v1.7.3 | [Forge](https://github.com/cabaletta/baritone/releases/download/v1.7.3/baritone-api-forge-1.7.3.jar) · [Fabric](https://github.com/cabaletta/baritone/releases/download/v1.7.3/baritone-api-fabric-1.7.3.jar) |
7799
| 1.16.5 | v1.6.5 | [Forge](https://github.com/cabaletta/baritone/releases/download/v1.6.5/baritone-api-forge-1.6.5.jar) · [Fabric](https://github.com/cabaletta/baritone/releases/download/v1.6.5/baritone-api-fabric-1.6.5.jar) |
100+
| 1.12.2 | v1.2.19 | [Forge](https://github.com/cabaletta/baritone/releases/download/v1.2.19/baritone-api-forge-1.2.19.jar) |
78101

79-
1.12.2 only has a [Forge jar](https://github.com/cabaletta/baritone/releases/download/v1.2.19/baritone-api-forge-1.2.19.jar). For 1.16.5, [click here](https://www.youtube.com/watch?v=_4eVJ9Qz2J8) and see description. Anything else is on the [releases page](https://github.com/cabaletta/baritone/releases).
80102

81103
</details>
82104

@@ -121,49 +143,6 @@ Have committed at least once a day from Aug 1, 2018, to Aug 1, 2019.
121143

122144
1Leijurv3DWTrGAfmmiTphjhXLvQiHg7K2
123145

124-
<details>
125-
<summary>All the badges</summary>
126-
127-
<p align="center">
128-
<a href="https://github.com/cabaletta/baritone/releases/"><img src="https://img.shields.io/github/downloads/cabaletta/baritone/total.svg" alt="GitHub All Releases"/></a>
129-
</p>
130-
131-
<p align="center">
132-
<a href="https://github.com/cabaletta/baritone/actions/workflows/gradle_build.yml"><img src="https://github.com/cabaletta/baritone/actions/workflows/gradle_build.yml/badge.svg" alt="Build Status"/></a>
133-
<a href="https://github.com/cabaletta/baritone/releases/"><img src="https://img.shields.io/github/release/cabaletta/baritone.svg" alt="Release"/></a>
134-
<a href="LICENSE"><img src="https://img.shields.io/badge/license-LGPL--3.0%20with%20anime%20exception-green.svg" alt="License"/></a>
135-
<a href="https://www.codacy.com/gh/cabaletta/baritone/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=cabaletta/baritone&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/cadab857dab049438b6e28b3cfc5570e" alt="Codacy Badge"/></a>
136-
<a href="https://github.com/cabaletta/baritone/blob/master/CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/%E2%9D%A4-code%20of%20conduct-blue.svg?style=flat" alt="Code of Conduct"/></a>
137-
<a href="https://snyk.io/test/github/cabaletta/baritone?targetFile=build.gradle"><img src="https://snyk.io/test/github/cabaletta/baritone/badge.svg?targetFile=build.gradle" alt="Known Vulnerabilities"/></a>
138-
<a href="https://github.com/cabaletta/baritone/issues/"><img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat" alt="Contributions welcome"/></a>
139-
<a href="https://github.com/cabaletta/baritone/issues/"><img src="https://img.shields.io/github/issues/cabaletta/baritone.svg" alt="Issues"/></a>
140-
<a href="https://github.com/cabaletta/baritone/issues?q=is%3Aissue+is%3Aclosed"><img src="https://img.shields.io/github/issues-closed/cabaletta/baritone.svg" alt="GitHub issues-closed"/></a>
141-
<a href="https://github.com/cabaletta/baritone/pulls/"><img src="https://img.shields.io/github/issues-pr/cabaletta/baritone.svg" alt="Pull Requests"/></a>
142-
<a href="https://github.com/cabaletta/baritone/graphs/contributors/"><img src="https://img.shields.io/github/contributors/cabaletta/baritone.svg" alt="GitHub contributors"/></a>
143-
<a href="https://github.com/cabaletta/baritone/commit/"><img src="https://img.shields.io/github/commits-since/cabaletta/baritone/v1.0.0.svg" alt="GitHub commits"/></a>
144-
<img src="https://img.shields.io/github/languages/code-size/cabaletta/baritone.svg" alt="Code size"/>
145-
<img src="https://img.shields.io/github/repo-size/cabaletta/baritone.svg" alt="GitHub repo size"/>
146-
<img src="https://tokei.rs/b1/github/cabaletta/baritone?category=code&style=flat" alt="Lines of Code"/>
147-
<img src="https://img.shields.io/badge/Badges-36-blue.svg" alt="yes"/>
148-
</p>
149-
150-
<p align="center">
151-
<a href="https://impactclient.net/"><img src="https://img.shields.io/badge/Impact%20integration-v1.2.14%20/%20v1.3.8%20/%20v1.4.6%20/%20v1.5.3%20/%20v1.6.3-brightgreen.svg" alt="Impact integration"/></a>
152-
<a href="https://github.com/lambda-client/lambda"><img src="https://img.shields.io/badge/Lambda%20integration-v1.2.17-brightgreen.svg" alt="Lambda integration"/></a>
153-
<a href="https://github.com/fr1kin/ForgeHax/"><img src="https://img.shields.io/badge/ForgeHax%20%22integration%22-scuffed-yellow.svg" alt="ForgeHax integration"/></a>
154-
<a href="https://aristois.net/"><img src="https://img.shields.io/badge/Aristois%20add--on%20integration-v1.6.3-green.svg" alt="Aristois add-on integration"/></a>
155-
<a href="https://rootnet.dev/"><img src="https://img.shields.io/badge/rootNET%20integration-v1.2.14-green.svg" alt="rootNET integration"/></a>
156-
<a href="https://futureclient.net/"><img src="https://img.shields.io/badge/Future%20integration-v1.2.12%20%2F%20v1.3.6%20%2F%20v1.4.4-red" alt="Future integration"/></a>
157-
<a href="https://rusherhack.org/"><img src="https://img.shields.io/badge/RusherHack%20integration-v1.2.14-green" alt="RusherHack integration"/></a>
158-
</p>
159-
160-
<p align="center">
161-
<a href="http://forthebadge.com/"><img src="https://web.archive.org/web/20230604002050/https://forthebadge.com/images/badges/built-with-swag.svg" alt="forthebadge"/></a>
162-
<a href="http://forthebadge.com/"><img src="https://web.archive.org/web/20230604002050/https://forthebadge.com/images/badges/mom-made-pizza-rolls.svg" alt="forthebadge"/></a>
163-
</p>
164-
165-
</details>
166-
167146
<a href="https://www.star-history.com/#cabaletta/baritone&amp;Date">
168147
<picture>
169148
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=cabaletta/baritone&amp;type=Date&amp;theme=dark"/>

‎SETUP.md‎

Lines changed: 9 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,9 @@ Releases are made rarely and are not always up to date with the latest features
1212

1313
Which Baritone version goes with which Minecraft version:
1414

15-
| Minecraft version | Baritone version |
16-
|-------------------|------------------|
17-
| 1.12 | v1.2 |
18-
| 1.13 | v1.3 |
19-
| 1.14 | v1.4 |
20-
| 1.15 | v1.5 |
21-
| 1.16 | v1.6 |
22-
| 1.17 | v1.7 |
23-
| 1.18 | v1.8 |
24-
| 1.19 | v1.9 |
25-
| 1.20 | v1.10 |
26-
| 1.21 - 1.21.1 | v1.11 |
27-
| 1.21.3 | v1.12 |
28-
| 1.21.4 | v1.13 |
29-
| 1.21.5 | v1.14 |
30-
| 1.21.6 - 1.21.8 | v1.15 |
31-
| 1.21.9 - 1.21.10 | v1.16 |
32-
| 1.21.11 | v1.17 |
33-
| 26.1 | v1.18 |
34-
| 26.2 | v1.19 |
35-
| 26.3 | v1.20 |
15+
| Minecraft version | 1.12 | 1.13 | 1.14 | 1.15 | 1.16 | 1.17 | 1.18 | 1.19 | 1.20 | 1.21 - 1.21.1 | 1.21.3 | 1.21.4 | 1.21.5 | 1.21.6 - 1.21.8 | 1.21.9 - 1.21.10 | 1.21.11 | 26.1 | 26.2 | 26.3 |
16+
|-------------------|------|------|------|------|------|------|------|------|-------|---------------|--------|--------|--------|-----------------|------------------|---------|-------|-------|-------|
17+
| Baritone version | v1.2 | v1.3 | v1.4 | v1.5 | v1.6 | v1.7 | v1.8 | v1.9 | v1.10 | v1.11 | v1.12 | v1.13 | v1.14 | v1.15 | v1.16 | v1.17 | v1.18 | v1.19 | v1.20 |
3618

3719
### Verifying a release
3820

@@ -46,19 +28,13 @@ Building Baritone will create the final artifacts in the `dist` directory. These
4628

4729
**The Forge, NeoForge and Fabric releases can simply be added as mods.**
4830

49-
Which one you want:
31+
There's three flavors:
5032

51-
- If another one of your mods has a Baritone integration, you want `baritone-api-*-VERSION.jar`.
52-
- If you want to report a bug and spare us some effort, you want `baritone-unoptimized-*-VERSION.jar`.
53-
- Otherwise, you want `baritone-standalone-*-VERSION.jar`.
33+
- **API**: Only the non-api packages are obfuscated. Use this one if another one of your mods has a Baritone integration.
34+
- **Standalone**: Everything is obfuscated. Other mods cannot use Baritone, but you get a bit of extra performance. Use this one otherwise.
35+
- **Unoptimized**: Nothing is obfuscated. This shouldn't be used in production, but if you want to report a bug and spare us some effort, use this one.
5436

55-
What the first part of the name means:
56-
57-
- **API**: Only the non-api packages are obfuscated. This should be used in environments where other mods would like to use Baritone's features.
58-
- **Standalone**: Everything is obfuscated. Other mods cannot use Baritone, but you get a bit of extra performance.
59-
- **Unoptimized**: Nothing is obfuscated. This shouldn't be used in production, but is really helpful for crash reports.
60-
61-
And the second part:
37+
And each flavor comes for:
6238

6339
- **Forge / NeoForge / Fabric**: Loadable as a standard mod using the respective loader. The Fabric build may or may not work on Quilt.
6440
- **No loader**: Loadable as a launchwrapper tweaker against vanilla Minecraft using a custom `version.json`.
@@ -91,7 +67,7 @@ For anything newer, check the Java version in [the build CI action](/.github/wor
9167

9268
On Mac and Linux, use `./gradlew` instead of `gradlew`.
9369

94-
For most branches, `gradlew build` builds everything. The exact tasks depend on the Minecraft version, so if that doesn't work, check [the build CI action](/.github/workflows/gradle_build.yml) of the branch you want to build, since this file might be out of date.
70+
For most branches, `gradlew build` builds everything, and the finished jars end up in the `dist` directory at the root of the repo. The exact tasks depend on the Minecraft version, so if that doesn't work, check [the build CI action](/.github/workflows/gradle_build.yml) of the branch you want to build, since this file might be out of date.
9571

9672
On older branches, `gradlew build` only builds the tweaker jar, and you need `gradlew build -Pbaritone.forge_build` or `gradlew build -Pbaritone.fabric_build` for Forge or Fabric instead. You might also have to run `setupDecompWorkspace` first.
9773

0 commit comments

Comments
 (0)