https://github.com/mysteryblokhed/cluecards
Automatic inference for interactions in Clue (Cluedo). Mirrored from https://gitlab.com/MysteryBlokHed/cluecards.
https://github.com/mysteryblokhed/cluecards
Last synced: 3 months ago
JSON representation
Automatic inference for interactions in Clue (Cluedo). Mirrored from https://gitlab.com/MysteryBlokHed/cluecards.
- Host: GitHub
- URL: https://github.com/mysteryblokhed/cluecards
- Owner: MysteryBlokHed
- License: agpl-3.0
- Created: 2024-07-12T20:49:31.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-04-01T16:26:40.000Z (3 months ago)
- Last Synced: 2025-04-01T17:44:47.268Z (3 months ago)
- Language: TypeScript
- Homepage: https://clue.adamts.me
- Size: 800 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cluecards
Automatic inference for interactions in [Clue (Cluedo)](https://en.wikipedia.org/wiki/Cluedo).
## How does it work?
If you're interested in a written explanation for the inference methods I've discovered while creating this website,
I've done my best to document them [here](./Inference.md).
You don't need to read it to use the website, but it might be interesting.
Note that GitLab has a maximum number of LaTeX cells per markdown file,
so it will not display properly unless you're looking at this repository [on GitHub](https://github.com/MysteryBlokHed/cluecards).
## Folder structure
| Folder | Purpose |
| :-------- | :----------------------------------------------------------------- |
| inference | Rust WebAssembly implementation of the site's inference logic. |
| public | Static website assets. |
| scripts | Convenience scripts for testing/development. |
| src | Source code for the UI and the TypeScript portions of the website. |
| test | Unit and integration tests for the inference logic. |
## Building
The inference logic must be built _before_ the rest of the website.
Instructions are available [here](./inference/README.md).
After that, this project requires pnpm v9.
After installing [Node.js](https://nodejs.org/en/download/package-manager), run the following in the project directory:
```sh
corepack enable
corepack install
```
Then, to build for release:
```sh
pnpm run build
```
## License
This project is licensed under the GNU Affero General Public License, Version 3.0
([LICENSE](LICENSE) or ).