Lib.rs

Cargo Features

[dependencies]
lightyear_examples_common = { version = "0.19.0", default-features = false, features = ["steam", "websocket", "server", "client", "bevygap_client", "bevygap_server", "visualizer", "gui", "bevy_metrics_dashboard", "bevy_egui"] }

default = client, gui, server, steam, websocket

These default features are set whenever lightyear_examples_common is added without default-features = false somewhere in the dependency tree.

steam default

Enables steam of lightyear

websocket default

Enables websocket of lightyear

server default bevygap_server?

Affects app::server_app, settings::build_server_netcode_config, settings::get_server_net_configs, settings::parse_private_key_from_env, app::combined_app, lightyear_examples_common::server_renderer…

client default bevygap_client? = gui

Affects app::client_app, app::combined_app, lightyear_examples_common::client_renderer…

bevygap_client = client

Enables bevygap_client_plugin

Affects lightyear_examples_common::bevygap_shared…

bevygap_server = server

Enables bevygap_server_plugin

Affects lightyear_examples_common::bevygap_shared…

visualizer = gui

Enables visualizer of lightyear

gui default client visualizer?

this serves as a bit of "workspace-hack" crate by enabling all bevy features needed by examples. you can read about workspace-hack crates here: https://docs.rs/cargo-hakari/latest/cargo_hakari/about/index.html even though we're not using cargo-hakari.

Enables bevy-inspector-egui, bevy_core_pipeline, bevy_gizmos, bevy_pbr, bevy_picking, bevy_render, bevy_scene, bevy_sprite, bevy_text, bevy_ui, bevy_window, bevy_winit, default_font, hdr, png, smaa_luts, tonemapping_luts, webgl2 and x11 of bevy

Affects app::window_plugin, app::new_gui_app, lightyear_examples_common::client_renderer, lightyear_examples_common::server_renderer…

Features from optional dependencies

bevy_metrics_dashboard implicit feature

Enables bevy_metrics_dashboard

bevy_metrics_dashboard:

Metrics dashboard for Bevy apps

bevy_egui implicit feature

Enables bevy_egui

bevy_egui:

A plugin for Egui integration into Bevy