azalea

Azalea

A collection of Rust crates for making Minecraft bots, clients, and tools.

Currently supported Minecraft version: 26.2.

[!WARNING] Many parts of Azalea are still unfinished and will receive breaking changes in the future. Most breaking changes will be listed in the changelog.

Features

• Accurate physics (but some features like entity pushing and sprint swimming aren't implemented yet)
• Pathfinder
• Swarms
• Breaking blocks
• Block interactions & building (this doesn't predict the block interactions/placement on the client yet, but it's usually fine)
• Inventories
• Attacking entities
• Plugins

Goals

• 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 anti-cheats.
• Support the latest Minecraft version.
• Be fast and efficient.

Non-goals

• Supporting multiple versions of Minecraft at the same time [Note].
• Graphics [Note].
• Bedrock edition.

Documentation

The stable documentation for the main azalea crate is available at docs.rs/azalea, and the unstable documentation is at azalea.rs.

Matrix/Discord

If you'd like to chat about Azalea, you can join the Matrix space at #azalea:matdoes.dev or the Discord server at 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:

• ShayBox/ShaysBot - Pearl stasis bot featuring a Discord bot, an HTTP API, and more.
• EnderKill98/statis-bot - This bot can automatically detect thrown pearls and later walk there and pull them for you.
• as1100k/aether - Collection of Minecraft bots and plugins.
• mat-1/potato-bot-2 - Hardened Discord chat bridge created for the LiveOverflow SMP.
• ErrorNoInternet/ErrorNoWatcher - A Minecraft bot with Lua scripting support.
• BaconCat1/ForestBot-RS - Originally a Mineflayer bot, ported to Azalea. Does too many things to list here.
• nullclyze/salarixi - Feature-rich, multi-task, and lightweight tool for Minecraft botting.

You can see more projects built with Azalea in the GitHub dependency graph.

Plugins

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 - Multi-version compatibility for your Azalea bots using ViaProxy.
• azalea-rs/azalea-hax - Anti-knockback.

If you've created your own plugin for Azalea, please create a PR to add it to this list :).

Funding

Azalea is currently maintained primarily by one person as a hobby project. If you appreciate Azalea, please consider sponsoring it with GitHub Sponsors or on Ko-fi.