<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>readme.md - fork/slippi-nix @ main</title>
<meta name="description" content="readme.md in fork/slippi-nix at main.">
<meta property="og:title" content="readme.md - fork/slippi-nix @ main">
<meta property="og:description" content="readme.md in fork/slippi-nix 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="795075756c52ed481cd7aed909a1d9fe6dc38aca">
<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/slippi-nix</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/slippi-nix</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Daniel Flanagan</span><span class="commit-message" data-commit="68e971a57de45fb3f2081e837962f2c9b8c34240">Merge pull request #8 from Noodlez1232/main</span><span class="snapshot-sha sha" data-commit="68e971a57de45fb3f2081e837962f2c9b8c34240">68e971a</span><time datetime="2024-09-10T13:52:12-05:00" title="2024-09-10 13:52:12 -0500">2024-09-10</time></p>
<header class="topbar"><details class="switcher"><summary>main</summary><div class="menu"><strong>branches</strong><a href="/fork/slippi-nix/ref/fix-recursion/">fix-recursion</a><a class="current" href="/fork/slippi-nix/ref/main/">main</a><a href="/fork/slippi-nix/ref/remove-trace/">remove-trace</a><a href="/fork/slippi-nix/ref/xdg-mime/">xdg-mime</a><a class="all" href="/fork/slippi-nix/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/slippi-nix/">slippi-nix</a> / <span class="cur">readme.md</span></nav>
<span class="view-stats"><span>5.0 KiB</span><span>143 lines</span></span><span class="actions"><a class="raw" href="/fork/slippi-nix/raw/f295495ecdfdd5ae3f869536ab43739c19c75b8a/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>slippi-nix</h1>
<p><a href="https://github.com/lytedev/slippi-nix/actions/workflows/build-and-cache.yaml"><img src="https://github.com/lytedev/slippi-nix/actions/workflows/build-and-cache.yaml/badge.svg" alt="build status" /></a></p>
<p>This project is a Flake which exposes NixOS modules for ensuring your GameCube
controller adapter is performing as well is it can be and Home Manager modules
for installing and configuring the Slippi Launcher using NixOS-compatible
versions of both the playback and netplay builds of Dolphin (Ishiiruka).</p>
<p><strong>NOTE</strong>: At this time, this Flake only supports the <code>x86_64-linux</code> <code>system</code>
(since it consumes AppImages that support the same). If you are using Linux on
another CPU architecture, please reach out! If you are using macOS, install the
launcher from https://slippi.gg/downloads directly; I don't recommend using Nix
to manage your Slippi installation in that case.</p>
<h1>Usage</h1>
<p>The simplest usage is to simply run the netplay package in this Flake:</p>
<pre class="language-bash"><a-f>nix</a-f> run github:lytedev/slippi-nix#slippi-netplay</pre>
<p>However, for the optimal experience, you will want to ensure the host has the
necessary configuration to handle a GameCube controller adapter. Additionally,
you likely want to make use of the Slippi Launcher for managing and viewing
your replays.</p>
<p>In your flake, you may optionally import the NixOS module for the overclocked
adapter and you must import the Home Manager module for the Slippi Launcher. You
will also need to specify where your Melee ISO is. Here is an example:</p>
<pre class="language-nix"><a-p>{</a-p>
  <a-v>inputs</a-v><a-p>.</a-p><a-v>slippi</a-v><a-p>.</a-p><a-v>url</a-v> <a-p>=</a-p> <a-s>&quot;github:lytedev/slippi-nix&quot;</a-s><a-p>;</a-p>
  <a-v>inputs</a-v><a-p>.</a-p><a-v>nixpkgs</a-v><a-p>.</a-p><a-v>url</a-v> <a-p>=</a-p> <a-s>&quot;...&quot;</a-s><a-p>;</a-p>

  <a-v>outputs</a-v> <a-p>=</a-p> <a-p>{</a-p><a-v>slippi</a-v><a-p>,</a-p> <a-v>nixpkgs</a-v><a-p>,</a-p> ...<a-p>}</a-p>: <a-p>{</a-p>
    <a-v>nixosConfigurations</a-v> <a-p>=</a-p> <a-v>nixpkgs</a-v><a-p>.</a-p><a-v>lib</a-v><a-p>.</a-p><a-v>nixosSystem</a-v> <a-p>{</a-p>
      <a-v>system</a-v> <a-p>=</a-p> <a-s>&quot;...&quot;</a-s><a-p>;</a-p>
      <a-v>modules</a-v> <a-p>=</a-p> <a-p>[</a-p>
        <a-v>slippi</a-v><a-p>.</a-p><a-v>nixosModules</a-v><a-p>.</a-p><a-v>default</a-v>
        <a-p>{</a-p>
          <a-v>home-manager</a-v> <a-p>=</a-p> <a-p>{</a-p>
            <a-c># ... snip -- see Home Manager&#39;s documentation for details</a-c>
            <a-v>users</a-v><a-p>.</a-p><a-v>YOUR_USERNAME</a-v> <a-p>=</a-p> <a-p>{</a-p>
              <a-v>imports</a-v> <a-p>=</a-p> <a-k>with</a-k> <a-v>outputs</a-v><a-p>.</a-p><a-v>homeManagerModules</a-v><a-p>;</a-p> <a-p>[</a-p>
                <a-v>slippi</a-v><a-p>.</a-p><a-v>homeManagerModules</a-v><a-p>.</a-p><a-v>default</a-v>
                <a-p>{</a-p>
                  <a-c># use your path</a-c>
                  <a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>isoPath</a-v> <a-p>=</a-p> <a-s>&quot;/home/user/Downloads/melee.iso&quot;</a-s><a-p>;</a-p>
                <a-p>}</a-p>
              <a-p>];</a-p>
            <a-p>};</a-p>
          <a-p>};</a-p>
        <a-p>}</a-p>
      <a-p>];</a-p>
    <a-p>};</a-p>
  <a-p>};</a-p>
<a-p>}</a-p></pre>
<p>There are other configuration options if you take a look at the flake's source.
Most useful to me is:</p>
<pre class="language-nix"><a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>launchMeleeOnPlay</a-v> <a-p>=</a-p> <a-v>false</a-v><a-p>;</a-p></pre>
<p>As I prefer to be able to tweak Dolphin's settings before diving right in.</p>
<h1>Updates</h1>
<p>Note that this does <em>not</em> support the auto-updates performed by Slippi Launcher.
Instead, when updates are pushed here, you must update your input reference to
this flake and then your system.</p>
<pre>nix flake lock --update-input slippi-nix # use whatever name you gave this flake as input!
sudo nixos-rebuild switch --flake .
</pre>
<p>In the event that this repo is out-of-date and an update was newly pushed out
and you do not want to wait, or you prefer to be in control, this Flake exposes
extra configuration fields for specifying the version of the AppImage you want
along with the hash like so:</p>
<pre class="language-nix"><a-p>{</a-p>
  <a-v>home-manager</a-v><a-p>.</a-p><a-v>users</a-v><a-p>.</a-p><a-v>YOUR_USERNAME</a-v> <a-p>=</a-p> <a-p>{</a-p>
    <a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>netplayVersion</a-v> <a-p>=</a-p> <a-s>&quot;3.4.0&quot;</a-s><a-p>;</a-p>
    <a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>netplayHash</a-v> <a-p>=</a-p> <a-s>&quot;sha256-d1iawMsMwFElUqFmwWAD9rNsDdQr2LKscU8xuJPvxYg=&quot;</a-s><a-p>;</a-p>
    <a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>netplayBetaVersion</a-v> <a-p>=</a-p> <a-s>&quot;4.0.0-mainline-beta.6&quot;</a-s><a-p>;</a-p>
    <a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>netplayBetaHash</a-v> <a-p>=</a-p> <a-s>&quot;sha256-CicAZ28+yiagG3bjosu02azV6XzP7+JnLhUJ3hdeQbI=&quot;</a-s><a-p>;</a-p>
    <a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>playbackVersion</a-v> <a-p>=</a-p> <a-s>&quot;3.4.0&quot;</a-s><a-p>;</a-p>
    <a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>playbackHash</a-v> <a-p>=</a-p> <a-s>&quot;sha256-d1iawMsMwFElUqFmwWAD9rNsDdQr2LKscU8xuJPvxYg=&quot;</a-s><a-p>;</a-p>
  <a-p>};</a-p>
<a-p>}</a-p></pre>
<p>So when a Slippi update is released, you can usually bump the version to match
and update the hash with whatever <code>nix</code> says it is.</p>
<h1>Beta</h1>
<p>You can enable the beta netplay client by adding this to the configuration:</p>
<pre class="language-nix"><a-p>{</a-p>
  <a-v>home-manager</a-v><a-p>.</a-p><a-v>users</a-v><a-p>.</a-p><a-v>YOUR_USERNAME</a-v> <a-p>=</a-p> <a-p>{</a-p>
    <a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>useBetaNetplay</a-v> <a-p>=</a-p> <a-v>true</a-v><a-p>;</a-p>
  <a-p>};</a-p>
<a-p>}</a-p></pre>
<p>The beta netplay client is <em>not</em> downloaded unless it is enabled. When enabled it is set as the default as well.</p>
<h1>Cache</h1>
<p>You may also want to leverage our Cachix binary cache. There isn't <em>much</em>
purpose to it since the "build" steps are just unpacking the AppImages and
repacking them in a format that works with Nix, but they graciously provide one
to us freely.</p>
<pre class="language-nix"><a-v>nixConfig</a-v> <a-p>=</a-p> <a-p>{</a-p>
  <a-v>extra-substituters</a-v> <a-p>=</a-p> <a-p>[</a-p><a-s>&quot;https://slippi-nix.cachix.org&quot;</a-s><a-p>];</a-p>
  <a-v>extra-trusted-public-keys</a-v> <a-p>=</a-p> <a-p>[</a-p><a-s>&quot;slippi-nix.cachix.org-1:2qnPHiOxTRpzgLEtx6K4kXq/ySDg7zHEJ58J6xNDvBo=&quot;</a-s><a-p>];</a-p>
<a-p>};</a-p></pre>
<h1>To Do</h1>
<p>It would be nice if Home Manager weren't strictly necessary. At the moment,
I believe the config file <em>could</em> be created via a NixOS module (using
<code>systemd.tmpfiles.rules</code> or something?), but the ideal scenario would be to
instead either be to specify to the launcher where the netplay and playback
binaries are without the configuration file -- perhaps via command line
arguments or environment variables.</p>
<p>If this were true, you could simply <code>nix run github:lytedev/slippi-nix#netplay</code>
and start playing right away, which is ideal!</p>
<h1>License</h1>
<p>This project is licensed under the <a href="/fork/slippi-nix/ref/main/blob/license">MIT</a> license.</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>slippi-nix</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">[![build status](https://github.com/lytedev/slippi-nix/actions/workflows/build-and-cache.yaml/badge.svg)](https://github.com/lytedev/slippi-nix/actions/workflows/build-and-cache.yaml)</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">This project is a Flake which exposes NixOS modules for ensuring your GameCube</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">controller adapter is performing as well is it can be and Home Manager modules</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">for installing and configuring the Slippi Launcher using NixOS-compatible</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">versions of both the playback and netplay builds of Dolphin (Ishiiruka).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">**NOTE**: At this time, this Flake only supports the `x86_64-linux` `system`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">(since it consumes AppImages that support the same). If you are using Linux on</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">another CPU architecture, please reach out! If you are using macOS, install the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">launcher from https://slippi.gg/downloads directly; I don&#39;t recommend using Nix</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">to manage your Slippi installation in that case.</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"><a-p>#</a-p> <a-tt>Usage</a-tt></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">The simplest usage is to simply run the netplay package in this Flake:</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"><a-p>```</a-p><a-tl>shell</a-tl></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>nix run github:lytedev/slippi-nix#slippi-netplay</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>However, for the optimal experience, you will want to ensure the host has the</a-p></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>necessary configuration to handle a GameCube controller adapter. Additionally,</a-p></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>you likely want to make use of the Slippi Launcher for managing and viewing</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>your replays.</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"></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>In your flake, you may optionally import the NixOS module for the overclocked</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"><a-p>adapter and you must import the Home Manager module for the Slippi Launcher. You</a-p></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>will also need to specify where your Melee ISO is. Here is an example:</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>{</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><a-v>inputs</a-v><a-p>.</a-p><a-v>slippi</a-v><a-p>.</a-p><a-v>url</a-v><a-p> = </a-p><a-s>&quot;github:lytedev/slippi-nix&quot;</a-s><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"><a-p>  </a-p><a-v>inputs</a-v><a-p>.</a-p><a-v>nixpkgs</a-v><a-p>.</a-p><a-v>url</a-v><a-p> = </a-p><a-s>&quot;...&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>  </a-p><a-v>outputs</a-v><a-p> = {</a-p><a-v>slippi</a-v><a-p>, </a-p><a-v>nixpkgs</a-v><a-p>, ...}: {</a-p></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>    </a-p><a-v>nixosConfigurations</a-v><a-p> = </a-p><a-v>nixpkgs</a-v><a-p>.</a-p><a-v>lib</a-v><a-p>.</a-p><a-v>nixosSystem</a-v><a-p> {</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"><a-p>      </a-p><a-v>system</a-v><a-p> = </a-p><a-s>&quot;...&quot;</a-s><a-p>;</a-p></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-v>modules</a-v><a-p> = [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>        </a-p><a-v>slippi</a-v><a-p>.</a-p><a-v>nixosModules</a-v><a-p>.</a-p><a-v>default</a-v></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>        {</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"><a-p>          </a-p><a-v>home-manager</a-v><a-p> = {</a-p></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>            </a-p><a-c># ... snip -- see Home Manager&#39;s documentation for details</a-c></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>            </a-p><a-v>users</a-v><a-p>.</a-p><a-v>YOUR_USERNAME</a-v><a-p> = {</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>              </a-p><a-v>imports</a-v><a-p> = </a-p><a-k>with</a-k><a-p> </a-p><a-v>outputs</a-v><a-p>.</a-p><a-v>homeManagerModules</a-v><a-p>; [</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>                </a-p><a-v>slippi</a-v><a-p>.</a-p><a-v>homeManagerModules</a-v><a-p>.</a-p><a-v>default</a-v></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>                {</a-p></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-c># use your path</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>                  </a-p><a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>isoPath</a-v><a-p> = </a-p><a-s>&quot;/home/user/Downloads/melee.iso&quot;</a-s><a-p>;</a-p></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>                }</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>              ];</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>            };</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>          };</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>        }</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>      ];</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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>There are other configuration options if you take a look at the flake&#39;s source.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>Most useful to me is:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</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="L67" href="#L67">67</a><span class="code-text"><a-p>slippi-launcher.</a-p><a-v>launchMeleeOnPlay</a-v><a-p> = </a-p><a-v>false</a-v><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>As I prefer to be able to tweak Dolphin&#39;s settings before diving right in.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p># </a-p><a-tt>Updates</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>Note that this does _not_ support the auto-updates performed by Slippi Launcher.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>Instead, when updates are pushed here, you must update your input reference to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>this flake and then your system.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>```</a-p><a-tl>shell_session</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>nix flake lock --update-input slippi-nix # use whatever name you gave this flake as input!</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>sudo nixos-rebuild switch --flake .</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>In the event that this repo is out-of-date and an update was newly pushed out</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>and you do not want to wait, or you prefer to be in control, this Flake exposes</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>extra configuration fields for specifying the version of the AppImage you want</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>along with the hash like so:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</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="L89" href="#L89">89</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>  </a-p><a-v>home-manager</a-v><a-p>.</a-p><a-v>users</a-v><a-p>.</a-p><a-v>YOUR_USERNAME</a-v><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>    </a-p><a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>netplayVersion</a-v><a-p> = </a-p><a-s>&quot;3.4.0&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>    </a-p><a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>netplayHash</a-v><a-p> = </a-p><a-s>&quot;sha256-d1iawMsMwFElUqFmwWAD9rNsDdQr2LKscU8xuJPvxYg=&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>    </a-p><a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>netplayBetaVersion</a-v><a-p> = </a-p><a-s>&quot;4.0.0-mainline-beta.6&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>    </a-p><a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>netplayBetaHash</a-v><a-p> = </a-p><a-s>&quot;sha256-CicAZ28+yiagG3bjosu02azV6XzP7+JnLhUJ3hdeQbI=&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>    </a-p><a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>playbackVersion</a-v><a-p> = </a-p><a-s>&quot;3.4.0&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"><a-p>    </a-p><a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>playbackHash</a-v><a-p> = </a-p><a-s>&quot;sha256-d1iawMsMwFElUqFmwWAD9rNsDdQr2LKscU8xuJPvxYg=&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p>So when a Slippi update is released, you can usually bump the version to match</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>and update the hash with whatever `nix` says it is.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p># </a-p><a-tt>Beta</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>You can enable the beta netplay client by adding this to the configuration:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</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="L107" href="#L107">107</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>  </a-p><a-v>home-manager</a-v><a-p>.</a-p><a-v>users</a-v><a-p>.</a-p><a-v>YOUR_USERNAME</a-v><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>    </a-p><a-v>slippi-launcher</a-v><a-p>.</a-p><a-v>useBetaNetplay</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="L110" href="#L110">110</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"><a-p>The beta netplay client is *not* downloaded unless it is enabled. When enabled it is set as the default as well.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"><a-p># </a-p><a-tt>Cache</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"><a-p>You may also want to leverage our Cachix binary cache. There isn&#39;t _much_</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>purpose to it since the &quot;build&quot; steps are just unpacking the AppImages and</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"><a-p>repacking them in a format that works with Nix, but they graciously provide one</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>to us freely.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</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="L123" href="#L123">123</a><span class="code-text"><a-p>nixConfig = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p>  </a-p><a-v>extra-substituters</a-v><a-p> = [</a-p><a-s>&quot;https://slippi-nix.cachix.org&quot;</a-s><a-p>];</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"><a-p>  </a-p><a-v>extra-trusted-public-keys</a-v><a-p> = [</a-p><a-s>&quot;slippi-nix.cachix.org-1:2qnPHiOxTRpzgLEtx6K4kXq/ySDg7zHEJ58J6xNDvBo=&quot;</a-s><a-p>];</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"><a-p>};</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"><a-p># </a-p><a-tt>To Do</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"><a-p>It would be nice if Home Manager weren&#39;t strictly necessary. At the moment,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text"><a-p>I believe the config file _could_ be created via a NixOS module (using</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"><a-p>`systemd.tmpfiles.rules` or something?), but the ideal scenario would be to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"><a-p>instead either be to specify to the launcher where the netplay and playback</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"><a-p>binaries are without the configuration file -- perhaps via command line</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"><a-p>arguments or environment variables.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"><a-p>If this were true, you could simply `nix run github:lytedev/slippi-nix#netplay`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text"><a-p>and start playing right away, which is ideal!</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"><a-p># </a-p><a-tt>License</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text">This project is licensed under the [MIT](./license) license.</span></span></pre></div></div>
</main>
</body>
</html>
