Updated Wabbajack on Linux via Wine (markdown)

Wabbajack-on-Linux-via-Wine.md

@@ -2,15 +2,46 @@
 
 ## Introduction
 
-This is all unofficial, please don't ask for support from Wabbajack Support staff in the way you would if you have an issue running Wabbajack on Windows, instead please seek assistance from the #unofficial-linux-help channel on the Official Wabbajack Discord. There have been many users involved at various stages of getting things this far, and a lot of trial and error and testing has been done before things were repeatable enough to form into a guide and offer it as an option for those running Linux as their primary OS - most recently Sulfur Nitride, blejusca, Ouroboros and trawzified on the Official Wabbajack Discord, but many, many more over the time. Thanks to all involved for getting this far!
+This is all unofficial, please don't ask for support from Wabbajack Support staff in the way you would if you have an issue running Wabbajack on Windows, instead please seek assistance from the #unofficial-linux-help channel on the Official Wabbajack Discord - we will try and help there, but it is a best-effort level and is not guaranteed. 
+
+There have been many users involved at various stages of getting things this far, and a lot of trial and error and testing has been done before things were repeatable enough to form into a guide and offer it as an option for those running Linux as their primary OS - most recently Sulfur Nitride, blejusca, Ouroboros and trawzified on the Official Wabbajack Discord, but many, many more over the time. Thanks to all involved for getting this far!
 
 As with my other guides, they may look longer and more involved than the steps actually are - this is to try and be as clear as possible, step by step.
 
 Sulfur Nitride has produced a YouTube video covering the set up, you can watch it [here](https://www.youtube.com/watch?v=A2I4i4GmZ70)!
 
+
+---
+
+
 ## Wabbajack on Linux, via Wine
 
-Thanks to advancements with Wine, it now appears that running Wabbajack on Linux is a viable option - though please understand that there won't be any guarantee of 100% compatibility. As it stands, it's 'good enough' to be able to install a Wabbajack modlist. Starting with Wine v9.16, it seems that only a few steps are required to successfully run the Wabbajack application, login to Nexusmods via the GUI, then download and install a modlist.
+Thanks to advancements with Wine, it now appears that running Wabbajack on Linux is a viable option - though please understand that there won't be any guarantee of 100% compatibility. As it stands, it's 'good enough' to be able to install a Wabbajack modlist. Starting with Wine v9.15, it seems that only a few steps are required to successfully run the Wabbajack application, login to Nexusmods via the GUI, then download and install a modlist. Please note for Arch you must use wine-staging, and not just wine, even if the wine package is >=9.15. Additionally for ubuntu based distros, there are some additional steps needed to get a new enough version of wine, please see [Additional Notes](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki/Wabbajack-on-Linux-via-Wine#additional-notes) below.
+
+
+---
+
+
+## Automatic Wabbajack Install
+
+I have create a bash script that should do everything for you, though it is still in alpha and needs more feedback from different distros and platforms. See further down this wiki page for the manual steps if you prefer.
+
+The script will ask you where to store the wine prefix, so won't overwrite anything you already have on your system.
+
+You can check out the source code [here](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/blob/main/binaries/WabbajackWine.sh) to see what it does, but to run it, open a terminal and run:
+
+```
+bash <(curl -s https://raw.githubusercontent.com/Omni-guides/Wabbajack-Modlist-Linux/main/binaries/WabbajackWine.sh)
+```
+The script will ask a few questions, but should be fairly straight forward. Any feedback on this automation, good or bad, will be most welcome!
+
+
+---
+
+
+## Manual Wabbajack Install
+
+If you prefer to set things up manually, you can follow these steps.
 
 There are many ways to carry out the steps required, and more experienced users may have their preferred way (for example command line vs gui), but this guide should help those unsure, and at least give some guidance to others.
 
@@ -30,7 +61,7 @@ For each step, I've tried to include both command line and GUI methods (you only
 
 ### Step 1 - Wine/System Requirements
 
-Wine 9.16 or newer and winetricks, installed via your package manager. See <additional notes> below for Ubuntu-based distros, or if your distro also doesn't have wine 9.16 or above via the standard repos.
+Wine 9.15 or newer and winetricks, installed via your package manager. See <additional notes> below for Ubuntu-based distros, or if your distro also doesn't have wine 9.15 or above via the standard repos.
 
 You can check which wine version your system has currently by running the following in a terminal:
 
@@ -39,7 +70,7 @@ You can check which wine version your system has currently by running the follow
 wine --version
 ```
 
-If the command returns wine-9.16 or above, you should be good to go. If not, check for system updates, or check if you have an alternative version of wine available via your package manager - for example wine-staging or wine-development.
+If the command returns wine-9.15 or above, you should be good to go. If not, check for system updates, or check if you have an alternative version of wine available via your package manager - for example wine-staging or wine-development.
 
 You will also need to install winetricks from your system package manager, if it is not already installed.
 
@@ -77,7 +108,7 @@ wget -O $HOME/Wabbajack/MicrosoftEdgeWebView2RuntimeInstallerX64.exe https://mse
 
 ### Step 4 - A Clean Beginning (Creating a new Wine Prefix)
 
-A new, clean, wine >9.16 prefix is highly recommended. If you know what you are doing or have a reason you wish to hold on to your existing default wine prefix, then you will need to know how to handle multiple wine prefixes. For simplicity in this guide, I will just use the default wine prefix, which tends to be `/home/<user>/.wine`
+A new, clean, wine >9.15 prefix is highly recommended. If you know what you are doing or have a reason you wish to hold on to your existing default wine prefix, then you will need to know how to handle multiple wine prefixes. For simplicity in this guide, I will just use the default wine prefix, which tends to be `/home/<user>/.wine`
 
 To do this from command line, in a terminal, run the following command (adjusting as necessary for the prefix location on your system):
 
@@ -237,13 +268,45 @@ You can now close winetricks by clicking the Cancel button a few times.
 
 ### Step 10 - Link Steam Library
 
-Lastly, Wabbajack inside the prefix doesn't know where to find your Steam Library when it's running via Wine, which means Wabbajack won't detect the game as being installed when you try to install a modlist. The simplest way to workaround that is to create a symlink from your Linux Steam Library, to a specific location inside the Prefix that Wabbajack will find. The easiest way to create this symlink is to run the following command in a terminal (you will have to alter the command to match the path used by your distro or system Steam Library location):
+Lastly, Wabbajack inside the prefix doesn't know where to find your Steam Library when it's running via Wine, which means Wabbajack won't detect the game as being installed when you try to install a modlist. To ensure that Wabbajack can detect games installed in both the default Steam Library AND any additional Steam Library locations, we have to mirror and edit a specific directory path and file content.
+
+Firstly, make the directory that is expected (you will need to adjust the path if your prefix is elsewhere):
 
 ```
-ln -s $HOME/.local/share/Steam $HOME/.wine/drive_c/Program\ Files\ \(x86\)/Steam
+mkdir -p "$HOME/.wine/drive_c/Program Files (x86)/Steam/config"
+```
+Next copy in your libraryfolders.vdf file from your Linux Steam install
+
+```
+cp "$HOME/.local/share/Steam/config/libraryfolders.vdf" "$HOME/.wine/drive_c/Program Files (x86)/Steam/config/."
 ```
 
-This Steam Library check is only done when Wabbajack starts, so if you have jumped ahead and launched Wabbajack, you'll have to close it an open it again.
+With the file in the right place, you will need to edit the newly copied libraryfolders.vdf file (**NOT THE ONE IN THE REAL STEAM LIBRARY**) and change the paths of your Steam Libraries from Linux to Windows style. e.g.
+
+```
+"path"    "/home/omni/.local/share/Steam"
+```
+
+would change to (please note the Z: Drive and double backslashes).
+
+```
+"path"    "Z:\\home\\omni\\.local\\share\\Steam"
+```
+Do the same for any additional Steam Libraries in your libraryfolders.vfd file. e.g.
+
+```
+"path"    "/mnt/storage/SteamLibrary"
+```
+
+would change to (please note the Z: Drive and double backslashes).
+
+```
+"path"    "Z:\\mnt\\storage\\SteamLibrary"
+```
+Save the new libraryfolders.vdf file.
+
+
+The Steam Library check is only done when Wabbajack starts, so if you have jumped ahead and launched Wabbajack, you'll have to close it an open it again. Also note that if you add or change Steam Libraries in the future, you will need to copy the libraryfolders.vdf file and edit the paths again.
 
 ---
 
@@ -308,7 +371,7 @@ The above will get Wabbajack installed and running on your Linux system. It *doe
 
 ### Additional Notes
 
-As mentioned above, functionality for Wabbajack via wine only really became reliable with the newer versions of Wine 9. There may be some success with versions earlier than Wine 9.16, but I'd still suggest using the newest that your distribution gives you easy access to.
+As mentioned above, functionality for Wabbajack via wine only really became reliable with the newer versions of Wine 9. There may be some success with versions earlier than Wine 9.15, but I'd still suggest using the newest that your distribution gives you easy access to.
 
 For some though, the distro they are using only really has an old version of Wine available from the default repos. For example, Ubuntu-based distros that are using 22.04 as a base can only supply Wine 6 from the standard repos. You may have to check or research how to add newer versions of wine to your distro, but something like the following was used on Mint, as an example.