README.md

WiVRn

GitHub

In order to compile WiVRn with Nvenc, you must have cudaSupport set in your NixOS configuration (nixpkgs.config.cudaSupport).

Note

There is an issue where Lemonake won't inherit your cudaSupport resulting in Nvenc never being built. For now, override the value like so: inputs.lemonake.packages.${pkgs.system}.wivrn-git.override { cudaSupport = true; }

If you use Nvidia, it is recommended to install the monado-vulkan-layers package to mitigate crashes with OpenXR. Add it to hardware.opengl.extraPackages.

Example usage

# configuration.nix
{
  services.wivrn = {
    enable = true;
    package = pkgs.wivrn;
    openFirewall = true;
    highPriority = true;
    defaultRuntime = true;
    monadoEnvironment = {
      XRT_COMPOSITOR_LOG = "warning";
    };
    extraServerFlags = [ "--no-publish-service" ]
    config = {
      enable = true;
      json = {
        scale = 0.5;
        bitrate = 100000000;
        encoders = [
          {
            encoder = "nvenc";
            codec = "h264";
            width = 1.0;
            height = 1.0;
            offset_x = 0.0;
            offset_y = 0.0;
          }
        ];
        # Different application examples:
        application = pkgs.wlx-overlay-s;
        application = [ pkgs.wlx-overlay-s ];
        application = [ pkgs.wlx-overlay-s "--openxr" ];
      };
    };
  };
}

Note

Note that the application option must be either a package or a list with package as the first element.

Full overview

# configuration.nix
{
  services.wivrn = {
    enable = { type = bool; default = false; };
    package = { type = package; default = pkgs.wivrn; };
    openFirewall = { type = bool; default = false; };
    highPriority = { type = bool; default = true; };
    defaultRuntime = { type = bool; default = true; };
    extraServerFlags = {
      type = types.listOf types.str;
      default = [ ];
    };
    extraApplicationFlags = {
      type = types.listOf types.str;
      default = [ ];
    };
    extraPackages = {
      type = types.listOf types.package;
      default = [ ];
    };
    monadoEnvironment = {
      type = types.attrsOf types.str;
      default = {
        XRT_COMPOSITOR_LOG = "debug";
        XRT_PRINT_OPTIONS = "on";
        IPC_EXIT_ON_DISCONNECT = "off";
      };
    };
    config = {
      enable = { type = bool; default = true; };
      json = {
        type = formats.json;
        default = { };
        application = "See note above";
      };
    };
  };
}