Metadata-Version: 2.4
Name: TelemetryOverlay
Version: 0.2.0
Summary: An overlay for displaying real-time numeric data
Author: thatCal
License-Expression: MIT
Project-URL: GitHub, https://github.com/thatCal/TelemetryOverlay
Keywords: overlay,tkinter,data
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Widget Sets
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: Microsoft :: Windows
Classifier: Typing :: Typed
Requires-Python: <4,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Telemetry Overlay

Originally designed as a Forza Horizon 6 overlay, this project is generic enough to display numeric data from virtually any source. (see `OverlayDataSource.py`, and `OverlayDataSource*.py` in examples)

To use the overlay, `OverlayApp` has been provided. Initialise an instance of `OverlayApp`, passing a derivative of `OverlayDataSource`, and add your desired elements - see examples for exact usage.

_Note: `OverlayApp` uses Tkinter's `-transparentcolor` to make the background transparent. This feature only works on Windows._ If you aren't on Windows, you may still use `OverlayApp` after modification.

## Installation

Prerequisites:
- Python 3.10 or later

For basic usage, you can install the package with:
```
pip install TelemetryOverlay
```

For those wishing to contribute, see below.

## Development

Prerequisites:
- Git
- Python 3.10 or later

Clone the repo, start a venv, navigate to the repo root and install the `TelemetryOverlay` package in editable mode:
```
pip install -e .
```
