From bfc33b646265d6b8feb882f5586602d594fec745 Mon Sep 17 00:00:00 2001 From: Noted-Jrelvas <55360900+Noted-Jrelvas@users.noreply.github.com> Date: Wed, 27 Sep 2023 01:05:05 +0100 Subject: [PATCH 1/5] Add "Reporting issues to WineHQ" page --- src/SUMMARY.md | 1 + src/Troubleshooting/winehq.md | 78 +++++++++++++++++++++++++++++++++++ 2 files changed, 79 insertions(+) create mode 100644 src/Troubleshooting/winehq.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 858315f..673d63c 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -10,3 +10,4 @@ - [Tips and tricks](./Configuration/tips-and-tricks/index.md) - [Contributing](./Contributing/index.md) - [Troubleshooting](./Troubleshooting/index.md) + - [Reporting issues to WineHQ](./Troubleshooting/winehq.md) \ No newline at end of file diff --git a/src/Troubleshooting/winehq.md b/src/Troubleshooting/winehq.md new file mode 100644 index 0000000..3ee9b21 --- /dev/null +++ b/src/Troubleshooting/winehq.md @@ -0,0 +1,78 @@ +# Reporting issues to WineHQ + +Whenever you run into an issue with Vinegar, the culprit could be one (or more) of its many components and libraries (Vinegar itself, Wine, DXVK, etc.), but more often than not, said culprit is Wine. +Vinegar can be configured to help you diagnose if a bug/issue is caused by Wine and make a report to WineHQ without violating their reporting guidelines. + +**Warning**: This guide is not recommended unless you're an advanced user. Please follow [Troubleshooting](./index.md)'s instructions instead. + +First of all, create a new toml configuration file somewhere accessible to you, with the following content: +```toml +# Written for Vinegar v1.4.4. + +# WARNING: This should be left empty if your system has WineHQ packages installed (https://wiki.winehq.org/Download). +# Otherwise, either install WineHQ packages or set wineroot to a staging/development wine's path. +# TL;DR: Ensure Vinegar uses a staging/development wine, otherwise your report is INVALID. +wineroot = "" + +# Symbols definition: +# (X) = DO NOT EDIT: This option should never be changed. (will invalidate all reports) +# (?) = This option may be edited. In case of doubt, do not change. +# (...) = User defined options can be added here (not recommended, may invalidate your report) + +dxvk_version = "" # (X) +multiple_instances = false # (X) +sanitize_env = false # (X) + +[env] +WINEDEBUG = "" # (?): Use this to increase Wine log verbosity. +# (...) +DXVK_LOG_PATH = "" # (X) +WINEESYNC = "" # (X) +WINEFSYNC = "" # (X) +WINEDLLOVERRIDES = "" # (X) + +[player] +channel = "" # (?): Use this to debug a specific Roblox version. +forced_version = "" # (?): Use this to debug a specific Roblox version. +renderer = "D3D11" # (?): Use this to debug a specific renderer. (D3D11 will use Wine's built-in D3D opengl conversion.) +dxvk = false # (X) +auto_kill_prefix = false # (X) +launcher = "" # (X) + +[studio] +channel = "" # (?): Use this to debug a specific Roblox version. +forced_version = "" # (?): Use this to debug a specific Roblox version. +renderer = "D3D11" # (?): Use this to debug a specific renderer. (D3D11 will use Wine's built-in D3D opengl conversion.) +dxvk = false # (X) +auto_kill_prefix = false # (X) +launcher = "" # (X) + +[player.fflags] +DFIntTaskSchedulerTargetFps = 60 # (X) +``` +Read over every option carefully. Some can (and should) be edited! Follow the instructions in the comments. + +**Critical**: This configuration file depends heavily on your Vinegar version! Do **NOT** reuse it, especially after updating Vinegar. Recheck this guide to ensure you have the latest version of the configuration. + +Once you have created the file, you have to tell Vinegar to use it instead of your default/normal configuration. This can be done using the `-config (filepath)` flag! +Lastly, you must specify a wine prefix for Vinegar to use, to ensure any existing data does not interfere with your report. This can be done by setting the env variable `WINEPREFIX` to your desired location. This can be anywhere, even `/tmp`. as long as Vinegar has access to it. + +Assuming that you placed your configuration file in your Documents folder and that it's named `winehq-report.toml`, you should run the following command to test Roblox player (for example): `WINEPREFIX=/tmp/report vinegar -config /home/jrelvas/Documents/winehq-report.toml player`. + +If you followed these instructions correctly, Vinegar... +- Will use a Staging/Devel WineHQ Build of Wine +- Will use a clean, unmodified wineprefix +- Will provide a bit of extra debug logs by default +- Will not use DXVK or any other non-wine DLLs or libraries +- Will not use any special workarounds or settings +- Will not use or touch your existing configuration +- Will not have any special functionality not provided by Wine +- Will essentially just act as a Roblox Player/Roblox Studio installer and bootstrapper, with no other functionality or features + +Caveat: Your .desktop files will obviously not be affected by this. This means you won't be able to log into studio or open links/games from roblox.com. The workaround is to manually edit the desktop file so it uses the right `-config` flag and `WINEPREFIX`. They can be found at `usr/share/applications`. + +Note that env variables in .desktop Exec commands must be declared with the `env`. For example: Do `env WINEPREFIX = /tmp/report vinegar -config /home/jrelvas/Documents/winehq-report.toml player` instead of `WINEPREFIX=/tmp/report vinegar -config /home/jrelvas/Documents/winehq-report.toml player` + +**Warning**: After following these steps, ensure your report follows [WineHQ.org's bug report guidelines](https://wiki.winehq.org/Bugs). + +**Warning**: Keep in mind that any issues you face while following these steps are unsupported and should not be reported to us. \ No newline at end of file From de92a78d50fe6e410455817b95430aa24b995c12 Mon Sep 17 00:00:00 2001 From: Noted-Jrelvas <55360900+Noted-Jrelvas@users.noreply.github.com> Date: Wed, 27 Sep 2023 01:07:28 +0100 Subject: [PATCH 2/5] Added missing word in line --- src/Troubleshooting/winehq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Troubleshooting/winehq.md b/src/Troubleshooting/winehq.md index 3ee9b21..e1027dc 100644 --- a/src/Troubleshooting/winehq.md +++ b/src/Troubleshooting/winehq.md @@ -71,7 +71,7 @@ If you followed these instructions correctly, Vinegar... Caveat: Your .desktop files will obviously not be affected by this. This means you won't be able to log into studio or open links/games from roblox.com. The workaround is to manually edit the desktop file so it uses the right `-config` flag and `WINEPREFIX`. They can be found at `usr/share/applications`. -Note that env variables in .desktop Exec commands must be declared with the `env`. For example: Do `env WINEPREFIX = /tmp/report vinegar -config /home/jrelvas/Documents/winehq-report.toml player` instead of `WINEPREFIX=/tmp/report vinegar -config /home/jrelvas/Documents/winehq-report.toml player` +Note that env variables in .desktop Exec commands must be declared with the `env` command. For example: Do `env WINEPREFIX = /tmp/report vinegar -config /home/jrelvas/Documents/winehq-report.toml player` instead of `WINEPREFIX=/tmp/report vinegar -config /home/jrelvas/Documents/winehq-report.toml player` **Warning**: After following these steps, ensure your report follows [WineHQ.org's bug report guidelines](https://wiki.winehq.org/Bugs). From 35d6043217fa5ca0cd2dffcafd6af438a2995d5d Mon Sep 17 00:00:00 2001 From: Noted-Jrelvas <55360900+Noted-Jrelvas@users.noreply.github.com> Date: Tue, 3 Oct 2023 13:44:42 +0100 Subject: [PATCH 3/5] Removed verbosity, more straight to the point --- src/Troubleshooting/winehq.md | 30 +++++++----------------------- 1 file changed, 7 insertions(+), 23 deletions(-) diff --git a/src/Troubleshooting/winehq.md b/src/Troubleshooting/winehq.md index e1027dc..be1c7b3 100644 --- a/src/Troubleshooting/winehq.md +++ b/src/Troubleshooting/winehq.md @@ -1,11 +1,10 @@ # Reporting issues to WineHQ -Whenever you run into an issue with Vinegar, the culprit could be one (or more) of its many components and libraries (Vinegar itself, Wine, DXVK, etc.), but more often than not, said culprit is Wine. -Vinegar can be configured to help you diagnose if a bug/issue is caused by Wine and make a report to WineHQ without violating their reporting guidelines. - **Warning**: This guide is not recommended unless you're an advanced user. Please follow [Troubleshooting](./index.md)'s instructions instead. -First of all, create a new toml configuration file somewhere accessible to you, with the following content: +Vinegar can be configured to help you diagnose if a bug/issue is caused by Wine and make a report to WineHQ without violating their reporting guidelines. + +First of all, create a new toml configuration file in an appropriate location, with the following content: ```toml # Written for Vinegar v1.4.4. @@ -50,29 +49,14 @@ launcher = "" # (X) [player.fflags] DFIntTaskSchedulerTargetFps = 60 # (X) ``` -Read over every option carefully. Some can (and should) be edited! Follow the instructions in the comments. +Read over every option carefully and follow the instructions in the comments. **Critical**: This configuration file depends heavily on your Vinegar version! Do **NOT** reuse it, especially after updating Vinegar. Recheck this guide to ensure you have the latest version of the configuration. -Once you have created the file, you have to tell Vinegar to use it instead of your default/normal configuration. This can be done using the `-config (filepath)` flag! -Lastly, you must specify a wine prefix for Vinegar to use, to ensure any existing data does not interfere with your report. This can be done by setting the env variable `WINEPREFIX` to your desired location. This can be anywhere, even `/tmp`. as long as Vinegar has access to it. - -Assuming that you placed your configuration file in your Documents folder and that it's named `winehq-report.toml`, you should run the following command to test Roblox player (for example): `WINEPREFIX=/tmp/report vinegar -config /home/jrelvas/Documents/winehq-report.toml player`. - -If you followed these instructions correctly, Vinegar... -- Will use a Staging/Devel WineHQ Build of Wine -- Will use a clean, unmodified wineprefix -- Will provide a bit of extra debug logs by default -- Will not use DXVK or any other non-wine DLLs or libraries -- Will not use any special workarounds or settings -- Will not use or touch your existing configuration -- Will not have any special functionality not provided by Wine -- Will essentially just act as a Roblox Player/Roblox Studio installer and bootstrapper, with no other functionality or features - -Caveat: Your .desktop files will obviously not be affected by this. This means you won't be able to log into studio or open links/games from roblox.com. The workaround is to manually edit the desktop file so it uses the right `-config` flag and `WINEPREFIX`. They can be found at `usr/share/applications`. +Once the file is ready, set the `WINEPREFIX` env var to a temporary location, then run Vinegar with the `-config (filepath)` flag to use the cfg you just created. -Note that env variables in .desktop Exec commands must be declared with the `env` command. For example: Do `env WINEPREFIX = /tmp/report vinegar -config /home/jrelvas/Documents/winehq-report.toml player` instead of `WINEPREFIX=/tmp/report vinegar -config /home/jrelvas/Documents/winehq-report.toml player` +The command should be similar to this if all steps were followed correctly: `WINEPREFIX=/tmp/report vinegar -config /home/jrelvas/Documents/winehq-report.toml player`. -**Warning**: After following these steps, ensure your report follows [WineHQ.org's bug report guidelines](https://wiki.winehq.org/Bugs). +Caveat: Your desktop entries will obviously not be affected by this, preventing you from logging into studio or executing actions from roblox.com properly. You will have to edit them to reflect the changes above. **Warning**: Keep in mind that any issues you face while following these steps are unsupported and should not be reported to us. \ No newline at end of file From 78275b63e3356d45743eadf8d462c18ae1dfe62c Mon Sep 17 00:00:00 2001 From: Jrelvas <55360900+Noted-Jrelvas@users.noreply.github.com> Date: Sun, 8 Oct 2023 14:37:29 +0100 Subject: [PATCH 4/5] Update src/Troubleshooting/winehq.md Co-authored-by: tacheometry <39647014+tacheometry@users.noreply.github.com> Signed-off-by: Jrelvas <55360900+Noted-Jrelvas@users.noreply.github.com> --- src/Troubleshooting/winehq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Troubleshooting/winehq.md b/src/Troubleshooting/winehq.md index be1c7b3..4de1ccd 100644 --- a/src/Troubleshooting/winehq.md +++ b/src/Troubleshooting/winehq.md @@ -1,6 +1,6 @@ # Reporting issues to WineHQ -**Warning**: This guide is not recommended unless you're an advanced user. Please follow [Troubleshooting](./index.md)'s instructions instead. +**Warning**: This guide is only recommended for advanced users. If facing issues, please follow [Troubleshooting](./index.md) instructions first. Vinegar can be configured to help you diagnose if a bug/issue is caused by Wine and make a report to WineHQ without violating their reporting guidelines. From d23e37a46f17f412b6ddc444328a7f3c65372ad9 Mon Sep 17 00:00:00 2001 From: Jrelvas <55360900+Noted-Jrelvas@users.noreply.github.com> Date: Sun, 8 Oct 2023 14:37:57 +0100 Subject: [PATCH 5/5] Update src/Troubleshooting/winehq.md Co-authored-by: tacheometry <39647014+tacheometry@users.noreply.github.com> Signed-off-by: Jrelvas <55360900+Noted-Jrelvas@users.noreply.github.com> --- src/Troubleshooting/winehq.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Troubleshooting/winehq.md b/src/Troubleshooting/winehq.md index 4de1ccd..ebe795f 100644 --- a/src/Troubleshooting/winehq.md +++ b/src/Troubleshooting/winehq.md @@ -2,9 +2,9 @@ **Warning**: This guide is only recommended for advanced users. If facing issues, please follow [Troubleshooting](./index.md) instructions first. -Vinegar can be configured to help you diagnose if a bug/issue is caused by Wine and make a report to WineHQ without violating their reporting guidelines. +Vinegar can be configured to help you determine whether a bug/issue is caused by Wine, so you can submit a report to WineHQ without violating their guidelines. -First of all, create a new toml configuration file in an appropriate location, with the following content: +To begin, create a new toml configuration file in an appropriate location, with the following content: ```toml # Written for Vinegar v1.4.4.