From 631d830c18b8097c2c01df869860fbd7a00c5232 Mon Sep 17 00:00:00 2001 From: Samuel Dionne-Riel Date: Tue, 29 Aug 2023 23:11:07 -0400 Subject: [PATCH] docs: Init configuration with some info from README --- docs/configuration.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/configuration.md diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 00000000..cb8941c5 --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,20 @@ +Configuration +============= + +> [!WARNING] +> This page is a stub. + +All available module options along with their descriptions can be found under `modules`. + +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 `steam-session` in a VT. +- Launch `steam-session` within an existing desktop session. This will run [gamescope](https://github.com/Plagman/gamescope) in nested mode which results in higher latency. + +If you want *Switch to Desktop* to switch to another session with `autoStart`, 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 if will close Steam. +