azalea/README.md

33 lines
1.1 KiB
Markdown
Raw Normal View History

2021-12-16 05:10:55 +00:00
# Azalea
2022-06-17 23:13:34 +00:00
A collection of Rust crates primarily for creating Minecraft bots.
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. -->
*Currently supported Minecraft version: `1.19.2`.*
2022-05-25 01:28:08 +00:00
2022-07-18 21:55:55 +00:00
## ⚠️ Azalea is still super unfinished, you probably shouldn't use it
2021-12-20 21:22:02 +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.
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-05-10 00:14:13 +00:00
- Bypass most/all anticheats.
- 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
- Supporting many versions of Minecraft (but there might be branches made in the future for some popular versions).
- Graphics.