Rust-based, universal, configurable word‑game engine with bindings (WASM/JS, Python, C ABI) and a Docusaurus docs site.
- Docs:
./docs - Engine crate:
./engine - WASM:
./wasm - C ABI:
./engine_ffi - Python:
./bindings/python
Wordlists
- We include an example word list at
assets/dictionaries/TWL06.txt, sourced from https://scrabutility.com/ (citation for provenance). - A prebuilt FST is generated at
docs/static/dictionaries/TWL06.fstviamake wasmfor fast loading in the web demo. - See docs page “Lexicon Integration” for how to load custom dictionaries.
Getting Started
- Build/test:
make check - Web (WASM) demo:
make wasmand open the docs playground - Python:
cd bindings/python && maturin develop --release - C header:
make ffi-header(generatesengine_ffi/include/engine.h)
- Run
./tools/package_release.pyto build the Rust crate tarball, Python wheel, npm bundle, and Unity/Godot archives underdist/. - Inspect
dist/manifest.jsonto confirm the produced artifacts. - Publish each artifact to its registry (
cargo publish,twine upload,npm publish, attach the Unity/Godot zips to the GitHub release) and tag the repo (git tag v0.2.0).