No description
Find a file
2020-08-21 18:36:32 -07:00
.cargo -Clinker=lld was overwriting linker="lld-link.exe"; having both is unnecessary. 2020-08-12 16:44:22 -07:00
.github Merge pull request #206 from multun/clippy 2020-08-19 21:33:28 -07:00
assets add HDR image loader 2020-07-27 11:37:45 +02:00
crates upgrade to latest wgpu 2020-08-21 18:36:32 -07:00
docs add more tracing docs 2020-08-16 01:26:42 -07:00
examples Add repeating flag to Timer (#165) 2020-08-21 14:57:25 -07:00
src enforce cargo fmt --check 2020-08-16 05:02:06 -07:00
tools update publish script 2020-08-09 18:32:03 -07:00
.gitignore Ignore CLion/intellij project files 2020-08-11 20:41:37 -07:00
Cargo.toml Add serialize/deserialize to some input types (#281) 2020-08-21 18:13:50 -07: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 Add links to Stack Overflow and Awesome Bevy (#282) 2020-08-21 18:11:03 -07:00
rustfmt.toml enforce cargo fmt --check 2020-08-16 05:02:06 -07:00

Bevy

Crates.io license Crates.io

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 setup correctly. Once setup, 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

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