hodasemi/rFactor2_vk_hud
1
0
Fork 0
Code Issues 2 Pull requests 1 Actions Projects Releases 1 Wiki Activity
rFactor2_vk_hud/README.md
hodasemi b381d6686d Update README
2023-01-18 12:00:30 +01:00

1.9 KiB
Raw Blame History

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 (enabled on in race)
  • Radar
  • Pedals

How to enable

Archlinux based

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

Manual installation

  1. Build this repository cargo build --release
  2. Change the path where the libvk_layer_rs.so is located (library_path parameter in the rFactorOverlay.json file)
  3. 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)

Resources

Vulkan Layer

rFactor2 Shared Memory