{"id":48600413,"url":"https://github.com/TinyPedal/TinyPedal","last_synced_at":"2026-04-24T15:01:11.791Z","repository":{"id":42522851,"uuid":"469651629","full_name":"TinyPedal/TinyPedal","owner":"TinyPedal","description":"Free and Open Source telemetry overlay application for racing simulation","archived":false,"fork":false,"pushed_at":"2026-04-15T07:11:55.000Z","size":6117,"stargazers_count":298,"open_issues_count":15,"forks_count":35,"subscribers_count":12,"default_branch":"master","last_synced_at":"2026-04-15T08:24:02.520Z","etag":null,"topics":["overlay","python","qt","racing","racing-game","telemetry"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TinyPedal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-03-14T08:54:48.000Z","updated_at":"2026-04-15T07:11:59.000Z","dependencies_parsed_at":"2025-11-17T07:04:40.235Z","dependency_job_id":null,"html_url":"https://github.com/TinyPedal/TinyPedal","commit_stats":null,"previous_names":["tinypedal/tinypedal"],"tags_count":147,"template":false,"template_full_name":null,"purl":"pkg:github/TinyPedal/TinyPedal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TinyPedal%2FTinyPedal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TinyPedal%2FTinyPedal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TinyPedal%2FTinyPedal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TinyPedal%2FTinyPedal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TinyPedal","download_url":"https://codeload.github.com/TinyPedal/TinyPedal/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TinyPedal%2FTinyPedal/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32228437,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-24T13:21:15.438Z","status":"ssl_error","status_checked_at":"2026-04-24T13:21:15.005Z","response_time":64,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["overlay","python","qt","racing","racing-game","telemetry"],"created_at":"2026-04-08T22:00:19.234Z","updated_at":"2026-04-24T15:01:11.780Z","avatar_url":"https://github.com/TinyPedal.png","language":"Python","funding_links":[],"categories":["Telemetry \u0026 Data Analysis","Sim Racing"],"sub_categories":["Multi-Sim","Media and Analysis"],"readme":"# TinyPedal - racing simulation overlay\n\nTinyPedal is a Free and Open Source telemetry overlay application for racing simulation.\n\nFocuses on minimalist design, light-weight and efficiency, extensive customization and data analysis. Features a large collection of highly configurable overlay widgets and data modules, advanced fuel calculator and editing tools.\n\nCurrently supports `rFactor 2` and `Le Mans Ultimate`, and runs on `Windows` and `Linux`.\n\n[Download](https://github.com/TinyPedal/TinyPedal/releases) -\n[Quick Start](#quick-start) -\n[FAQ](https://github.com/TinyPedal/TinyPedal/wiki/Frequently-Asked-Questions) -\n[User Guide](https://github.com/TinyPedal/TinyPedal/wiki/User-Guide) -\n[Run on Linux](#running-on-linux) -\n[License](#license)\n---\n\n![preview](https://user-images.githubusercontent.com/21177177/282278970-b806bf02-a83d-4baa-8b45-0ca10f28f775.png)\n\n## Requirements\n\n### Supported Sims\n\n| API | Windows | Linux |\n|:-:|:-:|:-:|\n| Le Mans Ultimate | No plugin required | Requires third-party plugin |\n| rFactor 2 | rF2SharedMemoryMapPlugin | rF2SharedMemoryMapPlugin(Wine) |\n\n### Display Mode\n\nGame display mode must be set to `Borderless` or `Windowed` to show overlay. `Fullscreen` mode is not supported.\n\n### Setup for Le Mans Ultimate\n\n#### Windows\n\n* There is no plugin required for accessing LMU's built-in API on Windows. However, make sure `Enable Plugins` option is turned `ON` from in game `Settings` -\u003e `Gameplay` page.\n\n#### Linux\n\n* LMU's built-in API can be selected on Linux, but may require third-party plugin to access, see [discussion #9](https://github.com/TinyPedal/TinyPedal/issues/9) for info.\n\n### Setup for rFactor 2\n\nTheIronWolf's [rF2 Shared Memory Map Plugin](https://github.com/TheIronWolfModding/rF2SharedMemoryMapPlugin) is required for accessing `rFactor 2` API.\n\n#### Windows\n\n* Download the plugin from:\\\nhttps://github.com/TheIronWolfModding/rF2SharedMemoryMapPlugin#download\n\n#### Linux\n\n* Download the forked plugin for Wine from:\\\nhttps://github.com/schlegp/rF2SharedMemoryMapPlugin_Wine/blob/master/build\n\n#### Install plugin\n\nThe plugin file is named `rFactor2SharedMemoryMapPlugin64.dll` and should be placed in `rFactor 2\\Bin64\\Plugins` folder.\n\nNote, manually create this `Plugins` folder if it is missing.\n\n#### Enable plugin in game\n\nIn game `Settings` -\u003e `Gameplay` page, find `Plugins` section and toggle on `rFactor2SharedMemoryMapPlugin64.dll`.\n\nAfter plugin enabled, must `restart game` to take effect.\n\nNote, if game cannot generate `rFactor2SharedMemoryMapPlugin64.dll` entry in `CustomPluginVariables.JSON` file, make sure `VC12 (Visual C++ 2013) runtime` is installed, which can be found in game's `Support\\Runtimes` folder.\n\n## Quick Start\n\n\u003e [!IMPORTANT]\n\u003e Make sure required plugins for specific game are installed according to [Requirements](#requirements).\n\u003e\n\u003e DO NOT extract TinyPedal into `system` or `game` folder, such as `Program Files` or `rFactor 2` folder, otherwise it may fail to run.\n\u003e\n\u003e See [Frequently Asked Questions](https://github.com/TinyPedal/TinyPedal/wiki/Frequently-Asked-Questions) for common issues, and [User Guide](https://github.com/TinyPedal/TinyPedal/wiki/User-Guide) for usage info.\n\u003e\n\u003e For Linux user, please follow [Running on Linux](#running-on-linux) section for instruction.\n\n1. Download latest TinyPedal version from [Releases](https://github.com/TinyPedal/TinyPedal/releases) page, extract it into a clean folder, and run `tinypedal.exe`.\n\n2. A tray icon will appear at system tray. If not shown, check hidden tray icon. `Right Click` on tray icon will bring up context menu.\n\n3. Launch game, overlay will appear once vehicle is on track, and auto-hide otherwise. Auto-hide can be toggled On and Off by clicking `Auto Hide` from tray menu.\n\n4. Overlay can be Locked or Unlocked by clicking `Lock Overlay` from tray menu. While Unlocked, click on overlay to drag around.\n\n5. Widgets can be Enabled or Disabled from `Widget` panel in main window. `Right Click` on tray icon and select `Config` to show main window if it is hidden.\n\n6. To quit APP, `Right Click` on tray icon and select `Quit`; or, click `Overlay` menu from main window and select `Quit`.\n\n## Run from Source\n\n### Dependencies:\n* [Python](https://www.python.org/) 3.8, 3.9, or 3.10\n* PySide2\n* pyLMUSharedMemory\n* pyRfactor2SharedMemory\n* psutil\n\n\u003e [!IMPORTANT]\n\u003e Make sure to check Python version before installing additional dependencies.\n\u003e\n\u003e PySide2 may not be available for Python version higher than 3.10; or requires PySide6 instead for running with newer Python version. PySide6 is currently supported only via command line argument, see [Command Line Arguments](https://github.com/TinyPedal/TinyPedal/wiki/User-Guide#command-line-arguments) in User Guide for details.\n\n### Download source code\n\n#### Method 1\n\nDownload TinyPedal source code from [Releases](https://github.com/TinyPedal/TinyPedal/releases) page; or click `Code` button at the top of repository and select `Download ZIP`.\n\nDownload submodule source code from following links:\n- pyLMUSharedMemory: https://github.com/TinyPedal/pyLMUSharedMemory\n- pyRfactor2SharedMemory: https://github.com/TinyPedal/pyRfactor2SharedMemory\n\nExtract TinyPedal source code ZIP file. Then extract submodule ZIP files and put them in corresponding folder in the root folder of TinyPedal.\n\n#### Method 2\n\nUse [Git](https://git-scm.com/) tool and run following command to clone TinyPedal source code alongside required submodules:\n```\ngit clone --recursive https://github.com/TinyPedal/TinyPedal.git\n```\n\nTo update submodules, run command:\n```\ngit submodule update --init\n```\n\nSince `master` branch is the development branch, it may not be stable for normal use. You may switch to specific released version instead, such as `v2.45.0`, run command:\n```\ngit checkout tags/v2.45.0\n```\n\nAnd to switch back to development branch, run:\n```\ngit checkout master\n```\n\n### Setup development environment\n\nIt is recommended to setup an isolated development environment for running and testing code, especially useful if multiple different versions of Python are installed.\n\nTo start, make sure required Python version was installed. Currently the primary supported Python version is `3.8`, which is used in this example.\n\nFirst, we need to create a [Python virtual environment](https://docs.python.org/3/library/venv.html). On windows, run following command in `Powershell` (replace the last part to your preferred path, either relative or absolute path):\n\n```\npy -3.8 -m venv '.virtualenvs\\tinypedal_py38'\n```\n\nThen run following command to activate this virtual environment:\n\n```\n.virtualenvs\\tinypedal_py38\\Scripts\\activate.ps1\n```\n\nOnce activated, you can continue with [Install dependencies](#install-dependencies) section to install required package for this virtual environment, and running or building TinyPedal inside this virtual environment.\n\nFinally, remember to activate this virtual environment (if haven't already) before installing packages or running the code.\n\n### Install dependencies\n\nInstall additional dependencies by using command:\n```\npip3 install PySide2 psutil\n```\n\nTo start TinyPedal, type command from project root folder:\n```\npython run.py\n```\n\n## Build Executable for Windows\n\nExecutable file can be built with [py2exe](http://www.py2exe.org).\n\nTo install py2exe, run command:\n```\npip3 install py2exe\n```\n\nTo build executable file, run command:\n```\npython freeze_py2exe.py\n```\n\nAfter building completed, executable file can be found in `dist\\TinyPedal` folder.\n\n\u003e [!NOTE]\n\u003e The build script only supports py2exe `v0.12.0.0` or higher. The build script does not support PySide6.\n\n## Running on Linux\n\nThe procedure described in the [Run from Source](#run-from-source) section is mostly valid,\nexcept some differences in the dependencies, and that no executable can be\nbuilt. The differences are explained here.\n\nConfiguration and data files will be stored in the defined user-specific\ndirectories, default to:\n```\n$HOME/.config/TinyPedal/\n$HOME/.local/share/TinyPedal/\n```\n\nThe required Python packages are `PySide2`, `psutil` and `pyxdg`. Most distros\nname the package with a prefix, like `python3-pyside2`, `python3-psutil` and\n`python3-pyxdg`.\n\nSome distros split `PySide2` in subpackages. If you don't find\n`python3-pyside2` then you should install `python3-pyside2.qtgui`,\n`python3-pyside2.qtwidgets` and `python3-pyside2.qtmultimedia`.\n\nAlternatively, you can install them using `pip3` but this will bypass your\nsystem package manager and it isn't the recommended option. The command to\ninstall the dependencies with this method is:\n```\npip3 install PySide2 psutil pyxdg\n```\n\nTo start TinyPedal type the following command:\n```\n./run.py\n```\n\n### Installation\n\nOnce you have a working instance of TinyPedal, created using the git command or\nby unpacking the Linux release file, you can run the install script to install\nor update TinyPedal on your system.\n\nThe install script will create a desktop launcher and will make `TinyPedal`\navailable as a command from the terminal.\n\nThe files will be installed at the `/usr/local/` prefix. You'll need\nappropriate permissions to write there, for example, by using `sudo`.\n\nYou can run the script as (it doesn't support any arguments or options):\n```sh\nsudo ./install.sh\n```\n\nIf you need persistent launch arguments (for example, to force PySide6), create\n`~/.config/TinyPedal/launcher.conf` with:\n\n```sh\nTINYPEDAL_RUN_ARGS=\"--pyside 6\"\n```\n\nThe installed launcher and desktop entry will read this file automatically. This is mainly useful for ArchLinux where `PySide2` is deprecated.\n\n### Known issues\n\n- Some features may not be available on Linux currently.\n- Widgets don't appear over the game window in KDE. Workaround: enable `Bypass Window Manager` option in `Compatibility` dialog from `Config` menu in main window.\n- Transparency of widgets doesn't work when desktop compositing is disabled. Workaround: enable `window manager compositing` in your Desktop Environment.\n\n## Contributing\n\nPlease follow [Contributing Guidelines](CONTRIBUTING.md) for how to report issue, request feature, or contribute code.\n\n## License\n\nCopyright (C) 2022-2026 TinyPedal developers\n\nTinyPedal is free software and licensed under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. TinyPedal is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY. See [LICENSE.txt](./LICENSE.txt) for more info.\n\nTinyPedal icon, as well as image files located in `images` folder, are licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).\n\nLicenses and notices file for third-party software are located in `docs\\licenses` folder, see [THIRDPARTYNOTICES.txt](./docs/licenses/THIRDPARTYNOTICES.txt) file for details.\n\n## Credits\n\nSee [docs\\contributors.md](./docs/contributors.md) file for full list of developers and contributors.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTinyPedal%2FTinyPedal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTinyPedal%2FTinyPedal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTinyPedal%2FTinyPedal/lists"}