bevy/src/lib.rs

84 lines
2.7 KiB
Rust
Raw Normal View History

2020-04-07 00:56:17 +00:00
//! [![](https://bevyengine.org/assets/bevy_logo_docs.svg)](https://bevyengine.org)
//!
//! Bevy is an open-source modular game engine built in Rust, with a focus on developer productivity and performance.
//!
//! Check out the [Bevy website](https://bevyengine.org) for more information, read the
//! [Bevy Book](https://bevyengine.org/learn/book/introduction) for a step-by-step guide, and [engage with our
//! community](https://bevyengine.org/community/) if you have any questions or ideas!
2020-04-07 04:04:09 +00:00
//!
//! ## Example
//!Here is a simple "Hello World" Bevy app:
//! ```no_run
//!use bevy::prelude::*;
//!
//!fn main() {
//! App::build()
//! .add_default_plugins()
//! .add_system(hello_world_system.system())
//! .run();
//!}
//!
//!fn hello_world_system() {
//! println!("hello world");
//!}
//! ```
2020-04-07 04:04:09 +00:00
//! Don't let the simplicity of the example above fool you. Bevy is a [fully featured game engine](https://bevyengine.org/learn/book/introduction/features/)
//! and it gets more powerful every day!
//!
2020-04-07 04:04:09 +00:00
//! ### This Crate
2020-04-07 00:21:15 +00:00
//! The "bevy" crate is just a container crate that makes it easier to consume Bevy components.
//! The defaults provide a "full" engine experience, but you can easily enable / disable features
//! in your project's Cargo.toml to meet your specific needs. See Bevy's Cargo.toml for a full list of features available.
//!
2020-04-07 04:04:09 +00:00
//! If you prefer it, you can also consume the individual bevy crates directly.
2020-04-07 00:21:15 +00:00
2020-04-06 22:54:17 +00:00
#![feature(min_specialization)]
2020-05-01 05:30:51 +00:00
#![doc(
html_logo_url = "https://bevyengine.org/assets/icon.png",
html_favicon_url = "https://bevyengine.org/assets/icon.png"
)]
2020-04-07 00:21:15 +00:00
2020-04-19 19:13:04 +00:00
mod add_default_plugins;
2020-04-25 01:55:15 +00:00
pub mod prelude;
2019-11-13 03:36:02 +00:00
2020-04-19 19:13:04 +00:00
pub use add_default_plugins::*;
2020-04-06 21:20:53 +00:00
pub use bevy_app as app;
pub use glam as math;
pub use legion;
#[cfg(feature = "asset")]
2020-04-06 21:20:53 +00:00
pub use bevy_asset as asset;
#[cfg(feature = "type_registry")]
pub use bevy_type_registry as type_registry;
#[cfg(feature = "core")]
2020-04-06 03:19:02 +00:00
pub use bevy_core as core;
#[cfg(feature = "derive")]
pub use bevy_derive as derive;
#[cfg(feature = "diagnostic")]
2020-04-06 07:12:54 +00:00
pub use bevy_diagnostic as diagnostic;
#[cfg(feature = "gltf")]
pub use bevy_gltf as gltf;
#[cfg(feature = "input")]
2020-04-06 21:20:53 +00:00
pub use bevy_input as input;
#[cfg(feature = "pbr")]
pub use bevy_pbr as pbr;
#[cfg(feature = "property")]
pub use bevy_property as property;
#[cfg(feature = "render")]
2020-04-06 03:19:02 +00:00
pub use bevy_render as render;
2020-05-22 00:21:33 +00:00
#[cfg(feature = "scene")]
pub use bevy_scene as scene;
2020-05-14 01:05:18 +00:00
#[cfg(feature = "text")]
pub use bevy_text as text;
#[cfg(feature = "transform")]
2020-04-06 21:20:53 +00:00
pub use bevy_transform as transform;
#[cfg(feature = "ui")]
2020-04-06 21:20:53 +00:00
pub use bevy_ui as ui;
2020-05-14 01:05:18 +00:00
#[cfg(feature = "wgpu")]
pub use bevy_wgpu as wgpu;
#[cfg(feature = "window")]
2020-04-25 01:55:15 +00:00
pub use bevy_window as window;
#[cfg(feature = "winit")]
pub use bevy_winit as winit;