Skip to content

Commit 4ae3ca3

Browse files
authored
Merge pull request #237 from adverbialsatz/rewording
Reword the Sober documentation to be clearer
2 parents 98443a7 + aef8858 commit 4ae3ca3

File tree

4 files changed

+12
-17
lines changed

4 files changed

+12
-17
lines changed

src/Sober/Configuration/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ The configuration file is located at: `~/.var/app/org.vinegarhq.Sober/config/sob
1414
| Option | Description | Default |
1515
| ----------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------- |
1616
| `allow_gamepad_permission` | Enables the service to use gamepads or controllers | `false` |
17-
| ~~`bring_back_oof`~~ | ~~Brings back the nostalgic 'oof' sound~~ (Removed in patch 1.6.0) |~~`false`~~|
1817
| `close_on_leave` | Closes Sober upon leaving a game | `true` |
1918
| `discord_rpc_enabled` | Shares the game you're playing with your Discord servers and contacts | `false` |
2019
| `discord_rpc_show_join_button` | Allows other players to join games directly off your Discord profile | `false` |

src/Sober/FAQ/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ We made it closed source to reduce the potential for abuse (which would lead to
3737

3838

3939
## Is Sober ever going to be distributed outside of Flatpak?
40-
Unfortunately no. This is because it would be more easier to debug Sober using a reproducible runtime environment.
40+
Unfortunately no. This is because it is easier to debug Sober in a reproducible runtime environment.
4141

4242

4343
## ARM64 support/VR support?

src/Sober/Installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
The requirements to be able to run Sober are based on [Roblox's official minimum requirements for mobile](https://en.help.roblox.com/hc/en-us/articles/203625474).<br>
66
Other requirements include:
77

8-
- Processor: x86-64 CPU **with SSE4.1+ support** (see [more info here](./FAQ/index.html#How-do-I-know-I-meet-the-requirements-to-run-Sober))
8+
- Processor: x86-64 CPU **with SSE4.1+ support** (see [more info here](./FAQ/index.html#how-do-i-know-i-meet-the-requirements-to-run-sober))
99
- Graphics: Vulkan 1.0 or later, or OpenGL ES 3.0 or later
1010
- Linux kernel 5.11
1111

@@ -53,7 +53,7 @@ Once the APK is downloaded, select the APK from the file picker.
5353
5454
## Post-Install
5555

56-
You can configure Sober to do things like bringing back the old 'oof' sound, or enabling server location indicators. See our [configuration docs](../Configuration/index.md) for more info.
56+
You can configure Sober to do things like changing the death sound, or enabling server location indicators. See our [configuration docs](../Configuration/index.md) for more info.
5757

5858
## Uninstalling Sober
5959
To uninstall Sober, run the following command in your terminal:

src/Sober/Troubleshooting.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
If there are any undocumented issues, feel free to [create an issue](https://github.com/vinegarhq/vinegarhq.github.io/issues/new/choose) to update the documentation!
44

5-
---
65

76
## Obtaining logs
87

@@ -13,7 +12,6 @@ There are two ways of obtaining logs when running Sober:
1312
- Run Sober on the terminal (`flatpak run org.vinegarhq.Sober`)
1413
- Get the log file at `~/.var/app/org.vinegarhq.Sober/data/sober/sober_logs/`
1514

16-
---
1715

1816
## Known General Issues
1917

@@ -53,14 +51,11 @@ Otherwise, we cannot give a definite answer.
5351

5452

5553
#### Solution
56-
If you are sure your primary language is set anything but English, launch Sober using this command:
57-
```console
58-
$ flatpak override --user --env=LC_ALL=en_US.UTF-8 org.vinegarhq.Sober
59-
```
54+
Check the rest of this page to see if you can find a solution, or ask on our Discord server or make a GitHub issue if you can't find anything.
6055

6156

6257
### It says Sober couldn't launch because my card does not support Vulkan
63-
Please see question #4 on [the FAQ](./FAQ/index.html#is-my-gpu-compatible). Otherwise, you will have to use OpenGL.
58+
Please see question #4 on [the FAQ](./FAQ/index.html#is-my-gpu-compatible).
6459

6560

6661

@@ -76,7 +71,7 @@ Update your distro to a newer version by following a distro-specific guide.
7671
GPUs using Mesa should be fine as long as it's recent. If you're using an NVIDIA card, the driver version installed on your system must match with the Flatpak NVIDIA drivers that is installed on the system. (For example, the installed 560 system drivers cannot run with NVIDIA Flatpak 555 drivers)
7772

7873
#### Solution
79-
You can update by typing `flatpak update` on your terminal.
74+
Update by running `flatpak update` in your terminal.
8075

8176

8277
### Sober crashes on hybrid graphics with the following error: `vkGetPhysicalDeviceSurfacePresentModesKHR failed`
@@ -90,7 +85,7 @@ Run an application utilizing Vulkan (e.g. vkcube) in order to wake up the discre
9085

9186
### My FFlags are not applying!
9287

93-
This is due to security implications imposed by Roblox in order to combat cheating through Fast Flags, almost none of which are supposed to be used by regular users. Otherwise, make sure that the FFlag is a valid and whitelisted flag to use.
88+
This is due to security implications imposed by Roblox in order to combat cheating through Fast Flags, almost none of which are supposed to be used by regular users. Make sure that the FFlag is a valid and whitelisted to use.
9489

9590
> The list of allowed Fast Flags can be found in the [DevForum announcement](https://devforum.roblox.com/t/allowlist-for-local-client-configuration-via-fast-flags/3966569/)
9691
@@ -101,13 +96,13 @@ This is caused by zombie Sober processes that refused to close properly when clo
10196

10297
#### Solution
10398

104-
Launch your DE's built-in system monitor app or install [Mission Control](https://missioncenter.io/), search, and kill any remaining lingering Sober processes. Otherwise, restart your computer as instructed in the popup.
99+
Run `flatpak kill org.vinegarhq.Sober` or launch your DE's built-in system monitor app (or a system monitor app like [Mission Center](https://missioncenter.io/)), search, and kill any remaining lingering Sober processes. Otherwise, restart your computer as instructed in the popup.
105100

106101

107102
### I'm running a virtual machine, but I cannot launch Sober!
108-
Virtual machines are not generally supported. Unless you can passthrough the GPU, it's advised against so to try and run Sober on a virtual machine.
103+
Virtual machines are not supported, unless you can passthrough the GPU. We advise against trying to run Sober in a virtual machine.
109104

110-
> It kinda does have support, depending if the VM host you're running has OpenGL support, but you're going to get terrible performance out of it.
105+
> It does have some degree of support, depending on if the VM host you're running has OpenGL support, but you're going to get terrible performance out of it.
111106
112107

113108

@@ -284,4 +279,5 @@ If you want it at higher quality, append the following FFlags into the `"fflags"
284279
```
285280

286281

287-
> Please keep in mind that if you are using an NVIDIA card with VRAM capacity less than 4 GB, please be mindful of the [OutOfMemory crash](#rbxcrash-outofmemory-failed-to-allocate-memory-size--x-alignment--y) when attempting to play as it will render **all** textures at the highest quality possible. Proceed at your own risk.
282+
283+
> Please keep in mind that if you are using an NVIDIA card with VRAM capacity less than 4 GB, please be mindful of the [OutOfMemory crash](#rbxcrash-outofmemory-failed-to-allocate-memory-size--x-alignment--y) when attempting to play as it will render **all** textures at the highest quality possible. Proceed at your own risk.

0 commit comments

Comments
 (0)