https://github.com/teamjorge/ibt

iRacing telemetry parsing and processing
https://github.com/teamjorge/ibt

go golang ibt iracing iracing-telemetry simracing telemetry

Last synced: 4 months ago
JSON representation

iRacing telemetry parsing and processing

• Host: GitHub
• URL: https://github.com/teamjorge/ibt
• Owner: teamjorge
• License: apache-2.0
• Created: 2024-08-16T06:42:28.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-23T19:22:14.000Z (over 1 year ago)
• Last Synced: 2025-02-12T09:15:53.667Z (over 1 year ago)
• Topics: go, golang, ibt, iracing, iracing-telemetry, simracing, telemetry
• Language: Go
• Homepage:
• Size: 258 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# ibt

    iRacing Telemetry parsing and processing library

![ibt logo](assets/ibt_mascot.png)

[![Go Reference](https://pkg.go.dev/badge/github.com/teamjorge/ibt.svg)](https://pkg.go.dev/github.com/teamjorge/ibt)

[![Go Report Card](https://goreportcard.com/badge/github.com/teamjorge/ibt)](https://goreportcard.com/report/github.com/teamjorge/ibt)

[![codecov](https://codecov.io/gh/teamjorge/ibt/branch/main/graph/badge.svg?token=08QVKSEPXT)](https://codecov.io/gh/teamjorge/ibt)

## Install

`go get github.com/teamjorge/ibt`

## Overview

`ibt` is a package from parsing iRacing telemetry files. An *ibt* file is created when you enter the car and ends when you exit the car. By default, you can find these files in your `iRacing/telemetry/[car]/` directory. These files are binary for the most part, with the exception of the session data.

This package will not parse real-time telemetry as that requires opening a memory-mapped file and CGO. A planned real-time parsing package leverage `ibt` will be available in the future.

## Features

* Easy to use telemetry tick processing interface.

* Quick parsing of file metadata.

* Grouping of *ibt* files into the sessions where they originate from.

* Great test coverage and code documentation.

* Freedom to use it your own way. Most functions/methods has been made public.

## Examples

The [Examples](https://github.com/teamjorge/ibt/tree/main/examples) directory houses all of the available examples.

To try these examples locally, please clone to repository:

```shell

git clone https://github.com/teamjorge/ibt

#or

git clone git@github.com:teamjorge/ibt.git

```

Please have a look at the instructions in the examples [`README`](./examples/README.md) for details on how to run each example.