hodasemi/rFactor2_vk_hud
1
0
Fork 0
Code Issues 2 Pull requests 1 Projects Releases 1 Wiki Activity Actions

Update README

Browse source
This commit is contained in:
hodasemi 2023-01-18 12:00:30 +01:00
parent f11eef57ac
commit b381d6686d
1 changed files with 19 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -2,16 +2,31 @@
This project is an attempt to render custom HUD elements for rFactor2 by being a Vulkan layer. This project is an attempt to render custom HUD elements for rFactor2 by being a Vulkan layer.
# Current state # 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 # 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) ### Archlinux based
* 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)) 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%`) * 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` 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 # Resources
## Vulkan Layer ## Vulkan Layer