<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - fork/m-overlay @ gui</title>
<meta name="description" content="README.md in fork/m-overlay at gui.">
<meta property="og:title" content="README.md - fork/m-overlay @ gui">
<meta property="og:description" content="README.md in fork/m-overlay at gui.">
<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="gui" data-tip="650c9b173a3b362944d79451791f4d77e01d8ab6">
<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>fork/m-overlay</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/m-overlay</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">blackops7799</span><span class="commit-message" data-commit="b997d8f65bf77858931224f9f7c306889898bcb8">Fancy GIF of it working</span><span class="snapshot-sha sha" data-commit="b997d8f65bf77858931224f9f7c306889898bcb8">b997d8f</span><time datetime="2019-06-12T21:47:01-04:00" title="2019-06-12 21:47:01 -0400">2019-06-12</time></p>
<header class="topbar"><details class="switcher"><summary>gui</summary><div class="menu"><strong>branches</strong><a href="/fork/m-overlay/ref/GUI/">GUI</a><a class="current" href="/fork/m-overlay/ref/gui/">gui</a><a href="/fork/m-overlay/ref/main/">main</a><a href="/fork/m-overlay/ref/master/">master</a><a href="/fork/m-overlay/ref/settings-overhaul/">settings-overhaul</a><strong>tags</strong><a href="/fork/m-overlay/ref/v2.1.1/">v2.1.1</a><a href="/fork/m-overlay/ref/v2.1.1a/">v2.1.1a</a><a href="/fork/m-overlay/ref/v2.1.1b/">v2.1.1b</a><a href="/fork/m-overlay/ref/v2.1.2/">v2.1.2</a><a href="/fork/m-overlay/ref/v2.1.3/">v2.1.3</a><a href="/fork/m-overlay/ref/v2.1.4/">v2.1.4</a><a href="/fork/m-overlay/ref/v2.1.5/">v2.1.5</a><a href="/fork/m-overlay/ref/v2.1.6/">v2.1.6</a><a class="all" href="/fork/m-overlay/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/m-overlay/">m-overlay</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>1013 B</span><span>20 lines</span></span><span class="actions"><a class="raw" href="/fork/m-overlay/raw/5e25eb5097b88c541882104c6fda9e8bc44e8cab/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>m-overlay</h1>
<p><img src="https://giant.gfycat.com/HandmadeBeautifulLamb.gif" alt="Image of M&#39;Overlay" /></p>
<h3>Usage</h3>
<p>This program hooks into Dolphin and reads from memory to show a players inputs. This could be an alternative to Nintendo-Spy for those who don't have the technical prowess of setting up an Arduino.</p>
<p>Currently this program will only work on Melee v1.02 (NTSC), but should work on any ANY version of dolphin.</p>
<p>To use with OBS, add a "Game Capture" source and use "capture specific window" "[M'Overlay.exe]"
and be sure to check "Allow Transparency"</p>
<h3>Why?</h3>
<p>This is the start of a bigger project to make a fully customizable stream overlay. I plan on making a fully customizable overlay system to show different elements of the game, like percents, stocks, game time, an off camera minimap (like Smash Ultimate), APM meters, controller inputs, and much more. The plan is to have a plugin system for people to script their own overlay elements.</p>
<p>Example..</p>
<p><img src="https://i.imgur.com/wzRoxcD.png" alt="M&#39;Overlay Future Plans" /></p>
</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>m-overlay</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">![Image of M&#39;Overlay](https://giant.gfycat.com/HandmadeBeautifulLamb.gif)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</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="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">This program hooks into Dolphin and reads from memory to show a players inputs. This could be an alternative to Nintendo-Spy for those who don&#39;t have the technical prowess of setting up an Arduino.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">Currently this program will only work on Melee v1.02 (NTSC), but should work on any ANY version of dolphin.</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">To use with OBS, add a &quot;Game Capture&quot; source and use &quot;capture specific window&quot; &quot;[M&#39;Overlay.exe]&quot;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">and be sure to check &quot;Allow Transparency&quot;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>###</a-p> <a-tt>Why?</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">This is the start of a bigger project to make a fully customizable stream overlay. I plan on making a fully customizable overlay system to show different elements of the game, like percents, stocks, game time, an off camera minimap (like Smash Ultimate), APM meters, controller inputs, and much more. The plan is to have a plugin system for people to script their own overlay elements.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">Example..</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">![M&#39;Overlay Future Plans](https://i.imgur.com/wzRoxcD.png)</span></span></pre></div></div>
</main>
</body>
</html>
