← back

+/obs-gamepad

overlay to display inputs

git clone https://git.julia.blue/+/obs-gamepad

Julia RyanFix nix warnings8201fe7

main
2 folders11 files

files

layouts/
src/
.envrc10 B
.gitignore8 B
.taplo.toml32 B
Cargo.lock55.7 KiB
Cargo.toml501 B
LICENSE291 B
README.md2.4 KiB
bundle.ps1508 B
flake.lock1.4 KiB
flake.nix1.4 KiB
install.sh483 B

OBS Gamepad Plugin

I wanted to display my controller inputs while speedrunning celeste (and later while playing melee), and I just wanted to draw some transparent shapes for the buttons. I didn't want to set up a browser capture for something like https://gamepadviewer.com, and input-overlay was a bit complicated for my use case (though if I ever wanted more features it seems really cool and customizable), so I just wrote a little plugin to do it myself.

celestemelee
<video src="https://github.com/user-attachments/assets/b3164361-9b0e-4bd0-a1eb-2e8e89ed3d3c"><video src="https://github.com/user-attachments/assets/8be063a2-31be-4124-9007-64da3ac5f33b">

Installation

Windows

Download the latest release and then follow these instructions to copy it into your OBS plugins directory.

Nix

There's a home-manager module for OBS, so you can use this flake's overlay to install the plugin like you would any other:

programs.obs-studio = { enable = true;
  plugins = with pkgs.obs-studio-plugins; [ obs-gamepad ];
};

If you don't use flakes or home-manager, you can use flake-compat and manually override the OBS wrapper to add the plugin:

pkgs.wrapOBS.override {} { plugins = [ obs-gamepad ]; };

Other Linux Distros

Run install.sh (which is just cargo build + moving the files around). If you want to write a PKGBUILD/deb/rpm/etc. for your distro, just take a look in flake.nix for the required native deps.

Usage

Check out the example to see the config options.

You don't have to open OBS to tweak your config, just cargo run <my-config.toml> and it'll show your overlay in a separate window. Both the OBS plugin and the standalone window support live-reloading, so if you tweak your config file and save, the changes should show up in your overlay.

Future plans