nurtex 0.1.0

Lightweight library for creating Minecraft bots. Asynchronous, optimized, ease of coding.
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

# NurtexMC


**NurtexMC** is a library written in Rust that allows you to create Minecraft bots and manage them, including connection and packet processing. This library focuses on an asynchronous environment, maximum speed and optimization, and ease of coding.

Supported Minecraft version: `1.21.11` (or protocol version - `774`).

# Usage


To use this library in your code, add a dependency to the Cargo.toml:

```
nurtex = { git = "https://github.com/nullclyze/NurtexMC" }
```

# Examples


## Creating a bot


```rust
use std::io;

use nurtex::core::bot::Bot;
use nurtex::utils::sleep;

#[tokio::main]

async fn main() -> io::Result<()> {
  // Creating a bot and its terminal.
  let (mut bot, terminal) = Bot::new("NurtexBot");

  // Spawn an asynchronous task.
  tokio::spawn(async move {
    sleep(3000).await; // Wait for the bot to connect.

    // Send a message to the chat.
    terminal.chat("Hello, world!").await; 

    sleep(5000).await; // Wait a little.

    // Disconnect bot.
    terminal.disconnect().await; 
  });

  // Connecting bot to the server.
  bot.connect_to("localhost", 25565).await?;

  Ok(())
}
```

## Creating a swarm


```rust
use std::io;

use nurtex::{create_shared_swarm, launch_shared_swarm};
use nurtex::core::bot::BotCommand;
use nurtex::core::swarm::SwarmObject;
use nurtex::utils::sleep;

#[tokio::main]

async fn main() -> io::Result<()> {
  // Creating swarm objects.
  let mut objects = Vec::new();

  for i in 0..4 {
    let object = SwarmObject::new(format!("bot_{}", i));
    objects.push(object);
  }

  // Creating a shared-swarm of bots.
  let swarm = create_shared_swarm(objects);

  // Starting the swarm without blocking the thread.
  launch_shared_swarm(swarm.clone(), "localhost".to_string(), 25565, 500);

  sleep(4000).await; // Waiting for all the bots to connect.

  // Send a message to the chat from all bots.
  swarm.read().await.send(BotCommand::Chat("Hello, world!".to_string())).await; 

  sleep(5000).await; // Wait a little.

  // Clear and destroy swarm.
  swarm.write().await.destroy().await; 

  Ok(())
}
```