|
|
||
|---|---|---|
| .cargo | ||
| .vscode | ||
| assets | ||
| bevy_app | ||
| bevy_asset | ||
| bevy_core | ||
| bevy_derive | ||
| bevy_diagnostic | ||
| bevy_gltf | ||
| bevy_input | ||
| bevy_legion | ||
| bevy_render | ||
| bevy_serialization | ||
| bevy_transform | ||
| bevy_ui | ||
| bevy_wgpu | ||
| bevy_window | ||
| bevy_winit | ||
| docs | ||
| examples | ||
| src | ||
| tools | ||
| .gitignore | ||
| Cargo.toml | ||
| CREDITS.md | ||
| README.md | ||
| rustfmt.toml | ||
What is Bevy?
Bevy is an open-source modular game engine built in Rust, with a focus on developer productivity and performance.
WARNING
Bevy is still in the very early stages of development. APIs can and will change. Important features are missing. Documentation is non-existent. Please don't build any serious projects in Bevy unless you are prepared to be broken by api changes constantly.
Design Goals
- Provide a first class user-experience for both 2D and 3D games.
- Easy for newbies to pick up, but infinitely flexible for power users.
- Fast iterative compile times. Ideally less than 1 second for small to medium sized projects.
- Data-first game development using ECS (Entity Component System)
- Modular design: use only what you need ... replace what you don't like
- High performance and parallel architecture
- Use the latest and greatest rendering technologies and techniques
About
Docs
- The Bevy Book: Bevy's official documentation. The best place to start learning Bevy.
- Bevy Rust API Docs: Bevy's Rust API docs, which are automatically generated from the doc comments in this repo.
Getting Started
We recommend checking out The Bevy Book for a full tutorial. You can quickly try out the examples by cloning this repo and running the following command:
# Runs the "scene" example
cargo run --example scene
Nightly Compiler
Bevy requires nightly rust right now. It currently uses specialization features, which are unstable. If specialization goes stable soon then we can go back to a stable compiler. There is actually good forward progress happening here. In the meantime, we will try our best to remove specialization usage so we can go back to stable.
Libraries Used
Bevy is only possible because of the hard work put into these foundational technologies:
- wgpu-rs: modern / low-level / cross platform graphics library inspired by Vulkan
- legion: a feature rich high performance ECS library
- glam-rs: a simple and fast 3D math library for games and graphics
- winit: cross platform window creation and management in Rust
- legion_transform: A hierarchical space transform system, implemented using Legion ECS
- shaderc: compiles GLSL and HLSL shaders to SPIR-V binaries
- spirv-reflect: Reflection API in rust for SPIR-V shader byte code
Additionally, we would like to thank the Amethyst, coffee, ggez, and Piston projects for providing solid examples of game engine development in Rust. If you are looking for a Rust game engine, it is worth considering all of your options. Each engine has different design goals and some will likely resonate with you more than others.