Merge pull request #235 from effectsbot/vinegar-revision-v2

Update Vinegar section in accordance with recent changes

Author: effectsbot

src/Vinegar/FAQ.md

@@ -2,19 +2,19 @@
 
 ### What is the best configuration?
 
-This can vary from system to system. The most important factor in Wine's performance is the renderer. If your graphics card supports Vulkan, it's recommended to use either the D3D11 renderer with DXVK or Vulkan.
+This can vary from system to system. The most important factor in Wine's performance is the renderer. If your graphics card supports Vulkan, it's recommended to use either DXVK or Vulkan.
 
-It is also recommended to use Wine Staging with Vinegar, as it contains patches such as Esync that can provide a noticeable performance boost; set the environment variable `WINEESYNC=1`, additionally if your Wine build is TKG or is patched with Fsync, you can use the environment variable `WINEFSYNC=1` to enable it.
+It is also recommended to enable the NTSync kernel driver if your Linux kernel supports it (see [System Requirements](https://vinegarhq.org/Vinegar/Installation/index.html)).
 
 Vinegar also changes the Wineprefix version. While this does not increase performance, it increases compatibility.
 
 ### What is the difference between DXVK and Vulkan?
 
 As stated in the DXVK README:
 
-> A Vulkan-based translation layer for Direct3D 9/10/11 which allows running 3D applications on Linux using Wine.
+> A Vulkan-based translation layer for Direct3D 8/9/10/11 which allows running 3D applications on Linux using Wine.
 
-The only real difference is that Roblox's Vulkan is native, which means there is no translation layer. It is best to experiment on your system to see which one is better. Some users report that Vulkan can provide lower latency, while others report DXVK performs significantly better.
+The only real difference is that Roblox's Vulkan is native, which means there is no translation layer. It is best to experiment on your system to see which one is better. Some users report that Vulkan can provide lower latency, while others report DXVK performing significantly better.
 
 ### Why Go?
 

src/Vinegar/Installation/index.md

@@ -1,15 +1,21 @@
 # Installation
 
-## Requirements
+## System Requirements
 
-Before using Vinegar, there are some requirements for your setup to be able to run Roblox.
+Before installing Vinegar, there are some requirements for your system to fulfill in order to be able to run Roblox Studio.
 
-Ensure your system meets [Roblox's official minimum requirements](https://en.help.roblox.com/hc/en-us/articles/203312800).
-Additionally, ensure the requirements below:
+Ensure that your system meets the minimum requirements below:
 
-- Processor: X86-64 CPU.
-- Graphics: Vulkan 1.1 support.
-- Wine: 10.13 and onwards (Wine is pre-installed if using Flatpak).
+- OS: Linux kernel version 2.6.22 or later
+- Processor: x86-64/AMD64 type CPU
+- Memory: 3 GB RAM
+- Graphics: OpenGL 4.4 capable
+
+The following requirements are recommended for a smoother experience:
+
+- OS: Linux kernel version 6.14 or later ([NTSync](https://www.phoronix.com/news/Linux-6.14-NTSYNC-Driver-Ready))
+- Graphics: Vulkan 1.3 capable[*](https://github.com/doitsujin/dxvk/wiki/Driver-support#required-vulkan-features)
+- Memory: 8 GB RAM
 
 ## Using Flatpak (recommended)
 

src/Vinegar/TipsAndTricks.md

@@ -22,28 +22,3 @@ Example replacement of Roblox's default death sound:
             └── sounds
                 └── ouch.ogg
 ```
-
-## FFlags
-
-See [Bloxstrap's guide to FastFlags](https://github.com/pizzaboxer/bloxstrap/wiki/A-guide-to-FastFlags).
-
-## Environmental variables
-
-- `WINEESYNC`: allows Wine Staging to use Esync, please see [HowToEsync](https://github.com/lutris/docs/blob/master/HowToEsync.md) for more information.
-- `WINEDEBUG`: for performance reasons, this has been set to `-all`, which disables most of the logging. In order to debug crashes of Wine, it is recommended to set this to an empty string (`""`).
-- `DXVK_HUD`: is a variable used by DXVK for a hud, for more information about it you can see the [DXVK README](https://github.com/doitsujin/dxvk#hud), which includes various other variables that can be set. This can be set, for example, to `fps` to display an fps counter.
-
-## Studio backup
-
-Before you delete your wineprefixes via `Vinegar > Delete Data` you should backup data you have on your Studio prefix. This includes your settings and files you've stored.
-
-The Studio prefix location depends on how you installed Vinegar:
-
-- On Flatpak, it's located in `~/.var/app/org.vinegarhq.Vinegar/data/vinegar/prefixes/studio`
-- On other methods, it's located in `~/.local/share/vinegar/prefixes/studio`
-
-Where Roblox Studio store their settings and what they store:
-
-- `(studio prefix)/user.reg`: Studio theme, Docking layout.
-- `(studio prefix)/drive_c/users/(username)/AppData/Local/Roblox/GlobalSettings_13.xml`: Display language, Fonts, etc. 
-- `(studio prefix)/drive_c/users/(username)/AppData/Local/Roblox/GlobalBasicSettings_13_Studio.xml`: MicroProfiler, Fullscreen, etc.

src/Vinegar/Troubleshooting.md

@@ -20,27 +20,21 @@ This is due to a Wine bug when you upgrade Vinegar. To workaround this, simply d
 Ensure you have your Studio settings backed up! These can be found by pressing 'Open Files' next to the main run button, and going to:
 `drive_c/users/<user>/AppData/Local/Roblox`. The user `steamuser` might be present, which is from Vinegar's past usage of Proton, which you must move or backup to your new user.
 
-### Flickering widgets and plugin windows
-
-Change the Roblox Studio renderer from Studio's settings to D3D11 and disable DXVK. Optionally, if you are on a multi monitor setup,
-Create the registry key `HKEY_CURRENT_USER\Software\Wine\X11 Driver\UseEGL` as necessary and set it to `"Y"` (`REG_SZ`),
-which may improve D3D11 (non-DXVK).
-
 ### Can't dock plugin windows
 
-This issue occurs most often on Wayland desktops, you may either use [xwayland-satellite](https://github.com/Supreeeme/xwayland-satellite) 
-or enable Virtual desktop mode by opening the Wine configurator by pressing on the cog icon next to the Wine section in Vinegar's settings,
-and going to 'Graphics'.
+This issue occurs both on Wayland and X11-based desktop environments. You may enable Virtual Desktop in Vinegar's settings
+or untick the "Allow the window manager to control the windows" option in the Advanced Wine Settings to mitigate this.
+
+Wine's native Wayland driver currently doesn't support this functionality and therefore doesn't offer a solution.
 
-This currently has no fix if Studio is running using the winewayland driver and not running under xwayland or Xwayland-satellite.
+### Cursor fails to lock when moving around the camera
 
-### Cursor fails to lock / Studio closes without any message
+This is an issue with Xwayland, which only allows the cursor to lock when its invisible.
 
-These are due to specific Wine issues, as this is because Wine doesn't currently have the proper patches.
 This can be fixed by either:
 
-- Using the Flatpak version of Vinegar or using VinegarHQ's [Wine builds](https://github.com/vinegarhq/wine-builds)
-- If cursor fails to lock, switching to a real X11 session.
+- Using [Kombucha](https://github.com/vinegarhq/kombucha.git) (automatically pulled by Vinegar)
+- Switching to an X11 session
 
 ### Exit status 53