Skip to content

Latest commit

 

History

History
361 lines (236 loc) · 33.4 KB

CHANGELOG.md

File metadata and controls

361 lines (236 loc) · 33.4 KB

Changelog

v0.6.2 - 2024-10-16

Caution: To update the app, you must completely uninstall the old version, including all mods. Learn More.

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.

Baldur's Gate 3

This version of the app adds Baldur's Gate 3 as the third supported game (#2122). Currently, all 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 them 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 (#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.

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.

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

v0.6.1 - 2024-09-24

Caution: To update the app, you must completely uninstall the old version, including all mods. Learn More.

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

The My Mods and Library pages have been completely reworked to use the new tree view. Mods are now grouped by the mod page on Nexus Mods, meaning if download several files from the same page they will be grouped together. A "Switch View" option has been added to the toolbar to toggle these groupings on or off. We are continuing to work towards to designs shown in the previous changelog.

An image showing mods in the Library nested by mod page (left) or ungrouped (right)

EXPERIMENTAL - Collections

WARNING: The feature is unfinished and not considered stable. It will not accurately install complex collections and is currently only functional for Premium users.

We've included a very early implementation of the Collections feature in this release. It's incomplete and will not install collections as the user has set them up in Vortex. Currently, only mods from Nexus Mods can be installed - anything from external websites or bundled with the collection will not install as expected.

A collection for Cyberpunk 2077 installed into a loadout.

Collections will appear as a separate list of mods in the left menu. Users can view all mods in the loadout from the new "Installed Mods" option at the top of the left menu.

To start out, this will only be available to Premium users, but we are working on the free user journey separately which requires considerably more UI elements to be created. This will be available in a future release.

Cyberpunk 2077 Enhancements

As a further enhancement to support for Cyberpunk 2077, we will now detect if the REDmod DLC is missing and prompt the user to install it if required.

The diagnostic message for REDmod shown in the Health Check.

We've also fixed the issue which prevented REDmod from deploying automatically on Linux. This work also sets up a framework for running Windows apps and tools on a Linux system using Protontricks (#1989).

Known Issues

  • When batch selecting mods in My Mods and using the remove button the app will occasionally fail to remove mods that are not currently visible in the UI due to scrolling.
  • Trying to install a collection with an unsupported type of mod (e.g. Bundled or External) 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 a 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.

Other Features

  • The name of the active loadout will now appear in the top bar (#1953).
  • The app now has a minimum window size of 360x360 to prevent it being resized to unusable dimensions (#1947).

Bugfixes

  • Stardew Valley: Fixed enabled mods showing up as disabled in the diagnostics (#1923).
  • Linux: Fixed the game not launching when running through Steam (#1917).

Technical Changes

  • Added a system for storing and displaying images in the app.

External Contributors

v0.6.0 - 2024-09-03

Caution: To update the app, you must completely uninstall the old version, including all mods. Learn More.

This release enhances support for Cyberpunk 2077, adds multiple Loadouts per game and implements the back-end changes to support our new "Loadout items" data model.

Cyberpunk 2077 Improvements

IMPORTANT: It is not currently possible for the app to run REDmod automatically on Linux - Windows users are unaffected. If you are using REDmods on Linux, you may need to manually run the REDmod.exe file located at tools\redmod\bin\redmod.exe before launching the game.

This version further refines the modding experience for Cyberpunk 2077 players by adding additional diagnostics to the Health Check and automatically running REDmod - if necessary - before starting the game. Learn More.

Multiple Loadouts

Loadouts offer a convenient way to have manage several different mod setups for a single game. Players can easily swap between simple or complex mod setups by creating multiple loadouts. In this release players can create, copy and delete loadouts for any supported game. You can learn more about this feature here.

The "My Loadouts" page showing two loadouts for Cyberpunk 2077

Your mod configuration files for Stardew Valley are synced to the current loadout, so you can have different mod settings for different lists of mods.

EXPERIMENTAL - Tree views for My Mods and Library

We're still working on the new "tree view" for the My Mods and Library pages, but you can preview them in this version by enabling the "Enable tree UI for Library and My Mods" toggle in the app settings. The image below is the current design we are working towards and does not represent what is available in the app.

The design file showing the current plans for tree view

Please be aware that these pages are unfinished and are not stable enough to fully replace the current views, but we are working hard on improving them and hope to start using them in the next release.

Known issues

  • The Downloads page is not working and currently shows a placeholder progress bar.
  • Cyberpunk 2077 - REDmods are not automatically deployed on Linux.

Other Features

  • Updated the My Games page with new tile designs.
  • Game tiles now show a store icon to indicate where the game was downloaded from.
  • It is now possible to delete mods from your Library.
  • Within a Workspace the active panel is now highlighted in the UI.
  • All panels and tabs in Workspace now have a history, allowing the user to navigate forward or backward using the new arrows on the top toolbar.
  • The fonts used in the UI have been updated to Inter in line with our new design system.

Bugfixes

  • Fixed the game icon in the spine flickering when updating a loadout.
  • Reworded the "Update available" pop-up to make it more clear that updating the app requires a full reset of your mod setup.
  • Fixed an issue where Steam games would fail to launch on Ubuntu.

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.
  • 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.

External Contributors

v0.5.3 - 2024-07-11

This release makes some refinements to the Stardew Valley modding experience based on user feedback, improves various UI elements and includes a number of back-end bugfixes.

Fixes

  • Fixed the "SMAPI is disabled"-diagnostic for multiple SMAPI installations (#1674).
  • Fixed Loadout disappearing when applying (#1737).
  • Fixed un-managing a game removing all Loadouts instead of just the ones for the current game (#1738).
  • Fixed sorting in the Mod Library and the "Completed Downloads"-section (#1690).
  • Fixed SVGs not loading and rendering properly in the markdown viewer (#1661).
  • Fixed SVGs throughout the App (#1622, #1681).
  • Fixed not disposing services on close correctly (#1679).
  • Windows: Fixed log file creation failing due to illegal character in path (#1728). Thanks, @ZeeWanderer!
  • Linux: Fixed protocol registration (#1691, #1689, #1683).
  • Linux: Upgraded GameFinder to fix an issue with not being able to find Steam installed as a Flatpak or Snap (#1720).

Cyberpunk 2077 - EXTREMELY EXPERIMENTAL

This version of the app adds Cyberpunk 2077 to the Games section (#1719). We are now actively working on supporting this game but the implementation is still very experimental and may not work for all types of mod. Further improvements are planned for future updates.

Other Features

  • Added support for ignoring game assets when backing up the game files. For Cyberpunk 2077, this can result in 98.75% less disk space used: 1 GB instead of 80 GB (#1713).
  • The logs directory can be opened from the help menu in the top bar (#1675).

Miscellaneous

  • Improved user documentation for Workspaces, Health Checks and Stardew Valley.
  • Reworked protocol registration to set the App as the default on startup (#1691).
  • Reworked out data model to use our new source generator (#1626).
  • Reworked out synchronizer to a simpler 3-way merge approach. (#1707).
  • Began working on adding Loadout Items, Library Items, and reworking Downloads (#1336).
  • This release contains some major changes for package maintainers. See the new docs for details.

External Contributors

v0.5.2 - 2024-06-19

This is a minor release containing many UI improvement and bugfixes. To illustrate all of these changes, here are before and after screenshots of version 0.5.1 and 0.5.2:

Screenshot of the App showing the design of the previous version 0.5.1

Screenshot of the App showing the new design for 0.5.2

Notably is the redesign of the Spine buttons (#1539), the rework of the TopBar (#1580, #1621), and the many improvements to the Settings page including a redesign of the toggle switches (#1549), the combo boxes (#1549), and the addition of sections (#1618). The settings page will continue to evolve over time, but this is already a big step forward.

We've added a banner to the new tab-page to better promote the panel system. You can dismiss the banner manually, or it will be dismissed automatically, if you add a new panel (#1584, #1595):

Screenshot of the App showing the new info banner for adding panels

Other Changes

  • Improved the Mod Library design and usability. Mods can now be added from the library and the installation status will switch if the mod has already been installed (#1543).
  • New messages have been added to the Mod Library and the Mods page when they are empty (#1617).
  • Xbox Game Pass has been disabled until we find a solution to deal with protected Xbox Store binaries. See #1476 and #1477 for details.
  • Missing dependency diagnostic for SMAPI Mods will now show the mod name (#1650).
  • Changed the default open page behavior for the settings page to always open in the "Home" workspace as a new panel (#1598).
  • After logging in via Nexus Mods, the App window will move to the foreground to signal completion of the login process (#1544).
  • The line in the download speed graph will automatically be hidden after 5 seconds of inactivity (#1597).
  • Both the diff and mod file tree will auto-expand the root nodes for better usability (#1593).
  • Renamed "Diagnostics" to "Health Check" (#1586).
  • New documentation has been created for both users and developers (#1624).
  • The updated documentation also includes a new section for package maintainers. Thanks to @l0b0, @MattSturgeon and Abzie we have the first packages appearing for both NixOS and Arch:

Packaging status

Fixes

  • Linux: Fixed the Launch button. Steam and the Game will now start correctly (#1533 and #1151).
  • ToolTip styles have finally been fixed and should appear correctly (#1566, #1592).
  • Fixed an issue where broken data can result in having no panels (#1599, #1526).

External Contributors

v0.5.1 - 2024-06-03

This is a minor release containing bugfixes and small UI improvements.

Fixes

  • Fixed link in the metrics opt-in overlay (#1523, #1524).
  • Fixed the infinite loading screen when previewing apply changes (#1502).
  • Fixed the uninstaller (#1503, #1504).
  • Fixed a silent exception when using an uninitialized value (#1493).
  • Various UI fixes and improvements (#1495, #1517).

v0.5.0 - 2024-05-29

New Features

This release is packed with new features. Configs generated by the game are now ingested into the correct mod, and can be edited using our new Text Editor (#1358, #1346):

Screenshot of the new Text Editor with syntax highlighting.

The text editor uses AvaloniaEdit and comes with syntax highlighting and many features you'd expect a code editor to have. You can even change the theme in the toolbar directly or using our new Settings UI (#396, #920):

Screenshot of the new Settings UI displaying various items with toggles and drop down menus.

Settings have been in the works for a long time, and we've finally developed a system to easily create settings and allow users to change them. The UI will be expanded with sections, a search bar, and many more features in the future.

Our Downloads Page received a lot of attention in this release as well. It now contains a very nice and sleek download speed chart, and a list of completed downloads (#1297, #1397):

Screenshot of the Downloads Page with a new speed chart and a list of completed downloads.

Clicking the "View in library" button will take you to our new Mods Library. Here you can see a list of all mods you've downloaded and installed. You can also quickly add a mod to your Loadout (#1268, #1347):

Screenshot of the new Mod Library showing all downloaded Mods.

The biggest change we've done is completely overhauling our internal data model and moving almost everything to our custom build database called MnemonicDB. The immediate benefit of this change is better faster, the long term benefit is having a reliable database with migrations and opportunities for new and awesome features without being bogged down by our previous data model.

One notable change that the new data model brought to the App is reified deletes.

Other Changes

  • Starting the App for the first time will open a warning about the state of the release. This overlay can be opened again by clicking the help icon in the top bar (#1390).
  • Navigating panels has been made easier. You can now right-click buttons that would create panels, to open up a context menu. Similar to browsers, combinations like Ctrl+Click or Shift+Click also work (#1266).
  • This Changelog can now be viewed directly in the App (#1258).
  • Stardew Valley saves are no longer managed by the App (#1344).
  • Added new Stardew Valley diagnostics:
    • Minimum supported SMAPI version (#1265).
    • Minimum supported Game version (#1265).
    • Mod overwrites game files (#1481).
  • Stardew Valley has a new image (#1393).
  • The "Library" and "Diagnostics" entry on the left menu now show badges with counts for new archives and active diagnostics (#1452).
  • Added a message to an empty Loadout (#1464).
  • Updated mod names for failed installations (#1468).
  • Game Files and the Override Mod are hidden by default, this is controlled using a setting (#1286, #1341).
  • Restrict release build to only having one Loadout (#1416).
  • Restrict release build to only show Stardew Valley (#1401).
  • The CLI and how we handle multiple processes has been reworked (#1345).
  • Logging to the console can be now enabled in the settings, it's disabled by default (#1351).
  • A console window will no longer appear on Windows when starting the App (#1410).
  • Package maintainers can choose to disable the bundled 7z binary (#1308).
  • Loadouts can be removed and games can be un-managed (#1259, #1279).
  • Added an uninstaller (#1383).

Fixes

  • Tons of UI fixes and small visual improvements.
  • The login overlay has been fixed and will now appear correctly again (#1402).
  • Telemetry has been reworked and fixed (#1293).

External Contributors

v0.4.1 - 2024-04-17

New Features

The highlight of this PR is the new Apply Diff View (#1202). You can now preview the changes made to disk before applying the Loadout:

Screenshot of the new Apply Diff View that displays a list of files with different states like "Contents modified" or "Added" as well as file counts for directories and file/directory sizes.

Stardew Valley received three new diagnostics (#1171, #1168). These diagnostics use the current game version and a compatibility matrix to figure out if the currently installed SMAPI version is compatible:

Screenshot of a critical error where the minimum support game version of SMAPI is greater than the currently game version.

Screenshot of a critical error where the maximum supported game version of SMAPI is lower than the currently installed game version.

This also includes our first "suggestion" diagnostic. This diagnostic will only appear if you have no mods installed, and it will recommend a supported SMAPI version:

Screenshot of a suggestion for installing SMAPI to get started with modding Stardew Valley.

Other Changes

  • A new settings backend was added in preparation for a settings UI. See #1182 for more details.
  • The App will now use two logging files, nexusmods.app.main.log and nexusmods.app.slim.log, instead of one nexusmods.app.log to prevent log collisions between processes (#1167).
  • The default logging level has been changed from Information to Debug for Release builds to make it easier to debug issues (#1209).

Fixes

  • Fixed icons clipping in the left menu (#1165, #1169).
  • Windows: Fixed Stardew Valley not launching with a console (#1135, #1205).
  • Linux: Fixed NXM protocol registration when using an AppImage (#1149, #1150).
  • Linux: Fixed whitespace in desktop entry files (#1150, #1152).
  • Linux: Fixed various issues related to launching the game through Steam (#1206, #1151).

External Contributors

0.4 to 0.0.1

This is the end of the CHANGELOG. All previous releases used an auto-generated changelog in the GitHub release.