diff --git a/Using-the-omni‐guides.sh-Automation-Script.md b/Using-the-omni‐guides.sh-Automation-Script.md index 692929c..e0dd48c 100644 --- a/Using-the-omni‐guides.sh-Automation-Script.md +++ b/Using-the-omni‐guides.sh-Automation-Script.md @@ -4,9 +4,9 @@ DISCLAIMER - I am not affiliated with the Wabbajack group in any way, just a gam ## Introduction -Although the script is still in an alpha state, I've done my best to try and capture as many eventualities as I can - but there will always be some that slip through the net. Some Linux distro's keep things in different locations, have slight variations on command syntax, and so on, but I've done what I can to allow this to be as compatible as possible. I have mostly tested this on my Nobara (Fedora) system and Steam Deck, though technically it should work on any distro, keeping in mind the above potential for variations. +This automation script is now in Beta, which means it should be mostly feature complete, though additional enhancements are added regularly to increase efficiency or deal with distro specific or situation specific issues. I've done my best to try and capture as many eventualities as I can - but there will always be some that slip through the net. Some Linux distro's keep things in different locations, have slight variations on command syntax, and so on, but I've done what I can to allow this to be as compatible as possible. I have mostly tested this on my Nobara (Fedora) system and Steam Deck, though technically it should work on any distro, keeping in mind the above potential for variations. -Only Skyrim Special Edition and Fallout 4 are supported at this time - the older games are much harder to get running at the best of times, and would be even harder to automate, but who knows in future.. I've tested and had success with the following Modlists (except where denoted, other users have reported success), but my aim is to make the script work with any Modlist. +Only Skyrim Special Edition and Fallout 4 are supported at this time - the older games are much harder to get running at the best of times, and would be even harder to automate, but who knows in future.. I've tested and had success with the following Modlists (except where denoted, other users have reported success), but my aim is to make the script work with _any_ Modlist. | Skyrim | Fallout 4 | | ------------- | ------------- | @@ -34,8 +34,6 @@ Entries noted with **(GE)** require Proton GE (latest version is fine) to be use For best results, the script expects a newly installed and unchanged modlist directory from Wabbajack, and a newly created but untouched Non-Steam Game Entry in steam, as per the steps below. I'm aiming so that it doesn't matter the path to your modlist, but it's hard to capture all possibilities, so I'd recommend storing the Modlist Install directory in, for example, /home/USER/Games/Skyrim/Anvil, and calling the Steam Entry (e.g) "Skyrim - Anvil", "Skyrim - Lost Legacy", "Skyrim - Living Skyrim 4", and so on. -For a list of what the Automation Script does and doesn't do, please see the [Additional Notes](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki/_new#additional-notes) at the end of this page. - Please do let me know if all or part of the script doesn't work on your platform and I'll try to expand the compatibility - this will help us all. [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) @@ -44,43 +42,19 @@ Please do let me know if all or part of the script doesn't work on your platform ## Steps Required *BEFORE* you run the script -While the script can handle most of the process, there are a couple of things it cannot do; Copying the Modlist Directory from Windows to Linux, Creating the Non-Steam Game entry in Steam, and setting the Name and Proton version of that entry. You will have to create those yourself first. +While the script can handle most of the post-install process, it does not perform the steps to actually download and install the modlist itself. To acquire the modlist, you can either run Wabbajack directly on your Linux/Steam Deck system, or you can copy an existing Modlist Directory from a Windows system. Once you have the modlist on your Linux system/Steam Deck, you can proceed with creating the Non-Steam Game entry in Steam, setting the Name and Proton version of that entry, and launching once. You can the continue with this guide. The script also assumes that you have *sudo* access for your user. There are only a couple of items the script performs that requires sudo, but you should have sudo access set up prior to running (most modern distro's have this set up by default anyway, but on Steam Deck, you will have to have set a password for the deck user.) -I will use Anvil as an example Modlist for this guide. +I will use Anvil as an example Modlist for this guide. **Please change the commands and names shown in this guide to match the Modlist you are trying to run.** -** IMPORTANT **: _Once you have added the Non-Steam Game entry, click Play on it in Steam at least once, even if it fails or gives an error. This is required to register the Game Entry so that Protontricks can manage it._ +** IMPORTANT **: _Once you have added the Non-Steam Game entry, click Play on it in Steam at least once, even if it fails or gives an error. This is required to register the Game Entry so that Protontricks can manage it._ If ModOrganizer does manage to open, asking for a Portable instance, or has no errors at all _you must still close it down and run this script before continuing_. --- -### Step 1 - Create the directory +### Step 1 - Add ModOrganizer.exe as a Non-Steam Game -Once Wabbajack has successfully completed the download and installation of the Modlist on your Windows system, create a new directory on the Steam Deck to house the required files - this can either be on the internal storage, or with the use of a specific launch parameter described below, can live on the SD Card. Open up Konsole terminal and run **only one** of the following, depending on where you want to store the Modlist: - -Create Directory on **Internal Storage**: -``` -mkdir -p /home/deck/Games/Skyrim/Anvil -``` - -OR - -Create Directory on **SD Card**: -``` -mkdir -p /run/media/mmcblk0p1/Games/Skyrim/Anvil -``` - -(Note: Valve plan to change the default mount point of SD Cards within SteamOS soon, I'll update this guide once that chance is in place) - -Technically you can use any path or naming convention you like, but for simplicity of following this guide it may be best just to copy the paths I use. **I recommend not including any spaces in the Directory Name** - it does not play well with the Proton/MO2 combination even with the spaces being escaped, for whatever reason.. - -Copy the Modlist directory from Windows into this newly created directory. There are many ways to do this. I chose to enable ssh on my Deck, and then use rsync to transfer. There are too many options to discuss here, but it should be relatively easy to search for methods. I copied the Modlist Install directory contents from Windows to the newly created directory on the Deck: /home/deck/Games/Skyrim/Anvil/ - ---- - -### Step 2 - Add ModOrganizer.exe as a Non-Steam Game - -The next step is to add ModOrganizer.exe to Steam as a non-steam game. In Steam, click Games, then "Add a Non-Steam Game to My Library": +Once Wabbajack has successfully completed the download and installation of the Modlist, or you have transferred the modlist from your Windows system, the next step is to add ModOrganizer.exe to Steam as a non-steam game. In Steam, click Games, then "Add a Non-Steam Game to My Library": @@ -96,15 +70,15 @@ Ensure ModOrganizer.exe is present and ticked, and then click Add Selected Progr -Once added, edit the properties of the new ModOrganizer.exe entry. The script expects the Shortcut Name to contain either "Skyrim" for Skyrim modlists, or "Fallout" for Fallout based modlists - for example "Skyrim - Anvil" or "Fallout - Life in the Ruins". This is because not limiting the search for game entries the script will find to only Skyrim or Fallout, would mean listing literally all games you have installed. +Once added, edit the properties of the new ModOrganizer.exe entry. The script expects the Shortcut Name to contain either "Skyrim" for Skyrim modlists, or "Fallout" for Fallout based modlists - for example "Skyrim - Tuxborn", "Skyrim - Anvil" or "Fallout - Life in the Ruins". Adjust to match the modlist you are trying to run. This is required because _not_ limiting the search for game entries the script will find to only Skyrim or Fallout, would mean listing literally all games you have installed and would be messy to deal with. -Then in the Compatibility tab tick the box for 'Force the use of a specific Steam Play compatibility tool', then select the Proton version - Personally I now use Proton Experimental which has recently been updated by Valve to be based on Proton 9, and is actually slightly newer than the Proton 9 (Beta) option. This has some very useful fixes for Wabbajack Modlists and Bethesda game mods in general. The script will automatically handle any additional tasks required if you do still need to select Proton 8 for whatever reason. +Switch to the Compatibility tab and tick the box for 'Force the use of a specific Steam Play compatibility tool', then select the Proton version "Proton Experimental". -**IMPORTANT FOR SD CARD USERS** - You must add the following to the Launch Options for the ModOrganizer.exe Non-Steam game, otherwise the Proton environment won't have access to your SD Card contents: +**IMPORTANT FOR SD CARD USERS** - You must add the following to the Launch Options for the ModOrganizer.exe Non-Steam game, otherwise the Proton environment won't have access to your SD Card contents (you may need to adjust the path of your SD Card in /run/media as necessary on your system): ``` STEAM_COMPAT_MOUNTS=/run/media/mmcblk0p1 %command% @@ -114,11 +88,11 @@ Like so: -******IMPORTANT**:**** _As a reminder - Once you have added the Non-Steam Game entry, click Play on it in Steam at least once, even if it fails or gives an error. This is required to register the Game Entry so that Protontricks can manage it._ +******IMPORTANT**:**** _As a reminder - Once you have added the Non-Steam Game entry, click Play on it in Steam at least once. Whether it opens MO2 successfully, it fails or gives an error, you **must** close it down again before continuing. This step is required to register the Game Entry with Steam so that Protontricks can manage it._ --- -### Step 3 - Running the Script +### Step 2 - Running the Script You can run the script directly from GitHub - this will ensure you are using the most up to date version. Run the following command in a terminal/konsole: @@ -146,63 +120,30 @@ Lastly, you will be asked if you want to set the resolution. This is optional bu + --- + ### Post-script tasks -And that's it! You should now be able to click Play on the Modlist entry in Steam. MO2 should start and now be pre-configured correctly - as much as I can, anyway. You may still have to/want to disable any features or mods you don't want or aren't compatible - things such as ENB. For the most part, any Modlist-specific steps will still be listed in my manual guide for that Modlist, but I will also soon be attempting to add Modlist-specific steps to the automation script, where required. +And that's it! You should now be able to click Play on the Modlist entry in Steam. MO2 should start and its executable paths etc pre-configured correctly - as much as I can, anyway. -**PLEASE NOTE** - I have also seen a number of Modlists hang on first launch - either before displaying the Main Menu options (New Game etc), or after clicking New Game. This only seems to happen the first time, and is fine every subsequent time - I believe at this time that it is related to Shader Cache building, but I haven't been able to pin it down or resolve it. There are also some odd cases when on first launch, some mods may fail to load - again this is usually only for the first launch, but there have been times when a restart of Steam has been required (or just a reboot of the deck) - I haven't been able to find out why.. at least it is only a minor annoyance and subsequent launches are fine. +**PLEASE NOTE** - I have also seen a number of Modlists hang or crash on first launch - either before displaying the Main Menu options (New Game etc), or after clicking New Game. This only seems to happen the first time, and is fine every subsequent time. There are also some odd cases when on first launch, some mods may fail to load - again this is usually only for the first launch, but there have been times when a restart of Steam has been required (or just a reboot of the deck) - I haven't been able to find out why.. at least it is only a minor annoyance and subsequent launches are fine. -This is not unique to this automation script, and is a minor annoyance more than anything. +This is not unique to this automation script as it happens when manually configuring things too. Thankfully it's more of a minor annoyance more than anything. --- ### Conclusion -As an addition to the disclaimer at the top of this guide, I have no visibility of longer term stability, so save often, and maybe even make backups of your save-games, just in case ;) +As an addition to the disclaimer at the top of this page, I have no visibility of longer term stability, so save often, and maybe even make backups of your save-games, just in case ;) -If you need help with any of the above, or better yet have another fix, tweak or workaround to help get these Modlists running on Linux, then please do stop by the #unofficial-linux-help channel on the Wabbajack Discord, I should be around so just @ me (@omni) on there! +If you need help with any of the above, or better yet have another fix, tweak or workaround to help get Wabbajack Modlists running on Linux, then please do stop by the #unofficial-linux-help channel on the Wabbajack Discord, I should be around so just @ me (@omni) on there! Enjoy! --- -### Additional Notes - -What this script *does not* do: - -``` -* Create the Modlist directory on Linux and copy the Modlist from Windows. -* Install Protontricks without flatpak - This is far too platform specific. The script will ask the user if they want to install the flatpak version of protontricks, but if not, it's down to the user to source and install. -* Disabling any mods - such as ENB or mods that don't work via Proton - not sure if there's any way to influence the enabled mods in MO2 without doing so through the graphical application. -``` - -What this script *does* do: - -``` -* Detect installed Modlists and ask the user to select the Modlist to configure. -* Detect if running on a Steam Deck. -* Detect protontricks and install via flatpak if not found. -* Detect which game the Modlist is for (or asks if unsure). -* Detect the Steam Library Location (or asks if unsure). -* Handle locations on disk or SDCard (for Steam Deck). -* Detects the modlist directory location (or asks if unsure). -* Set protontricks permissions appropriately. -* Enables the visibility of (.)dotfiles in the proton prefix -* Installs the required Wine components via protontricks -* Checks the MO2 version for compatibility. -* If MO2 2.5 and Proton 8 are detected, offer the option to automatically downgrade to MO2 2.4. -* Chown/Chmod the Modlist directory. -* Backup ModOrganizer.ini prior to making changes. -* Handle the download_directory entry in ModOrganizer.ini. -* Detect and replace the gamePath entry in ModOrganizer.ini appropriately. -* Detect and replace the workingDirectory paths in ModOrganizer.ini appropriately. -* Edit the Resolution based on user entry. -* Any smaller additional tasks for compatibility. -``` - ---- [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD)