Don't Count The Sheep

A top down pixelart game created with Bevy.

Run $ ./dev/wiki to open the game's wiki locally in your browser.

Our primary color is #0d0e1f.

Dependencies

• Rust
• Bevy
• apt install lld clang for faster builds
• Graphviz

Repo organization

There are crates in the common directory that help with animation, input handling, loading screen, and more. These crates typically either export plugins or systems that one has to register themselves.

Then there's the main game lib. This crate exports logic that did not fit into the common crates. For example, the GlobalGameState enum that directs the game flow lives here, or map layout, npc and player control. It also sets up default plugins and alike.

Then we have the scenes. Scenes are main menu, top down view, minigames within the game etc. The game state transitions between scenes. The scenes will typically use the common crates or the main game lib for most work, only implementing specific logic for the scene.

We use some external dependencies. It's paramount that we keep the bevy related dependencies to a minimum with the current Bevy release schedule. With every extra dependency that also depends on Bevy it potentially takes longer to start upgrading.

• bevy_pixel_camera is used to scale the game to a pixel art resolution. This plugin seems to be no longer maintained and we will vendor it soon
• bevy_webp_anim is a crate we maintain so not a problem
• leafwing-input-manager is maintained by a core Bevy contributor
• bevy_kira_audio is used for audio. This decision was made based on some discord conversations that suggested it was better than the native Bevy audio plugin
• bevy_egui and bevy-inspector-egui are used for devtools

Dev environment

Some crates export devtools feature that enable additional debug and/or dev tooling functionality: $ cargo run --features devtools