v2023.3

Updates

• EGS authentication is now supported
• ModioCreateModLibrary members are now public
• New "Getting Started" screen added with links to Discord, documentation and more
• New Tutorial Blueprints covering some Plugin basics
• NativeSDK updated

Please use the attached source archive rather than the one automatically generated by Github, to include our submodule dependencies.

v2023.2

Updates

• Support for linking against platform-specific library dependencies added for better console platform support
• NativeSDK updated
• Internal warnings related to the deprecation of the old ModProgressInfo interface should not be triggered when building the plugin now
• Long mod names should be truncated in the UI
• Added method for hiding the mod browser rather than destroying it
• Status badges on mod tiles now update and show progress more accurately
• Clicking on items in the Download Queue will now go to the Mod Details page
• Additional stability and performance improvements for the UI on UE4.26 and UE4.27

Please use the attached source archive rather than the one automatically generated by Github, to include our submodule dependencies.

v2023.1.1

Updates

• Remove redundant vendored function2 now the SDK provides its own
• MSDFGen is now only a dependency of the MSDFSupportEditor module
• Core module changes for 5.1 support on Windows
• NativeSDK updated to 2023.1.1 hotfix
• Documentation and build system improvements

Please use the attached source archive rather than the one automatically generated by Github, to include our submodule dependencies.

v2023.1

New release naming convention and deprecation policy

Please note from this release onwards we will be using the YYYY.M.rev format for release names/versions. This change is intended to allow for greater clarity regarding deprecations or upcoming breaking changes.
We will endeavour to maintain deprecated functionality for two monthly releases after the deprecation is announced. For example, code deprecated in the 2023.1 release will be maintained until 2023.3 and may be removed in any release from 2023.4 onwards.

Updates

• ListUserCreatedModsAsync added, allowing mods that a user has submitted to be queried
• MuteUserAsync/UnmuteUserAsync/GetMutedUsersAsync added, allowing users to request that mod.io hide mods created by the specified user.
• Added PSN as an external authentication method
• Added support for editing Mod Logos when editing a mod
• Cleanup of some issues with symlinks in third party submodules on OSX
• Un-broke non-unity builds by adding some missing headers (thanks Philbax)
• UI Improvements
  • ModioUISettings data has been moved to the Game config file to work around some issues with Plugins not loading custom config files correctly.
  • Featured Mod Carousel now displays mod logos at a fixed resolution of 1280x720 rather than 320x180
  • mod.io Terms of Use are now shown correctly when a user performs single-sign-on/external authentication through the UI
  • Mod Details image widgets should show an animated loading material while fetching images from the mod.io servers
  • Mod Details image gallery widget should now accept controller input for navigation between images
  • new UModioUISubsystem::CloseModBrowserUI() method which will correctly tear down the mod browser and remove it from display
  • Added a SoundMix and SoundClass to allow the volume of the mod.io UI audio to be controlled
  • Localization improvements

Deprecations in this release

• The public members on FModioModProgressInfo have been deprecated in favour of GetCurrentProgress, GetTotalProgress and GetCurrentState methods. This change means that users no longer have to intuit the state of a mod upload or download by inspecting the values of the FModioModProgressInfo object and doing a comparison between current and total values.
  It also means that the object is now explicit in indicating if the operation is an upload or a download rather than relying on context from ModManagementEvents or similar.

  As a result of these changes, in a forthcoming release where the deprecated members are removed, a file transfer that is starting, but relies on a REST API call to begin reporting progress (for example, a file transfer that requires us to fetch the file size) will result in a FModioModProgressInfo object being returned with a state of Initializing. This will be a change from the current behaviour where the Plugin simply doesn't return a FModioModProgressInfo object until that file size has been calculated. This change will be listed as a breaking change in the release notes.

Breaking Changes

• ModioUISettings config values have been moved to the Game config file that ships with the plugin. If you have customized these settings you will need to copy them from your old config to the new location.

v2.24.2306

• Hotfix release to address a crash caused by some new Mod Management events that were missing conversions
• Mod Management will now also emit the following events at the start of a mod management operation:
  • BeginInstall
  • BeginUninstall
  • BeginUpdate
  • BeginUpload

Please use the attached source archive rather than the one automatically generated by Github, to include our submodule dependencies.

v2.23.2306

• UI improvements:

  • Fix a crash when logging out with active downloads
  • Better handling for users logging out while Mod Browser is open
  • First pass on fixing SFxWidget render transforms
    • Should address UE5 featured mod carousel rendering issues on Windows and Linux, OSX fixes still to come
  • Add a number of UE5-specific styling tweaks to some widgets
  • Preliminary support for audio feedback on widgets
  • Further support for keyboard and controller navigation

• NativeSDK updated

• Editor sessions of the Plugin will now automatically perform a pseudo-blocking shutdown when PIE closes, if the Plugin was initialized during PIE, emitting a warning so developers know they should be shutting it down themselves. This will make it easier to test Plugin functionality in a scenario where you are repeatedly running PIE sessions in a single Editor session.

• Breaking Changes

  • GetProjectInitializeOptions had some Windows-specific behaviour that was not easily generalized to all our supported platforms, namely, only on Windows, there was a default session ID derived from the SID of the currently-logged in user. Moving forward, we are removing this functionality in favour of an explicit session ID provided by developers on all platforms.
    This means the following changes have been made:

    • GetProjectInitializeOptions has been deprecated in favour of GetProjectInitializeOptionsForSessionId. This new method is very similar to the existing function, but requires an explicit session ID to be provided by the developer.
    • GetProjectInitializeOptions will still function, and will populate the Session ID automatically on Windows as before, but is now marked deprecated.
    • New titles should use GetProjectInitializeOptionsForSessionID and pass in an explicit profile identifier on all platforms.

Please use the attached source archive rather than the one automatically generated by Github, to include our submodule dependencies.

v2.22.2124

• Early Access UE5 support
  ** Mod Browser UI is still WIP, but core functionality through UModioSubsystem is fully available
• QueryCurrentModUpdate improvements on non-Windows platforms - FModioModProgressInfo objects should be more accurate
• NativeSDK Updated
  ** Zip64 support is now included
• Bugfixes and improvements to the Mod Browser UI

Please use the attached source archive rather than the one automatically generated by Github, to include our submodule dependencies.

v2.21.2070

• NativeSDK Updated
• Featured and Category widgets will now show error retry widgets
  correctly in the UI
• Improved support for external authentication in the UI
• UI Documentation updates
• Plugin now correctly adds explicit platforms to all modules in
  descriptor

Breaking Changes:

• ForceUninstallModAsync is now a pure native method in line with the
  other functions on the UModioSubsystem. Please use
  K2_ForceUninstallModAsync in blueprints, you will need to delete and
  re-place the node for your blueprints to compile.

Please use the attached source archive rather than the one automatically generated by Github, to include our submodule dependencies.

v2.20.2048

• Implemented UModioSubsystem::SubmitModChangesAsync allowing you to edit mod name, description, etc
• Implemented UModioSubsystem::PrioritizeTransferForMod allowing you to request a transfer begin immediately, bumping the current transfer back to the queue
• Expose FModioCreateModParams and FModioCreateModFileParams to Blueprint
• Minor UI updates
• UE4.27 compatibility improvements
• Improve support for non-unity builds
• Update NativeSDK

Please use the attached source archive rather than the one automatically generated by Github, to include our submodule dependencies.

v2.19.1919

• Alpha release of Mod Browser UI modules
  ** Please see the documentation for configuration steps, initialization, and basic customization
• Add AlreadyAuthenticated error condition
• Update NativeSDK

Please use the attached source archive rather than the one automatically generated by Github, to include our submodule dependencies.