No description

Find a file

RenovateBot 0fa5cb55c8 All checks were successful Gavania Merge Build / build (pull_request) Successful in 9m42s Details Update Rust crate anyhow to 1.0.80		2024-02-20 02:06:03 +00:00
.gitea/workflows	.gitea/workflows/pull_request.yaml aktualisiert	2023-08-16 10:07:33 +02:00
.vscode	Add actions file	2023-08-16 09:05:59 +02:00
resources	Add application info workaround	2023-02-21 19:23:10 +01:00
src	Fix overlay	2023-12-06 13:53:31 +01:00
.gitignore	Add texture generator	2023-01-20 16:08:14 +01:00
build.rs	Add texture generator	2023-01-20 16:08:14 +01:00
Cargo.toml	Update Rust crate anyhow to 1.0.80	2024-02-20 02:06:03 +00:00
README.md	Update pkgbuild path in readme	2023-01-23 20:13:14 +01:00
renovate.json	Add renovate.json	2023-01-11 02:01:33 +01:00

README.md

Vulkan rFactor2 HUD

This project is an attempt to render custom HUD elements for rFactor2 by being a Vulkan layer.

Current state

I would consider the following elements as working:

Leader Board
Delta Board (shows intervals between driver next to you (2 before and 2 behind you))
Radar
Pedals

How to enable

Archlinux based

Simply use the PKGBUILD from the resources/pkgbuild directory (How to use it)

Manual installation

Build this repository cargo build --release
Change the path where the libvk_layer_rs.so is located (library_path parameter in the rFactorOverlay.json file)
Put the rFactorOverlay.json into a layer directory (layer directories)

Add RFACTOR_HUD=1 to steam launch command (example: RFACTOR_HUD=1 %command%)

A config file is generated the first time you start it at: $HOME/.config/rFactorHUD/config.json

Requirement

You need to have rFactor2 memory plugin shared file enabled (rF2SharedMemoryMapPlugin_Wine)

Debugging

Add RFACTOR_HUD_LOG=1 to the launch options of the game. Then a file log file will be created ($HOME/rf2_vk_hud.log). The logs may seem super random and they are super random, since I didn't have (or took) the time to unify my logging output. I would not recommend to activate logging while playing a longer session, it can get quite big (about 15 minutes are roundabout 1 million lines).