README.md

Wordle Assistant

Console application that follows your game state and provides options. It saves time for finding words. Currently only working for standard daily SPANISH challenges.
Spanish Version of Wordle »
English Version of Wordle »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Allows you to introduce a string with the feedback of the game. Then filters all the non-available words and shows you the alternatives to introduce in the next place. Between all this words, a ranking is shown to help you choose the best option. The ranking sorts distance of Levenshtein. The word that have less distance with all the non filtered words goes first.

(back to top)

Built With

• Python

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

WIP Tested with Python 3.9

• pips as current dependencies

    import re
    import tkinter as tk
    import json

Usage

Execute main.py to start the console application.

Introduce a wildcard for each character of the word:

-a --> States that the 'a' was GREY at that position. (The final words doesn't have 'a')

!a --> States that the 'a' was GREEN at that position. (The final words has 'a' at that specific position)

?a --> States that the 'a' was YELLOW at that position. (The final words has 'a' at other position)

p.e

The input pattern string -a?m!i-g!o

• States that the final word doesn't have 'a' or 'g' (GREYS).
• States that the final word has 'i' and 'o' (GREENS) are in his correct place.
• States that the final word has 'm' but is in other position, not in the second character (YELLOWS).

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Levenshtein distance for base cases
• FIX repeated characters on the same word.
• Provide base words for the game first word iteration.
  • Ranking of best 10 words
  • Feeling lucky (Providing one complete random word)
  • Need a challenge (Providing one of the worst 10% words)
• Add ENGLISH! (Just need data that needs to share the /data/spanish.txt format)
• Missing verb conjugations inside /data/spanish.txt (Can be used but not for the final word(?))
• Improved help/instructions, make it more visual
• Make a usable UI instead of console application
• Game state visualization improvement
• Game state CRUD
• Add other Wordle game modes
• Get game state from the wordle webpage.
• Game theory IA training ... Win % for each turn

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE file for more information.

(back to top)

Contact

Joralgra - @replica_SP - [email protected]

Project Link: https://github.com/joralgra/wordleBOT

(back to top)