Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/drakon64/nixos-xivlauncher-rb

XIVLauncher-RB for NixOS
https://github.com/drakon64/nixos-xivlauncher-rb

nixos xivlauncher

Last synced: 2 months ago
JSON representation

XIVLauncher-RB for NixOS

Awesome Lists containing this project

README

        

# nixos-xivlauncher-rb

[XIVLauncher-RB](https://github.com/rankynbass/XIVLauncher.Core) for NixOS.

## Installation

Firstly your system must have Flakes enabled. To do this, add the following to your `configuration.nix` file:
```nix
nix.settings.experimental-features = [ "nix-command" "flakes" ];
```

Then run `sudo nixos-rebuilt test`, then create a `flake.nix` file in your NixOS configuration directory with the following content:

```nix
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.05"; # This should match the version of NixOS you want to use

nixos-xivlauncher-rb = {
url = "github:drakon64/nixos-xivlauncher-rb";
inputs.nixpkgs.follows = "nixpkgs";
};
};

outputs = inputs@{
self,
nixpkgs,
}:
{
nixosConfigurations = {
desktop = nixpkgs.lib.nixosSystem {
modules = [
./configuration.nix
];

specialArgs = {
inherit inputs;
};
};
};
};
}
```

Then you can add `xivlauncher-rb` to `configuration.nix` like so:

```nix
{
config,
lib,
pkgs,
inputs,
...
}:
...

environment.systemPackages = [
inputs.nixos-xivlauncher-rb.packages.x86_64-linux.default
];
```

### Overrides

#### GameMode

```nix
environment.systemPackages = [
(inputs.nixos-xivlauncher-rb.packages.x86_64-linux.default.override { useGameMode = true; })
];
```

#### DLSS

```nix
environment.systemPackages = [
(inputs.nixos-xivlauncher-rb.packages.x86_64-linux.default.override { nvngxPath = "${config.hardware.nvidia.package}/lib/nvidia/wine"; })
];
```

Now run `sudo nix flake update` in your NixOS configuration directory and rebuild your system as normal. Please note that the previous method of updating Nix channels will no longer work, you will have to use `sudo nix flake update` as long as Flakes are enabled.

## Credits

* [nur-packages-template](https://github.com/nix-community/nur-packages-template) for providing the template for a Nix Flake
* [sersorrel](https://github.com/sersorrel) and [witchof0x20](https://github.com/witchof0x20) for maintaining the [XIVLauncher package in Nixpkgs](https://github.com/NixOS/nixpkgs/tree/master/pkgs/by-name/xi/xivlauncher) which this heavily borrows from