Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/blackmonk13/wordament_solver

A simple tool to help you find words in Wordament puzzles using OpenCV.
https://github.com/blackmonk13/wordament_solver

image-processing ocr ocr-python ocr-recognition opencv tesseract-ocr trie-data-structure wordament wordament-solver

Last synced: 9 days ago
JSON representation

A simple tool to help you find words in Wordament puzzles using OpenCV.

Awesome Lists containing this project

README

        



Project logo

Wordament Solver

[![Status](https://img.shields.io/badge/status-active-success.svg)]()
[![GitHub Issues](https://img.shields.io/github/issues/blackmonk13/wordament_solver.svg)](https://github.com/blackmonk13/wordament_solver/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/blackmonk13/wordament_solver.svg)](https://github.com/blackmonk13/wordament_solver/pulls)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)

---

A simple tool to help you find words in Wordament puzzles using OpenCV.


## 📝 Table of Contents

- [About](#about)
- [Getting Started](#getting_started)
- [Usage](#usage)
- [Built Using](#built_using)
- [Authors](#authors)
- [Disclaimer](#disclaimer)

## 🧐 About

Wordament Solver is a Python project that helps you find words in Wordament puzzles. It uses image processing techniques to extract the grid data from a screenshot of the game, and then employs a trie data structure to efficiently search for valid words in the puzzle. The project also displays the highest-scoring words and shows the path of each word on the grid using arrows.

## 🏁 Getting Started

To get started with Wordament Solver, follow these steps:

1. Clone the repository:
```
git clone https://github.com/blackmonk13/wordament_solver.git
```
2. Install the required packages:
```
pip install -r requirements.txt
```
3. Run the project using a sample puzzle or a screenshot of the game.

## 🎈 Usage

### CLI Usage

```
python -m wordament_solver -h
```
When you have a cropped grid image like the following

Grid Image

``` python
python -m wordament_solver --image sample_images/grid/regular_grid.jpg --cropped --view
```

### Example Usage

For more detailed examples and use cases, refer to the `example.ipynb` notebook. It covers common scenarios and demonstrates how to use the package when imported as a package in other projects.

### Usage as a package

## ⛏️ Built Using

- [Python](https://www.python.org/) - Programming Language
- [NumPy](https://numpy.org/) - Array Processing Library
- [OpenCV](https://opencv.org/) - Image Processing Library
- [Pillow](https://pillow.readthedocs.io/en/stable/) - Image Processing Library
- [PyTesseract](https://github.com/madmaze/pytesseract) - OCR Library
- [NLTK](https://www.nltk.org/) - Natural Language Processing Library
- [SciPy](https://docs.scipy.org/doc/scipy/reference/) - Statistics Library

## ✍️ Authors

- [@blackmonk13](https://github.com/blackmonk13) - Idea & Initial work

See also the list of [contributors](https://github.com/blackmonk13/wordament_solver/contributors) who participated in this project.

## 📝 Disclaimer

Wordament Solver is not affiliated with, endorsed, or sponsored by Microsoft Corporation or the creators of Wordament. The project is intended for educational and entertainment purposes only. Any use of this project to gain an unfair advantage in the game or to violate the terms of service of Wordament or Microsoft Corporation is strictly prohibited. The authors and contributors of this project are not responsible for any misuse of the software.