blob: b83cfaa147c2fe60a429082f73d46cb375536b79 (
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
# Azalea
[](https://docs.rs/azalea)
A collection of Rust crates for making Minecraft bots, clients, and tools.
<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.20.1`.*
## ⚠️ Azalea is still very unfinished, though most crates are in a somewhat useable state
## Docs
The "stable" documentation is available at [docs.rs/azalea](https://docs.rs/azalea) and the unstable docs are at [azalea.matdoes.dev](https://azalea.matdoes.dev)
## Matrix/Discord
If you'd like to chat about Azalea, you can join the Matrix space at [#azalea:matdoes.dev](https://matrix.to/#/#azalea:matdoes.dev) or the Discord server at [discord.gg/FaRey6ytmC](https://discord.gg/FaRey6ytmC).
## Why
This project was heavily inspired by [PrismarineJS](https://github.com/PrismarineJS).
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.
Also it's named Azalea because it sounds like a cool word and this is a cool library.
## Goals
- Do everything a vanilla client can do.
- Be intuitive and easy to use.
- Make it easy to have many bots working at the same time.
- Don't trigger 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.
## Branches
There are several branches in the Azalea repository that target older Minecraft versions. It is not guaranteed that they will be up-to-date with the latest version of Azalea. If you'd like to update them or add more, please open a PR.
- [1.19.4](https://github.com/mat-1/azalea/tree/1.19.4)
- [1.19.3](https://github.com/mat-1/azalea/tree/1.19.3)
- [1.19.2](https://github.com/mat-1/azalea/tree/1.19.2)
|
