Releases: modio/modio-unity
v2023.5.4 Various bug fixes and optomisations
In this patch we addressed some bugs and added some improvements to the core plugin's performance. The most notable fixes being uploads from Xbox will no longer trim file names and the GetMods request no longer returning zero mods after a search with no results.
Changelog
- Fixed the UI from auto-initializing the plugin if already initialized
- Fixed UI collection view not updating immediately on login
- GetTagCategories will now return hidden tags
- Fixed a visual bug with Unity's free aspect resolutions
- Added mods' tags to the details view for individual mods
- Improved performance for larger web request, particularly GetMods
- Improved performance on larger mod uploads
- Added some caching improvements for requests
- Fixed a caching bug returning zero mods
- Added more accurate disk space checking before mod isntallations
- Various cosmetic fixes to the UI
- Fixed mod uploading while on Xbox from trimming characters in file names
v2023.5.3 URL update and Minor fixes
In this patch we've updated the config and added game specific api domains. If you go into your config file and re-check the button "Insert URL For Production API" it will update the url to the new version (Optional).
We've also addressed an issue when attempting to re-authenticate via email, and getting a 401 error. This has been fixed. As well as some UI related fixes, such as the 'Sort by' dropdown not working in the Search results view, and some other minor cosmetic fixes.
v2023.5.2 Hotfix
This is a quick patch to address some null reference exceptions as well as a fix to make the new input system work.
v2023.5 New Versioning, Features and fixes
With this release comes numerous features and fixes, along with a new versioning convention. We've decided to change to Year.Month.Patch versioning to more clearly define each release.
Breaking changes
Multiple method signatures have changed
- GetMods now returns a ResultAnd object instead of an Action<Result, ModPage>
- (For Nintendo Developers) There are now extra steps in the Nintendo README for setting up the plugin for Switch
- We've removed the ThirdParty/JsonNet dependency. Instead you can now add the Newtonsoft package directly from the Unity Registry in the package manager.
Changelog
- decoupled UnityWebRequest and now using base HttpWebRequests
- Added user ratings displayed in the UI
- Added more filter options in SearchFilter
- The Browser UI now supports the new Input System
- Added SSO with Epic Store
- Enable/Disable feature added to the UI
- Lots of other UI improvements and bug fixes
- Performance improvements
v4.1.0 Additional features and fixes
Some syntaxes and signatures have changed and will likely result in minor fixes if upgrading from an older version.
Main changes include:
- The initializeForUser method is no longer asynchronous and has been removed from ModIOAsync and the callback param removed from ModIOUnity.
- Enable and Disable mods feature added (See ModIOUnity.EnableMod(ModId)), note that this feature only works locally and will not sync across devices.
- GetInstalledModsForUser now has an optional parameter for excluding disabled mods (defaults to true)
- Auto Initialize option added into the config so you no longer need to manually initialize the plugin (Note if you wish to Shutdown and free resources, you will still need to do that manually)
- Added the Mute and Unmute method to ModIOUnity (and async) for supressing specified users.
- Added GetModDependencies() method to ModIOUnity (and async)
- Added a local PDF documentation file inside the plugin folder (modio/Documentation/Full_Documentation.pdf)
- Added an UPGRADING.md guide for additional help transitioning from the old Unity v1 plugin
- Lots of UI improvements and bug fixes
v4.0.8 PlayStation support
In this release we can now officially support PlayStation 4 and 5. If you would like access to the additional files for use with PlayStation please contact us directly, as we can only provide them to authorized developers.
There are also many fixes to the UI, controller support, Translation support and improvements to the underlying plugin.
- PlayStation 4 and 5 support
- Translation support
- UI improvements and optimizations
- Other minor fixes
v4.0.7 Switch Support (and more)
The main feature for this release is the support for Nintendo Switch consoles. If you'd like the additional files for Switch, you'll need to contact the mod.io team directly and show that you are an authorized developer with Nintendo. Among other minor things we have also added functions for Adding and Deleting tags to mod profiles via the plugin, see ModIOUnity.AddTags and ModIOUnity.DeleteTags (And async equivalents). There is also a new method added for convenience called ModIOUnity.GetInstalledModsForUser. This will only give the installed mods for the current user the plugin has been initialized for.
We've also added a delegate in the ModIOBrowser.Broswer class for listening to ModManagement events, for those who would like to use the UI as well as listen to the plugin's events for mod downloads themselves. Refer to ModIOBrowser.Browser.OnModManagementEvent.
We have also dropped the UI support for any version of Unity below 2019.4 as it's not longer in Long Term Support from the Unity Team.
Here are the notable changes in dot point since the previous release:
- Added Nintendo Switch support
- Added AddTags and DeleteTags methods to ModIOUnity and ModIOUnityAsync
- Added ModIOUnity.GetInstalledModsForUser method for convenience
- Added delegate for capturing ModManagement events with the UI Browser
- Fixed an issue with ModIOUnity.GetMods not retrieving custom page sizes
- Improved caching and performance on ModIOUnity.GetMods requests
- Fixed the ExampleInputCapture object to be removable to allow for other input implementations
- Updated README and platform examples
- Fixed 2019 visual bug with download progress
- Dropped all Unity support below 2019.4
- Added feature for checking and postponing downloads if storage space is full
- Several cosmetic fixes for the UI
v4.0.6 GDK Support and UI Fixes
Various UI bug fixes and better support for controller navigation. The UI code now better supports Addressable implementations of the Browser as well.
The plugin (including the UI) is now supported on Xbox GDK. However, due to the GDK being exclusive to approved developers please contact us directly for the additional files required to fully support an Xbox GameCore build. You can speak to a team member on our discord server: https://discord.gg/nm46CNz88e
Note: It is recommended when using the .unitypackage file to update the plugin, completely remove the plugin first.
v4.0.5 IL2CPP support and minor fixes
AOT support is now working when building for windows/standalone (IL2CPP compilation). some missing fields that weren't previously being assigned in ModProfiles are now being properly assigned (eg metadata). README.md has been updated and many more XML comments/docs updated
v4.0.4 Added tags to ModProfile
previously the tags field in the ModProfile was not being set.