bevy README

The project's README from github.com/bevyengine/bevy. As one markdown file: README.md.

Bevy

License Crates.io Downloads Docs Discord

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

About

Docs

Community

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

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:

# 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:

use bevy::prelude::*;

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

Fast Compiles

Bevy can be built just fine using default configuration on stable Rust. However for really fast iterative compiles, you should enable the "fast compiles" setup by following the instructions here.

Bevy Cargo Features

This list outlines the different cargo features supported by Bevy. These allow you to customize the Bevy feature set for your use-case.

Thanks

Bevy is the result of the hard work of many people. A huge thanks to all Bevy contributors, the many open source projects that have come before us, the Rust gamedev ecosystem, and the many libraries we build on.

A huge thanks to Bevy's generous sponsors. Bevy will always be free and open source, but it isn't free to make. Please consider sponsoring our work if you like what we're building.

This project is tested with BrowserStack.

License

Bevy is free, open source and permissively licensed! Except where noted (below and/or in individual files), all code in this repository is dual-licensed under either:

at your option. This means you can select the license you prefer! This dual-licensing approach is the de-facto standard in the Rust ecosystem and there are very good reasons to include both.

Some of the engine's code carries additional copyright notices and license terms due to their external origins. These are generally BSD-like, but exact details vary by crate: If the README of a crate contains a 'License' header (or similar), the additional copyright notices and license terms applicable to that crate will be listed. The above licensing requirement still applies to contributions to those crates, and sections of those crates will carry those license terms. The license field of each crate will also reflect this.

The assets included in this repository (for our examples) typically fall under different open licenses. These will not be included in your game (unless copied in by you), and they are not distributed in the published bevy crates. See CREDITS.md for the details of the licenses of those files.

Your contributions

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

bevy (bevyengine/bevy)

gamedev
Searching Database…

49.1K ·GitHub
Bevy
What is this?Bevy is a free, open-source, data-driven game engine built in Rust that uses an Entity Component System (ECS) architecture to support both 2D and 3D game development.
Is Bevy a full game engine or just a rendering library?It's a full game engine aiming for a complete 2D and 3D feature set, built around a data-oriented Entity Component System rather than being just a renderer.
How do I get started with Bevy?Follow the official Quick Start Guide and Setup guide to prepare your environment, then clone the repo and run the bundled examples with Cargo, like opening a basic window.
Do I need a specific Rust version?Yes, since Bevy relies heavily on recent language and compiler improvements, its Minimum Supported Rust Version (MSRV) stays close to the latest stable Rust release.
Is Bevy stable enough to build a full game right now?Not entirely - Bevy is still early in development, important features are missing, docs are sparse, and breaking API changes land roughly every 3 months, with migration guides but no guarantee of an easy upgrade.
Can Bevy games run in a browser?Yes, Bevy compiles to WebAssembly for the web alongside native Windows, macOS and Linux builds, and the project is cross-tested with BrowserStack.
What is Bevy's ECS architecture and why does it matter?Bevy structures games around Entities, Components, and Systems instead of OOP inheritance, keeping app logic data-oriented so independent systems can run in parallel for better performance.
Does Bevy support both 2D and 3D games out of the box?Yes, offering a complete 2D and 3D feature set is one of Bevy's core design goals.
Can I speed up Bevy's compile times during development?Yes, Bevy offers an optional 'fast compiles' configuration you can enable on top of the default stable-Rust build for faster iterative compiling.
Where can I find community plugins and learning resources?Bevy Assets collects community plugins, tools and tutorials, and there's an official Discord, subreddit, and GitHub Discussions for support.
What are similar projects?bgfx, egui, benilla, raylib, aframe, libgdx, GDevelop, ebiten
Which topics is it in?game-engine, gamedev, game-development, graphics, wasm, 3d, developers, plugin, performance, rust, apache-2.0, web
Creator
bevyengine
Size
176.1 MB
Stars
49.1K
Updated
CommitOct 18Releasev0.20.0Oct 08
Age
6y
Commits · 90 Days