basalt-mc-protocol 0.2.1

Minecraft packet definitions and version-aware packet registry
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

//! Login state packet definitions.
//!
//! Auto-generated by `cargo xt codegen` from minecraft-data.
//! Do not edit manually — changes will be overwritten.

use basalt_derive::{Decode, Encode, EncodedSize, packet};
use basalt_types::Decode as _;
use basalt_types::Uuid;

use crate::error::{Error, Result};

// -- Serverbound packets --

#[derive(Debug, Clone, Default, PartialEq)]
#[packet(id = 0x01)]
pub struct ServerboundLoginEncryptionBegin {
    #[field(length = "varint")]
    pub shared_secret: Vec<u8>,
    #[field(length = "varint")]
    pub verify_token: Vec<u8>,
}

#[derive(Debug, Clone, Default, PartialEq)]
#[packet(id = 0x03)]
pub struct ServerboundLoginLoginAcknowledged;

#[derive(Debug, Clone, Default, PartialEq)]
#[packet(id = 0x02)]
pub struct ServerboundLoginLoginPluginResponse {
    #[field(varint)]
    pub message_id: i32,
    #[field(optional)]
    pub data: Option<Vec<u8>>,
}

#[derive(Debug, Clone, Default, PartialEq)]
#[packet(id = 0x00)]
pub struct ServerboundLoginLoginStart {
    pub username: String,
    pub player_uuid: Uuid,
}

// -- Clientbound packets --

#[derive(Debug, Clone, Default, PartialEq)]
#[packet(id = 0x03)]
pub struct ClientboundLoginCompress {
    #[field(varint)]
    pub threshold: i32,
}

#[derive(Debug, Clone, Default, PartialEq)]
#[packet(id = 0x00)]
pub struct ClientboundLoginDisconnect {
    pub reason: String,
}

#[derive(Debug, Clone, Default, PartialEq)]
#[packet(id = 0x01)]
pub struct ClientboundLoginEncryptionBegin {
    pub server_id: String,
    #[field(length = "varint")]
    pub public_key: Vec<u8>,
    #[field(length = "varint")]
    pub verify_token: Vec<u8>,
    pub should_authenticate: bool,
}

#[derive(Debug, Clone, Default, PartialEq)]
#[packet(id = 0x04)]
pub struct ClientboundLoginLoginPluginRequest {
    #[field(varint)]
    pub message_id: i32,
    pub channel: String,
    #[field(rest)]
    pub data: Vec<u8>,
}

/// Inline data structure used by [`ClientboundLoginSuccess`].
#[derive(Debug, Clone, Default, PartialEq, Encode, Decode, EncodedSize)]
pub struct ClientboundLoginSuccessProperties {
    pub name: String,
    pub value: String,
    #[field(optional)]
    pub signature: Option<String>,
}

#[derive(Debug, Clone, Default, PartialEq)]
#[packet(id = 0x02)]
pub struct ClientboundLoginSuccess {
    pub uuid: Uuid,
    pub username: String,
    #[field(length = "varint")]
    pub properties: Vec<ClientboundLoginSuccessProperties>,
}

/// serverbound packets in the Login state.
#[derive(Debug, Clone, PartialEq)]
pub enum ServerboundLoginPacket {
    EncryptionBegin(ServerboundLoginEncryptionBegin),
    LoginAcknowledged(ServerboundLoginLoginAcknowledged),
    LoginPluginResponse(ServerboundLoginLoginPluginResponse),
    LoginStart(ServerboundLoginLoginStart),
}

impl ServerboundLoginPacket {
    /// Decodes a packet from its ID and payload.
    pub fn decode_by_id(id: i32, buf: &mut &[u8]) -> Result<Self> {
        match id {
            ServerboundLoginEncryptionBegin::PACKET_ID => Ok(Self::EncryptionBegin(
                ServerboundLoginEncryptionBegin::decode(buf)?,
            )),
            ServerboundLoginLoginAcknowledged::PACKET_ID => Ok(Self::LoginAcknowledged(
                ServerboundLoginLoginAcknowledged::decode(buf)?,
            )),
            ServerboundLoginLoginPluginResponse::PACKET_ID => Ok(Self::LoginPluginResponse(
                ServerboundLoginLoginPluginResponse::decode(buf)?,
            )),
            ServerboundLoginLoginStart::PACKET_ID => {
                Ok(Self::LoginStart(ServerboundLoginLoginStart::decode(buf)?))
            }
            _ => Err(Error::UnknownPacket { id, state: "login" }),
        }
    }
}

/// clientbound packets in the Login state.
#[derive(Debug, Clone, PartialEq)]
pub enum ClientboundLoginPacket {
    Compress(ClientboundLoginCompress),
    Disconnect(ClientboundLoginDisconnect),
    EncryptionBegin(ClientboundLoginEncryptionBegin),
    LoginPluginRequest(ClientboundLoginLoginPluginRequest),
    Success(ClientboundLoginSuccess),
}

impl ClientboundLoginPacket {
    /// Decodes a packet from its ID and payload.
    pub fn decode_by_id(id: i32, buf: &mut &[u8]) -> Result<Self> {
        match id {
            ClientboundLoginCompress::PACKET_ID => {
                Ok(Self::Compress(ClientboundLoginCompress::decode(buf)?))
            }
            ClientboundLoginDisconnect::PACKET_ID => {
                Ok(Self::Disconnect(ClientboundLoginDisconnect::decode(buf)?))
            }
            ClientboundLoginEncryptionBegin::PACKET_ID => Ok(Self::EncryptionBegin(
                ClientboundLoginEncryptionBegin::decode(buf)?,
            )),
            ClientboundLoginLoginPluginRequest::PACKET_ID => Ok(Self::LoginPluginRequest(
                ClientboundLoginLoginPluginRequest::decode(buf)?,
            )),
            ClientboundLoginSuccess::PACKET_ID => {
                Ok(Self::Success(ClientboundLoginSuccess::decode(buf)?))
            }
            _ => Err(Error::UnknownPacket { id, state: "login" }),
        }
    }
}