⚠️ Warning: This is the legacy documentation for Jumpy, before the Bevy rewrite was merged. It is no longer up-to-date, but it still has some useful thoughts, and some of it may still be good to migrate to the new documentation.
The latest documentation site can be found here.
Fish Folk: Jumpy
Introduction
Fish Folk: Jumpy is a tactical 2D shooter, played by up to 4 players online or on a shared screen. Aim either left or right; the rest is up to clever movement and positioning in this fish-on-fish brawler! For more information about our origin story (Duck Game et.al.) and big-picture plans, see our design document.
Key Features (WIP)
- 2 to 4 players in either Local Multiplayer or Online Play
- Easy to pick up, emphasizing strategy over twitch reaction
- Customize characters with hats, saved to your cross-platform profile
- Create & explore user-made weapons, levels, audio and other scripted extensions
- Smart level creation tools
- Tournaments & matchmaking built in
Status
The game is currently under re-construction as it is being rewritten to use the Bevy game engine. There are now 4 stable maps and 4 items in the new version, and the game is nearly ready for another release.
Community
Contributing
Anyone involved in the Fish Folk community must follow our code of conduct.
If you'd like to make something for Fish Folk, check out our help-wanted issues or just ask us on Discord. We'll soon post an updated roadmap for the next month or two of work ahead.
Before committing and opening a PR, please run the following commands and follow their instructions:
cargo clippy -- -W clippy::correctness -D warnings
cargo fmt
Learning Materials
Rust
Bevy
Download & play
- Download the latest version from the releases page.
- Extract the archive and run the executable. (e.g.
./jumpy
orjumpy.exe
)
Launcher
A cross-platform launcher is also available for downloading and launching the game easily.
Distro Packages
Arch Linux
pacman -S jumpy
Building
- Install Rust with rustup.rs
- Clone this repository:
git clone https://github.com/fishfolks/jumpy.git
cd jumpy
cargo run
Credits
- Fish Folk: Jumpy Credits
- Input Icons: Kadith's Icons by Kadith