GitHub - eerii/hello-bevy: template for bevy games ðŸĶ€ (original) (raw)

an opinionated bevy template for my projects.

migration to bevy 0.15 and partial rewrite in progress. not everything is functional. use the previous branch instead

features ðŸŒŋ

how to use it âœĻ

runing locally 🌚

to run a debug build use cargo:

you can also play around with some of the included examples with cargo run --example <name>. and if you want to get started quickly, copy any example to src/main.rs!

if you have nix installed, running nix develop you get a shell with all the dependencies already installed.

release ðŸŒŧ

in order to create a release build with binaries for all platforms you have two options: either you trigger it manually on the actions page or you add a tag like '[anything]0.1' with the version you want.

git tag -a "0.1" -m "test release" git push --tags

if you want to also deploy this build to itch, go to the repository settings > secrets > actions and add:

ITCH_API_KEY = [your api key]

to run a release build locally:

cargo run --release --no-default-features --features release

profiling 📈

bevy has built in support for the tracy profiler. you can profile your game easily:

tracy-capture -o capture.tracy & cargo run --release --no-default-features --features trace

and then view the result with:

other projects 💖

this is heavily based on TheBevyFlock/bevy_quickstart and NiklasEi/bevy_game_template. please use these more general templates that are robust and have community support. hello bevy is hardly tested and very tailored to my preferences.

plugins ðŸŠī

this template intends to use as little external dependencies as possible to facilitate version updates and avoid bloat. that said, there are a few awesome community plugins that make everything as easy as possible.

license 📝

this project is dual licensed under MIT and Apache 2.0, do what you want with it!

the files under assets may come from other sources and have different licenses: