Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 2.08 KB

readme.md

File metadata and controls

55 lines (40 loc) · 2.08 KB

Foxtrot

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

Foxtrot in action

I created Foxtrot because I wanted to have a quick starting point for jams, prototypes and projects supporting features that I want to use in my games. Since the target audience is me, the code is not super well documented, but it should be good enough for others to find inspiration, copy parts they like or troubleshoot their own implementations :)

What does this template give you?

  • A 3D character controller
  • Physics via bevy_rapier
  • Audio via bevy_kira_audio
  • Pathfinding via bevy_pathmesh
  • bevy_editor_pls from the dev feature
  • Custom editor that can be opened with 'Q' from the dev feature
  • Saving / loading levels
  • Saving / loading the game state
  • Animations
  • A custom dialog system
  • Shaders
  • GLTF imports, including colliders and navmeshes
  • dynamic builds via the dynamic feature

Usage

Running the game

cargo run --features dev

Building requires setting up LLD or ZLD as described in the Bevy book. Don't worry, it's super easy:

  • Ubuntu: sudo apt-get install lld

  • Arch: sudo pacman -S lld

  • Windows: Ensure you have the latest cargo-binutils

    cargo install -f cargo-binutils
rustup component add llvm-tools-preview

  • MacOS: Modern LLD does not yet support MacOS, but we can use zld instead: brew install michaeleisel/zld/zld

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...