Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the Troubleshooting section and add Umu launcher documentation #139

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions src/Configuration/tips-and-tricks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,27 @@ See [Bloxstrap's guide to FastFlags](https://github.com/pizzaboxer/bloxstrap/wik
- `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.

## Umu launcher

### NOTE: On the Flatpak version of Vinegar you can simply set the wineroot path to Proton-GE without having to use Umu launcher(you might need to edit permissions due to Flatpak sandboxing) or any other configuration option, this part only applies to the Source/Package version of Vinegar (1.7.8+)

[Umu launcher](https://github.com/Open-Wine-Components/umu-launcher) can be used to solve a few bugs with studio.

After installing Umu launcher and having downloaded and extracted [Proton-GE](https://github.com/GloriousEggroll/proton-ge-custom/releases) add the following to your Vinegar configuration:

```toml
[studio]
wineroot = "/path/to/proton"

[studio.env]
PROTONPATH = "/path/to/proton"
GAMEID = "0"
PROTON_VERB = "run"
```

replace `/path/to/proton` with the actual path
example: `/home/username/Downloads/Proton-GE`

## Studio backup

Before you delete your wineprefixes via `vinegar delete` or `flatpak run org.vinegarhq.Vinegar delete`, you should backup data you have on your Studio prefix. This includes your settings and files you've stored.
Expand Down
43 changes: 28 additions & 15 deletions src/Troubleshooting/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ Workarounds such as running Roblox in a virtual machine or Android emulation wit

### Cursor fails to lock

On XWayland, the cursor cannot be locked unless it's invisible. This impacts the functionality of Roblox's first-person and shiftlock modes. This also impacts Studio's edit mode, where the camera rotation depends on the cursor being locked and is broken.
On XWayland, the cursor cannot be locked unless it's invisible. This impacts Studio's edit mode, where the camera rotation depends on the cursor being locked and is broken.

Switching to a real X11 session fixes this issue. Some users have also reported success with gamescope's `--force-grab-cursor` option, but this doesn't seem to work for everyone.
Try using [Proton-GE or Umu launcher](https://vinegarhq.org/Configuration/tips-and-tricks/index.html#umu-launcher)

Once Wine's wayland driver is introduced (scheduled for next year), this issue should be fixed.
Switching to a real X11 session also fixes this issue.

### DXVK returns white screen

Expand All @@ -67,8 +67,7 @@ This issue has no known cause, but appears to be more frequent with the Vinegar

### Roblox doesn't launch from the website

This issue is most likely caused by Vinegar failing to configure the mimelist entries. This can be fixed by manually adding them.
First, remove any Roblox related lines in `~/.config/mimeapps.list`, then, under the `[Default Applications]` section add the lines found at the end of [this](https://vinegarhq.org/Installation/guides/source.html#installing-vinegar) chapter.
This issue is most likely caused by Vinegar failing to configure the mimelist entries. This can be fixed by just adding them, Run `xdg-mime default org.vinegarhq.Vinegar.studio.desktop x-scheme-handler/roblox-studio` (ignore the Qtpaths errors) then `xdg-mime default org.vinegarhq.Vinegar.studio.desktop x-scheme-handler/roblox-studio-auth`

### Roblox doesn't launch from website if using Firefox/Librewolf

Expand Down Expand Up @@ -134,13 +133,33 @@ Known Roblox Studio issues:

### Stuck on the splash screen

Studio is currently broken with 96 DPI rendering. Set the DPI to 97 (already done by default) by running `vinegar exec winecfg` to open the Wine configuration, and then head to the Graphics tab. There should be a DPI option at the bottom of the page.
This may be caused by you using an older version of Studio, remove the `force-version` option from your configuration. You may need to also run `flatpak run org.vinegarhq.Vinegar delete`

Studio is also currently broken with 96 DPI rendering. Set the DPI to 97 (already done by default) by running `vinegar exec winecfg` to open the Wine configuration, and then head to the Graphics tab. There should be a DPI option at the bottom of the page.

Other DPI values work, as long as they're **NOT** 96. Note that values not divisible by 96 will make the interface blurrier, and that the game world view becomes blurrier as DPI increases. This is a limitation with Wine's X11 implementation.

### Unable to log in - WebView2 error
### Studio login black window or login failed error

While WebView2 does generally work it may be really buggy and give you a black window or an error While trying to log in.

Use the package/source version of Vinegar with Umu launcher to fix this issue:

Uninstall the previous Vinegar, run `flatpak uninstall --delete-data org.vinegarhq.Vinegar -y`

Follow the instructions listed [here](https://vinegarhq.org/Installation/guides/package.html) to get a vinegar package (some packages may be out of date, get the ones that have vinegar 1.7.8+)

or follow the instructions listed [here](https://vinegarhq.org/Installation/guides/source.html#building-vinegar) for the source version

when installing the source version you may get errors about icons and qtpaths, ignore them

WebView2 is currently not supported, so there's no way to log in directly inside of studio.
Make sure you have steam installed as umu-launcher needs steam-related components to make proton and the steamrt work correctly

Next, download and extract [Proton-GE](https://github.com/GloriousEggroll/proton-ge-custom/releases)

Next follow [this guide](https://vinegarhq.org/Configuration/tips-and-tricks/index.html#umu-launcher) on how to setup Umu launcher.

Next run Vinegar using `vinegar studio run`, you will see the black window again, open the terminal and run `pkill -f webview` (or kill it manually) a new window should popup.

Follow the on-screen prompt and click "Log in via browser". This will open an authentication website in your browser. Once you're done authenticating, you might be prompted to allow the use of the `roblox-studio-auth` protocol. Make sure to say "yes".

Expand All @@ -150,13 +169,7 @@ If you're still unable to log in, try changing your DNS to a viable alternative

### "Your GPU is incompatible" error

This issue is most commonly caused by the Wine build not having the Vulkan ChildWindow patch applied. There are a couple solutions:

- Using the [Vinegar flatpak](https://vinegarhq.org/Installation/guides/flatpak.html), which includes the ChildWindow patch;

- Using a Wine build that has the ChildWindow patch enabled (such as [Wine GE](https://github.com/GloriousEggroll/wine-ge-custom));

- Disabling DXVK in the Vinegar configuration.
Try using [Proton-GE](https://github.com/GloriousEggroll/proton-ge-custom/releases) or Umu launcher.

### "Necessary graphics drivers not installed" error

Expand Down