readme.md

Foxtrot

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

foxtrot-480p.mov

What does this template give you?

• Integration with Blender as an editor via the Blender_bevy_components_workflow set of tools
• Physics via bevy_xpbd
  • A 3D character controller via bevy-tnua
• Audio via bevy_kira_audio
• Pathfinding via oxidized_navigation
• bevy_editor_pls bound to 'Q'
  • Custom editor found in the windows selection for bevy_editor_pls.
• Animations
• Dialogs via Yarn Spinner for Rust
• Shaders, using the code from DGriffin's tutorial
• Smooth cameras via bevy_dolly
• Particle effects via bevy_hanabi
• Procedural skies via bevy_atmosphere
• Grass via warbler_grass

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

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 :)