summaryrefslogtreecommitdiff
path: root/readme.md
blob: 3b289a61bf5055c76a8cd931ba661d3892e42b84 (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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# Hurry Curry!

A cooperative multiplayer game about cooking.

The protocol is documented in [protocol.md](protocol.md).

If you happen to be using pacman you can add or manually download pre-built
packages from https://pkg.metamuffin.org/. These also include documentation,
systemd services and .desktop files.

## Client

### Building

- Requirements:
  - Godot 4.2
  - cURL

```
make client
godot --import client/project.godot
```

### Usage

- `godot client/project.godot`

## Server

### Building

- Requirements:
  - Nightly rust toolchain
  - Deno

```
make test-client
```

### Usage

- Ensure the `data` directory is available **in** either the process working
  directory of the server or /usr/share/hurrycurry (or similar). Running the
  server in the source folder should work.
- Run the server: `./target/release/hurrycurry-server`

## Pixel Client

### Building

- Requirements:
  - Nightly rust toolchain
  - SDL2 development libraries

```
make pixel-client
```

### Usage

```
cargo run --bin pixel-client
```

## Test Client

### Building

- Requirements:
  - esbuild

```
make test-client
```

### Usage

- Serve `test-client` directory somehow. With python:
  `python -m http.server 8080 -d test-client`
- Open the page with your browser.

## License

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