Skip to main content

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 .

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

telemetryoverlay-0.2.0.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

telemetryoverlay-0.2.0-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file telemetryoverlay-0.2.0.tar.gz.

File metadata

  • Download URL: telemetryoverlay-0.2.0.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.0

File hashes

Hashes for telemetryoverlay-0.2.0.tar.gz
Algorithm Hash digest
SHA256 779b3089ff1322681389968280943ac8480df1fa62c4810a212b86cc53dd306a
MD5 8e5b78e9072eda4362f9278f3af98efc
BLAKE2b-256 c708f7298a946e5d71e3102aeae604dd4d992e53f8f220fb1f552f53f88f6d74

See more details on using hashes here.

File details

Details for the file telemetryoverlay-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for telemetryoverlay-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 00204891ae383ff5ce43815d3d5ae0bc2001b0116290ea3cb70601aa597c9fb7
MD5 f59cdf4aac6817106ddd299457e80f3b
BLAKE2b-256 565bd12055321cbf97bfd00898beab83b9145a534300edd2ae7be77d797a4800

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page