readme refresh
This commit is contained in:
@@ -1,11 +1,24 @@
|
|||||||
# cruciverb
|
# cruciverb
|
||||||
|
|
||||||
A crossword puzzle engine that generates grids, fills them with real words, and turns them into IPUZ and PUZ files you can publish anywhere.
|
Crossword puzzles with a handwriting-first twist: daily grids in five difficulty presets, a community clue pool, and ActivityPub federation between instances.
|
||||||
|
|
||||||
## Status
|
## Features
|
||||||
|
|
||||||
Very early. The fill works on small and mid-size grids. Exports are being shaped up.
|
- Daily puzzles generated with seeds so every solver gets the same grid and clues
|
||||||
|
- Handwriting and stylus input recognized through ONNX and the browser handwriting api, with tesseract as a fallback
|
||||||
|
- Puzzle editor, clue trainer, multiplayer rooms, and party games
|
||||||
|
- Receipts and federation: instances follow each other and exchange clue submissions and puzzles
|
||||||
|
|
||||||
## How to run
|
## Layout
|
||||||
|
|
||||||
cargo run -p cruciverb-cli -- generate --width 15 --height 15
|
- cruciverb-core: the generator (grid construction, fill, exports)
|
||||||
|
- cruciverb-server: the axum api, sqlite storage, and activitypub plumbing
|
||||||
|
- cruciverb-cli: command line generation
|
||||||
|
- frontend: the vite and react client
|
||||||
|
|
||||||
|
## Running it
|
||||||
|
|
||||||
|
cargo run -p cruciverb-server
|
||||||
|
cd frontend && npm install && npm run dev
|
||||||
|
|
||||||
|
Point the client at the api on localhost:8080. Environment variables configure the instance domain, actor name, and data directory.
|
||||||
|
|||||||
Reference in New Issue
Block a user