Merge pull request #2136 from Nexus-Mods/docs-update

Update docs for the next release

CHANGELOG.md

@@ -1,9 +1,67 @@
 # Changelog
 
-## [v0.6.1](https://github.com/Nexus-Mods/NexusMods.App/releases/tag/v0.6.1) - 2024-09-24
+## [v0.6.2](https://github.com/Nexus-Mods/NexusMods.App/releases/tag/v0.6.2) - 2024-10-16
 
 # Caution: To update the app, you must completely uninstall the old version, including all mods. [Learn More.](https://nexus-mods.github.io/NexusMods.App/users/faq/#why-do-i-have-to-uninstall-everything-to-update-the-app)
 
+This release adds initial support for Baldur's Gate 3, detects GOG games installed through the Heroic Launcher on Linux and further develops the Collections feature.
+
+**Important: If you are installing the app outside of the default location (Local App Data), the uninstallers for all previous versions may not work correctly. To manually reset your install follow the guide [here](https://nexus-mods.github.io/NexusMods.App/users/Uninstall/#manual-uninstall-fallback).**
+
+### Baldur's Gate 3 
+This version of the app adds Baldur's Gate 3 as the third supported game ([#2122](https://github.com/Nexus-Mods/NexusMods.App/pull/2122)). Currently, most common mod types will be installed correctly. Installations on Steam and GOG can be detected on Windows or Linux. 
+
+The app will display a diagnostic message if a PAK file lists a dependency in the meta.lsx file that is not currently installed. We plan to improve the available data shown to the users in future releases. 
+
+The current implementation does not include load order support. You will need to go to "Mod Manager" from the main menu and enable your mods to have the take effect in the game. Load order support is planned for a future release. 
+
+**Note: When launching the GOG version of the game, the app will currently default to the Vulkan version. A choice between Vulkan and DX11 will be added in a future release. If you require the DX11 version, please launch from GOG Galaxy (Windows), Heroic Launcher (Linux) or via bg3_dx11.exe.**
+
+
+### Heroic Launcher
+Linux users can now manage GOG games installed or imported using the [Heroic Launcher](https://heroicgameslauncher.com/) ([#2103](https://github.com/Nexus-Mods/NexusMods.App/pull/2103)). Due to technical limitations, we've disabled REDmod deployment for Cyberpunk 2077 using Heroic, but it's possible to have the launcher run this process when starting the game. [More Info.](https://nexus-mods.github.io/NexusMods.App/users/games/Cyberpunk2077/#automated-deployment-for-redmods)
+
+### Collections
+**Warning: Collections support is still an experimental feature and may not work as expected. Please check the Known Issues section if you choose to install a collection.**
+
+In this build, we've made further updates to the process of downloading and installing collections. The feature does not have parity with Vortex yet so cannot be used to install a collection fully. 
+
+![The new collections tile available from the "Collections WIP" tab.](./docs/changelog-assets/8ed9a020e1532940c4d57a2753eae55a.webp)
+
+The changes we've made include:
+- Updated the card design for collections (Above).
+- Added support for FOMOD presets and binary patching during installation.
+
+### Updating Mods
+We're starting work on showing when a mod has an update in the app. The backend to enable this feature is mostly complete and we will be adding the UI elements to support it in an upcoming release. 
+
+### Known Issues
+- Most collection installations will not complete successfully. This is due to several features that have not yet been implemented. 
+- The game version is not checked when adding a collection meaning you can install outdated mods without being warned. 
+- Trying to install a collection with an unsupported type of mod (e.g. non-Nexus Mods files) will fail with no error message. This is not supported in the current build.
+- Trying to install a collection as a non-Premium user will fail with no error message. This is not supported in the current build. 
+- Once a collection is added to the app, it cannot be removed from the left menu.
+- Collections allow users to modify the included mods but do not allow you to reset them to the original state. 
+- The first row of the My Mods or Library tables will sometimes be misaligned with the headers. Scrolling or adjusting any column width will correct this. 
+- The "Switch View" option does not persist in the Library/Installed Mods view.
+
+
+### Bugfixes
+- The app will now uninstall correctly when installed outside of the default directory on Windows. 
+- The correct WINE prefix will now be used for games on Linux. 
+- When the numerical badges in the left menu show 3 or more digits, the width of the badge will expand correctly.
+- Fixed an issue where batch actions would not work correctly when adding/removing/deleting mods from the Library or Loadout pages. 
+- The app will no longer re-download the user's avatar image every time a request is made to the Nexus Mods API. 
+
+### External Contributors
+- [@MistaOmega](https://github.com/MistaOmega): [#2118](https://github.com/Nexus-Mods/NexusMods.App/pull/2118), [#2119](https://github.com/Nexus-Mods/NexusMods.App/pull/2119), [#2128](https://github.com/Nexus-Mods/NexusMods.App/pull/2128), [#2130](https://github.com/Nexus-Mods/NexusMods.App/pull/2130)
+- [@Patriot99](https://github.com/Patriot99): [#2145](https://github.com/Nexus-Mods/NexusMods.App/pull/2145)
+- [@Michael-Kowata](https://github.com/Michael-Kowata): [#2163](https://github.com/Nexus-Mods/NexusMods.App/pull/2163)
+
+## [v0.6.1](https://github.com/Nexus-Mods/NexusMods.App/releases/tag/v0.6.1) - 2024-09-24
+
+**Caution: To update the app, you must completely uninstall the old version, including all mods. [Learn More.](https://nexus-mods.github.io/NexusMods.App/users/faq/#why-do-i-have-to-uninstall-everything-to-update-the-app)**
+
 This release adds a very basic implementation of downloading Collections, updates the UI to the new tree view and includes some enhancements when interacting with Windows applications via Linux. 
 
 ### New UI for My Mods and Library
@@ -101,7 +159,7 @@ Please be aware that these pages are unfinished and are not stable enough to ful
 
 ### Technical Changes
 - Downloading files now uses a new "Jobs" system to make them easier to manage. 
-- We are continuing our backend work to convert from "Mods" to "Loadout items". [More Info](https://forums.nexusmods.com/topic/13495763-nexus-mods-app-1-august-progress-update/)
+- We are continuing our backend work to convert from "Mods" to "Loadout items". [More Info.](https://forums.nexusmods.com/topic/13495763-nexus-mods-app-1-august-progress-update/)
 - The synchronizer for handling loadout states has been reworked to provide much more robust coverage of edge cases.
 - Added generic support for path-based diagnostic checks when checking for missing dependencies. 
 
@@ -248,7 +306,7 @@ One notable change that the new data model brought to the App is reified deletes
 - Logging to the console can be now enabled in the settings, it's disabled by default ([#1351](https://github.com/Nexus-Mods/NexusMods.App/pull/1351)).
 - A console window will no longer appear on Windows when starting the App ([#1410](https://github.com/Nexus-Mods/NexusMods.App/pull/1410)).
 - Package maintainers can choose to disable the bundled 7z binary ([#1308](https://github.com/Nexus-Mods/NexusMods.App/pull/1308)).
-- Loadouts can be removed and games can be unmanaged ([#1259](https://github.com/Nexus-Mods/NexusMods.App/pull/1259), [#1279](https://github.com/Nexus-Mods/NexusMods.App/pull/1279)).
+- Loadouts can be removed and games can be un-managed ([#1259](https://github.com/Nexus-Mods/NexusMods.App/pull/1259), [#1279](https://github.com/Nexus-Mods/NexusMods.App/pull/1279)).
 - Added an uninstaller ([#1383](https://github.com/Nexus-Mods/NexusMods.App/pull/1383)).
 
 ### Fixes
@@ -291,7 +349,7 @@ This also includes our first "suggestion" diagnostic. This diagnostic will only
 - Fixed icons clipping in the left menu ([#1165](https://github.com/Nexus-Mods/NexusMods.App/issues/1165), [#1169](https://github.com/Nexus-Mods/NexusMods.App/pull/1169)).
 - Windows: Fixed Stardew Valley not launching with a console ([#1135](https://github.com/Nexus-Mods/NexusMods.App/issues/1135), [#1205](https://github.com/Nexus-Mods/NexusMods.App/pull/1205)).
 - Linux: Fixed NXM protocol registration when using an AppImage ([#1149](https://github.com/Nexus-Mods/NexusMods.App/issues/1149), [#1150](https://github.com/Nexus-Mods/NexusMods.App/issues/1150)).
-- Linux: Fixed whitespaces in desktop entry files ([#1150](https://github.com/Nexus-Mods/NexusMods.App/issues/1150), [#1152](https://github.com/Nexus-Mods/NexusMods.App/pull/1152)).
+- Linux: Fixed whitespace in desktop entry files ([#1150](https://github.com/Nexus-Mods/NexusMods.App/issues/1150), [#1152](https://github.com/Nexus-Mods/NexusMods.App/pull/1152)).
 - Linux: Fixed various issues related to launching the game through Steam ([#1206](https://github.com/Nexus-Mods/NexusMods.App/pull/1206), [#1151](https://github.com/Nexus-Mods/NexusMods.App/issues/1151)).
 
 ### External Contributors

docs/users/Uninstall.md

@@ -36,9 +36,24 @@ This part only applies if you are using Linux, have a portable install or have b
 !!! warning "Caution"
     Manual uninstall should only be used as a fallback if the normal installer is not available. You will need to manually remove any mod files from your game folder(s).
 
-If something goes wrong during uninstall, it may be necessary to remove the app manually. The following steps must be performed manually by the user:
+If something goes wrong during uninstall, it may be necessary to remove the app manually.
 
-1. Inside the App, ensure that all mods for your loadouts in all games are disabled and these changes have been applied. This will remove any files added to the game folder and get the game back to a "vanilla" state. (When possible, you should delete your loadouts).</li>
-2. Close the App. 
-3. Delete the contents of `%LOCALAPPDATA%\NexusMods.App` on Windows or `$XDG_STATE_HOME/NexusMods.App/Logs` and `$XDG_DATA_HOME/NexusMods.App` on Linux to remove all downloaded mods and internal databases used by the app.
-4. Delete the App itself (or uninstall it using the Windows system settings if possible). </li>
+Inside the App, ensure that all mods for your loadouts in all games are disabled and these changes have been applied. This will remove any files added to the game folder and get the game back to a "vanilla" state. (When possible, you should delete your loadouts). Close the app before continuing. 
+
+### Manual Uninstall on Windows
+To reset the app on Windows you will need to empty the contents of `%LOCALAPPDATA%\NexusMods.App`. 
+
+1. Press ++win+"R"++ to open the "Run" command box.
+2. Paste `%LOCALAPPDATA%\NexusMods.App\` into the Open field and press OK.
+3. This will open the correct folder in a File Explorer window.
+4. Delete the contents of this folder. 
+5. Delete the app itself (or uninstall it using the Windows system settings if possible). 
+
+### Manual Uninstall on Linux
+To reset the app on Linux you will need to empty the contents of `$XDG_STATE_HOME/NexusMods.App/Logs` and `$XDG_DATA_HOME/NexusMods.App`.
+
+1. Navigate to your Desktop (on Steam Deck you will need to be in Desktop Mode, which can be found in the power menu).
+2. Open a terminal window (e.g. Konsole)
+3. Paste the following command into the terminal and press ++enter++: `rm -Ird ${XDG_STATE_HOME:-$HOME/.local/state}/NexusMods.App`.
+4. Paste the following command into the terminal and press ++enter++: `rm -Ird ${XDG_DATA_HOME:-$HOME/.local/share}/NexusMods.App`.
+5. Delete the appimage file from your PC. 

docs/users/games/BaldursGate3.md

@@ -1,12 +1,29 @@
-!!! tip "Coming Soon"
-    Baldur's Gate 3 is not supported yet, but will be one of the next games we add to the app. Keep an eye on the [roadmap](https://trello.com/b/gPzMuIr3/nexus-mods-app-roadmap) for updates!
+!!! example "We're working on it"
+    Baldur's Gate 3 support is currently in development. Get involved by joining us on [GitHub](https://github.com/Nexus-Mods/NexusMods.App/issues/new/choose), [Discord](https://discord.gg/ReWTxb93jS) or the [forums](https://forums.nexusmods.com/forum/9052-nexus-mods-app/)!
+
+## Features
+In addition to basic mod management features, players also benefit from these dedicated features:
+
+### Loadout Health Check
+Get information on potential issues in your loadout(s). [Learn more about Health Checks.](../features/HealthCheck.md)
+
+Diagnostics are shown in the following situations: 
+- A mod is installed and requires another mod which is not installed or enabled. This check uses the meta.lsx file inside the PAK. 
+
+### Selective Game Backup
+When managing Baldur's Gate 3 the app will back up only the core game files (default) or the entire game folder. Backing up the whole game requires significantly more hard drive space. This option can be toggled in the :material-cog: Settings menu.
+
 
 ## Compatibility
+!!! warning "Launch options for the GOG version"
+    In 0.6.2 pressing the play button in the app will always launch the Vulkan version of the game. To play the DX11 version please launch the game through GOG Galaxy (Windows), Heroic Launcher (Linux) or via `bin\bg3_dx11.exe`. 
+
 This game can be managed via the app on the following operating systems and platforms. The application will automatically detect valid installations from supported game stores if possible. 
 
 || :fontawesome-brands-windows: Windows |  :fontawesome-brands-linux: Linux | :fontawesome-brands-apple: macOS |
 |---|---|---|---|
 | :fontawesome-brands-steam: [Steam](https://store.steampowered.com/app/1086940/Baldurs_Gate_3/) | :material-check-circle: | :material-check-circle: | :material-close-thick: |
-| <img src="../../images/GOG.com_logo_white.svg" alt="GOG" width="14"/> [GOG](https://www.gog.com/en/game/baldurs_gate_iii) | :material-check-circle:[^1] | :material-close-thick:[^1] | :material-close-thick: |
+| <img src="../../images/GOG.com_logo_white.svg" alt="GOG" width="14"/> [GOG](https://www.gog.com/en/game/baldurs_gate_iii) | :material-check-circle:[^1] | :material-check-circle:[^1][^2] | :material-close-thick: |
 
-[^1]: Offline backup installs from GOG.com cannot be detected automatically.
+[^1]: Offline backup installs from GOG.com cannot be detected automatically.
+[^2]: [Heroic Launcher](https://heroicgameslauncher.com/) is required. 

docs/users/games/Cyberpunk2077.md

@@ -25,6 +25,11 @@ Diagnostics are shown in the following situations:
 
 ### Automated deployment for REDmods
 
+??? info "REDmod with Heroic Launcher (Linux)"
+    The app cannot run REDmod deployment automatically for users who have installed Cyberpunk 2077 through Heroic Launcher on Linux. To run REDmod in Heroic, ensure the "Enable Mods" checkbox is enabled under "Modify Installation". This will mean REDmods are deployed by Heroic Launcher before the game starts.
+    ![The option to "Modify Installation" is under the options menu when viewing a game in Heroic Launcher](../images/0.6.1/REDmodHeroicModifyInstall.webp)
+    ![The option to "Enable Mods" is under "REDmod Integration" in Heroic Launcher](../images/0.6.1/REDmodHeroicEnableMods.webp) 
+
 When mods using the official REDmod system are installed, it may be necessary to run the the REDmod tool. The app will detect when this is necessary and run it automatically before starting the game. 
 
 ### Selective Game Backup
@@ -36,7 +41,8 @@ This game can be managed via the app on the following operating systems and plat
 || :fontawesome-brands-windows: Windows |  :fontawesome-brands-linux: Linux | :fontawesome-brands-apple: macOS |
 |---|---|---|---|
 | :fontawesome-brands-steam: [Steam](https://store.steampowered.com/app/1091500/Cyberpunk_2077/) | :material-check-circle: | :material-check-circle: | :material-close-thick: |
-| <img src="../../images/GOG.com_logo_white.svg" alt="GOG" width="14"/> [GOG](https://store.steampowered.com/app/1091500/Cyberpunk_2077/) | :material-check-circle:[^1] | :material-close-thick:[^1] | :material-close-thick: |
+| <img src="../../images/GOG.com_logo_white.svg" alt="GOG" width="14"/> [GOG](https://store.steampowered.com/app/1091500/Cyberpunk_2077/) | :material-check-circle:[^1] | :material-check-circle:[^1][^2] | :material-close-thick: |
 | <img src="../../images/epic-games.svg" alt="Epic Games Store" width="14"/> [Epic Games Store](https://store.epicgames.com/en-US/p/cyberpunk-2077) | :material-check-circle: | :material-close-thick: | :material-close-thick: |
 
 [^1]: Offline backup installs from GOG.com cannot be detected automatically.
+[^2]: [Heroic Launcher](https://heroicgameslauncher.com/) is required. 

docs/users/games/StardewValley.md

@@ -42,10 +42,11 @@ This game can be managed via the app on the following operating systems and plat
 || :fontawesome-brands-windows: Windows |  :fontawesome-brands-linux: Linux | :fontawesome-brands-apple: macOS |
 |---|---|---|---|
 | :fontawesome-brands-steam: [Steam](https://store.steampowered.com/app/413150/Stardew_Valley/) | :material-check-circle: | :material-check-circle:[^1] | :material-close-thick: |
-| <img src="../../images/GOG.com_logo_white.svg" alt="GOG" width="14"/> [GOG](https://www.gog.com/en/game/stardew_valley) | :material-check-circle: | :material-close-thick:[^2] | :material-close-thick: |
+| <img src="../../images/GOG.com_logo_white.svg" alt="GOG" width="14"/> [GOG](https://www.gog.com/en/game/stardew_valley) | :material-check-circle: | :material-check-circle:[^2][^4] | :material-close-thick: |
 | :fontawesome-brands-xbox: [Xbox Game Pass (PC)](https://www.xbox.com/en-GB/games/store/stardew-valley/c3d891z6tnqm) | :material-close-thick:[^3] | :material-close-thick: | :material-close-thick: |
 | <img src="../../images/wegame.svg" alt="WeGame" width="14"/> [WeGame (China only)](https://www.wegame.com.cn/store/2000064/Stardew_Valley) | :material-close-thick: | :material-close-thick: | :material-close-thick: |
 
 [^1]: Native Linux only. Proton is not supported.
 [^2]: Offline backup installs from GOG.com cannot be detected automatically.
 [^3]: Xbox Game Pass for PC is not yet supported. <a href="https://github.com/Nexus-Mods/NexusMods.App/issues/1476">More.</a>
+[^4]: [Heroic Launcher](https://heroicgameslauncher.com/) is required. 

docs/users/games/index.md

@@ -9,7 +9,7 @@ The following games are currently supported. Click on the game icon to learn mor
 <img src="https://github.com/Nexus-Mods/NexusMods.App/blob/main/src/Games/NexusMods.Games.RedEngine/Resources/Cyberpunk2077/icon.png?raw=true" style="max-width:150px" title="Cyberpunk 2077" alt="Cyberpunk 2077">
 </a>
 <a href="./BaldursGate3">
-<img src="https://github.com/Nexus-Mods/NexusMods.App/blob/main/src/Games/NexusMods.Games.Larian/BaldursGate3/Resources/icon.png?raw=true" style="max-width:150px" title="Baldur's Gate 3" alt="Baldur's Gate 3">
+<img src="https://github.com/Nexus-Mods/NexusMods.App/blob/main/src/Games/NexusMods.Games.Larian/Resources/BaldursGate3/icon.png?raw=true" style="max-width:150px" title="Baldur's Gate 3" alt="Baldur's Gate 3">
 </a>
 
 

mkdocs.yml

@@ -61,6 +61,8 @@ nav:
     - System Requirements: users/SystemRequirements.md
     - Getting Started: users/GettingStarted.md
     - Adding a Game: users/AddGames.md
+    # - Mod Library: users/Library.md
+    # - Installed Mods: users/InstalledMods.md
     - Features: 
       - Loadouts: users/features/Loadouts.md
       - Health Check: users/features/HealthCheck.md