README

What is Bevy?

Bevy is a refreshingly simple data-driven game engine built in Rust. It is free and open-source forever!

 WARNING

Bevy is still in the early stages of development. Important features are missing. Documentation is sparse. A new version of Bevy containing breaking changes to the API is released approximately once every 3 months. We provide migration guides, but we can't guarantee migrations will always be easy. Use only if you are willing to work in this environment.

MSRV: Bevy relies heavily on improvements in the Rust language and compiler.
As a result, the Minimum Supported Rust Version (MSRV) is generally close to "the latest stable release" of Rust.

 Design Goals

 Capable: Offer a complete 2D and 3D feature set
 Simple: Easy for newbies to pick up, but infinitely flexible for power users
 Data Focused: Data-oriented architecture using the Entity Component System paradigm
 Modular: Use only what you need. Replace what you don't like
 Fast: App logic should run quickly, and when possible, in parallel
 Productive: Changes should compile quickly ... waiting isn't fun

 About

 Features: A quick overview of Bevy's features.
 News: A development blog that covers our progress, plans and shiny new features.

 Docs

 Quick Start Guide: Bevy's official Quick Start Guide. 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.
 Official Examples: Bevy's dedicated, runnable examples, which are great for digging into specific concepts.
 Community-Made Learning Resources: More tutorials, documentation, and examples made by the Bevy community.

 Community

Before contributing or participating in discussions with the community, you should familiarize yourself with our Code of Conduct.

 Discord: Bevy's official discord server.
 Reddit: Bevy's official subreddit.
 GitHub Discussions: The best place for questions about Bevy, answered right here!
 Bevy Assets: A collection of awesome Bevy projects, tools, plugins and learning materials.

 Contributing

If you'd like to help build Bevy, check out the Contributor's Guide.
For simple problems, feel free to open an issue or
PR and tackle it yourself!

For more complex architecture decisions and experimental mad science, please open a GitHub Discussion so we can brainstorm together effectively!

 Getting Started

We recommend checking out the Quick Start Guide for a brief introduction.

Follow the Setup guide to ensure your development environment is set up correctly.
Once set up, you can quickly try out the examples by cloning this repo and running the following commands:

sh
 Switch to the correct version (latest release, default is main development branch)
git checkout latest
 Runs the "breakout" example
cargo run --example breakout


To draw a window with standard functionality enabled, use:

rust
use bevy::prelude::;

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .run();
}

Top issues

Discussions

Latest release

A full diff of what's in this release can be seen here: https://github.com/bevyengine/bevy/compare/v0.20.0...v0.20.1