Skip to content

Latest commit

 

History

History
89 lines (55 loc) · 2.48 KB

README.md

File metadata and controls

89 lines (55 loc) · 2.48 KB

ScoreSight - OCR Scoreboard Application

This is an OCR (Optical Character Recognition) application designed to read scoreboards. It is written in Python and utilizes the following technologies:

  • Qt6: A cross-platform GUI toolkit for creating graphical user interfaces.
  • OpenCV: A computer vision library for image and video processing.
  • Tesseract OCR: An open-source OCR engine for recognizing text from images.

Features

  • Extracts text from scoreboards using image processing techniques.
  • Provides a user-friendly interface for interacting with the application.
  • Supports multiple platforms thanks to PyInstaller packaging.

Usage

Videos and tutorials will be provided shortly.

Installation

See the releases page for downloadable executables and installers.

See the Install Guide for help with installation.

Build from Source

Prerequisites

  • Python 3.11
  • git

Procedure

  1. Clone the repository:
git clone https://github.com/occ-ai/scoresight.git
  1. Install the required dependencies:
pip install -r requirements.txt

For Mac and Windows there are further dependencies in requirements-mac.txt and requirements-win.txt

  1. Create a .env file. See the contents of the file in the .github/worksflows/build.yaml file

Windows

There are some extra steps for installation on Windows:

Usage

  1. Launch the application:
python main.py
  1. Follow the on-screen instructions to load an image of the scoreboard and extract the text.

Contributing

Contributions are welcome! If you would like to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them.
  4. Push your changes to your forked repository.
  5. Submit a pull request.

License

This project is released under the MIT license.

Contact

If you have any questions or suggestions, feel free to leave an issue on the repository. You may also email [email protected].

Business Inquiries

If you wish to contract the development team to productionize ScoreSight for your business need, please contact [email protected].