minechat_protocol/lib.rs
1//! # MineChat Protocol
2//!
3//! This library implements my own MineChat protocol, which is designed to enable you to chat with a Minecraft server
4//! from external clients, without going through the hassle of using platforms like Discord.
5//! It provides asynchronous functions to send and receive messages, handle authentication, and
6//! manage connections, although a synchronous API is going to be developed soon if you feel like
7//! using one.
8//!
9//! ## Features
10//!
11//! - Asynchronous message sending and receiving via generic readers/writers.
12//! - UUID generation for client identification for a more unique identification for your client.
13//! - Right now there is just an async API to use packets, with `tokio`.
14//! - This crate uses the `log` crate for logging for debugging and monitoring, so you can log what
15//! happens in your application.
16//!
17//! ## Modules
18//!
19//! - `protocol`: Defines the message types and payload structures used in the MineChat protocol.
20//! - `packets`: Contains functions for sending and receiving messages, as well as handling server linking.
21
22#[allow(dead_code)]
23pub mod packets;
24pub mod protocol;