Pyri New Jam

This template is optimized for game jams, with 3rd-party dependencies and some more opinionated patterns.

You can try this template in your browser!

Comparison to Bevy New 2D

This template builds on top of Bevy New 2D with a few additions:

Features

• Hot-reloaded config files
• Screen transition animations (fade in / out)
• Fancy buttons (drop shadow, hover offset)
• Press P or Escape to pause
• Restart game from pause menu
• Basic rich text parsing
• Dynamic font size

3rd-party crates

• avian2d for 2D physics
• bevy_asset_loader for asset loading ergonomics
• bevy_common_assets for loading .ron assets
• bevy_editor_pls for a live inspector window
• bevy_mod_debugdump for inspecting the system graph
• bevy_simple_prefs for remembering settings
• iyes_progress for loading bar progress tracking
• leafwing-input-manager for input-to-action mapping
• pyri_state for more flexible game states
• pyri_tooltip for tooltips
• tiny_bail for error handling ergonomics

Assets

• pypx pixel fonts
• Different click and hover sound effects
• Different music for title and gameplay screens

Getting started

Use Bevy CLI to create a new game:

bevy new game -t benfrankel/pyri_new_jam
cd game
git commit -am 'Initial commit'

Next, create a new GitHub repository and upload your game to it. Set up GitHub workflows by following the steps described in Bevy New 2D's documentation.

Run your game

Use any of the following commands to run your game:

bevy run
bevy run web
bevy run --release
bevy run --release web

For VS Code users, .vscode/tasks.json provides IDE integration.

Release your game

To trigger a full release, navigate to Actions > Release > Run workflow in your GitHub repository.

Note

A web release runs automatically on every commit to main.

License

The source code in this repository is licensed under either of the following at your option:

• CC0-1.0 License
• 0BSD License

Credits

• The splash screen image belongs to the Bevy Foundation.
• The pixel fonts are CC0.
• The click and hover sound effects are CC0.
• The title and gameplay music tracks are CC0.