No description
Find a file
Carter Anderson b12e3bf3bb
Improve usability of StateStage and cut down on "magic" (#1059)
Improve usability of StateStage and cut down on "magic"
2020-12-14 17:13:22 -08:00
.cargo Suggest -Zrun-dsymutil-no for macOS fast compiles (#552) 2020-09-24 18:52:32 -07:00
.github Fix ci (#1024) 2020-12-07 11:57:15 -08:00
assets Live reloading of shaders (#937) 2020-12-07 12:32:13 -08:00
benches update dependencies (#470) 2020-09-10 12:54:24 -07:00
crates Improve usability of StateStage and cut down on "magic" (#1059) 2020-12-14 17:13:22 -08:00
docs Grammar correction (#856) 2020-11-15 11:33:21 -08:00
examples Improve usability of StateStage and cut down on "magic" (#1059) 2020-12-14 17:13:22 -08:00
src Add bevy_dylib to force dynamic linking of bevy (#808) 2020-11-09 19:26:08 -08:00
tools Bevy Reflection (#926) 2020-11-27 16:39:59 -08:00
.gitignore add .cargo/config.toml to .gitignore 2020-12-12 17:17:35 -08:00
Cargo.toml Schedule v2 (#1021) 2020-12-12 18:04:42 -08:00
CHANGELOG.md Add support for Apple Silicon by upgrading winit. (#1043) 2020-12-13 11:27:54 -08:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2020-08-19 20:25:58 +01:00
CREDITS.md add HDR image loader 2020-07-27 11:37:45 +02:00
LICENSE add license 2020-04-24 13:16:04 -07:00
README.md Grammar correction (#856) 2020-11-15 11:33:21 -08:00
rustfmt.toml enforce cargo fmt --check 2020-08-16 05:02:06 -07:00

Bevy

Crates.io license Crates.io Rust iOS cron CI

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 very early stages of development. APIs can and will change (now is the time to make suggestions!). Important features are missing. Documentation is sparse. Please don't build any serious projects in Bevy unless you are prepared to be broken by API changes constantly.

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

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.

Community

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

Getting Started

We recommend checking out The Bevy Book for a full tutorial.

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

# Runs the "breakout" example
cargo run --example breakout

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.

Focus Areas

Bevy has the following Focus Areas. We are currently focusing our development efforts in these areas, and they will receive priority for Bevy developers' time. If you would like to contribute to Bevy, you are heavily encouraged to join in on these efforts:

Editor-Ready UI

PBR / Clustered Forward Rendering

Scenes

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
  • glam-rs: a simple and fast 3D math library for games and graphics
  • winit: cross-platform window creation and management in Rust
  • spirv-reflect: Reflection API in rust for SPIR-V shader byte code

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 and Alternatives

Additionally, we would like to thank the Amethyst, macroquad, coffee, ggez, rg3d, 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.