protocraft_framework
| Crates.io | protocraft_framework |
| lib.rs | protocraft_framework |
| version | 0.2.4 |
| created_at | 2026-01-02 14:19:05.992194+00 |
| updated_at | 2026-01-06 05:06:09.390759+00 |
| description | A framework for handling minecraft packets |
| homepage | |
| repository | https://github.com/kralverde/protocraft-framework |
| max_upload_size | |
| id | 2018614 |
| size | 430,361 |
(kralverde)
documentation
README
Protocraft Framework
This crate provides traits for receiving and sending Minecraft packets, synchronous and asynchronous defaults, strongly typed implementations of protocol handlers, and (in progress) representations of every release protocol version in java Minecraft.
Examples
See Examples for a basic synchronous and asynchronous server. This serves as a basic example-tutorial.
Features
By default, this crate only provides synchronous traits and a packet
handling logic and is both no_std and no_alloc.
To use pre-made protocols, use the feature vx_y_z where x is the
major version, y is the sub version, and z is the minor version.
For example:
features = ["v1_21_10"]
Version features remain no_std and no_alloc.
| Feature | Description | no_std |
no_alloc |
|---|---|---|---|
async |
Adds async traits. | true |
true |
std |
Implements Reader and Writer for std::io::Read and std::io::Write |
false |
false |
tokio-io |
Implements AsyncReader and AsyncWriter for tokio::io::Read and tokio::io::Write |
false |
false |
futures-io |
Implements AsyncReader and AsyncWriter for futures_io::AsyncRead and futures_io::AsyncWrite |
false |
false |
defaults |
Implements a default synchronous StreamProvider |
false |
false |
tokio-defaults |
Implements a default asynchronous StreamProvider using tokio |
false |
false |
futures-defaults |
Implements a default asynchronous StreamProvider using futures_io |
false |
false |
Minecraft Versions Not Yet Implemented
- 1.21.11+
- 1.16.0 - 1.16.2
- 1.15.0 - 1.15.1
- 1.14.0 - 1.14.3
- 1.13.0
- pre 1.7 - 1.7.1
The goal is to support all release versions.
Goals
- Allow only the use of valid packets depending on the protocol state and whether the packet is clientbound or serverbound.
- Handle errors and parse Minecraft packets to provide the user a window into the raw packet data.
- Provide sane defaults to handle compression and encryption.
- Support and detect different Minecraft versions.
- Provide seemless inter-version support. (A WIP; Protocol versions are currently distinct from one another)
Non-Goals
Packets since the Netty re-write are very complex; this library does not provide distinct fields or provide serialization for subfields of packets.
License
Licensed under either of
at your option.