Home

Awesome

Fish Folk: Punchy

Build Status License Discord Bors enabled

A 2.5D side-scroller beat-’em-up, made in Bevy. Inspired by games like Little Fighter 2, River City Ransom and many more.

EA469655-50B7-487F-84EA-A4A06938356A

https://user-images.githubusercontent.com/1379590/215623680-2abbd867-717c-42d3-898c-aa7d110e0e0c.mp4

Web Build

We keep our web build current with our latest relese.

https://fishfolk.github.io/punchy/player/latest/

Previous versions of the web build can also be found linked on their respective release pages.

Building current development version

If you wish to check out changes not yet made it into a release, you can build the game for yourself.

  1. If you dont have it installed already, Install rust and the latest stable toolchain with rustup.rs.
  2. If you are running Linux, ensure you have Bevy's dependancies installed.
  3. Clone this repository: git clone git@github.com:fishfolks/punchy.git
  4. In the repository base, cargo run to compile and run the project.

Contributing

Anyone involved in the Fish Folk community must follow our code of conduct.

Punchy is currently at an early stage of development, if you want to contribute the best way to get started is to join us at the Spicy Lobster Discord and check out our help-wanted issues.

Before committing and opening a PR, please run the following commands and follow their instructions:

  1. cargo clippy -- -W clippy::correctness -D warnings
  2. cargo fmt

Or if you install just you can simply run just check.

MVP Spec

861A6300-5FFD-4DDC-B4BF-0E8514F4B87C