v2023.7.2

Updates

• NativeSDK updated
• SubmitModChangesAsync now allows the alteration of a mod's tags
• DisplayNamePortal field added to User objects to provide the portal-specific display name for that user

Bugfixes

• Email validation regex had some edge cases not handled properly
• Mod Tags no longer have incorrect caching logic

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

2023.7

Updates

• NativeSDK updated
• UI improvements
  • Added support for localizing Tags in the UI
  • Added support for collapsing tag categories in the UI, including new button binding options
  • Improvements to input glyph display and handling
  • SyntheticCursorMoves are no longer disabled when using the UI
  • Input Glyphs are now shown when using the mouse rather than toggling on and off when using the keyboard
  • Fixed various UI display issues

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

v2023.6

Updates

• NativeSDK updated to 2023.6 release
• Add new SubmitNewModFromMemoryAsync which allows users to submit an in-memory buffer of PNG data as the mod logo
• Add default keyboard keybinds for the Mod Browser

Deprecations

• FModioModInfo::bVisible is now deprecated. Code should be updated to use the new Visibility member which is an enum

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

v2023.5

Updates

• New wizard for uploading a mod directly from the editor
• NativeSDK updated to 2023.5 release
• Improvements to profiling support
• OpenID now supported as an authentication provider for studios with OpenID configured on the mod.io dashboard
• A new extended initialization parameter PlatformOverride allows the use of the Source platform for titles that wish to perform custom cooking on submitted mods for target platforms such as consoles

UI Updates and Polish

• More styling and layout improvements across the entire UI
• Fixed an issue that could cause crashes in async image loading
• Improved focus improvements when navigating with a keyboard or controller
• Improved errors such as timeouts not surfacing correctly to users
• Improved mod details image gallery navigation and display

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

v2023.4

Updates

• NativeSDK updated to 2023.4 release
• Removed deprecated raw ModProgressInfo properties as per their deprecation in 2023.1

Mod Browser

• Stylesheets have been refactored into smaller assets for easier management
• Full controller support for all supported platforms
• Per-platform input hint glyphs
• General polish and improvements

Bugfixes

• Fix a crash on Linux if a malformed response creates an image that can't be loaded by the UI

Breaking Changes

• 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 before we start downloading) will now result in a FModioModProgressInfo object being returned with a state of Initializing. Previously, the Plugin simply wouldn't report a transfer in progress until the size of the transfer had been calculated and data transfer actually started.

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

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.