Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Bevy 2D Template
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Model registry
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Microhacks
Bevy 2D Template
Commits
2d81d034
Verified
Commit
2d81d034
authored
2 years ago
by
Louis
Browse files
Options
Downloads
Patches
Plain Diff
Update README.md
parent
8c234a3e
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
README
+0
-31
0 additions, 31 deletions
README
README.md
+43
-0
43 additions, 0 deletions
README.md
with
43 additions
and
31 deletions
README
deleted
100644 → 0
+
0
−
31
View file @
8c234a3e
# 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
This diff is collapsed.
Click to expand it.
README.md
0 → 100644
+
43
−
0
View file @
2d81d034
# 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.
`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
](
https://lab.lcr.gr/microhacks/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`
## Includes
-
Workspace configuration w/ assets dir
-
Splash screen
-
Websockets
-
High level audio player
\ No newline at end of file
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment