diff --git a/README.md b/README.md index 2278711..0c366ee 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,12 @@ A tool that changes the resolution of a Sunshine host to an approximation of the **TLDR**: Sunshine is an ultra low latency display streaming server, and Moonlight is a client for it. I get around 1ms~ when using it for my tablet as a second display. ## What Does This Support? -Linux, specifically only GNOME's Wayland session at the moment ([and in a very hacky state...](https://git.coolbea.nz/oscarg/sunshine-snake-glue/src/branch/main/pkg/wayland_display_manager/gnome/__init__.py)). +Linux, specifically only GNOME's Wayland session at the moment. ### Support list: | Compositor | Support | | :--- | ---: | -| GNOME | ⚠️ (Work in progress / Hacky) | +| GNOME | ⚠️ (Functional/Work in progress) | | KDE Plasma | ❌ | | Sway | ❌ | | Hyprland | ❌ | @@ -26,7 +26,7 @@ Linux, specifically only GNOME's Wayland session at the moment ([and in a very h I don't think I'll ever extend this to support X11. Sunshine has options to interact with an X server, Wayland compositors tend to be much stricter, and this is just a middle layer to make that communication pleasant. Sunshine's documentation [even has instructions for X11](https://docs.lizardbyte.dev/projects/sunshine/master/md_docs_2app__examples.html#x11). Yes, it does mention GNOME's Wayland session, but it makes the bold assumption that the client has an exact match with a resolution/refresh rate the compositor offers. ## Dependencies -A version of GNOME that supports `gdctl`. That's all! Presumably you have `python3`, right? +A version of GNOME that supports `gdctl`, and Python 3.10+ ## Usage ### Arguments @@ -54,8 +54,8 @@ Undo: `python3 [path] reset [display adapter]` ### Example Usage #### Do: ``` -python3 /home/agrey/Development/sunshine-snake-glue set HDMI-2 -python3 /home/agrey/Development/sunshine-snake-glue create HDMI-2 "gamescope -f -W {res_x} -H {res_y} -r {rate} -e -- steam -bigpicture -steamos3" +python3 /home/ogrey/Development/sunshine-snake-glue set HDMI-2 +python3 /home/ogrey/Development/sunshine-snake-glue create HDMI-2 "gamescope -f -W {res_x} -H {res_y} -r {rate} -e -- steam -bigpicture -steamos3" ``` #### Command: ```