merge soberdocs into vinegarhq.org (#143)

* push p1

* guess that ain't going to praise it

* p2

* begin config sec

* forgot to put this into summary.md

* begin draft for troubleshooting section

* keep on forgetting

* see how this will go

* add faq and minor edit to sober install page

* I always forget

* no double dots, got it

* distinquish the titles because it's going to mess up how search is going to search

* + TAT and adjustments

* point the pics to the correct dir

* upload sober svg

* see if this shall line together

* align

* inc to 30

* change title

* they said no to the homepage, so I'll seperate them

* I ALWAYS FORGET

* someone suggested this

* Home: fix grammar for sober doc link

Co-authored-by: Jrelvas <jrelvastheduck@gmail.com>
Signed-off-by: sewn <sewn@disroot.org>

* scrub this while I figure out how this should be worded

* Update src/Sober/Troubleshooting/index.md

Co-authored-by: Jrelvas <jrelvastheduck@gmail.com>
Signed-off-by: Kirby <80133246+k1yrix@users.noreply.github.com>

* Update src/Sober/FAQ/index.md

Co-authored-by: Jrelvas <jrelvastheduck@gmail.com>
Signed-off-by: Kirby <80133246+k1yrix@users.noreply.github.com>

* paraphrased the quotes

* fx

* Update src/Sober/Installation/index.md

Co-authored-by: Jrelvas <jrelvastheduck@gmail.com>
Signed-off-by: Kirby <80133246+k1yrix@users.noreply.github.com>

* rep

* Update src/Sober/Home/index.md

Co-authored-by: Jrelvas <jrelvastheduck@gmail.com>
Signed-off-by: Kirby <80133246+k1yrix@users.noreply.github.com>

* rm

* Update src/Sober/FAQ/index.md

Co-authored-by: Jrelvas <jrelvastheduck@gmail.com>
Signed-off-by: Kirby <80133246+k1yrix@users.noreply.github.com>

* Update src/Sober/FAQ/index.md

Co-authored-by: Jrelvas <jrelvastheduck@gmail.com>
Signed-off-by: Kirby <80133246+k1yrix@users.noreply.github.com>

* mention that issues are in the troubleshooting page as well

* added wording for "how do I know I meet reqs for sober" section

* rwd

* rep

* update for 0.0.0-379b6ec

* another update for 0.0.0-379b6ec

* emergency write in warn after recent update

* reword and add 268

* Update src/Sober/FAQ/index.md

Co-authored-by: teknos <40285364+teknosx@users.noreply.github.com>
Signed-off-by: Kirby <80133246+k1yrix@users.noreply.github.com>

* fix spelling error

Signed-off-by: Kirby <80133246+k1yrix@users.noreply.github.com>

* make adjustments based on tunis' comments

* one more

* update

---------

Signed-off-by: sewn <sewn@disroot.org>
Signed-off-by: Kirby <80133246+k1yrix@users.noreply.github.com>
Co-authored-by: sewn <sewn@disroot.org>
Co-authored-by: Jrelvas <jrelvastheduck@gmail.com>
Co-authored-by: teknos <40285364+teknosx@users.noreply.github.com>

Author: 4 people

src/Home/index.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img style="max-width: 30%" src="/favicon.svg">
+  <img style="max-width: 30%" src="../vinegar.svg">
 </p>
 
 ## Welcome to the home of the VinegarHQ project!
@@ -8,6 +8,7 @@ Here, you'll find documentation for Vinegar and links to Sober.
 
 - Sober is an experimental software interoperability layer, which lets users run *Roblox Player* on Linux.
 - The homepage and installation page for Sober can be found [here](https://sober.vinegarhq.org/).
+- Its documentation can be found [here](../Sober/Home/index.md).
 <br><br>
 - Vinegar is a fast and robust bootstrapper for *Roblox Studio* that has many ease-of-use features.
 - The software and documentation are both open source, and can be accessed [on GitHub](https://github.com/vinegarhq).

src/SUMMARY.md

@@ -3,12 +3,20 @@
 - [2024 Roblox Block FAQ](./Home/rol_faq.md)
 
 # Vinegar 
-- [Installation](./Installation/index.md)
+- [Vinegar Installation](./Installation/index.md)
   - [Installing from package](./Installation/guides/package.md)
   - [Installing from source](./Installation/guides/source.md)
-- [Configuration](./Configuration/index.md)
+- [Vinegar Configuration](./Configuration/index.md)
   - [Tips and tricks](./Configuration/tips-and-tricks/index.md)
-- [Troubleshooting](./Troubleshooting/index.md)
+- [Vinegar Troubleshooting](./Troubleshooting/index.md)
   - [Reporting issues to WineHQ](./Troubleshooting/winehq.md)
-- [FAQ](./Home/faq.md)
+- [Vinegar FAQ](./Home/faq.md)
 - [Contributing](./Contributing/index.md)
+
+# Sober
+- [Sober Home](./Sober/Home/index.md)
+- [Sober Installation](./Sober/Installation/index.md)
+- [Sober Configuration](./Sober/Configuration/index.md)
+  - [Tips and tricks](./Sober/Configuration/tipsAndTricks.md)
+- [Sober Troubleshooting](./Sober/Troubleshooting/index.md)
+- [Sober FAQ](./Sober/FAQ/index.md)

src/Sober/Configuration/index.md

@@ -0,0 +1,32 @@
+# Sober Configuration
+
+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.
+
+## Editing the configuration
+
+By editing the configuration file, you are overriding the default configuration.
+
+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:
+
+```json
+{
+    "bring_back_oof": false,
+    "disable_hidpi": false,
+    "discord_rpc_enabled": true,
+    "fflags": null,
+    "server_location_indicator_enabled": false,
+    "touch_mode": "off",
+    "use_opengl": false
+}
+```
+
+### Configuration values
+| Option                              | Description                                                                           | Default   |
+| ----------------------------------- | ------------------------------------------------------------------------------------- | --------- |
+| `bring_back_oof`                    | brings back the old "oof" sound                                                       | `false`   |
+| `disable_hidpi`                     | disables the support for HiDPI screens                                                | `false`   |
+| `discord_rpc_enabled`               | use Discord's rich presence through the BloxstrapRPC protocol.                        | `true`    |
+| `fflags`                            | a section for inputting additional FFlags to use advanced features                    | -         |
+| `server_location_indicator_enabled` | shows a popup of the location of the server you are connected                         | `false`   |
+| `touch_mode`                        | enables touchscreen controls                                                               | `"off"`   |
+| `use_opengl`                        | use OpenGL instead of default Vulkan graphics API                                     | `false`   |

src/Sober/Configuration/tipsAndTricks.md

@@ -0,0 +1,5 @@
+# Tips and Tricks
+
+## FFlags
+
+See [Bloxstrap's guide to FastFlags](https://github.com/pizzaboxer/bloxstrap/wiki/A-guide-to-FastFlags).

src/Sober/FAQ/index.md

@@ -0,0 +1,66 @@
+# Sober FAQ
+
+
+## Q: Why Does this exist?
+A: Because people on Linux still want to be able to play Roblox easily.
+
+
+## Q: How do I know I meet the requirements to run Sober?
+- If you know your CPU very well, any CPUs that is from 2008+ for Intel (Nehalem series or later) or 2011+ for AMD (Bulldozer series or later) should be fine.
+    - If you don't know if your CPU supports SSE4.2, you can run `grep "sse4_2" /proc/cpuinfo` on your terminal. If SSE4.2 is available, it should be highlighted when you run the command.
+- For RAM, you should check on your system monitoring application and see the under-load 
+- For GPU, check the next question.
+- For Flatpak installation, simply run `flatpak` on your terminal and it should come out with the following:
+
+```console
+error: No command specified
+
+See 'flatpak --help'
+```
+
+## Q: Is the [GPU here] compatible?
+A: If it was made in the last 8 years or so and has Vulkan support either in Mesa or Nvidia drivers, then yes. If you're not sure, check [GPUInfo](https://vulkan.gpuinfo.org/) and search your graphics card. If it doesn't support Vulkan, Sober should automatically switch to OpenGL. If it doesn't automatically switch, set `use_opengl` to `true` in `~/.var/app/org.vinegarhq.Sober/config/sober/config.json`. If it still doesn't work, you're out of luck.
+
+![Vulkan Supported](./vulkaninfo.png)
+
+## Q: I can't log in to Roblox!
+A: If it didn't say explicitly you have a wrong password or something like that, reopen Sober and check if it logged you in. If that didn't work, try **"Login with Another Device"** on the login page.
+
+
+
+## Q: Studio support?
+A: Roblox does not have Studio for Android. Use [Vinegar](https://vinegarhq.org/) for Roblox Studio, which uses the Windows version of Roblox Studio with Wine.
+
+
+
+## Q: Why is Sober closed source?
+A: When the development team was making Sober, they wanted to ensure it wouldn't meet the same fate as Vinegar (being blocked). They recommended to make Sober closed source, to ensure no Exploit developers abuse it. Sadly, this is a necessary measure to ensure the continued existence of Roblox on Linux. On the bright side, this ensures that Sober will not be blocked in the long term, if no exploits are made for it, which the dev team will ensure.
+
+### SQ: Wasn't Roblox working on Hyperion for Android? What happens then?
+A: That's correct. Despite progress appearing to be slow, it's very likely that Hyperion gets deployed on Android during 2025, possibly within Q1. Once this happen, Sober will probably be discontinued.
+
+
+
+## Q: Roblox is crashing after around 5-10 minutes in game!
+A: There are various issues that could cause this. (You can check [the list of common issues](../Troubleshooting/index.md#known-general-issues)) Mostly, if you're on Wayland it's because Wayland support isn't great at the moment so you'll want make Sober use XWayland. To do this, you can simply run ```flatpak override --user --socket=x11 --nosocket=wayland org.vinegarhq.Sober```. Alternatively, if you prefer a GUI for managing flatpak permissions, you can use [Flatseal](https://flathub.org/apps/com.github.tchx84.Flatseal). And if you're on X11, don't know how to help you.
+
+![Turn on XWayland](./xwaylandforever.png)
+
+
+
+## Q: ARM64 support?
+A: We currently have no plans to support ARM64. It'd take a huge amount of time and effort we can't spare. However, this isn't definitive and could be reconsidered in the future.
+
+
+
+## Q: Will Sober be released on Flathub?
+A: No. Releasing Sober on Flathub implies that Sober is ready for production use, and that Sober is likely to keep on working for the long term. Sober isn't a production use-ready software because it's not supported, and support could stop at any time for any reason.
+
+
+
+## Q: Does it work with VR?
+A: No, as the Android version doesn't have support for VR. The Quest version is only on built on ARM and under a translation layer, it performs horribly.
+
+
+## Q: I'm running into an issue which isn't listed here or in the troubleshooting page. What should I do?
+A: More often than not, simply restarting Sober or updating it to the latest version fixes the issue. If it persists, consider reporting it in VinegarHQ's Discord Server.

src/Sober/FAQ/vulkaninfo.png

@@ -0,0 +1,20 @@
+<p align="center">
+  <img style="max-width: 30%" src="../../sober.svg">
+</p>
+
+<div class="warning">
+
+  **Notice regarding the recent Sober update**
+  
+  There have been reports of Error 268 (Unexpected client behavior) kicks after Sober was recently updated to 659. It is suspected that Roblox is slowly activating Hyperion onto its Android builds, but it is not fully confirmed and only applies to some games. While it is unlikely you will be banned for using Sober, the software cannot guarantee the support statuses of some games.
+
+  If you intend to use Sober, please proceed with caution. 
+
+</div>
+
+## Welcome to the community-maintained documentation of Sober
+
+- Sober is an experimental software interoperability layer, which lets users run *Roblox Player* on Linux.
+- The homepage and installation page for Sober can be found [here](https://sober.vinegarhq.org/).
+- The documentation is open source, however the software is closed source for various reasons. The documentation can be accessed [on its GitHub repo](https://github.com/vinegarhq/vinegarhq.github.io).
+> **Note**: Due to the closed source nature of Sober, documentation is limited by the community's public knowledge. As a result, documentation may not be fully accurate.

src/Sober/FAQ/xwaylandforever.png

@@ -0,0 +1,61 @@
+# Sober Installation
+
+## Requirements
+
+Before using Sober, there are some requirements for your setup to be able to run Sober. The requirements are based on [Roblox's official minimum requirements for mobile](https://en.help.roblox.com/hc/en-us/articles/203625474).<br>
+Other requirements include:
+
+- Processor: x86-64 CPU **with SEE4.2 support** (see the corresponding [FAQ question](../FAQ/index.md#How-do-I-know-I-meet-the-requirements-to-run-Sober))
+- Graphics: Vulkan 1.0* or later. (or OpenGL ES 3.0 or later for OpenGL operation)
+- Flatpak installed on your system.
+
+<p class="tiny">[*] Vulkan 1.3 is required for "Future" graphics.<p>
+
+> Sober is not distributed anywhere else but our self-hosted Flatpak repository.<br>
+If you don’t have Flatpak installed on your system, you can install it by going to [Flatpak's setup page](https://flatpak.org/setup/) and following the guide there. 
+
+> At this time, Sober is not available for ARM64 devices at this time
+
+## Instructions
+### To install
+Once you have Flatpak installed on your system, you can either download the Flatpak link for your software center [here](https://sober.vinegarhq.org/sober.flatpakref), or in your terminal, run:
+
+```console
+$ flatpak install --user https://sober.vinegarhq.org/sober.flatpakref
+```
+
+Then in it should appear in your app grid on GNOME or your Application Launcher on KDE/Cinnamon. Open it up and if everything works out, you should see the bootstrapper installation screen.
+
+There are two installation types: **Automatic** and **Manual**. By default, **Automatic** installation is already checked when you first install Sober. It should be left checked unless you know what you're doing. 
+
+
+#### Manual installation
+To use the manual installation, you need to download an APK. You should take note on which version of the APK Sober is asking.
+
+> You can download an APK from a trustworthy APK site or mirror. Make sure the service you're using is trustworthy and hasn't tampered with the APK. In case of doubt, you should use the automatic installation instead.
+
+Once the APK is downloaded, select the APK from the file picker and Roblox should now be installed onto Sober.
+
+> If you downloaded an APK that contains the base and the x86-64 split individually, make sure that **both** of the APKs are selected, otherwise it will not be able to install.
+
+## Post-Install
+
+Like the official Roblox client, there really isn't anything that you can configure by default outside of the app. But the [tips](../../SUMMARY.md) page is here to help you with some helpful things you might want such as FFlags or bringing the old Oof sound back.
+
+## Reinstalling Rolbox
+To reinstall Roblox, run the follwing command on your terminal:
+
+```console
+$ flatpak run org.vinegarhq.Sober --bootstrap
+```
+
+You are then instructed to go through the installation process again.
+
+## Uninstalling Sober
+To uninstall Sober, run the following command on your terminal:
+
+```console
+$ flatpak uninstall org.vinegarhq.Sober
+```
+
+> By default, this will keep data onto the disk. If you need to delete the data, pass `--delete-data` before the application ID to do so.