wordle-rs is a wordle inspired word guessing game for the CLI written in rust.
Run the game by executing
cargo run --bin game [language]
.
If language is not set, it defaults to the locale system settings or "en".
Run the importer tool by executing
cargo run --bin import <file_path> [language]
.
If language is not set, it defaults to the locale system settings or "en".
The player has to correctly guess a randomly selected word from the dictionary. All words are 5 characters long. By coloring single letters the game tells the player about correct letter positioning. * green: The guessed letter is at the correct position. * orange: The word contains the letter, but at a different position.
The game ends when the player runs out of guesses or when the player guesses the word correctly. After that, a message is displayed.
The .env file contains information about the database location.
* DATABASE_URL indicates that the dictioanry is located in a given db url
The import tool can be used to expand the word base. You have two options here with different implications.
If WORDBASE_FILE in the .env file is set, the tool will merge the data to avoid duplicates.
If DATABASE_URL is set, you need to manually clean up the database beforehand.
However, the requirements for the file underneath the <file_path argument are as follows:
* The file needs to be encoded in UTF-8
* The words need to be alphabetically sorted
* The words need to be separated with a newline character as the file is read line-wise
The tool automatically removes duplicates and entries with a size different from 5 bytes and converts unicode characters to ASCII using [any_ascii]. German umlauts receive a special treatment.
If you choose to set up a database to serve as dictionary, please take a closer look at the [diesel.rs] documentation. You need a working diesel_cli installation to proceed.
Step 1: Run the diesel initialization.
diesel setup
Step 2: Create a diesel migration.
diesel create dictionary_migration
Step 3: Navigate to the res/db folder.
create.sql and drop.sql should be put into the diesel migration's up.sql and down.sql.
Step 4: Import your dictionary into the database.
cargo run --bin import dictionary.txt [language]
Et voilà! Enjoy additional features. A correctly guessed word will be marked as guessed in the database and won't show up a second time. The first randomly selected word of the day will re-occur upon starting the game on the same day, until it has been guessed successfully.