mat/azalea
1
2
Fork 0
mirror of https://github.com/mat-1/azalea.git synced 2025-08-02 14:26:04 +00:00
Code Issues Projects Releases Packages Activity

improve readme

Browse source
This commit is contained in:
mat 2023-10-03 13:10:18 -05:00
parent 0ef15254c4
commit f63baf5a03
1 changed files with 14 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -11,11 +11,22 @@ A collection of Rust crates for making Minecraft bots, clients, and tools.
<!-- The line below is automatically read and updated by the migrate script, so don't change it manually. -->
*Currently supported Minecraft version: `1.20.2`.*
## ⚠️ Azalea is still very unfinished, though most crates are in a somewhat useable state
> **Warning**
> Azalea is still very unfinished, though most crates are in a somewhat useable state
## Features
- [Accurate physics](https://github.com/azalea-rs/azalea/blob/main/azalea-physics/src/lib.rs) (but some features like knockback and water physics aren't yet implemented)
- [Pathfinder](https://azalea.matdoes.dev/azalea/pathfinder/index.html) (parkour isn't perfect yet)
- [Swarms](https://azalea.matdoes.dev/azalea/swarm/index.html)
- [Breaking blocks](https://azalea.matdoes.dev/azalea/struct.Client.html#method.mine)
- [Block interactions & building](https://azalea.matdoes.dev/azalea/struct.Client.html#method.block_interact) (this doesn't predict the block interactions/placement on the client yet but it's usually fine)
- [Inventories](https://azalea.matdoes.dev/azalea/struct.Client.html#impl-ContainerClientExt-for-Client)
- [Attacking entities](https://azalea.matdoes.dev/azalea/struct.Client.html#method.attack) (but you can't get the entity at the crosshair yet)
## 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)
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) (recommended).
## Matrix/Discord
@ -23,9 +34,7 @@ If you'd like to chat about Azalea, you can join the Matrix space at [#azalea:ma
## 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.
For fun, mostly. I wasn't satisfied with the current state of Minecraft bot libraries, and this seemed like a good way to learn Rust.
## Goals
@ -42,11 +51,6 @@ Also it's named Azalea because it sounds like a cool word and this is a cool lib
- 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.