Foxtrot

The all-in-one Bevy 3D game template.

https://user-images.githubusercontent.com/9047632/226387411-70f662de-0681-47ff-b1d1-ccc59b02fa7b.mov

What does this template give you?

• A 3D character controller
• Physics via bevy_rapier
• Audio via bevy_kira_audio
• Pathfinding via oxidized_navigation
• bevy_editor_pls bound to 'G'
• Custom editor for the game state found in the windows selection for bevy_editor_pls.
• Saving / loading levels
• Saving / loading the game state
• Animations
• A custom dialog system
• Shaders
• GLTF imports, including auto-detection of colliders
• Dynamic builds when developing
• Grass blades using warbler_grass
• Smooth cameras via bevy_dolly
• A skydome that follows the camera
• Simple error handling via bevy_mod_sysfail
• Simple plugin creation via seldom_fn_plugin
• Particle effects via bevy_hanabi
• Clean and extensible object spawning via spew

Usage

Simply use the template button on GitHub to create a new repository from this template. Then, replace all instances of the word foxtrot with the name of your game. Change the game version as well as the author information in the following files:

• Cargo.toml
• build/windows/installer/Package.wxs
• build/macos/src/Game.app/Contents/Resources/Info.plist

Running the game

cargo run

Updating assets

You should keep the credits directory up to date. The release workflow automatically includes the directory in every build.

Updating the icons

1. Replace build/windows/icon.ico (used for windows executable and as favicon for the web-builds)
2. Replace build/macos/icon_1024x1024.png with a 1024 times 1024 pixel png icon and run create_icns.sh (make sure to run the script inside the macos directory) - Warning: sadly this seems to require a mac...

Help and Discussion

Feel free to shoot a message in the dedicated help thread on the Bevy Discord or open an issue on GitHub if you want to discuss something or need help :)