Template to quickly start developing with bevy. Highly inspired from bevy_new_2d and nolantait/bevy-starter.

Preparation

Install dependencies

Ubuntu

sudo apt update
sudo apt install g++ pkg-config libx11-dev libasound2-dev libudev-dev libxkbcommon-x11-0

Windows

Follow the windows setup

Editor setup

We assume that RustRover is being used.

External Linter

Use Clippy and optionally make it to run on the fly.

Formatting

Use Rustfmt instead of the built-in formatter.

Configure action on save:

• Check Reformat Code
• Do not check the Optimize Import, as sometiems it conflicts with Rustfmt formatting. Instead, run the Optimize Import on case-by-case basis when import optimization is needed (e.g. plenty of unused import after refactoring)

Run Configurations

Optionally create several convenient Shell configurations, like:

• cargo run

  cargo run --features bevy/dynamic_linking --color=always
  

• cargo test

  cargo test --features bevy/dynamic_linking --color=always
  

• cargo build for release

  cargo build --release --no-default-features --color=always
  

• cargo fmt

  cargo fmt --all --check
  

• cargo clippy

  cargo clippy --all
  

Docs and References

• Tainted Coders
• Bevy opinionated best practices