v2024.11

UNITY 2020 DEPRECATION

Support for Unity 2020 will be discontinued. We will continue to support it up until the end of January 2025. We strongly recommend you upgrade your version of Unity if you wish to use future releases of mod.io.

New Features

• Meta Quest Integration with authentication and marketplace features (You can find the integration in the plugin at mod.io/Platform/Oculus). Set the compile directive MODIO_OCULUS to enable compilation.
• Log Level can now be set via command line argument: -modio-loglevel , use verbose, message, warning & error as it's potential values.

Changes

• (TemplateUI) Removed log out button from console platform implementations.
• (TemplateUI) Updated lots of sprites to look nicer and be more console compliant.

Deprecating

• Browser UI is undergoing deprecation see the readme for more information.

Fixes

• Fixed an issue causing a corrupted memory stream when importing the 'Experimental UI'.
• Fixed Android disk space checking only working on IL2CPP builds.
• Fixed disk space checking on iOS.
• Fixed a crash when removing a rating on a mod.
• Fixed numerous console errors when importing the 'Experimental UI'.
• (TemplateUI) Fixed mod options doing nothing.
• (TemplateUI) Fixed back button going missing on numerous screens.
• (TemplateUI) Fixed submit button on the report window not being selectable.
• (TemplateUI) Fixed numerous issues related to incorrect glyphs displaying on consoles.
• (TemplateUI) Fixed numerous selection navigation issues.
• (Steam Deck) (TemplateUI) Fixed a steam authentication issue.
• (TemplateUI) Fixed numerous localization issues.
• (Mac) (TemplateUI) Fixed Mod Screen carousel overlapping other UI elements.
• (Steam Deck) (TemplateUI) Fixed an issue preventing symbols from being entered into the email field.
• (TemplateUI) Fixed an intermittent issue with ratings showing incorrect values after rating a mod.
• (TemplateUI) Fixed multiple minor visual issues.

v2024.9

Changes

• Platform headers will now be omitted from web requests if there is no platform set. This is changing from them being sent as null values.

Updates

• Implemented platform examples for iOS & Android for use with CUI.

Bug Fixes

• Fixed timescale issues with UI animations.
• Fixed compilation issues with Steam implementations (both Steamworks & Facepunch).
• Fixed incorrect Steamworks AppId within example.
• Fixed Steamworks Initialization error spam.

v2024.8.0

Changed

• Improved Download Error Handling & Logging

Fixed

• Enable/Disable not always saving correctly
• Image caching & corruption issues

Deprecating

• Browser UI is now undergoing deprecation see the readme for more information.

v2024.7.3

Fixed

• Mobile Platform Support

v2024.7.2

Fixed

• Mobile Platform Support

v2024.7.1

Added

• Support for editing, adding and deleting MetadataKVPs for a Mod using ModioUnity and ModioUnityAsync
• Command line arguments to now support launching a build with preconfigured ServerSettings
• Support for the ping endpoint
• Ability to configure the SettingAsset changes via Project Settings
• Support for temporary mod Sets for multiplayer support
• iOS entitlement Support
• Android entitlement support

Changed

• Networking framework changed from System.Net.Http to UnityWebRequest
• Browser is now PlayStation compliant
• Modfiles to now be cleaned up after install
• Storage checks to account for download and install size

Fixed

• Modfiles being 'lost' in file system
• Browser layout issues
• SettingAsset Serialization errors
• Filtering for multiple items returning 1 result in request
• minor style issues

v2024.3.1p1

Fixed call to GetModMonetizationTeam during every AddMod/EditMod.

v2024.3.1

Many overdue bug fixes have been addressed in this release. There are also additional methods that have been added to accommodate the Marketplace features soon to be released on the mod.io website. You can see the methods inside ModIOUnity, as well as an additional section in the README explaining the new Marketplace methods. Keep in mind these will only work once your game profile has gone through the appropriate setup process on the mod.io website.

v2023.7.1 Multi Device Login via WebSockets

In this release we've added a web socket hook to the mod.io API for authentication. This allows for multi device logins. For example, showing a QR code to a user that they can scan on their phone and login via their mobile device instead (thus eliminating the need for a virtual keyboard on platforms such as VR or consoles. Example usage below). The Browser UI has a QR code method of this implemented.

Deprecating Unity 2019 due to LTS

We are deprecating Unity 2019 as an officially supported version for the plugin, as it is no longer under Long Term Support by Unity. The mod.io plugin will now be officially supported from 2020.3+ onwards.

Changelog

• Added Multi device login (See ModIOUnity.RequestExternalAuthentication - a usage example is provided below)
• Added QR code and multi device login flow to the Browser UI
• Added mod's profile url into the ModProfile object
• Fixed an issue where user ratings weren't being returned correctly
• Fixed an issue with updating comments
• Fixed some bugs with the Browser UI filtering
• Fixed an issue with authenticated sessions getting incorrect platform data for GetMods requests
• Fixed an issue checking remaining disk space on Xbox
• Fixed an issue checking remaining disk space on PlayStation
• Various other minor fixes

External Authentication Example

        public Text messageForUser;

        ExternalAuthenticationToken token;
         
         void Example()
         {
             ModIOUnity.RequestExternalAuthentication(ReceiveToken);
         }
        
         async void ReceiveToken(ResultAnd<ExternalAuthenticationToken> response)
         {
             if (response.result.Succeeded())
             {
                 // Cache the token in case we want to cancel it
                 token = response.value;

                // Show instructions for the user to go and authenticate
                messageForUser.text = $"Go to the following link {token.url} and enter the code {token.code} to login";        

                 // Wait for the user to authenticate externally
                 Result result = await token.task;
        
                 if (result.Succeeded())
                 {
                     Debug.Log("You have successfully authenticated the user");
                 }
                 else
                 {
                     Debug.Log("Failed to authenticate (possibly timed out)");
                 }
             }
             else
             {
                 Debug.Log("Failed to connect to mod.io");
             }
         }
        
         void StopAuthentication()
         {
             token.Cancel();
         }

v2023.6.1 Comments/dependencies and bug fixes

In this patch we've addressed some common bugs reported recently such as slow download speeds and authentication failures. Along with that we've also added the functionality for getting and submitting comments for mods (This is only with the core plugin, this has not been added to the Example UI)

Changelog

• New features
  -- Add Dependencies
  -- Remove Dependencies
  -- Get Comments
  -- Add Comment
  -- Delete Comment
  -- Edit Comment
• Fixed Get Dependencies to work when not logged in
• Fixed an issue throttling download speeds
• Fixed a bug when authenticating
• Fixed total downloaded bytes display text
• Fixed compile errors when using the new input system
• Fixed some bugs when using IL2CPP on later versions of Unity
• Updated documentation pdf
• Minor cosmetic and bug fixes