lightyear 0.26.4

Server-client networking library for the Bevy game engine with modular architecture
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

//! Module to verify that the protocols of the client and server match

use bevy_app::{App, Plugin};
use bevy_ecs::error::{BevyError, Result};
use bevy_ecs::prelude::*;
use core::time::Duration;
use lightyear_connection::client::Connected;
use lightyear_connection::client_of::ClientOf;
use lightyear_connection::direction::NetworkDirection;
use lightyear_connection::host::HostClient;
use lightyear_messages::prelude::{AppTriggerExt, EventSender, RemoteEvent};
use lightyear_messages::registry::MessageRegistry;
use lightyear_replication::message::MetadataChannel;
use lightyear_replication::registry::registry::ComponentRegistry;
use lightyear_transport::prelude::{
    AppChannelExt, ChannelMode, ChannelRegistry, ChannelSettings, ReliableSettings,
};
use serde::{Deserialize, Serialize};
use tracing::trace;

#[derive(Serialize, Deserialize, Debug, PartialEq, Default, Clone, Copy, Event)]
pub struct ProtocolCheck {
    messages: Option<u64>,
    components: Option<u64>,
    channels: Option<u64>,
}

pub struct ProtocolCheckPlugin;

#[derive(thiserror::Error, Debug)]
pub enum ProtocolCheckError {
    #[error("the message protocol doesn't match")]
    Message,
    #[error("the component protocol doesn't match")]
    Component,
    #[error("the channel protocol doesn't match")]
    Channel,
}

impl ProtocolCheckPlugin {
    /// On the server, send a message with the protocol checksum when a client connects
    fn send_verify_protocol(
        trigger: On<Add, Connected>,
        mut sender: Query<&mut EventSender<ProtocolCheck>, (With<ClientOf>, Without<HostClient>)>,
        messages: Option<ResMut<MessageRegistry>>,
        components: Option<ResMut<ComponentRegistry>>,
        channels: Option<ResMut<ChannelRegistry>>,
    ) {
        let check_message = ProtocolCheck {
            messages: messages.map(|mut m| m.finish()),
            components: components.map(|mut c| c.finish()),
            channels: channels.map(|mut c| c.finish()),
        };
        if let Ok(mut s) = sender.get_mut(trigger.entity) {
            s.trigger::<MetadataChannel>(check_message);
        }
    }

    fn receive_verify_protocol(
        trigger: On<RemoteEvent<ProtocolCheck>>,
        messages: Option<ResMut<MessageRegistry>>,
        components: Option<ResMut<ComponentRegistry>>,
        channels: Option<ResMut<ChannelRegistry>>,
    ) -> Result {
        let message = trigger.trigger;
        trace!("Received protocol check from server: {message:?}");
        if message.messages != messages.map(|mut m| m.finish()) {
            return Err(BevyError::from(ProtocolCheckError::Message));
        }
        if message.components != components.map(|mut c| c.finish()) {
            return Err(BevyError::from(ProtocolCheckError::Component));
        }
        if message.channels != channels.map(|mut c| c.finish()) {
            return Err(BevyError::from(ProtocolCheckError::Channel));
        }
        Ok(())
    }
}

impl Plugin for ProtocolCheckPlugin {
    fn build(&self, app: &mut App) {
        // TODO: add these observers only on the server/client
        // app.add_observer(Self::send_verify_protocol);
        // app.add_observer(Self::receive_verify_protocol);

        // try to re-add the Channel in case Replication is not enabled
        app.add_channel::<MetadataChannel>(ChannelSettings {
            mode: ChannelMode::UnorderedReliable(ReliableSettings::default()),
            send_frequency: Duration::default(),
            priority: 10.0,
        })
        .add_direction(NetworkDirection::Bidirectional);

        app.register_event::<ProtocolCheck>()
            .add_direction(NetworkDirection::ServerToClient);
    }

    fn finish(&self, app: &mut App) {
        app.add_observer(Self::send_verify_protocol);
        app.add_observer(Self::receive_verify_protocol);
    }

    // fn finish(&self, app: &mut App) {
    //     // try to re-add the Channel in case Replication is not enabled
    //     app.add_channel::<MetadataChannel>(ChannelSettings {
    //         mode: ChannelMode::UnorderedReliable(ReliableSettings::default()),
    //         send_frequency: Duration::default(),
    //         priority: 10.0,
    //     })
    //     .add_direction(NetworkDirection::Bidirectional);
    //
    //     app.add_trigger::<ProtocolCheck>()
    //         .add_direction(NetworkDirection::ServerToClient);
    // }
}