aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 377b183a3c22c1412f4aa6a5b3505426b5a43439 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# 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)
- [Book](./book/README.md)
- [Test Client](./data/README.md)

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).