https://github.com/trubusoft/bevy-starter
Collection of useful docs to quickly start developing with bevy using RustRover
https://github.com/trubusoft/bevy-starter
bevy rust rustrover ubuntu
Last synced: about 2 months ago
JSON representation
Collection of useful docs to quickly start developing with bevy using RustRover
- Host: GitHub
- URL: https://github.com/trubusoft/bevy-starter
- Owner: trubusoft
- License: apache-2.0
- Created: 2024-06-25T01:50:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-23T07:23:33.000Z (about 1 year ago)
- Last Synced: 2025-06-21T01:38:37.383Z (about 1 year ago)
- Topics: bevy, rust, rustrover, ubuntu
- Language: Rust
- Homepage:
- Size: 55.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
Template to quickly start developing with bevy.
Highly inspired from [bevy_new_2d](https://github.com/TheBevyFlock/bevy_new_2d)
and [nolantait/bevy-starter](https://github.com/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](https://bevyengine.org/learn/quick-start/getting-started/setup/#windows)
### 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](https://taintedcoders.com/)
- [Bevy opinionated best practices](https://github.com/tbillington/bevy_best_practices)