Skip to content

Commit d4bb2a2

Browse files
mrshmllowuku3lig
andauthored
Add nix-specific notes to help new users (#40)
* Add nix-specific notes to help new users * fix kinda weird sentence in readme * incorporate suggestions * Update doc/00_installation.md Co-authored-by: uku <hi@uku.moe> * Update doc/00_installation.md Co-authored-by: uku <hi@uku.moe> * Update doc/00_installation.md Co-authored-by: uku <hi@uku.moe> * Update doc/00_setup.md Co-authored-by: uku <hi@uku.moe> * Update 00_installation.md --------- Co-authored-by: uku <hi@uku.moe>
1 parent a8c9160 commit d4bb2a2

File tree

3 files changed

+58
-5
lines changed

3 files changed

+58
-5
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ successor to [resetti](https://github.com/tesselslate/resetti).
1111
1212
# Installation
1313

14-
Distribution-specific packages are currently only available for Arch through
15-
the AUR.
14+
Waywall is available on Arch through the AUR and on systems with Nix through Nixpkgs.
1615

1716
- [Arch Linux (AUR)](https://aur.archlinux.org/packages/waywall-working-git)
17+
- [Nix (Nixpkgs)](https://search.nixos.org/packages?channel=unstable&query=waywall)
1818

1919
Users on other distributions must [build waywall from source](#building-from-source),
2020
download a prebuilt package from the [Releases](https://github.com/tesselslate/waywall/releases)

doc/00_installation.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,54 @@
11
# Installation
22

3-
Distribution-specific packages are currently only available for Arch through
4-
the AUR.
3+
waywall is available on Arch through the AUR and on systems with Nix through Nixpkgs.
54

65
- [Arch Linux (AUR)](https://aur.archlinux.org/packages/waywall-working-git)
6+
- [Nix (Nixpkgs)](https://search.nixos.org/packages?channel=unstable&query=waywall)
77

88
Users on other distributions must download a prebuilt package from the
99
[Releases](https://github.com/tesselslate/waywall/releases) page or build
1010
waywall from source.
1111

12+
## Installing with Nix
13+
14+
waywall is available in Nixpkgs since 26.05.
15+
16+
If it is available, waywall should be installed on your NixOS or Home Manager profile.
17+
18+
### NixOS
19+
20+
```nix
21+
# configuration.nix
22+
{ pkgs, ... }:
23+
{
24+
environment.systemPackages = [
25+
pkgs.prismlauncher
26+
pkgs.waywall
27+
];
28+
}
29+
```
30+
31+
### Home Manager
32+
33+
```nix
34+
# home.nix
35+
{ pkgs, ... }:
36+
{
37+
home.packages = [
38+
pkgs.prismlauncher
39+
pkgs.waywall
40+
];
41+
}
42+
```
43+
44+
### Nix Profile
45+
46+
On other distributions with Nix installed, it can be installed with:
47+
48+
```
49+
$ nix profile install nixpkgs#waywall
50+
```
51+
1252
## Building with the packaging script
1353

1454
The package building script is able to create binary packages for Arch Linux,

doc/00_setup.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@ GLFW.
2323
> script, then you already have the correct version of GLFW available! It can be
2424
> found at `/usr/local/lib64/waywall-glfw/libglfw.so`.
2525
26+
> [!TIP]
27+
> If you are using Prism Launcher installed from Nixpkgs, you can skip and
28+
> continue to the next step as it already includes the patch.
29+
>
30+
> If you have Nix but are using Prism Launcher from a *different* source, you can
31+
> install the `glfw3-minecraft` package with `nix profile` and use the path
32+
> `/home/USER/.nix-profile/lib/libglfw.so` in the upcoming steps.
33+
2634
You can compile the patched version of GLFW with the following commands:
2735

2836
```sh
@@ -66,12 +74,17 @@ on whether you are on PrismLauncher or MultiMC.
6674
You can configure your instance to use the patched version of GLFW by opening
6775
its settings (with the `Edit` button on the right pane) and going to `Settings`
6876
-> `Workarounds`. Then, enable `Native libraries` and `Use system installation
69-
of GLFW`. Finally, enter the path to the patched `libglfw.so` you just compiled.
77+
of GLFW`. Finally, enter the path to the patched `libglfw.so` you just compiled
78+
or installed.
7079

7180
> [!IMPORTANT]
7281
> Prism Launcher **will not expand** `~`. If your patched GLFW is within your
7382
> home directory, you need to type out the absolute path.
7483
84+
> [!TIP]
85+
> If you are using Prism Launcher installed from Nixpkgs, you must leave the path
86+
> field empty to automatically use the patched GLFW.
87+
7588
![The Prism Launcher menu for enabling patched GLFW](assets/prism-glfw.png)
7689

7790
### MultiMC

0 commit comments

Comments
 (0)