summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9b6a1ed
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# fhvkov - horizon 6 vulkan overlay
+
+![https://i.imgur.com/irrzMPc.gif](https://i.imgur.com/irrzMPc.gif)
+
+![https://i.imgur.com/3NBxetQ.png](https://i.imgur.com/3NBxetQ.png)
+
+## !! THIS SOFTWARE IS LINUX ONLY !!
+
+## installing
+
+1. run attached install.sh script
+2. prepend FHVKOV=1 to your horizon 6 launch options in steam
+3. enjoy!
+
+## features
+
+1. boost gauge
+ - boost gauge values are adjusted based on current vehicle max boost value
+2. adaptive rpm
+ - redline automatically adjusts based on max reached rpm (adjustable offset)
+3. tire temperature display
+4. adjustable motion blur
+5. auto-hide in menus
+
+## configuration
+
+config file in ~/.config/fhvkov/fhvkov.conf
+
+config is hot-reloaded, so it can be edited in-game.
+