Cargo Features
[dependencies]
lightyear = { version = "0.20.0-rc.2", default-features = false, features = ["std", "trace", "metrics", "visualizer", "mock_time", "webtransport", "leafwing", "avian2d", "avian3d", "udp", "websocket", "steam", "track_location", "lz4", "zstd", "bevy_egui", "futures-lite"] }- default = std
-
The
stdfeature is set by default wheneverlightyearis added withoutdefault-features = false - std default steam? udp? websocket? webtransport?
-
Enables async_executor and std of bevy and std of chacha20poly1305
netcode
bincode:
serialization
and std of no_std_io2 and serde
no_std_io2:
no_std
TODO: only enable in no_std - trace
-
Affects
channel::stats… - metrics visualizer?
-
Enables metrics, metrics-exporter-prometheus, metrics-tracing-context, and metrics-util
- visualizer = metrics
-
Enables bevy_metrics_dashboard ^0.4
- mock_time
-
Enables mock_instant
- webtransport = std
-
Enables wasm-bindgen-futures, web-sys, wtransport, xwt-core, and xwt-web
- leafwing
-
Enables leafwing-input-manager
input
Affects
input::leafwing,inputs::leafwing,input::leafwing,input::leafwing… - avian2d
-
NOTE: because lightyear doesn't enable any features of avian by default, your crate must enable essential features (like f32 or f64).
Enables avian2d =0.2.0
physics
Affects
utils::avian2d… - avian3d
-
Enables 3d of avian3d =0.2.0
Affects
utils::avian3d… - udp = std
- websocket = std
-
Enables futures-util, tokio-tungstenite ^0.23.0, wasm-bindgen, wasm-bindgen-futures, and web-sys
futures-util:
WebSocket
- steam = std
-
Enables steamworks
Affects
connection::steam… - track_location
-
Enables track_location of bevy
bevy:
Enables source location tracking for change detection and spawning/despawning, which can assist with debugging
- lz4
-
compression
Enables lz4_flex
- zstd
-
Enables zstd
Features from optional dependencies
- bevy_egui implicit feature
-
Enables bevy_egui ^0.32
debug ui
- futures-lite wasm implicit feature
-
Enables futures-lite
futures-lite:
Futures, streams, and async I/O combinators