Swarm (#36)

* make azalea-pathfinder dir

* start writing d* lite impl

* more work on d* lite

* work more on implementing d* lite

* full d* lite impl

* updated edges

* add next() function

* add NoPathError

* why does dstar lite not work

* fix d* lite implementation

* make the test actually check the coords

* replace while loop with if statement

* fix clippy complaints

* make W only have to be PartialOrd

* fix PartialOrd issues

* implement mtd* lite

* add a test to mtd* lite

* remove normal d* lite

* make heuristic only take in one arg

* add `success` function

* Update README.md

* evil black magic to make .entity not need dimension

* start adding moves

* slightly improve the vec3/position situation

new macro that implements all the useful functions

* moves stuff

* make it compile

* update deps in az-pathfinder

* make it compile again

* more pathfinding stuff

* add Bot::look_at

* replace EntityMut and EntityRef with just Entity

* block pos pathfinding stuff

* rename movedirection to walkdirection

* execute path every tick

* advance path

* change az-pf version

* make azalea_client keep plugin state

* fix Plugins::get

* why does it think there is air

* start debugging incorrect air

* update some From methods to use rem_euclid

* start adding swarm

* fix deadlock

i still don't understand why it was happening but the solution was to keep the Client::player lock for shorter so it didn't overlap with the Client::dimension lock

* make lookat actually work probably

* fix going too fast

* Update main.rs

* make a thing immutable

* direction_looking_at

* fix rotations

* import swarm in an example

* fix stuff from merge

* remove azalea_pathfinder import

* delete azalea-pathfinder crate

already in azalea::pathfinder module

* swarms

* start working on shared dimensions

* Shared worlds work

* start adding Swarm::add_account

* add_account works

* change "client" to "bot" in some places

* Fix issues from merge

* Update world.rs

* add SwarmEvent::Disconnect(Account)

* almost add SwarmEvent::Chat and new plugin system

it panics rn

* make plugins have to provide the State associated type

* improve comments

* make fn build slightly cleaner

* fix SwarmEvent::Chat

* change a println in bot/main.rs

* Client::shutdown -> disconnect

* polish

fix clippy warnings + improve some docs a bit

* fix shared worlds*

*there's a bug that entities and bots will have their positions exaggerated because the relative movement packet is applied for every entity once per bot

* i am being trolled by rust

for some reason some stuff is really slow for literally no reason and it makes no sense i am going insane

* make world an RwLock again

* remove debug messages

* fix skipping event ticks

unfortunately now sending events is `.send().await?` instead of just `.send()`

* fix deadlock + warnings

* turns out my floor_mod impl was wrong

and i32::rem_euclid has the correct behavior LOL

* still errors with lots of bots

* make swarm iter & fix new chunks not loading

* improve docs

* start fixing tests

* fix all the tests

except the examples i don't know how to exclude them from the tests

* improve docs some more

1 files changed, 136 insertions, 0 deletions

diff --git a/azalea/src/start.rs b/azalea/src/start.rs
new file mode 100644
index 00000000..c7d79261
--- /dev/null
+++ b/azalea/src/start.rs
@@ -0,0 +1,136 @@
+use crate::{bot, pathfinder, HandleFn};
+use azalea_client::{Account, Client, Plugins};
+use azalea_protocol::ServerAddress;
+use std::{future::Future, sync::Arc};
+use thiserror::Error;
+
+/// A helper macro that generates a [`Plugins`] struct from a list of objects
+/// that implement [`Plugin`].
+///
+/// ```rust,no_run
+/// plugins![azalea_pathfinder::Plugin];
+/// ```
+///
+/// [`Plugin`]: crate::Plugin
+#[macro_export]
+macro_rules! plugins {
+    ($($plugin:expr),*) => {
+        {
+            let mut plugins = azalea::Plugins::new();
+            $(
+                plugins.add($plugin);
+            )*
+            plugins
+        }
+    };
+}
+
+/// The options that are passed to [`azalea::start`].
+///
+/// [`azalea::start`]: crate::start()
+pub struct Options<S, A, Fut>
+where
+    A: TryInto<ServerAddress>,
+    Fut: Future<Output = Result<(), anyhow::Error>>,
+{
+    /// The address of the server that we're connecting to. This can be a
+    /// `&str`, [`ServerAddress`], or anything that implements
+    /// `TryInto<ServerAddress>`.
+    ///
+    /// [`ServerAddress`]: azalea_protocol::ServerAddress
+    pub address: A,
+    /// The account that's going to join the server.
+    pub account: Account,
+    /// The plugins that are going to be used. Plugins are external crates that
+    /// add extra functionality to Azalea. You should use the [`plugins`] macro
+    /// for this field.
+    ///
+    /// ```rust,no_run
+    /// plugins![azalea_pathfinder::Plugin]
+    /// ```
+    pub plugins: Plugins,
+    /// A struct that contains the data that you want your bot to remember
+    /// across events.
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// use parking_lot::Mutex;
+    /// use std::sync::Arc;
+    ///
+    /// #[derive(Default, Clone)]
+    /// struct State {
+    ///     farming: Arc<Mutex<bool>>,
+    /// }
+    /// ```
+    pub state: S,
+    /// The function that's called whenever we get an event.
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// use azalea::prelude::*;
+    ///
+    /// async fn handle(bot: Client, event: Event, state: State) -> anyhow::Result<()> {
+    ///     Ok(())
+    /// }
+    /// ```
+    pub handle: HandleFn<Fut, S>,
+}
+
+#[derive(Error, Debug)]
+pub enum StartError {
+    #[error("Invalid address")]
+    InvalidAddress,
+    #[error("Join error: {0}")]
+    Join(#[from] azalea_client::JoinError),
+}
+
+/// Join a server and start handling events. This function will run forever until
+/// it gets disconnected from the server.
+///
+/// # Examples
+///
+/// ```rust,no_run
+/// let error = azalea::start(azalea::Options {
+///     account,
+///     address: "localhost",
+///     state: State::default(),
+///     plugins: plugins![azalea_pathfinder::Plugin],
+///     handle,
+/// }).await;
+/// ```
+pub async fn start<
+    S: Send + Sync + Clone + 'static,
+    A: Send + TryInto<ServerAddress>,
+    Fut: Future<Output = Result<(), anyhow::Error>> + Send + 'static,
+>(
+    options: Options<S, A, Fut>,
+) -> Result<(), StartError> {
+    let address = match options.address.try_into() {
+        Ok(address) => address,
+        Err(_) => return Err(StartError::InvalidAddress),
+    };
+
+    let (mut bot, mut rx) = Client::join(&options.account, address).await?;
+
+    let mut plugins = options.plugins;
+    // DEFAULT PLUGINS
+    plugins.add(bot::Plugin);
+    plugins.add(pathfinder::Plugin);
+
+    bot.plugins = Arc::new(plugins.build());
+
+    let state = options.state;
+
+    while let Some(event) = rx.recv().await {
+        let cloned_plugins = (*bot.plugins).clone();
+        for plugin in cloned_plugins.into_iter() {
+            tokio::spawn(plugin.handle(event.clone(), bot.clone()));
+        }
+
+        tokio::spawn((options.handle)(bot.clone(), event.clone(), state.clone()));
+    }
+
+    Ok(())
+}