From 7c3a5768cda78cb9590aac1e1469d36333cd95ac Mon Sep 17 00:00:00 2001 From: mat Date: Thu, 11 Dec 2025 20:52:49 -1100 Subject: polish readmes --- README.md | 40 +++++++++++++++++----------------------- azalea-auth/README.md | 2 +- azalea-block/README.md | 6 ++++-- azalea-brigadier/README.md | 2 +- azalea-buf/README.md | 4 ++-- azalea-client/README.md | 4 ++-- azalea-core/README.md | 2 +- azalea-crypto/README.md | 2 +- azalea-entity/README.md | 3 +++ azalea-entity/src/lib.rs | 1 + azalea-inventory/README.md | 3 +++ azalea-inventory/src/lib.rs | 3 +-- azalea-language/README.md | 4 ++-- azalea-physics/README.md | 4 ++-- azalea-protocol/README.md | 6 ++++-- azalea-protocol/src/lib.rs | 12 +----------- azalea-world/README.md | 4 +++- azalea/README.md | 12 +++++++++--- 18 files changed, 58 insertions(+), 56 deletions(-) create mode 100644 azalea-entity/README.md create mode 100644 azalea-inventory/README.md 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. diff --git a/azalea-auth/README.md b/azalea-auth/README.md index d7026254..055498c3 100644 --- a/azalea-auth/README.md +++ b/azalea-auth/README.md @@ -1,4 +1,4 @@ -# Azalea Auth +# `azalea-auth` A port of Mojang's Authlib and launcher authentication. diff --git a/azalea-block/README.md b/azalea-block/README.md index 81e6b097..ff3e8c31 100644 --- a/azalea-block/README.md +++ b/azalea-block/README.md @@ -1,6 +1,8 @@ +# `azalea-block` + Representation of Minecraft block states. -There's three block types, used for different things. You can (mostly) convert between them with `.into()`. +There are three block types, used for different things. You can (mostly) convert between them with `.into()`. ## `BlockState` struct @@ -43,7 +45,7 @@ if let Some(jukebox) = Box::::from(block_state).downcast_ref::() == bot.component::()` is not guaranteed to be true inside of a `tokio::spawn`. Azalea already mitigates this in the handler function by using a Tokio [LocalSet](https://docs.rs/tokio/latest/tokio/task/struct.LocalSet.html), but that mitigation does not apply if you call `tokio::spawn` yourself. To avoid this, you must call `tokio::task::spawn_local` in place of `tokio::spawn`. Alternatively, you could also mark your main function with `#[tokio::main(flavor = "current_thread")]`. +## Disabling log messages + +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`. + +See the [`env_logger`](https://docs.rs/env_logger/latest/env_logger/) crate documentation for more information. + [`bevy_log`]: https://docs.rs/bevy_log + -- cgit v1.2.3