Releases: modio/modio-ue
v2024.2
Updates
- Documentation updates and improvements
- UI improvements and polish
- Addition of new
UModioSubsystem::SetLanguage
method - calling this as part of your plugin initialization flow will set the language for all REST API calls, eliminating the need to explicitly pass one to methods likeGetTermsOfUseAsync
- NativeSDK updated to 2024.2
Bugfixes
- Profiling support will no longer be enabled in Test configuration as it utilized functionality not available there
Breaking Changes
- Deprecated version of
GetTermsOfUseAsync
has been removed GetTermsOfUseAsync
no longer requires an explicit language parameter
Please use the attached source archive rather than the one automatically generated by Github, to include our submodule dependencies.
v2024.1
NOTE: This release, and all future releases, will no longer support UE 4.2x-5.0 . Please use the 2023.11 release if you wish to use the mod.io plugin on an older version of the engine.
Updates
- Unreal 5.3 Support
- UI Improvements
- NativeSDK updated to 2024.1 release
Breaking Changes
- UE4 content and code removed due to deprecation
- Module changes to reflect UE4 removal - ModioUI5 has been renamed to ModioUI. A redirector has been added to the plugin configuration so this change should be transparent.
Please use the attached source archive rather than the one automatically generated by Github, to include our submodule dependencies.
v2023.11
Updates
- Stability and performance improvements for the UI
- Improved gamepad support within the UE5 UI
- New
PreviewExternalUpdatesAsync
method allows you to see what mods would require update or installation based on external changes the user has made to their subscriptions, so that you can unmount or close open file handles to mod files to allow them to be updated - NativeSDK updated to 2023.11 release
Deprecations
With this release we are stopping active development of our plugin for Unreal Engine versions 4.26, 4.27, and 5.0.
Developers are still able to use our plugin on these versions of Unreal Engine, but no further features will be added.
Please use the attached source archives rather than the one automatically generated by Github, to include our submodule dependencies.
v2023.10
Updates
- NativeSDK updated to 2023.10 release
- Documentation updated
- Improved error surfacing for mod installations
- Improved multi-language support in included fonts
- Keyboard navigation improvements in UI
Bugfixes
- Crashfixes for mod list and tile views
Breaking changes
GetTermsOfUseAsync
no longer requires aEModioAuthenticationProvider
parameter. The old version is deprecated and will be removed from the 2024.1 release
Please use the attached source archives rather than the one automatically generated by Github, to include our submodule dependencies.
v2023.8
New Features
-
Early Access Unreal 5-compatible Mod Browser using CommonUI
- If you are using the Git repository directly, to configure the the Mod Browser for Unreal 5, please follow the steps at the bottom of these release notes.
-
Support for invoking RunPendingHandlers in a background thread
- Please see the Getting Started documentation for information about configuring this feature.
Updates
- Fix errors not correctly showing in the UE4 UI email auth code dialog
- Fixed mod logos in UE4 UI carousels showing at the wrong resolution after navigating into the mod details page
- Improvements to how the UE4 UI displays on widescreen and high resolution screens
- Added missing XBox controller glyphs
- Various controller and keyboard navigation and focus improvements for the UE4 UI
Breaking Changes
- UModioUISubsystem has now been split into two different subsystems: UModioUISubsystem is a subsystem shared between the UE4 and UE5 UI modules, with the UE4-specific code refactored into a new subsystem called UModioUI4Subsystem. If you are calling any UE4-specific UI methods, you will need to update these to use UModioUI4Subsystem instead.
- This plugin now includes configuration files and binary assets for both Unreal 4 and Unreal 5 versions of the Mod Browser.
In the current release the Git repository is preconfigured to use the Unreal 4 Mod Browser. This will change to Unreal 5 in a future release.
If you are using the Git repository directly in your project, to configure the Mod Browser for the desired version of the engine, perform the following steps:
- Unreal Engine 4
- Delete Content/UI5 directory
- Copy Extra/UE4UI/modio.uplugin to the root of the plugin, overwriting the existing file
- Unreal Engine 5
- Copy Extra/UE5UI/modio.uplugin to the root of the plugin, overwriting the existing file
Standalone, preconfigured archives for both UE4 and UE5 are included in this release below.
Please use the attached source archives rather than the one automatically generated by Github, to include our submodule dependencies.
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 newVisibility
member which is an enumPlease 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.