Valsr

A Lojban version of the word guessing game Wordle implemented in Rust.

Live version running at la-lojban.github.io/valsr/.

A fork of sanuli

Quick start

Follow Rust installation instructions.

To build the WASM based yew UI, further wasm tooling is required

rustup target add wasm32-unknown-unknown
cargo install --locked trunk
cargo install wasm-bindgen-cli

Create word list files and populate them with uppercase words, one per line

touch definitions.txt
touch hints.txt
touch common-words.txt
touch daily-words.txt
touch profanities.txt

Start the UI in development mode

RUSTFLAGS=--cfg=web_sys_unstable_apis trunk serve --port=9090

Word lists

Three separate word list files in the root of this project containing all the words are required. The lists are not included in this repository.

The lists are:

• definitions.txt - Full list of all accepted 5 and 6 character words. Each line is word "tab-separator" word definition. The checks if a word real or not is done against this list. Word definitions after a successful guess are shown from this file too.
• hints.txt - a list of Lojban definitions of words. Used to provide hints while playing. May not contains definitions for all words from definitions.txt.
• daily-words.txt - a list of daily words. The daily word is taken from row equal to the days from 2022-01-07.
• common-words.txt - a subset of the definitions list, intended for easier game mode
• profanities.txt - Words from here are included into games when "experimental gismu" mode is enabled

Beware that these are included in the release binary, and anyone can obtain the lists!

Generating base word lists

To create a word list, a dictionary like the "nykysuomen sanalista" by Kotus, licensed with CC BY 3.0, can be used as a baseline.

A parser for parsing kotus-sanalista_v1.xml file from Kotus is included:

cargo run --bin parse-kotus-word-list your/path/to/kotus-sanalista_v1.xml

which creates a full-words-generated.txt file in the working directory.

Development

For development, start the web server with

RUSTFLAGS=--cfg=web_sys_unstable_apis trunk serve

This should make the UI available at 0.0.0.0:8080 with hot reload on code changes.

To change the default port, use

RUSTFLAGS=--cfg=web_sys_unstable_apis trunk serve --port=9090

Release build

RUSTFLAGS=--cfg=web_sys_unstable_apis trunk build --release

and copy the produced docs directory to your target server.