Crate lightyear_examples_common

Common harness for Lightyear examples

This module contains utilities to build a Bevy app with Lightyear plugins.

It supports 4 different modes that can be selected using a CLI:

• Server: a single bevy App and a ServerConfig to run a dedicated server Run with cargo run -- server
• Client: a single bevy App and a ClientConfig to run a client Run with cargo run -- client -c 1
• HostServer: a single bevy App that contains both the [ClientPlugins] and [ServerPlugins]. This is when you want a server to act as client as well (one of the clients is ‘hosting’ the game) Run with cargo run -- host-server -c 1
• ClientAndServer: two bevy Apps that run in separate threads. One is a client, the other is a server. They will communicate via channels. This is useful for quickly testing, since you can run both the client and server with one command. Run with cargo run -- client-and-server -c 1

There is a lot of setup code, but it’s mostly to have the examples work in all possible configurations of transport. The server supports running multiple transports at the same time (WebTransport, WebSockets, UDP, channels, Steam). The client can connect to the server using any of these transports.

use bevy::prelude::{App, Plugin};
use lightyear_examples_common::app::{Cli, Apps};
use lightyear_examples_common::settings::Settings;

struct ExampleClientPlugin;
struct ExampleServerPlugin;
#[derive(Clone)]
struct SharedPlugin;



fn main() {
    let cli = Cli::default();
    let settings_str = include_str!("../assets/settings.ron");
    let settings = common::settings::read_settings::<Settings>(settings_str);
    // build the bevy app (this adds common plugin such as the DefaultPlugins)
    Apps::new(settings, cli)
      // add the `ClientPlugins` and `ServerPlugins` plugin groups
      .add_lightyear_plugins()
      // update the lightyear `ClientConfig` if necessary
      .update_lightyear_client_config(|config| {})
      // add our plugins
      .add_user_plugins(ExampleClientPlugin, ExampleServerPlugin, SharedPlugin)
      // run the app
      .run();
}

Reading settings

The settings are read from the settings module, which contains the Settings struct.

The user is expected to provide a Settings struct, which can be done by manually creating the struct, or by reading the settings from a file and deserializing into the struct. The lightyear examples use the latter and read the settings from a RON file.

Modules

app

Utilities for building the Bevy app

client_renderer

server_renderer

settings

This module introduces a settings struct that can be used to configure the server and client.

shared