diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 47 |
1 files changed, 36 insertions, 11 deletions
@@ -5,8 +5,8 @@ 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. +packages from https://pkg.metamuffin.org/. These also include documentation, +systemd services and .desktop files. ## Client @@ -14,13 +14,16 @@ systemd service. - Requirements: - Godot 4.2 -- `make client-assets` -- `cd client` -- Import all assets: `godot --import .` + - cURL + +``` +make client +godot --import client/project.godot +``` ### Usage -- `godot .` +- `godot client/project.godot` ## Server @@ -29,8 +32,10 @@ systemd service. - Requirements: - Nightly rust toolchain - Deno -- Build game data: `make -C data` -- Build the server program: `cargo +nightly build --release` + +``` +make test-client +``` ### Usage @@ -39,14 +44,34 @@ systemd service. 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` +- Requirements: + - esbuild -- Compile typescript: - `esbuild test-client/main.ts --bundle --outdir=test-client --target=esnext --format=esm` +``` +make test-client +``` ### Usage |