rkon 0.1.0

Yet another RCON library.
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

# rkon

Yet another RCON library.

## Features

* No dependencies except for `std`.
* Exposes the internal Packet structure, useful for writing a server.

## Client

An example client is available under [examples/client.rs](examples/client.rs) which uses the `Client` type.

## Server

Since an RCON server would be tightly integrated with the game server, it doesn't make sense to provide a generic solution. Instead, you can use this crate to encode packets:

```rust
// read from client
let mut resp_bytes = [0u8; MAX_PACKET_SIZE];
stream.read(&mut resp_bytes).unwrap();

// decode
let request = Packet::decode(&resp_bytes);

// send response
let response = Packet {
    request_id: request.request_id,
    PacketType::Command,
    body: "foobar"
};
let encoded = response.encode();

// send to the client
stream.write_all(&encoded).unwrap();
```

## Credits

Thanks to the [minecraft-client-rs](https://github.com/willroberts/minecraft-client-rs) project where some of this code is based off of. I took a different approach for the API, and plan on expanding support beyond just Minecraft.

## License

![GPLv3](https://www.gnu.org/graphics/gplv3-127x51.png)

This project is licensed under the GNU General Public License 3.