NOTE: No longer maintained
This repository has been archived in favor of bevy_game_template. Go use that.
Bevy Template
An opinionated Bevy project template with a configuration script to run for the more complex parts (like setting up the fast-compile setup).
Quick Start
- Click on Use this template and choose your new project name
- Clone your new repository to your development location (local laptop, etc.)
- Run
./setup
(macOS, Linux) to complete the setup
Features:
- Template-based. - No Git history comes along for the ride. You can create private repositories directly from the template.
- Git configured -
.gitignore
is already set up for you. - Setup script - Run the
setup
script to configure/install things like optional linkers, nightly compiler, etc. Configuration choices include:- Set the package name
- Update to the latest version of Bevy
- Set up the fast-compile config file
- Install
zld
on macOS (we need Windows and Linux volunteers to help bring this sort of feature to their platforms!) - Install the nightly compiler
- Configure the project to use the nightly compiler
- Replace the
README.md
file - Delete the
license
directory
- Not license-restricted - The included license is for the template itself. Projects starting with this template may use any license (or no license at all).
💖 Help Needed!
We need help from Linux and Windows users! Please submit pull requests or open issues! For example:
- The
setup
script ought to mostly work on Linux, but it needs to be tested setup
needs code to install LLD on various Linux Distros- The
setup
script doesn't support Windows at all, yet! We need to figure out a way to do the equivalent stuff for Windows users.
Changelog
Software License
Distributed under the terms of both the MIT license and the Apache License (Version 2.0).
See license/APACHE and license/MIT.