█░█ ▀█▀ █▄░█ ▀█▀ ▄▀█ █▀▀ █▀▀ █▀ ▀█▀ █▀█ █▀█ ▀▄▀ ▄▄ █▄░█ ▀█▀ ▀▄▀
▀▄▀ ▄█▄ █░▀█ ░█░ █▀█ █▄█ ██▄ ▄█ ░█░ █▄█ █▀▄ ░█░ ░░ █░▀█ ▄█▄ ▄▀▄

---

A flake to help you on your Vintage Story journey on NixOS.

Documentation
📦Packages 🔧Tools

Features

📦 All game versions, down to 1.18.8

Get the full list using the following command:

nix flake show github:PierreBorine/vintagestory-nix

🧪 Release Candidates and Pre Releases

🔧 Modding tools with Home Manager modules

• VS Launcher (MIT) - github - moddb - module
• Rustique (MIT) - github - moddb
• VS Model Creator (Apache 2.0) - github -wiki
• MVL (MIT) - github - moddb - module

Usage

Add this flake as an input to yours

# flake.nix
inputs = {
  vintagestory-nix = {
    url = "github:PierreBorine/vintagestory-nix";
    inputs.nixpkgs.follows = "nixpkgs";
  };
};

Add the overlay

# configuration.nix
{inputs, ...}: {
  nixpkgs.overlays = [inputs.vintagestory-nix.overlays.default];
}

Vintage Story packages

See the relevant README for more complete docs.

{pkgs, ...}: {
  home.packages = [
    pkgs.vintagestoryPackages.v1-20-12
    pkgs.vintagestoryPackages.v1-21-1-rc-2
    pkgs.vintagestoryPackages.v1-19  # ignores RCs
    pkgs.vintagestoryPackages.latest # ignores RCs
  ];
}

Modding Tools

See the relevant README for more complete docs.

{inputs, pkgs, ...}: {
  imports = [inputs.vintagestory-nix.homeModules.default];

  home.packages = [
    pkgs.vintagestoryPackages.rustique
    pkgs.vintagestoryPackages.vs-launcher
  ];

  # Recommended !!
  # As the builtin game downloader
  # won't work on NixOS.
  programs.vs-launcher = {
    enable = true;
    settings.gameVersions = [
      pkgs.vintagestoryPackages.v1-21-1
    ];
  };
}

Server

See the module file for more infos

# configuration.nix
{inputs, pkgs, ...}: {
  imports = [inputs.vintagestory-nix.nixosModules.default];

  services.vintagestory = {
    enable = true;
    package = pkgs.vintagestoryPackages.v1-21-0;
    openFirewall = true;
  };
}

Installing mods with Nix

This flake does not provide a way to declaratively install mods with Nix. Fortunately for you, vs2nix is another Vintage Story flake that packages the top 400 mods of modDB.

Thanks

• to the Vintage Story team for their incredible game
• to XurxoMF for making VS Launcher
• to dtomvan for the rustique derivation and the server module