From dc8a1627fe650256dd527535737d5382d25b9f75 Mon Sep 17 00:00:00 2001 From: Samuel Dionne-Riel Date: Sun, 6 Oct 2024 17:45:29 -0400 Subject: [PATCH 1/4] docs/steam: Add a tip for the `desktopSession` option. --- docs/steam.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/steam.md b/docs/steam.md index 5b7476ba..a838c851 100644 --- a/docs/steam.md +++ b/docs/steam.md @@ -17,7 +17,7 @@ To manually start **Gaming Mode** (also known as the **Steam Deck UI**), there a ## Start On Boot -To automatically launch Gaming Mode on boot and enable desktop switching from the power menu: +The following configuration snippet configures the system to automatically launch Gaming Mode on boot, and enables desktop switching to Plasma 5. ```nix { @@ -32,6 +32,9 @@ To automatically launch Gaming Mode on boot and enable desktop switching from th } ``` +> [!NOTE] +> The session name semantics are the same as for the `services.displayManager.defaultSession` NixOS option. + ## Troubleshooting From 085495b76920c53722fdd7ca3ec1cd69139dbc40 Mon Sep 17 00:00:00 2001 From: Samuel Dionne-Riel Date: Sun, 6 Oct 2024 17:54:53 -0400 Subject: [PATCH 2/4] docs/configuration: Reword --- docs/configuration.md | 46 +++++++++++++++++++++++++++++++++---------- 1 file changed, 36 insertions(+), 10 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 51409338..d699c3b4 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,20 +1,46 @@ Configuration ============= -> [!INFO] -> This page is a stub. - All available module options along with their descriptions can be found under `modules`. +The options are also listed on the [options page in the documentation](https://jovian-experiments.github.io/Jovian-NixOS/options.html). + +### Using the Steam Deck UI To use the Steam Deck UI, set `jovian.steam.enable = true;` in your configuration. -This will only enable the Steam Deck UI tooling. To enable "desktop" steam, enable the usual NixOS options. -Then you can start the UI using one of the following methods: -- (**preferred**) Use `jovian.steam.autoStart = true;` to auto-start at login, and enabling use of *Switch to Desktop* option. -- Select "Gaming Mode" in the Display Manager or run `start-gamescope-session` in a VT. -- Launch `gamescope-session` within an existing desktop session. This will run [gamescope](https://github.com/Plagman/gamescope) in nested mode which results in higher latency. +This will only enable the Steam Deck UI tooling. +**To enable "desktop" Steam**, enable the usual NixOS options. + +The Steam Deck UI can be used in different manners. + +#### Autostart + +(*This is the preferred way to use the Steam Deck interface*) + +Set `jovian.steam.autoStart = true;` to auto-start at boot. + +This also enables use of the *Switch to Desktop* option. + +> [!NOTE] +> To go back to the *Steam Deck interface* from the *desktop* interface, logout or exit from your desktop environment. -If you want *Switch to Desktop* to switch to another session with `autoStart`, you will need to configure `jovian.steam.desktopSession`. +If you want the *Switch to Desktop* menu option to switch to another session, you will need to configure `jovian.steam.desktopSession`. Configure it with the name of the X11 or Wayland session of your choosing. -The *Switch to Desktop* option will not work with the other two methods of running the Steam Deck UI, instead it will close Steam. +The session name semantics are the same as for the `services.displayManager.defaultSession` NixOS option. + +#### As a user session + +Select the *Gaming Mode* sesssion in your Display Manager, or run `start-gamescope-session` in a VT. + +The *Switch to Desktop* option will not work as intended, instead it will close Steam. + + +#### As a *nested* window + +Run `gamescope-session` within an existing desktop session. + +This will run [gamescope](https://github.com/Plagman/gamescope) in nested mode which may result in higher latency. + +Usage as a *nested* window is less tested, and may have other undesirable idiosyncrasies. +The *Switch to Desktop* option will not work as intended, instead it will close Steam. From 1dcaedcfd051e8bb9bc07a04d9132d3ce1541113 Mon Sep 17 00:00:00 2001 From: Samuel Dionne-Riel Date: Mon, 7 Oct 2024 12:44:44 -0400 Subject: [PATCH 3/4] docs: Update gamescope repo ref Now that it's at ValveSoftware --- docs/configuration.md | 2 +- docs/steam.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index d699c3b4..b71d1279 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -39,7 +39,7 @@ The *Switch to Desktop* option will not work as intended, instead it will close Run `gamescope-session` within an existing desktop session. -This will run [gamescope](https://github.com/Plagman/gamescope) in nested mode which may result in higher latency. +This will run [gamescope](https://github.com/ValveSoftware/gamescope) in nested mode which may result in higher latency. Usage as a *nested* window is less tested, and may have other undesirable idiosyncrasies. diff --git a/docs/steam.md b/docs/steam.md index a838c851..ce6f61a8 100644 --- a/docs/steam.md +++ b/docs/steam.md @@ -13,7 +13,7 @@ You can enable the Steam Deck version of the Steam client with: To manually start **Gaming Mode** (also known as the **Steam Deck UI**), there are two options: - Select "Gaming Mode" in the Display Manager or run `start-gamescope-session` in a VT. -- Launch `gamescope-session` within an existing desktop session. This will run [gamescope](https://github.com/Plagman/gamescope) in nested mode which results in higher latency. +- Launch `gamescope-session` within an existing desktop session. This will run [gamescope](https://github.com/ValveSoftware/gamescope) in nested mode which results in higher latency. ## Start On Boot From 03f7042d9225a239e530c3b563c9a3011e4604cf Mon Sep 17 00:00:00 2001 From: Samuel Dionne-Riel Date: Tue, 8 Oct 2024 07:32:45 -0400 Subject: [PATCH 4/4] docs: Recommend Plasma 6 --- docs/steam.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/steam.md b/docs/steam.md index ce6f61a8..669cd6b8 100644 --- a/docs/steam.md +++ b/docs/steam.md @@ -17,11 +17,11 @@ To manually start **Gaming Mode** (also known as the **Steam Deck UI**), there a ## Start On Boot -The following configuration snippet configures the system to automatically launch Gaming Mode on boot, and enables desktop switching to Plasma 5. +The following configuration snippet configures the system to automatically launch Gaming Mode on boot, and enables desktop switching to Plasma 6. ```nix { - services.xserver.desktopManager.plasma5.enable = true; + services.desktopManager.plasma6.enable = true; jovian.steam = { enable = true;