# Hurry Curry!

A cooperative 3D multiplayer game about cooking.

## Installation

The installation methods for end-users are listed on the
[game's website](https://hurrycurry.org/). For information about
building from source, see the instructions below.

## Translation

If you want to help translate the project, you can use the
[weblate](https://translate.codeberg.org/engage/hurrycurry/). All help is
appreciated.

## Building / Development / Documentation

The game is composed of individual components each has its own readme file and
convinience make target.

- [Client](./client/README.md)
- [Server](./server/README.md)
- [Data](./data/README.md)
- [Test Client](./test-client/README.md)

### Dependencies:
- General:
    - make
- Client:
    - Godot (>=4.5)
    - ffmpeg
- Server:
    - cargo (toolchain version specified in `./rust-toolchain`; can be installed via `rustup toolchain install $(cat rust-toolchai)`)
    - Book:
        - cargo (see above)
- Data:
    - deno or node (if using non-deno, pass `JSR=node` to make)
- Test client:
    - cargo (see above)
    - esbuild

The game protocol is outlined in [protocol.md](./protocol.md).

## 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](https://matrix.to/#/#hurrycurry:metamuffin.org).

## License

AGPL-3.0-only; See [COPYING](./COPYING).
