Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README.md and vkBasalt.conf #196

Open
wants to merge 24 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
b14fc11
Fix typos, improve look, reorganize etc. README.md
Kazevic Sep 21, 2022
17bd9a9
Shorten description in README.md
Kazevic Sep 21, 2022
21c12d9
Add a space in REAMDE.md
Kazevic Sep 24, 2022
e8e01db
Add more and improve explanations and fix typos in vkBasalt.conf
Kazevic Sep 24, 2022
9f9fb4b
Restore fxaaQualityEdgeThresholdMin
Kazevic Oct 25, 2022
7ae6c90
Remove excessive spacing after toggleKey
Kazevic Oct 25, 2022
6b9d2be
Capitalize S and add spacing between the # and Supported in lutFile
Kazevic Oct 25, 2022
a21206a
Add suggested values for fxaaQualityEdgeThreshold
Kazevic Oct 25, 2022
d3d3872
Update README.md to comply with the latest version
Kazevic Dec 14, 2022
71ad5ff
Add some comas
Kazevic Jan 3, 2023
b9c0a38
Merge branch 'master' into patch-1
Kazevic Jan 3, 2023
84f67d1
Shorten some sentences and make other sentences more natural
Kazevic Jan 3, 2023
f68c316
Minor adjustment to improve consistency
Kazevic Jan 3, 2023
98d4931
Minor adjustment
Kazevic Jan 4, 2023
03dba82
Improve vkBasalt.conf consistency
Kazevic Jan 4, 2023
fa095fd
Added minimum and maximum values for fxaaQualityEdgeThresholdMin and …
Kazevic Feb 7, 2023
76f63cd
Improve the descriptions for some effects and fix typos
Kazevic Feb 8, 2023
9c881be
Improve the wording
Kazevic Feb 8, 2023
32e949d
Improved the wording and fixed some typos
Kazevic Feb 8, 2023
29082dc
Improved the wording (again)
Kazevic Feb 8, 2023
37094f2
Merge branch 'DadSchoorse:master' into patch-1
Kazevic Mar 22, 2023
9b8fdc8
Minor FIxes to Formatting
Kazevic Mar 22, 2023
caa72b8
Merge branch 'master' into patch-1
Kazevic Apr 15, 2023
618d248
Merge branch 'DadSchoorse:master' into patch-1
Kazevic Jun 29, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Shorten some sentences and make other sentences more natural
  • Loading branch information
Kazevic authored Jan 3, 2023
commit 84f67d1e0837bbd4bd5a8eb50fcbeaa0b824958b
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ Enable the layer with the environment variable.

### Lutris
Follow these steps with Lutris:
1. Right-click on a game and click on `Configure`.
1. Right-click a game and click on `Configure`.
2. Go to the `System options` tab and scroll down to `Environment variables`.
3. Click on `Add` and add `ENABLE_VKBASALT` under `Key` and `1` under `Value`.
3. Click `Add` and add `ENABLE_VKBASALT` under `Key` and `1` under `Value`.

### Standard
When using the terminal or an application (.desktop) file, run:
Expand Down Expand Up @@ -62,7 +62,7 @@ The config file will be searched for in the locations:
You can create a file named `vkBasalt.conf` in the game's working directory and change the values there if you want to make changes for only one game.

### ReShade FX shaders
You need to set `reshadeTexturePath` and `reshadeIncludePath` to the matching directories from the repository to run ReShade FX shaders, e.g., shaders from the [ReShade repository](https://github.com/crosire/reshade-shaders). You need to set a custom effect name to the shader path then add that effect name to `effects` like every other effect to use a specific shader.
You must set `reshadeTexturePath` and `reshadeIncludePath` to the matching directories from the repository to run ReShade FX shaders, like shaders from the [ReShade repository](https://github.com/crosire/reshade-shaders). You must set a custom effect name to the shader path then add that effect name to `effects` like every other effect to use a specific shader.
```ini
effects = colorfulness:denoise

Expand All @@ -73,12 +73,12 @@ reshadeIncludePath = /home/user/reshade-shaders/Shaders
```

### Ingame input
The [Home key](https://en.wikipedia.org/wiki/Home_key) can be used to disable and re-enable the applied effects. The key can also be changed in the config file. It will not work on pure Wayland; it is based on X11. But it **should** not crash without X11.
The [Home key](https://en.wikipedia.org/wiki/Home_key) can be used to toggle the applied effects on and off. The key can also be changed in the config file. It will not work on pure Wayland; it is based on X11. But it **should** not crash without X11.

### Debug output
The amount of debug output can be set with the `VKBASALT_LOG_LEVEL` env var, e.g., `VKBASALT_LOG_LEVEL=debug`. Valid values are: `trace, debug, info, warn, error, none`.
The amount of debug output can be set with the `VKBASALT_LOG_LEVEL` environment variable, like `VKBASALT_LOG_LEVEL=debug`. Valid values are: `trace, debug, info, warn, error, none`.

The logger outputs to stderr by default. A file as output location can be set with the `VKBASALT_LOG_FILE` env var, e.g., `VKBASALT_LOG_FILE="vkBasalt.log"`.
The logger outputs to stderr by default. A file as output location can be set with the `VKBASALT_LOG_FILE` environment variable, like `VKBASALT_LOG_FILE="vkBasalt.log"`.

## Building from source

Expand All @@ -91,16 +91,16 @@ Before building, you will need:
- X11 development files

### Building
These instructions use `--prefix=/usr` that is generally not recommended; vkBasalt will be installed in directories that are meant for the package manager. An alternative is not setting the prefix, so it will be installed in `/usr/local`. But you need to ensure the `ld` finds the library; /usr/local is probably not in the default path.
These instructions use `--prefix=/usr`, that is not recommended in general; vkBasalt will be installed in directories that are meant for the package manager. An alternative is not setting the prefix, so it will be installed in `/usr/local`. But you musto ensure the `ld` finds the library; /usr/local is probably not in the default path.

Prefer to use distro-provided packages generally.
Prefer to use distro-provided packages in general.
```
git clone https://github.com/DadSchoorse/vkBasalt.git
cd vkBasalt
```

#### 32-bit
Ensure the `PKG_CONFIG_PATH=/usr/lib32/pkgconfig` and `--libdir=lib32` are right for your distro and change them if needed. E.g., You need to replace `lib32` by `lib/i386-linux-gnu` on Debian-based distros.
Ensure the `PKG_CONFIG_PATH=/usr/lib32/pkgconfig` and `--libdir=lib32` are right for your distro and change them if needed. E.g., you must replace `lib32` by `lib/i386-linux-gnu` on Debian-based distros.
```
ASFLAGS=--32 CFLAGS=-m32 CXXFLAGS=-m32 PKG_CONFIG_PATH=/usr/lib32/pkgconfig meson setup --prefix=/usr --buildtype=release --libdir=lib32 -Dwith_json=false builddir.32
ninja -C builddir.32 install
Expand Down