rust_mc_proto/README.md
MeexReay f794336e7d
All checks were successful
Rust / Check (push) Successful in 26m1s
Rust / Build (push) Successful in 20m16s
Rust / Test Suite (push) Successful in 21m1s
obyebalsa
2025-05-01 15:30:27 +03:00

44 lines
1.4 KiB
Markdown
Executable File

# rust_mc_proto
Lightweight minecraft packets protocol support in pure rust \
Has compression (`MinecraftConnection::set_compression`) \
This crate can be used for a server on rust idk -_-
## Setup
```toml
rust_mc_proto = "0.1.19" # stable version
rust_mc_proto = { git = "https://git.meex.lol/MeexReay/rust_mc_proto" } # unstable version
```
## How to use
Example of receiving motd:
```rust
use rust_mc_proto::{DataReader, DataWriter, MCConnTcp, Packet, ProtocolError};
fn main() -> Result<(), ProtocolError> {
let mut conn = MCConnTcp::connect("localhost:25565")?; // connecting
conn.write_packet(&Packet::build(0x00, |packet| {
packet.write_varint(765)?; // protocol_version
packet.write_string("localhost")?; // server_address
packet.write_unsigned_short(25565)?; // server_port
packet.write_varint(1) // next_state
})?)?; // handshake packet
conn.write_packet(&Packet::empty(0x00))?; // status request packet
Ok(println!("motd: {}", conn.read_packet()?.read_string()?)) // status response packet
}
```
[More examples](https://git.meex.lol/MeexReay/rust_mc_proto/src/branch/main/examples) \
[Documentation](https://docs.rs/rust_mc_proto/)
### Contributing
If you would like to contribute to the project, feel free to fork the repository and submit a pull request.
### License
This project is licensed under the WTFPL License