- Python 94.4%
- Shell 5.6%
| src/wordlebot | Added documentation. Added install script | |
| .gitignore | Added AGPL license. Added pyproject setup | |
| COPYING | Added AGPL license. Added pyproject setup | |
| install.sh | Added documentation. Added install script | |
| MANIFEST.in | Updated the manifest to include the installer | |
| pyproject.toml | Updated the manifest to include the installer | |
| README.md | Updated the license details | |
wordlebot
wordlebot is a command-line tool designed to assist players in solving
the popular word puzzle
game Wordle. The
program generates possible
word guesses, evaluates user inputs, and ranks potential words based on
various algorithms to maximize the chances of winning.
Installation
Note: The included installer is designed only for MacOS. It will install
wordlebot using pipx and Homebrew, and will also install all
required dependencies of these tools.
-
Copy the .tar.gz archive file to the same location as
install.sh. -
Run the installer:
./install.sh
The wordlebot command will be added to your PATH.
Usage
Just run wordlebot from your terminal.
How to Play
-
Start the game: When you run the program, it will suggest the best opening words based on frequency algorithms.
-
Input your guess: Play your guess in Wordle, then input that guess into
wordlebot. -
Input your results: After each guess, tell
wordlebotthe results of your guess by entering characters as follows:!for letters in the correct position (green tiles in Wordle)?for letters present in the word but in the wrong position (yellow tiles).-for letters not present in the word (grey tiles).
-
Get suggestions: Based on your input,
wordlebotwill suggest the best possible words to try next. -
Continue or quit: Continue playing until you solve the puzzle or press
Ctrl+Cto exit the game.
License
/src/wordlebot/wordlists/shuffled_real_wordles.txt is courtesy of
Kinkelin/WordleCompetition
and is licensed under Creative Commons Attribution-ShareAlike 3.0
Unported. Besides this file, the below licensing terms apply.
Copyright 2024 Logan Kirkland.
This project is licensed under the GNU Affero General Public License.
See the COPYING file for details.