Skip to content

Latest commit

 

History

History
152 lines (99 loc) · 4.87 KB

README.md

File metadata and controls

152 lines (99 loc) · 4.87 KB
Raw

ScoreSight - Scoreboard OCR Application

GitHub GitHub Workflow Status Total downloads GitHub release (latest by date) Discord

ScoreSight 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.

It is the best free scoreboard OCR tool on planet Earth.

If you'd like to donate to help support the project, you can do so on GitHub or Patreon.

Features

  • Works on Windows, Mac and Linux (the only scoreboard OCR tool that does it)
  • Input/Capture: USB, NDI, Screen Capture, URL / RTSP, Video Files, etc.
  • Perspective correction
  • Image processing and binarization techniques, local, global etc.
  • Output to text files (.txt, .csv, .xml)
  • HTTP output via local server: HTML, JSON, XML and CSV endpoints
  • Import & Export configuration profiles
  • Integrations: OBS (websocket), vMix (API), NewBlue FX Titler (API)
  • Up to 30 updates/s
  • Unlimited detection boxes
  • Camera bump and drift correction with stabilization algorithm
  • Unlimited devices or open instances on the same device
  • Custom detection boxes

Price: FREE.

Usage

Very short video tutorials:

Additional guides:

Installation

See the releases page for downloadable executables and installers.

See the Install Guide for help with installation.

Running and Building 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:

Running from source

  1. Once everything is installed launch the application:
python main.py
  1. Follow the on-screen instructions to load an image of the scoreboard and extract the text.

Build an executable

You may want to build a distributable .exe or .app or even an installer, this is possible with PyInstaller.

To build the executable run PyInstaller.

MacOS

pyinstaller --clean --noconfirm scoresight.spec -- --mac_osx

Windows

pyinstaller --clean --noconfirm scoresight.spec -- --win

Linux

pyinstaller --clean --noconfirm scoresight.spec

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 needs, please contact [email protected].