aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authormat <git@matdoes.dev>2025-12-11 20:52:49 -1100
committermat <git@matdoes.dev>2025-12-12 02:53:08 -0500
commit7c3a5768cda78cb9590aac1e1469d36333cd95ac (patch)
treeacecd4f57831e0fff47a8f96a1a30f6edb8825ed /README.md
parentf4a3c53eee7d29bade0c074f402c4a45aa98eca8 (diff)
downloadazalea-drasl-7c3a5768cda78cb9590aac1e1469d36333cd95ac.tar.xz
polish readmes
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 17 insertions, 23 deletions
diff --git a/README.md b/README.md
index 142cdd95..2ca162f8 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ _Currently supported Minecraft version: `1.21.11`._
## Features
-- [Accurate physics](https://github.com/azalea-rs/azalea/blob/main/azalea-physics/src/lib.rs) (but some features like entity pushing and elytras aren't implemented yet)
+- [Accurate physics](https://azalea.matdoes.dev/azalea_physics/) (but some features like entity pushing and elytras aren't implemented yet)
- [Pathfinder](https://azalea.matdoes.dev/azalea/pathfinder/index.html)
- [Swarms](https://azalea.matdoes.dev/azalea/swarm/index.html)
- [Breaking blocks](https://azalea.matdoes.dev/azalea/struct.Client.html#method.mine)
@@ -26,29 +26,29 @@ _Currently supported Minecraft version: `1.21.11`._
- [Attacking entities](https://azalea.matdoes.dev/azalea/struct.Client.html#method.attack)
- [Plugins](#plugins)
-## 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) (recommended).
-
-## 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) (recommended) or the Discord server at [discord.gg/FaRey6ytmC](https://discord.gg/FaRey6ytmC) (they're bridged so you don't need to join both).
-
## Goals
-- Do everything a vanilla client can do.
-- Be intuitive and easy to use.
+- Support everything that a vanilla Minecraft client can do.
+- Have an intuitive and easy to use API.
- Make it easy to have many bots working at the same time.
-- Don't trigger anticheats.
+- Don't trigger anti-cheats.
- Support the latest Minecraft version.
-- Be fast and memory efficient.
+- Be fast and efficient.
## Non-goals
-- Supporting several versions of Minecraft on the same branch[\*](https://github.com/azalea-rs/azalea-viaversion).
+- Supporting multiple versions of Minecraft at the same time[\*](https://github.com/azalea-rs/azalea-viaversion).
- Graphics[\*](https://github.com/urisinger/azalea-graphics).
- Bedrock edition.
+## Documentation
+
+The stable documentation for the main `azalea` crate is available at [docs.rs/azalea](https://docs.rs/azalea), and the unstable documentation is 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). The channels are bridged so you don't need to join both.
+
## Real-world bots using Azalea
Here's an incomplete list of bots built using Azalea, primarily intended as a reference in addition to the existing documentation and examples:
@@ -63,7 +63,8 @@ You can see more projects built with Azalea in the [GitHub dependency graph](htt
## Plugins
-Azalea has support for Bevy plugins, which can significantly alter its functionality. Here are some plugins that you may find useful:
+Azalea has support for Bevy plugins which can significantly alter its functionality.
+Here are some plugins that you may find useful:
- [azalea-rs/azalea-viaversion](https://github.com/azalea-rs/azalea-viaversion) - Multi-version compatibility for your Azalea bots using ViaProxy.
- [azalea-rs/azalea-hax](https://github.com/azalea-rs/azalea-hax) - Anti-knockback.
@@ -72,12 +73,5 @@ If you've created your own plugin for Azalea, please create a PR to add it to th
## Funding
-Azalea is currently maintained primarily by one person (mat) as a hobby project. If you appreciate Azalea, consider [donating on Ko-fi](https://ko-fi.com/matdoesdev).
-
-## FAQ
-
-- There's too many console messages, how do I disable them?
-
- You can disable all console messages by setting the `RUST_LOG` environment variable to `off`, or you can filter log messages by setting specific log levels. For example, to disable only pathfinding logs, you can set `RUST_LOG=azalea::pathfinder=off`.
+Azalea is currently maintained primarily by one person as a hobby project. If you appreciate Azalea, consider [donating on Ko-fi](https://ko-fi.com/matdoesdev).
- See the [`env_logger`](https://docs.rs/env_logger/latest/env_logger/) crate documentation for more information.