From ccff1ec955a57e91bfa70ec600c7975d12fe81cc Mon Sep 17 00:00:00 2001 From: Omni Date: Tue, 24 Feb 2026 12:36:45 +0000 Subject: [PATCH] Wiki rework: new install/configure guides, v0.4.0 screenshots, structure improvements --- Configure-Existing-Modlist.md | 52 +++ Configure-New-Modlist.md | 78 ++++ FNVTemp.md | 185 -------- Installing-Additional-Tools.md | 316 +++++++++++++ Installing-a-Modlist-with-Jackify.md | 245 ++++++++++ Installing-a-Modlist-with-Wabbajack.md | 308 +++++++++++++ Manual-Installation-Guides.md | 18 + My-Wabbajack-VM-Setup.md | 204 --------- User-Guide.md | 406 +++-------------- Using-the-omni‐guides.sh-Automation-Script.md | 164 +------ WIP-Skyrim:-AVO-(Deck).md | 330 -------------- Wabbajack-on-Linux-via-Wine.md | 405 ----------------- Wabbajack-on-Steam-Deck-Linux-via-Bottles.md | 3 - Wabbajack-via-Proton.md | 133 +----- Withdrawn:--Skyrim-Journey.md | 326 -------------- Withdrawn:-AVO.md | 303 ------------- Withdrawn:-Skyrim-Dragonborn.md | 424 ------------------ Withdrawn:-Skyrim-Redoran.md | 419 ----------------- Withdrawn:-Skyrim-Septimus.md | 404 ----------------- Withdrawn:-Skyrim-Sovngarde.md | 351 --------------- 20 files changed, 1079 insertions(+), 3995 deletions(-) create mode 100644 Configure-Existing-Modlist.md create mode 100644 Configure-New-Modlist.md delete mode 100644 FNVTemp.md create mode 100644 Installing-Additional-Tools.md create mode 100644 Installing-a-Modlist-with-Jackify.md create mode 100644 Installing-a-Modlist-with-Wabbajack.md create mode 100644 Manual-Installation-Guides.md delete mode 100644 My-Wabbajack-VM-Setup.md delete mode 100644 WIP-Skyrim:-AVO-(Deck).md delete mode 100644 Wabbajack-on-Linux-via-Wine.md delete mode 100644 Wabbajack-on-Steam-Deck-Linux-via-Bottles.md delete mode 100644 Withdrawn:--Skyrim-Journey.md delete mode 100644 Withdrawn:-AVO.md delete mode 100644 Withdrawn:-Skyrim-Dragonborn.md delete mode 100644 Withdrawn:-Skyrim-Redoran.md delete mode 100644 Withdrawn:-Skyrim-Septimus.md delete mode 100644 Withdrawn:-Skyrim-Sovngarde.md diff --git a/Configure-Existing-Modlist.md b/Configure-Existing-Modlist.md new file mode 100644 index 0000000..9501fe3 --- /dev/null +++ b/Configure-Existing-Modlist.md @@ -0,0 +1,52 @@ +Jackify Banner + +
+ +[Wiki](https://github.com/Omni-guides/Jackify/wiki) | [Nexus](https://www.nexusmods.com/site/mods/1427) | [Download](https://www.nexusmods.com/site/mods/1427?tab=files) | [Wabbajack Discord](https://discord.gg/wabbajack) | [Jackify Issues](https://github.com/Omni-guides/Jackify/issues) | [Ko-fi](https://ko-fi.com/omni1) + +
+ +--- + +# Configure Existing Modlist + +Use this workflow if a modlist is already in your Steam library but needs (re)configuring — for example after moving your installation to a new location, or if something went wrong during an earlier configuration. + +--- + +## Step 1: Open Configure Existing Modlist + +From the Jackify main menu, select **Modlist Tasks**, then **Configure Existing Modlist (In Steam)**. + +Modlist Tasks menu — Configure Existing Modlist highlighted + +*Modlist Tasks menu — select Configure Existing Modlist (In Steam)* + +Configure Existing Modlist - Interface + +*The reconfiguration interface lets you update settings while preserving existing Steam integration* + +--- + +## Step 2: Select Your Modlist + +Jackify detects existing modlist shortcuts in your Steam library and presents them for selection. + +Configure Existing Modlist - Selection + +*Jackify detects existing modlist shortcuts in Steam* + +**Common reasons to use this workflow:** +- Moving a modlist installation to a new location +- Fixing a corrupted or broken Steam shortcut +- Re-applying configuration after a Proton or Steam update + +--- + +## Step 3: Start Configuration + +Confirm your settings and click **Start Configuration**. Jackify will re-apply Steam integration, Proton settings, and launch options. + +--- + +*Back to [[User Guide]] | See also: [[Configure New Modlist]]* diff --git a/Configure-New-Modlist.md b/Configure-New-Modlist.md new file mode 100644 index 0000000..f897511 --- /dev/null +++ b/Configure-New-Modlist.md @@ -0,0 +1,78 @@ +Jackify Banner + +
+ +[Wiki](https://github.com/Omni-guides/Jackify/wiki) | [Nexus](https://www.nexusmods.com/site/mods/1427) | [Download](https://www.nexusmods.com/site/mods/1427?tab=files) | [Wabbajack Discord](https://discord.gg/wabbajack) | [Jackify Issues](https://github.com/Omni-guides/Jackify/issues) | [Ko-fi](https://ko-fi.com/omni1) + +
+ +--- + +# Configure New Modlist (Post-Download) + +> [!NOTE] +> This guide uses **Tuxborn** (a Skyrim Special Edition modlist) as a worked example throughout. The steps are identical for any Wabbajack modlist — substitute your modlist name and game wherever Tuxborn and Skyrim appear. + +Use this workflow if you have a modlist that was installed with another method (such as Wabbajack on Windows, or following older guides) and want to integrate it properly with Steam on Linux. See [[Installing a Modlist with Jackify]] for the full end-to-end guide if you are starting from scratch (or [[Installing a Modlist with Wabbajack]] if you do not have Nexus Premium). + +This workflow will: +- Create a proper Steam shortcut +- Configure Proton settings +- Set up launch options +- Install any missing compatibility components + +--- + +## Step 1: Open Configure New Modlist + +From the Jackify main menu, select **Modlist Tasks**, then **Configure New Modlist (Post-Download)**. + +Modlist Tasks menu — Configure New Modlist highlighted + +*Modlist Tasks menu — select Configure New Modlist (Post-Download)* + +Configure New Modlist - Initial + +*The configuration screen for bringing an existing modlist installation into Steam* + +--- + +## Step 2: Locate Your ModOrganizer.exe + +Browse to your existing `ModOrganizer.exe` file. This tells Jackify where your modlist is installed. + +Configure New Modlist - Browse to MO2 + +*Browse to locate your ModOrganizer.exe — Jackify will analyse the installation and configure Steam integration automatically* + +Jackify analyses: +- Game type and version +- Required compatibility components +- Steam integration requirements + +--- + +## Step 3: Set Name and Resolution + +Enter a name for the modlist and select your display resolution. + +Configure New Modlist - Completed + +*Name, path and resolution filled in — ready to start configuration* + +--- + +## Step 4: Start Configuration + +Click **Start Configuration**. Jackify will: + +- Create a Steam shortcut +- Configure Proton settings +- Set up launch options +- Install any missing compatibility components + +Once complete, open Steam and click Play to launch Mod Organizer 2, then run the game from there. + +--- + +*Back to [[User Guide]] | See also: [[Configure Existing Modlist]]* diff --git a/FNVTemp.md b/FNVTemp.md deleted file mode 100644 index 719e231..0000000 --- a/FNVTemp.md +++ /dev/null @@ -1,185 +0,0 @@ -![Begin Again Banner](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/BeginAgain/BeginAgain_banner.png) - -# Begin Again - -Begin Again is a modlist focused on bringing the gameplay feel of later Fallout titles into Fallout 3 and New Vegas, whilst being careful to preserve what made those games unique. Overhauled locations, textures, characters, and gunplay in a simple-to-install package thanks to Wabbajack. - ---- - -## Instructions - -**Tested on Begin Again v4.0.2** - -This guide covers getting the Modlist running on Linux, it does **not** cover downloading the Modlist via Wabbajack itself. You can follow the [guides on this github](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki) for running Wabbajack to install the modlist itself. - -If playing on the Steam Deck, the below steps must be carried out in Desktop mode, but once complete you can launch the Modlist and play the game from Game Mode. - -This guide assumes you have installed Begin Again via Wabbajack and have the TTW archive ready to add to MO2 when the time comes. - -> **YOU MUST HAVE COMPLETED ALL THE STEPS FOR CREATING THE TTW MOD AS DIRECTED BY THE BEGIN AGAIN INSTALLATION STEPS**, up until it asks you to add to MO2. - -I also assume that you have set a user password on the Steam Deck (or have sudo access if on a general Linux system). The commands and paths I use will match up with users of the Steam Deck, but you can easily modify the commands and paths to suit your system. - ---- - -With Fallout New Vegas installed on your system, and the whole Wabbajack and TTW processes complete: - -### Step 1 - 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": - - - -Click Browse: - - - -Browse to the path of your modlist. e.g. /home/deck/Games/Fallout/BeginAgain, select ModOrganizer.exe, and click Open. - - - -Ensure ModOrganizer.exe is present and ticked, and then click Add Selected Program. - - - - ---- - - -### Step 2 - Configure the new Steam entry - -Once added, edit the properties of the new ModOrganizer.exe entry. Rename the new Steam entry to be "FNV - Begin Again" (for my automated post-install script that you will use later to function, the Steam entry must start "FNV - " to be picked up correctly): - - - -Then, in the Compatibility tab tick the box for 'Force the use of a specific Steam Play compatibility tool', then select "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: - -``` -STEAM_COMPAT_MOUNTS=/run/media/mmcblk0p1 %command% -``` - -Like so: - -![IMAGE STEAM_COMPAT_MOUNTS](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-STEAM_COMPAT_MOUNTS.png) - - -Close the properties window, and click play on FNV - Begin Again entry in Steam. This should start Mod Organizer. Once it opens, CLOSE IT DOWN AGAIN. This step is critical as it creates the prefix for the modlist entry, but we're not ready to play the modlist just yet. - - ---- - - -## Step 3 - Run the Omni-Guides Configuration Script - -This custom script will automate the installation of necessary Proton components and configure your environment for Mod Organizer 2, and Begin Again, to run successfully. - -Open a Konsole terminal and run: - -``` -bash <(curl -s https://raw.githubusercontent.com/Omni-guides/Wabbajack-Modlist-Linux/main/binaries/omni-guides.sh) -``` - -Follow any on-screen prompts from the script. - - ---- - - -## Step 4 - Apply the 4GB Patcher - -The 4GB Patcher is crucial for Fallout: New Vegas stability. - -- Download the Linux version of the 4GB Patcher from Nexus Mods: [Download 4GB Patcher](https://www.nexusmods.com/newvegas/mods/62552) -- Extract the `FalloutNVPatcher` executable from the .zip file into your vanilla Fallout New Vegas directory. - -**Internal Storage:** - -``` -/home/deck/.local/share/Steam/steamapps/common/Fallout New Vegas/ -``` - -**SD Card:** - -``` -/run/media/mmcblk0p1/SteamLibrary/steamapps/common/Fallout New Vegas/ -``` - -Set the file as executable: - -``` -chmod +x "/home/deck/.local/share/Steam/steamapps/common/Fallout New Vegas/FalloutNVPatcher" -``` - -(Use quotes around the path if it contains spaces.) - -Then, cd to the Fallout New Vegas directory and run the patcher: - -``` -cd "/home/deck/.local/share/Steam/steamapps/common/Fallout New Vegas" -./FalloutNVPatcher - -``` - -It should output that the file was patched successfully. - - - - ---- - - -## Step 5 - Set the required Launch Options in Steam - -Fallout New Vegas modlists, unlike those for Skyrim, FO4 etc, *need* to be launched from the Vanilla Fallout New Vegas prefix, for some reason. We can make this happen by adding the following Launch Option in the steam properties for "FNV - Begin Again": - -``` -STEAM_COMPAT_DATA_PATH="/home/deck/.local/share/Steam/steamapps/compatdata/22380" %command% -``` - -You will need to edit this to match the path to your Vanilla Fallout New Vegas compatdata directory - this could be on your SDCard, or if you're on Linux desktop, could be a different drive if your Steam Library is there instead, such as - -``` -STEAM_COMPAT_DATA_PATH="/SteamLibrary/steamapps/compatdata/22380" %command% -``` - -SDCard users who earlier needed to add the STEAM_COMPAT_MOUNTS launch option, these can be chained like so: - -``` -STEAM_COMPAT_DATA_PATH="/run/media/mmcblk0p1/steamapps/compatdata/22380" STEAM_COMPAT_MOUNTS=/run/media/mmcblk0p1 %command% -``` - -It should look something like so: - - - -## Step 6 - Click Play! - -In Mod Organizer 2, ensure the dropdown menu in the top-right is set to "Begin Again" (or whatever the main game executable profile is named for the modlist). - -Click the **Run** button (play icon). - -You may get a warning about some missing `.ini` files. This is expected; just click OK. - -If you're not playing on Steam Deck, head to the conclusion and you’re done! - -Deck users: close the game down again if you launched it, as you can now change back to Game Mode to run the game after reading the Conclusion. - ---- - -## Conclusion - -If you've read this far, well done! I'd very much appreciate a Star for this guide, just to show if I'm on the right track. I'm also open to any feedback, positive or negative. - -I would love to hear your feedback on performance of this or other modlists, and any tweaks that you made! - -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 ;) - -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! - -**Enjoy!** - -![Begin Again Game Menu](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/BeginAgain/BeginAgain_GameMenu.png) \ No newline at end of file diff --git a/Installing-Additional-Tools.md b/Installing-Additional-Tools.md new file mode 100644 index 0000000..a801e40 --- /dev/null +++ b/Installing-Additional-Tools.md @@ -0,0 +1,316 @@ + + +# Installing Additional Tools + +## Introduction + +This guide covers installation of additional tools that enhance compatibility and functionality for modlists on Linux and Steam Deck. These tools are used by both Jackify's automated processes and post-install phase of a Wabbajack installation. + +**Tools covered in this guide:** +- **[Protontricks](#installing-protontricks)**: Tool for managing Proton prefixes — required regardless of which Proton version you use +- **[GE-Proton](#installing-ge-proton)**: Alternative Proton builds with better performance and ENB compatibility + +--- + +# Installing Protontricks + +**Protontricks** is a tool we will use to manage Wine components (like vcrun2022, dotnet, etc.) in Proton prefixes. It is required for modlist configuration regardless of which Proton version you use. + +## Why Protontricks? + +Protontricks allows you to: +- Install Wine components (DLLs, runtimes) in Proton prefixes +- Apply registry fixes for .NET Framework compatibility +- Manage and troubleshoot Proton prefix configurations + +**Required version**: 1.11.0 or newer + +--- + +## Installation + +### Steam Deck: Discover Store + +Search for **Protontricks** in the Discover Store and install it from there. No terminal needed. + +--- + +### All Distributions: Flatpak + +**Flatpak is recommended for all distributions** — provides the latest version with universal compatibility. + +```bash +flatpak install --user flathub com.github.Matoking.protontricks +``` + +**Launch**: +```bash +flatpak run com.github.Matoking.protontricks +``` + +**Grant Steam access** (if using Flatpak Steam): +```bash +flatpak override --user --filesystem=~/.var/app/com.valvesoftware.Steam com.github.Matoking.protontricks +``` + +**Add alias for easier usage** (optional but recommended): + +To avoid typing the full `flatpak run` command every time, add an alias to your shell configuration: + +**For Bash (most Linux distributions)**: +```bash +echo 'alias protontricks="flatpak run com.github.Matoking.protontricks"' >> ~/.bashrc +source ~/.bashrc +``` + +**For Zsh (some distributions)**: +```bash +echo 'alias protontricks="flatpak run com.github.Matoking.protontricks"' >> ~/.zshrc +source ~/.zshrc +``` + +**For Fish**: +```bash +echo 'alias protontricks="flatpak run com.github.Matoking.protontricks"' >> ~/.config/fish/config.fish +source ~/.config/fish/config.fish +``` + +**For Steam Deck** (uses Bash): +```bash +echo 'alias protontricks="flatpak run com.github.Matoking.protontricks"' >> ~/.bashrc +source ~/.bashrc +``` + +After adding the alias, you can simply use `protontricks` instead of the full command: +```bash +protontricks -l +``` + +--- + +### Alternative: Distribution Packages + +Distribution packages may be older versions. Flatpak is recommended for most users. + +**Arch/Manjaro**: +```bash +sudo pacman -S protontricks +``` + +**Fedora/Nobara**: +```bash +sudo dnf install protontricks +``` + +**Ubuntu/Debian** (though I recommend you use the flatpack version): +```bash +sudo apt install protontricks +``` + +--- + +## Verifying Protontricks Installation + +Check that Protontricks is installed and working: + +```bash +protontricks --version +``` + +You should see version 1.11.0 or newer. + +List available Proton prefixes: +```bash +protontricks -l +``` + +You should see a list of Steam games and non-Steam shortcuts with their AppIDs. + +--- + +## Protontricks Troubleshooting + +### Command not found + +- **Flatpak**: Use full command `flatpak run com.github.Matoking.protontricks` +- **System package**: Ensure protontricks is in your PATH + +### No Steam games found + +- Ensure Steam is installed and has launched at least once +- For Flatpak Steam, grant filesystem permissions (see Flatpak installation section above) +- Check Steam library paths are accessible + +### Winetricks fails to download components + +- Check internet connection +- Try updating protontricks: `flatpak update` or your package manager's update command +- Some components may require accepting licenses - follow prompts + +--- + +# Installing GE-Proton + +While Steam provides official Proton versions, alternative builds like **GE-Proton** (GloriousEggroll) often provide better compatibility and performance for modded games. GE-Proton is **highly recommended** for use with Jackify and modlists, especially those using ENB. + +## Why GE-Proton? + +GE-Proton (Proton-GE) is a community build of Proton with additional patches and features: + +- Better compatibility with modded games and ENB +- Includes fixes not yet in official Proton releases +- Recommended for Skyrim, Fallout, and other Bethesda modlists +- **Required** for ENB support with Proton 10+ + +**Recommended version**: GE-Proton 10-14 (Specifically 10-14, anything newer than this breaks ENB compatibility) + +--- + +## Method 1: ProtonPlus + +[ProtonPlus](https://github.com/Vysp3r/ProtonPlus) is a graphical tool for managing Proton and compatibility tool versions, with a clean interface and broad distribution support. Install it via Flatpak (available in the Discover Store on Steam Deck) or your distribution's package manager. + +### Installing GE-Proton + +1. **Install and launch ProtonPlus** — available via Flatpak (search for it in the Discover Store on Steam Deck), your distribution's package manager, or via another method. See the [ProtonPlus GitHub](https://github.com/Vysp3r/ProtonPlus) for all options. + + + +*Screenshot: ProtonPlus main window* + +2. **Navigate to the "Runners" tab** + +3. **Find "Proton-GE"** in the list of available tools + +4. **Select and install GE-Proton 10-14** — this is the recommended version for modlists. If your modlist uses ENB, do not install a newer version as it will break ENB compatibility + + + +*Screenshot: ProtonPlus — GE-Proton selected for installation* + +5. **Wait for installation** to complete + +6. **Restart Steam** for the new version to appear and be available to use in Jackify + +7. **Verify installation**: Open Steam, go to any game's Properties > Compatibility, and you should see the new GE-Proton version in the dropdown + + + +*Screenshot: Steam game Properties — Compatibility tab showing GE-Proton* + +--- + +## Method 2: ProtonUp-Qt + +[ProtonUp-Qt](https://github.com/DavidoTek/ProtonUp-Qt) is an alternative graphical tool for managing Proton versions. Install it via Flatpak (available in the Discover Store on Steam Deck) or your distribution's package manager. + +### Installing GE-Proton + +1. **Install and launch ProtonUp-Qt** — available via Flatpak (search for it in the Discover Store on Steam Deck), your distribution's package manager, or via another method. See the [ProtonUp-Qt GitHub](https://github.com/DavidoTek/ProtonUp-Qt) for all options. + + + +*Screenshot: ProtonUp-Qt main window* + +2. **Select "Add version"** + +3. **Configure installation**: + - **Compatibility tool**: Select "GE-Proton" + - **Version**: Select and install GE-Proton 10-14 — this is the recommended version for modlists. If your modlist uses ENB, do not install a newer version as it will break ENB compatibility + + + +*Screenshot: ProtonUp-Qt — version selection dialog* + +4. **Click "Install"** and wait for the download to complete. + +5. **Restart Steam** for the new version to appear and be available to use in Jackify + +6. **Verify installation**: Open Steam, go to any game's Properties > Compatibility, and you should see the new GE-Proton version in the dropdown + + + +*Screenshot: Steam game Properties — Compatibility tab showing GE-Proton* + +--- + +## Verifying GE-Proton Installation + +After installing GE-Proton with any method: + +1. **Restart Steam** (if not already done) + +2. **Right-click any game** in your Steam library > **Properties** + +3. **Go to Compatibility tab** + +4. **Check "Force the use of a specific Steam Play compatibility tool"** + +5. **Open the dropdown** - you should see your newly installed GE-Proton version + +--- + +## Manual GE-Proton Installation (Advanced) + +If you prefer manual installation or the above methods don't work: + +1. **Download GE-Proton** from [GitHub Releases](https://github.com/GloriousEggroll/proton-ge-custom/releases) + +2. **Extract to compatibilitytools.d**: + ```bash + mkdir -p ~/.steam/steam/compatibilitytools.d + tar -xf GE-Proton*.tar.gz -C ~/.steam/steam/compatibilitytools.d/ + ``` + +3. **For Flatpak Steam**: + ```bash + mkdir -p ~/.var/app/com.valvesoftware.Steam/data/Steam/compatibilitytools.d + tar -xf GE-Proton*.tar.gz -C ~/.var/app/com.valvesoftware.Steam/data/Steam/compatibilitytools.d/ + ``` + +4. **Restart Steam** + +--- + +## GE-Proton Troubleshooting + +### GE-Proton doesn't appear in Steam + +- Ensure you restarted Steam completely (not just closed the window) +- Check installation path is correct: + - Native Steam: `~/.steam/steam/compatibilitytools.d/` + - Flatpak Steam: `~/.var/app/com.valvesoftware.Steam/data/Steam/compatibilitytools.d/` +- Verify the extracted folder name matches the version (e.g., `GE-Proton9-20`) + +### ProtonUp-Qt can't find Steam + +- If using Flatpak Steam, grant ProtonUp-Qt filesystem permissions: + ```bash + flatpak override --user --filesystem=~/.var/app/com.valvesoftware.Steam net.davidotek.pupgui2 + ``` + +--- + +## Recommended GE-Proton Versions + +For modlists and ENB compatibility: + +- **GE-Proton 10-14** (recommended maximum - newer versions break ENB) +- **GE-Proton 9-27** (alternative for ENB modlists, but may cause other issues) +- Versions newer than GE-Proton 10-14 will cause endless black screen with ENB + +--- + +## External Links + +| Resource | URL | Description | +|----------|-----|-------------| +| GE-Proton Releases | https://github.com/GloriousEggroll/proton-ge-custom/releases | Official GE-Proton downloads | +| ProtonUp-Qt | https://github.com/DavidoTek/ProtonUp-Qt | ProtonUp-Qt project page | +| ProtonPlus | https://github.com/Vysp3r/ProtonPlus | ProtonPlus project page | +| Protontricks | https://github.com/Matoking/protontricks | Protontricks project page | +| ProtonDB | https://www.protondb.com/ | Game compatibility database | + +--- + +*This guide is referenced by: [Installing a Modlist with Jackify](Installing-a-Modlist-with-Jackify), [Installing a Modlist with Wabbajack](Installing-a-Modlist-with-Wabbajack), and [Manual Installation Guides](Manual-Installation-Guides).* diff --git a/Installing-a-Modlist-with-Jackify.md b/Installing-a-Modlist-with-Jackify.md new file mode 100644 index 0000000..0b00ad8 --- /dev/null +++ b/Installing-a-Modlist-with-Jackify.md @@ -0,0 +1,245 @@ + + +# Installing a Modlist with Jackify + +> [!NOTE] +> This guide uses **Tuxborn** (a Skyrim Special Edition modlist) as a worked example throughout. The steps are identical for any Wabbajack modlist — substitute your modlist name and game wherever Tuxborn and Skyrim appear. + +> [!IMPORTANT] +> A Nexus Mods Premium subscription is currently required for automated downloads. Non-Premium support is coming in a future release. A [3-day free trial](https://www.nexusmods.com/users/myaccount?tab=subscriptions) is available if you want to try it out. + +> [!IMPORTANT] +> A successful installation **_does not_** guarantee the modlist will work on your system. Linux modding involves too many hardware, driver, and system-specific variables for any guarantee to be made. If something does not work after a successful install, seek help in [#unofficial-linux-help](https://discord.gg/wabbajack) on the Wabbajack Discord. + +## Introduction + +Jackify provides fully automated modlist installation and configuration for Linux and Steam Deck - with the exception of some Fallout New Vegas modlists. This guide covers the complete start-to-finish installation process — Jackify handles everything automatically with no manual configuration needed. + +## Prerequisites + +- Linux system (Steam Deck, Ubuntu, Fedora/Nobara, Arch, etc.) +- Steam installed and logged in +- **Protontricks** — required for modlist configuration + - See [Installing Protontricks](Installing-Additional-Tools#installing-protontricks) for installation instructions +- **Proton GE 10-14** (highly recommended, maximum for ENB compatibility) + - See [Installing GE-Proton](Installing-Additional-Tools#installing-ge-proton) for installation instructions + - Alternatively, Proton 10 or Proton Experimental will work for non-ENB modlists +- Nexus Mods Premium subscription +- 7-Zip (for AppImage extraction) +- FUSE (pre-installed on most distributions) +- **Ubuntu/Debian-based distros only** (Ubuntu, Kubuntu, Linux Mint, Pop!_OS, Zorin OS, elementary OS, and others): Qt platform plugin library + ```bash + sudo apt install libxcb-cursor-dev + ``` + +--- + +## Step 1: Download and Extract Jackify + +1. Download Jackify from [Nexus Mods](https://www.nexusmods.com/site/mods/1427) +2. Extract the AppImage from the 7z archive: + ```bash + 7z x Jackify.7z + ``` +3. Make it executable: + ```bash + chmod +x Jackify.AppImage + ``` + + + +*Screenshot: Jackify on Nexus Mods* + +--- + +## Step 2: Launch Jackify + +```bash +./Jackify.AppImage +``` + +Or for CLI mode: +```bash +./Jackify.AppImage --cli +``` + + + +*Screenshot: Jackify main window* + +--- + +## Step 3: Install a Modlist + +1. From the main menu, select **"Modlist Tasks"** + + + +*Screenshot: Jackify main menu — Modlist Tasks option* + +2. Select **"Install a Modlist (Automated)"** + + + +*Screenshot: Modlist Tasks menu* + +3. **Choose your game** (e.g. Skyrim, Fallout 4, etc.) + + + +*Screenshot: Game type selection — Skyrim shown as example* + +4. **Authorise with Nexus Mods:** + - Click the **"Authorise"** button + - Complete the OAuth login in your browser + - Jackify will be redirected back automatically once authorised + + + + *Screenshot: Jackify installation screen with Authorise button* + + + + *Screenshot: Nexus Mods OAuth login page* + +5. **Select your modlist:** + + **Option A — Browse the Modlist Gallery:** + - Click the "Select Modlist" button + - Use the search box to find your modlist + - Filter by game, tags, or NSFW content as needed + - Check download and install sizes before proceeding + - Click on your modlist to select it, then click **"Install"** + + + + *Screenshot: Modlist gallery — Tuxborn shown as example* + + **Option B — Supply your own .wabbajack file:** + - Click the **"Use .wabbajack file"** tab + - Browse to your downloaded .wabbajack file + +6. **Set Installation and Download Directories:** + - Installation directory: where the modlist and Mod Organizer 2 will be installed + - Download directory: where mod archives will be stored (can be on slower storage and deleted after installation) + - Avoid spaces in directory names + - Examples: + ``` + Installation: ~/Games/Tuxborn + Downloads: ~/Modlist_Downloads/Tuxborn + ``` + + + + *Screenshot: Installation and download directories configured — Tuxborn shown as example* + +7. **Set Resolution:** + - Select your display resolution from the dropdown + - Steam Deck default: 1280x800 + + + + *Screenshot: Resolution selection* + +8. **Click "Start Installation"** + + + +*Screenshot: Installation ready to start* + +--- + +## Step 4: Wait for Installation + +Jackify will automatically download, install, and configure the modlist. + +**Installation Phase:** +- Download the modlist .wabbajack file (if needed) +- Download all required mod archives from Nexus Mods +- Extract and organise mod files +- Convert textures (if needed) +- Build BSAs + +**Configuration Phase (Automatic):** +- Create a Steam shortcut with proper Proton configuration +- Install required Wine components (vcrun2022, dotnet, etc.) +- Apply game-specific registry fixes +- Configure launch options and display resolution +- Restart Steam to apply changes + +**This process may take several hours** depending on modlist size, internet speed, CPU, GPU and disk performance. Installation is resumable — if interrupted, simply reuse the same directories and Jackify will continue from where it left off. + + + +*Screenshot: Installation in progress* + +Once installation and configuration complete, Jackify will show a success message. + + + +*Screenshot: Installation complete* + +--- + +## Step 5: Launch and Play + +1. Open Steam — your modlist will appear in your library + + + +*Screenshot: Modlist shortcut in Steam library — your modlist will appear here; Tuxborn shown as example* + +2. Click **Play** — Mod Organizer 2 will launch +3. In Mod Organizer 2, ensure your desired **profile** is selected in the left-hand dropdown at the top of the window +4. In the right-hand dropdown next to the **Run** button, ensure the correct executable for your modlist is selected (this is usually the modlist name or the game launcher) +5. Click **Run** to start the game + + + +*Screenshot: Mod Organizer 2 — profile dropdown (top left) and Run button (top right)* + +> [!WARNING] +> Shortly after clicking Run, an **Unlock** button will appear in Mod Organizer 2. Do not click it — doing so will break your modlist installation. + +### First Launch Expectations + +The first launch will behave differently from subsequent ones: + +- **Long load times**: Via Proton, initial load times are longer than on Windows. On Steam Deck this can be 7-8 minutes. This is normal and unfortunately not limited to just the first launch. +- **Shader compilation**: The game will compile shaders on first launch. This is a one-off process. +- **Possible crashes**: 1-2 crashes during the first few launches are normal while the shader cache builds. Relaunch and continue. +- **Unusual colours on the main menu**: Can occur during initial shader building and resolves once the game fully loads. +- **Creations download prompt**: Skyrim Modlists On Linux, the game may not recognise that Creation Club content is already installed and will prompt you to download it again. You do not need to re-download anything — dismiss the prompt with `Escape` or `Enter` on keyboard, or the back/dismiss button on a gamepad. +- **Character naming box**: If you cannot type in the character name field on first launch, restart the game once more and try again. + +--- + +## Troubleshooting + +**Installation fails:** +- Try running the installation again — temporary network issues can cause failures +- Verify you have sufficient disk space +- Re-authorise with Nexus Mods if your session has expired +- Check internet connection stability + +**Jackify won't start:** +- Ensure FUSE is installed on your system +- Check file permissions: `chmod +x Jackify.AppImage` +- Try running from terminal to see any error output + +**Installation fails with errors referencing `ccbgssse037-curios` (Skyrim modlists):** +Bethesda distributes Rare Curios in two versions — one via Steam (uppercase filenames) and one via the in-game Creations menu (lowercase filenames). Wabbajack modlists require the lowercase version. To fix: +1. Delete `ccBGSSSE037-Curios.bsa` and `ccBGSSSE037-Curios.esl` from your Skyrim `Data` folder +2. Launch Skyrim Special Edition from Steam +3. Go to **Creations** in the main menu +4. Search for and download **Rare Curios** +5. Wait until it shows as Installed, then close the game +6. Retry the installation in Jackify + +**Need help:** +- For modlist-specific issues, check the modlist's own Discord or support channels +- Report Jackify issues on [GitHub Issues](https://github.com/Omni-guides/Jackify/issues) + +--- + +*For installation without Nexus Premium, see [Installing a Modlist with Wabbajack](Installing-a-Modlist-with-Wabbajack).* diff --git a/Installing-a-Modlist-with-Wabbajack.md b/Installing-a-Modlist-with-Wabbajack.md new file mode 100644 index 0000000..03a549a --- /dev/null +++ b/Installing-a-Modlist-with-Wabbajack.md @@ -0,0 +1,308 @@ + + +# Installing a Modlist with Wabbajack + +> [!NOTE] +> This guide uses **Tuxborn** (a Skyrim Special Edition modlist) as a worked example throughout. The steps are identical for any Wabbajack modlist — substitute your modlist name and game wherever Tuxborn and Skyrim appear. + +> [!NOTE] +> This guide is for Linux/Steam Deck users **without** Nexus Premium. If you have Premium, [Installing a Modlist with Jackify](Installing-a-Modlist-with-Jackify) is faster and fully automated. Nexus Mods offers a [3-day free trial](https://www.nexusmods.com/users/myaccount?tab=subscriptions) if you want to try the automated route. + +> [!IMPORTANT] +> A successful installation **_does not_** guarantee the modlist will work on your system. Linux modding involves too many hardware, driver, and system-specific variables for any guarantee to be made. If something does not work after a successful install, seek help in [#unofficial-linux-help](https://discord.gg/wabbajack) on the Wabbajack Discord. + +## Introduction + +This guide covers installing a Wabbajack modlist on Linux without Nexus Premium. The workflow is: + +1. **Download Jackify** — used to install and configure Wabbajack on Linux +2. **Install Wabbajack via Jackify** — automated setup of Wabbajack under Proton +3. **Use Wabbajack** — download and install the modlist (manual downloads for non-Premium) +4. **Configure with Jackify** — automated post-install configuration (Steam shortcut, Proton, Wine components) + +## Prerequisites + +- Linux system (Steam Deck or desktop Linux) +- Steam installed and logged in +- **Protontricks** — required for modlist configuration + - See [Installing Protontricks](Installing-Additional-Tools#installing-protontricks) for installation instructions +- **Proton GE 10-14** (highly recommended, maximum for ENB compatibility) + - See [Installing GE-Proton](Installing-Additional-Tools#installing-ge-proton) for installation instructions + - Alternatively, Proton 10 or Proton Experimental will work for non-ENB modlists +- Nexus Mods account (Premium not required) +- Sufficient disk space for the modlist +- 7-Zip (for AppImage extraction) +- FUSE (pre-installed on most distributions) +- **Ubuntu/Debian-based distros only** (Ubuntu, Kubuntu, Linux Mint, Pop!_OS, Zorin OS, elementary OS, and others): Qt platform plugin library + ```bash + sudo apt install libxcb-cursor-dev + ``` + +--- + +## Step 1: Download and Extract Jackify + +1. Download Jackify from [Nexus Mods](https://www.nexusmods.com/site/mods/1427) +2. Extract the AppImage from the 7z archive: + ```bash + 7z x Jackify.7z + ``` +3. Make it executable: + ```bash + chmod +x Jackify.AppImage + ``` + + + +*Screenshot: Jackify on Nexus Mods* + +--- + +## Step 2: Install Wabbajack via Jackify + +Jackify automates the entire Wabbajack setup process on Linux. + +1. Launch Jackify by either double-clicking the AppImage, or by running in a konsole/terminal: + ```bash + ./Jackify.AppImage + ``` + +2. From the main menu, click **"Additional Tasks"** + + + +*Screenshot: Jackify main menu — Additional Tasks option* + +3. Click **"Install Wabbajack"** + + + +*Screenshot: Additional Tasks menu — Install Wabbajack option* + +4. Configure the installation: + - Set the installation directory (default: `~/Games/Wabbajack`) + - Set a shortcut name (default: "Wabbajack") + + + +*Screenshot: Wabbajack installer configuration* + +5. Click **"Start Installation"** + + + +*Screenshot: Wabbajack installer ready to start* + +Jackify will automatically: +- Download the latest Wabbajack.exe +- Create a Steam shortcut +- Initialise a Wine prefix with Proton +- Install WebView2 runtime (required for Nexus login and manual/Non-Premium archive downloads) +- Apply Proton-specific fixes +- Restart Steam to apply the shortcut + + + +*Screenshot: Wabbajack installation in progress* + +This process typically takes 2-5 minutes. Once complete, you'll see a success message. + + + +*Screenshot: Wabbajack installation complete* + +--- + +## Step 3: Launch Wabbajack and Log In + +1. Open Steam and find **"Wabbajack"** in your library +2. Click **Play** to launch Wabbajack + + + +*Screenshot: Wabbajack in Steam library* + +On first launch, Wabbajack will download and install the latest version — this may take a few minutes. + + + +*Screenshot: Wabbajack downloading on first launch* + +3. Once Wabbajack opens, click the **settings/gear icon** in the bottom left + + + +*Screenshot: Wabbajack main screen — settings button location* + +4. Click **"Login"** to authenticate with Nexus Mods and complete the login process + + + +*Screenshot: Wabbajack settings — Nexus Mods login* + + + +*Screenshot: Nexus Mods OAuth login page* + +> [!WARNING] +> The Nexus login screen can appear black on Linux/SteamOS. If this happens: close Wabbajack, remove it from Steam, re-run the Install Wabbajack workflow in Jackify, and try again. If problems persist, ask for help on Discord. + +--- + +## Step 4: Select Your Modlist + +1. In Wabbajack, navigate to the **Modlist Gallery** +2. Find your modlist — some modlists require ticking **"Show Non-Featured Lists"** to appear in the gallery +3. Click on your modlist to view details, then click **"Download and Install"** + + + +*Screenshot: Wabbajack gallery — Tuxborn shown as example; tick "Show Non-Featured Lists" if your modlist doesn't appear* + + + +*Screenshot: Modlist details card with Download and Install button* + +--- + +## Step 5: Configure Installation Paths + +Wabbajack running via Proton sees your Linux filesystem through the Z: drive. Convert your paths accordingly - **DO NOT** Install to the C: drive here, that will install the modlist inside the Wabbajack Prefix, which will not turn out well: + +- `/home/deck/Games/Tuxborn` → `Z:\home\deck\Games\Tuxborn` +- `/run/media/deck/MySdCard/Games/Tuxborn` → `Z:\run\media\deck\MySdCard\Games\Tuxborn` + +**To find your SD card name** (Steam Deck users): +```bash +ls /run/media/deck/ +``` + +Set both directories in Wabbajack: +- **Installation Directory**: where the modlist and Mod Organizer 2 will be installed +- **Download Directory**: where mod archives will be stored (can be deleted after installation) + + + +*Screenshot: Wabbajack installation screen with Z: drive paths — Tuxborn shown as example* + +--- + +## Step 6: Start Installation + +1. Review your paths and ensure you are logged in to Nexus Mods +2. Click **"Install"** to begin + + + +*Screenshot: Wabbajack installation in progress* + +**Non-Premium users:** Wabbajack will pause at each mod requiring a manual download. Click the download button for each mod through the Nexus Mods interface and wait for it to complete before Wabbajack continues. This process can be very time-consuming for large modlists. + +**Installation is resumable** — if Wabbajack crashes or is interrupted, restart it and point it at the same directories. It will resume from where it left off. + +--- + +## Step 7: Post-Install Configuration with Jackify + +Once Wabbajack installation completes, run Jackify's post-install configuration. This handles Steam shortcut creation, Proton setup, and launch options automatically. + +1. Launch Jackify again and select **"Modlist Tasks"** +2. Click **"Configure New Modlist (Post-Download)"** + + + +*Screenshot: Modlist Tasks menu — Configure New Modlist option* + +3. In the configuration screen: + - **Name**: enter your modlist name (e.g. "Tuxborn") + - **ModOrganizer.exe Path**: browse to and select the `ModOrganizer.exe` in your installation directory + - **Resolution**: select your display resolution (1280x800 for Steam Deck) + + + +*Screenshot: Configure New Modlist screen — Tuxborn shown as example* + +4. Click **"Start Configuration"** + + + +*Screenshot: Configuration in progress* + +Jackify will automatically: +- Add the modlist to your Steam library +- Configure Proton settings +- Set up launch options +- Install any missing compatibility components +- Configure resolution settings + +**Steam Deck users:** After configuration completes, reboot your Steam Deck, then return to Desktop Mode to launch Mod Organizer 2 for the first time. + +--- + +## Step 8: Launch and Play + +1. Open Steam — your modlist will appear in your library + + + +*Screenshot: Modlist shortcut in Steam library — your modlist will appear here; Tuxborn shown as example* + +2. Click **Play** — Mod Organizer 2 will launch +3. In Mod Organizer 2, ensure your desired **profile** is selected in the left-hand dropdown at the top of the window +4. In the right-hand dropdown next to the **Run** button, ensure the correct executable for your modlist is selected (this is usually the modlist name or the game launcher) +5. Click **Run** to start the game + + + +*Screenshot: Mod Organizer 2 — profile dropdown (top left) and Run button (top right)* + +> [!WARNING] +> Shortly after clicking Run, an **Unlock** button will appear in Mod Organizer 2. Do not click it — doing so will break your modlist installation. + +### First Launch Expectations + +The first launch will behave differently from subsequent ones: + +- **Long load times**: Via Proton, initial load times are longer than on Windows. On Steam Deck this can be 7-8 minutes. This is normal and unfortunately not limited to just the first launch. +- **Shader compilation**: The game will compile shaders on first launch. This is a one-off process. +- **Possible crashes**: 1-2 crashes during the first few launches are normal while the shader cache builds. Relaunch and continue. +- **Unusual colours on the main menu**: Can occur during initial shader building and resolves once the game fully loads. +- **Creations download prompt**: Skyrim Modlists On Linux, the game may not recognise that Creation Club content is already installed and will prompt you to download it again. You do not need to re-download anything — dismiss the prompt with `Escape` or `Enter` on keyboard, or the back/dismiss button on a gamepad. +- **Character naming box**: If you cannot type in the character name field on first launch, restart the game once more and try again. + +--- + +## Troubleshooting + +**Wabbajack won't launch:** +- Ensure Proton Experimental is installed in Steam +- Try removing Wabbajack from Steam and re-running the Install Wabbajack workflow in Jackify + +**Nexus login fails / black screen:** +- Close Wabbajack, remove from Steam, re-run the Install Wabbajack workflow, try again +- If still failing, ask for help on Discord + +**Wabbajack crashes during installation:** +- This is always possible — Wabbajack is not officially supported on Linux +- Restart Wabbajack and it will resume from where it left off + +**Installation fails on specific mods:** +- Manually download the failing mod from Nexus Mods and place the archive in your download directory, then restart the installation + +**Installation fails with errors referencing `ccbgssse037-curios` (Skyrim modlists):** +Bethesda distributes Rare Curios in two versions — one via Steam (uppercase filenames) and one via the in-game Creations menu (lowercase filenames). Wabbajack modlists require the lowercase version. To fix: +1. Delete `ccBGSSSE037-Curios.bsa` and `ccBGSSSE037-Curios.esl` from your Skyrim `Data` folder +2. Launch Skyrim Special Edition from Steam +3. Go to **Creations** in the main menu +4. Search for and download **Rare Curios** +5. Wait until it shows as Installed, then close the game +6. Retry the installation in Wabbajack + +**Need help:** +- For modlist-specific issues, check the modlist's own Discord or support channels +- Report Jackify issues on [GitHub Issues](https://github.com/Omni-guides/Jackify/issues) +- For Wabbajack issues on Linux, ask in #unofficial-linux-help on the [Wabbajack Discord](https://discord.gg/wabbajack) + +--- + +*For fully automated installation with Nexus Premium, see [Installing a Modlist with Jackify](Installing-a-Modlist-with-Jackify).* diff --git a/Manual-Installation-Guides.md b/Manual-Installation-Guides.md new file mode 100644 index 0000000..571fa0e --- /dev/null +++ b/Manual-Installation-Guides.md @@ -0,0 +1,18 @@ + + +# Manual Installation Guides + +> [!NOTE] +> These guides are under development and will be available in a future update. + +Manual installation guides cover per-modlist setup for cases where automated installation is not available or additional game-specific steps are required. + +In the meantime: + +- For fully automated installation: [[Installing a Modlist with Jackify]] +- For installation without Nexus Premium: [[Installing a Modlist with Wabbajack]] +- For help: [#unofficial-linux-help](https://discord.gg/wabbajack) on the Wabbajack Discord + +--- + +*Back to [[User Guide]]* diff --git a/My-Wabbajack-VM-Setup.md b/My-Wabbajack-VM-Setup.md deleted file mode 100644 index c0d20b1..0000000 --- a/My-Wabbajack-VM-Setup.md +++ /dev/null @@ -1,204 +0,0 @@ -![Omni-guides Banner](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/WabbajackModlistsBanner2.png) - -## Introduction - -⚠️ ❗ This method is now no longer recommended. We are now able to run [Wabbajack via Proton](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki/Wabbajack-via-Proton) directly from Steam (on both Deck and PC). No more messing with Virtual Machines! I will leave this here for information purposes only. ⚠️ ❗ - -Quite a few people have asked, so here's a quick rundown of my method for running Wabbajack in a Windows Virtual Machine (VM). This is needed because Wabbajack does not work via Wine/Proton at all. Using the below steps, only Steam and Wabbajack (+dependencies) are installed inside the Windows VM, nothing else. Steam is configured to detect the Steam Library from the Linux Filesystem, and Wabbajack is able to download mods and install Wabbajack Modlists directly to the Linux Filesystem. Using this method, the games such as Skyrim, Fallout etc _do not need_ to be installed inside the VM as well as on Linux, and it also avoids the need for copying the modlist from Windows to Linux after the installation is complete. - -I was hesitant to create a guide for this because there are so many possibilities of how to achieve similar, but enough people have asked - so here it is. The method essentially boils down to installing a Windows 10 VM and sharing the Linux Filesystem to it via Samba. Yes, there are other, technically better options for filesharing between a VM and the host, but out of NFS, SSHFS, VirtIOFS, VirtualBox Folder Sharing and so on, Samba was the only one that didn't prove unstable with either Steam detecting the Games Library, Wabbajack detecting the game as being installed, or hangs and crashes while downloading and extracting the modlist via Wabbajack. - -I use KVM/virt-manager to run the VM. You could just as easily use VirtualBox or similar. I also chose to stick with Windows 10 as it has a marginally smaller footprint than Windows 11. Also worth mentioning that my Linux username is 'deck' in the screenshots below. This doesn't mean I do this on my Steam Deck, it just makes things easier to testing and writing the other guides for Wabbajack Modlists. - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) - ---- - -## Instructions - -### Step 1 - Create the VM - -Download the Windows 10 ISO from here: https://www.microsoft.com/en-gb/software-download/windows10ISO - -As mentioned, I use Virtual Machine Manager (virt-manager) to run the VM. It is available from the Discover store, if your Linux OS supports that. Otherwise it can likely be found in your distro's package manager. Alternatively you can use VirtualBox or whatever you like. - -![IMAGE DiscoverVirtManager](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-DiscoverVirtManager.png) - -Open up Virt-Manager and click the plus (+) button to create a new VM. - -![IMAGE VM-PlusNewVM](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-PlusNewVM.png) - -Accept the default "Local Media Install" and click Forward. - -![IMAGE NewVM-Step1](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-NewVM-Step1.png) - -Click Browse to select your Windows ISO, and then click "Browse Local". - -![IMAGE NewVM-Step2](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-NewVM-Step2.png) - -![IMAGE NewVM-Step2-BrowseLocal](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-NewVM-Step2-BrowseLocal.png) - -Navigate to where you downloaded the Windows ISO and select it. Ensure the Detected Windows version is Windows 10, otherwise, uncheck the box for Auto-detection and search for Windows 10, then click Forward. - -![IMAGE NewVM-Step2-Complete](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-NewVM-Step2-Complete.png) - -Set the RAM and vCPU allocation for the VM. This will depend on how many resources you can spare from your main Linux system. For example, I select 8192MB of RAM (8GB) and 8 vCPUs, then click Forward. - -![IMAGE NewVM-Step3](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-NewVM-Step3.png) - -According to Microsoft, Windows 10 needs at least 60GB of disk space to install. There are ways to reduce this further by utilising something like Tiny10, but for simplicity in this guide, I'm just going to go with 80GB so I change the Volume size to 80GB and click Forward. This will give us about 20GB free space after install, which should be more than enough while not being a bit too tight. If you're *really* struggling for disk space, doing this with Tiny10 can be squeezed into about 25GB in total, but that only leaves about 5GB to play with after Windows, and Tiny10 can come with it's own issues. - -![IMAGE NewVM-Step4](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-NewVM-Step4.png) - -Give the VM a name and then MAKE SURE YOU CHECK THE BOX TO "CUSTOMIZE CONFIGURATION BEFORE INSTALL", then click Finish. - -![IMAGE NewVM-Step5](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-NewVM-Step5.png) - -The reason we need to customise is due to the way that vCPUs are allocated by Virt Manager, and what Windows 10 allows. By default, vCPUs are presented to the VM as a physical CPU, instead of a CPU Core like you get with a modern CPU. Windows, for reasons best know to Microsoft, limit you to two Physical CPUs on Desktop Versions of Windows, so if we accept the default settings, our Windows VM will on see two CPUs, instead of the 8 allocated via Virt Manager. To change this, on the Customisation window, click the CPUs tab on the left, expand "topology" and tick the box for "Manually set CPU topology". I set to 1 CPU with 8 cores, but you could also choose 2 CPUs with 4 cores each, it doesn't make a lot of difference. Click Apply to set the changes, and then click the "Begin Installation" button in the top left of the window. - -![IMAGE NewVM-Step5-customize](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-NewVM-Step5-customize.png) - ---- - -### Step 2 - Install Windows, Steam and Wabbajack - -The rest of the Windows install is pretty normal so I won't cover it here. I select "I don't have a product key", and then Windows 10 Pro and then continue with the rest of the Windows install skipping the Windows account and accepting the "limited experience" as normal. - -![IMAGE NewVM-WindowsInstalling](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-NewVM-WindowsInstalling.png) - -I then set a username that matches my username on Linux, and don't set a password, just to make things easier, but you can do as you wish here. You can then configure Windows as you like, install a different browser etc etc. - -Download and install Steam from steampowered.com, and Wabbajack from wabbajack.org. Install Steam as normal, and sign into Steam with your Steam credentials. - -I created a new directory at C:\Wabbajack and copied the downloaded Wabbajack.exe file there, this will contain all of the .wabbajack files etc in future. Start Wabbajack and configure your Nexus credentials as normal and if desired, edit the threads available to Wabbajack for downloads and extraction. I just leave them as default. - -That's it for Windows just now, we'll come back to it shortly. - ---- - -### Step 3 - Install and configure Samba - -Back in Linux, we'll now install and configure Samba. As in the intro, Samba isn't the only option for setting up a fileshare between the two, but in my experience it's proven to be the most stable for this particular use case. How to install Samba will entirely depend on your Linux distro. For me on Nobara (Fedora), it was as simple as running _sudo dnf install samba_. By default (certainly on Nobara/Fedora), the samba config has a section for 'homes' listed in /etc/samba/smb.conf: - -``` -[homes] - comment = Home Directories - valid users = %S, %D%w%S - browseable = No - read only = No - inherit acls = Yes -``` - -There are of course plenty of configuration options for samba, so if you know what you're doing, feel free to edit as required for your environment. If you're just following what I do, then ensure your smb.conf contains the same section as above. Next, enable and start the samba server service with: - -``` -sudo systemctl enable --now smb.service -``` - -Lastly, we need to set a Samba Password for our user - this will be used when creating the Mapped Network Drive in Step 5. - -In a terminal run (replace user-name with the name of your user in Linux), and set a password, remember it. - -``` -sudo smbpasswd -a user-name -``` - -Restart the smb service and we should be good to go: - -``` -sudo systemctl restart smb -``` - ---- - -### Step 4 - Firewall example - -Another step that will vary depending on your Linux distribution and Firewall used, will be how to open the ports required for the samba server to be accessible to Windows. One good thing about this being a Linux Host and Windows VM is that we only need to open firewall ports between the two, using the Virtual Network between them, rather than opening the port on our Linux system to the rest of the LAN. - -For me on Nobara, I used the Firewall gui application to open the port. There are likely command line methods if you prefer, but you'll have to look them up. - -![IMAGE NewVM-FirewallConfig](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-FirewallConfig.png) - -Select 'Permanent' from the Configuration drop down at the top, and then 'libvirt' from the list of Zones in the middle left, followed by ticking the box next to 'samba' in the right hand pane. The changes should be applied as soon as you click the tickbox. - ---- - -### Step 5 - Map network Drive - -Back to Windows and it's time to map the Linux FS into the Windows VM using a Mapped Network Drive. Open a File Explorer, right-click "This PC" and click "Map Network Drive". - -![IMAGE NewVM-MapNetworkDrive1](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-MapNetworkDrive1.png) - -A new window will appear allowing you to set a Drive Letter and a path. I select the W: Drive letter (for Wabbajack), but you can select as you wish. Enter the Folder path as (replace "user" with your Linux username, the same one you used during the Step 3 smbpasswd stage): - -``` -\\192.168.122.1\user -``` - -![IMAGE NewVM-MapNetworkDrive2](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-MapNetworkDrive2.png) - -Certaily with KVM/libvirtd/Virt-manager, the IP address of the 'server' is usually 192.168.122.1, with the VM getting another IP address in the 192.168.122.X range. If you use a different application to create and run the VM, then this IP Address may differ, so please amend the above to reflect the IP Address of the Virtual Network Interface from your Linux system (usually called virbr0 or similar). - -Ensure "Reconnect at sign-in" and "Connect using different credentials" are both ticked, and then click "Finish". You will be prompted to enter a username and password, so enter as so, with the password being the one you set during Step 3. - -![IMAGE NewVM-MapNetworkDrive3](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-MapNetworkDrive3.png) - -Hit OK, and all being well, it should open a new Windows Explorer window showing the files from your Linux Home Directory. - ---- - -### Step 6 - Steam Library switcheroo - -The last step involves 'tricking' Steam into detecting your existing games as being installed, by adding a new Steam Library and performing a bit of a switcheroo. - -***IMPORTANT*** - As mentioned at the start of this guide - Once you perform this step, Steam will detect the games as if they were installed natively in Windows, and may attempt to update/install games. This is especially a pain for games in your library that have a native Linux version, as it will attempt to 'update' them to the Windows version instead. For this reason, I set Steam to not start on boot (we hopefully won't need it to after this step) and then set the download speed to 1kbps (so I can stop/pause any downloads that sneak through) and lastly set the 'Restrict updates to between' to be some time overnight. - -![IMAGE NewVM-SteamLibrary1](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-SteamLibrary1.png) - -To add a new Library, open Settings in Steam and then select the 'Storage' tab on the left. Click the Drop-down next to "Add Drive" and then select "Add Drive". - -![IMAGE NewVM-SteamLibrary2](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-SteamLibrary2.png) - -All being well, it will have automatically selected your new W: Drive, or whatever you called it. Click Add and that should complete the creation of the new Steam Library, visible on the Linux FS in /home/user/SteamLibrary, or on the W: Drive in Windows. - -![IMAGE NewVM-SteamLibrary3](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-SteamLibrary3.png) - -![IMAGE NewVM-SteamLibrary4](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-SteamLibrary4.png) - -The next step is where we connect things together. ***IMPORTANT*** Close down Steam in Windows fully - make sure that it is not still running in the system try down by the clock. - -Back on your Linux system, we're going to delete the **new** empty SteamLibrary directory Windows created (make sure you don't delete your *real* Steam Library if it's called something similar!). Replace "user" with your linux username, and alter the path if you set it to something different in Steam on Windows. - -``` -rm -rf /home/user/SteamLibrary -``` - -As the final piece of the puzzle, we then create a symlink from the REAL Steam Library on Linux, to the Steam Library that Steam in Windows is expecting (replace 'user' with your Linux username) - -``` -ln -s /home/user/.local/share/Steam /home/user/SteamLibrary -``` - -And that should really be it. Re-open Steam in Windows, and it should now detect all your games as being installed - **Pay particular attention to Steam Downloads in case it ignores the above download settings and tries to update/download something. If it does, quickly pause/stop the downloads.** - -You should be able to see, e.g. Skyrim installed in Steam in Windows now (providing it was installed in Linux). - -![IMAGE NewVM-SteamLibrary5](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-SteamLibrary5.png) - -If so, then you should be all done. Close and exit Steam fully again, as we no longer need it open, and ensure that it's set to not start on boot to avoid any annoying game "updates"; Steam Settings - Interface Tab, uncheck "Run Steam when my computer starts" - ---- - -### Conclusion - -With the above all done, you are now free to open Wabbajack and download/Install a modlist. Set the Install Directory to be a path of your choice on the W: Drive (for me this is e.g. W:\Games\Skyrim or W:\Games\Fallout), and set the Download Directory to also be a path on the W: Drive (e.g. W:\WabbajackDownloads\Skyrim or W:\WabbajackDownloads\Fallout). - -![IMAGE NewVM-WabbajackDirectories](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MyVM/MyVM-WabbajackDirectories.png) - -Personally, I tend to use the same download dir for all modlists of that game that I download, and then occasionally when the WabbajackDownloads directory gets too large, just delete the contents and start again with the next list I download. - -This is definitely draft 1 of this guide, so if you spot any issues, typos or something that just doesn't work, then let me know either as an issue on github, or pay me a visit in the #unofficial-linux-help channel of the official Wabbajack Discord - just @ me (@Omni). - -Enjoy! - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) diff --git a/User-Guide.md b/User-Guide.md index 7faf0b8..d8f218d 100644 --- a/User-Guide.md +++ b/User-Guide.md @@ -2,387 +2,85 @@
-[Wiki](https://github.com/Omni-guides/Jackify/wiki) | [Nexus](https://www.nexusmods.com/site/mods/1427) | [Download](https://www.nexusmods.com/site/mods/1427?tab=files) | [Wabbajack Discord](https://discord.gg/wabbajack) | [Jackify Issues](https://github.com/Omni-guides/Jackify/issues) | [Legacy Guides](https://github.com/Omni-guides/Jackify/tree/master/Legacy) | [Ko-fi](https://ko-fi.com/omni1) +[Wiki](https://github.com/Omni-guides/Jackify/wiki) | [Nexus](https://www.nexusmods.com/site/mods/1427) | [Download](https://www.nexusmods.com/site/mods/1427?tab=files) | [Wabbajack Discord](https://discord.gg/wabbajack) | [Jackify Issues](https://github.com/Omni-guides/Jackify/issues) | [Ko-fi](https://ko-fi.com/omni1)
- + --- # Jackify - User Guide -> **New to Jackify?** Read our [Introduction](Home) to understand what Jackify is and why it exists. +> **New to Jackify?** Read our [[Home|Introduction]] to understand what Jackify is and why it exists. -This guide provides step-by-step instructions for using Jackify to install, configure, and manage Wabbajack modlists on Linux and Steam Deck. +Jackify automates the installation, configuration, and Steam integration of Wabbajack modlists on Linux and Steam Deck. Use the guides below for your scenario. -**IMPORTANT:** MOST Modlists are not supported on Linux, so please do not go to the Modlist Author for support, unless they specifically do support running their modlist on Linux. +**IMPORTANT:** Most modlists are not officially supported on Linux. Do not contact the modlist author for support unless they explicitly support Linux. For Linux-specific help, use the #unofficial-linux-help channel on the [Wabbajack Discord](https://discord.gg/wabbajack). -## Installation and First Run +--- -### Step 1: Getting Jackify from Nexus Mods +## Installation Guides -Jackify is primarily distributed through Nexus Mods. Releases on Github are planned in the very near future, but for now the preference is to download Jackify from Nexus Mods. +| Guide | When to use | +|---|---| +| [[Installing a Modlist with Jackify]] | You have **Nexus Premium** — fully automated, recommended | +| [[Installing a Modlist with Wabbajack]] | You **don't have Nexus Premium** — uses Wabbajack under Proton | -1. **Visit the Jackify mod page on Nexus Mods** - You can download Jackify from [NexusMods](https://www.nexusmods.com/site/mods/1427). -2. **Download the latest version** - Click the "Download" button to get the latest Jackify 7z archive. While I'd prefer to just supply the AppImage file itself, Nexus Mods does not support this file type directly, so it has to be zipped up. +> [!NOTE] +> Native non-Premium support is coming to Jackify in a future release — automated downloads without Nexus Premium, no Wabbajack required. A [3-day free trial](https://www.nexusmods.com/users/myaccount?tab=subscriptions) is available if you want to use the fully automated route in the meantime. -Nexus Mods Download Page +## Configuration Guides -*Nexus Mods page showing Jackify mod with download button highlighted* +| Guide | When to use | +|---|---| +| [[Configure New Modlist]] | Modlist installed by another method, needs Steam integration | +| [[Configure Existing Modlist]] | Modlist already in Steam, needs reconfiguring | -### Step 2: Extracting and Running Jackify +## Additional Tools -Once you've downloaded the 7z archive, you'll need to extract the AppImage and make it executable. This is a standard process for AppImage applications on Linux: +| Guide | When to use | +|---|---| +| [[Installing Additional Tools]] | Installing GE-Proton, Protontricks | +--- + +## Launching Jackify +- See the Install guide for more detailed guidance. + +**GUI mode** (default — double-click the AppImage, or run): ```bash -# Extract the AppImage from the 7z archive -7z x Jackify.7z - -# Make the AppImage executable -chmod +x Jackify.AppImage - -# Run Jackify ./Jackify.AppImage ``` -You could chose to create a specific Jackify directory in your home directory, like so: -Terminal Installation Process + -*Screenshot: Terminal showing the 7z extraction command, chmod command, and successful AppImage execution* - -If you encounter permission issues or the AppImage fails to run, make sure FUSE is installed on your system. Most modern Linux distributions include FUSE by default, but some minimal installations might require manual installation. - -### Alternative: GitHub Release - -As mentioned, GitHub Release versions will be available soon. - -## Quick Start - -For users who want to get started immediately after installation: - -1. **Launch Jackify**: `./Jackify.AppImage` -2. **Install a Modlist**: - - Click "Modlist Tasks" → "Install a Modlist (Automated)" - - Select your game (e.g. Skyrim Special Edition) - - Choose a modlist - - Set directories and enter Nexus API key - - Click "Start Installation" -3. **Play**: Launch from Steam when installation completes - -That's it! Jackify handles everything else automatically. - -## Understanding the Interface - -When you first launch Jackify, you'll see the main menu with two primary options: - -Jackify Main Menu - -*The Jackify main menu presents two options: Modlist Tasks for all functionality, and Coming Soon for future features* - -- **Modlist Tasks**: Access all modlist installation and configuration features -- **Coming Soon...**: Shows information about upcoming features (currently displays a dialog explaining that all current functionality is available through Modlist Tasks) -- **Exit Jackify**: Quit the application - -All current modlist operations are accessed through "Modlist Tasks". - -Modlist Tasks Menu - -*The Modlist Tasks menu provides access to installation and management functions* - -The Modlist Tasks menu provides three main workflows: - -- **Install a Modlist (Automated)**: Download and install any modlist from scratch with full automation -- **Configure New Modlist (Post-Download)**: Set up Steam integration for manually installed modlists -- **Configure Existing Modlist (In Steam)**: Reconfigure existing Steam shortcuts - -## Installing a New Modlist - -Let's start with the most common scenario - installing a modlist from scratch. This workflow demonstrates Jackify's full automation capabilities. - -### Step 1: Accessing Installation Options - -From the Modlist Tasks menu, click the Install a Modlist button. - -### Step 2: Understanding the Installation Interface - -The installation interface contains all the configuration options needed to install and configure a modlist: - -Install a Modlist - Initial Screen - -*The initial installation screen shows all the configuration options you'll need to complete: game selection, modlist choice, directories, API key, and preferences* - -### Step 3: Selecting Your Game - -Start by choosing which game you want to install a modlist for. - -Game Selection Screen - -*Game selection showing the full range of supported titles* - -**Fully Supported Games** (complete automation including Steam integration): -- **Skyrim Special Edition**: Full automation with post-install configuration -- **Fallout 4**: Full automation with post-install configuration -- **Fallout New Vegas**: Full automation with post-install configuration *except* for TTW creation. -- **Enderal**: Full automation with post-install configuration -- **Oblivion**: Full automation with post-install configuration -- **Starfield**: Installation works, Steam configuration coming soon - -**Download & Install Only** (automation coming in future updates): -- **Cyberpunk 2077**: Basic modlist installation support. Manual configuration needed -- **Baldur's Gate 3**: Basic modlist installation support. Manual configuration needed - -### Step 4: Choosing Your Modlist - -Once you've selected your game, you can browse available modlists. This is where Jackify's integration with the Wabbajack ecosystem comes through - it pulls live data about modlist availability, sizes, and status. - -Modlist Browser Table - -*The modlist browser shows comprehensive information including download sizes, install sizes, total space requirements, and current status* - -The table provides crucial information for planning your installation: -- **Download Size**: How much you'll need to download from Nexus -- **Install Size**: How much disk space the final installation will use -- **Total Size**: Combined space needed during installation (usually download + install) -- **Status**: Whether the modlist is currently available and working - -#### Advanced Modlist Features - -Jackify provides a modlist search function, as well as NSFW filtering: - -**Search and Filtering** - -When you're looking for specific modlists or want to narrow down options, the search function lets you filter by name: - -Modlist Search - -*Search functionality helps you quickly find specific modlists in large catalogs* - -**Content and Status Filtering** - -Jackify respects user preferences around content and shows clear indicators for modlist status: - -NSFW and Status Filters - -*NSFW filtering and status indicators help you avoid unsuitable or unavailable content* - -By default, NSFW content is hidden to maintain family-friendly defaults, but you can enable it by checking the box at the bottom of the window. \[DOWN\] Status indicators clearly show when modlists are temporarily unavailable. - -**Custom .wabbajack Files** - -If you already have the .wabbajack file for your desired modlist downloaded, or it's just not available via the Wabbajack Modlist List, you can use your own .wabbajack file using the "Use .wabbajack file" tab at the top: - -Custom Wabbajack File Selection - -*The custom file option supports community modlists, beta versions, or personal modlist projects* - -This is particularly useful for: -- Beta versions of modlists not yet in the public catalog -- Community-created modlists not distributed through Wabbajack's ecosystem -- Personal modlist projects - -### Step 5: Configuring Directories - -Directory configuration is where you will select where you want the modlist installed, and where you want the mod archives to be downloaded to: - -Directory Selection - -*Directory configuration showing the distinction between installation location (where the modlist lives) and download location (temporary storage for mod files)* - -**Installation Directory**: This is where your final modlist will be installed. It contains ModOrganizer, the game files, and all configured mods. This directory should be on fast storage if possible since it's accessed during gameplay. - -**Download Directory**: This is temporary storage for downloaded mod files during installation. These files can be deleted after installation completes if you wish, so this can be on slower/cheaper storage if you have a multi-drive setup. - -**Tips for Directory Selection**: -- Place installation directories on SSDs for better performance -- Download directories can be on traditional HDDs to save SSD space -- Consider creating a dedicated `~/Games` or `~/Modlists` directory structure -- Keep the modlist Install and Download directories separate - -Jackify has built-in protection to ensure you don't accidentally overwrite the wrong directory if you select one as the install directory by mistake. - -### Step 6: Nexus Mods API Configuration - -This step connects Jackify to your Nexus Mods account for automated downloads. The API key is like a passcode that lets Jackify download mods on your behalf. While there are plans to replace this API Key requirement, this is the only option for now. The UI provides a link to where you will find your Nexus API Key, and has an optional Save function to keep the key stored locally on your system, encrypted. - -Nexus API Key Input - -*The API key input includes helpful instructions and links to generate your key* - -**Getting Your API Key**: -1. Browse to the Nexus Mods API Key page - https://www.nexusmods.com/users/myaccount?tab=api -2. If prompted, log in with your account -3. Scroll down to the very bottom to find your Personal API Key -4. Copy the key and paste it into Jackify -5. Optionally save your key by checking the box - -Nexus API Key Filled - -*Once entered, the API key is validated and stored securely for future use* - -Jackify validates your API key and optionally stores it securely for future modlist installations. You won't need to enter it again unless you generate a new key or switch Nexus accounts. - -**Security Note**: Your API key is stored locally and encrypted. Jackify never transmits your key to any servers other than Nexus Mods for legitimate mod downloads. - -### Step 7: Resolution Setting - -The final configuration step involves setting display preferences: - -Resolution Configuration - -*Resolution configuration ensures your modlist is optimized for your display setup* - -**Resolution Settings**: Choose the resolution that matches your monitor or your preferred gaming resolution. This can be changed later, but setting it correctly now saves configuration time. Jackify will remember the last resolution you set to make future modlist installs easier. - -### Step 8: Installation Process - -Once all configuration options are set, the actual installation begins. This is where Jackify's automation kicks in. - -Installation Progress - -*The installation progress screen provides real-time feedback on download and installation status* - -**What Happens During Installation**: -1. **Modlist File**: If needed, the modlist .wabbajack file is downloaded -2. **Download Phase**: Mods are downloaded from Nexus Mods using your API key -3. **Extraction**: Downloaded archives are extracted and organized -4. **Installation**: Files are moved to their final locations, textures are converted, BSAs are built and configured -5. **Steam Integration**: Steam shortcuts are created with proper Proton configuration -6. **Final Configuration**: Launch options, compatibility tools, and artwork are set up, where possible - -Time varies significantly based on your internet connection, disk speed, processing power. The process is designed to be resumable if interrupted - simply reuse the same Install and Download directory paths and the modlist installation will analyse the current status, and pick up where it left off. - -## Configuring Existing Modlists - -Not everyone starts from scratch - you might have modlists from previous installations, or you might want to reconfigure existing Steam shortcuts. Jackify handles these scenarios with dedicated workflows. - -### Configure a New Modlist: Bringing Manual Installations into Steam - -If you have a modlist that was installed with some other method (perhaps following old guides) and want to integrate it properly with Steam, the "Configure New Modlist (Post-Download)" option is what you need. - -Configure New Modlist - Initial - -*The initial configuration screen for existing modlists focuses on locating your installation and setting up Steam integration* - -This workflow assumes you have a working modlist installation but need Jackify to: -- Create proper Steam shortcut -- Configure Proton settings -- Set up launch options -- Install any missing compatibility components - -#### Finding Your ModOrganizer Installation - -The key step is pointing Jackify to your existing ModOrganizer.exe file. This tells Jackify where your modlist is installed and lets it analyze the configuration: - -Configure New Modlist - Browse to MO2 - -*Browse to locate your ModOrganizer.exe file - Jackify will analyze the installation and configure Steam integration automatically* - -**What Jackify Analyses**: -- Game type and version -- Required compatibility components -- Steam integration requirements - -#### Completing Configuration - -Configure New Modlist - Completed - -*The completed configuration shows Jackify's analysis of your existing installation and proposed Steam integration settings* - -With the Name, path and resolution set, click Start Configuration. Jackify will: - -- Create proper Steam shortcut -- Configure Proton settings -- Set up launch options -- Install any missing compatibility components - -Once complete, you should be good to click play in steam, and launch the modlist from MO2! - -### Configure an Existing Modlist: Reconfiguring Steam Shortcuts - -Sometimes you may want to reconfigure modlists that are already in Steam, perhaps from a previous install, or if something went wrong during the install process. - -Configure Existing Modlist - Interface - -*The reconfiguration interface lets you update settings while preserving existing Steam integration* - -Jackify detects existing modlists in your Steam library and presents them for reconfiguration. - -Configure Existing Modlist - Selection - -*Jackify can detect existing modlist shortcuts in Steam and reconfigure them* - -**Common Reconfiguration Scenarios**: -- Moving modlist installations to new locations -- Fixing corrupted Steam shortcuts - -## Command Line Interface - -While the GUI is designed for ease of use, Jackify also provides a full-featured command line interface. - -### Launching CLI Mode - -Launch Jackify with the `--cli` flag to access the text-based interface: +*Screenshot: Jackify main window* +**CLI mode** (text-based interface, same functionality): ```bash ./Jackify.AppImage --cli ``` -CLI Main Menu - -*The CLI main menu provides the same functionality as the GUI but in a text-based interface suitable for remote access or automation* - -### CLI Navigation and Features - -The CLI uses a menu-driven approach that mirrors the GUI functionality: - -CLI Installation Menu - -*CLI installation menus provide step-by-step text interfaces with the same configuration options as the GUI* - -**Main Menu Options**: -- **Modlist Tasks**: Same functionality as GUI version -- **Coming Soon...**: For now this only displays a message about future features and returns to main menu -- **Exit Jackify**: Quit the application - -**Navigation**: -- Use the numbered menu options to select an option -- Press Enter to select items -- Follow the on-screen prompts -- All GUI features are available through text menus - -## Settings Menu (Advanced) - -The GUI has a Settings menu that allows you to configure certain aspects of Jackify, such as: - -**Settings Menu Options**: -- **Resource Limits**: Similarly to Wabbajack, you can configure the threads available for various actions -- **Enabling Debug Mode**: Check this box to enable debug logging, mostly if asked to do so as part of a support issue -- **Set/Clear Nexus API Key**: Set or clear the stored API Key -- **Default Directory Paths**: Set the default directories that will be shown in the Install a Modlist workflow, this can make it simpler for future modlists if you have a standard directory structure. - -GUI Settings Menu - -*GUI Settings Menu that allows various configuration and default setting* - -## Troubleshooting: When Things Go Wrong - -Even with all of Jackify's automation, things can still go wrong. There are just too many distros, system set ups, modlists and potential differences to have tested them all. - -### Common Issues and Solutions - -Details and guidance for common issues and solutions will be entered into the FAQ Wiki Page (coming soon) - -### Getting Help and Support - -When you encounter issues that aren't covered by basic troubleshooting: - -**Check the Logs**: Jackify creates detailed logs in `~/Jackify/logs/`. These often contain specific error messages that point to solutions. - -**Community Support**: Join the #unofficial-linux-help channel in the [Wabbajack Discord](https://discord.gg/wabbajack). The Linux modding community is helpful and experienced with troubleshooting. - -**GitHub Issues**: For bugs or feature requests, the [GitHub Issues](https://github.com/Omni-guides/Jackify/issues) page is the best place to report problems and track fixes. - -**Wiki Documentation**: Check the [project wiki](https://github.com/Omni-guides/Jackify/wiki) for detailed guides, FAQ, and community-contributed solutions. +CLI Main Menu --- -*For more information about Jackify's history, philosophy, and technical details, see the [Introduction](Home).* \ No newline at end of file +## Settings + +The GUI Settings menu allows you to configure: + +- **Resource Limits**: Threads available for downloads and installation +- **Debug Mode**: Enable detailed logging for support purposes +- **Nexus API Key**: Set or clear the stored API key +- **Default Directories**: Pre-fill install and download paths for future installs + +GUI Settings Menu + +--- + +## Getting Help + +**Logs**: Jackify writes logs to `~/Jackify/logs/` — check these first when something goes wrong. + +**Community**: [#unofficial-linux-help](https://discord.gg/wabbajack) on the Wabbajack Discord. + +**Bugs and feature requests**: [GitHub Issues](https://github.com/Omni-guides/Jackify/issues). diff --git a/Using-the-omni‐guides.sh-Automation-Script.md b/Using-the-omni‐guides.sh-Automation-Script.md index 97cac16..c3e9da0 100644 --- a/Using-the-omni‐guides.sh-Automation-Script.md +++ b/Using-the-omni‐guides.sh-Automation-Script.md @@ -1,162 +1,8 @@ -![Omni-guides Banner](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/WabbajackModlistsBanner2.png) - -DISCLAIMER - I am not affiliated with the Wabbajack group in any way, just a gamer trying to help other gamers. You may be able to get assistance with this guide from the #unofficial-linux-help channel of the main [Official Wabbajack Discord](https://discord.gg/wabbajack), but it may be best to @ me on Discord (@omni). Due to this being an unofficial guide, assistance on this from Wabbajack support directly, or the Modlist developers, is highly unlikely. - -## Introduction - -The omni-guides post-install automation script is designed to work with _any_ modlist (for Skyrim/Fallout 4/Oblivion/New Vegas), not just those listed below. Some specific modlists may require an additional manual step or two. - -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. - -| Skyrim | Fallout 4 | -| ------------- | ------------- | -| Tuxborn | Welcome to Paradise | -| Anvil | Life in the Ruins | -| Licentia DECK | Fusion | -| Eldryn | Anomaly | -| Keizaal | Wasteland of Depravity* | -| Living Skyrim 4 (GE) | | -| Nordic Souls | | -| Legends of the Frost | | -| The Phoenix Flavour | | -| Lost Legacy (GE) | | -| Morning Star | | -| Fahluaan | | -| Winds of the North | | -| Elysium* | | -| Deckborn* | | -| Masterstroke* | | - -*Reported success by other users. - -Entries noted with **(GE)** require Proton GE (latest version is fine) to be used. This is due to the requirement of dotnet4 being installed in the prefix for .Net Script Framework to work correctly. - -**PLEASE NOTE:** The Anvil modlist was used as an example in the below steps, _you should use the name of the modlist you are trying to install instead_. - -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. - -⚠️ ❗ STEAM DECK USERS: DO NOT TRY TO USE THE TOUCH SCREEN TO INTERACT WITH MO2 IN DESKTOP MODE, IT WILL CRASH. INSTEAD HOLD DOWN THE 'STEAM' BUTTON AND USE THE TRACK PAD TO CONTROL THE MOUSE POINTER AND CLICK AS NEEDED ⚠️ ❗ - -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) - ---- - -## Steps Required *BEFORE* you run the script - -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. **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._ 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 - Add ModOrganizer.exe as a Non-Steam Game - -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": - - - -Click Browse: - - - -Browse to the path of your Modlist. e.g. /home/deck/Games/Skyrim/Anvil, select ModOrganizer.exe, and click Open. - - - -Ensure ModOrganizer.exe is present and ticked, and then click Add Selected Program. - - - -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. - - - -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 (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% -``` -Like so: - - - - -******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 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: - -``` -bash <(curl -s https://raw.githubusercontent.com/Omni-guides/Wabbajack-Modlist-Linux/main/binaries/omni-guides.sh) -``` - - - -A banner and a short note will be displayed, and a request to press any key to continue: - - - -The script will then attempt to detect all the Wabbajack Modlists you have installed and added to Steam. Press the corresponding number for the Modlist you with to configure: - - - -You will be asked to confirm you want to continue, and the script will move on to detecting the Modlist Install directory - if multiple possibilities are found, you'll be asked to select the right one. If nothing can be found automatically, you'll be asked to manually input the path to the Modlist directory. - -You will be prompted for your *sudo* password so that protontricks permissions can be set correctly, and the script will continue through more automated tasks: - - - -Lastly, you will be asked if you want to set the resolution. This is optional but I'm trying to reduce the manual steps as much as I can. If you're running this on a Steam Deck, it will assume the desired resolution is 1280x800 (If you are going to be playing while docked, you will have to manually alter the resolution via MO2 for skyrimprefs.ini/fallou4prefs and SSEDisplayTweaks). If you are not running this script on a Steam Deck, you will be asked to input your desired resolution, in the format 1920x1080. - - - - ---- - - -### 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 its executable paths etc pre-configured correctly - as much as I can, anyway. - -**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 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 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 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! - ---- - - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) - -![IMAGE GAMEMenu](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Anvil/) - - - - +# omni-guides.sh — Guide Superseded +The omni-guides.sh script has been superseded by Jackify, which handles the full installation and configuration process natively on Linux without any manual scripting. +**Please use the appropriate guide below:** +- **Nexus Mods Premium**: [[Installing a Modlist with Jackify]] — fully automated, no manual steps required +- **Without Nexus Premium**: [[Installing a Modlist with Wabbajack]] — Wabbajack under Proton, with Jackify handling all post-install configuration automatically diff --git a/WIP-Skyrim:-AVO-(Deck).md b/WIP-Skyrim:-AVO-(Deck).md deleted file mode 100644 index b53e14a..0000000 --- a/WIP-Skyrim:-AVO-(Deck).md +++ /dev/null @@ -1,330 +0,0 @@ -![AVO Banner](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/AVO/AVO-Banner.png) - -_Althro's Visual Overhaul ([AVO](https://github.com/Althro/AVO) ) is designed as a "true to vanilla list" to build your own list upon. It has been installed over 12 thousand times and garnered a reputation for being incredibly stable and is, as the quote says, "the best way to make your own list."_ - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) - -As it stands, I DO NOT RECOMMEND AVO 8 ON STEAM DECK, it's just too heavy and will average around 20fps. I'm still trying to see if there are any relatively easy tweaks that could be done to get this playable. This guide will focus on running AVO on a Linux system, rather than the Steam Deck. I will keep this guide online for anyone that wishes to try and tweak things into a performant situation on deck - maybe we can work together! - -## Instructions - -**The following has been tested on AVO v8** - -This guide only covers getting the Modlist running. It does not cover downloading the Modlist via Wabbajack, or how to copy the Modlist to your Steam Deck/Linux system. The official AVO entry from Wabbajack will not run on Linux - this is due to the version of MO2 used (2.5.0) which is not yet functional via Proton. Instead, Althro has provided me with an alternative .wabbajack file for a Linux-specific build using a compatible version of MO2. You can find this .wabbajack file < < HERE > >, and download the list using the "Install from File" option in Wabbajack. - -Once you have the list downloaded and installed on a Windows system, and then copied to your Linux/Steam Deck system, these steps will need to be carried out in Desktop mode, but once complete you will be able to launch the Modlist and play the game from Game Mode. For AVO, you will need to own the Anniversary Edition of Skyrim, and have launched the vanilla Skyrim game to download the Creation Club content. I also assume that you have set a user password on the Steam Deck. - -AVO only supports Skyrim AE, Anniversary Edition is **not optional**. - -The steps below may seem wordy and plentiful, but they can be carried out relatively quickly - I just wanted to give context and description to each step. - ---- - -### Step 1 - Create the directory - -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/AVO -``` - -OR - -Create Directory on **SD Card**: -``` -mkdir -p /run/media/mmcblk0p1/Games/Skyrim/AVO -``` - -(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/AVO/ - -Finally for this step, it's best to make sure that the newly copied files have sufficient permissions for your user. Run **only one** of the following for each action (owner and permissions), depending on where you want to store the Modlist: - -Change the owner and permissions of the directory on **Internal Storage**: -``` -sudo chown -R deck:deck /home/deck/Games/Skyrim/AVO -``` -``` -sudo chmod -R 755 /home/deck/Games/Skyrim/AVO -``` - -OR - -Change the owner and permissions of the directory on **SD Card**: -``` -sudo chown -R deck:deck /run/media/mmcblk0p1/Games/Skyrim/AVO -``` -``` -sudo chmod -R 755 /run/media/mmcblk0p1/Games/Skyrim/AVO -``` - ---- - -### 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". The latest version of Steam should use the regular File Browser from your system, older versions of Steam had a built-in file browser. - -![IMAGE AddNonSteamGame](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-AddNonSteamGame.png) - -Click Browse: - -![IMAGE BrowseNonSteamGame](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-BrowseNonSteamGame.png) - -Browse to the path of your modlist. e.g. /home/deck/Games/Skyrim/AVO, select ModOrganizer.exe, and click Open. - -![IMAGE AddMO2NonSteamGame](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/AVO/AVO-AddMO2NonSteamGame.png) - -Ensure ModOrganizer.exe is present and ticked, and then click Add Selected Program. - -![IMAGE AddMO2NonSteamGame](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-AddMO2NonSteamGame.png) - -Once added, edit the properties of the new ModOrganizer.exe entry. You can give it a more sensible name - I used "Skyrim - AVO": - -![IMAGE PropertiesNonSteamGame](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/AVO/AVO-PropertiesNonSteamGame.png) - -Then in the Compatibility tab tick the box for 'Force the use of a specific Steam Play compatibility tool', then select the Proton version - I use Proton 8.0-4 which was the latest stable Proton version provided by Valve at time of writing.. - -![IMAGE ProtonNonSteamGame](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-ProtonNonSteamGame.png) - -**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: - -``` -STEAM_COMPAT_MOUNTS=/run/media/mmcblk0p1 %command% -``` -Like so: - - -![IMAGE STEAM_COMPAT_MOUNTS](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-STEAM_COMPAT_MOUNTS.png) - ---- - -### Step 3 - Install Protontricks - -If you don't already have it installed, ProtonTricks can be installed via the Discover store as a flatpak: - -![IMAGE ProtontricksSearch](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-ProtontricksDiscover.png) - -![IMAGE ProtontricksInstall](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-ProtontricksDiscoverInstall.png) - -To enable the use of protontricks via the command line, open a Konsole terminal and run the following command to add an alias: - -``` -echo "alias protontricks='flatpak run com.github.Matoking.protontricks'" >> ~/.bashrc -``` - -then close and reopen Konsole. We can now invoke protontricks from the command line. Next, we need to allow protontricks access to the filesystem location (adjust as needed if you used a different path): - -``` -sudo flatpak override com.github.Matoking.protontricks --filesystem=/home/deck/Games -``` - -That should be protontricks installed and ready to use later in the guide. - - ---- - -### Step 4 - Start and Configure ModOrganizer2 - -Click play on this new entry "Skyrim - AVO" (or whatever you renamed it to) in Steam - Depending on the path on Windows that you copied the Modlist files from, you may see an error pop-up about your account lacking permission: - -![IMAGE MO2DownloadsError](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-MO2DownloadsError.png) - -To fix this, we just need to strip the now incorrect download directory from the ModOrganizer.ini file. in Konsole terminal, run: - -``` -sed -i "/download_directory/c\download_directory =" /home/deck/Games/Skyrim/AVO/ModOrganizer.ini -``` - -then re-run "Skyrim - AVO" from Steam. - -Another error box will appear, complaining that it "Cannot open instance 'Portable'. This is because we copied the Modlist directory (inclusive of the built-in MO2) from Windows, so the path has changed: - -![IMAGE MO2PortableError](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-MO2PortableError.png) - -To fix this, we need to point MO2 to our new location. Click OK, and then Browse. The path we are looking for is: - -``` -Z:\home\deck\Games\Skyrim\AVO\Game Root -``` - -If you installed vanilla Skyrim to an SD Card or a different Library location, then you will have to browse to that location, or the equivalent SD Card path in /run/media/mmcblk0p1, which will be mounted inside Proton as the E: Drive. - -![IMAGE BrowseLocalBlur](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/AVO/AVO-BrowseLocalBlur.png) - -The splash screen for AVO should hopefully now appear: - -![IMAGE MO2Splash](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/AVO/AVO-MO2Splash.png) - -You may also get a pop-up asking if you want to Register for handling nxm links, like so: - -![IMAGE HandleNXMLinks](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-MO2RegisterNXMLinks.png) - -I usually just hit "Yes" and move on with my life. - -Getting close now. Next, we have to ensure that ModOrganizer2 is pointing to the correct location for the required executable. In MO2, click the little two-cog icon at the top, which will bring up the Modify Executables window (please note that this icon may differ for some Modlists that use custom icon sets): - - -![IMAGE MO2ExecutableCog](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/AVO/AVO-MO2ExecutablesCog.png) - -For the AVO executable, we need to point MO2 at a file that may not actually exist yet (but it will exist, once GameRoot does it's thing when you click launch - and is then removed again when the game closes). - -The path you need for the AVO application will be: - -``` -Z:\home\deck\Games\AVO\mods\Skyrim Script Extender\Root\skse64_loader.exe -``` - -![IMAGE MO2Executables](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/AVO/AVO-MO2Executables.png) - -If you installed vanilla Skyrim to an SD Card, then you will have to replace with the above with the equivalent path in /run/media/mmcblk0p1. - ---- - -### Step 5 - Install Required Wine Additions - -There is an issue with missing NPC Voices - apparently this is an issue with Proton, so it may ultimately be resolved in time with a newer version of Proton without needing these steps. For now though, we need to install xact and xact_x64 to the Wine/Proton environment Steam created for our "Skyrim - AVO" entry, and a few others for the use of Community Shaders. AVO also requires Microsoft Visual C++ Redistributable 2022 for some of it's mods. - -The easiest way to install what we need is to use ProtonTricks, which should be installed already from Step 3 earlier in this guide. - -Adding the required packages can be done via the ProtonTricks gui, but perhaps the easiest way is via command line. You can run the following one-liner to do it for you, or if you prefer, you can manually run the individual steps noted below (replace "Skyrim - AVO" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep -i "Skyrim - AVO" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:'` ; protontricks --no-bwrap $APPID xact xact_x64 -``` - -Alternatively, **If you prefer to run this manually**, see an alternative step-by-step method in the **Additional Notes** section below. - ---- - -### Step 6 - Install VCREDIST2022 - -Next up is the requirement of vcredist2022. Unfortunately this isn't available directly through protontricks as per xact, so we will have to install it semi-manually. The following one-liner should do everything you need (replace "AVO" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep -i "Skyrim - AVO" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:' | tail -1` ; wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O '/home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe' ; protontricks --no-bwrap -c 'wine /home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe /Q' $APPID -``` - ---- - -### Step 7 - Set Resolution - -Next, we should set the resolution so that the deck isn't doing more work than it needs to. There's no point in asking Skyrim to render at 1440p, and then have the game squeezed into an 800p screen on the deck. To do this in MO2, filter for the entry for "SSE Display Tweaks", and double-click it: - -![IMAGE IniEditor](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/AVO/AVO-SSEDisplayTweaks.png) - -Switch to the INI Tab, highlight the INI File on the left, and then scroll down until you see the line that reads "#Resolution=1920x1080". Remove the # at the start of the line, and then set the resolution to be 1280x800: - -![IMAGE SetResolution](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/AVO/AVO-SetResolution.png) - -Finally, click the Close button and select "Yes" to save the changes. - ---- - -### Step 8 - Optional but Recommended - -Increase Steam Deck Swap Space, Swappiness and adjust Steam Deck VRAM - -This may be optional, but there have been reports of far better stability and performance after increasing the swap space available to the deck when running Modlists. This is an optional step, but if you are experiencing stability issues, it might be worth investigating. How to do so is outside the scope of this guide, but there is plenty of information available elsewhere on how to do it - [CryoByte33](https://github.com/CryoByte33/steam-deck-utilities) has an excellent set of utilities available on github that can take care of this, and more! - -Personally I have increased the VRAM in the deck bios to 4GB (see [here](https://www.youtube.com/watch?v=od9_a1QQQns&t=1377s) for details), 16GB Swap space, and a Swappiness of 1 - the recommended settings when you run Cryobyte33's Steam Deck Utilities. In fact, the [full video](https://www.youtube.com/watch?v=od9_a1QQQns) of Cryobyte33 explaining what this all means, is definitely worth a watch! - -### Conclusion - -At last! - -If you've read this far, then well done! I'd very much appreciate a Star for this guide, just to show if I'm on the right track. I'm also open to any feedback, positive or negative. - -With NPC Voices fixed, and vcredist2022 installed, we should now be ready! Click the Play button in Mod Organizer, and wait.... This takes quite a bit of time to start. Once it had loaded though, performance was as expected in the menus. - -On Steam Deck, I limit FPS and Refresh rate to 40, and it does a pretty good job of maintaining that. If you want absolutely no fluctuations at all, you'd likely have to lock to 30fps, but I find sticking it at 40Hz/FPS, and then turning off the FPS counter lets me just get on with the game, feeling fluid enough that I don't think about the FPS any more. - -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 ;) - -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! - -Enjoy! - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) - -![IMAGE AVOMenu](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/AVO/AVO-Menu.png) - - - - ---- - - - - -## Additional Notes - - -### Install VCREDIST2022 manually - -If you prefer to install vcredist manually instead of using my one-liner, you can follow these steps. Unfortunately this isn't available directly through protontricks as per xact, so we will have to install it semi-manually. The following one-liner should do everything you need (replace "Skyrim - AVO" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep -i "Skyrim - AVO" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:' | tail -1` ; wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O '/home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe' ; protontricks --no-bwrap -c 'wine /home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe' $APPID -``` - -![IMAGE AdditionalVCRedistStart](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-VCRedistInstallStart.png) - -Check the box to agree, and then click install. It should complete quickly. - -![IMAGE AdditionalComplate](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-VCRedistInstallComplete.png) - -Alternatively, **If you prefer to run this manually, step-by-step**, you can do the following. Firstly, we need to download the vc_redist.x64.exe installer inside the Proton prefix. Run the following command, replacing my Game ID (3595949753) with your own which you can get by running protontricks -l in Konsole: - -``` -wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O /home/deck/.local/share/Steam/steamapps/compatdata/3595949753/pfx/drive_c/vc_redist.x64.exe -``` - -Then we can enter the shell of our Proton environment: - -``` -protontricks --no-bwrap 3595949753 shell -``` - -If successful, it should display a little C: prompt in your terminal window. Your terminal may misbehave after running the wine command - you can regain control by typing 'reset', even if you can't see the characters as you type. - -Finally, run the installer: - -``` -wine vc_redist.x64.exe -``` - -![IMAGE AdditionalVCRedistStart](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-WineShell.png) - -![IMAGE AdditionalVCRedistStart](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-VCRedistInstallStart.png) - -Check the box to agree, and then click install. It should complete quickly. - -![IMAGE AdditionalComplate](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-VCRedistInstallComplete.png) - -When running wine commands in Konsole, it usually mangles the terminal a bit - text you type wont be shown (though it technically is still being printed in the terminal) - to get out of that state, either close and reopen Konsole, or just type 'reset' and hit enter, even if you can't see the characters. - -### Install wine requirements manually (xact, xact_x64) - -first find the AppID of the Non-Steam Game we added for mo-redirect.exe. In a terminal run: - -``` -protontricks -l | grep -i "Skyrim - AVO" -``` - -Replace "Skyrim - AVO" if you have renamed the Non-Steam Game added earlier. The output should look something like below, though your AppID will differ from mine: - -``` -Non-Steam shortcut: Skyrim - AVO (3595949753) -``` - -With the AppID now known, install the required xact and xact_x64 packages into this Proton environment (use your own AppID from the command above): - -``` -protontricks --no-bwrap 3595949753 xact xact_x64 -``` - -This may take a little time to complete, but just let it run the course. Your terminal may misbehave after running the protontricks/wine command - you can regain control by typing 'reset', even if you can't see the characters as you type. diff --git a/Wabbajack-on-Linux-via-Wine.md b/Wabbajack-on-Linux-via-Wine.md deleted file mode 100644 index 7207ead..0000000 --- a/Wabbajack-on-Linux-via-Wine.md +++ /dev/null @@ -1,405 +0,0 @@ - - -## 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 - 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.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/debian 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 created a bash script that should do everything for you, though it is still in alpha and needs more feedback from users of 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 directly, 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. - -We have so far confirmed success on various distros, such as: - -**Arch based:** Arch, CachyOS, -**Fedora based:** Fedora, Nobara, Ultramarine, Bazzite -**Others:** OpenSUSE Tumbelweed. - -The same steps will likely work on other distros too! Please let me know if you have success on a distro that isn't listed here, so I can add it to the list. Due to shipping with an old versions of wine, Ubuntu and derivatives such as Pop_OS, Mint, etc, need some additional steps, outlined below in the [Additional Notes](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki/Wabbajack-on-Linux-via-Wine/_edit#additional-notes) section, until they update the version of wine provided. - -For each step, I've tried to include both command line and GUI methods (you only need to do one or the other), though not all steps have both. - -**PLEASE NOTE: Use this guide at your own risk. Damage to your system caused by following the steps of this guide either correctly or incorrectly are done so with this understanding. You could always initially carry out the steps in a VM until you are familiar with the steps, to test for your distro without altering your base system.** - ---- - -### Step 1 - Wine/System Requirements - -Wine 9.15 or newer and winetricks, installed via your package manager. See 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: - - -``` -wine --version -``` - -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. - ---- - -### Step 2 - Create a Wabbajack Directory - -While not required, I strongly recommend you create a directory to use for Wabbajack, just to keep things in a sensible place and together. You can use a file browser or cli to create this new directory - for this guide I will use /home/omni/Wabbajack, but the commands shown will use the $HOME variable, which should apply the command to your user home directory on your system. - -``` -mkdir -p $HOME/Wabbajack -``` - ---- - -### Step 3 - Download the required installers - -There are two applications we need to get things running - [Wabbajack](https://www.wabbajack.org/) itself, and the [Edge Webview2 Installer (Evergreen Standalone Installer)](https://developer.microsoft.com/en-gb/microsoft-edge/webview2/?form=MA13LH#download) that we will need to manually install into the wine prefix in the next steps. While it doesn't need to exist in our new Wabbajack directory, I tend to store the WebView installer there anyway, to keep things contained and easy to find. - -Either download the above two applications via your browser, and copy them into the new `/home//Wabbajack` directory, or run the following two commands in a terminal. - -Download Wabbajack Application: - -``` -wget -O $HOME/Wabbajack/Wabbajack.exe https://github.com/wabbajack-tools/wabbajack/releases/latest/download/Wabbajack.exe -``` - -Download Microsoft Edge WebView2 Installer - -``` -wget -O $HOME/Wabbajack/MicrosoftEdgeWebView2RuntimeInstallerX64.exe https://msedge.sf.dl.delivery.mp.microsoft.com/filestreamingservice/files/6d376ab4-4a07-4679-8918-e0dc3c0735c8/MicrosoftEdgeWebView2RuntimeInstallerX64.exe -``` - ---- - -### Step 4 - A Clean Beginning (Creating a new Wine Prefix) - -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//.wine` - -To do this from command line, in a terminal, run the following command (adjusting as necessary for the prefix location on your system): - -``` -rm -rf $HOME/.wine -``` -Alternatively, use the following steps to carry out via the winetricks GUI: - -Start winetricks either from Apps menu: - - - -or by running `winetricks` in a terminal: - - - -Once winetricks has opened, ensure "Select the default wineprefix" is selected, or select it, and then click OK. - - - -On the next window, highlight "Delete ALL DATA AND APPLICATIONS INSIDE THIS WINEPREFIX" - you may have to scroll the window down a little: - - - -A warning will pop up needing you to confirm the deletion of the prefix and contents: - - - -Click continue, and winetricks will close, deleting the prefix in the background. The prefix has now been removed. - ---- - -### Step 5 - Create a new prefix - -To create a new prefix from command line, issue the following command in a terminal: - -``` -wineboot -``` - -Alternatively, to do so using the winetricks GUI, re-run winetricks, either from the Applications menu, or terminal, as above. This time it will notify you that the Wine environment in `/home//.wine` is being updated. This is a good sign, as it means the prefix cleaning succeeded. - - - -It will also likely prompt you to install Wine-Mono, which you can confirm. - - - -### Step 6 - Change the default renderer used - -To avoid some of the graphical bugs that can be seen with Wabbajack when running via Wine, we can change the renderer used to display the application. - -To do so via command line, run the following in a terminal: - -``` -winetricks renderer=vulkan -``` - -Alternatively via the GUI, start winetricks as above, and then again, with "Select the default wineprefix" highlighted, click OK. - - - -This time, however, highlight "Change settings" and click OK - - - -Scroll down the list of settings shown, until you see "renderer=vulkan", highlight it, and click OK. - - - -This should return you to the previous options menu, don't close winetricks just yet. - ---- - -### Step 7 - Install Edge WebView2 - -Next we need to manually install WebView - this is needed to make certain aspects of Wabbajack function, and is integral to the function of the Nexus Login needed for Wabbajack to actually download mods. - -To install this via command line, enter the following in a terminal (adjust as needed if you stored the installer in a different location): - -``` -wine $HOME/Wabbajack/MicrosoftEdgeWebView2RuntimeInstallerX64.exe -``` - -To do so via the GUI, start winetricks as above if it's not still open, select the Default Prefix option if needed, and then highlight "Run an arbitrary executable (.exe/.msi/.msu)" and click OK. This should bring up a file browser of your system, and will allow us to locate and run any .exe we want - in this case, the Edge Webview installer that we downloaded in Step 3. - - - -Using the file browser, locate the installer for Webview - this should be in `/home//Wabbajack` if you are following my steps exactly. Once located, highlight the installer .exe file, and click Open: - - - -After a few second, the WebView2 installer window will appear, and run through the install process, and then it will close without any message. Keep winetricks open for the next step. - - - ---- - -### Step 8 - Change Windows version for the prefix - -While it would be great to just set wine to mimic windows 10 or 11 and be done with it, leaving things like that will cause various issues with the Wabbajack interface, including the inability to complete the Nexus login step via the GUI. To avoid this, we need to set the overall Wine environment to be win7, yet keep the Wabbajack.exe application as win10. - -The command to do this in a terminal is: - -``` -winecfg -v win7 -``` - -Alternatively via the winetricks GUI, highlight "Run winecfg" and click OK. This will open up a new small window labelled "Wine configuration". - - - -Staying on the Applications tab which should be selected by default, change the "Windows Version" at the bottom to be "Windows 7" instead of the default of Windows 10 or 11. - - - -Do not close this window yet. - ---- - -### Step 9 - Add Wabbajack as an application - -Even though we have set the overall wine environment to be win7, Wabbajack itself needs to remain as win10 for things to work. We therefor need to add Wabbajack.exe as an application, which will allow us to specify a non-default setting. - -To do so via command line, we need to create a registry file. Run the following in a terminal (copy and paste the whole thing as one big command, then hit return): - -``` -cat < $HOME/Wabbajack/WJApplication.reg -Windows Registry Editor Version 5.00 - -[HKEY_CURRENT_USER\Software\Wine\AppDefaults\Wabbajack.exe] -"Version"="win10" -EOF -``` - -Lastly for this step, apply the registry setting: - -``` -wine regedit $HOME/Wabbajack/WJApplication.reg -``` - -Alternatively, to do this from the winetricks GUI, ensure you are still on the Applications tab from Step 8, click the "Add application" button near the bottom: - - - -This will open up a Windows-style file browser. Navigate to your Wabbajack.exe file, which will be in `Z:\home\\Wabbajack\Wabbajack.exe` if you have been following these steps exactly. - - - -Highlight Wabbajack.exe, and click Open, and you should now see Wabbajack.exe listed in the list of applications. Select Wabbajack.exe in the list, and change the "Windows Version" from "Use global settings" to "Windows 10", and then click apply: - - - -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. 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): - -``` -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/." -``` - -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. - ---- - -### Step 11 - Run Wabbajack, Nexus Login - -That should be it as far as configuration is concerned. We can now run Wabbajack. You can do this by double-clicking the Wabbajack.exe file in your file browser: - - - -or by running your equivalent of: - -``` -cd $HOME/Wabbajack ; wine $HOME/Wabbajack/Wabbajack.exe -``` - -And all being well, this will start Wabbajack, and it will run through the usual install: - - - -Log into Nexus using the GUI options, just like you would on Windows. - - - -At this stage, you should be good to just Wabbajack in the normal way. Either install a modlist from file, or browse the gallery to select one. There is currently a bug with some of the images not loading correctly, but that should be fixed in an upcoming update to Wabbajack. - -When selecting the modlist Install and Downloads directory, keep in mind that this is from a Windows point of view, and that most likely the Linux Filesystem locations will show up as the Z: drive. I'd recommend creating a location to store the Wabbajack modlist and downloads specifically - For example, I use `/home/omni/Games/Skyrim/` as the Install directory, and `/home/omni/Games/WabbajackDownloads/Skyrim` as the Downloads directory. - -If you install a list using the C: drive show in the file browser, the list will be installed inside your wine prefix location (e.g. `/home//.wine`) and could get messy should you need to remove the prefix or redo this guide in future. - ---- - -### Step 12 (Optional) Create a Desktop launcher for Wabbajack - -Once you're happy that Wabbajack is function correctly, you may want to create a Desktop launcher shortcut for our new Wabbajack-via-wine application. - -Firstly, grab a copy of the Wabbajack icon to use: - -``` -wget -O $HOME/Wabbajack/Wabbajack.ico https://raw.githubusercontent.com/wabbajack-tools/wabbajack/main/Wabbajack.Launcher/Assets/wabbajack.ico -``` -Next, create a new file in $HOME/Desktop called Wabbajack.desktop with the following contents (edit to suit your environment): - -``` -[Desktop Entry] -Name=Wabbajack -Exec=env HOME="$HOME" WINEPREFIX="$HOME/.wine" wine $HOME/Wabbajack/Wabbajack.exe -Type=Application -StartupNotify=true -Path=~/Wabbajack -Icon=/home/omni/Wabbajack/Wabbajack.ico -``` - -Unfortunately the standards for the .desktop file format require an absolute path for the Icon= entry, so it can't be shortened to $HOME or ~/ for ease, so you will need to specify the path in full for the desktop shortcut to have the Wabbajack icon. - -You should now be able to start Wabbajack simply by double-clicking the icon on your desktop. - -### Post Wabbajack Steps - -The above will get Wabbajack installed and running on your Linux system. It *does not* however, take care of any installation requirements to get the modlist itself running on Linux. You can see my [other guides within this github](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki) for specific lists, or [general steps](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki/General-Linux-Guide-(Anvil)) to take, or you can use my [Automated Installation Script](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki/Using-the-omni%E2%80%90guides.sh-Automation-Script) to take care of things for you. - ---- - -### 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.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. - -1. Install the key and gpg needed for the winehq ubuntu repository: -``` -curl -s https://dl.winehq.org/wine-builds/winehq.key | sudo gpg --dearmor | sudo tee /usr/share/keyrings/winehq.gpg > /dev/null -``` - -2. Add the winehq Ubuntu repository to your system: - -``` -echo deb [signed-by=/usr/share/keyrings/winehq.gpg] http://dl.winehq.org/wine-builds/ubuntu/ noble main | sudo tee /etc/apt/sources.list.d/winehq.list -``` - -3. Update apt to read and include the new repository: - -``` -sudo apt update -``` - -4. Finally, install a newer version of wine from the new repository: - -``` -sudo apt install winehq-staging -``` - -This should result in a newer version of wine on your ubuntu-based system (and derivatives like Mint, Pop_OS) and allow you to get the above guide running. - ---- - diff --git a/Wabbajack-on-Steam-Deck-Linux-via-Bottles.md b/Wabbajack-on-Steam-Deck-Linux-via-Bottles.md deleted file mode 100644 index acc9f8f..0000000 --- a/Wabbajack-on-Steam-Deck-Linux-via-Bottles.md +++ /dev/null @@ -1,3 +0,0 @@ -*** -⚠️ ❗ This method ultimately proved to have issues with modlists with more complicated Wabbajack install processes, resulting in odd issues and corrupt textures and meshes in rare cases. For that reason, it is now recommended to use the far more reliable method, running [Wabbajack via Proton](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki/Wabbajack-via-Proton) directly from Steam (on both Deck and PC). No more messing with Bottles! ⚠️ ❗ -*** diff --git a/Wabbajack-via-Proton.md b/Wabbajack-via-Proton.md index 7e100bb..9c43807 100644 --- a/Wabbajack-via-Proton.md +++ b/Wabbajack-via-Proton.md @@ -1,131 +1,8 @@ - +# Wabbajack via Proton — Guide Superseded -## Introduction +This guide has been replaced by up-to-date installation guides that no longer require manual script usage. -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! - -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 also produced a youtube video that covers this, as well as examples of how to get many modlist types running. You can view it [here](https://www.youtube.com/watch?v=tUitJZWEAJY) ! - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) - -## Wabbajack on Linux, via Steam/Proton - -Thanks to advancements with Wine(Proton), 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. While you can run Wabbajack via base Wine on Linux desktops, and via Bottles on Steam Deck (though with some issues), I hope that this method utilising Proton/Steam will mean things are the same across all platforms and distros, and that this will become the preferred method. It is not yet perfect, see the Known Issues and Troubleshooting sections at the end of this guide for more information. - -There may be other 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. - -For each step, I've tried to include both command line and GUI methods (you only need to do one or the other), though not all steps have both. - -**Required - protontricks 1.11.0 or newer (users of Ubuntu and Ubuntu-based distributions take note, as the non-flatpak version of Protontricks available by default to ubuntu distros is far too old)** - -**PLEASE NOTE: Use this guide at your own risk. Damage to your system caused by following the steps of this guide either correctly or incorrectly are done so with this understanding. You could always initially carry out the steps in a VM until you are familiar with the steps, to test for your distro without altering your base system.** - - ---- - - -### Step 1 - Create a Wabbajack Directory and Download Wabbajack - -There are only a couple of steps that I can't automate for this - Downloading the Wabbajack installer, adding it to Steam, and running the initial launch. - -While not specifically required, I strongly recommend you create a directory to use for Wabbajack, just to keep things in a sensible place and together. You can use a file browser or cli to create this new directory - for this guide I will use /home/deck/Wabbajack, but the commands shown will use the $HOME variable, which should apply the command to your user home directory on your system. - -``` -mkdir -p $HOME/Wabbajack -``` - -Next, download the Wabbajack Application into the Wabbajack directory we created: - -``` -wget -O $HOME/Wabbajack/Wabbajack.exe https://github.com/wabbajack-tools/wabbajack/releases/latest/download/Wabbajack.exe -``` - -Alternatively, just download it from [wabbajack.org](https://www.wabbajack.org/) via your browser and then copy or move it into the new Wabbajack directory. Either way, once you have a $HOME/Wabbajack/Wabbajack.exe in place, we're good to proceed. - - ---- - - -### Step 2 - Add Wabbajack.exe to Steam - -Add Wabbajack.exe to Steam by using the "Add a Non-Steam Game to My Library" function from Steam: - - - -Once added, right click the new entry and go to Properties. Change the name to simply "Wabbajack", followed by clicking the Compatibility tab, and set it to use "Proton - Experimental": - - - - - -With that set, close the properties window and click Play for the Wabbajack entry in Steam. This will start Wabbajack for the first time, which is when the application downloads and installs the latest version of Wabbajack for you. It'll take a little time to download and install, just let it complete. - - - -Once done, the Wabbajack application itself should open up - **Close it down** before trying to use the application, and move on to Step 3. - - ---- - -### Step 3 - Run the WabbajackProton script - -I've written a bash script [(source)](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/blob/main/binaries/WabbajackProton.sh) that will configure the Proton Prefix as required to run Wabbajack via Proton. Run the following in a terminal/konsole and follow the few steps when prompted: - -``` -bash <(curl -s https://raw.githubusercontent.com/Omni-guides/Wabbajack-Modlist-Linux/refs/heads/main/binaries/WabbajackProton.sh) -``` - -e.g: - - - ---- - -### Step 4 - Run Wabbajack - -All being well, that should really be all that is needed. Start Wabbajack from Steam again, and log in to nexus using the little cog in the top right. Once ready, browse the gallery or add a .wabbajack file manually, as you would do even on Windows. Fill in the Install and Downloads directories using their Z:\ paths. For example: - - - ---- - -### Additional Steps Needed - -The above will get _Wabbajack_ installed and running on your Linux system. It *does not* however, take care of any installation requirements to get the modlist itself running on Linux. You can see my [other guides within this github](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki) for specific lists, or [general steps](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki/General-Linux-Guide-(Anvil)) to take, or you can use my [Automated Installation Script](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki/Using-the-omni%E2%80%90guides.sh-Automation-Script) to take care of things for you. - - ---- - - -### Known Issues and Troubleshooting - -Current Known Issues are: - -* Drop-down menus fail to render. - -* Some images fail to load in the Wabbajack Gallery. - -* The "Verify Installation" checkbox doesn't render correctly. - -* Wabbajack may hang or crash when running via Proton/Wine. Just restart the app and use the "Install from Disk" option, Wabbajack should pick up from where it left off. - - -====== - - -Troubleshooting: - -If even after the script runs without errors, you still have issues with things like the Nexus login, it is possible that rogue/ghost wine processes got in the way of things truly being successful. I've done what I can to mitigate these, but by nature wine processes can often get stuck. - -Best bet is to reboot your system and re-run the install script. I wish there was an easier way. - ---- - -### Conclusion - -If you've read this far, then well done! I'd very much appreciate a Star for this guide, just to show if I'm on the right track. I'm also open to any feedback, positive or negative. - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) +**Please use the appropriate guide below:** +- **Nexus Mods Premium**: [[Installing a Modlist with Jackify]] — fully automated, no manual steps required +- **Without Nexus Premium**: [[Installing a Modlist with Wabbajack]] — Wabbajack under Proton, with Jackify handling all post-install configuration automatically diff --git a/Withdrawn:--Skyrim-Journey.md b/Withdrawn:--Skyrim-Journey.md deleted file mode 100644 index 3b24b09..0000000 --- a/Withdrawn:--Skyrim-Journey.md +++ /dev/null @@ -1,326 +0,0 @@ -![Journey Banner]() - -[![Star!]https://github.com/Omni-guides/Wabbajack-Modlist-Linux" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star Omni-guides/Wabbajack-Modlist-Linux on GitHub">Star - -## Instructions - -These steps will need to be carried out in Desktop mode, but once complete you will be able to launch the Modlist and play the game from Game Mode. Journey is designed and made for Skyrim: Special Edition with full support for players with only the free Creation Club content or those who have the full Anniversary Edition content. If you wish to use the full Anniversary contant, then you will need to have launched the vanilla Skyrim game and download the Creation Club content. - ---- - -### Step 1 - Create the directory - -Once Wabbajack has successfully completed the download and installation of the Modlist on your Windows system, create a new directory on the SteamDeck 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 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/Journey -``` - -OR - -Create Directory on **SD Card**: -``` -mkdir -p /run/media/mmcblk0p1/Games/Skyrim/Journey -``` - -(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) - -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 directory to /home/deck/Games/Skyrim/Journey/Journey-WJ - the reason for this folder structure is to assist in having multiple Modlists installed at the same time. **Do not include any spaces in the directory path at this level** - it does not play well with the Proton/mo-redirect/MO2 combination even with the spaces being escaped, for whatever reason.. - -Finally for this step, it's best to make sure that the newly copied files have sufficient permissions for your user. Run **only one** of the following for each action (owner and permissions), depending on where you want to store the Modlist: - -Change the owner and permissions of the directory on **Internal Storage**: -``` -sudo chown -R deck:deck /home/deck/Games/Skyrim/Journey/Journey-WJ -sudo chmod -R 755 /home/deck/Games/Skyrim/Journey/Journey-WJ -``` - -OR - -Change the owner and permissions of the directory on **SD Card**: -``` -sudo chown -R deck:deck /run/media/mmcblk0p1/Games/Skyrim/Journey/Journey-WJ -sudo chmod -R 755 /run/media/mmcblk0p1/Games/Skyrim/Journey/Journey-WJ -``` - ---- - -### Step 2 - Steam Redirector - -Next we need a nifty little program called steam-redirector. Information about this program can be found on the github page for the more general [Linux Mod Organizer 2 installation](https://github.com/rockerbacon/modorganizer2-linux-installer) by rockerbacon. You can download a version I have pre-compiled from here (tested on Arch and Fedora but should work on others) using one of the commands below. If you prefer, you can choose to build from source yourself following the instructions provided on the on the [steam-redirector](https://github.com/rockerbacon/modorganizer2-linux-installer/tree/master/steam-redirector) github page. - -To download the version I have pre-built, run **only one** of the following commands in Konsole, depending on your storage location. - -Download the pre-built mo-redirect.exe to **Internal Storage**: -``` -wget https://github.com/Omni-guides/Wabbajack-Modlist-Linux/raw/main/mo-redirect.exe -O /home/deck/Games/Skyrim/Journey/mo-redirect.exe -``` - -OR - -Download the pre-built mo-redirect.exe to **SDCard**: -``` -wget https://github.com/Omni-guides/Wabbajack-Modlist-Linux/raw/main/mo-redirect.exe -O /run/media/mmcblk0p1/Games/Skyrim/Journey/mo-redirect.exe -``` - -This mo-redirect.exe is a wrapper app that basically points to the real location of your Modlist's ModOrganizer.exe and nxmhandler.exe. It does this based on the contents of two files that have to live inside a specific directory called modorganizer2. This directory has to exist in the same directory mo-redirect.exe lives. So we need to create a directory, and then create the two files mo-redirect.exe is expecting. - -Run **only one** of the following commands in Konsole, depending on where you are storing the Modlist. - -Create the Directory on **Internal Storage**: -``` -mkdir /home/deck/Games/Skyrim/Journey/modorganizer2 -``` - -OR - -Create the Directory on **SD Card**: -``` -mkdir /run/media/mmcblk0p1/Games/Skyrim/Journey/modorganizer2 -``` - -Create the two required files, firstly ModOrganizer.exe. Run **only one** of the following: - -**Internal Storage**: -``` -echo "/home/deck/Games/Skyrim/Journey/Journey-WJ/ModOrganizer.exe" > /home/deck/Games/Skyrim/Journey/modorganizer2/instance_path.txt -``` - -OR - -**SD Card**: -``` -echo "/run/media/mmcblk0p1/Games/Skyrim/Journey/Journey-WJ/ModOrganizer.exe" > /run/media/mmcblk0p1/Games/Skyrim/Journey/modorganizer2/instance_path.txt -``` - -and then nxmhandler.exe. Again, only **run one** of the following: - -**Internal Storage**: -``` -echo "/home/deck/Games/Skyrim/Journey/Journey-WJ/nxmhandler.exe" > /home/deck/Games/Skyrim/Journey/modorganizer2/instance_download_path.txt -``` - -OR - -**SD Card**: -``` -echo "/run/media/mmcblk0p1/Games/Skyrim/Journey/Journey-WJ/nxmhandler.exe" > /run/media/mmcblk0p1/Games/Skyrim/Journey/modorganizer2/instance_download_path.txt -``` - -At this stage, the /home/deck/Games/Skyrim/Journey directory (or SD Card equivalent) should contain the following two directories and one .exe file: - -``` -modorganizer2 mo-redirect.exe Journey-WJ -``` - -with the modorganizer2 directory containing the two created files: - -``` -instance_path.txt -instance_download_path.txt -``` ---- - -### Step 3 - Add the redirector as a Non-Steam Game - -Next step is to add mo-redirect.exe to Steam as a non-steam game. Once added, edit the properties of the new mo-redirect.exe entry. You can give it a more sensible name - I used "Skyrim - Journey" for example, and then in the Compatibility tab tick the box for 'Force the use of a specific Steam Play compatibility tool', then select the Proton version - I chose Proton 7.0-4 which was the latest stable Proton version at time of writing.. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/SteamCompatibilityProton.png) - -**IMPORTANT FOR SD CARD USERS** - You must add the following to the Launch Options for the mo-redirect.exe Non-Steam game, otherwise the Proton environment won't have access to your SD Card contents: - -``` -STEAM_COMPAT_MOUNTS=/run/media/mmcblk0p1 %command% -``` -Like so: - -![Screenshot_20220816_221418](https://user-images.githubusercontent.com/110171124/184987838-3688c045-551d-499a-ac2c-cba4b84255ed.png) - ---- - -### Step 4 - Start and Configure ModOrganizer2 - -Click play on this new entry "Skyrim - Journey" (or whatever you renamed it to) in Steam, and all being well, a little terminal window will appear - this is the steam-redirector doing it's job. If the terminal window just pops up for a second and vanishes, double check the contents of the instance_path.txt and instance_download_path.txt files as above, and that they are present in the correct directory - e.g. /home/deck/Games/Skyrim/Journey/modorganizer2/instances_path.txt, or check that the Proton version you have selected is 7.0-4 (or whatever the latest Steam-supplied stable version is). - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus4MORedirectTerminal.png) - -Depending on the path on Windows that you copied the ModList files from, you may see an error pop-up about your account lacking permission: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MO2DownloadsError.png) - -To fix this, we just need to strip the now incorrect download directory from the ModOrganizer.ini file: - -``` -sed -i "/download_directory/c\download_directory =" /home/deck/Games/Skyrim/Journey/Journey-WJ/ModOrganizer.ini -``` - -If you had this error, fix as above and then re-run "Skyrim - Journey" from Steam. - -Another error box will appear, complaining that it "Cannot open instance 'Portable'. This is because we copied the Modlist directory (inclusive of the built-in MO2) from Windows, so the path has changed: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus4PortableError.png) - -To fix this, we need to point MO2 to our new location. Click OK, and then Browse: - -![image](https://user-images.githubusercontent.com/110171124/185071655-30f8fe66-d83d-48d0-acf5-398951d0001e.png) - -A GUI file browser will appear, and we need to expand the directories path to reveal the 'Root Game' directory: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus4GameRoot.png) - -With that done, the custom Modlist splashscreen for MO2 should appear, followed by ModOrganizer2 itself. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus4Splash.png) - -You may also get a pop-up asking if you want to Register for handling nxm links, like so: - -![image](https://user-images.githubusercontent.com/110171124/185072115-97215185-7237-4973-9674-5281a7daf305.png) - -I usually just hit "No, don't ask again" as I wont be downloading any new mods via this version of MO2. - -Getting close now. Next, we have to ensure that ModOrganizer2 is pointing to the correct **new** location for the required executable. In MO2, click the little two-cog icon at the top, which will bring up the Modify Executables window (please note that this icon may differ for some Modlists that use custom icon sets): - -![image](https://user-images.githubusercontent.com/110171124/181569435-99b953ff-bb0a-4da7-aab8-4e76b5d0f3d6.png) - -For Journey, the executable that needs edited will be simply 'Journey' if you **do not** have the Anniversary Edition, and 'Journey - Anniversary' if you **do** have the Anniversary Edition. We need to change the "Binary" and "Start In" locations to point to the directory inside our Journey-WJ directory that houses the skse64_loader.exe application. Due to running this through proton, it will be referenced by being the Z: drive location. So for example, the executable paths we need for the Journey entry should be: - -'Binary' path: -``` -Z:\home\deck\Games\Skyrim\Journey\Journey-WJ\Stock Game\skse64_loader.exe -``` -and a 'Start In' path of: - -``` -Z:\home\deck\Games\Skyrim\Journey\Journey-WJ\Stock Game\ -``` - -You can copy and paste the path, or use the three dots beside the "Binary" and "Start In" entries to manually locate via GUI. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus4MO2Executables.png) - ---- - -### Step 5 - Disable ENB - -Depending on the Modlist you are trying to run, the method for disabling ENB will differ. While ENB can work under Linux, it is likely going to badly impact performance on the Deck, so I would advise you to disable it. To do that for Journey, we just need to rename the ENB .dll file: - -``` -TODO ENB RENAME -``` - -disable the 'ENB - Binaries' entry in MO2 - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus4DisableENB.png) - ---- - -### Step 6 - Required Fixes - -Now on to required fixes. The following have been required for each of the Modlists I have managed to get running. There is an issue with missing NPC Voices - apparently this is an issue with Proton, so it may ultimately be resolved in time with a newer version of Proton without needing these steps. For now though, we need to install xact and xact_x64 to the Wine/Proton environment Steam created for our "Skyrim - Journey" (mo-redirect.exe) entry. The easiest way to accomplish this is to use ProtonTricks. This can be installed via the Discover store on the Deck: - -![image](https://user-images.githubusercontent.com/110171124/183392721-f4ed554a-8bb7-4cc2-a4b9-29c56b8b5a39.png) - -![image](https://user-images.githubusercontent.com/110171124/183392763-f005a96d-4a78-4b7b-9fd1-ba4961126d10.png) - -To enable the use of protontricks via the command line, open Konsole if it isn't open already, and run the following command to add an alias: - -``` -echo "alias protontricks='flatpak run com.github.Matoking.protontricks'" >> ~/.bashrc -``` - -then close and reopen Konsole. We can now invoke protontricks from the command line. - -Adding the required packages can be done via the ProtonTricks gui, but perhaps the easiest way is via command line. You can run the following one-liner to do it for you, or if you prefer, you can manually run the individual steps noted below (replace "Journey" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep "Journey" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:'` ; echo $APPID ; protontricks $APPID xact xact_x64 -``` - -If you prefer to run this manually, first find the AppID of the Non-Steam Game we added for mo-redirect.exe. In a terminal run(replace "Journey" with the name of your Non-steam game entry, if you called it something else): - -``` -protontricks -l | grep "Journey" -``` - -The output should look something like below, though your AppID will differ from mine: - -``` -Non-Steam shortcut: Skyrim - Journey (3595949753) -``` - -With the AppID now known, install the required xact and xact_x64 packages into this Proton environment (use your own AppID from the command above): - -``` -protontricks 3595949753 xact xact_x64 -``` - -This may take a little time to complete, but just let it run the course. - ---- - -### Step 7 - Modlist Specific Steps - Journey **TO DELETE?** - -At this stage, the steps required may differ depending on the Modlist you have chosen, and the mods that the Modlist includes. For Septimus 4, we should only need to install vcredist2022. Unfortunately this isn't available directly through protontricks, so we will have to install it manually. The following one-liner should do everything you need (replace "Septimus" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep "Septimus" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:' | tail -1` ; wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O '/home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/dosdevices/c:/vc_redist.x64.exe' ; protontricks -c 'wine /home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/dosdevices/c:/vc_redist.x64.exe' $APPID -``` - -However, if you aren't keen on that giant command, or just want to do the steps one by one, you can do the following. Firstly, we need to download the vc_redist.x64.exe installer inside the Proton prefix. Run the following command, replacing my Game ID (3595949753) with your own which you can get by running protontricks -l in Konsole: - -``` -wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O /home/deck/.local/share/Steam/steamapps/compatdata/3595949753/pfx/drive_c/vc_redist.x64.exe -``` - -Then we can enter the shell of our Proton environment: - -``` -protontricks 3595949753 shell -``` - -If successful, it should display a little C: prompt in your terminal window. Your terminal may misbehave after running the wine command - you can regain control by typing 'reset', even if you can't see the characters as you type. - -Finally, run the installer: - -``` -wine vc_redist.x64.exe -``` - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus4WineShell.png) - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/SeptimusVCRedistInstallStart.png) - -Check the box to agree, and then click install. It should complete quickly. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/SeptimusVCRedistInstallComplete.png) - ---- - -### Step 8 - Optional: Increase SteamDeck Swap Space, Swappiness and adjust SteamDeck VRAM - -This may be optional, but there have been reports of far better stability and performance after increasing the swap space available to the deck when running Modlists. This is an optional step, but if you are experiencing stability issues, it might be worth investigating. How to do so is outside the scope of this guide, but there is plenty of information available elsewhere on how to do it - [CryoByte33](https://github.com/CryoByte33/steam-deck-utilities) has an excellent set of utilities available on github that can take care of this, and more! - -TODO - Add links for Deck Swap Size Guide - -### Conclusion - -At last! - -If you've read this far, then well done! I'd appreciate a Star for this guide, just to show if I'm on the right track. I'm also open to any feedback, positive or negative. - -With NPC Voices fixed, we should now be ready! Click the Play button in Mod Organizer, and wait. This takes quite a bit of time to start. So long, in fact, that I thought it had crashed and I started killing processes etc. But just wait... It took my SteamDeck approximately 3 minutes and 45 seconds before I could interact with the in-game menu. Once it had loaded though, performance was as expected in the menus. - -On SteamDeck, I limit FPS and Refresh rate to 40, and it does a pretty good job at maintaining that in the Journey Modlist, though I am still testing more performance tweaks. Other lists may vary, and I do plan to test more as my time allows. I would love to hear your feedback on performance of various lists, and any tweaks that you made! - -Once you have started a new game, please follow any additional steps that the wiki for your chosen Modlist asks you to carry out, in terms of mod configuration from inside the game. - -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 ;) - -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 channel on the Wabbajack Discord, I should be around so just @ me (@omni) on the Wabbajack Discord. - -Enjoy! - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus4-GoodLuck.png) diff --git a/Withdrawn:-AVO.md b/Withdrawn:-AVO.md deleted file mode 100644 index 627c9d7..0000000 --- a/Withdrawn:-AVO.md +++ /dev/null @@ -1,303 +0,0 @@ -![IMAGE General Banner](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/General/General-Banner.png) - -This guide is designed to be a generic Wabbajack-list-on-Linux guide. While I use AVO as the example here, the same steps should apply to other lists, too. There may be a few different steps needed for some lists, but this should at least be a good start. Feel free to get in touch with me on the below linked Discord if the below steps do not work for the modlist you are trying to run. - -_Althro's Visual Overhaul ([AVO](https://github.com/Althro/AVO) ) is designed as a "true to vanilla list" to build your own list upon. It has been installed over 12 thousand times and garnered a reputation for being incredibly stable and is, as the quote says, "the best way to make your own list."_ - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) - -As it stands, I **DO NOT RECOMMEND AVO 8 ON STEAM DECK**, it's just too heavy and will average around 20fps. I'm still trying to see if there are any relatively easy tweaks that could be done to get this playable. This guide will focus on running AVO on a Linux system, rather than the Steam Deck. - ---- - - -## Automated Configuration - -While this guide contains the step by step process to get the modlist up and running, a growing number of modlists have been tested against my automation script successfully. - -If you wish to carry out the steps manually because you want to learn the process, or simply enjoy tinkering, then absolutely feel free to follow the below steps. Otherwise, you can find the Automation Script and instructions for use here - [Using the Omni-Guides Automation Script](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki/Using-the-omni%E2%80%90guides.sh-Automation-Script). - - ---- - - - -## Instructions - -**The following has been tested on AVO v8** - -This guide only covers getting the Modlist running. It does not cover downloading the Modlist via Wabbajack, or how to copy the Modlist to your Linux system. The official AVO entry from Wabbajack will not run on Linux - this is due to the version of MO2 used (2.5.0) which is not yet functional via Proton. Instead, Althro has provided me with an alternative .wabbajack file for a Linux-specific build using a compatible version of MO2. You can find this .wabbajack file [HERE](https://www.nexusmods.com/skyrimspecialedition/mods/108310/), and download the list using the "Install from File" option in Wabbajack. - -For AVO, you will need to own the Anniversary Edition of Skyrim, and have launched the vanilla Skyrim game to download the Creation Club content. I also assume that you have sudo access for your Linux user. - -AVO only supports Skyrim AE, Anniversary Edition is **not optional**. - -The steps below may seem wordy and plentiful, but they can be carried out relatively quickly - I just wanted to give context and description to each step. - ---- - -### Step 1 - Create the directory - -Once Wabbajack has successfully completed the download and installation of the Modlist on your Windows system, create a new directory on Linux to house the required files. Open up a terminal/Konsole and run the equivalent of the following command. You will have to replace 'omni' with the name of your Linux user: - -``` -mkdir -p /home/omni/Games/Skyrim/AVO -``` - -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 seem to play well with the Proton/MO2 combination, even with the spaces being escaped, for whatever reason.. - -Copy the Modlist Install directory from Windows into this newly created directory. There are many ways to do this. I chose to enable ssh on my Linux system, 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 Linux filesystem, /home/omni/Games/Skyrim/AVO/ - -Finally for this step, it's best to make sure that the newly copied files have sufficient permissions for your user. - -Change the owner and permissions of the directory : -``` -sudo chown -R omni:omni /home/omni/Games/Skyrim/AVO -``` -``` -sudo chmod -R 755 /home/omni/Games/Skyrim/AVO -``` - ---- - -### 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". The latest version of Steam should use the regular File Browser from your system, older versions of Steam had a built-in file browser. - -![IMAGE AddNonSteamGame](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-AddNonSteamGame.png) - -Click Browse: - -![IMAGE BrowseNonSteamGame](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-BrowseNonSteamGame.png) - -Browse to the path of your modlist. e.g. /home/omni/Games/Skyrim/AVO, select ModOrganizer.exe, and click Open. - -![IMAGE AddMO2NonSteamGame](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/General/GeneralAVO-AddMO2NonSteamGame.png) - -Ensure ModOrganizer.exe is present and ticked, and then click Add Selected Program. - -![IMAGE AddMO2NonSteamGame](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/General/GeneralAVO-AddSelectedPrograms.png) - -Once added, edit the properties of the new ModOrganizer.exe entry. You can give it a more sensible name - I used "Skyrim - AVO": - -![IMAGE PropertiesNonSteamGame](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/General/GeneralAVO-PropertiesNonSteamGame.png) - -Then in the Compatibility tab tick the box for 'Force the use of a specific Steam Play compatibility tool', then select the Proton version - I use Proton 8.0-4 which was the latest stable Proton version provided by Valve at time of writing.. - -![IMAGE ProtonNonSteamGame](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-ProtonNonSteamGame.png) - ---- - -### Step 3 - Install Protontricks - -If you don't already have it installed, ProtonTricks can be installed via the Discover store as a flatpak, and is likely also available from your distribution's package manager. Personally I use the version from flatpak/Discover Store: - -![IMAGE ProtontricksSearch](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-ProtontricksDiscover.png) - -![IMAGE ProtontricksInstall](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-ProtontricksDiscoverInstall.png) - -To enable the use of protontricks via the command line, open a Konsole terminal and run the following command to add an alias(If you use a shell other than bash, you will have to adapt the following for your own login script location): - -``` -echo "alias protontricks='flatpak run com.github.Matoking.protontricks'" >> ~/.bashrc -``` - -then close and reopen your terminal/Konsole. We can now invoke protontricks from the command line. Next, we need to allow protontricks access to the filesystem location (adjust as needed if you used a different path): - -``` -sudo flatpak override com.github.Matoking.protontricks --filesystem=/home/omni/Games -``` - -That should be protontricks installed and ready to use later in the guide. - - ---- - -### Step 4 - Start and Configure ModOrganizer2 - -Click play on this new entry "Skyrim - AVO" (or whatever you renamed it to) in Steam - Depending on the path on Windows that you copied the Modlist files from, you may see an error pop-up about your account lacking permission: - -![IMAGE MO2DownloadsError](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-MO2DownloadsError.png) - -To fix this, we just need to strip the now incorrect download directory from the ModOrganizer.ini file. in Konsole terminal, run: - -``` -sed -i "/download_directory/c\download_directory =" /home/omni/Games/Skyrim/AVO/ModOrganizer.ini -``` - -then re-run "Skyrim - AVO" from Steam. - -Another error box will appear, complaining that it "Cannot open instance 'Portable'. This is because we copied the Modlist directory (inclusive of the built-in MO2) from Windows, so the path has changed: - -![IMAGE MO2PortableError](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-MO2PortableError.png) - -To fix this, we need to point MO2 to our new location. Click OK, and then Browse. The path we are looking for is: - -``` -Z:\home\omni\Games\Skyrim\AVO\Game Root -``` - -![IMAGE BrowseLocalBlur](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/General/GeneralAVO-BrowseLocalBlur.png) - -The splash screen for AVO should hopefully now appear: - -![IMAGE MO2Splash](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/General/GeneralAVO-MO2Splash.png) - -You may also get a pop-up asking if you want to Register for handling nxm links, like so: - -![IMAGE HandleNXMLinks](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-MO2RegisterNXMLinks.png) - -I usually just hit "Yes" and move on with my life. - -Getting close now. Next, we have to ensure that ModOrganizer2 is pointing to the correct location for the required executable. In MO2, click the little two-cog icon at the top, which will bring up the Modify Executables window (please note that this icon may differ for some Modlists that use custom icon sets): - - -![IMAGE MO2ExecutableCog](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/General/GeneralAVO-MO2ExecutablesCog.png) - -For the AVO executable, we need to point MO2 at a file that may not actually exist yet (but it will exist, once GameRoot does it's thing when you click launch - and is then removed again when the game closes). - -The path you need for the AVO application will be: - -``` -Z:\home\omni\Games\Skyrim\AVO\mods\Skyrim Script Extender\Root\skse64_loader.exe -``` - -![IMAGE MO2Executables](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/General/GeneralAVO-MO2Executables.png) - ---- - -### Step 5 - Install Required Wine Additions - -There is an issue with missing NPC Voices - apparently this is an issue with Proton, so it may ultimately be resolved in time with a newer version of Proton without needing these steps. For now though, we need to install xact and xact_x64 to the Wine/Proton environment Steam created for our "Skyrim - AVO" entry, and a few others for the use of Community Shaders. AVO also requires Microsoft Visual C++ Redistributable 2022 for some of it's mods. - -The easiest way to install what we need is to use ProtonTricks, which should be installed already from Step 3 earlier in this guide. - -Adding the required packages can be done via the ProtonTricks gui, but perhaps the easiest way is via command line. You can run the following one-liner to do it for you, or if you prefer, you can manually run the individual steps noted below (replace "Skyrim - AVO" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep -i "Skyrim - AVO" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:'` ; protontricks --no-bwrap $APPID xact xact_x64 -``` - -Alternatively, **If you prefer to run this manually**, see an alternative step-by-step method in the **Additional Notes** section below. - ---- - -### Step 6 - Install VCREDIST2022 - -Next up is the requirement of vcredist2022. Unfortunately this isn't available directly through protontricks as per xact, so we will have to install it semi-manually. The following one-liner should do everything you need (replace "AVO" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep -i "Skyrim - AVO" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:' | tail -1` ; wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O '/home/omni/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe' ; protontricks --no-bwrap -c 'wine /home/omni/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe /Q' $APPID -``` - ---- - -### Step 7 - Set Resolution - -Next, we should set the resolution to match your monitor resolution. To do this in MO2, filter for the entry for "SSE Display Tweaks", and double-click it: - -![IMAGE IniEditor](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/General/GeneralAVO-SSEDisplayTweaks.png) - -Switch to the INI Tab, highlight the INI File on the left, and then scroll down until you see the line that reads "#Resolution=1920x1080". Remove the # at the start of the line, and then set the resolution to be what you need: - -![IMAGE SetResolution](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/General/GeneralAVO-SetResolution.png) - -Finally, click the Close button and select "Yes" to save the changes. - ---- - -### Conclusion - -At last! - -If you've read this far, then well done! I'd very much appreciate a Star for this guide, just to show if I'm on the right track. I'm also open to any feedback, positive or negative. - -With NPC Voices fixed, and vcredist2022 installed, we should now be ready! Click the Play button in Mod Organizer, and wait.... This takes quite a bit of time to start. Once it had loaded though, performance was as expected once you're in the menus. - -![IMAGE SetResolution](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/General/GeneralAVO-MO2Play.png) - -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 ;) - -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! - -Enjoy! - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) - -![IMAGE AVOMenu](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/General/GeneralAVO-Menu.png) - - - - ---- - - - -## Additional Notes - - -### Install VCREDIST2022 manually - -If you prefer to install vcredist manually instead of using my one-liner, you can follow these steps. Unfortunately this isn't available directly through protontricks as per xact, so we will have to install it semi-manually. The following one-liner should do everything you need (replace "Skyrim - AVO" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep -i "Skyrim - AVO" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:' | tail -1` ; wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O '/home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe' ; protontricks --no-bwrap -c 'wine /home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe' $APPID -``` - -![IMAGE AdditionalVCRedistStart](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-VCRedistInstallStart.png) - -Check the box to agree, and then click install. It should complete quickly. - -![IMAGE AdditionalComplate](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-VCRedistInstallComplete.png) - -Alternatively, **If you prefer to run this manually, step-by-step**, you can do the following. Firstly, we need to download the vc_redist.x64.exe installer inside the Proton prefix. Run the following command, replacing my Game ID (3595949753) with your own which you can get by running protontricks -l in Konsole: - -``` -wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O /home/deck/.local/share/Steam/steamapps/compatdata/3595949753/pfx/drive_c/vc_redist.x64.exe -``` - -Then we can enter the shell of our Proton environment: - -``` -protontricks --no-bwrap 3595949753 shell -``` - -If successful, it should display a little C: prompt in your terminal window. Your terminal may misbehave after running the wine command - you can regain control by typing 'reset', even if you can't see the characters as you type. - -Finally, run the installer: - -``` -wine vc_redist.x64.exe -``` - -![IMAGE AdditionalVCRedistStart](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-WineShell.png) - -![IMAGE AdditionalVCRedistStart](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-VCRedistInstallStart.png) - -Check the box to agree, and then click install. It should complete quickly. - -![IMAGE AdditionalComplate](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-VCRedistInstallComplete.png) - -When running wine commands in Konsole, it usually mangles the terminal a bit - text you type wont be shown (though it technically is still being printed in the terminal) - to get out of that state, either close and reopen Konsole, or just type 'reset' and hit enter, even if you can't see the characters. - -### Install wine requirements manually (xact, xact_x64) - -first find the AppID of the Non-Steam Game we added for mo-redirect.exe. In a terminal run: - -``` -protontricks -l | grep -i "Skyrim - AVO" -``` - -Replace "Skyrim - AVO" if you have renamed the Non-Steam Game added earlier. The output should look something like below, though your AppID will differ from mine: - -``` -Non-Steam shortcut: Skyrim - AVO (3595949753) -``` - -With the AppID now known, install the required xact and xact_x64 packages into this Proton environment (use your own AppID from the command above): - -``` -protontricks --no-bwrap 3595949753 xact xact_x64 -``` - -This may take a little time to complete, but just let it run the course. Your terminal may misbehave after running the protontricks/wine command - you can regain control by typing 'reset', even if you can't see the characters as you type. diff --git a/Withdrawn:-Skyrim-Dragonborn.md b/Withdrawn:-Skyrim-Dragonborn.md deleted file mode 100644 index a13e20c..0000000 --- a/Withdrawn:-Skyrim-Dragonborn.md +++ /dev/null @@ -1,424 +0,0 @@ -![Dragonborn Banner](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Dragonborn/DragonbornBanner.png) - -[Dragonborn](https://github.com/Lost-Outpost/dragonborn/#readme) _is a lightweight and streamlined modlist with the very best modded content, creation club and survival support as well as excellent performance. It's designed to take up as little hard drive space as possible while still providing a performance friendly and beautiful graphics overhaul and enough content to discover for existing and new players._ - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) - ---- - -Note that as of Dragonborn v1.4.5, that list has been re-branded as Septimus. The following guide is for the list formerly known as Simplicity of Skyrim, which has now been re-branded as Dragonborn - ask GuitarNinja for more details ;) - ---- - - -## Instructions - -**The following has been tested on Dragonborn v1.0.15** - -These steps will need to be carried out in Desktop mode, but once complete you will be able to launch the Modlist and play the game from Game Mode. For the Dragonborn Modlist, you will need to own the Anniversary Edition of Skyrim, and have launched the vanilla Skyrim game to download the Creation Club content. I also assume that you have set a user password on the Steam Deck. - -### Step 1 - Create the directory - -Once Wabbajack has successfully completed the download and installation of the Modlist on your Windows system, create a new directory on the SteamDeck 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 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/Dragonborn -``` - -OR - -Create Directory on **SD Card**: -``` -mkdir -p /run/media/mmcblk0p1/Games/Skyrim/Dragonborn -``` - -(Note: Valve plan to change the default mount point of SD Cards within SteamOS soon, I'll update this guide once that change is in place) - -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 directory to /home/deck/Games/Skyrim/Dragonborn/Dragonborn-WJ - the reason for this structure is that it helps if you want to have multiple Modlists installed at the same time. - -**Do not include any spaces in the directory path at this level** - it does not play well with the Proton/mo-redirect/MO2 combination even with the spaces being escaped, for whatever reason.. - -Finally for this step, it's best to make sure that the newly copied files have sufficient permissions for your user. Run **only one** of the following for each action (owner and permissions), depending on where you want to store the ModList: - -Change the owner and permissions of the directory on **Internal Storage**: -``` -sudo chown -R deck:deck /home/deck/Games/Skyrim/Dragonborn/Dragonborn-WJ -``` -``` -sudo chmod -R 755 /home/deck/Games/Skyrim/Dragonborn/Dragonborn-WJ -``` - -OR - -Change the owner and permissions of the directory on **SD Card**: -``` -sudo chown -R deck:deck /run/media/mmcblk0p1/Games/Skyrim/Dragonborn/Dragonborn-WJ -``` -``` -sudo chmod -R 755 /run/media/mmcblk0p1/Games/Skyrim/Dragonborn/Dragonborn-WJ -``` - ---- - -### Step 2 - Steam Redirector - -Next we need a nifty little program called steam-redirector. Information about this program can be found on the github page for the more general [Linux Mod Organizer 2 installation](https://github.com/rockerbacon/modorganizer2-linux-installer) by rockerbacon. You can download a version I have pre-compiled from here (tested on Arch and Fedora but should work on others) using one of the commands below. If you prefer, you can choose to build from source yourself following the instructions provided on the on the [steam-redirector](https://github.com/rockerbacon/modorganizer2-linux-installer/tree/master/steam-redirector) github page. - -To download the version I have pre-built, run **only one** of the following commands in Konsole, depending on your storage location. - -Download the pre-built mo-redirect.exe to **Internal Storage**: -``` -wget https://github.com/Omni-guides/Wabbajack-Modlist-Linux/raw/main/mo-redirect.exe -O /home/deck/Games/Skyrim/Dragonborn/mo-redirect.exe -``` - -OR - -Download the pre-built mo-redirect.exe to **SDCard**: -``` -wget https://github.com/Omni-guides/Wabbajack-Modlist-Linux/raw/main/mo-redirect.exe -O /run/media/mmcblk0p1/Games/Skyrim/Dragonborn/mo-redirect.exe -``` - -This mo-redirect.exe is a wrapper app that basically points to the real location of your Modlist's ModOrganizer.exe and nxmhandler.exe. It does this based on the contents of two files that have to live inside a specific directory called modorganizer2. This directory has to exist at the same directory level as mo-redirect.exe. So we need to create a directory, and then create the two files mo-redirect.exe is expecting. - -Run **only one** of the following commands in Konsole, depending on where you are storing the Modlist. - -Create the Directory on **Internal Storage**: -``` -mkdir /home/deck/Games/Skyrim/Dragonborn/modorganizer2 -``` - -OR - -Create the Directory on **SD Card**: -``` -mkdir /run/media/mmcblk0p1/Games/Skyrim/Dragonborn/modorganizer2 -``` - -Create the two required files, firstly ModOrganizer.exe. Run **only one** of the following: - -**Internal Storage**: -``` -echo "/home/deck/Games/Skyrim/Dragonborn/Dragonborn-WJ/ModOrganizer.exe" > /home/deck/Games/Skyrim/Dragonborn/modorganizer2/instance_path.txt -``` - -OR - -**SD Card**: -``` -echo "/run/media/mmcblk0p1/Games/Skyrim/Dragonborn/Dragonborn-WJ/ModOrganizer.exe" > /run/media/mmcblk0p1/Games/Skyrim/Dragonborn/modorganizer2/instance_path.txt -``` - -and then nxmhandler.exe. Again, only **run one** of the following: - -**Internal Storage**: -``` -echo "/home/deck/Games/Skyrim/Dragonborn/Dragonborn-WJ/nxmhandler.exe" > /home/deck/Games/Skyrim/Dragonborn/modorganizer2/instance_download_path.txt -``` - -OR - -**SD Card**: -``` -echo "/run/media/mmcblk0p1/Games/Skyrim/Dragonborn/Dragonborn-WJ/nxmhandler.exe" > /run/media/mmcblk0p1/Games/Skyrim/Dragonborn/modorganizer2/instance_download_path.txt -``` - -At this stage, the /home/deck/Games/Skyrim/Dragonborn directory (or SD Card equivalent) should contain the following two directories and one .exe file: - -``` -modorganizer2 mo-redirect.exe Dragonborn-WJ -``` - -with the modorganizer2 directory containing the two created files: - -``` -instance_path.txt -instance_download_path.txt -``` ---- - -### Step 3 - Add the redirector as a Non-Steam Game - -Next step is to add mo-redirect.exe to Steam as a non-steam game. In Steam, click Games, then "Add a Non-Steam Game to My Library". - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/AddNonSteamGame.png) - -Click Browse, and then adjust the "Look in" and "File type" drop-down menus as in the image below, then click Open: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Dragonborn/Dragonborn_AddNonSteamGame.png) - -Once added, edit the properties of the new mo-redirect.exe entry. You can give it a more sensible name - I used "Skyrim - Dragonborn" for example, and then in the Compatibility tab tick the box for 'Force the use of a specific Steam Play compatibility tool', then select the Proton version - I chose Proton 7.0-6 which was the latest stable Proton version at time of writing.. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Dragonborn/DragonbornProtonCompat.png) - -**IMPORTANT FOR SD CARD USERS** - You must add the following to the Launch Options for the mo-redirect.exe Non-Steam game, otherwise the Proton environment won't have access to your SD Card contents: - -``` -STEAM_COMPAT_MOUNTS=/run/media/mmcblk0p1 %command% -``` -Like so: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/STEAM_COMPAT_MOUNTS.png) - ---- - -### Step 4 - Enable Visibility of dot(.) files and folders - -Click Start on this new Non-Steam Game entry - it **_will probably_** fail to load correctly, but we need to launch the entry once so that it registers fully in Steam, and allow Protontricks to interact with it in the next Step. If it did start MO2 correctly, close it or any error windows and move on to the next step. - -Dragonborn requires MO2 to point to the vanilla Skyrim install in Steam. To enable this, we need to perform a few steps to allow MO2 visibility of our vanilla Skyrim directory, which will probably exist in your /home/deck/.local directory (this may differ if you have installed vanilla Skyrim to the SD Card or other location). By default, Wine/Proton applications do not have visibility of .(dot) files and folders, so we need to tweak it via Protontricks. - -If you don't already have it installed, ProtonTricks can be installed via the Discover store as a flatpak: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/ProtontricksDiscover.png) - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/ProtontricksDiscoverInstall.png) - -To enable the use of protontricks via the command line, open Konsole if it isn't open already, and run the following command to add an alias: - -``` -echo "alias protontricks='flatpak run com.github.Matoking.protontricks'" >> ~/.bashrc -``` - -then close and reopen Konsole. We can now invoke protontricks from the command line. Next, we need to allow protontricks access to the filesystem location (adjust as needed if you used a different path): - -``` -sudo flatpak override com.github.Matoking.protontricks --filesystem=/home/deck/Games -``` - - -To add the ability to see dot files and folders inside the Proton prefix, open up the Protontricks gui for our Dragonborn instance (replace "Dragonborn" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep "Dragonborn" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:' | tail -1` ; protontricks $APPID --gui ; reset - -``` - -Keep the 'default' selection highlighted, and click Next: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/ProtonTricks_wincfg_select_default.png) - -Select the 'winecfg' entry, and click Next. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/ProtonTricks_GUI_winecfg.png) - -This should open up a little windows style Properties box. From there, click the Drives tab at the top, and then check the box for showing 'dot files': - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Protontricks_GUI-dotfiles.png) - -Click Apply and then OK. To exit winecfg, click Cancel, and then cancel again. With this setting now in place, MO2 will have visibility of the required .local directory path to point MO2 at when you first launch it. When running wine commands in Konsole, it usually mangles the terminal a bit - text you type wont be shown (though it technically is still being printed in the terminal) - to get out of that state, either close and reopen Konsole, or just type 'reset' and hit enter, even if you can't see the characters. - ---- - -### Step 5 - Start and Configure ModOrganizer2 - -Click play on this new entry "Skyrim - Dragonborn" (or whatever you renamed it to) in Steam, and all being well, a little terminal window will appear - this is the steam-redirector doing it's job. If the terminal window just pops up for a second and vanishes, double check the contents of the instance_path.txt and instance_download_path.txt files as above, and that they are present in the correct directory - e.g. /home/deck/Games/Skyrim/Dragonborn/modorganizer2/instances_path.txt, check that the Proton version you have selected is 7.0-5 (or whatever the latest Steam-supplied stable version is) and make sure that there are no spaces in the path - for some reason mo-redirect.exe doesn't like that, even if you escape the spaces with backslashes in the text files. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Dragonborn/DragonbornMORedirectTerm.png) - -Depending on the path on Windows that you copied the ModList files from, you may see an error pop-up about your account lacking permission: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/MO2DownloadsError.png) - -To fix this, we just need to strip the now incorrect download directory from the ModOrganizer.ini file: - -``` -sed -i "/download_directory/c\download_directory =" /home/deck/Games/Skyrim/Dragonborn/Dragonborn-WJ/ModOrganizer.ini -``` - -If you had this error, fix as above and then re-run "Skyrim - Dragonborn" (mo-redirect.exe) from Steam. - -Another error box will appear, complaining that it "Cannot open instance 'Portable'. This is because we copied the ModList directory (inclusive of the built-in MO2) from Windows, so the path has changed now we are on deck: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Dragonborn/DragonbornMO2PortableError.png) - -To fix this, we need to point MO2 to our new location. Click OK, and then Browse. The path we are looking for is: - -``` -Z:\home\deck\.local\share\Steam\steamapps\common\Skyrim Special Edition -``` - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Dragonborn/DragonbornBrowsetoLocalBlur.png) - -The splash screen for Dragonborn should hopefully now display: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Dragonborn/DragonbornMO2Splash.png) - -You may also get a pop-up asking if you want to Register for handling nxm links, like so: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/MO2RegisterNXMLinks.png) - -I usually just hit "No, don't ask again" as I wont be downloading any new mods via this version of MO2. - -Getting close now. Next, we have to ensure that ModOrganizer2 is pointing to the correct **new** location for the required executable.In MO2, click the little two-cog icon at the top, which will bring up the Modify Executables window (please note that this icon may differ for some Modlists that use custom icon sets): - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Dragonborn/DragonbornExecutablesCog.png) - -For the Dragonborn executable, we need to point MO2 at a file that doesn't actually exist (but it will exist, once GameRoot does it's thing when you click launch - and is then removed again when the game closes). - -The path you need for the Dragonborn application will be: - -``` -Z:\home\deck\.local\share\Steam\steamapps\common\Skyrim Special Edition\skse64_loader.exe -``` - -with a 'start in' path of: - -``` -Z:\home\deck\.local\share\Steam\steamapps\common\Skyrim Special Edition -``` - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Dragonborn/DragonbornModifyExecutables.png) - -If you installed vanilla Skyrim to an SD Card, then you will have to replace with the equivalent path in /run/media/mmcblk0p1. - ---- - -### Step 6 - Disable ENB - -While ENB can work under Linux, it is likely going to badly impact performance on the Deck so I would advise you just disable it. However, if you do want to, you can see my guide to do so [here](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki/WIP---ENB-&-Reshade-(In-Progress...)) - -To disable ENB for Dragonborn, we just need to disable all the mods under the 'ENB - Options' category in MO2: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Dragonborn/DragonbornDisableENB.png) - -It's also a good plan to make sure that there are no Game Root leftovers. Click the Tools menu at the top of MO2, then select Tool Plugins, Root Builder, then Clear: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/ClearRootBuilder.png) - ---- - -### Step 7 - Fix Missing Audio - -There is an issue with missing NPC Voices - apparently this is an issue with Proton, so it may ultimately be resolved in time with a newer version of Proton without needing these steps. For now though, we need to install xact and xact_x64 to the Wine/Proton environment Steam created for our "Skyrim - Dragonborn" (mo-redirect.exe) entry. The easiest way to accomplish this is to use ProtonTricks, which should be installed already from Step 4 earlier in this guide. - -Adding some of the required packages can be done via the ProtonTricks gui, but perhaps the easiest way is via command line. You can run the following one-liner to do it for you, or if you prefer, you can manually run the individual steps noted below (replace "Dragonborn" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep "Dragonborn" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:'` ; protontricks $APPID xact xact_x64 ; reset -``` - -Alternatively, **If you prefer to run this manually**, first find the AppID of the Non-Steam Game we added for mo-redirect.exe. In a terminal run: - -``` -protontricks -l | grep "Dragonborn" -``` - -Replace mo-redirect if you have renamed the Non-Steam Game added earlier. The output should look something like below, though your AppID will differ from mine: - -``` -Non-Steam shortcut: Skyrim - Dragonborn (3595949753) -``` - -With the AppID now known, install the required xact and xact_x64 packages into this Proton environment (use your own AppID from the command above): - -``` -protontricks 3595949753 xact xact_x64 -``` - -This may take a little time to complete, but just let it run the course. Again, when running wine commands in Konsole, it usually mangles the terminal a bit - text you type wont be shown (though it technically is still being printed in the terminal) - to get out of that state, either close and reopen Konsole, or just type 'reset' and hit enter, even if you can't see the characters. - - ---- - -### Step 8 - Install VCREDIST2022 - -Next up is the requirement of vcredist2022. Unfortunately this isn't available directly through protontricks as per xact, so we will have to install it semi-manually. The following one-liner should do everything you need (replace "Dragonborn" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep "Dragonborn" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:' | tail -1` ; wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O '/home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe' ; protontricks -c 'wine /home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe' $APPID ; reset -``` - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/SeptimusVCRedistInstallStart.png) - -Check the box to agree, and then click install. It should complete quickly. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/SeptimusVCRedistInstallComplete.png) - -Alternatively, **If you prefer to run this manually**, you can do the following. Firstly, we need to download the vc_redist.x64.exe installer inside the Proton prefix. Run the following command, replacing my Game ID (3595949753) with your own which you can get by running protontricks -l in Konsole: - -``` -wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O /home/deck/.local/share/Steam/steamapps/compatdata/3595949753/pfx/drive_c/vc_redist.x64.exe -``` - -Then we can enter the shell of our Proton environment: - -``` -protontricks 3595949753 shell -``` - -If successful, it should display a little C: prompt in your terminal window. Your terminal may misbehave after running the wine command - you can regain control by typing 'reset', even if you can't see the characters as you type. - -Finally, run the installer: - -``` -wine vc_redist.x64.exe -``` - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus4WineShell.png) - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/SeptimusVCRedistInstallStart.png) - -Check the box to agree, and then click install. It should complete quickly. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/SeptimusVCRedistInstallComplete.png) - -Again here, when running wine commands in Konsole, it usually mangles the terminal a bit - text you type wont be shown (though it technically is still being printed in the terminal) - to get out of that state, either close and reopen Konsole, or just type 'reset' and hit enter, even if you can't see the characters. - - ---- - -### Step 9 - Set Resolution - -Next, we should set the resolution and desired Max FPS so that the deck isn't doing more work than it needs to. There's no point in asking Skyrim to render at 1440p, and then have the game squeezed into an 800p screen on the deck. You can also decide to lock the FPS here, or you can leave it and lock the FPS/Refresh via the Steam Deck itself. To do this in MO2, we can double-click the "SSE Display Tweaks" mod entry in MO2: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/SSEDisplayEditINI.png) - -Select the "INI Files" tab, click the entry under Ini Files, and then edit in the right pane for your desired resolution and Frame Limit: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/SSEDisplayEditResolution.png) - -Finally, click close and then Yes to accept the changes: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Dragonborn/DragonbornAcceptResolution.png) - ---- - - -### Step 10 - Optional but Recommended - -Increase SteamDeck Swap Space, Swappiness and adjust SteamDeck VRAM - -This may be optional, but there have been reports of far better stability and performance after increasing the swap space available to the deck when running Modlists. This is an optional step, but if you are experiencing stability issues, it might be worth investigating. How to do so is outside the scope of this guide, but there is plenty of information available elsewhere on how to do it - [CryoByte33](https://github.com/CryoByte33/steam-deck-utilities) has an excellent set of utilities available on github that can take care of this, and more! - -Personally I have increased the VRAM in the deck bios to 4GB (see [here](https://www.youtube.com/watch?v=od9_a1QQQns&t=1377s) for details), 16GB Swap space, and a Swappiness of 1 - the recommended settings when you run Cryobyte33's Steam Deck Utilities. In fact, the [full video](https://www.youtube.com/watch?v=od9_a1QQQns) of Cryobyte33 explaining what this all means, is definitely worth a watch! - -## Conclusion - -At last! - -If you've read this far, then well done! I'd very much appreciate a Star for this guide, just to show if I'm on the right track. I'm also open to any feedback, positive or negative. - -With NPC Voices fixed, andvcredist2022 installed, we should now be ready! Click the Play button in Mod Organizer, and wait.... - -You may see an error pop-up regarding bink2w64.dll. This is safe to ignore and can also appear on Windows. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Dragonborn/DragonbornBinkError.png) - -This error is apparently fine to ignore, and although I haven't found a fix for it, the same error can be seen on Windows too, so isn't specific to the Deck/Linux. - -The game does take quite a bit of time to start. So long, in fact, that I thought it had crashed and I started killing processes etc. But just wait... It took my Steam Deck approximately 3 minutes and 45 seconds before I could interact with the in-game menu. Once it had loaded though, performance was as expected in the menus. - -On SteamDeck, I limit FPS and Refresh rate to 40, and it does a pretty good job at maintaining that in the Dragonborn Modlist, though I am still testing more performance tweaks. Increasing the size of the swap space available to the deck can definitely help with this. I would love to hear your feedback on performance of various lists, and any tweaks that you made! - -**More performance metrics, including ReShade and ENB performance to be added soon** - -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 ;) - -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! - -Enjoy! - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Dragonborn/DragonbornMenuSuccess.png) \ No newline at end of file diff --git a/Withdrawn:-Skyrim-Redoran.md b/Withdrawn:-Skyrim-Redoran.md deleted file mode 100644 index ab34bde..0000000 --- a/Withdrawn:-Skyrim-Redoran.md +++ /dev/null @@ -1,419 +0,0 @@ -![Game Banner](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Redoran/RedoranBanner.png) - -"This is House Redoran territory. You'd do well to remember that." - -From the Modlist GitHub: [Redoran](https://github.com/Lost-Outpost/redoran) is a modlist designed to be utilized with Skyrim's Anniversary Edition Upgrade, featuring high-quality quest-based content, followers, and generalized vanilla improvements, all while being optimized for performance. The AE content included in this pack has been fully integrated into the world of Skyrim. Most quests have either been reworked, removed, or expanded upon to enhance the experience. - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) - -## Instructions - -**The following has been tested on Redoran v1.01** - -These steps will need to be carried out in Desktop mode, but once complete you will be able to launch the Modlist and play the game from Game Mode. For the Redoran Modlist, you will need to own the Anniversary Edition of Skyrim, and have launched the vanilla Skyrim game to download the Creation Club content. - ---- - -### Step 1 - Create the directory - -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 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/Redoran -``` - -OR - -Create Directory on **SD Card**: -``` -mkdir -p /run/media/mmcblk0p1/Games/Skyrim/Redoran -``` - -(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) - -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 directory to /home/deck/Games/Skyrim/Redoran/Redoran-WJ - the reason for this structure is that it helps if you want to have multiple Modlists installed at the same time. - -**Do not include any spaces in the directory path at this level** - it does not play well with the Proton/mo-redirect/MO2 combination even with the spaces being escaped, for whatever reason.. - -Finally for this step, it's best to make sure that the newly copied files have sufficient permissions for your user. Run **only one** of the following for each action (owner and permissions), depending on where you want to store the Modlist: - -Change the owner and permissions of the directory on **Internal Storage**: -``` -sudo chown -R deck:deck /home/deck/Games/Skyrim/Redoran/Redoran-WJ -``` -``` -sudo chmod -R 755 /home/deck/Games/Skyrim/Redoran/Redoran-WJ -``` - -OR - -Change the owner and permissions of the directory on **SD Card**: -``` -sudo chown -R deck:deck /run/media/mmcblk0p1/Games/Skyrim/Redoran/Redoran-WJ -``` -``` -sudo chmod -R 755 /run/media/mmcblk0p1/Games/Skyrim/Redoran/Redoran-WJ -``` - ---- - -### Step 2 - Steam Redirector - -Next we need a nifty little program called steam-redirector. Information about this program can be found on the github page for the more general [Linux Mod Organizer 2 installation](https://github.com/rockerbacon/modorganizer2-linux-installer) by rockerbacon. You can download a version I have pre-compiled from here (tested on Arch and Fedora but should work on others) using one of the commands below. If you prefer, you can choose to build from source yourself following the instructions provided on the on the [steam-redirector](https://github.com/rockerbacon/modorganizer2-linux-installer/tree/master/steam-redirector) github page. - -To download the version I have pre-built, run **only one** of the following commands in Konsole, depending on your storage location. - -Download the pre-built mo-redirect.exe to **Internal Storage**: -``` -wget https://github.com/Omni-guides/Wabbajack-Modlist-Linux/raw/main/mo-redirect.exe -O /home/deck/Games/Skyrim/Redoran/mo-redirect.exe -``` - -OR - -Download the pre-built mo-redirect.exe to **SDCard**: -``` -wget https://github.com/Omni-guides/Wabbajack-Modlist-Linux/raw/main/mo-redirect.exe -O /run/media/mmcblk0p1/Games/Skyrim/Redoran/mo-redirect.exe -``` - -This mo-redirect.exe is a wrapper app that basically points to the real location of your Modlist's ModOrganizer.exe and nxmhandler.exe. It does this based on the contents of two files that have to live inside a specific directory called modorganizer2. This directory has to exist in the same directory mo-redirect.exe lives. So we need to create a directory, and then create the two files mo-redirect.exe is expecting. - -Run **only one** of the following commands in Konsole, depending on where you are storing the Modlist. - -Create the Directory on **Internal Storage**: -``` -mkdir /home/deck/Games/Skyrim/Redoran/modorganizer2 -``` - -OR - -Create the Directory on **SD Card**: -``` -mkdir /run/media/mmcblk0p1/Games/Skyrim/Redoran/modorganizer2 -``` - -Create the two required files, firstly ModOrganizer.exe. Run **only one** of the following: - -**Internal Storage**: -``` -echo "/home/deck/Games/Skyrim/Redoran/Redoran-WJ/ModOrganizer.exe" > /home/deck/Games/Skyrim/Redoran/modorganizer2/instance_path.txt -``` - -OR - -**SD Card**: -``` -echo "/run/media/mmcblk0p1/Games/Skyrim/Redoran/Redoran-WJ/ModOrganizer.exe" > /run/media/mmcblk0p1/Games/Skyrim/Redoran/modorganizer2/instance_path.txt -``` - -and then nxmhandler.exe. Again, only **run one** of the following: - -**Internal Storage**: -``` -echo "/home/deck/Games/Skyrim/Redoran/Redoran-WJ/nxmhandler.exe" > /home/deck/Games/Skyrim/Redoran/modorganizer2/instance_download_path.txt -``` - -OR - -**SD Card**: -``` -echo "/run/media/mmcblk0p1/Games/Skyrim/Redoran/Redoran-WJ/nxmhandler.exe" > /run/media/mmcblk0p1/Games/Skyrim/Redoran/modorganizer2/instance_download_path.txt -``` - -At this stage, the /home/deck/Games/Skyrim/Redoran directory (or SD Card equivalent) should contain the following two directories and one .exe file: - -``` -modorganizer2 mo-redirect.exe Redoran-WJ -``` - -with the modorganizer2 directory containing the two created files: - -``` -instance_path.txt -instance_download_path.txt -``` ---- - -### Step 3 - Add the redirector as a Non-Steam Game - -Next step is to add mo-redirect.exe to Steam as a non-steam game. In Steam, click Games, then "Add a Non-Steam Game to My Library". - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/AddNonSteamGame.png) - -Click Browse, and then adjust the "Look in" and "File type" drop-down menus as in the image below, then click Open: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Redoran/Redoran_NonSteamGameBrowseLookin.png) - -Once added, edit the properties of the new mo-redirect.exe entry. You can give it a more sensible name - I used "Skyrim - Redoran" for example, and then in the Compatibility tab tick the box for 'Force the use of a specific Steam Play compatibility tool', then select the Proton version - I chose Proton 7.0-5 which was the latest stable Proton version at time of writing.. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Redoran/RedoranProtonCompatibility.png) - -**IMPORTANT FOR SD CARD USERS** - You must add the following to the Launch Options for the mo-redirect.exe Non-Steam game, otherwise the Proton environment won't have access to your SD Card contents: - -``` -STEAM_COMPAT_MOUNTS=/run/media/mmcblk0p1 %command% -``` -Like so: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/STEAM_COMPAT_MOUNTS.png) - - -**Click Start on this new Non-Steam Game entry** - it **_will_** fail to load correctly, but we need to launch the entry once so that it registers fully in Steam, and allow Protontricks to interact with it in the next Step. - -Close any error windows, or MO2 if it launched, and move on to the next step. - - ---- - -### Step 4 - Enable Visibility of dot(.) files and folders - -Redoran requires MO2 to point to the vanilla Skyrim install in Steam. To enable this, we need to perform a few steps to allow MO2 visibility of our vanilla Skyrim directory, which will probably exist in your /home/deck/.local directory (this may differ if you have installed vanilla Skyrim to the SD Card or other location). By default, Wine/Proton applications do not have visibility of .(dot) files and folders, so we need to tweak it via Protontricks. - -If you don't already have it installed, ProtonTricks can be installed via the Discover store as a flatpak: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/ProtontricksDiscover.png) - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/ProtontricksDiscoverInstall.png) - -To enable the use of protontricks via the command line, open Konsole if it isn't open already, and run the following command to add an alias: - -``` -echo "alias protontricks='flatpak run com.github.Matoking.protontricks'" >> ~/.bashrc -``` - -then close and reopen Konsole. We can now invoke protontricks from the command line. Next, we need to allow protontricks access to the filesystem location (adjust as needed if you used a different path): - -``` -sudo flatpak override com.github.Matoking.protontricks --filesystem=/home/deck/Games -``` - - -To add the ability to see dot files and folders inside the Proton prefix, open up the Protontricks gui for our Redoran instance (replace "Redoran" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep "Redoran" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:' | tail -1` ; protontricks $APPID --gui - -``` - -Keep the 'default' selection highlighted, and click Next: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/ProtonTricks_wincfg_select_default.png) - -Select the 'winecfg' entry, and click Next. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/ProtonTricks_GUI_winecfg.png) - -This should open up a little windows style Properties box. From there, click the Drives tab at the top, and then check the box for showing 'dot files': - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Protontricks_GUI-dotfiles.png) - -Click Apply and then OK. To exit winecfg, click Cancel, and then cancel again. With this setting now in place, MO2 will have visibility of the required .local directory path to point MO2 at when you first launch it. When running wine commands in Konsole, it usually mangles the terminal a bit - text you type wont be shown (though it technically is still being printed in the terminal) - to get out of that state, either close and reopen Konsole, or just type 'reset' and hit enter, even if you can't see the characters. - ---- - -### Step 5 - Start and Configure ModOrganizer2 - -Click play on Non-steam game - "Skyrim - Redoran" (or whatever you renamed it to) in Steam, and all being well, a little terminal window will appear - this is the steam-redirector doing it's job. If the terminal window just pops up for a second and vanishes, double check the contents of the instance_path.txt and instance_download_path.txt files as above, and that they are present in the correct directory - e.g. /home/deck/Games/Skyrim/Redoran/modorganizer2/instances_path.txt, or check that the Proton version you have selected is 7.0-5 (or whatever the latest Steam-supplied stable version is) and make sure that there are no spaces in the path - for some reason mo-redirect.exe doesn't like that, even if you escape the spaces in the text files. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Redoran/Redoran_MOTerminal.png) - -Depending on the path on Windows that you copied the Modlist files from, you may see an error pop-up about your account lacking permission: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/MO2DownloadsError.png) - -To fix this, we just need to strip the now incorrect download directory from the ModOrganizer.ini file: - -``` -sed -i "/download_directory/c\download_directory =" /home/deck/Games/Skyrim/Redoran/Redoran-WJ/ModOrganizer.ini -``` - -If you had this error, fix as above and then re-run "Skyrim - Redoran" from Steam. - -Another error box will appear, complaining that it "Cannot open instance 'Portable'. This is because we copied the Modlist directory (inclusive of the built-in MO2) from Windows, so the path has changed: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Redoran/Redoran_MO2PortableError.png) - -To fix this, we need to point MO2 to our new location. Click OK, and then Browse. The path we are looking for is: - -``` -/home/deck/.local/share/Steam/steamapps/common/Skyrim Special Edition -``` - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Redoran/Redoran_BrowseToSkyrimBlur.png) - -The splash screen for Redoran should hopefully now display: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Redoran/Redoran_MO2_Splash.png) - -You may also get a pop-up asking if you want to Register for handling nxm links, like so: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/MO2RegisterNXMLinks.png) - -I usually just hit "No, don't ask again" as I wont be downloading any new mods via this version of MO2. - -Getting close now. Next, we have to ensure that ModOrganizer2 is pointing to the correct **new** location for the required executable. In MO2, click the little two-cog icon at the top, which will bring up the Modify Executables window (please note that this icon may differ for some Modlists that use custom icon sets): - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/MO2_Executables_Cog.png) - -For the Redoran executable, we need to point MO2 at a file that doesn't actually exist (but it will exist, once GameRoot does it's thing when you click launch - and is then removed again when the game closes). - -The path you need for the Redoran application will be: - -``` -Z:\home\deck\.local\share\Steam\steamapps\common\Skyrim Special Edition\skse64_loader.exe -``` - -with a 'start in' path of: - -``` -Z:\home\deck\.local\share\Steam\steamapps\common\Skyrim Special Edition -``` - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Redoran/RedoranModifyExecutables.png) - -If you installed vanilla Skyrim to an SD Card, then you will have to replace with the equivalent path in /run/media/mmcblk0p1. - ---- - -### Step 6 - Disable ENB - -While ENB can work under Linux, it is likely going to badly impact performance on the Deck so I would advise you just disable it. However, if you do want to, you can see my guide to do so [here](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki/WIP---ENB-&-Reshade-(In-Progress...)) - -To disable ENB for Redoran, we just need to disable all the mods under the 'ENB - Options' category in MO2: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Redoran/RedoranDisableENBMods.png) - -It's also a good plan to make sure that there are no Game Root leftovers. Click the Tools menu at the top of MO2, then select Tool Plugins, Root Builder, then Clear: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/ClearRootBuilder.png) - ---- - -### Step 7 - Fix Missing Audio - -There is an issue with missing NPC Voices - apparently this is an issue with Proton, so it may ultimately be resolved in time with a newer version of Proton without needing these steps. For now though, we need to install xact and xact_x64 to the Wine/Proton environment Steam created for our "Skyrim - Redoran" (mo-redirect.exe) entry. The easiest way to accomplish this is to use ProtonTricks, which should be installed already from Step 4 earlier in this guide. - -Adding some of the required packages can be done via the ProtonTricks gui, but perhaps the easiest way is via command line. You can run the following one-liner to do it for you, or if you prefer, you can manually run the individual steps noted below (replace "Redoran" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep "Redoran" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:'` ; protontricks $APPID xact xact_x64 -``` - -Alternatively, **If you prefer to run this manually**, first find the AppID of the Non-Steam Game we added for mo-redirect.exe. In a terminal run: - -``` -protontricks -l | grep "Redoran" -``` - -Replace "Redoran" if you have renamed the Non-Steam Game added earlier. The output should look something like below, though your AppID will differ from mine: - -``` -Non-Steam shortcut: Skyrim - Redoran (3595949753) -``` - -With the AppID now known, install the required xact and xact_x64 packages into this Proton environment (use your own AppID from the command above): - -``` -protontricks 3595949753 xact xact_x64 -``` - -This may take a little time to complete, but just let it run the course. Again, when running wine commands in Konsole, it usually mangles the terminal a bit - text you type wont be shown (though it technically is still being printed in the terminal) - to get out of that state, either close and reopen Konsole, or just type 'reset' and hit enter, even if you can't see the characters. - - -### Step 8 - Install VCREDIST2022 - -Next up is the requirement of vcredist2022. Unfortunately this isn't available directly through protontricks as per xact, so we will have to install it semi-manually. The following one-liner should do everything you need (replace "Redoran" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep "Redoran" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:' | tail -1` ; wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O '/home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe' ; protontricks -c 'wine /home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe' $APPID -``` - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/VCRedistInstallStart.png) - -Check the box to agree, and then click install. It should complete quickly. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/VCRedistInstallComplete.png) - -Alternatively, **If you prefer to run this manually**, you can do the following. Firstly, we need to download the vc_redist.x64.exe installer inside the Proton prefix. Run the following command, replacing my Game ID (3595949753) with your own which you can get by running protontricks -l in Konsole: - -``` -wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O /home/deck/.local/share/Steam/steamapps/compatdata/3595949753/pfx/drive_c/vc_redist.x64.exe -``` - -Then we can enter the shell of our Proton environment: - -``` -protontricks 3595949753 shell -``` - -If successful, it should display a little C: prompt in your terminal window. Your terminal may misbehave after running the wine command - you can regain control by typing 'reset', even if you can't see the characters as you type. - -Finally, run the installer: - -``` -wine vc_redist.x64.exe -``` - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/WineShell.png) - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/VCRedistInstallStart.png) - -Check the box to agree, and then click install. It should complete quickly. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/VCRedistInstallComplete.png) - -Again here, when running wine commands in Konsole, it usually mangles the terminal a bit - text you type wont be shown (though it technically is still being printed in the terminal) - to get out of that state, either close and reopen Konsole, or just type 'reset' and hit enter, even if you can't see the characters. - - ---- - -### Step 9 - Set Resolution -Next, we should set the resolution and desired Max FPS so that the deck isn't doing more work than it needs to. There's no point in asking Skyrim to render at 1440p, and then have the game squeezed into an 800p screen on the deck. You can also decide to lock the FPS here, or you can leave it and lock the FPS/Refresh via the Steam Deck itself. To do this in MO2, we can double-click the "SSE Display Tweaks - Config File" mod entry in MO2: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Redoran/Redoran_SSEDisplayTweaks.png) - -Select the "INI Files" tab, click the entry under Ini Files, and then edit in the right pane for your desired resolution and Frame Limit: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Redoran/Redoran_INI_Files.png) - -Finally, click close and then Yes to accept the changes: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Redoran/Redoran_AcceptResolution.png) - ---- - -### Step 10 - Optional but Recommended - -Increase Steam Deck Swap Space, Swappiness and adjust Steam Deck VRAM - -This may be optional, but there have been reports of far better stability and performance after increasing the swap space available to the deck when running Modlists. This is an optional step, but if you are experiencing stability issues, it might be worth investigating. How to do so is outside the scope of this guide, but there is plenty of information available elsewhere on how to do it - [CryoByte33](https://github.com/CryoByte33/steam-deck-utilities) has an excellent set of utilities available on github that can take care of this, and more! - -Personally I have increased the VRAM in the deck bios to 4GB (see [here](https://www.youtube.com/watch?v=od9_a1QQQns&t=1377s) for details), 16GB Swap space, and a Swappiness of 1 - the recommended settings when you run Cryobyte33's Steam Deck Utilities. In fact, the [full video](https://www.youtube.com/watch?v=od9_a1QQQns) of Cryobyte33 explaining what this all means, is definitely worth a watch! - -## Conclusion - -At last! - -If you've read this far, then well done! I'd very much appreciate a Star for this guide, just to show if I'm on the right track. I'm also open to any feedback, positive or negative. - -With NPC Voices fixed, and vcredist2022 installed, we should now be ready! Click the Play button in Mod Organizer, and wait.... - -You may see an error pop-up regarding bink2w64.dll. This is safe to ignore and can also appear on Windows. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Redoran/Redoran_bink2w64dllError.png) - -The game does take quite a bit of time to start. So long, in fact, that I thought it had crashed and I started killing processes etc. But just wait... It took my Steam Deck approximately 3 minutes and 45 seconds before I could interact with the in-game menu. Once it had loaded though, performance was as expected in the menus. - -On Steam Deck, I limit FPS and Refresh rate to 40, and it does a pretty good job at maintaining that in the Redoran Modlist, though I am still testing more performance tweaks. Increasing the size of the swap space available to the deck can definitely help with this. I would love to hear your feedback on performance of various lists, and any tweaks that you made! - -**More performance metrics, including ReShade and ENB performance to be added soon** - -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 ;) - -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! - -Enjoy! - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Redoran/RedoranMenuSuccess.png) \ No newline at end of file diff --git a/Withdrawn:-Skyrim-Septimus.md b/Withdrawn:-Skyrim-Septimus.md deleted file mode 100644 index 8a967eb..0000000 --- a/Withdrawn:-Skyrim-Septimus.md +++ /dev/null @@ -1,404 +0,0 @@ -![Septimus4 Banner](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus/SeptimusBanner.png) - -[Septimus](https://github.com/Lost-Outpost/septimus) _is an extensive modlist full of carefully chosen new gear, spells, quests, and personal touches, all designed to fit seamlessly into the game. It contains optional lightweight survival gameplay and full anniversary edition creation club integration. It is designed to look beautiful while maintaining a stable 60+ framerate on almost any machine._ - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) - -## Instructions - -**The following has been tested on Septimus v1.4.5** - -These steps will need to be carried out in Desktop mode, but once complete you will be able to launch the Modlist and play the game from Game Mode. For the Septimus Modlist, you will need to own the Anniversary Edition of Skyrim, and have launched the vanilla Skyrim game to download the Creation Club content. I also assume that you have set a user password on the Steam Deck. - ---- - -### Step 1 - Create the directory - -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 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/Septimus -``` - -OR - -Create Directory on **SD Card**: -``` -mkdir -p /run/media/mmcblk0p1/Games/Skyrim/Septimus -``` - -(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) - -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 directory to /home/deck/Games/Skyrim/Septimus/Septimus-WJ - the reason for this structure is that it helps if you want to have multiple Modlists installed at the same time. - -**Do not include any spaces in the directory path at this level** - it does not play well with the Proton/mo-redirect/MO2 combination even with the spaces being escaped, for whatever reason.. - -Finally for this step, it's best to make sure that the newly copied files have sufficient permissions for your user. Run **only one** of the following for each action (owner and permissions), depending on where you want to store the Modlist: - -Change the owner and permissions of the directory on **Internal Storage**: -``` -sudo chown -R deck:deck /home/deck/Games/Skyrim/Septimus/Septimus-WJ -``` -``` -sudo chmod -R 755 /home/deck/Games/Skyrim/Septimus/Septimus-WJ -``` - -OR - -Change the owner and permissions of the directory on **SD Card**: -``` -sudo chown -R deck:deck /run/media/mmcblk0p1/Games/Skyrim/Septimus/Septimus-WJ -``` -``` -sudo chmod -R 755 /run/media/mmcblk0p1/Games/Skyrim/Septimus/Septimus-WJ -``` - ---- - -### Step 2 - Steam Redirector - -Next we need a nifty little program called steam-redirector. Information about this program can be found on the github page for the more general [Linux Mod Organizer 2 installation](https://github.com/rockerbacon/modorganizer2-linux-installer) by rockerbacon. You can download a version I have pre-compiled from here (tested on Arch and Fedora but should work on others) using one of the commands below. If you prefer, you can choose to build from source yourself following the instructions provided on the on the [steam-redirector](https://github.com/rockerbacon/modorganizer2-linux-installer/tree/master/steam-redirector) github page. - -To download the version I have pre-built, run **only one** of the following commands in Konsole, depending on your storage location. - -Download the pre-built mo-redirect.exe to **Internal Storage**: -``` -wget https://github.com/Omni-guides/Wabbajack-Modlist-Linux/raw/main/mo-redirect.exe -O /home/deck/Games/Skyrim/Septimus/mo-redirect.exe -``` - -OR - -Download the pre-built mo-redirect.exe to **SDCard**: -``` -wget https://github.com/Omni-guides/Wabbajack-Modlist-Linux/raw/main/mo-redirect.exe -O /run/media/mmcblk0p1/Games/Skyrim/Septimus/mo-redirect.exe -``` - -This mo-redirect.exe is a wrapper app that basically points to the real location of your Modlist's ModOrganizer.exe and nxmhandler.exe. It does this based on the contents of two files that have to live inside a specific directory called modorganizer2. This directory has to exist in the same directory mo-redirect.exe lives. So we need to create a directory, and then create the two files mo-redirect.exe is expecting. - -Run **only one** of the following commands in Konsole, depending on where you are storing the Modlist. - -Create the Directory on **Internal Storage**: -``` -mkdir /home/deck/Games/Skyrim/Septimus/modorganizer2 -``` - -OR - -Create the Directory on **SD Card**: -``` -mkdir /run/media/mmcblk0p1/Games/Skyrim/Septimus/modorganizer2 -``` - -Create the two required files, firstly ModOrganizer.exe. Run **only one** of the following: - -**Internal Storage**: -``` -echo "/home/deck/Games/Skyrim/Septimus/Septimus-WJ/ModOrganizer.exe" > /home/deck/Games/Skyrim/Septimus/modorganizer2/instance_path.txt -``` - -OR - -**SD Card**: -``` -echo "/run/media/mmcblk0p1/Games/Skyrim/Septimus/Septimus-WJ/ModOrganizer.exe" > /run/media/mmcblk0p1/Games/Skyrim/Septimus/modorganizer2/instance_path.txt -``` - -and then nxmhandler.exe. Again, only **run one** of the following: - -**Internal Storage**: -``` -echo "/home/deck/Games/Skyrim/Septimus/Septimus-WJ/nxmhandler.exe" > /home/deck/Games/Skyrim/Septimus/modorganizer2/instance_download_path.txt -``` - -OR - -**SD Card**: -``` -echo "/run/media/mmcblk0p1/Games/Skyrim/Septimus/Septimus-WJ/nxmhandler.exe" > /run/media/mmcblk0p1/Games/Skyrim/Septimus/modorganizer2/instance_download_path.txt -``` - -At this stage, the /home/deck/Games/Skyrim/Septimus directory (or SD Card equivalent) should contain the following two directories and one .exe file: - -``` -modorganizer2 mo-redirect.exe Septimus-WJ -``` - -with the modorganizer2 directory containing the two created files: - -``` -instance_path.txt -instance_download_path.txt -``` ---- - -### Step 3 - Add the redirector as a Non-Steam Game - -Next step is to add mo-redirect.exe to Steam as a non-steam game. In Steam, click Games, then "Add a Non-Steam Game to My Library". - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus/AddNonSteamGame.png) - -Click Browse, and then adjust the "Look in" and "File type" drop-down menus as in the image below, then click Open: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus/AddNonSteamGameBrowse.png) - -Once added, edit the properties of the new mo-redirect.exe entry. You can give it a more sensible name - I used "Skyrim - Septimus" for example, and then in the Compatibility tab tick the box for 'Force the use of a specific Steam Play compatibility tool', then select the Proton version - I chose Proton 7.0-6 which was the latest stable Proton version at time of writing.. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus/SeptimusProtonCompatibility.png) - -**IMPORTANT FOR SD CARD USERS** - You must add the following to the Launch Options for the mo-redirect.exe Non-Steam game, otherwise the Proton environment won't have access to your SD Card contents: - -``` -STEAM_COMPAT_MOUNTS=/run/media/mmcblk0p1 %command% -``` -Like so: - -![Screenshot_20220816_221418](https://user-images.githubusercontent.com/110171124/184987838-3688c045-551d-499a-ac2c-cba4b84255ed.png) - ---- - -### Step 4 - Enable Visibility of dot(.) files and folders - -Click Start on this new Non-Steam Game entry - it **_will probably_** fail to load correctly, but we need to launch the entry once so that it registers fully in Steam, and allow Protontricks to interact with it in the next Step. If it did start Mo2 correctly, close it or any error windows and move on to the next step. - -Septimus requires MO2 to point to the vanilla Skyrim install in Steam. To enable this, we need to perform an extra few steps to be able to point MO2 to our Vanilla Skyrim directory which will probably exist in your /home/deck/.local directory (this may differ if you have installed Vanilla Skyrim to the SD Card or other location). By default, Wine/Proton applications do not have visibility of .(dot) files and folders, so we need to tweak it via Protontricks. - -If you don't already have it installed, ProtonTricks can be installed via the Discover store as a flatpak: - -![image](https://user-images.githubusercontent.com/110171124/183392721-f4ed554a-8bb7-4cc2-a4b9-29c56b8b5a39.png) - -![image](https://user-images.githubusercontent.com/110171124/183392763-f005a96d-4a78-4b7b-9fd1-ba4961126d10.png) - -To enable the use of protontricks via the command line, open Konsole if it isn't open already, and run the following command to add an alias: - -``` -echo "alias protontricks='flatpak run com.github.Matoking.protontricks'" >> ~/.bashrc -``` - -then close and reopen Konsole. We can now invoke protontricks from the command line. Next, we need to allow protontricks access to the filesystem location (adjust as needed if you used a different path): - -``` -sudo flatpak override com.github.Matoking.protontricks --filesystem=/home/deck/Games -``` - - -To add the ability to see dot files and folders inside the Proton prefix, open up the Protontricks gui for our Septimus instance (replace "Septimus" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep "Septimus" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:' | tail -1` ; protontricks --no-bwrap $APPID --gui - -``` - -Keep the 'default' selection highlighted, and click Next: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/ProtonTricks_GUI_winecfg.png) - -Select the 'winecfg' entry, and click Next. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/ProtonTricks_GUI_winecfg2.png) - -This should open up a little windows style Properties box. From there, click the Drives tab at the top, and then check the box for showing 'dot files': - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Protontricks_GUI-dotfiles.png) - -Click Apply and then OK. To exit winecfg, click Cancel, and then Cancel again. With this setting now in place, MO2 will have visibility of the required .local directory path to point MO2 at when you first launch it. - ---- - -### Step 5 - Start and Configure ModOrganizer2 - -Click play on this new entry "Skyrim - Septimus" (or whatever you renamed it to) in Steam, and all being well, a little terminal window will appear - this is the steam-redirector doing it's job. If the terminal window just pops up for a second and vanishes, double check the contents of the instance_path.txt and instance_download_path.txt files as above, and that they are present in the correct directory - e.g. /home/deck/Games/Skyrim/Septimus/modorganizer2/instances_path.txt, or check that the Proton version you have selected is 7.0-6 (or whatever the latest Steam-supplied stable version is) and make sure that there are no spaces in the path - for some reason mo-redirect.exe doesn't like that, even if you escape the spaces in the text files. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus/SeptimusMOTerminal.png) - -Depending on the path on Windows that you copied the Modlist files from, you may see an error pop-up about your account lacking permission: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MO2DownloadsError.png) - -To fix this, we just need to strip the now incorrect download directory from the ModOrganizer.ini file: - -``` -sed -i "/download_directory/c\download_directory =" /home/deck/Games/Skyrim/Septimus/Septimus-WJ/ModOrganizer.ini -``` - -If you had this error, fix as above and then re-run "Skyrim - Septimus" from Steam. - -Another error box will appear, complaining that it "Cannot open instance 'Portable'. This is because we copied the Modlist directory (inclusive of the built-in MO2) from Windows, so the path has changed: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus/SeptimusMO2PortableError.png) - -To fix this, we need to point MO2 to our new location. Click OK, and then Browse. The path we are looking for is: - -``` -Z:\hom\deck\.local\share\Steam\steamapps\common\Skyrim Special Edition -``` - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Dragonborn/DragonbornBrowsetoLocalBlur.png) - -The splash screen for Septimus should hopefully now display: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus/SeptimusMO2Splash.png) - -You may also get a pop-up asking if you want to Register for handling nxm links, like so: - -![image](https://user-images.githubusercontent.com/110171124/185072115-97215185-7237-4973-9674-5281a7daf305.png) - -I usually just hit "No, don't ask again" as I wont be downloading any new mods via this version of MO2. - -Getting close now. Next, we have to ensure that ModOrganizer2 is pointing to the correct **new** location for the required executable. In MO2, click the little two-cog icon at the top, which will bring up the Modify Executables window (please note that this icon may differ for some Modlists that use custom icon sets): - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus/SeptimusModifyExecutablesCog.png) - -For the Septimus executable, we need to point MO2 at a file that doesn't actually exist (but it will exist, once GameRoot does it's thing when you click launch - and is then removed again when the game closes). - -The path you need for the Septimus application will be: - -``` -Z:\home\deck\.local\share\Steam\steamapps\common\Skyrim Special Edition\skse64_loader.exe -``` - -with a 'start in' path of: - -``` -Z:\home\deck\.local\share\Steam\steamapps\common\Skyrim Special Edition -``` - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus/SeptimusModifyExecutables.png) - -If you installed vanilla Skyrim to an SD Card, then you will have to replace with the equivalent path in /run/media/mmcblk0p1. - ---- - -### Step 6 - Disable ENB - -While ENB can work under Linux, it is likely going to badly impact performance on the Deck, so I would advise you to disable it. However, if you do want to, you can see my guide to do so [here](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki/WIP---ENB-&-Reshade-(In-Progress...)) - -To disable ENB for Septimus, we just need to disable the mods under the 'ENB - Options' category in MO2: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus/SeptimusDisableENB.png) - -It's also a good plan to make sure that there are no Game Root leftovers. Click the Tools menu at the top of MO2, then select Tool Plugins, Root Builder, then Clear: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus/SeptimusClearRootBuilder.png) - ---- - -### Step 7 - Fix Missing Audio - -There is an issue with missing NPC Voices - apparently this is an issue with Proton, so it may ultimately be resolved in time with a newer version of Proton without needing these steps. For now though, we need to install xact and xact_x64 to the Wine/Proton environment Steam created for our "Skyrim - Septimus" (mo-redirect.exe) entry. The easiest way to accomplish this is to use ProtonTricks, which should be installed already from Step 4 earlier in this guide. - -Adding some of the required packages can be done via the ProtonTricks gui, but perhaps the easiest way is via command line. You can run the following one-liner to do it for you, or if you prefer, you can manually run the individual steps noted below (replace "Septimus" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep -i "Septimus" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:'` ; protontricks --no-bwrap $APPID xact xact_x64 -``` - -Alternatively, **If you prefer to run this manually**, first find the AppID of the Non-Steam Game we added for mo-redirect.exe. In a terminal run: - -``` -protontricks -l | grep -i "Septimus" -``` - -Replace "Septimus" if you have renamed the Non-Steam Game added earlier. The output should look something like below, though your AppID will differ from mine: - -``` -Non-Steam shortcut: Skyrim - Septimus (3595949753) -``` - -With the AppID now known, install the required xact and xact_x64 packages into this Proton environment (use your own AppID from the command above): - -``` -protontricks 3595949753 xact xact_x64 -``` - -This may take a little time to complete, but just let it run the course. - -### Step 8 - Install VCREDIST2022 - -Next up is the requirement of vcredist2022. Unfortunately this isn't available directly through protontricks as per xact, so we will have to install it semi-manually. The following one-liner should do everything you need (replace "Septimus" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep "Septimus" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:' | tail -1` ; wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O '/home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe' ; protontricks --no-bwrap -c 'wine /home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe' $APPID -``` - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/SeptimusVCRedistInstallStart.png) - -Check the box to agree, and then click install. It should complete quickly. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/SeptimusVCRedistInstallComplete.png) - -Alternatively, **If you prefer to run this manually**, you can do the following. Firstly, we need to download the vc_redist.x64.exe installer inside the Proton prefix. Run the following command, replacing my Game ID (3595949753) with your own which you can get by running protontricks -l in Konsole: - -``` -wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O /home/deck/.local/share/Steam/steamapps/compatdata/3595949753/pfx/drive_c/vc_redist.x64.exe -``` - -Then we can enter the shell of our Proton environment: - -``` -protontricks 3595949753 shell -``` - -If successful, it should display a little C: prompt in your terminal window. Your terminal may misbehave after running the wine command - you can regain control by typing 'reset', even if you can't see the characters as you type. - -Finally, run the installer: - -``` -wine vc_redist.x64.exe -``` - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus4WineShell.png) - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/SeptimusVCRedistInstallStart.png) - -Check the box to agree, and then click install. It should complete quickly. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/SeptimusVCRedistInstallComplete.png) - -When running wine commands in Konsole, it usually mangles the terminal a bit - text you type wont be shown (though it technically is still being printed in the terminal) - to get out of that state, either close and reopen Konsole, or just type 'reset' and hit enter, even if you can't see the characters. - ---- - -### Step 9 - Set Resolution - -Next, we should set the resolution and desired Max FPS so that the deck isn't doing more work than it needs to. There's no point in asking Skyrim to render at 1440p, and then have the game squeezed into an 800p screen on the deck. You can also decide to lock the FPS here, or you can leave it and lock the FPS/Refresh via the Steam Deck itself. To do this in MO2, we can double-click the "SSE Display Tweaks" mod entry in MO2: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/SSEDisplayEditINI.png) - -Select the "INI Files" tab, click the entry under Ini Files, and then edit in the right pane for your desired resolution and Frame Limit: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/SSEDisplayEditResolution.png) - -Finally, click close and then Yes to accept the changes: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus/SeptimusAcceptResolution.png) - ---- - -### Step 10 - Optional but Recommended - -Increase Steam Deck Swap Space, Swappiness and adjust Steam Deck VRAM - -This may be optional, but there have been reports of far better stability and performance after increasing the swap space available to the deck when running Modlists. This is an optional step, but if you are experiencing stability issues, it might be worth investigating. How to do so is outside the scope of this guide, but there is plenty of information available elsewhere on how to do it - [CryoByte33](https://github.com/CryoByte33/steam-deck-utilities) has an excellent set of utilities available on github that can take care of this, and more! - -Personally I have increased the VRAM in the deck bios to 4GB (see [here](https://www.youtube.com/watch?v=od9_a1QQQns&t=1377s) for details), 16GB Swap space, and a Swappiness of 1 - the recommended settings when you run Cryobyte33's Steam Deck Utilities. In fact, the [full video](https://www.youtube.com/watch?v=od9_a1QQQns) of Cryobyte33 explaining what this all means, is definitely worth a watch! - -### Conclusion - -At last! - -If you've read this far, then well done! I'd very much appreciate a Star for this guide, just to show if I'm on the right track. I'm also open to any feedback, positive or negative. - -With NPC Voices fixed, and vcredist2022 installed, we should now be ready! Click the Play button in Mod Organizer, and wait.... This takes quite a bit of time to start. So long, in fact, that I thought it had crashed and I started killing processes etc. But just wait... It took my Steam Deck approximately 3 minutes and 45 seconds before I could interact with the in-game menu. Once it had loaded though, performance was as expected in the menus. - -On Steam Deck, I limit FPS and Refresh rate to 40, and it does a great job at maintaining that in the Septimus Modlist. Enabling the Performance Grass optional mod pushes things up to an average of 53+ FPS, which is great if you want higher FPS at the cost of graphical quality. Increasing the size of the swap space available to the deck can definitely help with this. I would love to hear your feedback on performance of various lists, and any tweaks that you made! - -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 ;) - -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! - -Enjoy! - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus/SeptimusMenuSuccess.png) diff --git a/Withdrawn:-Skyrim-Sovngarde.md b/Withdrawn:-Skyrim-Sovngarde.md deleted file mode 100644 index c5b0959..0000000 --- a/Withdrawn:-Skyrim-Sovngarde.md +++ /dev/null @@ -1,351 +0,0 @@ -![Sovngarde Banner](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Sovngarde/Sovngarde-Logo.png) - -[Sovngarde](https://github.com/Lost-Outpost/sovngarde/) _Sovngarde is a lightweight Legacy of the Dragonborn modlist with a minimal yet beautiful visual overhaul and the highest quality quest content. Included is full creation club support and a suite of balance mods to tie it all together with my own cut of simonrim._ - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) - -## Instructions - -**The following has been tested on Sovngarde v1.0.0** - -This guide only covers getting the Modlist running. It does not cover downloading the Modlist via Wabbajack, or how to copy the Modlist to your Steam Deck/Linux system. - -These steps will need to be carried out in Desktop mode, but once complete you will be able to launch the Modlist and play the game from Game Mode. For Sovngarde, you will need to own the Anniversary Edition of Skyrim, and have launched the vanilla Skyrim game to download the Creation Club content. I also assume that you have set a user password on the Steam Deck. - -Sovngarde only supports Skyrim AE, Anniversary Edition is **not optional**. - ---- - -### Step 1 - Create the directory - -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/Sovngarde -``` - -OR - -Create Directory on **SD Card**: -``` -mkdir -p /run/media/mmcblk0p1/Games/Skyrim/Sovngarde -``` - -(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/mo-redirect/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 directory contents from Windows to the newly created directory on the Deck: /home/deck/Games/Skyrim/Sovngarde/ - -Finally for this step, it's best to make sure that the newly copied files have sufficient permissions for your user. Run **only one** of the following for each action (owner and permissions), depending on where you want to store the Modlist: - -Change the owner and permissions of the directory on **Internal Storage**: -``` -sudo chown -R deck:deck /home/deck/Games/Skyrim/Sovngarde -``` -``` -sudo chmod -R 755 /home/deck/Games/Skyrim/Sovngarde -``` - -OR - -Change the owner and permissions of the directory on **SD Card**: -``` -sudo chown -R deck:deck /run/media/mmcblk0p1/Games/Skyrim/Sovngarde -``` -``` -sudo chmod -R 755 /run/media/mmcblk0p1/Games/Skyrim/Sovngarde -``` - ---- - -### 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". The latest version of Steam should use the regular File Browser from your system, older versions of Steam had a built-in file browser. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Sovngarde/Sovngarde-AddNonSteamGame.png) - -Click Browse: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Sovngarde/Sovngarde-BrowseNonSteamGame.png) - -Browse to the path of your modlist. e.g. /home/deck/Games/Skyrim/Sovngarde, select ModOrganizer.exe, and click Open. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Sovngarde/Sovngarde-AddMO2NonSteamGame.png) - -Once added, edit the properties of the new ModOrganizer.exe entry. You can give it a more sensible name - I used "Skyrim - Sovngarde": - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Sovngarde/Sovngarde-PropertiesNonSteamGame.png) - -Then in the Compatibility tab tick the box for 'Force the use of a specific Steam Play compatibility tool', then select the Proton version - I use Proton 8.0-3 which was the latest stable Proton version provided by Valve at time of writing.. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Sovngarde/Sovngarde-ProtonNonSteamGame.png) - -**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: - -``` -STEAM_COMPAT_MOUNTS=/run/media/mmcblk0p1 %command% -``` -Like so: - -![Screenshot_20220816_221418](https://user-images.githubusercontent.com/110171124/184987838-3688c045-551d-499a-ac2c-cba4b84255ed.png) - ---- - -### Step 3 - Enable Visibility of dot(.) files and folders - -Click Start on this new Non-Steam Game entry - **_it will probably fail to load correctly_**, but we need to launch the entry once so that it registers fully in Steam, which then allows Protontricks to interact with it in the next Step. If it did start Mo2 correctly, close it or any error windows that appeared. - -Sovngarde requires MO2 to point to the vanilla Skyrim install directory in Steam, which is actually in a hidden directory by default (/home/deck/.local/share/Steam/steamapps/common). By default, Wine/Proton applications do not have visibility of .(dot) files and folders, so we need to tweak it via Protontricks. Of course your install path could differ if you have configured your Library differently, and the path will be different if you installed Skyrim to SD Card instead of the internal disk. - -If you don't already have it installed, ProtonTricks can be installed via the Discover store as a flatpak: - -![image](https://user-images.githubusercontent.com/110171124/183392721-f4ed554a-8bb7-4cc2-a4b9-29c56b8b5a39.png) - -![image](https://user-images.githubusercontent.com/110171124/183392763-f005a96d-4a78-4b7b-9fd1-ba4961126d10.png) - -To enable the use of protontricks via the command line, open a Konsole terminal and run the following command to add an alias: - -``` -echo "alias protontricks='flatpak run com.github.Matoking.protontricks'" >> ~/.bashrc -``` - -then close and reopen Konsole. We can now invoke protontricks from the command line. Next, we need to allow protontricks access to the filesystem location (adjust as needed if you used a different path): - -``` -sudo flatpak override com.github.Matoking.protontricks --filesystem=/home/deck/Games -``` - - -To add the ability to see dot files and folders inside the Proton prefix, run the following command in a terminal (replace "Skyrim - Sovngarde" below if you called it something else): - -``` -APPID=`protontricks -l | grep -i "Skyrim - Sovngarde" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:' | tail -1` ; protontricks --no-bwrap -c 'wine reg add "HKEY_CURRENT_USER\Software\Wine" /v ShowDotFiles /d Y' $APPID - -``` - -With this setting now in place, MO2 will have visibility of the required .local directory path to point MO2 at when you first launch it. - ---- - -### Step 4 - Start and Configure ModOrganizer2 - -Click play on this new entry "Skyrim - Sovngarde" (or whatever you renamed it to) in Steam - Depending on the path on Windows that you copied the Modlist files from, you may see an error pop-up about your account lacking permission: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/MO2DownloadsError.png) - -To fix this, we just need to strip the now incorrect download directory from the ModOrganizer.ini file. in Konsole terminal, run: - -``` -sed -i "/download_directory/c\download_directory =" /home/deck/Games/Skyrim/Sovngarde/ModOrganizer.ini -``` - -then re-run "Skyrim - Sovngarde" from Steam. - -Another error box will appear, complaining that it "Cannot open instance 'Portable'. This is because we copied the Modlist directory (inclusive of the built-in MO2) from Windows, so the path has changed: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-MO2PortableError.png) - -To fix this, we need to point MO2 to our new location. Click OK, and then Browse. The path we are looking for is: - -``` -Z:\home\deck\.local\share\Steam\steamapps\common\Skyrim Special Edition -``` - -If you installed vanilla Skyrim to an SD Card or a different Library location, then you will have to browse to that location, or the equivalent SD Card path in /run/media/mmcblk0p1, which will be mounted inside Proton as the E: Drive. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Dragonborn/DragonbornBrowsetoLocalBlur.png) - -The splash screen for Sovngarde should hopefully now appear: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Sovngarde/Sovngarde-MO2Splash.png) - -You may also get a pop-up asking if you want to Register for handling nxm links, like so: - -![image](https://user-images.githubusercontent.com/110171124/185072115-97215185-7237-4973-9674-5281a7daf305.png) - -I usually just hit "Yes" and move on with my life. - -Getting close now. Next, we have to ensure that ModOrganizer2 is pointing to the correct location for the required executable. In MO2, click the little two-cog icon at the top, which will bring up the Modify Executables window (please note that this icon may differ for some Modlists that use custom icon sets): - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/Shared-MO2ExecutablesCog.png) - -For the Sovngarde executable, we need to point MO2 at a file that may not actually exist yet (but it will exist, once GameRoot does it's thing when you click launch - and is then removed again when the game closes). - -The path you need for the Sovngarde application will be: - -``` -Z:\home\deck\.local\share\Steam\steamapps\common\Skyrim Special Edition\skse64_loader.exe -``` - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Sovngarde/Sovngarde-MO2Executables.png) - -If you installed vanilla Skyrim to an SD Card, then you will have to replace with the above with the equivalent path in /run/media/mmcblk0p1. - ---- - -### Step 5 - Disable ENB - -While ENB can work under Linux, it is likely going to badly impact performance on the Deck, so I would advise you to disable it. However, if you do want to, you can see my guide to do so [here](https://github.com/Omni-guides/Wabbajack-Modlist-Linux/wiki/WIP---ENB-&-Reshade-(In-Progress...)) - -To disable ENB for Sovngarde, we just need to disable the mods under the 'ENBSERIES' category in MO2: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Sovngarde/Sovngarde-DisableENB.png) - -We also need to make sure that there are no ENB leftovers from the Rootbuilder function. Click the Tools menu at the top of MO2, then select Tool Plugins, Root Builder, then Clear: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/shared/ClearRootBuilder.png) - ---- - -### Step 6 - Install Required Wine Additions - -There is an issue with missing NPC Voices - apparently this is an issue with Proton, so it may ultimately be resolved in time with a newer version of Proton without needing these steps. For now though, we need to install xact and xact_x64 to the Wine/Proton environment Steam created for our "Skyrim - Sovngarde" entry. Sovngarde also requires Microsoft Visual C++ Redistributable 2022 for some of it's mods. - -The easiest way to install what we need is to use ProtonTricks, which should be installed already from Step 3 earlier in this guide. - -Adding the required packages can be done via the ProtonTricks gui, but perhaps the easiest way is via command line. You can run the following one-liner to do it for you, or if you prefer, you can manually run the individual steps noted below (replace "Skyrim - Sovngarde" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep -i "Skyrim - Sovngarde" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:'` ; protontricks --no-bwrap $APPID xact xact_x64 d3dcompiler_47 d3dx11_43 d3dcompiler_43 -``` - -Alternatively, **If you prefer to run this manually**, see an alternative step-by-step method in the **Additional Notes** section below. - ---- - -### Step 7 - Install VCREDIST2022 - -Next up is the requirement of vcredist2022. Unfortunately this isn't available directly through protontricks as per xact, so we will have to install it semi-manually. The following one-liner should do everything you need (replace "Sovngarde" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep -i "Sovngarde" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:' | tail -1` ; wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O '/home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe' ; protontricks --no-bwrap -c 'wine /home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe /Q' $APPID -``` - ---- - -### Step 8 - Set Resolution - -** !! CONFIRM NEW METHOD !! ** - -Next, we should set the resolution so that the deck isn't doing more work than it needs to. There's no point in asking Skyrim to render at 1440p, and then have the game squeezed into an 800p screen on the deck. To do this in MO2, we can open the INI Editor: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/LegendsOfTheFrost/Frost_INIEditor.png) - -Select the "skyrimprefs.ini" tab, and then edit in the lower pane for your desired resolution: - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/LegendsOfTheFrost/Frost_SetResolution.png) - -Finally, click the Save button and close the window to accept the changes - ---- - -### Step 9 - Optional but Recommended - -Increase Steam Deck Swap Space, Swappiness and adjust Steam Deck VRAM - -This may be optional, but there have been reports of far better stability and performance after increasing the swap space available to the deck when running Modlists. This is an optional step, but if you are experiencing stability issues, it might be worth investigating. How to do so is outside the scope of this guide, but there is plenty of information available elsewhere on how to do it - [CryoByte33](https://github.com/CryoByte33/steam-deck-utilities) has an excellent set of utilities available on github that can take care of this, and more! - -Personally I have increased the VRAM in the deck bios to 4GB (see [here](https://www.youtube.com/watch?v=od9_a1QQQns&t=1377s) for details), 16GB Swap space, and a Swappiness of 1 - the recommended settings when you run Cryobyte33's Steam Deck Utilities. In fact, the [full video](https://www.youtube.com/watch?v=od9_a1QQQns) of Cryobyte33 explaining what this all means, is definitely worth a watch! - -### Conclusion - -At last! - -If you've read this far, then well done! I'd very much appreciate a Star for this guide, just to show if I'm on the right track. I'm also open to any feedback, positive or negative. - -With NPC Voices fixed, and vcredist2022 installed, we should now be ready! Click the Play button in Mod Organizer, and wait.... This takes quite a bit of time to start. Once it had loaded though, performance was as expected in the menus. - -On Steam Deck, I limit FPS and Refresh rate to 40, and it does a pretty good job of maintaining that. If you want absolutely no fluctuations at all, you'd likely have to lock to 30fps, but I find sticking it at 40Hz/FPS, and then turning off the FPS counter lets me just get on with the game, feeling fluid enough that I don't think about the FPS any more. - -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 ;) - -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! - -Enjoy! - -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Sovngarde/Sovngarde-GameMainMenu.png) - - - - ---- - - - - -## Additional Notes - - - -### Install VCREDIST2022 manually step-by-step - -Next up is the requirement of vcredist2022. Unfortunately this isn't available directly through protontricks as per xact, so we will have to install it semi-manually. The following one-liner should do everything you need (replace "Sovngarde" with the name of your Non-steam game entry, if you called it something else): - -``` -APPID=`protontricks -l | grep -i "Sovngarde" | awk {'print $NF'} | sed 's:^.\(.*\).$:\1:' | tail -1` ; wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O '/home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe' ; protontricks --no-bwrap -c 'wine /home/deck/.local/share/Steam/steamapps/compatdata/'"$APPID"'/pfx/drive_c/vc_redist.x64.exe' $APPID -``` - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/SeptimusVCRedistInstallStart.png) - -Check the box to agree, and then click install. It should complete quickly. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/SeptimusVCRedistInstallComplete.png) - -Alternatively, **If you prefer to run this manually**, you can do the following. Firstly, we need to download the vc_redist.x64.exe installer inside the Proton prefix. Run the following command, replacing my Game ID (3595949753) with your own which you can get by running protontricks -l in Konsole: - -``` -wget https://aka.ms/vs/17/release/vc_redist.x64.exe -O /home/deck/.local/share/Steam/steamapps/compatdata/3595949753/pfx/drive_c/vc_redist.x64.exe -``` - -Then we can enter the shell of our Proton environment: - -``` -protontricks 3595949753 shell -``` - -If successful, it should display a little C: prompt in your terminal window. Your terminal may misbehave after running the wine command - you can regain control by typing 'reset', even if you can't see the characters as you type. - -Finally, run the installer: - -``` -wine vc_redist.x64.exe -``` - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/Septimus4WineShell.png) - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/SeptimusVCRedistInstallStart.png) - -Check the box to agree, and then click install. It should complete quickly. - -![image](https://raw.githubusercontent.com/Omni-guides/Jackify/main/Legacy/images/SeptimusVCRedistInstallComplete.png) - -When running wine commands in Konsole, it usually mangles the terminal a bit - text you type wont be shown (though it technically is still being printed in the terminal) - to get out of that state, either close and reopen Konsole, or just type 'reset' and hit enter, even if you can't see the characters. - -### Install wine requirements manually (xact, xact_x64, d3dcompiler_47) - -first find the AppID of the Non-Steam Game we added for mo-redirect.exe. In a terminal run: - -``` -protontricks -l | grep -i "Sovngarde" -``` - -Replace "Sovgarde" if you have renamed the Non-Steam Game added earlier. The output should look something like below, though your AppID will differ from mine: - -``` -Non-Steam shortcut: Skyrim - Sovngarde (3595949753) -``` - -With the AppID now known, install the required xact and xact_x64 packages into this Proton environment (use your own AppID from the command above): - -``` -protontricks 3595949753 xact xact_x64 d3dcompiler_47 vcrun2022 -``` - -This may take a little time to complete, but just let it run the course. Your terminal may misbehave after running the protontricks/wine command - you can regain control by typing 'reset', even if you can't see the characters as you type. - - -