From b381d6686d020bd2da6ae35cdbb4a3bfde802a62 Mon Sep 17 00:00:00 2001 From: hodasemi Date: Wed, 18 Jan 2023 12:00:30 +0100 Subject: [PATCH] Update README --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7dced95..8d702f0 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,31 @@ This project is an attempt to render custom HUD elements for rFactor2 by being a Vulkan layer. # Current state -I just started doing it. That means it isn't very usable right now. I'm working on a radar right now as the first element. +I would consider the following elements as working: + +* Leader Board (enabled on in race) +* Radar +* Pedals # How to enable -* 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](https://vulkan.lunarg.com/doc/view/1.3.216.0/mac/loader_and_layer_interface.html#user-content-linux-layer-discovery)) + +### Archlinux based +Simply use the PKGBUILD from the pkgbuild directory ([How to use it](https://wiki.archlinux.org/title/Makepkg)) + +### 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](https://vulkan.lunarg.com/doc/view/1.3.216.0/mac/loader_and_layer_interface.html#user-content-linux-layer-discovery)) + +--- + * 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](https://github.com/schlegp/rF2SharedMemoryMapPlugin_Wine)) + # Resources ## Vulkan Layer