<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - fork/nix-minecraft @ master</title>
<meta name="description" content="README.md in fork/nix-minecraft at master.">
<meta property="og:title" content="README.md - fork/nix-minecraft @ master">
<meta property="og:description" content="README.md in fork/nix-minecraft at master.">
<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="master" data-tip="70daf1f48885f0b4a70797076cd2ff5d9139b46e">
<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/nix-minecraft</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/nix-minecraft</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Nathan Regner</span><span class="commit-message" data-commit="cc15499d7973a4c0a3e5e81a1b197c023180bbd7">neoforge-servers: init</span><span class="snapshot-sha sha" data-commit="cc15499d7973a4c0a3e5e81a1b197c023180bbd7">cc15499</span><time datetime="2025-07-04T09:28:44-06:00" title="2025-07-04 09:28:44 -0600">2025-07-04</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a href="/fork/nix-minecraft/ref/develop/">develop</a><a href="/fork/nix-minecraft/ref/feat/abduco/">feat/abduco</a><a href="/fork/nix-minecraft/ref/feat/legacy-fabric-servers/">feat/legacy-fabric-servers</a><a href="/fork/nix-minecraft/ref/lazymc/">lazymc</a><a class="current" href="/fork/nix-minecraft/ref/master/">master</a><a href="/fork/nix-minecraft/ref/module/fix-14/">module/fix-14</a><a class="all" href="/fork/nix-minecraft/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/nix-minecraft/">nix-minecraft</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>20.1 KiB</span><span>548 lines</span></span><span class="actions"><a class="raw" href="/fork/nix-minecraft/raw/f14c5bcac7126ee3dbe2190c7f3f103ea6aae6bd/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>nix-minecraft</h1>
<h2>About</h2>
<p><code>nix-minecraft</code> is an attempt to better package and support Minecraft as part of the Nix ecosystem, focusing on the server-side.
As of currently, it packages:</p>
<ul>
<li>All versions of Vanilla servers</li>
<li>All supported versions of the following mod/plugin loaders/servers:
<ul>
<li>Fabric</li>
<li>Legacy Fabric</li>
<li>Quilt</li>
<li>Paper</li>
<li>Purpur</li>
<li>NeoForge</li>
</ul>
</li>
<li>All supported versions of the following:
<ul>
<li>Velocity proxy</li>
</ul>
</li>
<li>Various tools
<ul>
<li><code>nix-modrinth-prefetch</code></li>
<li><code>fetchPackwizModpack</code></li>
</ul>
</li>
</ul>
<p>Check out this video by vimjoyer that provides a brief overview of how to use the flake: https://youtu.be/Fph7SMldxpI</p>
<h2>Changelog</h2>
<p>See <a href="/fork/nix-minecraft/ref/master/blob/CHANGELOG.md">CHANGELOG.md</a>.</p>
<h2>Deprecation Policy</h2>
<p>When something gets deprecated, an announcement gets added to the <a href="/fork/nix-minecraft/ref/master/blob/CHANGELOG.md">changelog file</a>, and the respective parts in Nix get marked with an evaluation warning.
Deprecated code is subject to removal after 1 month.</p>
<h2>Installation</h2>
<p>This repository is made exclusively as a Nix flake. <code>flake-compat</code> is included for those not in flakes, however because I personally use flakes, it is not actively tested.</p>
<p>In your <code>flake.nix</code>:</p>
<pre class="language-nix"><a-p>{</a-p>
  <a-v>inputs</a-v> <a-p>=</a-p> <a-p>{</a-p>
    <a-v>nix-minecraft</a-v><a-p>.</a-p><a-v>url</a-v> <a-p>=</a-p> <a-s>&quot;github:Infinidoge/nix-minecraft&quot;</a-s><a-p>;</a-p>
  <a-p>};</a-p>
<a-p>}</a-p></pre>
<p>In your system configuration:</p>
<pre class="language-nix"><a-p>{</a-p> <a-v>inputs</a-v><a-p>,</a-p> ... <a-p>}</a-p>: <a-c># Make sure the flake inputs are in your system&#39;s config</a-c>
<a-p>{</a-p>
  <a-v>imports</a-v> <a-p>=</a-p> <a-p>[</a-p> <a-v>inputs</a-v><a-p>.</a-p><a-v>nix-minecraft</a-v><a-p>.</a-p><a-v>nixosModules</a-v><a-p>.</a-p><a-v>minecraft-servers</a-v> <a-p>];</a-p>
  <a-v>nixpkgs</a-v><a-p>.</a-p><a-v>overlays</a-v> <a-p>=</a-p> <a-p>[</a-p> <a-v>inputs</a-v><a-p>.</a-p><a-v>nix-minecraft</a-v><a-p>.</a-p><a-v>overlay</a-v> <a-p>];</a-p>
<a-p>}</a-p></pre>
<h2>Examples</h2>
<p>See the <a href="/fork/nix-minecraft/ref/master/tree/examples/">examples directory</a>.</p>
<h2>Roadmap</h2>
<p>See <a href="/fork/nix-minecraft/ref/master/blob/TODO.md">TODO.md</a>.</p>
<h2>Packages</h2>
<p>All of these are found under <code>legacyPackages</code>, since they are not derivations (i.e. an attrset of derivation, or a function that returns a derivation).</p>
<h3><code>vanillaServers.*</code></h3>
<p><a href="/fork/nix-minecraft/ref/master/tree/pkgs/vanilla-servers/">Source</a></p>
<p>An attrset of all of the vanilla server versions, in the form of <code>vanilla-version</code>, where <code>version</code> is the Minecraft version (<code>1.18</code>, <code>1.12.2</code>, <code>22w16b</code>, etc), with all periods and spaces replaced with underscores (<code>1_18</code>, <code>1_12_2</code>, etc).</p>
<p>For convenience, <code>vanillaServers.vanilla</code> is equivalent to the latest major version.</p>
<pre>vanillaServers.vanilla-1_18_2
vanillaServers.vanilla-22w16b
vanillaServers.vanilla-22w13oneblockatatime
</pre>
<h3><code>fabricServers.*</code></h3>
<p><a href="/fork/nix-minecraft/ref/master/tree/pkgs/fabric-servers/">Source</a></p>
<p>An attrset of all of the Fabric server versions, in the form of <code>fabric-mcversion</code>, following the same format as described above for version numbers. The <code>mcversion</code> must be <code>&gt;=1.14</code>. The Fabric version is the latest released version.</p>
<p>To change the Fabric version, you can override the derivation and set <code>loaderVersion</code>: <code>fabric-mcversion.override { loaderVersion = "fabricversion"; }</code>.  The <code>loaderVersion</code> must be <code>&gt;=0.10.7</code>.</p>
<p>For convenience, <code>fabricServers.fabric</code> is equivalent to the latest major Minecraft and Fabric versions.</p>
<pre>fabricServers.fabric-1_18_2
fabricServers.fabric-22w16b
fabricServers.fabric-1_18_2.override { loaderVersion = &quot;0.14.20&quot;; } # Specific fabric loader version
</pre>
<h3><code>quiltServers.*</code></h3>
<p><a href="/fork/nix-minecraft/ref/master/tree/pkgs/quilt-servers/">Source</a></p>
<p><code>quiltServers</code> functions the same as <code>fabricServers</code>, but with the Quilt mod loader.</p>
<h3><code>legacyFabricServers.*</code></h3>
<p><a href="/fork/nix-minecraft/ref/master/tree/pkgs/legacy-fabric-servers/">Source</a></p>
<p><code>legacyFabricServers</code> functions the same as <code>fabricServers</code>, but with versions provided by the Legacy Fabric project.</p>
<p>Since Legacy Fabric does not have a defined newest version to target, it lacks a <code>legacy-fabric</code> attribute pointing to the latest version/loader version combination.</p>
<h3><code>paperServers.*</code></h3>
<p><a href="/fork/nix-minecraft/ref/master/tree/pkgs/paper-servers/">Source</a></p>
<p><code>paperServers</code> functions the same as <code>fabricServers</code>, but with the Paper server software.</p>
<p>If you plan on running paper without internet, you'll have to link the vanilla jar to <code>cache/mojang_{version}.jar</code>. The relevant jar is available at the package's <code>vanillaJar</code> attribute.</p>
<h3><code>purpurServers.*</code></h3>
<p><a href="/fork/nix-minecraft/ref/master/tree/pkgs/purpur-servers/">Source</a></p>
<p><code>purpurServers</code> functions the same as <code>paperServers</code>.</p>
<p>If you plan on running paper without internet, you'll have to link the vanilla jar to <code>cache/mojang_{version}.jar</code>. The relevant jar is available at the package's <code>vanillaJar</code> attribute.</p>
<h3><code>neoforgeServers.*</code></h3>
<p><a href="/fork/nix-minecraft/ref/master/tree/pkgs/neoforge-servers/">Source</a></p>
<p>An attrset of all of the NeoForge server versions, in the form of <code>neoforge-mcversion-neoforgeversion</code>, following the same format as described above for version numbers.
The lowest supported version is <code>20.4.240</code>; see <a href="/fork/nix-minecraft/ref/master/blob/pkgs/neoforge-servers/update.py">the update script</a> for details.</p>
<p>For convenience, <code>neoforgeServers.neoforge</code> is equivalent to the latest major Minecraft and NeoForge versions.
<code>neoforgeServers.neoforge.gameversion</code> is equivalent to the latest NeoForge version for <code>gameversion</code>.</p>
<pre>neoforgeServers.neoforge-1_21_1
neoforgeServers.neoforge-1_21_1-21_1_193
</pre>
<h3><code>velocityServers.*</code></h3>
<p><a href="/fork/nix-minecraft/ref/master/tree/pkgs/velocity-servers/">Source</a></p>
<p>An attrset of all of the Velocity server versions (differently from the others, the version does not include nor depend on specific minecraft versions).</p>
<p>For convenience, <code>velocityServers.velocity</code> is equivalent to the latest version.</p>
<h3><code>minecraftServers.*</code></h3>
<p><code>vanillaServers // fabricServers // quiltServers // legacyFabricServers // paperServers // purpurServers // neoforgeServers</code>. Will be used most often as it contains all of the different server versions across each mod loader. When using the overlay, this will replace the Nixpkgs <code>minecraftServers</code>.</p>
<h3><code>fetchPackwizModpack</code></h3>
<p><a href="/fork/nix-minecraft/ref/master/tree/pkgs/tools/fetchPackwizModpack/">Source</a></p>
<p>This function allows you to easily package a <a href="https://packwiz.infra.link/">packwiz</a> modpack, for example, to run it own your server. An example:</p>
<pre class="language-nix"><a-k>let</a-k>
  <a-v>modpack</a-v> <a-p>=</a-p> <a-v>pkgs</a-v><a-p>.</a-p><a-v>fetchPackwizModpack</a-v> <a-p>{</a-p>
    <a-v>url</a-v> <a-p>=</a-p> <a-s>&quot;https://github.com/Misterio77/Modpack/raw/0.2.9/pack.toml&quot;</a-s><a-p>;</a-p>
    <a-v>packHash</a-v> <a-p>=</a-p> <a-s>&quot;sha256-L5RiSktqtSQBDecVfGj1iDaXV+E90zrNEcf4jtsg+wk=&quot;</a-s><a-p>;</a-p>
  <a-p>};</a-p>
<a-k>in</a-k>
<a-p>{</a-p>
  <a-v>services</a-v><a-p>.</a-p><a-v>minecraft-servers</a-v><a-p>.</a-p><a-v>servers</a-v><a-p>.</a-p><a-v>cool-modpack</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>package</a-v> <a-p>=</a-p> <a-v>pkgs</a-v><a-p>.</a-p><a-v>fabricServers</a-v><a-p>.</a-p><a-v>fabric-1_18_2</a-v><a-p>.</a-p><a-v>override</a-v> <a-p>{</a-p> <a-v>loaderVersion</a-v> <a-p>=</a-p> <a-s>&quot;0.14.9&quot;</a-s><a-p>;</a-p> <a-p>};</a-p>
    <a-v>symlinks</a-v> <a-p>=</a-p> <a-p>{</a-p>
      <a-s>&quot;mods&quot;</a-s> <a-p>=</a-p> <a-s>&quot;</a-s><a-p>${</a-p><a-eb>modpack</a-eb><a-p>}</a-p><a-s>/mods&quot;</a-s><a-p>;</a-p>
    <a-p>};</a-p>
    <a-v>files</a-v> <a-p>=</a-p> <a-p>{</a-p>
      <a-s>&quot;config&quot;</a-s> <a-p>=</a-p> <a-s>&quot;</a-s><a-p>${</a-p><a-eb>modpack</a-eb><a-p>}</a-p><a-s>/config&quot;</a-s><a-p>;</a-p>
      <a-s>&quot;config/mod1.yml&quot;</a-s> <a-p>=</a-p> <a-s>&quot;</a-s><a-p>${</a-p><a-eb>modpack</a-eb><a-p>}</a-p><a-s>/config/mod1.yml&quot;</a-s><a-p>;</a-p>
      <a-s>&quot;config/mod2.conf&quot;</a-s> <a-p>=</a-p> <a-s>&quot;</a-s><a-p>${</a-p><a-eb>modpack</a-eb><a-p>}</a-p><a-s>/config/mod2.conf&quot;</a-s><a-p>;</a-p>
      <a-c># You can add files not on the modpack, of course</a-c>
      <a-s>&quot;config/server-specific.conf&quot;</a-s><a-p>.</a-p><a-v>value</a-v> <a-p>=</a-p> <a-p>{</a-p>
        <a-v>example</a-v> <a-p>=</a-p> <a-s>&quot;foo-bar&quot;</a-s><a-p>;</a-p>
      <a-p>};</a-p>
    <a-p>};</a-p>
  <a-p>};</a-p>
<a-p>}</a-p></pre>
<p>This will symlink the modpack's final <code>mods</code> directory into the server's <code>mods</code> directory, and copy the specified config files into <code>config</code>. You can also do this for any files in the modpack you're interested in, in a granular way.</p>
<p><strong>Note</strong>: Be sure to use a stable URL (e.g. a git tag/commit) to the manifest, as it changing will cause the derivation to generate a different hash, breaking the build until you change it.</p>
<p>Adding config files one by-one is boring. Trying to include an additional mod will also fail, as <code>mods</code> is read-only and symlinked as is. To solve these issues, this flake provides a <code>collectFilesAt</code> function, that recursively collects every file on the given directory (e.g. <code>config</code>), and returns an attribute set in the format <code>symlinks</code>/<code>files</code> expects. For example:</p>
<pre class="language-nix"><a-p>{</a-p> <a-v>inputs</a-v><a-p>,</a-p> ... <a-p>}</a-p>:
<a-k>let</a-k>
  <a-k>inherit</a-k> <a-p>(</a-p><a-v>inputs</a-v><a-p>.</a-p><a-v>nix-minecraft</a-v><a-p>.</a-p><a-v>lib</a-v><a-p>)</a-p> <a-v>collectFilesAt</a-v><a-p>;</a-p>
  <a-v>modpack</a-v> <a-p>=</a-p> <a-v>pkgs</a-v><a-p>.</a-p><a-v>fetchPackwizModpack</a-v> <a-p>{</a-p>
    <a-v>url</a-v> <a-p>=</a-p> <a-s>&quot;https://github.com/Misterio77/Modpack/raw/0.2.9/pack.toml&quot;</a-s><a-p>;</a-p>
    <a-v>packHash</a-v> <a-p>=</a-p> <a-s>&quot;sha256-L5RiSktqtSQBDecVfGj1iDaXV+E90zrNEcf4jtsg+wk=&quot;</a-s><a-p>;</a-p>
  <a-p>};</a-p>
<a-k>in</a-k>
<a-p>{</a-p>
  <a-v>services</a-v><a-p>.</a-p><a-v>minecraft-servers</a-v><a-p>.</a-p><a-v>servers</a-v><a-p>.</a-p><a-v>cool-modpack</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>package</a-v> <a-p>=</a-p> <a-v>pkgs</a-v><a-p>.</a-p><a-v>fabricServers</a-v><a-p>.</a-p><a-v>fabric-1_18_2-0_14_9</a-v><a-p>;</a-p>
    <a-v>symlinks</a-v> <a-p>=</a-p> <a-v>collectFilesAt</a-v> <a-v>modpack</a-v> <a-s>&quot;mods&quot;</a-s> <a-o>//</a-o> <a-p>{</a-p>
      <a-s>&quot;mods/FabricProxy-lite.jar&quot;</a-s> <a-p>=</a-p> <a-v>pkgs</a-v><a-p>.</a-p><a-v>fetchurl</a-v> <a-k>rec</a-k> <a-p>{</a-p>
        <a-v>pname</a-v> <a-p>=</a-p> <a-s>&quot;FabricProxy-Lite&quot;</a-s><a-p>;</a-p>
        <a-v>version</a-v> <a-p>=</a-p> <a-s>&quot;1.1.6&quot;</a-s><a-p>;</a-p>
        <a-v>url</a-v> <a-p>=</a-p> <a-s>&quot;https://cdn.modrinth.com/data/8dI2tmqs/versions/v</a-s><a-p>${</a-p><a-eb>version</a-eb><a-p>}</a-p><a-s>/</a-s><a-p>${</a-p><a-eb>pname</a-eb><a-p>}</a-p><a-s>-</a-s><a-p>${</a-p><a-eb>version</a-eb><a-p>}</a-p><a-s>.jar&quot;</a-s><a-p>;</a-p>
        <a-v>hash</a-v> <a-p>=</a-p> <a-s>&quot;sha256-U+nXvILXlYdx0vgomVDkKxj0dGCtw60qW22EK4FhAJk=&quot;</a-s><a-p>;</a-p>
      <a-p>};</a-p>
    <a-p>};</a-p>
    <a-v>files</a-v> <a-p>=</a-p> <a-v>collectFilesAt</a-v> <a-v>modpack</a-v> <a-s>&quot;config&quot;</a-s> <a-o>//</a-o> <a-p>{</a-p>
      <a-s>&quot;config/server-specific.conf&quot;</a-s><a-p>.</a-p><a-v>value</a-v> <a-p>=</a-p> <a-p>{</a-p>
        <a-v>example</a-v> <a-p>=</a-p> <a-s>&quot;foo-bar&quot;</a-s><a-p>;</a-p>
      <a-p>};</a-p>
    <a-p>};</a-p>
  <a-p>};</a-p>
<a-p>}</a-p></pre>
<p><strong>Note</strong>: Calling <code>collectFilesAt</code> on a derivation (e.g. the modpack) will cause <a href="https://nixos.wiki/wiki/Import_From_Derivation">IFD</a>.</p>
<p>The built modpack also exports a <code>manifest</code> attribute, that allows you to get any information from its <code>pack.toml</code> file, such as the MC or Modloader version. You can, this way, always sync the server's version with the one the modpack recommends:</p>
<pre class="language-nix"><a-k>let</a-k>
  <a-v>modpack</a-v> <a-p>=</a-p> <a-v>pkgs</a-v><a-p>.</a-p><a-v>fetchPackwizModpack</a-v> <a-p>{</a-p>
    <a-v>url</a-v> <a-p>=</a-p> <a-s>&quot;https://github.com/Misterio77/Modpack/raw/0.2.9/pack.toml&quot;</a-s><a-p>;</a-p>
    <a-v>packHash</a-v> <a-p>=</a-p> <a-s>&quot;sha256-L5RiSktqtSQBDecVfGj1iDaXV+E90zrNEcf4jtsg+wk=&quot;</a-s><a-p>;</a-p>
  <a-p>};</a-p>
  <a-v>mcVersion</a-v> <a-p>=</a-p> <a-v>modpack</a-v><a-p>.</a-p><a-v>manifest</a-v><a-p>.</a-p><a-v>versions</a-v><a-p>.</a-p><a-v>minecraft</a-v><a-p>;</a-p>
  <a-v>fabricVersion</a-v> <a-p>=</a-p> <a-v>modpack</a-v><a-p>.</a-p><a-v>manifest</a-v><a-p>.</a-p><a-v>versions</a-v><a-p>.</a-p><a-v>fabric</a-v><a-p>;</a-p>
  <a-v>serverVersion</a-v> <a-p>=</a-p> <a-v>lib</a-v><a-p>.</a-p><a-v>replaceStrings</a-v> <a-p>[</a-p> <a-s>&quot;.&quot;</a-s> <a-p>]</a-p> <a-p>[</a-p> <a-s>&quot;_&quot;</a-s> <a-p>]</a-p> <a-s>&quot;fabric-</a-s><a-p>${</a-p><a-eb>mcVersion</a-eb><a-p>}</a-p><a-s>&quot;</a-s><a-p>;</a-p>
<a-k>in</a-k>
<a-p>{</a-p>
  <a-v>services</a-v><a-p>.</a-p><a-v>minecraft-servers</a-v><a-p>.</a-p><a-v>servers</a-v><a-p>.</a-p><a-v>cool-modpack</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>package</a-v> <a-p>=</a-p> <a-v>pkgs</a-v><a-p>.</a-p><a-v>fabricServers</a-v><a-p>.${</a-p><a-eb>serverVersion</a-eb><a-p>}.</a-p><a-v>override</a-v> <a-p>{</a-p> <a-v>loaderVersion</a-v> <a-p>=</a-p> <a-v>fabricVersion</a-v><a-p>;</a-p> <a-p>};</a-p>
    <a-v>symlinks</a-v> <a-p>=</a-p> <a-p>{</a-p>
      <a-s>&quot;mods&quot;</a-s> <a-p>=</a-p> <a-s>&quot;</a-s><a-p>${</a-p><a-eb>modpack</a-eb><a-p>}</a-p><a-s>/mods&quot;</a-s><a-p>;</a-p>
    <a-p>};</a-p>
  <a-p>};</a-p>
<a-p>}</a-p></pre>
<p><strong>Note</strong>: Using <code>manifest</code>, by default, will cause <a href="https://nixos.wiki/wiki/Import_From_Derivation">IFD</a>. If you want to avoid IFD while still having access to <code>manifest</code>, simply pass a <code>manifestHash</code> to the <code>fetchPackwizModpack</code> function, it will then fetch the manifest through <code>builtins.fetchurl</code>.</p>
<h3>Others</h3>
<p>All of these packages are also available under <code>packages</code>, not just <code>legacyPackages</code>.</p>
<ul>
<li><code>vanilla-server</code>: Same as <code>vanillaServers.vanilla</code></li>
<li><code>fabric-server</code>: Same as <code>fabricServers.fabric</code></li>
<li><code>quilt-server</code>: Same as <code>quiltServers.quilt</code></li>
<li><code>paper-server</code>: Same as <code>paperServers.paper</code></li>
<li><code>purpur-server</code>: Same as <code>purpurServers.purpur</code></li>
<li><code>neoforge-server</code>: Same as <code>neoforgeServers.neoforge</code></li>
<li><code>velocity-server</code>: Same as <code>velocityServers.velocity</code></li>
<li><code>minecraft-server</code>: Same as <code>vanilla-server</code></li>
</ul>
<p>Server versions not found above can be setup manually via an override.
For example, this override changes the path the launch script uses to your provided jar file, and does not modify the vanilla jar:</p>
<pre class="language-nix"><a-k>let</a-k>
  <a-v>uberBukkit</a-v> <a-p>=</a-p> <a-v>pkgs</a-v><a-p>.</a-p><a-v>vanillaServers</a-v><a-p>.</a-p><a-v>vanilla</a-v><a-p>.</a-p><a-v>overrideAttrs</a-v> <a-p>(</a-p><a-v>oldAttrs</a-v>: <a-p>{</a-p>
    <a-v>src</a-v> <a-p>=</a-p> <a-s>./uberbukkit.jar</a-s><a-p>;</a-p>
  <a-p>});</a-p>
<a-k>in</a-k>
<a-p>{</a-p>
  <a-v>services</a-v><a-p>.</a-p><a-v>minecraft-servers</a-v><a-p>.</a-p><a-v>servers</a-v><a-p>.</a-p><a-v>beta-server</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>package</a-v> <a-p>=</a-p> <a-v>uberBukkit</a-v><a-p>;</a-p>
  <a-p>};</a-p>
<a-p>}</a-p></pre>
<h4><code>nix-modrinth-prefetch</code></h4>
<p><a href="/fork/nix-minecraft/ref/master/blob/pkgs/tools/nix-modrinth-prefetch.nix">Source</a></p>
<p>A helper script to fetch a Modrinth mod, which outputs the necessary <code>fetchurl</code> invocation.</p>
<p>To use it, first find a mod on Modrinth, and click on the version you want.
In the displayed information, there is a <code>Version ID</code> string.
Click on it to copy the version ID.
Then, run the script like so:</p>
<pre class="language-bash"><a-f>nix</a-f> run github:Infinidoge/nix-minecraft#nix-modrinth-prefetch <a-co>--</a-co> versionid</pre>
<p>(This helper script can also be used in a temporary shell with <code>nix shell github:Infinidoge/nix-minecraft#nix-modrinth-prefetch</code>)</p>
<p>This <code>fetchurl</code> invocation directly fetches the mod, and can be copy-pasted to wherever necessary.</p>
<h2>Modules</h2>
<h3><code>services.minecraft-servers</code></h3>
<p><a href="/fork/nix-minecraft/ref/master/blob/modules/minecraft-servers.nix">Source</a></p>
<p>Module for hosting multiple servers at once. All of the following are under this module.</p>
<h4><code>enable</code></h4>
<p>If enabled, the servers in <code>services.minecraft-servers.servers</code> will be created and started as applicable.
The data for the servers will be loaded from and saved to <code>dataDir</code>, and any sockets will be put in <code>runDir</code>.</p>
<h4><code>eula</code></h4>
<p>Whether you agree to <a href="https://account.mojang.com/documents/minecraft_eula">Mojang's EULA</a>.
This option must be set to true to run any Minecraft servers.</p>
<h4><code>openFirewall</code></h4>
<p>Whether to open ports in the firewall for each server. Sets the default for <code>servers.&lt;name&gt;.openFirewall</code>.
This will only work if the ports are specified in <code>servers.&lt;name&gt;.serverProperties</code>, otherwise it will use the default ports.
Remember to change the ports if you running multiple servers.
The module asserts that servers with <code>openFirewall</code> set do not have conflicting ports to try to catch this.</p>
<h4><code>dataDir</code></h4>
<p>Directory to store the Minecraft servers. Defaults to <code>/srv/minecraft</code>.</p>
<p>Each server will be under a subdirectory named after the server name, such as <code>/srv/minecraft/servername</code>.</p>
<h4><code>runDir</code></h4>
<p>Directory to place the runtime tmux sockets into. Defaults to <code>/run/minecraft</code>.
Each server's console will be a tmux socket file in the form of servername.sock. To connect to the console, run <code>tmux -S /run/minecraft/servername.sock attach</code>, press <code>Ctrl + b</code> then <code>d</code> to detach.</p>
<h4><code>user</code></h4>
<p>Name of the user to create and run servers under. It is recommended to leave this as the default, as it is the same user as <code>services.minecraft-server</code>.</p>
<h4><code>group</code></h4>
<p>Name of the group to create and run servers under. In order to modify the server files or attach to the tmux socket, your user must be a part of this group. It is recommended to leave this as the default, as it is the same group as <code>services.minecraft-server</code>.</p>
<h4><code>environmentFile</code></h4>
<p>File consisting of lines in the form <code>varname=value</code> to define environment variables for the minecraft servers.
Secrets (database passwords, secret keys, etc.) can be substituted into server files without adding them to the Nix store by defining them in the environment file and adding them <code>servers.&lt;name&gt;.files</code> with the syntax <code>@varname@</code>.</p>
<h3><code>servers.&lt;name&gt;</code></h3>
<p>This family of options govern individual servers, which will be created on boot.</p>
<h4><code>servers.&lt;name&gt;.enable</code></h4>
<p>Whether to enable this server. If set to false, does <strong>NOT</strong> delete any data in the data directory, just does not generate the service file.</p>
<h4><code>servers.&lt;name&gt;.autoStart</code></h4>
<p>Whether to start this server on boot. If set to false, can still be started with <code>systemctl start minecraft-server-servername</code>.
Requires the server to be enabled.</p>
<h4><code>servers.&lt;name&gt;.openFirewall</code></h4>
<p>Whether to open ports in the firewall for this server.</p>
<h4><code>servers.&lt;name&gt;.restart</code></h4>
<p>Value of systemd's <code>Restart=</code> service configuration option.
Due to the servers being started in tmux sockets, values other than "no" and "always" may not work properly.
As a consequence of the "always" option, stopping the server in-game with the /stop command will cause the server to automatically restart</p>
<p>To prevent infinite crash loops, there is a start limit of 5 times within 2 minutes.</p>
<h4><code>servers.&lt;name&gt;.enableReload</code></h4>
<p>Reload server when configuration changes instead of restarting.
This re-links/copies the declared symlinks/files.
You can include additional actions (even in-game commands) by setting <code>&lt;name&gt;</code>.extraReload.</p>
<h4><code>servers.&lt;name&gt;.extraReload</code></h4>
<p>Extra commands to run when reloading the service. Only has an effect if <code>&lt;name&gt;.enableReload</code> is true.</p>
<h4><code>servers.&lt;name&gt;.whitelist</code></h4>
<p>Whitelisted players, only has an effect when <code>&lt;name&gt;.serverProperties.white-list = true;</code>.
When empty/unspecified, the whitelist file is not managed declaratively, allowing for use of the whitelist commands.
Example:</p>
<pre>{
  username1 = &quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;;
  username2 = &quot;yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy&quot;;
}
</pre>
<h4><code>servers.&lt;name&gt;.operators</code></h4>
<p>Server operators. See <a href="https://minecraft.wiki/w/Ops.json_format">The Documentation</a>. Example:</p>
<pre>{
  username1 = &quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;;
  username2 = {
    uuid = &quot;yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy&quot;;
    level = 3;
    bypassesPlayerLimit = true;
  };
}
</pre>
<h4><code>servers.&lt;name&gt;.bannedPlayers</code></h4>
<p>Banned players. See <a href="https://docs.papermc.io/paper/reference/vanilla-data-files/">The Documentation</a>. Example:</p>
<pre>{
  username1 = &quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;;
  username2 = {
    uuid = &quot;yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy&quot;;
    created = &quot;2025-12-01 09:00:00 -0500&quot;;
    source = &quot;(Unknown)&quot;;
    expires = &quot;forever&quot;;
    reason = &quot;Banned by an operator.&quot;;
  };
}
</pre>
<h4><code>servers.&lt;name&gt;.serverProperties</code></h4>
<p>Minecraft server properties for the server.properties file of this server. See <a href="https://minecraft.wiki/w/Server.properties">The Documentation</a> on these values. Example:</p>
<pre>{
  server-port = 43000;
  difficulty = 3;
  gamemode = 1;
  max-players = 5;
  motd = &quot;NixOS Minecraft server!&quot;;
  white-list = true;
  enable-rcon = true;
  &quot;rcon.password&quot; = &quot;hunter2&quot;;
}
</pre>
<h4><code>servers.&lt;name&gt;.package</code></h4>
<p>The Minecraft server package to use. Example:
<code>pkgs.minecraftServers.vanilla-1_18_2</code></p>
<h4><code>servers.&lt;name&gt;.jvmOpts</code></h4>
<p>JVM Options for this server, usually used to set ram amount. Example:
<code>-Xms6144M -Xmx8192M</code></p>
<h4><code>servers.&lt;name&gt;.symlinks</code></h4>
<p>This option is special in that it allows for declarative management of arbitrary things inside of the server's folder.
If the file already exists, existing one will have a <code>.bak</code> suffix added to it. If it is replaced again the previous backup will be overwritten.</p>
<p>How it works is that it takes an attrset of derivations, and symlinks each derivation into place with the name of the attribute in the attrset.</p>
<p>For example,</p>
<pre class="language-nix"><a-p>{</a-p>
  <a-v>symlinks</a-v> <a-p>=</a-p> <a-p>{</a-p>
    <a-v>text-file</a-v> <a-p>=</a-p> <a-v>pkgs</a-v><a-p>.</a-p><a-v>writeTextFile</a-v> <a-p>{</a-p>
      <a-v>name</a-v> <a-p>=</a-p> <a-s>&quot;text-file&quot;</a-s><a-p>;</a-p>
      <a-v>text</a-v> <a-p>=</a-p> <a-s>&quot;Some text&quot;</a-s><a-p>;</a-p>
    <a-p>};</a-p>
  <a-p>};</a-p>
<a-p>}</a-p></pre>
<p>Would symlink a file containing <code>"Some text"</code> into the server's folder.</p>
<p>This option is quite powerful, and can be used for a number of things, though most notably it can be used for declaratively setting up mods or plugins for the server.</p>
<p>This example takes an attrset of the IDs and hashes for Modrinth mods, fetches each one, and makes a folder containing those mods. (<code>linkFarmFromDrvs</code> is quite useful because it can take a list of derivations and produce a folder suitable for this purpose.) The names in this attrset are meaningless, I only included them as convenient labels.</p>
<pre class="language-nix"><a-p>{</a-p>
  <a-v>symlinks</a-v> <a-p>=</a-p> <a-p>{</a-p>
    <a-v>mods</a-v> <a-p>=</a-p> <a-v>pkgs</a-v><a-p>.</a-p><a-v>linkFarmFromDrvs</a-v> <a-s>&quot;mods&quot;</a-s> <a-p>(</a-p><a-v>builtins</a-v><a-p>.</a-p><a-v>attrValues</a-v> <a-p>{</a-p>
      <a-v>Starlight</a-v> <a-p>=</a-p> <a-v>fetchurl</a-v> <a-p>{</a-p> <a-v>url</a-v> <a-p>=</a-p> <a-s>&quot;https://cdn.modrinth.com/data/H8CaAYZC/versions/XGIsoVGT/starlight-1.1.2%2Bfabric.dbc156f.jar&quot;</a-s><a-p>;</a-p> <a-v>sha512</a-v> <a-p>=</a-p> <a-s>&quot;6b0e363fc2d6cd2f73b466ab9ba4f16582bb079b8449b7f3ed6e11aa365734af66a9735a7203cf90f8bc9b24e7ce6409eb04d20f84e04c7c6b8e34f4cc8578bb&quot;</a-s><a-p>;</a-p> <a-p>};</a-p>
      <a-v>Lithium</a-v> <a-p>=</a-p> <a-v>fetchurl</a-v> <a-p>{</a-p> <a-v>url</a-v> <a-p>=</a-p> <a-s>&quot;https://cdn.modrinth.com/data/gvQqBUqZ/versions/ZSNsJrPI/lithium-fabric-mc1.20.1-0.11.2.jar&quot;</a-s><a-p>;</a-p> <a-v>sha512</a-v> <a-p>=</a-p> <a-s>&quot;d1b5c90ba8b4879814df7fbf6e67412febbb2870e8131858c211130e9b5546e86b213b768b912fc7a2efa37831ad91caf28d6d71ba972274618ffd59937e5d0d&quot;</a-s><a-p>;</a-p> <a-p>};</a-p>
      <a-v>FerriteCore</a-v> <a-p>=</a-p> <a-v>fetchurl</a-v> <a-p>{</a-p> <a-v>url</a-v> <a-p>=</a-p> <a-s>&quot;https://cdn.modrinth.com/data/uXXizFIs/versions/ULSumfl4/ferritecore-6.0.0-forge.jar&quot;</a-s><a-p>;</a-p> <a-v>sha512</a-v> <a-p>=</a-p> <a-s>&quot;e78ddd02cca0a4553eb135dbb3ec6cbc59200dd23febf3491d112c47a0b7e9fe2b97f97a3d43bb44d69f1a10aad01143dcd84dc575dfa5a9eaa315a3ec182b37&quot;</a-s><a-p>;</a-p> <a-p>};</a-p>
      <a-v>Krypton</a-v> <a-p>=</a-p> <a-v>fetchurl</a-v> <a-p>{</a-p> <a-v>url</a-v> <a-p>=</a-p> <a-s>&quot;https://cdn.modrinth.com/data/fQEb0iXm/versions/jiDwS0W1/krypton-0.2.3.jar&quot;</a-s><a-p>;</a-p> <a-v>sha512</a-v> <a-p>=</a-p> <a-s>&quot;92b73a70737cfc1daebca211bd1525de7684b554be392714ee29cbd558f2a27a8bdda22accbe9176d6e531d74f9bf77798c28c3e8559c970f607422b6038bc9e&quot;</a-s><a-p>;</a-p> <a-p>};</a-p>
      <a-v>LazyDFU</a-v> <a-p>=</a-p> <a-v>fetchurl</a-v> <a-p>{</a-p> <a-v>url</a-v> <a-p>=</a-p> <a-s>&quot;https://cdn.modrinth.com/data/hvFnDODi/versions/0.1.3/lazydfu-0.1.3.jar&quot;</a-s><a-p>;</a-p> <a-v>sha512</a-v> <a-p>=</a-p> <a-s>&quot;dc3766352c645f6da92b13000dffa80584ee58093c925c2154eb3c125a2b2f9a3af298202e2658b039c6ee41e81ca9a2e9d4b942561f7085239dd4421e0cce0a&quot;</a-s><a-p>;</a-p> <a-p>};</a-p>
      <a-v>C2ME</a-v> <a-p>=</a-p> <a-v>fetchurl</a-v> <a-p>{</a-p> <a-v>url</a-v> <a-p>=</a-p> <a-s>&quot;https://cdn.modrinth.com/data/VSNURh3q/versions/t4juSkze/c2me-fabric-mc1.20.1-0.2.0%2Balpha.10.91.jar&quot;</a-s><a-p>;</a-p> <a-v>sha512</a-v> <a-p>=</a-p> <a-s>&quot;562c87a50f380c6cd7312f90b957f369625b3cf5f948e7bee286cd8075694a7206af4d0c8447879daa7a3bfe217c5092a7847247f0098cb1f5417e41c678f0c1&quot;</a-s><a-p>;</a-p> <a-p>};</a-p>
    <a-p>});</a-p>
  <a-p>};</a-p>
<a-p>}</a-p></pre>
<p><code>symlinks</code> is also able to automatically infer the format of certain extensions:  <code>yml, yaml, json, props, properties, toml, ini, txt</code></p>
<p>For example,</p>
<pre class="language-nix"><a-v>symlinks</a-v><a-p>.</a-p><a-s>&quot;myfile.json&quot;</a-s> <a-p>=</a-p> <a-p>{</a-p>
  <a-v>value</a-v> <a-p>=</a-p> <a-p>{</a-p>
    <a-v>option</a-v> <a-p>=</a-p> <a-s>&quot;value&quot;</a-s><a-p>;</a-p>
  <a-p>};</a-p>
<a-p>};</a-p></pre>
<p>Would symlink a file containing the following into the server's folder:</p>
<pre class="language-json">{
  <a-s>&quot;option&quot;</a-s>: <a-s>&quot;value&quot;</a-s>
}</pre>
<p>Other formats are able to be generated by providing a format function: <a href="https://github.com/NixOS/nixpkgs/blob/e7b543ba95681a01148d8c267d668bdcbd521fcb/pkgs/pkgs-lib/formats.nix">Example Functions</a>
Example:</p>
<pre class="language-nix"><a-k>let</a-k>
  <a-v>extList</a-v> <a-p>=</a-p> <a-p>{}</a-p>: <a-p>{</a-p>
    <a-v>type</a-v> <a-p>=</a-p> <a-k>with</a-k> <a-v>lib</a-v><a-p>.</a-p><a-v>types</a-v><a-p>;</a-p> <a-v>listOf</a-v> <a-v>str</a-v><a-p>;</a-p>
    <a-v>generate</a-v> <a-p>=</a-p> <a-v>name</a-v>: <a-v>value</a-v>: <a-v>pkgs</a-v><a-p>.</a-p><a-v>writeText</a-v> <a-v>name</a-v> <a-p>(</a-p><a-v>lib</a-v><a-p>.</a-p><a-v>concatStringsSep</a-v> <a-s>&quot;\n&quot;</a-s> <a-v>value</a-v><a-p>);</a-p>
  <a-p>};</a-p>
<a-k>in</a-k>
<a-p>{</a-p>
  <a-v>symlinks</a-v><a-p>.</a-p><a-s>&quot;myfile.ext&quot;</a-s> <a-p>=</a-p> <a-p>{</a-p>
    <a-v>format</a-v> <a-p>=</a-p> <a-v>extList</a-v> <a-p>{};</a-p>
    <a-v>value</a-v> <a-p>=</a-p> <a-p>[</a-p>
      <a-s>&quot;Hi!&quot;</a-s>
      <a-s>&quot;Hello!&quot;</a-s>
    <a-p>];</a-p>
  <a-p>};</a-p>
<a-p>}</a-p></pre>
<h4><code>servers.&lt;name&gt;.files</code></h4>
<p>Things to copy into this server's data directory. Every option and example in <code>symlinks</code> works the same way for <code>files</code>, except that actual files are generated. Useful for configuration files that don't behave well when read-only.</p>
<p>For example:</p>
<pre class="language-nix"><a-v>files</a-v><a-p>.</a-p><a-s>&quot;white-list.txt&quot;</a-s> <a-p>=</a-p> <a-p>{</a-p>
  <a-v>value</a-v> <a-p>=</a-p> <a-p>[</a-p>
    <a-s>&quot;person1&quot;</a-s>
    <a-s>&quot;person2&quot;</a-s>
    <a-s>&quot;person3&quot;</a-s>
  <a-p>];</a-p>
<a-p>};</a-p></pre>
<p>generates a legacy <code>white-list.txt</code> that is needed for older minecraft versions (&lt; 1.7.6)</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>nix-minecraft</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"><a-p>##</a-p> <a-tt>About</a-tt></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">`nix-minecraft` is an attempt to better package and support Minecraft as part of the Nix ecosystem, focusing on the server-side.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">As of currently, it packages:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>- </a-p>All versions of Vanilla servers</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>- </a-p>All supported versions of the following mod/plugin loaders/servers:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>  - </a-p>Fabric</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>  - </a-p>Legacy Fabric</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>  - </a-p>Quilt</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>  - </a-p>Paper</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>Purpur</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>NeoForge</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>All supported versions of the following:</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>Velocity proxy</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>- </a-p>Various tools</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>  - </a-p>`nix-modrinth-prefetch`</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>`fetchPackwizModpack`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></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>Check out this video by vimjoyer that provides a brief overview of how to use the flake: https://youtu.be/Fph7SMldxpI</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>## </a-p><a-tt>Changelog</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></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>See [CHANGELOG.md](./CHANGELOG.md).</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"></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><a-tt>Deprecation Policy</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></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>When something gets deprecated, an announcement gets added to the [changelog file](./CHANGELOG.md), and the respective parts in Nix get marked with an evaluation warning.</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>Deprecated code is subject to removal after 1 month.</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-tt>Installation</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"></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>This repository is made exclusively as a Nix flake. `flake-compat` is included for those not in flakes, however because I personally use flakes, it is not actively tested.</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>In your `flake.nix`:</a-p></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>```</a-p><a-tl>nix</a-tl></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></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>inputs</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>nix-minecraft</a-v><a-p>.</a-p><a-v>url</a-v><a-p> = </a-p><a-s>&quot;github:Infinidoge/nix-minecraft&quot;</a-s><a-p>;</a-p></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></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"></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>In your system configuration:</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"></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><a-tl>nix</a-tl></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-tl> </a-tl><a-v>inputs</a-v><a-p>,</a-p><a-tl> ... </a-tl><a-p>}</a-p><a-tl>: </a-tl><a-c># Make sure the flake inputs are in your system&#39;s config</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></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><a-v>imports</a-v><a-p> = [ </a-p><a-v>inputs</a-v><a-p>.</a-p><a-v>nix-minecraft</a-v><a-p>.</a-p><a-v>nixosModules</a-v><a-p>.</a-p><a-v>minecraft-servers</a-v><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><a-v>nixpkgs</a-v><a-p>.</a-p><a-v>overlays</a-v><a-p> = [ </a-p><a-v>inputs</a-v><a-p>.</a-p><a-v>nix-minecraft</a-v><a-p>.</a-p><a-v>overlay</a-v><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"></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><a-tt>Examples</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"></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>See the [examples directory](./examples/).</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"></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><a-tt>Roadmap</a-tt></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>See [TODO.md](./TODO.md).</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>## </a-p><a-tt>Packages</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"></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>All of these are found under `legacyPackages`, since they are not derivations (i.e. an attrset of derivation, or a function that returns a derivation).</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>### </a-p><a-tt>`vanillaServers.*`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>[Source](./pkgs/vanilla-servers)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>An attrset of all of the vanilla server versions, in the form of `vanilla-version`, where `version` is the Minecraft version (`1.18`, `1.12.2`, `22w16b`, etc), with all periods and spaces replaced with underscores (`1_18`, `1_12_2`, etc).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"></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>For convenience, `vanillaServers.vanilla` is equivalent to the latest major version.</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>```</a-p></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>vanillaServers.vanilla-1_18_2</a-p></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>vanillaServers.vanilla-22w16b</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>vanillaServers.vanilla-22w13oneblockatatime</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>### </a-p><a-tt>`fabricServers.*`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"></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>[Source](./pkgs/fabric-servers)</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>An attrset of all of the Fabric server versions, in the form of `fabric-mcversion`, following the same format as described above for version numbers. The `mcversion` must be `&gt;=1.14`. The Fabric version is the latest released version.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"></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>To change the Fabric version, you can override the derivation and set `loaderVersion`: `fabric-mcversion.override { loaderVersion = &quot;fabricversion&quot;; }`.  The `loaderVersion` must be `&gt;=0.10.7`.</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"></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>For convenience, `fabricServers.fabric` is equivalent to the latest major Minecraft and Fabric versions.</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"></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></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>fabricServers.fabric-1_18_2</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>fabricServers.fabric-22w16b</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>fabricServers.fabric-1_18_2.override { loaderVersion = &quot;0.14.20&quot;; } # Specific fabric loader version</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"></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><a-tt>`quiltServers.*`</a-tt></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>[Source](./pkgs/quilt-servers)</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>`quiltServers` functions the same as `fabricServers`, but with the Quilt mod loader.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"></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>### </a-p><a-tt>`legacyFabricServers.*`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"></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>[Source](./pkgs/legacy-fabric-servers)</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"></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>`legacyFabricServers` functions the same as `fabricServers`, but with versions provided by the Legacy Fabric project.</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"></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>Since Legacy Fabric does not have a defined newest version to target, it lacks a `legacy-fabric` attribute pointing to the latest version/loader version combination.</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"></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>### </a-p><a-tt>`paperServers.*`</a-tt></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>[Source](./pkgs/paper-servers)</a-p></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>`paperServers` functions the same as `fabricServers`, but with the Paper server software.</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"></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>If you plan on running paper without internet, you&#39;ll have to link the vanilla jar to `cache/mojang_{version}.jar`. The relevant jar is available at the package&#39;s `vanillaJar` attribute.</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"><a-p>### </a-p><a-tt>`purpurServers.*`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"></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>[Source](./pkgs/purpur-servers)</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"></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>`purpurServers` functions the same as `paperServers`.</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"></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>If you plan on running paper without internet, you&#39;ll have to link the vanilla jar to `cache/mojang_{version}.jar`. The relevant jar is available at the package&#39;s `vanillaJar` attribute.</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>`neoforgeServers.*`</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>[Source](./pkgs/neoforge-servers/)</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"></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>An attrset of all of the NeoForge server versions, in the form of `neoforge-mcversion-neoforgeversion`, following the same format as described above for version numbers.</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>The lowest supported version is `20.4.240`; see [the update script](./pkgs/neoforge-servers/update.py) for details.</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"></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>For convenience, `neoforgeServers.neoforge` is equivalent to the latest major Minecraft and NeoForge versions.</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"><a-p>`neoforgeServers.neoforge.gameversion` is equivalent to the latest NeoForge version for `gameversion`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"></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>```</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"><a-p>neoforgeServers.neoforge-1_21_1</a-p></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>neoforgeServers.neoforge-1_21_1-21_1_193</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text"><a-p>### </a-p><a-tt>`velocityServers.*`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text"><a-p>[Source](./pkgs/velocity-servers)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"><a-p>An attrset of all of the Velocity server versions (differently from the others, the version does not include nor depend on specific minecraft versions).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text"><a-p>For convenience, `velocityServers.velocity` is equivalent to the latest version.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text"><a-p>### </a-p><a-tt>`minecraftServers.*`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text"><a-p>`vanillaServers // fabricServers // quiltServers // legacyFabricServers // paperServers // purpurServers // neoforgeServers`. Will be used most often as it contains all of the different server versions across each mod loader. When using the overlay, this will replace the Nixpkgs `minecraftServers`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L156" href="#L156">156</a><span class="code-text"><a-p>### </a-p><a-tt>`fetchPackwizModpack`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L157" href="#L157">157</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L158" href="#L158">158</a><span class="code-text"><a-p>[Source](./pkgs/tools/fetchPackwizModpack)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text"><a-p>This function allows you to easily package a [packwiz](https://packwiz.infra.link/) modpack, for example, to run it own your server. An example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</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="L163" href="#L163">163</a><span class="code-text"><a-p>let</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text"><a-p>  </a-p><a-v>modpack</a-v><a-p> = </a-p><a-v>pkgs</a-v><a-p>.</a-p><a-v>fetchPackwizModpack</a-v><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text"><a-p>    </a-p><a-v>url</a-v><a-p> = </a-p><a-s>&quot;https://github.com/Misterio77/Modpack/raw/0.2.9/pack.toml&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text"><a-p>    </a-p><a-v>packHash</a-v><a-p> = </a-p><a-s>&quot;sha256-L5RiSktqtSQBDecVfGj1iDaXV+E90zrNEcf4jtsg+wk=&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text"><a-p>in</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text"><a-p>  </a-p><a-v>services</a-v><a-p>.</a-p><a-v>minecraft-servers</a-v><a-p>.</a-p><a-v>servers</a-v><a-p>.</a-p><a-v>cool-modpack</a-v><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L171" href="#L171">171</a><span class="code-text"><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="L172" href="#L172">172</a><span class="code-text"><a-p>    </a-p><a-v>package</a-v><a-p> = </a-p><a-v>pkgs</a-v><a-p>.</a-p><a-v>fabricServers</a-v><a-p>.</a-p><a-v>fabric-1_18_2</a-v><a-p>.</a-p><a-v>override</a-v><a-p> { </a-p><a-v>loaderVersion</a-v><a-p> = </a-p><a-s>&quot;0.14.9&quot;</a-s><a-p>; };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text"><a-p>    </a-p><a-v>symlinks</a-v><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text"><a-p>      </a-p><a-s>&quot;mods&quot;</a-s><a-p> = </a-p><a-s>&quot;</a-s><a-p>${</a-p><a-eb>modpack</a-eb><a-p>}</a-p><a-s>/mods&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text"><a-p>    };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L176" href="#L176">176</a><span class="code-text"><a-p>    </a-p><a-v>files</a-v><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text"><a-p>      </a-p><a-s>&quot;config&quot;</a-s><a-p> = </a-p><a-s>&quot;</a-s><a-p>${</a-p><a-eb>modpack</a-eb><a-p>}</a-p><a-s>/config&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text"><a-p>      </a-p><a-s>&quot;config/mod1.yml&quot;</a-s><a-p> = </a-p><a-s>&quot;</a-s><a-p>${</a-p><a-eb>modpack</a-eb><a-p>}</a-p><a-s>/config/mod1.yml&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</a><span class="code-text"><a-p>      </a-p><a-s>&quot;config/mod2.conf&quot;</a-s><a-p> = </a-p><a-s>&quot;</a-s><a-p>${</a-p><a-eb>modpack</a-eb><a-p>}</a-p><a-s>/config/mod2.conf&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L180" href="#L180">180</a><span class="code-text"><a-p>      </a-p><a-c># You can add files not on the modpack, of course</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L181" href="#L181">181</a><span class="code-text"><a-p>      </a-p><a-s>&quot;config/server-specific.conf&quot;</a-s><a-p>.</a-p><a-v>value</a-v><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L182" href="#L182">182</a><span class="code-text"><a-p>        </a-p><a-v>example</a-v><a-p> = </a-p><a-s>&quot;foo-bar&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L183" href="#L183">183</a><span class="code-text"><a-p>      };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L184" href="#L184">184</a><span class="code-text"><a-p>    };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L185" href="#L185">185</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L186" href="#L186">186</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L187" href="#L187">187</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L188" href="#L188">188</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L189" href="#L189">189</a><span class="code-text"><a-p>This will symlink the modpack&#39;s final `mods` directory into the server&#39;s `mods` directory, and copy the specified config files into `config`. You can also do this for any files in the modpack you&#39;re interested in, in a granular way.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L190" href="#L190">190</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L191" href="#L191">191</a><span class="code-text"><a-p>**Note**: Be sure to use a stable URL (e.g. a git tag/commit) to the manifest, as it changing will cause the derivation to generate a different hash, breaking the build until you change it.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L192" href="#L192">192</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L193" href="#L193">193</a><span class="code-text"><a-p>Adding config files one by-one is boring. Trying to include an additional mod will also fail, as `mods` is read-only and symlinked as is. To solve these issues, this flake provides a `collectFilesAt` function, that recursively collects every file on the given directory (e.g. `config`), and returns an attribute set in the format `symlinks`/`files` expects. For example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L194" href="#L194">194</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L195" href="#L195">195</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="L196" href="#L196">196</a><span class="code-text"><a-p>{</a-p><a-tl> </a-tl><a-v>inputs</a-v><a-p>,</a-p><a-tl> ... </a-tl><a-p>}</a-p><a-tl>:</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L197" href="#L197">197</a><span class="code-text"><a-p>let</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L198" href="#L198">198</a><span class="code-text"><a-p>  </a-p><a-k>inherit</a-k><a-p> (</a-p><a-v>inputs</a-v><a-p>.</a-p><a-v>nix-minecraft</a-v><a-p>.</a-p><a-v>lib</a-v><a-p>) </a-p><a-v>collectFilesAt</a-v><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L199" href="#L199">199</a><span class="code-text"><a-p>  </a-p><a-v>modpack</a-v><a-p> = </a-p><a-v>pkgs</a-v><a-p>.</a-p><a-v>fetchPackwizModpack</a-v><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L200" href="#L200">200</a><span class="code-text"><a-p>    </a-p><a-v>url</a-v><a-p> = </a-p><a-s>&quot;https://github.com/Misterio77/Modpack/raw/0.2.9/pack.toml&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L201" href="#L201">201</a><span class="code-text"><a-p>    </a-p><a-v>packHash</a-v><a-p> = </a-p><a-s>&quot;sha256-L5RiSktqtSQBDecVfGj1iDaXV+E90zrNEcf4jtsg+wk=&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L202" href="#L202">202</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L203" href="#L203">203</a><span class="code-text"><a-p>in</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L204" href="#L204">204</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L205" href="#L205">205</a><span class="code-text"><a-p>  </a-p><a-v>services</a-v><a-p>.</a-p><a-v>minecraft-servers</a-v><a-p>.</a-p><a-v>servers</a-v><a-p>.</a-p><a-v>cool-modpack</a-v><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L206" href="#L206">206</a><span class="code-text"><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="L207" href="#L207">207</a><span class="code-text"><a-p>    </a-p><a-v>package</a-v><a-p> = </a-p><a-v>pkgs</a-v><a-p>.</a-p><a-v>fabricServers</a-v><a-p>.</a-p><a-v>fabric-1_18_2-0_14_9</a-v><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L208" href="#L208">208</a><span class="code-text"><a-p>    </a-p><a-v>symlinks</a-v><a-p> = </a-p><a-v>collectFilesAt</a-v><a-p> </a-p><a-v>modpack</a-v><a-p> </a-p><a-s>&quot;mods&quot;</a-s><a-p> </a-p><a-o>//</a-o><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L209" href="#L209">209</a><span class="code-text"><a-p>      </a-p><a-s>&quot;mods/FabricProxy-lite.jar&quot;</a-s><a-p> = </a-p><a-v>pkgs</a-v><a-p>.</a-p><a-v>fetchurl</a-v><a-p> </a-p><a-k>rec</a-k><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L210" href="#L210">210</a><span class="code-text"><a-p>        </a-p><a-v>pname</a-v><a-p> = </a-p><a-s>&quot;FabricProxy-Lite&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L211" href="#L211">211</a><span class="code-text"><a-p>        </a-p><a-v>version</a-v><a-p> = </a-p><a-s>&quot;1.1.6&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L212" href="#L212">212</a><span class="code-text"><a-p>        </a-p><a-v>url</a-v><a-p> = </a-p><a-s>&quot;https://cdn.modrinth.com/data/8dI2tmqs/versions/v</a-s><a-p>${</a-p><a-eb>version</a-eb><a-p>}</a-p><a-s>/</a-s><a-p>${</a-p><a-eb>pname</a-eb><a-p>}</a-p><a-s>-</a-s><a-p>${</a-p><a-eb>version</a-eb><a-p>}</a-p><a-s>.jar&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L213" href="#L213">213</a><span class="code-text"><a-p>        </a-p><a-v>hash</a-v><a-p> = </a-p><a-s>&quot;sha256-U+nXvILXlYdx0vgomVDkKxj0dGCtw60qW22EK4FhAJk=&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L214" href="#L214">214</a><span class="code-text"><a-p>      };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L215" href="#L215">215</a><span class="code-text"><a-p>    };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L216" href="#L216">216</a><span class="code-text"><a-p>    </a-p><a-v>files</a-v><a-p> = </a-p><a-v>collectFilesAt</a-v><a-p> </a-p><a-v>modpack</a-v><a-p> </a-p><a-s>&quot;config&quot;</a-s><a-p> </a-p><a-o>//</a-o><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L217" href="#L217">217</a><span class="code-text"><a-p>      </a-p><a-s>&quot;config/server-specific.conf&quot;</a-s><a-p>.</a-p><a-v>value</a-v><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L218" href="#L218">218</a><span class="code-text"><a-p>        </a-p><a-v>example</a-v><a-p> = </a-p><a-s>&quot;foo-bar&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L219" href="#L219">219</a><span class="code-text"><a-p>      };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L220" href="#L220">220</a><span class="code-text"><a-p>    };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L221" href="#L221">221</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L222" href="#L222">222</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L223" href="#L223">223</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L224" href="#L224">224</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L225" href="#L225">225</a><span class="code-text"><a-p>**Note**: Calling `collectFilesAt` on a derivation (e.g. the modpack) will cause [IFD](https://nixos.wiki/wiki/Import_From_Derivation).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L226" href="#L226">226</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L227" href="#L227">227</a><span class="code-text"><a-p>The built modpack also exports a `manifest` attribute, that allows you to get any information from its `pack.toml` file, such as the MC or Modloader version. You can, this way, always sync the server&#39;s version with the one the modpack recommends:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L228" href="#L228">228</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L229" href="#L229">229</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="L230" href="#L230">230</a><span class="code-text"><a-p>let</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L231" href="#L231">231</a><span class="code-text"><a-p>  </a-p><a-v>modpack</a-v><a-p> = </a-p><a-v>pkgs</a-v><a-p>.</a-p><a-v>fetchPackwizModpack</a-v><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L232" href="#L232">232</a><span class="code-text"><a-p>    </a-p><a-v>url</a-v><a-p> = </a-p><a-s>&quot;https://github.com/Misterio77/Modpack/raw/0.2.9/pack.toml&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L233" href="#L233">233</a><span class="code-text"><a-p>    </a-p><a-v>packHash</a-v><a-p> = </a-p><a-s>&quot;sha256-L5RiSktqtSQBDecVfGj1iDaXV+E90zrNEcf4jtsg+wk=&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L234" href="#L234">234</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L235" href="#L235">235</a><span class="code-text"><a-p>  </a-p><a-v>mcVersion</a-v><a-p> = </a-p><a-v>modpack</a-v><a-p>.</a-p><a-v>manifest</a-v><a-p>.</a-p><a-v>versions</a-v><a-p>.</a-p><a-v>minecraft</a-v><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L236" href="#L236">236</a><span class="code-text"><a-p>  </a-p><a-v>fabricVersion</a-v><a-p> = </a-p><a-v>modpack</a-v><a-p>.</a-p><a-v>manifest</a-v><a-p>.</a-p><a-v>versions</a-v><a-p>.</a-p><a-v>fabric</a-v><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L237" href="#L237">237</a><span class="code-text"><a-p>  </a-p><a-v>serverVersion</a-v><a-p> = </a-p><a-v>lib</a-v><a-p>.</a-p><a-v>replaceStrings</a-v><a-p> [ </a-p><a-s>&quot;.&quot;</a-s><a-p> ] [ </a-p><a-s>&quot;_&quot;</a-s><a-p> ] </a-p><a-s>&quot;fabric-</a-s><a-p>${</a-p><a-eb>mcVersion</a-eb><a-p>}</a-p><a-s>&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L238" href="#L238">238</a><span class="code-text"><a-p>in</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L239" href="#L239">239</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L240" href="#L240">240</a><span class="code-text"><a-p>  </a-p><a-v>services</a-v><a-p>.</a-p><a-v>minecraft-servers</a-v><a-p>.</a-p><a-v>servers</a-v><a-p>.</a-p><a-v>cool-modpack</a-v><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L241" href="#L241">241</a><span class="code-text"><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="L242" href="#L242">242</a><span class="code-text"><a-p>    </a-p><a-v>package</a-v><a-p> = </a-p><a-v>pkgs</a-v><a-p>.</a-p><a-v>fabricServers</a-v><a-p>.${</a-p><a-eb>serverVersion</a-eb><a-p>}.</a-p><a-v>override</a-v><a-p> { </a-p><a-v>loaderVersion</a-v><a-p> = </a-p><a-v>fabricVersion</a-v><a-p>; };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L243" href="#L243">243</a><span class="code-text"><a-p>    </a-p><a-v>symlinks</a-v><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L244" href="#L244">244</a><span class="code-text"><a-p>      </a-p><a-s>&quot;mods&quot;</a-s><a-p> = </a-p><a-s>&quot;</a-s><a-p>${</a-p><a-eb>modpack</a-eb><a-p>}</a-p><a-s>/mods&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L245" href="#L245">245</a><span class="code-text"><a-p>    };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L246" href="#L246">246</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L247" href="#L247">247</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L248" href="#L248">248</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L249" href="#L249">249</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L250" href="#L250">250</a><span class="code-text"><a-p>**Note**: Using `manifest`, by default, will cause [IFD](https://nixos.wiki/wiki/Import_From_Derivation). If you want to avoid IFD while still having access to `manifest`, simply pass a `manifestHash` to the `fetchPackwizModpack` function, it will then fetch the manifest through `builtins.fetchurl`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L251" href="#L251">251</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L252" href="#L252">252</a><span class="code-text"><a-p>### </a-p><a-tt>Others</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L253" href="#L253">253</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L254" href="#L254">254</a><span class="code-text"><a-p>All of these packages are also available under `packages`, not just `legacyPackages`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L255" href="#L255">255</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L256" href="#L256">256</a><span class="code-text"><a-p>- `vanilla-server`: Same as `vanillaServers.vanilla`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L257" href="#L257">257</a><span class="code-text"><a-p>- `fabric-server`: Same as `fabricServers.fabric`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L258" href="#L258">258</a><span class="code-text"><a-p>- `quilt-server`: Same as `quiltServers.quilt`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L259" href="#L259">259</a><span class="code-text"><a-p>- `paper-server`: Same as `paperServers.paper`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L260" href="#L260">260</a><span class="code-text"><a-p>- `purpur-server`: Same as `purpurServers.purpur`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L261" href="#L261">261</a><span class="code-text"><a-p>- `neoforge-server`: Same as `neoforgeServers.neoforge`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L262" href="#L262">262</a><span class="code-text"><a-p>- `velocity-server`: Same as `velocityServers.velocity`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L263" href="#L263">263</a><span class="code-text"><a-p>- `minecraft-server`: Same as `vanilla-server`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L264" href="#L264">264</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L265" href="#L265">265</a><span class="code-text"><a-p>Server versions not found above can be setup manually via an override.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L266" href="#L266">266</a><span class="code-text"><a-p>For example, this override changes the path the launch script uses to your provided jar file, and does not modify the vanilla jar:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L267" href="#L267">267</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L268" href="#L268">268</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="L269" href="#L269">269</a><span class="code-text"><a-p>let</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L270" href="#L270">270</a><span class="code-text"><a-p>  </a-p><a-v>uberBukkit</a-v><a-p> = </a-p><a-v>pkgs</a-v><a-p>.</a-p><a-v>vanillaServers</a-v><a-p>.</a-p><a-v>vanilla</a-v><a-p>.</a-p><a-v>overrideAttrs</a-v><a-p> (</a-p><a-v>oldAttrs</a-v><a-p>: {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L271" href="#L271">271</a><span class="code-text"><a-p>    </a-p><a-v>src</a-v><a-p> = </a-p><a-s>./uberbukkit.jar</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L272" href="#L272">272</a><span class="code-text"><a-p>  });</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L273" href="#L273">273</a><span class="code-text"><a-p>in</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L274" href="#L274">274</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L275" href="#L275">275</a><span class="code-text"><a-p>  </a-p><a-v>services</a-v><a-p>.</a-p><a-v>minecraft-servers</a-v><a-p>.</a-p><a-v>servers</a-v><a-p>.</a-p><a-v>beta-server</a-v><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L276" href="#L276">276</a><span class="code-text"><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="L277" href="#L277">277</a><span class="code-text"><a-p>    </a-p><a-v>package</a-v><a-p> = </a-p><a-v>uberBukkit</a-v><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L278" href="#L278">278</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L279" href="#L279">279</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L280" href="#L280">280</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L281" href="#L281">281</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L282" href="#L282">282</a><span class="code-text"><a-p>#### </a-p><a-tt>`nix-modrinth-prefetch`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L283" href="#L283">283</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L284" href="#L284">284</a><span class="code-text"><a-p>[Source](./pkgs/tools/nix-modrinth-prefetch.nix)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L285" href="#L285">285</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L286" href="#L286">286</a><span class="code-text"><a-p>A helper script to fetch a Modrinth mod, which outputs the necessary `fetchurl` invocation.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L287" href="#L287">287</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L288" href="#L288">288</a><span class="code-text"><a-p>To use it, first find a mod on Modrinth, and click on the version you want.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L289" href="#L289">289</a><span class="code-text"><a-p>In the displayed information, there is a `Version ID` string.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L290" href="#L290">290</a><span class="code-text"><a-p>Click on it to copy the version ID.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L291" href="#L291">291</a><span class="code-text"><a-p>Then, run the script like so:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L292" href="#L292">292</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L293" href="#L293">293</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="L294" href="#L294">294</a><span class="code-text"><a-p>nix run github:Infinidoge/nix-minecraft#nix-modrinth-prefetch -- versionid</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L295" href="#L295">295</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L296" href="#L296">296</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L297" href="#L297">297</a><span class="code-text"><a-p>(This helper script can also be used in a temporary shell with `nix shell github:Infinidoge/nix-minecraft#nix-modrinth-prefetch`)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L298" href="#L298">298</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L299" href="#L299">299</a><span class="code-text"><a-p>This `fetchurl` invocation directly fetches the mod, and can be copy-pasted to wherever necessary.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L300" href="#L300">300</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L301" href="#L301">301</a><span class="code-text"><a-p>## </a-p><a-tt>Modules</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L302" href="#L302">302</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L303" href="#L303">303</a><span class="code-text"><a-p>### </a-p><a-tt>`services.minecraft-servers`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L304" href="#L304">304</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L305" href="#L305">305</a><span class="code-text"><a-p>[Source](./modules/minecraft-servers.nix)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L306" href="#L306">306</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L307" href="#L307">307</a><span class="code-text"><a-p>Module for hosting multiple servers at once. All of the following are under this module.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L308" href="#L308">308</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L309" href="#L309">309</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L310" href="#L310">310</a><span class="code-text"><a-p>#### </a-p><a-tt>`enable`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L311" href="#L311">311</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L312" href="#L312">312</a><span class="code-text"><a-p>If enabled, the servers in `services.minecraft-servers.servers` will be created and started as applicable. </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L313" href="#L313">313</a><span class="code-text"><a-p>The data for the servers will be loaded from and saved to `dataDir`, and any sockets will be put in `runDir`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L314" href="#L314">314</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L315" href="#L315">315</a><span class="code-text"><a-p>#### </a-p><a-tt>`eula`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L316" href="#L316">316</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L317" href="#L317">317</a><span class="code-text"><a-p>Whether you agree to [Mojang&#39;s EULA](https://account.mojang.com/documents/minecraft_eula). </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L318" href="#L318">318</a><span class="code-text"><a-p>This option must be set to true to run any Minecraft servers.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L319" href="#L319">319</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L320" href="#L320">320</a><span class="code-text"><a-p>#### </a-p><a-tt>`openFirewall`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L321" href="#L321">321</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L322" href="#L322">322</a><span class="code-text"><a-p>Whether to open ports in the firewall for each server. Sets the default for `servers.&lt;name&gt;.openFirewall`. </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L323" href="#L323">323</a><span class="code-text"><a-p>This will only work if the ports are specified in `servers.&lt;name&gt;.serverProperties`, otherwise it will use the default ports.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L324" href="#L324">324</a><span class="code-text"><a-p>Remember to change the ports if you running multiple servers.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L325" href="#L325">325</a><span class="code-text"><a-p>The module asserts that servers with `openFirewall` set do not have conflicting ports to try to catch this.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L326" href="#L326">326</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L327" href="#L327">327</a><span class="code-text"><a-p>#### </a-p><a-tt>`dataDir`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L328" href="#L328">328</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L329" href="#L329">329</a><span class="code-text"><a-p>Directory to store the Minecraft servers. Defaults to `/srv/minecraft`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L330" href="#L330">330</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L331" href="#L331">331</a><span class="code-text"><a-p>Each server will be under a subdirectory named after the server name, such as `/srv/minecraft/servername`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L332" href="#L332">332</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L333" href="#L333">333</a><span class="code-text"><a-p>#### </a-p><a-tt>`runDir`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L334" href="#L334">334</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L335" href="#L335">335</a><span class="code-text"><a-p>Directory to place the runtime tmux sockets into. Defaults to `/run/minecraft`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L336" href="#L336">336</a><span class="code-text"><a-p>Each server&#39;s console will be a tmux socket file in the form of servername.sock. To connect to the console, run `tmux -S /run/minecraft/servername.sock attach`, press `Ctrl + b` then `d` to detach.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L337" href="#L337">337</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L338" href="#L338">338</a><span class="code-text"><a-p>#### </a-p><a-tt>`user`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L339" href="#L339">339</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L340" href="#L340">340</a><span class="code-text"><a-p>Name of the user to create and run servers under. It is recommended to leave this as the default, as it is the same user as `services.minecraft-server`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L341" href="#L341">341</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L342" href="#L342">342</a><span class="code-text"><a-p>#### </a-p><a-tt>`group`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L343" href="#L343">343</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L344" href="#L344">344</a><span class="code-text"><a-p>Name of the group to create and run servers under. In order to modify the server files or attach to the tmux socket, your user must be a part of this group. It is recommended to leave this as the default, as it is the same group as `services.minecraft-server`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L345" href="#L345">345</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L346" href="#L346">346</a><span class="code-text"><a-p>#### </a-p><a-tt>`environmentFile`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L347" href="#L347">347</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L348" href="#L348">348</a><span class="code-text"><a-p>File consisting of lines in the form `varname=value` to define environment variables for the minecraft servers. </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L349" href="#L349">349</a><span class="code-text"><a-p>Secrets (database passwords, secret keys, etc.) can be substituted into server files without adding them to the Nix store by defining them in the environment file and adding them `servers.&lt;name&gt;.files` with the syntax `@varname@`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L350" href="#L350">350</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L351" href="#L351">351</a><span class="code-text"><a-p>### </a-p><a-tt>`servers.&lt;name&gt;`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L352" href="#L352">352</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L353" href="#L353">353</a><span class="code-text"><a-p>This family of options govern individual servers, which will be created on boot.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L354" href="#L354">354</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L355" href="#L355">355</a><span class="code-text"><a-p>#### </a-p><a-tt>`servers.&lt;name&gt;.enable`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L356" href="#L356">356</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L357" href="#L357">357</a><span class="code-text"><a-p>Whether to enable this server. If set to false, does **NOT** delete any data in the data directory, just does not generate the service file.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L358" href="#L358">358</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L359" href="#L359">359</a><span class="code-text"><a-p>#### </a-p><a-tt>`servers.&lt;name&gt;.autoStart`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L360" href="#L360">360</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L361" href="#L361">361</a><span class="code-text"><a-p>Whether to start this server on boot. If set to false, can still be started with `systemctl start minecraft-server-servername`. </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L362" href="#L362">362</a><span class="code-text"><a-p>Requires the server to be enabled.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L363" href="#L363">363</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L364" href="#L364">364</a><span class="code-text"><a-p>#### </a-p><a-tt>`servers.&lt;name&gt;.openFirewall`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L365" href="#L365">365</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L366" href="#L366">366</a><span class="code-text"><a-p>Whether to open ports in the firewall for this server.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L367" href="#L367">367</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L368" href="#L368">368</a><span class="code-text"><a-p>#### </a-p><a-tt>`servers.&lt;name&gt;.restart`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L369" href="#L369">369</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L370" href="#L370">370</a><span class="code-text"><a-p>Value of systemd&#39;s `Restart=` service configuration option. </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L371" href="#L371">371</a><span class="code-text"><a-p>Due to the servers being started in tmux sockets, values other than &quot;no&quot; and &quot;always&quot; may not work properly. </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L372" href="#L372">372</a><span class="code-text"><a-p>As a consequence of the &quot;always&quot; option, stopping the server in-game with the /stop command will cause the server to automatically restart</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L373" href="#L373">373</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L374" href="#L374">374</a><span class="code-text"><a-p>To prevent infinite crash loops, there is a start limit of 5 times within 2 minutes.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L375" href="#L375">375</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L376" href="#L376">376</a><span class="code-text"><a-p>#### </a-p><a-tt>`servers.&lt;name&gt;.enableReload`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L377" href="#L377">377</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L378" href="#L378">378</a><span class="code-text"><a-p>Reload server when configuration changes instead of restarting. </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L379" href="#L379">379</a><span class="code-text"><a-p>This re-links/copies the declared symlinks/files. </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L380" href="#L380">380</a><span class="code-text"><a-p>You can include additional actions (even in-game commands) by setting `&lt;name&gt;`.extraReload.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L381" href="#L381">381</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L382" href="#L382">382</a><span class="code-text"><a-p>#### </a-p><a-tt>`servers.&lt;name&gt;.extraReload`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L383" href="#L383">383</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L384" href="#L384">384</a><span class="code-text"><a-p>Extra commands to run when reloading the service. Only has an effect if `&lt;name&gt;.enableReload` is true.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L385" href="#L385">385</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L386" href="#L386">386</a><span class="code-text"><a-p>#### </a-p><a-tt>`servers.&lt;name&gt;.whitelist`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L387" href="#L387">387</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L388" href="#L388">388</a><span class="code-text"><a-p>Whitelisted players, only has an effect when `&lt;name&gt;.serverProperties.white-list = true;`. </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L389" href="#L389">389</a><span class="code-text"><a-p>When empty/unspecified, the whitelist file is not managed declaratively, allowing for use of the whitelist commands.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L390" href="#L390">390</a><span class="code-text"><a-p>Example: </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L391" href="#L391">391</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L392" href="#L392">392</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L393" href="#L393">393</a><span class="code-text"><a-p>  username1 = &quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L394" href="#L394">394</a><span class="code-text"><a-p>  username2 = &quot;yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy&quot;;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L395" href="#L395">395</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L396" href="#L396">396</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L397" href="#L397">397</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L398" href="#L398">398</a><span class="code-text"><a-p>#### </a-p><a-tt>`servers.&lt;name&gt;.operators`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L399" href="#L399">399</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L400" href="#L400">400</a><span class="code-text"><a-p>Server operators. See [The Documentation](https://minecraft.wiki/w/Ops.json_format). Example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L401" href="#L401">401</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L402" href="#L402">402</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L403" href="#L403">403</a><span class="code-text"><a-p>  username1 = &quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L404" href="#L404">404</a><span class="code-text"><a-p>  username2 = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L405" href="#L405">405</a><span class="code-text"><a-p>    uuid = &quot;yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy&quot;;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L406" href="#L406">406</a><span class="code-text"><a-p>    level = 3;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L407" href="#L407">407</a><span class="code-text"><a-p>    bypassesPlayerLimit = true;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L408" href="#L408">408</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L409" href="#L409">409</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L410" href="#L410">410</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L411" href="#L411">411</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L412" href="#L412">412</a><span class="code-text"><a-p>#### </a-p><a-tt>`servers.&lt;name&gt;.bannedPlayers`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L413" href="#L413">413</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L414" href="#L414">414</a><span class="code-text"><a-p>Banned players. See [The Documentation](https://docs.papermc.io/paper/reference/vanilla-data-files/). Example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L415" href="#L415">415</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L416" href="#L416">416</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L417" href="#L417">417</a><span class="code-text"><a-p>  username1 = &quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L418" href="#L418">418</a><span class="code-text"><a-p>  username2 = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L419" href="#L419">419</a><span class="code-text"><a-p>    uuid = &quot;yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy&quot;;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L420" href="#L420">420</a><span class="code-text"><a-p>    created = &quot;2025-12-01 09:00:00 -0500&quot;;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L421" href="#L421">421</a><span class="code-text"><a-p>    source = &quot;(Unknown)&quot;;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L422" href="#L422">422</a><span class="code-text"><a-p>    expires = &quot;forever&quot;;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L423" href="#L423">423</a><span class="code-text"><a-p>    reason = &quot;Banned by an operator.&quot;;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L424" href="#L424">424</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L425" href="#L425">425</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L426" href="#L426">426</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L427" href="#L427">427</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L428" href="#L428">428</a><span class="code-text"><a-p>#### </a-p><a-tt>`servers.&lt;name&gt;.serverProperties`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L429" href="#L429">429</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L430" href="#L430">430</a><span class="code-text"><a-p>Minecraft server properties for the server.properties file of this server. See [The Documentation](https://minecraft.wiki/w/Server.properties) on these values. Example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L431" href="#L431">431</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L432" href="#L432">432</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L433" href="#L433">433</a><span class="code-text"><a-p>  server-port = 43000;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L434" href="#L434">434</a><span class="code-text"><a-p>  difficulty = 3;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L435" href="#L435">435</a><span class="code-text"><a-p>  gamemode = 1;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L436" href="#L436">436</a><span class="code-text"><a-p>  max-players = 5;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L437" href="#L437">437</a><span class="code-text"><a-p>  motd = &quot;NixOS Minecraft server!&quot;;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L438" href="#L438">438</a><span class="code-text"><a-p>  white-list = true;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L439" href="#L439">439</a><span class="code-text"><a-p>  enable-rcon = true;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L440" href="#L440">440</a><span class="code-text"><a-p>  &quot;rcon.password&quot; = &quot;hunter2&quot;;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L441" href="#L441">441</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L442" href="#L442">442</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L443" href="#L443">443</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L444" href="#L444">444</a><span class="code-text"><a-p>#### </a-p><a-tt>`servers.&lt;name&gt;.package`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L445" href="#L445">445</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L446" href="#L446">446</a><span class="code-text"><a-p>The Minecraft server package to use. Example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L447" href="#L447">447</a><span class="code-text"><a-p>`pkgs.minecraftServers.vanilla-1_18_2`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L448" href="#L448">448</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L449" href="#L449">449</a><span class="code-text"><a-p>#### </a-p><a-tt>`servers.&lt;name&gt;.jvmOpts`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L450" href="#L450">450</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L451" href="#L451">451</a><span class="code-text"><a-p>JVM Options for this server, usually used to set ram amount. Example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L452" href="#L452">452</a><span class="code-text"><a-p>`-Xms6144M -Xmx8192M`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L453" href="#L453">453</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L454" href="#L454">454</a><span class="code-text"><a-p>#### </a-p><a-tt>`servers.&lt;name&gt;.symlinks`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L455" href="#L455">455</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L456" href="#L456">456</a><span class="code-text"><a-p>This option is special in that it allows for declarative management of arbitrary things inside of the server&#39;s folder. </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L457" href="#L457">457</a><span class="code-text"><a-p>If the file already exists, existing one will have a `.bak` suffix added to it. If it is replaced again the previous backup will be overwritten.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L458" href="#L458">458</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L459" href="#L459">459</a><span class="code-text"><a-p>How it works is that it takes an attrset of derivations, and symlinks each derivation into place with the name of the attribute in the attrset.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L460" href="#L460">460</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L461" href="#L461">461</a><span class="code-text"><a-p>For example,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L462" href="#L462">462</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L463" href="#L463">463</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="L464" href="#L464">464</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L465" href="#L465">465</a><span class="code-text"><a-p>  </a-p><a-v>symlinks</a-v><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L466" href="#L466">466</a><span class="code-text"><a-p>    </a-p><a-v>text-file</a-v><a-p> = </a-p><a-v>pkgs</a-v><a-p>.</a-p><a-v>writeTextFile</a-v><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L467" href="#L467">467</a><span class="code-text"><a-p>      </a-p><a-v>name</a-v><a-p> = </a-p><a-s>&quot;text-file&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L468" href="#L468">468</a><span class="code-text"><a-p>      </a-p><a-v>text</a-v><a-p> = </a-p><a-s>&quot;Some text&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L469" href="#L469">469</a><span class="code-text"><a-p>    };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L470" href="#L470">470</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L471" href="#L471">471</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L472" href="#L472">472</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L473" href="#L473">473</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L474" href="#L474">474</a><span class="code-text"><a-p>Would symlink a file containing `&quot;Some text&quot;` into the server&#39;s folder.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L475" href="#L475">475</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L476" href="#L476">476</a><span class="code-text"><a-p>This option is quite powerful, and can be used for a number of things, though most notably it can be used for declaratively setting up mods or plugins for the server.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L477" href="#L477">477</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L478" href="#L478">478</a><span class="code-text"><a-p>This example takes an attrset of the IDs and hashes for Modrinth mods, fetches each one, and makes a folder containing those mods. (`linkFarmFromDrvs` is quite useful because it can take a list of derivations and produce a folder suitable for this purpose.) The names in this attrset are meaningless, I only included them as convenient labels.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L479" href="#L479">479</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L480" href="#L480">480</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="L481" href="#L481">481</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L482" href="#L482">482</a><span class="code-text"><a-p>  </a-p><a-v>symlinks</a-v><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L483" href="#L483">483</a><span class="code-text"><a-p>    </a-p><a-v>mods</a-v><a-p> = </a-p><a-v>pkgs</a-v><a-p>.</a-p><a-v>linkFarmFromDrvs</a-v><a-p> </a-p><a-s>&quot;mods&quot;</a-s><a-p> (</a-p><a-v>builtins</a-v><a-p>.</a-p><a-v>attrValues</a-v><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L484" href="#L484">484</a><span class="code-text"><a-p>      </a-p><a-v>Starlight</a-v><a-p> = </a-p><a-v>fetchurl</a-v><a-p> { </a-p><a-v>url</a-v><a-p> = </a-p><a-s>&quot;https://cdn.modrinth.com/data/H8CaAYZC/versions/XGIsoVGT/starlight-1.1.2%2Bfabric.dbc156f.jar&quot;</a-s><a-p>; </a-p><a-v>sha512</a-v><a-p> = </a-p><a-s>&quot;6b0e363fc2d6cd2f73b466ab9ba4f16582bb079b8449b7f3ed6e11aa365734af66a9735a7203cf90f8bc9b24e7ce6409eb04d20f84e04c7c6b8e34f4cc8578bb&quot;</a-s><a-p>; };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L485" href="#L485">485</a><span class="code-text"><a-p>      </a-p><a-v>Lithium</a-v><a-p> = </a-p><a-v>fetchurl</a-v><a-p> { </a-p><a-v>url</a-v><a-p> = </a-p><a-s>&quot;https://cdn.modrinth.com/data/gvQqBUqZ/versions/ZSNsJrPI/lithium-fabric-mc1.20.1-0.11.2.jar&quot;</a-s><a-p>; </a-p><a-v>sha512</a-v><a-p> = </a-p><a-s>&quot;d1b5c90ba8b4879814df7fbf6e67412febbb2870e8131858c211130e9b5546e86b213b768b912fc7a2efa37831ad91caf28d6d71ba972274618ffd59937e5d0d&quot;</a-s><a-p>; };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L486" href="#L486">486</a><span class="code-text"><a-p>      </a-p><a-v>FerriteCore</a-v><a-p> = </a-p><a-v>fetchurl</a-v><a-p> { </a-p><a-v>url</a-v><a-p> = </a-p><a-s>&quot;https://cdn.modrinth.com/data/uXXizFIs/versions/ULSumfl4/ferritecore-6.0.0-forge.jar&quot;</a-s><a-p>; </a-p><a-v>sha512</a-v><a-p> = </a-p><a-s>&quot;e78ddd02cca0a4553eb135dbb3ec6cbc59200dd23febf3491d112c47a0b7e9fe2b97f97a3d43bb44d69f1a10aad01143dcd84dc575dfa5a9eaa315a3ec182b37&quot;</a-s><a-p>; };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L487" href="#L487">487</a><span class="code-text"><a-p>      </a-p><a-v>Krypton</a-v><a-p> = </a-p><a-v>fetchurl</a-v><a-p> { </a-p><a-v>url</a-v><a-p> = </a-p><a-s>&quot;https://cdn.modrinth.com/data/fQEb0iXm/versions/jiDwS0W1/krypton-0.2.3.jar&quot;</a-s><a-p>; </a-p><a-v>sha512</a-v><a-p> = </a-p><a-s>&quot;92b73a70737cfc1daebca211bd1525de7684b554be392714ee29cbd558f2a27a8bdda22accbe9176d6e531d74f9bf77798c28c3e8559c970f607422b6038bc9e&quot;</a-s><a-p>; };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L488" href="#L488">488</a><span class="code-text"><a-p>      </a-p><a-v>LazyDFU</a-v><a-p> = </a-p><a-v>fetchurl</a-v><a-p> { </a-p><a-v>url</a-v><a-p> = </a-p><a-s>&quot;https://cdn.modrinth.com/data/hvFnDODi/versions/0.1.3/lazydfu-0.1.3.jar&quot;</a-s><a-p>; </a-p><a-v>sha512</a-v><a-p> = </a-p><a-s>&quot;dc3766352c645f6da92b13000dffa80584ee58093c925c2154eb3c125a2b2f9a3af298202e2658b039c6ee41e81ca9a2e9d4b942561f7085239dd4421e0cce0a&quot;</a-s><a-p>; };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L489" href="#L489">489</a><span class="code-text"><a-p>      </a-p><a-v>C2ME</a-v><a-p> = </a-p><a-v>fetchurl</a-v><a-p> { </a-p><a-v>url</a-v><a-p> = </a-p><a-s>&quot;https://cdn.modrinth.com/data/VSNURh3q/versions/t4juSkze/c2me-fabric-mc1.20.1-0.2.0%2Balpha.10.91.jar&quot;</a-s><a-p>; </a-p><a-v>sha512</a-v><a-p> = </a-p><a-s>&quot;562c87a50f380c6cd7312f90b957f369625b3cf5f948e7bee286cd8075694a7206af4d0c8447879daa7a3bfe217c5092a7847247f0098cb1f5417e41c678f0c1&quot;</a-s><a-p>; };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L490" href="#L490">490</a><span class="code-text"><a-p>    });</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L491" href="#L491">491</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L492" href="#L492">492</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L493" href="#L493">493</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L494" href="#L494">494</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L495" href="#L495">495</a><span class="code-text"><a-p>`symlinks` is also able to automatically infer the format of certain extensions:  `yml, yaml, json, props, properties, toml, ini, txt`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L496" href="#L496">496</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L497" href="#L497">497</a><span class="code-text"><a-p>For example,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L498" href="#L498">498</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="L499" href="#L499">499</a><span class="code-text"><a-p>symlinks.</a-p><a-s>&quot;myfile.json&quot;</a-s><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L500" href="#L500">500</a><span class="code-text"><a-p>  </a-p><a-v>value</a-v><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L501" href="#L501">501</a><span class="code-text"><a-p>    </a-p><a-v>option</a-v><a-p> = </a-p><a-s>&quot;value&quot;</a-s><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L502" href="#L502">502</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L503" href="#L503">503</a><span class="code-text"><a-p>};</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L504" href="#L504">504</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L505" href="#L505">505</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L506" href="#L506">506</a><span class="code-text"><a-p>Would symlink a file containing the following into the server&#39;s folder:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L507" href="#L507">507</a><span class="code-text"><a-p>```</a-p><a-tl>json</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L508" href="#L508">508</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L509" href="#L509">509</a><span class="code-text"><a-p>  </a-p><a-s>&quot;option&quot;</a-s><a-p>: </a-p><a-s>&quot;value&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L510" href="#L510">510</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L511" href="#L511">511</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L512" href="#L512">512</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L513" href="#L513">513</a><span class="code-text"><a-p>Other formats are able to be generated by providing a format function: [Example Functions](https://github.com/NixOS/nixpkgs/blob/e7b543ba95681a01148d8c267d668bdcbd521fcb/pkgs/pkgs-lib/formats.nix)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L514" href="#L514">514</a><span class="code-text"><a-p>Example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L515" href="#L515">515</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="L516" href="#L516">516</a><span class="code-text"><a-p>let</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L517" href="#L517">517</a><span class="code-text"><a-p>  </a-p><a-v>extList</a-v><a-p> = {}: {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L518" href="#L518">518</a><span class="code-text"><a-p>    </a-p><a-v>type</a-v><a-p> = </a-p><a-k>with</a-k><a-p> </a-p><a-v>lib</a-v><a-p>.</a-p><a-v>types</a-v><a-p>; </a-p><a-v>listOf</a-v><a-p> </a-p><a-v>str</a-v><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L519" href="#L519">519</a><span class="code-text"><a-p>    </a-p><a-v>generate</a-v><a-p> = </a-p><a-v>name</a-v><a-p>: </a-p><a-v>value</a-v><a-p>: </a-p><a-v>pkgs</a-v><a-p>.</a-p><a-v>writeText</a-v><a-p> </a-p><a-v>name</a-v><a-p> (</a-p><a-v>lib</a-v><a-p>.</a-p><a-v>concatStringsSep</a-v><a-p> </a-p><a-s>&quot;\n&quot;</a-s><a-p> </a-p><a-v>value</a-v><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L520" href="#L520">520</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L521" href="#L521">521</a><span class="code-text"><a-p>in</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L522" href="#L522">522</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L523" href="#L523">523</a><span class="code-text"><a-p>  </a-p><a-v>symlinks</a-v><a-p>.</a-p><a-s>&quot;myfile.ext&quot;</a-s><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L524" href="#L524">524</a><span class="code-text"><a-p>    </a-p><a-v>format</a-v><a-p> = </a-p><a-v>extList</a-v><a-p> {};</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L525" href="#L525">525</a><span class="code-text"><a-p>    </a-p><a-v>value</a-v><a-p> = [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L526" href="#L526">526</a><span class="code-text"><a-p>      </a-p><a-s>&quot;Hi!&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L527" href="#L527">527</a><span class="code-text"><a-p>      </a-p><a-s>&quot;Hello!&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L528" href="#L528">528</a><span class="code-text"><a-p>    ];</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L529" href="#L529">529</a><span class="code-text"><a-p>  };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L530" href="#L530">530</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L531" href="#L531">531</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L532" href="#L532">532</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L533" href="#L533">533</a><span class="code-text"><a-p>#### </a-p><a-tt>`servers.&lt;name&gt;.files`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L534" href="#L534">534</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L535" href="#L535">535</a><span class="code-text"><a-p>Things to copy into this server&#39;s data directory. Every option and example in `symlinks` works the same way for `files`, except that actual files are generated. Useful for configuration files that don&#39;t behave well when read-only.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L536" href="#L536">536</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L537" href="#L537">537</a><span class="code-text"><a-p>For example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L538" href="#L538">538</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="L539" href="#L539">539</a><span class="code-text"><a-p>files.</a-p><a-s>&quot;white-list.txt&quot;</a-s><a-p> = {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L540" href="#L540">540</a><span class="code-text"><a-p>  </a-p><a-v>value</a-v><a-p> = [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L541" href="#L541">541</a><span class="code-text"><a-p>    </a-p><a-s>&quot;person1&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L542" href="#L542">542</a><span class="code-text"><a-p>    </a-p><a-s>&quot;person2&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L543" href="#L543">543</a><span class="code-text"><a-p>    </a-p><a-s>&quot;person3&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L544" href="#L544">544</a><span class="code-text"><a-p>  ];</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L545" href="#L545">545</a><span class="code-text"><a-p>};</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L546" href="#L546">546</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L547" href="#L547">547</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L548" href="#L548">548</a><span class="code-text">generates a legacy `white-list.txt` that is needed for older minecraft versions (&lt; 1.7.6)</span></span></pre></div></div>
</main>
</body>
</html>
