mirror of
https://github.com/mat-1/azalea.git
synced 2024-09-20 07:02:31 +00:00
49 lines
1.9 KiB
Markdown
Executable file
49 lines
1.9 KiB
Markdown
Executable file
# 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.19.3`.*
|
|
|
|
## ⚠️ 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. (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)
|
|
- Having branches for several popular Minecraft versions.
|