flathub / flathub/org.freedesktop.Platform.VulkanLayer.vkBasalt

The readme needs to be improved

Open Beginner friendly
#13 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
13
Forks
0
PR merge metrics
No merged PRs in 30d

Description

To setup vkbasalt properly the user needs to give the application (e.g. Steam) reading rights to the shader directory and access to the vkBasalt.conf.
This should be better comunicated in the README.md

Solutions would be running commands like:
```shell
flatpak override com.valvesoftware.Steam --filesystem=~/.local/share/reshade
flatpak override com.valvesoftware.Steam --filesystem=xdg-config/vkBasalt:ro
```
Or adding those entries via Flatseal:
![image](https://user-images.githubusercontent.com/21966966/229990140-3c7f65da-799f-4667-a59b-2395db7b57a1.png)

Maybe there are better solutions to make vkbasalt work but this is what I had to do with steam.
Other applications may have already reading rights to the home directory but steam has some issues when given access to
```home:ro```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading README.md and checking its setup instructions against the reported Steam and Flatpak permissions. Done means documenting the required shader-directory and vkBasalt.conf access, including the shown override commands or Flatseal steps, while noting the home:ro limitation.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.