nurtex 1.2.1

Create efficient and lightweight Minecraft bots or clients.
Documentation 
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
210
211
212
213
214
215
216
217
218
219
220

use rand::Rng;

/// Тип функции для создания задержки подключения
pub type JoinDelayFn = dyn Fn(u64, u64) -> u64 + Send + Sync;

/// Гибкая задержка между подключением ботов
pub struct JoinDelay(Box<JoinDelayFn>);

impl JoinDelay {
  /// Метод активации функции создания задержки
  pub fn activate(&self, current: usize, total: usize) -> u64 {
    self.0(current as u64, total as u64)
  }

  /// Метод создания фиксированной задержки
  pub fn fixed(delay: u64) -> Self {
    Self(Box::new(move |_current, _total| delay))
  }

  /// Метод создания прогрессивной задержки (увеличивается с каждым ботом до указанного предела)
  pub fn progressive(delay: u64, max_delay: u64, multiplier: u64) -> Self {
    Self(Box::new(move |current, _total| {
      let result = delay * ((current + 1) * multiplier);

      if result > max_delay { max_delay } else { result }
    }))
  }

  /// Метод создания линейной прогрессивной задержки (увеличивается с каждым ботом до указанного предела)
  pub fn progressive_linear(delay: u64, max_delay: u64) -> Self {
    Self(Box::new(move |current, _total| {
      let result = delay * (current + 1);

      if result > max_delay { max_delay } else { result }
    }))
  }

  /// Метод создания регрессивной задержки (уменьшается с каждым ботом до указанного предела)
  pub fn regressive(delay: u64, min_delay: u64, multiplier: u64) -> Self {
    Self(Box::new(move |current, _total| {
      let result = delay / ((current + 1) * multiplier);

      if result < min_delay { min_delay } else { result }
    }))
  }

  /// Метод создания линейной регрессивной задержки (уменьшается с каждым ботом до указанного предела)
  pub fn regressive_linear(delay: u64, min_delay: u64) -> Self {
    Self(Box::new(move |current, _total| {
      let result = delay / (current + 1);

      if result < min_delay { min_delay } else { result }
    }))
  }

  /// Метод создания кастомной функции создания задержки
  pub fn custom(func: Box<JoinDelayFn>) -> Self {
    Self(func)
  }

  /// Метод создания случайной задержки в заданном диапазоне
  pub fn random(min_delay: u64, max_delay: u64) -> Self {
    Self(Box::new(move |_current, _total| {
      let mut rng = rand::thread_rng();
      rng.gen_range(min_delay..=max_delay)
    }))
  }

  /// Метод создания промежуточной задержки (каждый бот не попадающий под условие
  /// `(current + 1) % group_size == 0` имеет задрежку `delay`, а бот, который попадает
  /// под это условие, имеет задержку `intermediate_delay`)
  pub fn intermediate(group_size: u64, delay: u64, intermediate_delay: u64) -> Self {
    Self(Box::new(move |current, _total| {
      // Тк используются индексы ботов (0 включительно) нужно добавлять по 1 к текущему индексу,
      // чтобы не было вылета первого бота из условий
      if (current + 1) % group_size == 0 { intermediate_delay } else { delay }
    }))
  }
}

#[cfg(test)]
mod tests {
  use std::io;
  use std::time::Duration;

  use crate::bot::Bot;
  use crate::swarm::{JoinDelay, Swarm};

  #[tokio::test]
  async fn test_fixed_delay() -> io::Result<()> {
    let mut swarm = Swarm::create_with_capacity(10).with_join_delay(JoinDelay::fixed(500)).bind("localhost", 25565);

    for i in 0..10 {
      swarm.add_bot(Bot::create(format!("nurtex_{}", i)));
    }

    swarm.launch().await;
    tokio::time::sleep(Duration::from_secs(2)).await;
    swarm.shutdown().await?;

    Ok(())
  }

  #[tokio::test]
  async fn test_progressive_linear_delay() -> io::Result<()> {
    let mut swarm = Swarm::create_with_capacity(10)
      .with_join_delay(JoinDelay::progressive_linear(500, 5000))
      .bind("localhost", 25565);

    for i in 0..10 {
      swarm.add_bot(Bot::create(format!("nurtex_{}", i)));
    }

    swarm.launch().await;
    tokio::time::sleep(Duration::from_secs(2)).await;
    swarm.shutdown().await?;

    Ok(())
  }

  #[tokio::test]
  async fn test_progressive_delay() -> io::Result<()> {
    let mut swarm = Swarm::create_with_capacity(10)
      .with_join_delay(JoinDelay::progressive(10, 3000, 5))
      .bind("localhost", 25565);

    for i in 0..10 {
      swarm.add_bot(Bot::create(format!("nurtex_{}", i)));
    }

    swarm.launch().await;
    tokio::time::sleep(Duration::from_secs(2)).await;
    swarm.shutdown().await?;

    Ok(())
  }

  #[tokio::test]
  async fn test_regressive_delay() -> io::Result<()> {
    let mut swarm = Swarm::create_with_capacity(10).with_join_delay(JoinDelay::regressive(5000, 10, 5)).bind("localhost", 25565);

    for i in 0..10 {
      swarm.add_bot(Bot::create(format!("nurtex_{}", i)));
    }

    swarm.launch().await;
    tokio::time::sleep(Duration::from_secs(2)).await;
    swarm.shutdown().await?;

    Ok(())
  }

  #[tokio::test]
  async fn test_regressive_linear_delay() -> io::Result<()> {
    let mut swarm = Swarm::create_with_capacity(10)
      .with_join_delay(JoinDelay::regressive_linear(5000, 500))
      .bind("localhost", 25565);

    for i in 0..10 {
      swarm.add_bot(Bot::create(format!("nurtex_{}", i)));
    }

    swarm.launch().await;
    tokio::time::sleep(Duration::from_secs(2)).await;
    swarm.shutdown().await?;

    Ok(())
  }

  #[tokio::test]
  async fn test_random_delay() -> io::Result<()> {
    let mut swarm = Swarm::create_with_capacity(10).with_join_delay(JoinDelay::random(100, 3000)).bind("localhost", 25565);

    for i in 0..10 {
      swarm.add_bot(Bot::create(format!("nurtex_{}", i)));
    }

    swarm.launch().await;
    tokio::time::sleep(Duration::from_secs(2)).await;
    swarm.shutdown().await?;

    Ok(())
  }

  #[tokio::test]
  async fn test_custom_delay() -> io::Result<()> {
    let join_delay_fn = |current, total| (500 + total) * current;

    let mut swarm = Swarm::create_with_capacity(10)
      .with_join_delay(JoinDelay::custom(Box::new(join_delay_fn)))
      .bind("localhost", 25565);

    for i in 0..10 {
      swarm.add_bot(Bot::create(format!("nurtex_{}", i)));
    }

    swarm.launch().await;
    tokio::time::sleep(Duration::from_secs(2)).await;
    swarm.shutdown().await?;

    Ok(())
  }

  #[tokio::test]
  async fn test_intermediate_delay() -> io::Result<()> {
    let mut swarm = Swarm::create_with_capacity(10)
      .with_join_delay(JoinDelay::intermediate(2, 100, 2000))
      .bind("localhost", 25565);

    for i in 0..10 {
      swarm.add_bot(Bot::create(format!("nurtex_{}", i)));
    }

    swarm.launch().await;
    tokio::time::sleep(Duration::from_secs(3)).await;
    swarm.shutdown().await?;

    Ok(())
  }
}