-
Notifications
You must be signed in to change notification settings - Fork 119
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
19 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,47 @@ | ||
| # Fish Fight | ||
|
|
||
| [](https://github.com/fishfight/fish2/actions?query=workflow%3A) | ||
|  | ||
|
|
||
| ### Introduction | ||
| ## Introduction | ||
|
|
||
| Fish Fight 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! | ||
| Fish Fight 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](https://www.notion.so/erlendsh/Fish-Fight-1647ed74217e4e38a59bd28f4f5bc81a). | ||
|
|
||
| ## Key Features | ||
| ### Key Features (WIP) | ||
|
|
||
| - 2 to 4 players in either Local Multiplayer or Online Play (currently focused on local) | ||
| - 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 | ||
|
|
||
| ## The Plan | ||
|
|
||
| We are making a spiritual successor to the cult classic [Duck Game](https://store.steampowered.com/app/312530/Duck_Game/). | ||
|
|
||
| > Blast your friends with Shotguns, Net Guns, Mind Control Rays, Saxophones, Magnet Guns, and much, much more. This is DUCK GAME. Don't blink. | ||
| Duck Game is an excellent game. It deserves the 10/10 rating it can boast on Steam. But it is also stuck in an older tech stack. A combination of tech debt and lacking cross-platform infrastructure makes it very PC-centric. It's been ported to other platforms, albeit with a more limited experience; no online mods directory & delayed game updates. | ||
|
|
||
| The final update [still pending](https://twitter.com/superjoebob/status/1407628707754250241) for consoles is the last major update the game will ever receive. | ||
|
|
||
| There's ample opportunity for collaboration here: Fish Fight is a tribute to and continuation of Duck Game. *A spiritual successor*. To that end, we’ve been communicating with the creator of Duck Game (Landon) and got his blessing to make our own interpretation of his original game design. | ||
|
|
||
| ### Status | ||
|
|
||
| The game is fully playable: \ | ||
| https://twitter.com/fedor_games/status/1408868565772652544 | ||
|
|
||
| #### Install | ||
| https://twitter.com/fishfightgame/status/1424084016467226624 | ||
|
|
||
| 1. Install Rust with [Rustup.rs](https://rustup.rs/) | ||
| 2. `cargo run` | ||
| ## Community | ||
|
|
||
| ### Contributing | ||
| We are currently focused on making the game as enjoyable as possible on local multiplayer, i.e. couch co-op. Check out the [roadmap](https://github.com/fishfight/fish2/issues/2) for more. | ||
|
|
||
| Before committing and opening a PR, run the following commands and do as they say: | ||
| 1. `cargo clippy -- -W clippy::correctness -D warnings` | ||
| 2. `cargo fmt` | ||
| Anyone involved in the Fish Fight community must follow our [code of conduct](https://github.com/fishfight/FishFight/blob/main/CODE_OF_CONDUCT.md). | ||
|
|
||
| If you'd like to make something for Fish Fight, check out our [help-wanted](https://github.com/fishfight/FishFight/labels/help%20wanted) issues or just ask us on [Discord](https://discord.gg/4smxjcheE5). 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: | ||
| 1. `cargo clippy -- -W clippy::correctness -D warnings` | ||
| 2. `cargo fmt` | ||
|
|
||
| ### Learning Materials | ||
| - https://macroquad.rs/tutorials/fish-tutorial/ | ||
| - https://not-fl3.github.io/platformer-book/intro.html | ||
| - https://sokoban.iolivia.me/ (we do not use an ECS) | ||
| - https://pragprog.com/titles/hwrust/hands-on-rust/ (ask Erlend for a free copy) | ||
|
|
||
| ## Install & play | ||
|
|
||
| 1. Install Rust with [Rustup.rs](https://rustup.rs/) | ||
| 2. `cargo run` | ||
|
|
||
| We'll start distributing executables shortly! |