Hurry Curry!

A cooperative 3D multiplayer game about cooking.

Installation

The installation methods for end-users are listed on the game's website. For information about building from source, see the instructions below.

Translation

If you want to help translate the project, you can use the weblate. All help is appreciated.

Development / Documentation

The game is composed of individual components each has its own readme file:

• Client
• Server
• Data
• Test Client

The game protocol is outlined in protocol.md.

Building

The high-level build system is Make. But Rust's Cargo is also used. There are is a all target for everything and all_<component> for each component.

make all # Build everything
make all_{client,server,book,data,testclient} # Build only one component
make clean # Remove build files

Dependencies

• General:
  • Make
• Client:
  • Godot (>=4.5)
  • ffmpeg
• Server:
  • Rustup (alternatively a Rust toolchain matching rust-toolchain)
• Data:
  • Deno or Node.js (if using node, pass JSR=node to Make)
  • sed
• Test client:
  • Rustup
  • esbuild
• Book export:
  • Godot (>=4.5)
  • Rustup
  • (Optional) Graphviz

Contributing

Contributions are appreciated, just open issues or PRs for the things you think could be improved.

For discussion regarding development, feel free to join our matrix room: #hurrycurry:metamuffin.org.

License

AGPL-3.0-only; See COPYING.