aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 52637efe02bfb65cc780e9da0088f7b8235d54e5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# Azalea

A collection of Rust crates primarily for creating Minecraft bots.

<p align="center">
    <img src="https://cdn.matdoes.dev/images/flowering_azalea.webp" alt="Azalea" height="200">
</p>

<!-- The line below is automatically read and updated by the migrate script, so don't change it manually. -->
*Currently supported Minecraft version: `1.19.2`.*

## ⚠️ Azalea is still super unfinished, you probably shouldn't use it


I named this Azalea because it sounds like a cool word and this is a cool library. This project was heavily inspired by PrismarineJS.

## Why

I wanted a fun excuse to do something cool with Rust, and I also felt like I could do better than [Mineflayer](https://github.com/prismarinejs/mineflayer) in some areas.

## Goals

- Do everything a vanilla client can do.
- Be intuitive and easy to use.
- Bypass most/all anticheats.
- Support the latest Minecraft version.
- Be fast and memory efficient.

## Non-goals

- Supporting several versions of Minecraft on the same branch.
- Bedrock edition.
- Graphics.


## Stretch goals

- Server implementation.
- Having branches for several popular Minecraft versions.