1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
use std::time::Duration;
use azalea_client::{DefaultPlugins, account::Account};
use azalea_protocol::address::ResolvableAddr;
use bevy_app::{AppExit, Plugins};
use bevy_ecs::component::Component;
use crate::{
HandleFn, JoinOpts, NoState,
bot::DefaultBotPlugins,
swarm::{self, SwarmBuilder},
};
/// A builder for creating new [`Client`](crate::Client)s. This is the
/// recommended way of making a bot.
///
/// ```no_run
/// # use azalea::prelude::*;
/// # #[tokio::main]
/// # async fn main() {
/// ClientBuilder::new()
/// .set_handler(handle)
/// .start(Account::offline("bot"), "localhost")
/// .await;
/// # }
/// # #[derive(Clone, Component, Default)]
/// # pub struct State;
/// # async fn handle(mut bot: Client, event: Event, state: State) -> eyre::Result<()> {
/// # Ok(())
/// # }
/// ```
pub struct ClientBuilder<S, R>
where
S: Default + Send + Sync + Clone + Component + 'static,
R: Send + 'static,
Self: Send,
{
/// Internally, ClientBuilder is just a wrapper over SwarmBuilder since it's
/// technically just a subset of it so we can avoid duplicating code this
/// way.
swarm: SwarmBuilder<S, swarm::NoSwarmState, R, ()>,
}
impl ClientBuilder<NoState, ()> {
/// Start building a client that can join the world.
#[must_use]
pub fn new() -> Self {
Self::new_without_plugins()
.add_plugins(DefaultPlugins)
.add_plugins(DefaultBotPlugins)
}
/// [`Self::new`] but without adding the plugins by default.
///
/// This is useful if you want to disable a default plugin. This also exists
/// for swarms, see [`SwarmBuilder::new_without_plugins`].
///
/// Note that you can also disable `LogPlugin` by disabling the `log`
/// feature.
///
/// You **must** add [`DefaultPlugins`] and [`DefaultBotPlugins`] to this.
///
/// ```
/// # use azalea::prelude::*;
/// use azalea::app::PluginGroup;
///
/// let client_builder = ClientBuilder::new_without_plugins()
/// .add_plugins(
/// azalea::DefaultPlugins
/// .build()
/// .disable::<azalea::chat_signing::ChatSigningPlugin>(),
/// )
/// .add_plugins(azalea::bot::DefaultBotPlugins);
/// # client_builder.set_handler(handle);
/// # #[derive(Clone, Component, Default)]
/// # pub struct State;
/// # async fn handle(mut bot: Client, event: Event, state: State) -> eyre::Result<()> {
/// # Ok(())
/// # }
/// ```
#[must_use]
pub fn new_without_plugins() -> Self {
Self {
swarm: SwarmBuilder::new_without_plugins(),
}
}
/// Set the function that's called every time a bot receives an
/// [`Event`](crate::Client). This is the way to handle normal per-bot
/// events.
///
/// Currently, you can have up to one client handler.
///
/// Note that if you're creating clients directly from the ECS using
/// [`StartJoinServerEvent`] and the client wasn't already in the ECS, then
/// the handler function won't be called for that client. This shouldn't be
/// a concern for most bots, though.
///
/// ```
/// # use azalea::prelude::*;
/// # let client_builder = azalea::ClientBuilder::new();
/// client_builder.set_handler(handle);
///
/// # #[derive(Clone, Component, Default)]
/// # pub struct State;
/// async fn handle(mut bot: Client, event: Event, state: State) -> eyre::Result<()> {
/// Ok(())
/// }
/// ```
///
/// [`StartJoinServerEvent`]: azalea_client::join::StartJoinServerEvent
#[must_use]
pub fn set_handler<S, Fut, R>(self, handler: HandleFn<S, Fut>) -> ClientBuilder<S, R>
where
S: Default + Send + Sync + Clone + Component + 'static,
Fut: Future<Output = R> + Send + 'static,
R: Send + 'static,
{
ClientBuilder {
swarm: self.swarm.set_handler(handler),
}
}
}
impl<S, R> ClientBuilder<S, R>
where
S: Default + Send + Sync + Clone + Component + 'static,
R: Send + 'static,
{
/// Set the client state instead of initializing defaults.
#[must_use]
pub fn set_state(mut self, state: S) -> Self {
self.swarm.states = vec![state];
self
}
/// Add a group of plugins to the client.
///
/// See [`Self::new_without_plugins`] to learn how to disable default
/// plugins.
#[must_use]
pub fn add_plugins<M>(mut self, plugins: impl Plugins<M>) -> Self {
self.swarm = self.swarm.add_plugins(plugins);
self
}
/// Configures the auto-reconnection behavior for our bot.
///
/// If this is `Some`, then it'll set the default reconnection delay for our
/// bot (how long it'll wait after being kicked before it tries
/// rejoining). if it's `None`, then auto-reconnecting will be disabled.
///
/// If this function isn't called, then our client will reconnect after
/// [`DEFAULT_RECONNECT_DELAY`].
///
/// Note that disabling auto-reconnecting will not make
/// [`ClientBuilder::start`] return on disconnect, because Azalea will keep
/// the internal swarm around forever until it's forcibly exited. To learn
/// how to do that, see [`Client::exit`].
///
/// [`DEFAULT_RECONNECT_DELAY`]: crate::auto_reconnect::DEFAULT_RECONNECT_DELAY
/// [`Client::exit`]: crate::Client::exit
#[must_use]
pub fn reconnect_after(mut self, delay: impl Into<Option<Duration>>) -> Self {
self.swarm.reconnect_after = delay.into();
self
}
/// Build this `ClientBuilder` into an actual [`Client`](crate::Client) and
/// join the given server.
///
/// If the client can't join, it'll keep retrying forever until it can.
///
/// The `address` argument can be a `&str`, [`ServerAddr`],
/// [`ResolvedAddr`], or anything else that implements [`ResolvableAddr`].
///
/// # Errors
///
/// This will error if the given address is invalid or couldn't be resolved
/// to a Minecraft server.
///
/// [`ServerAddr`]: ../azalea_protocol/address/struct.ServerAddr.html
/// [`ResolvedAddr`]: ../azalea_protocol/address/struct.ResolvedAddr.html
/// [`ResolvableAddr`]: ../azalea_protocol/address/trait.ResolvableAddr.html
pub async fn start(mut self, account: Account, address: impl ResolvableAddr) -> AppExit {
self.swarm.accounts = vec![(account, JoinOpts::default())];
if self.swarm.states.is_empty() {
self.swarm.states = vec![S::default()];
}
self.swarm.start(address).await
}
/// Do the same as [`Self::start`], but allow passing in custom join
/// options.
pub async fn start_with_opts(
mut self,
account: Account,
address: impl ResolvableAddr,
opts: JoinOpts,
) -> AppExit {
self.swarm.accounts = vec![(account, opts.clone())];
if self.swarm.states.is_empty() {
self.swarm.states = vec![S::default()];
}
self.swarm.start_with_opts(address, opts).await
}
}
impl Default for ClientBuilder<NoState, ()> {
fn default() -> Self {
Self::new()
}
}