summaryrefslogtreecommitdiffstats
path: root/games/vkBasalt/README
diff options
context:
space:
mode:
Diffstat (limited to 'games/vkBasalt/README')
-rw-r--r--games/vkBasalt/README53
1 files changed, 53 insertions, 0 deletions
diff --git a/games/vkBasalt/README b/games/vkBasalt/README
new file mode 100644
index 0000000000..cad10cf339
--- /dev/null
+++ b/games/vkBasalt/README
@@ -0,0 +1,53 @@
+vkBasalt is a Vulkan post processing layer to enhance the visual
+graphics of games.
+
+Currently, the build in effects are:
+
+• Contrast Adaptive Sharpening
+• Denoised Luma Sharpening
+• Fast Approximate Anti-Aliasing
+• Enhanced Subpixel Morphological Anti-Aliasing
+• 3D color LookUp Table
+
+It is also possible to use Reshade Fx shaders.
+
+USAGE:
+
+Enable the layer with the environment variable.
+Standard
+
+When using the terminal or an application (.desktop) file, execute:
+
+ENABLE_VKBASALT=1 yourgame
+
+Lutris
+
+With Lutris, follow these steps below:
+
+Right click on a game, and press configure.
+Go to the System options tab and scroll down to Environment variables.
+Press on Add, and add ENABLE_VKBASALT under Key, and add 1 under Value.
+
+Steam
+
+With Steam, edit your launch options and add:
+
+ENABLE_VKBASALT=1 %command%
+
+Configure
+
+Settings like the CAS sharpening strength can be changed in the
+config file. The config file will be searched for in the following
+locations:
+
+a file set with the environment
+variableVKBASALT_CONFIG_FILE=/path/to/vkBasalt.conf
+vkBasalt.conf in the working directory of the game
+$XDG_CONFIG_HOME/vkBasalt/vkBasalt.conf or
+~/.config/vkBasalt/vkBasalt.conf if XDG_CONFIG_HOME is not set
+$XDG_DATA_HOME/vkBasalt/vkBasalt.conf or
+~/.local/share/vkBasalt/vkBasalt.conf if XDG_DATA_HOME is not set
+/etc/vkBasalt.conf
+/etc/vkBasalt/vkBasalt.conf
+/usr/share/vkBasalt/vkBasalt.conf
+