blob: e153ae747a5910ed5d0a1dcd584475042daada6d (
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
|
# 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 https://pkg.metamuffin.org/. These also include documentation and a
systemd service.
## Client
### Building
- Requirements:
- Godot 4.2
- `make client-assets`
- `cd client`
- Import all assets: `godot --import .`
### Usage
- `godot .`
## Server
### Building
- Requirements:
- Nightly rust toolchain
- Deno
- Build game data: `make -C data`
- Build the server program: `cargo +nightly build --release`
### 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`
## Test Client
### Building
- Requirements: `esbuild`
- Compile typescript:
`esbuild test-client/main.ts --bundle --outdir=test-client --target=esnext --format=esm`
### 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).
|
