Skip to content
Snippets Groups Projects
Select Git revision
  • trunk default protected
  • v2
2 results
Compare History
Louis Capitanchik's avatar
Clarify wording in CC
Louis authored
e1d2dadf
Name Last commit Last update
.cargo
assets
build/web
game_core
.dockerignore
.gitattributes
.gitignore
.gitlab-ci.yml
CHANGELOG
Cargo.lock
Cargo.toml
LICENSE
Makefile
README.md
rust-toolchain.toml
rustfmt.toml
README.md

Bevy 2D Template

Includes

  • Workspace configuration w/ assets dir
  • Splash screen
  • Websockets
  • High level audio player
  • Basic component based follow-camera setup
  • Convenience loader for assets
  • Asset loading state to preload all assets
  • Gitlab CI template based on Bevy Builder

Usage

Write some code, ya dig?

This project is set up for a multi-crate bevy game, but will work equally well if just using a single crate for your game. game_core is the location of your entry point, assets are placed at the root of the workspace in the assets folder.

Update the splash screen by replacing assets/splash.png - it is scaled by default to fill the shortest screen side; you can include empty space in your splash image as a simple way of changing the padding. assets/splash_sting.mp3 will be played during the splash screen.

If you need to pre-process files to generate your assets, update the Makefile assets command so that Gitlab CI will package them properly.

Includes websocket based multiplayer building blocks, using micro_bevy_remote_events

Comes with a Gitlab CI configuration that will build releases for web, Windows and Linux. It will also publish a Gitlab pages site with the web version automatically.

Commands

This project uses a Makefile to define some commands to get things going.

To run the game locally on linux, get things set up by running make setup-x11 or make setup-wayland depending on your requirements.

make run will run the desktop version of the game, while make run-web will run the game in your web browser. The web version requires trunk to be installed (cargo install trunk).

Building the game for desktop will use a docker container to manage dependancies, but will mount your workspace to perform the build. make build-linux and make build-windows can be run on any platform with docker installed, perfect for cross-compilation without juggling dependencies. make build-web

License

This template (and the code it contains) uses the GPL-3.0 license. This is unlikely to be changed in future on a template-wide basis, but if you would like to discuss having this template licensed differently for a specific project, please email louis@microhacks.co.uk.

The logo found in assets/splash.png is licensed under the following license for use only within the context of this template. For clarity: Changing this splash screen asset is recommended, and a changed asset won't be subject to any licensing

Microhacks Logo by Microhacks Ltd is licensed under CC BY-NC-ND 4.0