turdle

Crates.ioturdle
lib.rsturdle
version0.3.1
sourcesrc
created_at2024-06-05 22:44:34.99331
updated_at2024-06-10 10:02:34.183679
descriptionA Wordle clone for the terminal
homepage
repositoryhttps://github.com/weiteck/turdle
max_upload_size
id1263197
size200,148
Chris Price (weiteck)

documentation

README

Turdle

A Wordle clone for the terminal

Turdle screenshot

Turdle is a clone of the popular browser-based word game Wordle by Josh Wardle, now owned by The New York Times. The (admittedly crude) name is a portmanteau of TUI + Wordle.

A random word is selected each time the game is run. Run turdle --help for additional options.

Features

  • The same pool of 2,309 answers and 12,546 valid words from the original game
  • Large-font gameboard reminiscent of the original game
  • Animated letter reveals and invalid word feedback
  • 'Keyboard' showing the state of each letter you've used
  • An emoji result grid is printed when you guess correctly
  • Play today's Wordle with turdle today
  • Play a specific date's Wordle with turdle date <YY-MM-DD>

Special Keys

  • Use Esc to exit
  • Use Tab to toggle the keyboard layout or set TURDLE_QWERTY_MODE=1 to always start with QWERTY layout
  • Use Page Up and Page Down to cycle the background colour and Home to reset it

Installation

Linux and Windows binaries are available on the releases page.

Alternatively, if you already have Rust installed, simply run:

cargo install turdle --locked

If you encounter a linker error, your system may be missing the required compiler toolchain:

Arch

sudo pacman -S base-devel

Debian/Ubuntu

sudo apt install build-essential

Centos

sudo yum install gcc

Compatibility

Due to the large font used for the gameboard, your terminal must be at least 34 rows high for it to render correctly.

Turdle targets modern terminal emulators. The large font rendering is unlikely to work running in the Windows command prompt or Powershell, but it does work on later versions of Windows Terminal.


License

MIT or Apache 2.0 at your discretion.

Commit count: 30

cargo fmt