aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authormat <git@matdoes.dev>2023-10-03 13:10:18 -0500
committermat <git@matdoes.dev>2023-10-03 13:10:18 -0500
commitf63baf5a030b72de138354ae0601a8a5f66d6b30 (patch)
tree865d726b51bedd199765c18c23402eac242c4ba3 /README.md
parent0ef15254c404ec3afb72a61c19c09bb15dce6427 (diff)
downloadazalea-drasl-f63baf5a030b72de138354ae0601a8a5f66d6b30.tar.xz
improve readme
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md24
1 files changed, 14 insertions, 10 deletions
diff --git a/README.md b/README.md
index 7854dd86..96ec7253 100755
--- a/README.md
+++ b/README.md
@@ -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.