Skip to content

Commit

Permalink
docs: Init configuration with some info from README
Browse files Browse the repository at this point in the history
  • Loading branch information
samueldr committed Aug 30, 2023
1 parent 0160289 commit 631d830
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 631d830

Please sign in to comment.