bevy/lib.rs
1#![allow(clippy::single_component_path_imports)]
2#![cfg_attr(docsrs, feature(doc_auto_cfg))]
3
4//! [](https://bevyengine.org)
5//!
6//! Bevy is an open-source modular game engine built in Rust, with a focus on developer productivity
7//! and performance.
8//!
9//! Check out the [Bevy website](https://bevyengine.org) for more information, read the
10//! [Quick Start Guide](https://bevyengine.org/learn/quick-start/introduction) for a step-by-step introduction, and [engage with our
11//! community](https://bevyengine.org/community/) if you have any questions or ideas!
12//!
13//! ## Example
14//!
15//! Here is a simple "Hello World" Bevy app:
16//! ```
17//! use bevy::prelude::*;
18//!
19//! fn main() {
20//! App::new()
21//! .add_systems(Update, hello_world_system)
22//! .run();
23//! }
24//!
25//! fn hello_world_system() {
26//! println!("hello world");
27//! }
28//! ```
29//!
30//! Don't let the simplicity of the example above fool you. Bevy is a [fully featured game engine](https://bevyengine.org)
31//! and it gets more powerful every day!
32//!
33//! ## This Crate
34//!
35//! The `bevy` crate is just a container crate that makes it easier to consume Bevy subcrates.
36//! The defaults provide a "full" engine experience, but you can easily enable / disable features
37//! in your project's `Cargo.toml` to meet your specific needs. See Bevy's `Cargo.toml` for a full
38//! list of features available.
39//!
40//! If you prefer, you can also consume the individual bevy crates directly.
41//! Each module in the root of this crate, except for the prelude, can be found on crates.io
42//! with `bevy_` appended to the front, e.g. `app` -> [`bevy_app`](https://docs.rs/bevy_app/*/bevy_app/).
43#![doc = include_str!("../docs/cargo_features.md")]
44#![doc(
45 html_logo_url = "https://bevyengine.org/assets/icon.png",
46 html_favicon_url = "https://bevyengine.org/assets/icon.png"
47)]
48
49pub use bevy_internal::*;
50
51// Wasm does not support dynamic linking.
52#[cfg(all(feature = "dynamic_linking", not(target_family = "wasm")))]
53#[allow(unused_imports)]
54use bevy_dylib;