Skip to content
This repository has been archived by the owner on Aug 24, 2024. It is now read-only.

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AS1100K committed Jul 28, 2024
1 parent c938b18 commit d80bd23
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 19 deletions.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
<center>
<img src="https://img.shields.io/github/license/AS1100K/aether"/>
<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/AS1100K/aether/ci.yml?event=push&label=CI">
<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/AS1100K/aether/pr.yml?event=pull_request&label=PR">
<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/AS1100K/aether/release.yml?event=push&label=RELEASE">
</center>
![maintenance-status](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg)
![License](https://img.shields.io/github/license/AS1100K/aether)
![CI Status](https://img.shields.io/github/actions/workflow/status/AS1100K/aether/ci.yml?event=push&label=CI)
![PR Status](https://img.shields.io/github/actions/workflow/status/AS1100K/aether/pr.yml?event=pull_request&label=PR)
![Release Status](https://img.shields.io/github/actions/workflow/status/AS1100K/aether/release.yml?event=push&label=RELEASE)

# Aether
A Collection of Minecraft Bots written in rust mainly developed for `2b2t.org`.

> [!NOTE]
> This repository currently supports minecraft version `1.20.6` and uses self-maintained version of [azalea better-1.20.6](https://github.com/as1100k-forks/azalea.git)
> which has more features and fixes.
## Multi Azalea
This project is the wrapper around azalea to support multiple versions of azalea. This was made so that our plugins
support multiple versions of azalea. For more information see [multi-azalea](./multi-azalea/README.md)

## Plugins
1. [Anti AFK](./plugins/anti-afk) Anti AFK Plugin with advanced configuration which attempts to not get the bot afk kicked.
2. [Auto Mine](./plugins/auto-mine) Left Click implementation, when enabled this block will mine anything it is looking at
if reachable. Also available in [#156](https://github.com/azalea-rs/azalea/pull/156) PR in azalea.
4. [Task Manager](./plugins/task-manager) A small task manager that executes task one by one. Currently, it only supports,
a small number of tasks.
5. [Utility](./plugins/utility) A small collection of plugins that are essential for bot survival. It includes Auto Eat, and
Kill Aura (WIP).
1. [Anti AFK](./plugins/anti-afk) Plugin with advanced configuration which attempts to not get the bot afk kicked.
2. [Task Manager](./plugins/task-manager) A small task manager that executes task one by one. Currently, it only supports,
a small number of tasks.
3. [Utility](./plugins/utility) A small collection of plugins that are essential for bot survival. It includes Auto Eat, and
Kill Aura (WIP).

## Examples
1. [Anti AFK](./examples/anti-afk) This bot attempts to join the server, and simply tries to not get AFK kicked and also
not die of hunger.
2. [Stone Miner](./examples/stone-miner) This bot is specifically designed for mining stones in a stone generator at
craftmc.pl for my friend.
2. [Stone Miner](./examples/stone-miner) This bot is specifically designed for mining stones in a stone generator at `craftmc.pl`
for my friend.

### Deprecated Plugins ![maintenance-status](https://img.shields.io/badge/maintenance-deprecated-red.svg)
* [Auto-Mine](https://github.com/AS1100K/aether/tree/deprecated/plugins/auto-mine) plugin is the implementation of holding left-click in minecraft. Also, available at [PR #168](https://github.com/azalea-rs/azalea/pull/168) of azalea.

## TODOs / Future Goals
_For Project related TODOs head to the project's `README.md`_
Expand Down
8 changes: 7 additions & 1 deletion plugins/utility/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,10 @@ A small collection of azalea utility plugins required for the bot to survive.

## Included Plugins
1. Auto Eat
2. Kill Aura (WIP)
2. Kill Aura (WIP)

## TODOs

- [ ] Auto Totem
- [ ] Kill Aura
- [ ] Crystal PVP

0 comments on commit d80bd23

Please sign in to comment.