<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - +/obs-gamepad @ main</title>
<meta name="description" content="README.md in +/obs-gamepad at main.">
<meta property="og:title" content="README.md - +/obs-gamepad @ main">
<meta property="og:description" content="README.md in +/obs-gamepad at main.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="main" data-tip="8201fe79551ac3c473db9cec1ef068f02606e815">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>+/obs-gamepad</h1>
<p class="desc">overlay to display inputs</p>
</div>
<pre class="clone">git clone https://git.julia.blue/+/obs-gamepad</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Julia Ryan</span><span class="commit-message" data-commit="79b76e0a030f8d5eac96c88d6d5e66d0867c53ed">Fix windows serial</span><span class="snapshot-sha sha" data-commit="79b76e0a030f8d5eac96c88d6d5e66d0867c53ed">79b76e0</span><time datetime="2025-10-01T01:32:24-07:00" title="2025-10-01 01:32:24 -0700">2025-10-01</time></p>
<header class="topbar"><details class="switcher"><summary>main</summary><div class="menu"><strong>branches</strong><a class="current" href="/%2B/obs-gamepad/ref/main/">main</a><a class="all" href="/%2B/obs-gamepad/refs">all refs →</a></div></details><nav class="crumbs"><a href="/%2B/obs-gamepad/">obs-gamepad</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>2.4 KiB</span><span>58 lines</span></span><span class="actions"><a class="raw" href="/%2B/obs-gamepad/raw/041b2570696c93ec85e130987841f22d946c43d2/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>OBS Gamepad Plugin</h1>
<p>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
<a href="https://gamepadviewer.com">https://gamepadviewer.com</a>, and <a href="https://github.com/univrsal/input-overlay">input-overlay</a>
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.</p>
<table><thead><tr><th>celeste</th><th>melee</th></tr></thead><tbody>
<tr><td>&lt;video src="https://github.com/user-attachments/assets/b3164361-9b0e-4bd0-a1eb-2e8e89ed3d3c"&gt;</td><td>&lt;video src="https://github.com/user-attachments/assets/8be063a2-31be-4124-9007-64da3ac5f33b"&gt;</td></tr>
</tbody></table>
<h2>Installation</h2>
<h3>Windows</h3>
<p>Download the <a href="https://github.com/P1n3appl3/obs-gamepad/releases/latest">latest release</a> and then <a href="https://obsproject.com/kb/plugins-guide#install-or-remove-plugins">follow these instructions</a> to copy it into your OBS plugins directory.</p>
<h3>Nix</h3>
<p>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:</p>
<pre class="language-nix"><a-v>programs</a-v><a-p>.</a-p><a-v>obs-studio</a-v> <a-p>=</a-p> <a-p>{</a-p> <a-v>enable</a-v> <a-p>=</a-p> <a-v>true</a-v><a-p>;</a-p>
  <a-v>plugins</a-v> <a-p>=</a-p> <a-k>with</a-k> <a-v>pkgs</a-v><a-p>.</a-p><a-v>obs-studio-plugins</a-v><a-p>;</a-p> <a-p>[</a-p> <a-v>obs-gamepad</a-v> <a-p>];</a-p>
<a-p>};</a-p></pre>
<p>If you don't use flakes or home-manager, you can use flake-compat and manually override the OBS wrapper to add the plugin:</p>
<pre class="language-nix"><a-v>pkgs</a-v><a-p>.</a-p><a-v>wrapOBS</a-v><a-p>.</a-p><a-v>override</a-v> <a-p>{}</a-p> <a-p>{</a-p> <a-v>plugins</a-v> <a-p>=</a-p> <a-p>[</a-p> <a-v>obs-gamepad</a-v> <a-p>];</a-p> <a-p>};</a-p></pre>
<h3>Other Linux Distros</h3>
<p>Run <a href="/%2B/obs-gamepad/ref/main/blob/install.sh"><code>install.sh</code></a> (which is just <code>cargo build</code> + moving the files around). If you want to write a PKGBUILD/deb/rpm/etc. for your distro, just take a look in <a href="/%2B/obs-gamepad/ref/main/blob/flake.nix">flake.nix</a> for the required native deps.</p>
<h2>Usage</h2>
<p>Check out <a href="/%2B/obs-gamepad/ref/main/blob/layouts/example.toml">the example</a> to see the config options.</p>
<p>You don't have to open OBS to tweak your config, just
<code>cargo run &lt;my-config.toml&gt;</code> 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.</p>
<h2>Future plans</h2>
<ul>
<li>stick tilt distortion</li>
<li>backend to read dolphin memory like <a href="https://github.com/bkacjios/m-overlay">m-overlay</a>
<ul>
<li>will need additional button config for arbitrary bezier paths</li>
<li>octagonal gate option</li>
</ul>
</li>
<li>keyboard backend?</li>
<li>pass through info about whether or not a backend is connected and render that somehow</li>
<li>button labels? at that point maybe just add these backends to input-overlay instead...</li>
</ul>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>OBS Gamepad Plugin</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">I wanted to display my controller inputs while speedrunning celeste (and later</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">while playing melee), and I just wanted to draw some transparent shapes for</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">the buttons. I didn&#39;t want to set up a browser capture for something like</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">&lt;https://gamepadviewer.com&gt;, and [input-overlay](https://github.com/univrsal/input-overlay)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">was a bit complicated for my use case (though if I ever wanted more features</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">it seems really cool and customizable), so I just wrote a little plugin to do</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">it myself.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">celeste | melee</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">--|--</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">&lt;video src=&quot;https://github.com/user-attachments/assets/b3164361-9b0e-4bd0-a1eb-2e8e89ed3d3c&quot;&gt; | &lt;video src=&quot;https://github.com/user-attachments/assets/8be063a2-31be-4124-9007-64da3ac5f33b&quot;&gt;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>##</a-p> <a-tt>Installation</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>###</a-p> <a-tt>Windows</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">Download the [latest release](https://github.com/P1n3appl3/obs-gamepad/releases/latest) and then [follow these instructions](https://obsproject.com/kb/plugins-guide#install-or-remove-plugins) to copy it into your OBS plugins directory.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>###</a-p> <a-tt>Nix</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">There&#39;s a home-manager module for OBS, so you can use this flake&#39;s overlay to install the plugin like you would any other:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>```</a-p><a-tl>nix</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>programs.</a-p><a-v>obs-studio</a-v><a-p> = { </a-p><a-v>enable</a-v><a-p> = </a-p><a-v>true</a-v><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>  </a-p><a-v>plugins</a-v><a-p> = </a-p><a-k>with</a-k><a-p> </a-p><a-v>pkgs</a-v><a-p>.</a-p><a-v>obs-studio-plugins</a-v><a-p>; [ </a-p><a-v>obs-gamepad</a-v><a-p> ];</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>};</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>If you don&#39;t use flakes or home-manager, you can use flake-compat and manually override the OBS wrapper to add the plugin:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>```</a-p><a-tl>nix</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>pkgs.</a-p><a-v>wrapOBS</a-v><a-p>.</a-p><a-v>override</a-v><a-p> {} { </a-p><a-v>plugins</a-v><a-p> = [ </a-p><a-v>obs-gamepad</a-v><a-p> ]; };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>### </a-p><a-tt>Other Linux Distros</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>Run [`install.sh`](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](flake.nix) for the required native deps.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>## </a-p><a-tt>Usage</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>Check out [the example](layouts/example.toml) to see the config options.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>You don&#39;t have to open OBS to tweak your config, just</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>`cargo run &lt;my-config.toml&gt;` and it&#39;ll show your overlay in a separate window. Both</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>the OBS plugin and the standalone window support live-reloading, so if you tweak</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>your config file and save, the changes should show up in your overlay.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>## </a-p><a-tt>Future plans</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>- stick tilt distortion</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>- backend to read dolphin memory like [m-overlay](https://github.com/bkacjios/m-overlay)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>  - will need additional button config for arbitrary bezier paths</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>  - octagonal gate option</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>- keyboard backend?</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>- pass through info about whether or not a backend is connected and render that somehow</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>- </a-p>button labels? at that point maybe just add these backends to input-overlay instead...</span></span></pre></div></div>
</main>
</body>
</html>
