https://github.com/racing-telemetry/f1-cli
A helper CLI for broadcasting and recording F1 game data
https://github.com/racing-telemetry/f1-cli
f1 f1-2021 f1-dump
Last synced: 5 months ago
JSON representation
A helper CLI for broadcasting and recording F1 game data
- Host: GitHub
- URL: https://github.com/racing-telemetry/f1-cli
- Owner: racing-telemetry
- License: apache-2.0
- Created: 2022-01-24T20:03:04.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-10T13:48:06.000Z (about 4 years ago)
- Last Synced: 2024-06-20T05:09:40.250Z (about 2 years ago)
- Topics: f1, f1-2021, f1-dump
- Language: Go
- Homepage:
- Size: 77.1 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
F1 CLI
A helper CLI for broadcasting and recording F1 game data
## Table of Contents
- [F1 CLI](#f1-cli)
- [Introduction](#introduction)
- [Installation](#installation)
- [Go](#go)
- [Homebrew](#homebrew)
- [Quick Start](#quick-start)
- [Recording](#recording)
- [Broadcasting](#broadcasting)
## Introduction
We made this tool thinking that we could take the F1 game data from UDP and simulate that race or laps again using this
data.
## Installation
### Go
If you have Go 1.17+, you can directly install by running:
```shell
$ go install github.com/racing-telemetry/f1-dump@latest
```
and the resulting binary will be placed at **_$HOME/go/bin/f1_**.
### Homebrew
If you have brew installed, then you can easily download this with the following commands:
```shell
brew tap racing-telemetry/homebrew-tap
brew install f1-cli
```
# Quick Start
```shell
$ f1 --help
A helper CLI for broadcasting and recording F1 game data
Usage:
f1 [command]
Available Commands:
broadcast Start broadcasting
completion Generate the autocompletion script for the specified shell
help Help about any command
list List F1 packet types
record Start recording packets from UDP source
version Prints the CLI version
Flags:
-h, --help help for f1
-v, --verbose verbose output
Use "f1 [command] --help" for more information about a command.
```
## Recording
You can record the packets from the F1 game with UDP socket.
```shell
# Default options
$ f1 record
# Specify the output file name
$ f1 record -f f1-cli-out.bin
# Different IP and Port
$ f1 record --ip 192.168.1.41 -p 20777
# Ignore Packets
$ f1 record --ignore 1,2,3,4,5,6
```
## Broadcasting
You can broadcast the data you have recorded with using UDP.
```shell
# Recorded binary file
$ f1 broadcast -f f1-cli-out.bin
# Ignore Packets
$ f1 broadcast -f f1-cli-out.bin --ignore 1,2,3,4,5,6
# Broadcast all files instantly
$ f1 broadcast -f f1-cli-out.bin -i
# Different IP and Port
$ f1 broadcast -f f1-cli-out.bin --ip 192.168.1.41 -p 20777
```