lightyear_steam 0.23.0

Connection handling for the lightyear networking library
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

//! # Lightyear Steam
//!
//! This crate provides an integration layer for using Steam's networking sockets
//! (specifically `steamworks::networking_sockets`) as a transport for Lightyear.
//!
//! It handles the setup of Steam P2P connections and wraps them in a way that
//! can be used by Lightyear's `Link` component. This allows Lightyear to send
//! and receive messages over the Steam network infrastructure.
//!
//! Note: This crate requires the `steamworks` crate and a running Steam client.
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
#![no_std]

extern crate alloc;
#[cfg(feature = "std")]
extern crate std;

use bevy_app::PreUpdate;
use bevy_ecs::prelude::NonSend;

#[cfg(feature = "client")]
pub mod client;
#[cfg(all(feature = "server", not(target_family = "wasm")))]
pub mod server;

#[derive(thiserror::Error, Debug)]
pub enum SteamError {}

pub mod prelude {
    pub use crate::SteamAppExt;
    pub use crate::SteamError;
    pub use aeronet_steam::SessionConfig;
    pub use aeronet_steam::SteamworksClient;
    pub use aeronet_steam::steamworks;
    pub use aeronet_steam::steamworks::SteamId;

    #[cfg(feature = "client")]
    pub mod client {
        pub use crate::client::{SteamClientIo, SteamClientPlugin};
        pub use aeronet_steam::client::ConnectTarget;
    }

    #[cfg(all(feature = "server", not(target_family = "wasm")))]
    pub mod server {
        pub use crate::server::{SteamServerIo, SteamServerPlugin};
        pub use aeronet_steam::server::ListenTarget;
    }
}

pub trait SteamAppExt {
    /// Creates a steamworks::Client with the given app_id and adds it to the Bevy app.
    /// Then insert it as a resource as expected by `aeronet_steam`.
    ///
    /// The steam resources need to be inserted before the lightyear plugins
    fn add_steam_resources(&mut self, app_id: u32) -> &mut Self;
}

impl SteamAppExt for bevy_app::App {
    fn add_steam_resources(&mut self, app_id: u32) -> &mut Self {
        let (steam, steam_single) =
            prelude::steamworks::Client::init_app(app_id).expect("failed to initialize steam");
        steam.networking_utils().init_relay_network_access();

        self.insert_resource(prelude::SteamworksClient(steam))
            .insert_non_send_resource(steam_single)
            .add_systems(
                PreUpdate,
                |steam: NonSend<prelude::steamworks::SingleClient>| {
                    steam.run_callbacks();
                },
            );
        self
    }
}