Asking for help properly - Pahheb/lsfg-vk GitHub Wiki

If you're encountering any issue with lsfg-vk, follow this guide to report your findings properly.
It doesn't help if you say "it doesn't work" or "this is broken". You need to provide as much information as possible.

First, you will need to get a debug build. Read through the installation guide if you somehow haven't yet. Your build command should look something like this:

$ cmake -B build -G Ninja \
    -DCMAKE_BUILD_TYPE=Debug \
    -DCMAKE_INSTALL_PREFIX=~/.local
$ cmake --build build
$ cmake --install build

Second, you should install the Vulkan Validation Layers. Depending on your Linux distro the command for this might vary:

# on Arch Linux-based systems 
sudo pacman -S vulkan-validation-layers
# on Ubuntu
sudo apt install vulkan-validationlayers
# on Fedora
sudo dnf install vulkan-validation-layers
# on NixOS (temporary)
nix-shell -p vulkan-validation-layers

Now let's enable the debug logging. You can do this by setting the following environment variables:

  • VK_INSTANCE_LAYERS=VK_LAYER_KHRONOS_validation
  • VK_LOADER_DEBUG=all
  • LSFG_LOG_DEBUG=all

Please note that this will produce A LOT of debug information. Keep your session short!

If you're running the game from your command line, you might want to write the output to a file, rather than just the console. Add 2>&1 | tee output.log to your command and add LSFG_LOG_FILE=output.log to the start of it. Your command should look something like this:

LSFG_LOG_FILE=output.log ... <your app> 2>&1 | tee output.log

This will produce two log files, one under output.log and one under xxxx_output.log

If you're running on Steam, you should clear the log file before starting the app and don't need to specify the option above:

$ truncate -s 0 ~/.steam/steam/logs/console-linux.txt
# then launch the game from the menu

Send both output.log or the console-linux.txt alongside your other findings.

Include all the information about your environment:

  1. What Linux distro are you on?
  2. How familiar are you with Linux? (Let us know if you're a newcomer!)
  3. How did you obtain the liblsfg-vk.so file? How did you compile it?
  4. Are you running the game through Steam? Have you tried running it without Steam from the command line?
  5. Is the game running natively on Linux or in Proton? (Is it a Windows game, or does it have a Linux version?)
  6. Are you using gamescope?

Detail exactly what you're encountering. Attach photos and videos if possible. Tell us if it worked before.
If you've done all that, send your message and wait patiently, I'm extremely busy! <3

⚠️ **GitHub.com Fallback** ⚠️