aboutsummaryrefslogtreecommitdiff
path: root/azalea
diff options
context:
space:
mode:
authormat <git@matdoes.dev>2023-11-12 17:13:43 -0600
committermat <git@matdoes.dev>2023-11-12 17:13:43 -0600
commit03cc28d8e71ed969b21a0824a93dd8e2671e3178 (patch)
tree88cd604d8fe54d4c79f6cb67ab8b6a2872529a49 /azalea
parent3d22b5b91cf8ea790e98273d114f26589e8280ae (diff)
downloadazalea-drasl-03cc28d8e71ed969b21a0824a93dd8e2671e3178.tar.xz
improve docs a bit
Diffstat (limited to 'azalea')
-rwxr-xr-xazalea/README.md22
-rw-r--r--azalea/src/pathfinder/mod.rs2
2 files changed, 14 insertions, 10 deletions
diff --git a/azalea/README.md b/azalea/README.md
index 5a3751d5..1ec82cd3 100755
--- a/azalea/README.md
+++ b/azalea/README.md
@@ -1,9 +1,7 @@
Azalea is a framework for creating Minecraft bots.
-Internally, it's just a wrapper over [`azalea_client`], adding useful
-functions for making bots. Because of this, lots of the documentation will
-refer to `azalea_client`. You can just replace these with `azalea` in your
-code, since everything from azalea_client is re-exported in azalea.
+This page is primarily meant for developers that already know they want to use Azalea.
+See the [readme](https://github.com/azalea-rs/azalea) for an overview of why you might want to use it.
# Installation
@@ -12,10 +10,8 @@ default nightly`.
Then, add one of the following lines to your Cargo.toml:
-Latest bleeding-edge version (recommended):
-`azalea = { git="https://github.com/azalea-rs/azalea" }`\
-Latest "stable" release:
-`azalea = "0.8.0"`
+- Latest bleeding-edge version (recommended): `azalea = { git="https://github.com/azalea-rs/azalea" }`\
+- Latest "stable" release: `azalea = "0.8.0"`
## Optimization
@@ -32,6 +28,14 @@ opt-level = 1
[profile.dev.package."*"]
opt-level = 3
```
+# Documentation
+
+The documentation for the latest Azalea crates.io release is available at [docs.rs/azalea](https://docs.rs/azalea/latest/azalea/) and the docs for the latest bleeding-edge (git) version are at [azalea.matdoes.dev](https://azalea.matdoes.dev/azalea/).
+
+Note that the `azalea` crate is technically just a wrapper over [`azalea_client`] that adds some extra functions.
+Because of this, some of the documentation will refer to `azalea_client`.
+You can just replace these with `azalea` in your code since everything from `azalea_client` is re-exported in azalea.
+
# Examples
@@ -73,7 +77,7 @@ async fn handle(bot: Client, event: Event, state: State) -> anyhow::Result<()> {
# Swarms
-Azalea lets you create "swarms", which are a group of bots in the same world that can perform actions together. See [testbot](https://github.com/azalea-rs/azalea/blob/main/azalea/examples/testbot.rs) for an example. Also, if you're using swarms, you should also have both `azalea::prelude::*` and `azalea::swarm::prelude::*`.
+Azalea lets you create "swarms", which are a group of bots in the same world that can perform actions together. See [testbot](https://github.com/azalea-rs/azalea/blob/main/azalea/examples/testbot.rs) for an example. Also, if you're using swarms, you should also `use` both `azalea::prelude::*` and `azalea::swarm::prelude::*`.
# Plugins
diff --git a/azalea/src/pathfinder/mod.rs b/azalea/src/pathfinder/mod.rs
index 5763f379..c7f05eae 100644
--- a/azalea/src/pathfinder/mod.rs
+++ b/azalea/src/pathfinder/mod.rs
@@ -58,9 +58,9 @@ impl Plugin for PathfinderPlugin {
.add_event::<PathFoundEvent>()
.add_event::<StopPathfindingEvent>()
.add_systems(
- FixedUpdate,
// putting systems in the FixedUpdate schedule makes them run every Minecraft tick
// (every 50 milliseconds).
+ FixedUpdate,
(
timeout_movement,
check_node_reached,