diff options
-rw-r--r-- | README.md | 43 |
1 files changed, 26 insertions, 17 deletions
diff --git a/README.md b/README.md index b2fdbfae1c08..57c03df04d58 100644 --- a/README.md +++ b/README.md @@ -6,20 +6,21 @@ Because I **REALLY** had nothing better to do with my life. - A version of Minecraft >= 1.13 - - Older versions are not guaranteed to work. You can still try, though. + - Older versions use a version of LWJGL that doesn't work with this patch -- The MultiMC Minecraft Launcher +- MultiMC (or derivatives) (optional) - - Use it even if you don't plan to do this. It's great! - - If you don't want to do that, throw this into your Java arguments, changing - the file path as needed: `-Dorg.lwjgl.glfw.libname=/usr/lib/libglfw.so` + - Other launchers (not the official one) might or might not have similar settings + - If they don't, you can throw this into your Java arguments, changing the file + path as needed depending on your distro: + `-Dorg.lwjgl.glfw.libname=/usr/lib/libglfw.so` - A distro with a patched GLFW package - This guide has steps for Arch, Fedora, and Gentoo - Or the knowledge on how to patch packages in your distribution. - - In which case you can skip step 2 of this guide, as it will not apply to you - and you should know what to do with the `.patch` files in this repo already + - In which case you can skip step 2 of this guide, as it will not apply to you + and you should know what to do with the `.patch` files in this repo already ## Side effects @@ -27,10 +28,10 @@ Because I **REALLY** had nothing better to do with my life. - The controls page (and anywhere a keyboard key is shown) is a bit wonky - Keys you replace through your compositor (example: `caps:swapescape`) will require you to use the original key -- Originally made for Sway, GNOME needs to manually makepkg the `libdecoration` - branch for GNOME specific fixes or download an unofficial package listed below - (until a new GLFW version releases) - - I haven't received any bug reports from KDE, so it'll (probably) work +- Originally made for Sway, other desktops (GNOME, for example) might need to + manually makepkg the `libdecoration` branch for GNOME specific fixes or download + an unofficial package listed below (until a new GLFW version releases) + - KDE works on both branches, but with some [minor issues](https://github.com/Admicos/minecraft-wayland/issues/8#issuecomment-997155245) ## Step 1: Setting up MultiMC to use the system GLFW @@ -43,14 +44,14 @@ right direction. ## Step 2: Installing the patched GLFW library -If you're not under an Arch-based system, you're mostly on your own here. You -can try waiting for someone else to write a guide I guess. +If you're not under a distro with a guide here, you're mostly on your own. +You can try waiting for someone else to write a guide for your distro, I guess. ### Option 1: Use the AUR Install the `glfw-wayland-minecraft` package from the AUR. -If you're using GNOME, try using the **unofficial** +If you're using a desktop that needs it, try using the **unofficial** `glfw-wayland-minecraft-libdecoration` package, which packages the `libdecoration` branch of this repository to the AUR. @@ -59,15 +60,19 @@ If you're using GNOME, try using the **unofficial** `git clone` this repository to somewhere, and run `makepkg -si` inside. It will ask you to replace your existing GLFW package if already installed. -If you're using GNOME, consider running `git checkout libdecoration` before -running `makepkg -si`. This is a (probably) slightly unstable version that works -better on GNOME. +If you're using a desktop that needs it, consider running `git checkout libdecoration` +before running `makepkg -si`. This is a (probably) slightly unstable version that +works better on some desktops. ### Option 3: Install the Fedora package Install the Fedora package from https://copr.fedorainfracloud.org/coprs/lyessaadi/minecraft-wayland-glfw/. See https://github.com/Admicos/minecraft-wayland/issues/4 for more information. +You might need to change the Java arguments even if you are using a launcher that +can replace GLFW. See [this issue](https://github.com/Admicos/minecraft-wayland/issues/14) +for more details. + ### Option 4: Patch the Gentoo package Patch Gentoo's GLFW package by following the guide at https://github.com/Admicos/minecraft-wayland/issues/6 @@ -109,3 +114,7 @@ aren't even that old. Here are the proper credits: - `annacrombie` on GitHub - For https://github.com/glfw/glfw/pull/1711 + +- `christianrauch` on GitHub + + - For https://github.com/glfw/glfw/pull/1693 |