https://github.com/nowrep/obs-vkcapture

OBS Linux Vulkan/OpenGL game capture
https://github.com/nowrep/obs-vkcapture

linux obs-studio opengl vulkan

Last synced: 30 days ago
JSON representation

OBS Linux Vulkan/OpenGL game capture

• Host: GitHub
• URL: https://github.com/nowrep/obs-vkcapture
• Owner: nowrep
• License: gpl-2.0
• Created: 2021-03-21T15:04:08.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-18T08:49:17.000Z (4 months ago)
• Last Synced: 2024-08-01T03:21:07.422Z (3 months ago)
• Topics: linux, obs-studio, opengl, vulkan
• Language: C
• Homepage:
• Size: 645 KB
• Stars: 508
• Watchers: 11
• Forks: 25
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OBS Linux Vulkan/OpenGL game capture

OBS plugin for Vulkan/OpenGL game capture on Linux.

AUR: [obs-vkcapture-git](https://aur.archlinux.org/packages/obs-vkcapture-git/)

**Flatpak:**

* OBS plugin: [com.obsproject.Studio.Plugin.OBSVkCapture](https://github.com/flathub/com.obsproject.Studio.Plugin.OBSVkCapture)

* Capture tools: [org.freedesktop.Platform.VulkanLayer.OBSVkCapture](https://github.com/flathub/org.freedesktop.Platform.VulkanLayer.OBSVkCapture)

## About Flatpak

If you use Flatpak OBS, you need to install Flatpak *OBS plugin*.  

If you use Flatpak Steam, you need to install Flatpak *Capture tools* to be able to capture games running inside Flatpak Steam runtine.

For capturing games outside Flatpak runtime, you need native build regardless of if you are using Flatpak OBS or not.

## Dependencies

* cmake

* libobs

* libvulkan

* libgl

* libegl

* libX11 (optional)

* libxcb (optional)

* libwayland-client (optional)

* wayland-scanner (optional)

## Building

    mkdir build && cd build

    cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release ..

    make && make install

## Usage

1. Add `Game Capture` to your OBS scene.

2. Start the game with capture enabled `obs-gamecapture %command%`.

3. (Recommended) Start the game with only Vulkan capture enabled `env OBS_VKCAPTURE=1 %command%`.

## Troubleshooting

**NVIDIA**

Driver version >= 515.43.04 and `nvidia-drm.modeset=1` kernel parameter are required. In Wayland session make sure OBS is running on Wayland and not XWayland.