diff --git a/README.md b/README.md index 6f08941..1d9903d 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,24 @@ # Wordle Bot - Python 3 This is a wordle bot designed using the principles of entropy in information theory. -## Bot v1.0 - Naive bot -This bot takes the probability of choosing each letter for a given position of a word to be equally likely +# How to Use This Repo +There are two ways to use this repository: -## Bot v2.0 - FrequencyData Bot -This bot uses data about the frequency of usage of words to predict the probable words +## Use the bot to play wordle +To have the bot play wordle, you can use the `wordle_bot.py` file while playing the actual wordle game on the [Wordle website](https://www.nytimes.com/games/wordle/index.html). The bot will give you the next word to guess and you can use that to play the game. + +- Start the bot with `python wordle_bot.py` +- Enter the initial guess the bot gives in the Wordle site +- You will get the feedback of which letters are correct and which are in the wrong position. +- Enter the feedback in the bot using the following format + - `Correct letters in the right position: R` + - `Correct letters in the wrong position: Y` + - `Incorrect letters: G` +- Then it would give you its prediction to the next word + +## Simulation mode + +In this mode the robot will run on a simulated wordle game and will give you the next word to guess and the feedback. You can use this to test the bot's performance. It will simulate all the words given in the `allowed.txt` file. ### Calculations * Expected Value / Entropy : Calculate the matching words for a given arrangement and then use the frequecy data of those words to calculate the overall probability of that arrangement. Use this probability to calculate the Entropy value