Skip to content
Snippets Groups Projects
README 963 B
Newer Older
Louis's avatar
Louis committed
# Bevy 2D Template

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

## Commands

- Linux:
  - Run `make x11-setup` or `make wayland-setup` depending on the target platform
  - Run `make run` to play
  - Run `make check` to run Cargo Check

- Web:
  - Run `make cargo-deps` to install wasm tools
  - Run `make run-web` to launch the dev server
  - Run `make check` to run Cargo Check
  - Run `make web` to build the release version of the web project

## Includes

- Workspace configuration w/ assets dir
- Splash screen