Skip to content

Commit 15f87e9

Browse files
authored
Overhaul configuration page
Signed-off-by: burnerphones <[email protected]>
1 parent fd3e04b commit 15f87e9

File tree

1 file changed

+11
-29
lines changed

1 file changed

+11
-29
lines changed

Diff for: src/Sober/Configuration/index.md

+11-29
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,18 @@
11
# Sober Configuration
22

3-
To adjust Sober or Roblox's behavior, the configuration may be edited. This is done through a configuration file. To edit this file, you may follow the steps below.
3+
You may adjust application behavior by editing the default configuration file.
44

5-
## Editing the configuration
5+
The configuration file is located at: `~/.var/app/org.vinegarhq.Sober/config/sober/config.json`. Open it with your favorite editor.
66

7-
By editing the configuration file, you are overriding the default configuration.
7+
## Reference
88

9-
To open the configuation file, open a text editor to `~/.var/app/org.vinegarhq.Sober/config/sober/config.json`. When opening the file, you are greeted with the following configuration:
10-
11-
```json
12-
{
13-
"bring_back_oof": false,
14-
"discord_rpc_enabled": true,
15-
"enable_hidpi": false,
16-
"fflags": {
17-
"FFlagExample": true
18-
},
19-
"server_location_indicator_enabled": false,
20-
"touch_mode": "off",
21-
"use_libsecret": false,
22-
"use_opengl": false
23-
}
24-
```
25-
26-
### Configuration values
279
| Option | Description | Default |
2810
| ----------------------------------- | ------------------------------------------------------------------------------------- | --------- |
29-
| `bring_back_oof` | brings back the old "oof" sound | `false` |
30-
| `discord_rpc_enabled` | use Discord's rich presence through the BloxstrapRPC protocol. | `true` |
31-
| `enable_hidpi` | enables support for HiDPI screens | `false` |
32-
| `fflags` | a section for inputting additional FFlags to use advanced features | - |
33-
| `server_location_indicator_enabled` | shows a popup of the location of the server you are connected | `false` |
34-
| `touch_mode` | enables touchscreen controls | `"off"` |
35-
| `use_libsecret` | allows users to store the login cookie securely (**EXPERIMENTAL**) | `false` |
36-
| `use_opengl` | use OpenGL instead of default Vulkan graphics API | `false` |
11+
| `bring_back_oof` | Bring back the nostalgic 'oof' sound | `false` |
12+
| `discord_rpc_enabled` | Share the game you're playing with your Discord servers and contacts | `true` |
13+
| `enable_hidpi` | Scale Sober's game window depending on your screen's pixel density, useful for very high resolution displays/laptops | `false` |
14+
| `fflags` | Experimental internal Roblox configration. We don't recommend or support using this | - |
15+
| `server_location_indicator_enabled` | Show a popup with the location of the gameserver you connected to upon visiting an experience | `false` |
16+
| `touch_mode` | "off" - touchscreen is disabled, default; "on" - touchscreen is enabled, experiences will use the mobile UI; "fake-on" - touchscreen is enabled, experiences will use the desktop UI | `"off"` |
17+
| `use_libsecret` | use libsecret for storing the session cookie instead of plaintext, experimental | `false` |
18+
| `use_opengl` | use OpenGL instead of Vulkan as the graphics API, useful as a workaround for certain issues, like "OutOfMemory" reperated crashes | `false` |

0 commit comments

Comments
 (0)