diff options
| author | metamuffin <metamuffin@disroot.org> | 2025-07-13 16:44:00 +0200 |
|---|---|---|
| committer | metamuffin <metamuffin@disroot.org> | 2025-07-13 21:14:21 +0200 |
| commit | 10ef9cc31c82ada3625eab232d8c4b81a1356f1a (patch) | |
| tree | f341e595d20dc02b52a7a9d2cf661acfdedff31f /readme.md | |
| parent | 8c009e07a3b40b44cc03d54a189de2df76118a53 (diff) | |
| download | hurrycurry-10ef9cc31c82ada3625eab232d8c4b81a1356f1a.tar hurrycurry-10ef9cc31c82ada3625eab232d8c4b81a1356f1a.tar.bz2 hurrycurry-10ef9cc31c82ada3625eab232d8c4b81a1356f1a.tar.zst | |
Split off component-specific content into seperate readme files
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 114 |
1 files changed, 0 insertions, 114 deletions
diff --git a/readme.md b/readme.md deleted file mode 100644 index de91774b..00000000 --- a/readme.md +++ /dev/null @@ -1,114 +0,0 @@ -# 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.metamuffin.org/). - -For information about building from source, see the instructions for the -individual components 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. - -## Documentation - -The protocol is documented in [protocol.md](protocol.md). - -## Client - -### Building - -- Requirements: - - Godot 4.4 - - cURL (only if book is required) - - Nightly rust toolchain (only if locales are required) - -``` -make client -godot --import client/project.godot -``` - -### Usage - -- `godot client/project.godot` - -## Server - -### Building - -- Requirements: - - Nightly rust toolchain - - Deno (or Node.js in which case you need to pass `JSR=node` to make) - -``` -make data server -``` - -### Usage - -- Ensure the `data` directory is available **contained within** (not is) either - the process working directory of the server or in /usr/share/hurrycurry (or - similar). Running the server in the repository root should work. -- Run the server: `./target/release/hurrycurry-server` - -## Book - -### Building - -- Requirements: - - Python 3 - - Deno (or Node.js in which case you need to pass `JSR=node` to make) - - Typst (only if PDF or image export is required) - -``` -make book -``` - -## Pixel Client - -### Building - -- Requirements: - - Nightly rust toolchain - - SDL2 development libraries (including gfx, ttf and mixer extensions) - -``` -make pixel-client -``` - -### Usage - -- `./target/release/pixelcurry` - -## Test Client - -### Building - -- Requirements: - - Nightly rust toolchain (only if locales are required) - - 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. - -## Contributing - -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). |