2021-12-16 05:10:55 +00:00
# Azalea
2022-10-30 20:05:54 +00:00
[![docs.rs ](https://img.shields.io/docsrs/azalea )](https://docs.rs/azalea)
2022-10-30 20:05:14 +00:00
2022-10-15 22:47:41 +00:00
A collection of Rust crates for making Minecraft bots, clients, and tools.
2022-05-15 01:47:37 +00:00
2022-05-01 20:22:28 +00:00
< p align = "center" >
< img src = "https://cdn.matdoes.dev/images/flowering_azalea.webp" alt = "Azalea" height = "200" >
< / p >
2021-12-20 21:22:02 +00:00
2022-05-25 01:28:08 +00:00
<!-- The line below is automatically read and updated by the migrate script, so don't change it manually. -->
2022-08-06 04:58:50 +00:00
*Currently supported Minecraft version: `1.19.2` .*
2022-05-25 01:28:08 +00:00
2022-10-31 15:56:15 +00:00
## ⚠️ Azalea is still very unfinished, though most crates are in a somewhat useable state
2022-07-18 21:55:55 +00:00
2022-08-30 01:41:01 +00:00
I named this Azalea because it sounds like a cool word and this is a cool library.
This project was heavily inspired by [PrismarineJS ](https://github.com/PrismarineJS ).
2021-12-16 05:26:15 +00:00
2022-05-02 23:07:06 +00:00
## 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.
2021-12-16 05:26:15 +00:00
## Goals
2022-05-10 00:14:13 +00:00
- Do everything a vanilla client can do.
2022-05-15 01:50:20 +00:00
- Be intuitive and easy to use.
2022-10-08 00:57:42 +00:00
- Make it easy to have many bots working at the same time.
- Don't trigger anticheats.
2022-05-10 00:14:13 +00:00
- Support the latest Minecraft version.
- Be fast and memory efficient.
2022-04-25 16:18:12 +00:00
2022-07-30 23:00:54 +00:00
## Non-goals
2022-08-19 04:28:44 +00:00
- Supporting several versions of Minecraft on the same branch.
- Bedrock edition.
2022-07-30 23:00:54 +00:00
- Graphics.
2022-08-19 04:28:44 +00:00
## Stretch goals
2022-11-04 01:08:14 +00:00
- Server implementation. (if you're interested in making this then please contact me, I'd love for it to be a thing. [@mat:matdoes.dev ](https://matrix.to/#/@mat:matdoes.dev ) / mat#1592)
2022-08-19 04:28:44 +00:00
- Having branches for several popular Minecraft versions.