Skip to content

v2023.1

Compare
Choose a tag to compare
@stephenwhittle stephenwhittle released this 02 Feb 05:04
· 24 commits to main since this release

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.