fmc_protocol 0.1.3

The fmc protocol
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

use bevy::prelude::{Event, Resource};
use fmc_protocol_derive::{ClientBound, ServerBound};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

use crate::BlockId;

/// Sent by client to notify the server that it has processed all assets and is ready to be served.
#[derive(ServerBound, Serialize, Deserialize, Debug, Clone)]
pub struct ClientReady;

/// Initial server configuration needed for client setup.
#[derive(Resource, Event, ClientBound, Serialize, Deserialize, Debug, Clone)]
pub struct ServerConfig {
    /// Hash of the assets the server wants used.
    pub assets_hash: u64,
    /// Map from block name to id on the server.
    pub block_ids: HashMap<String, BlockId>,
    /// Map from model name to id on the server.
    pub model_ids: HashMap<String, u32>,
    /// Map from item name to id on the server.
    pub item_ids: HashMap<String, u32>,
    /// Maximum render distance allowed by server, measured in chunks.
    pub render_distance: u32,
}

/// Clients send this immediately on established connection to identify themselves.
#[derive(ServerBound, Serialize, Deserialize, Debug)]
pub struct ClientIdentification {
    /// The name the player wants to use.
    pub name: String,
}

/// Forceful disconnection by the server.
#[derive(ClientBound, Event, Serialize, Deserialize, Debug)]
pub struct Disconnect {
    /// Reason for the disconnect, optional
    pub message: String,
}

// TODO: This is meant to be temporary. As day/night is defined client-side, the server only sends
// the time of day (as angle of sun).
/// Sets the time of day.
#[derive(ClientBound, Event, Serialize, Deserialize, Debug, Clone)]
pub struct Time {
    /// Angle of the sun
    pub angle: f32,
}

/// A set of assets from the server
#[derive(ClientBound, Event, Serialize, Deserialize, Debug)]
pub struct AssetResponse {
    /// Assets stored as a tarball
    pub file: Vec<u8>,
}

/// Sent by clients if they don't have assets (or the wrong ones).
#[derive(ServerBound, Serialize, Deserialize, Debug, Clone, Copy)]
pub struct AssetRequest;