Crate bevy

Expand description

Bevy is an open-source modular game engine built in Rust, with a focus on developer productivity and performance.

Check out the Bevy website for more information, read the Quick Start Guide for a step-by-step introduction, and engage with our community if you have any questions or ideas!

§Example

Here is a simple “Hello World” Bevy app:

use bevy::prelude::*;

fn main() {
   App::new()
       .add_systems(Update, hello_world_system)
       .run();
}

fn hello_world_system() {
   println!("hello world");
}

Don’t let the simplicity of the example above fool you. Bevy is a fully featured game engine and it gets more powerful every day!

§This Crate

The bevy crate is just a container crate that makes it easier to consume Bevy subcrates. 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.

If you prefer, you can also consume the individual bevy crates directly. Each module in the root of this crate, except for the prelude, can be found on crates.io with bevy_ appended to the front, e.g. app -> bevy_app.

§Cargo Features

Bevy exposes many features to customize the engine. Enabling them add functionalities but often come at the cost of longer compilation times and extra dependencies.

§Default Features

The default feature set enables most of the expected features of a game engine, like rendering in both 2D and 3D, asset loading, audio and UI. To help reduce compilation time, consider disabling default features and enabling only those you need.

feature name	description
android-game-activity	Android GameActivity support. Default, choose between this and `android-native-activity`.
android_shared_stdcxx	Enable using a shared stdlib for cxx on Android
animation	Enable animation support, and glTF animation loading
async_executor	Uses `async-executor` as a task execution backend.
bevy_animation	Provides animation functionality
bevy_anti_alias	Provides various anti aliasing solutions
bevy_asset	Provides asset functionality
bevy_audio	Provides audio functionality
bevy_camera	Provides camera and visibility types, as well as culling primitives.
bevy_color	Provides shared color types and operations
bevy_core_pipeline	Provides cameras and other basic render pipeline features
bevy_gilrs	Adds gamepad support
bevy_gizmos	Adds support for rendering gizmos
bevy_gltf	glTF support
bevy_image	Load and access image data. Usually added by an image format
bevy_input_focus	Enable input focus subsystem
bevy_light	Provides light types such as point lights, directional lights, spotlights.
bevy_log	Enable integration with `tracing` and `log`
bevy_mesh	Provides a mesh format and some primitive meshing routines.
bevy_mesh_picking_backend	Provides an implementation for picking meshes
bevy_pbr	Adds PBR rendering
bevy_picking	Provides picking functionality
bevy_post_process	Provides post process effects such as depth of field, bloom, chromatic aberration.
bevy_render	Provides rendering functionality
bevy_scene	Provides scene functionality
bevy_shader	Provides shaders usable through asset handles.
bevy_sprite	Provides sprite functionality
bevy_sprite_picking_backend	Provides an implementation for picking sprites
bevy_sprite_render	Provides sprite rendering functionality
bevy_state	Enable built in global state machines
bevy_text	Provides text functionality
bevy_ui	A custom ECS-driven UI framework
bevy_ui_picking_backend	Provides an implementation for picking UI
bevy_ui_render	Provides rendering functionality for bevy_ui
bevy_window	Windowing layer
bevy_winit	winit window and input backend
custom_cursor	Enable winit custom cursor support
debug	Enable collecting debug information about systems and components to help with diagnostics
default_font	Include a default font, containing only ASCII characters, at the cost of a 20kB binary size increase
hdr	HDR image format support
ktx2	KTX2 compressed texture support
multi_threaded	Enables multithreaded parallelism in the engine. Disabling it forces all engine tasks to run on a single thread.
png	PNG image format support
reflect_auto_register	Enable automatic reflect registration
smaa_luts	Include SMAA Look Up Tables KTX2 Files
std	Allows access to the `std` crate.
sysinfo_plugin	Enables system information diagnostic plugin
tonemapping_luts	Include tonemapping Look Up Tables KTX2 files. If everything is pink, you need to enable this feature or change the `Tonemapping` method for your `Camera2d` or `Camera3d`.
vorbis	OGG/VORBIS audio format support
wayland	Wayland display server support
webgl2	Enable some limitations to be able to use WebGL2. Please refer to the WebGL2 and WebGPU section of the examples README for more information on how to run Wasm builds with WebGPU.
x11	X11 display server support
zstd_rust	For KTX2 Zstandard decompression using pure rust ruzstd. This is the safe default. For maximum performance, use “zstd_c”.

§Optional Features

feature name	description
accesskit_unix	Enable AccessKit on Unix backends (currently only works with experimental screen readers and forks.)
android-native-activity	Android NativeActivity support. Legacy, should be avoided for most new Android games.
asset_processor	Enables the built-in asset processor for processed assets.
async-io	Use async-io’s implementation of block_on instead of futures-lite’s implementation. This is preferred if your application uses async-io.
basis-universal	Basis Universal compressed texture support
bevy_ci_testing	Enable systems that allow for automated testing on CI
bevy_debug_stepping	Enable stepping-based debugging of Bevy systems
bevy_dev_tools	Provides a collection of developer tools
bevy_remote	Enable the Bevy Remote Protocol
bevy_solari	Provides raytraced lighting (experimental)
bevy_ui_debug	Provides a debug overlay for bevy UI
bluenoise_texture	Include spatio-temporal blue noise KTX2 file used by generated environment maps, Solari and atmosphere
bmp	BMP image format support
compressed_image_saver	Enables compressed KTX2 UASTC texture output on the asset processor
critical-section	`critical-section` provides the building blocks for synchronization primitives on all platforms, including `no_std`.
dds	DDS compressed texture support
debug_glam_assert	Enable assertions in debug builds to check the validity of parameters passed to glam
default_no_std	Recommended defaults for no_std applications
detailed_trace	Enable detailed trace event logging. These trace events are expensive even when off, thus they require compile time opt-in
dlss	NVIDIA Deep Learning Super Sampling
dynamic_linking	Force dynamic linking, which improves iterative compile times
embedded_watcher	Enables watching in memory asset providers for Bevy Asset hot-reloading
experimental_bevy_feathers	Feathers widget collection.
experimental_bevy_ui_widgets	Experimental headless widget collection for Bevy UI.
experimental_pbr_pcss	Enable support for PCSS, at the risk of blowing past the global, per-shader sampler limit on older/lower-end GPUs
exr	EXR image format support
ff	Farbfeld image format support
file_watcher	Enables watching the filesystem for Bevy Asset hot-reloading
flac	FLAC audio format support
force_disable_dlss	Forcibly disable DLSS so that cargo build –all-features works without the DLSS SDK being installed. Not meant for users.
ghost_nodes	Experimental support for nodes that are ignored for UI layouting
gif	GIF image format support
glam_assert	Enable assertions to check the validity of parameters passed to glam
hotpatching	Enable hotpatching of Bevy systems
http	Enables downloading assets from HTTP sources. Warning: there are security implications. Read the docs on WebAssetPlugin.
https	Enables downloading assets from HTTPS sources. Warning: there are security implications. Read the docs on WebAssetPlugin.
ico	ICO image format support
jpeg	JPEG image format support
libm	Uses the `libm` maths library instead of the one provided in `std` and `core`.
meshlet	Enables the meshlet renderer for dense high-poly scenes (experimental)
meshlet_processor	Enables processing meshes into meshlet meshes for bevy_pbr
mp3	MP3 audio format support
pbr_anisotropy_texture	Enable support for anisotropy texture in the `StandardMaterial`, at the risk of blowing past the global, per-shader texture limit on older/lower-end GPUs
pbr_clustered_decals	Enable support for Clustered Decals
pbr_light_textures	Enable support for Light Textures
pbr_multi_layer_material_textures	Enable support for multi-layer material textures in the `StandardMaterial`, at the risk of blowing past the global, per-shader texture limit on older/lower-end GPUs
pbr_specular_textures	Enable support for specular textures in the `StandardMaterial`, at the risk of blowing past the global, per-shader texture limit on older/lower-end GPUs
pbr_transmission_textures	Enable support for transmission-related textures in the `StandardMaterial`, at the risk of blowing past the global, per-shader texture limit on older/lower-end GPUs
pnm	PNM image format support, includes pam, pbm, pgm and ppm
qoi	QOI image format support
raw_vulkan_init	Forces the wgpu instance to be initialized using the raw Vulkan HAL, enabling additional configuration
reflect_auto_register_static	Enable automatic reflect registration without inventory. See `reflect::load_type_registrations` for more info.
reflect_documentation	Enable documentation reflection
reflect_functions	Enable function reflection
serialize	Enable serialization support through serde
shader_format_glsl	Enable support for shaders in GLSL
shader_format_spirv	Enable support for shaders in SPIR-V
shader_format_wesl	Enable support for shaders in WESL
spirv_shader_passthrough	Enable passthrough loading for SPIR-V shaders (Only supported on Vulkan, shader capabilities and extensions must agree with the platform implementation)
statically-linked-dxc	Statically linked DXC shader compiler for DirectX 12
symphonia-aac	AAC audio format support (through symphonia)
symphonia-all	AAC, FLAC, MP3, MP4, OGG/VORBIS, and WAV audio formats support (through symphonia)
symphonia-flac	FLAC audio format support (through symphonia)
symphonia-isomp4	MP4 audio format support (through symphonia)
symphonia-vorbis	OGG/VORBIS audio format support (through symphonia)
symphonia-wav	WAV audio format support (through symphonia)
tga	TGA image format support
tiff	TIFF image format support
trace	Tracing support
trace_chrome	Tracing support, saving a file in Chrome Tracing format
trace_tracy	Tracing support, exposing a port for Tracy
trace_tracy_memory	Tracing support, with memory profiling, exposing a port for Tracy
track_location	Enables source location tracking for change detection and spawning/despawning, which can assist with debugging
wav	WAV audio format support
web	Enables use of browser APIs. Note this is currently only applicable on `wasm32` architectures.
web_asset_cache	Enable caching downloaded assets on the filesystem. NOTE: this cache currently never invalidates entries!
webgpu	Enable support for WebGPU in Wasm. When enabled, this feature will override the `webgl2` feature and you won’t be able to run Wasm builds with WebGL2, only with WebGPU.
webp	WebP image format support
zlib	For KTX2 supercompression
zstd_c	For KTX2 Zstandard decompression using zstd. This is a faster backend, but uses unsafe C bindings. For the safe option, stick to the default backend with “zstd_rust”.

Modules§

a11y: Reusable accessibility primitives
animation: Animation for the game engine Bevy
anti_alias
app: This crate is about everything concerning the highest-level, application layer of a Bevy app.
asset: In the context of game development, an “asset” is a piece of content that is loaded from disk and displayed in the game. Typically, these are authored by artists and designers (in contrast to code), are relatively large in size, and include everything from textures and models to sounds and music to levels and scripts.
audio: Audio support for the game engine Bevy
camera
color: Representations of colors in various color spaces.
core_pipeline
dev_tools: This crate provides additional utilities for the Bevy game engine, focused on improving developer experience.
diagnostic: This crate provides a straightforward solution for integrating diagnostics in the Bevy game engine. It allows users to easily add diagnostic functionality to their Bevy applications, enhancing their ability to monitor and optimize their game’s.
ecs: Bevy ECS
feathers: bevy_feathers is a collection of styled and themed widgets for building editors and inspectors.
gilrs: Systems and type definitions for gamepad handling in Bevy.
gizmos: This crate adds an immediate mode drawing api to Bevy for visual debugging.
gltf: Plugin providing an AssetLoader and type definitions for loading glTF 2.0 (a standard 3D scene definition format) files in Bevy.
image
input: Input functionality for the Bevy game engine.
input_focus: A UI-centric focus system for Bevy.
light
log: This crate provides logging functions and configuration for Bevy apps, and automatically configures platform specific log handlers (i.e. Wasm or Android).
math: Provides math types and functionality for the Bevy game engine.
mesh
pbr
picking: This crate provides ‘picking’ capabilities for the Bevy game engine, allowing pointers to interact with entities using hover, click, and drag events.
platform: Platform compatibility support for first-party Bevy engine crates.
post_process
prelude: use bevy::prelude::*; to import common components, bundles, and plugins.
reflect: Reflection in Rust.
remote: An implementation of the Bevy Remote Protocol, to allow for remote control of a Bevy app.
render: Useful Environment Variables
scene: Provides scene definition, instantiation and serialization/deserialization.
shader
solari: Provides raytraced lighting.
sprite: Provides 2D sprite functionality.
sprite_render: Provides 2D sprite rendering functionality.
state: In Bevy, states are app-wide interdependent, finite state machines that are generally used to model the large scale structure of your program: whether a game is paused, if the player is in combat, if assets are loaded and so on.
tasks: Bevy Tasks
text: This crate provides the tools for positioning and rendering text in Bevy.
time: Bevy Time
transform: Bevy Transform
ui: This crate contains Bevy’s UI system, which can be used to create UI for both 2D and 3D games
ui_render: Provides rendering functionality for bevy_ui.
ui_widgets: This crate provides a set of standard widgets for Bevy UI, such as buttons, checkboxes, and sliders. These widgets have no inherent styling, it’s the responsibility of the user to add styling appropriate for their game or application.
utils: General utilities for first-party Bevy engine crates.
window: bevy_window provides a platform-agnostic interface for windowing in Bevy.
winit: bevy_winit provides utilities to handle window creation and the eventloop through winit

Structs§

DefaultPlugins: This plugin group will add all the default plugins for a Bevy application:
MinimalPlugins: This plugin group will add the minimal plugins for a Bevy application:

Crate bevy

Crate bevy Copy item path

§Example

§This Crate

§Cargo Features

§Default Features

§Optional Features

Modules§

Structs§

Crate bevy