2024.3

Updates

* New configuration value to allow hiding of mod.io tools in-editor
* New `ListUserGamesAsync` function to retrieve a list of games which
  contain the user as a member of their team
* Improvements to onboarding/setup/Getting Started widget
* Downvoting in the UI will be enabled or disabled based on the game's
  community options

Bugfixes

* Fix a thread-safety issue in input action handlers

Doc/getting-started.adoc

@@ -152,10 +152,10 @@ For more details on the error codes and how to inspect their values, please see
 
 The plugin stores mods in a game-specific directory in the following directory by default:
 
-[stripes=odd,frame=none,cols="1,^1,^1"]
+[stripes=odd,frame=none,cols="1,^1,^1,^1"]
 |===
-| Windows | Linux | OSX
-|`${FolderID_Public}/mod.io` | `${USER_HOME}/mod.io` | `${USER_HOME}/Library/Application Support/mod.io`
+| Windows | Linux | macOS | iOS
+|`${FolderID_Public}/mod.io` | `${USER_HOME}/mod.io` | `${USER_HOME}/Library/Application Support/mod.io` | `${APP-DIRECTORY}/Documents/mod.io`
 |===
 
 However, this value can be overridden in one of two ways:
@@ -174,7 +174,7 @@ Per-game settings are stored in `${FOLDERID_LocalAppData}/mod.io/${GameId}/${mod
 +
 *Adding* a `RootLocalDataPath` element to this file will redirect the mod installation directory for this specific game only, for the current system account. Removing this value will cause the game to revert back to the global value in `globalsettings.json`.
 
-
+NOTE: In Linux, macOS & iOS, mods and data binds to a single user. Every other client would have their own instance in their home directory.
 
 '''
 

README.adoc

@@ -32,7 +32,7 @@ The mod.io plugin is generally maintained to support the 3 most recent versions
 
 ### Platform compatability
 
-The mod.io plugin supports Windows, Linux and Mac as part of the public release.
+The mod.io plugin supports Windows, Linux, iOS and Mac as part of the public release.
 
 For access to Windows (GDK), XBox, Playstation 4, Playstation 5 or Switch, please <<contact-us,(Contact Us)>>.
 

Source/Modio/Modio.Build.cs

@@ -42,14 +42,16 @@ public class PlatformConfig
  public List<string> ModuleDependencies = new List<string>();
  public List<string> SystemLibraryDependencies = new List<string>();
  public List<string> PlatformSourceFolderNames = new List<string>();
+ public List<string> AndroidPluginPropertiesForReceipt = new List<string>();
+
  }
  public Dictionary<string, PlatformConfig> Platforms;
  public List<string> IncludeDirectories;
  public List<string> PlatformSpecificDefines;
  public List<string> ModuleDependencies = new List<string>();
  public List<string> SystemLibraryDependencies = new List<string>();
  };
-#if UE_5_0_OR_LATER
+
  private ModioPlatformConfigFile.PlatformConfig ParseInnerPlatformConfig(JsonObject InnerPlatformObject)
  {
  ModioPlatformConfigFile.PlatformConfig ParsedInnerPlatform = new ModioPlatformConfigFile.PlatformConfig();
@@ -78,14 +80,17 @@ private ModioPlatformConfigFile.PlatformConfig ParseInnerPlatformConfig(JsonObje
  {
  ParsedInnerPlatform.SystemLibraryDependencies = new List<string>(ParsedPlatformSystemLibraryDependencies);
  }
- return ParsedInnerPlatform;
- }
-#endif
+ string[] ParsedAndroidPluginPropertiesForReceipt;
+ if (InnerPlatformObject.TryGetStringArrayField("AndroidPluginPropertiesForReceipt", out ParsedAndroidPluginPropertiesForReceipt))
+ {
+ ParsedInnerPlatform.AndroidPluginPropertiesForReceipt = new List<string>(ParsedAndroidPluginPropertiesForReceipt);
+ }
 
+ return ParsedInnerPlatform;
+ }
 
  private ModioPlatformConfigFile TryLoadPlatformConfig(string PlatformConfigPath)
  {
-#if UE_5_0_OR_LATER
  ModioPlatformConfigFile ParsedConfig = new ModioPlatformConfigFile();
 
  JsonObject PlatformConfigObject = JsonObject.Read(new FileReference(PlatformConfigPath));
@@ -105,10 +110,8 @@ private ModioPlatformConfigFile TryLoadPlatformConfig(string PlatformConfigPath)
  JsonObject PlatformsInnerObject = PlatformConfigObject.GetObjectField("Platforms");
  ParsedConfig.Platforms = PlatformsInnerObject.KeyNames.ToDictionary(x => x, x =>
  ParseInnerPlatformConfig(PlatformsInnerObject.GetObjectField(x)), System.StringComparer.OrdinalIgnoreCase);
+
  return ParsedConfig;
-#else
- return Json.Load<ModioPlatformConfigFile>(new FileReference(PlatformConfigPath));
-#endif
  }
 
  private void InternalLog(string message)
@@ -189,6 +192,7 @@ private ModioPlatformConfigFile.PlatformConfig LoadNativePlatformConfig()
  MergedConfig.PlatformSpecificDefines.AddRange(Platform.Value.PlatformSpecificDefines);
  MergedConfig.ModuleDependencies.AddRange(Platform.Value.ModuleDependencies);
  MergedConfig.SystemLibraryDependencies.AddRange(Platform.Value.SystemLibraryDependencies);
+ MergedConfig.AndroidPluginPropertiesForReceipt.AddRange(Platform.Value.AndroidPluginPropertiesForReceipt);
  bFoundPlatformConfig = true;
  }
  }
@@ -199,7 +203,7 @@ private ModioPlatformConfigFile.PlatformConfig LoadNativePlatformConfig()
  MergedConfig.PlatformSpecificDefines.AddRange(CurrentConfig.PlatformSpecificDefines);
  MergedConfig.ModuleDependencies.AddRange(CurrentConfig.ModuleDependencies);
  MergedConfig.SystemLibraryDependencies.AddRange(CurrentConfig.SystemLibraryDependencies);
- }
+}
  }
  }
  }
@@ -228,9 +232,8 @@ private ModioTestConfigFile LoadTestConfig()
  {
  string TestConfigPath = Path.Combine(ModuleDirectory, "../ThirdParty/NativeSDK/tests", "UnrealTestConfig.json"); 
  if (File.Exists(TestConfigPath))
- {
-#if UE_5_0_OR_LATER
- ModioTestConfigFile ParsedConfig = new ModioTestConfigFile();
+ { 
+ ModioTestConfigFile ParsedConfig = new ModioTestConfigFile();
 
  JsonObject TestConfigObject = JsonObject.Read(new FileReference(TestConfigPath));
  string[] ParsedTestDefines;
@@ -250,9 +253,6 @@ private ModioTestConfigFile LoadTestConfig()
  }
  }
  return ParsedConfig;
-#else
- return Json.Load<ModioTestConfigFile>(new FileReference(TestConfigPath));
-#endif
  }
  else
  {
@@ -444,6 +444,14 @@ private void ApplyNativePlatformConfig(ModioPlatformConfigFile.PlatformConfig Co
  // Add platform-specific include directories
  PrivateIncludePaths.AddRange(Config.IncludeDirectories);
  PublicSystemLibraries.AddRange(Config.SystemLibraryDependencies);
+
+ string pluginPath = Utils.MakePathRelativeTo(ModuleDirectory, Target.RelativeEnginePath);
+
+ InternalLog($"AndroidPluginPropertiesForReceipt is {Config.AndroidPluginPropertiesForReceipt.Count}");
+ foreach (var androidPluginProp in Config.AndroidPluginPropertiesForReceipt)
+ {
+ AdditionalPropertiesForReceipt.Add("AndroidPlugin", Path.Combine(pluginPath, androidPluginProp));
+ }
  }
  private void AddCommonDefinitions()
  {

Source/Modio/ModioAndroid_UPL.xml

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<root xmlns:android="http://schemas.android.com/apk/res/android">
+
+ <!-- init section is always evaluated once per architecture -->
+ <init>
+ <log text="*** [UPL]*** Modio - Android - init"/>
+ </init>
+
+ <!--Android Specific sections-->
+ <!-- optional updates applied to AndroidManifest.xml -->
+ <androidManifestUpdates>
+ <!-- Add permissions -->
+ <log text="*** [UPL]*** Modio - Android - androidManifestUpdates"/>
+ <addPermission android:name="android.permission.READ_EXTERNAL_STORAGE" android:required="true"/>
+ <addPermission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:required="true"/>
+ <addPermission android:name="android.permission.READ_INTERNAL_STORAGE" android:required="true"/>
+ <addPermission android:name="android.permission.WRITE_INTERNAL_STORAGE" android:required="true"/>
+ <addPermission android:name="android.permission.MANAGE_EXTERNAL_STORAGE" android:required="true"/>
+ </androidManifestUpdates>
+
+ <!-- Copy java sources to build sources -->
+ <prebuildCopies>
+ <log text="*** [UPL]*** Modio - Android - prebuildCopies"/>
+ <copyDir src="$S(ProjectDir)/Plugins/Modio/Source/ThirdParty/NativeSDK/platform/android/java/com/modio/modiosdk" dst="$S(BuildDir)/src/com/modio/modiosdk" />
+ </prebuildCopies>
+
+ <resourceCopies>
+ <log text="Copy Cert resources"/>
+ <copyDir src="$S(ProjectDir)/Plugins/Modio/Source/ThirdParty/NativeSDK/platform/android/assets" dst="$S(BuildDir)/assets" />
+ </resourceCopies>
+
+ <!-- Set androidX and jetifier to true for some android versions -->
+ <gradleProperties>
+ <log text="*** [UPL]*** Modio - Android - gradleProperties"/>
+ <insert>
+ android.useAndroidX=true
+ android.enableJetifier=true
+ </insert>
+ </gradleProperties>
+
+ <!-- Import classes in com.modio.modiosdk package -->
+ <gameActivityImportAdditions>
+ <log text="*** [UPL]*** Modio - Android - gameActivityImportAdditions"/>
+ <insert>
+ import com.modio.modiosdk.*;
+ </insert>
+ </gameActivityImportAdditions>
+
+ <compilerArgument>-Xlint:deprecation</compilerArgument>
+</root>

Source/Modio/Private/Internal/Convert/FilterParams.h

@@ -67,6 +67,11 @@ FORCEINLINE Modio::FilterParams::SortFieldType ToModio(EModioSortFieldType Envir
 }
 MODIO_END_CONVERT_SWITCHES
 
+FORCEINLINE Modio::MaturityOption ToModio(EModioMaturityFlags Maturity)
+{
+ return static_cast<Modio::MaturityOption>((uint8) Maturity);
+}
+
 FORCEINLINE Modio::FilterParams ToModio(const FModioFilterParams& In)
 {
  Modio::FilterParams Out;
@@ -100,6 +105,11 @@ FORCEINLINE Modio::FilterParams ToModio(const FModioFilterParams& In)
  Out.RevenueType(ToModio(In.Revenue.GetValue()));
  }
 
+ if (In.Maturity.IsSet())
+ {
+ Out.WithMatureContentFlags(ToModio(In.Maturity.GetValue()));
+ }
+
  return Out.SortBy(ToModio(In.SortField), ToModio(In.Direction))
  .NameContains(ToModio(In.SearchKeywords))
  .MatchingIDs(ToModio<Modio::ModID>(In.IncludedIDs))

Source/Modio/Private/Internal/Convert/GameInfo.h

@@ -9,6 +9,7 @@
  */
 
 #pragma once
+#include "Internal/Convert/GamePlatform.h"
 #include "Internal/Convert/GameStats.h"
 #include "Internal/Convert/HeaderImage.h"
 #include "Internal/Convert/Icon.h"
@@ -39,7 +40,9 @@ FORCEINLINE FModioGameInfo ToUnreal(const Modio::GameInfo& In)
  Out.Theme = ToUnreal(In.Theme);
  Out.Stats = ToUnreal(In.Stats);
  Out.OtherUrls = ToUnreal<FModioOtherUrl>(In.OtherUrls);
+ Out.bAllowNegativeRatings = In.CommunityOptions.HasFlag(Modio::GameCommunityOptions::AllowNegativeRatings);
  Out.GameMonetizationOptions = ToUnreal<EGameMonetizationFlags, Modio::GameMonetizationOptions>(In.GameMonetizationOptions);
+ Out.GameMaturityOptions = ToUnreal<EGameMaturityFlags, Modio::GameMaturityOptions>(In.MaturityOptions);
  Out.VirtualTokenName = ToUnreal(In.VirtualTokenName);
  Out.PlatformSupport = ToUnreal<FModioGamePlatform>(In.PlatformSupport);
 

Source/Modio/Private/Internal/Convert/GameInfoList.h

@@ -0,0 +1,19 @@
+/*
+ * Copyright (C) 2024 mod.io Pty Ltd. <https://mod.io>
+ *
+ * This file is part of the mod.io UE4 Plugin.
+ *
+ * Distributed under the MIT License. (See accompanying file LICENSE or
+ * view online at <https://github.com/modio/modio-ue4/blob/main/LICENSE>)
+ *
+ */
+
+#pragma once
+
+#include "ModioSDK.h"
+#include "Types/ModioGameInfoList.h"
+
+FModioGameInfoList ToUnreal(const Modio::GameInfoList& In)
+{
+ return FModioGameInfoList(In);
+}

Source/Modio/Private/Libraries/ModioFilterParamsLibrary.cpp

@@ -72,3 +72,13 @@ FModioFilterParams& UModioFilterParamsLibrary::MetadataLike(FModioFilterParams&
 {
  return Filter.MetadataLike(SearchString);
 }
+
+FModioFilterParams& UModioFilterParamsLibrary::DisallowMatureContent(FModioFilterParams& Filter)
+{
+ return Filter.DisallowMatureContent();
+}
+
+FModioFilterParams& UModioFilterParamsLibrary::WithMatureContentFlags(FModioFilterParams& Filter, int32 ByMaturity)
+{
+ return Filter.WithMatureContentFlags(static_cast<EModioMaturityFlags>(ByMaturity));
+}

Source/Modio/Private/Libraries/ModioGameInfoListLibrary.cpp

@@ -0,0 +1,21 @@
+/* 
+ * Copyright (C) 2024 mod.io Pty Ltd. <https://mod.io>
+ * 
+ * This file is part of the mod.io UE4 Plugin.
+ * 
+ * Distributed under the MIT License. (See accompanying file LICENSE or 
+ * view online at <https://github.com/modio/modio-ue4/blob/main/LICENSE>)
+ * 
+ */
+
+#include "Libraries/ModioGameInfoListLibrary.h"
+
+const TArray<FModioGameInfo>& UModioGameInfoListLibrary::GetGames(const FModioGameInfoList& GameInfoList)
+{
+ return GameInfoList.GetRawList();
+}
+
+const FModioPagedResult& UModioGameInfoListLibrary::GetPagedResult(const FModioGameInfoList& GameInfoList)
+{
+ return GameInfoList;
+}

Source/Modio/Private/Libraries/ModioOptionalLibrary.cpp

@@ -10,6 +10,7 @@
 
 #include "Libraries/ModioOptionalLibrary.h"
 #include "Types/ModioGameInfo.h"
+#include "Types/ModioGameInfoList.h"
 #include "Types/ModioModDependencyList.h"
 #include "Types/ModioModInfoList.h"
 #include "Types/ModioModTagOptions.h"
@@ -44,6 +45,17 @@ bool UModioOptionalLibrary::GetValue_ModioOptionalModInfoList(const FModioOption
  return GetValueInternal(OptionalModInfoList, ModInfoList);
 }
 
+bool UModioOptionalLibrary::IsSet_ModioOptionalGameInfoList(const FModioOptionalGameInfoList& OptionalGameInfoList)
+{
+ return IsSetInternal(OptionalGameInfoList);
+}
+
+bool UModioOptionalLibrary::GetValue_ModioOptionalGameInfoList(const FModioOptionalGameInfoList& OptionalGameInfoList,
+ FModioGameInfoList& GameInfoList)
+{
+ return GetValueInternal(OptionalGameInfoList, GameInfoList);
+}
+
 bool UModioOptionalLibrary::IsSet_ModioOptionalModInfo(const FModioOptionalModInfo& OptionalModInfo)
 {
  return IsSetInternal(OptionalModInfo);

Source/Modio/Private/Libraries/ModioPlatformHelpersLibrary.cpp

@@ -16,9 +16,13 @@ EModioPlatformName UModioPlatformHelpersLibrary::GetCurrentPlatform()
  return EModioPlatformName::Mac;
  #endif
 
+ #if PLATFORM_IOS
+ return EModioPlatformName::iOS;
+ #endif
+
  #if PLATFORM_LINUX
  return EModioPlatformName::Linux;
-#endif
+ #endif
 
  #if PLATFORM_PS4
  return EModioPlatformName::PS4;
@@ -39,6 +43,10 @@ EModioPlatformName UModioPlatformHelpersLibrary::GetCurrentPlatform()
  #if PLATFORM_SWITCH
  return EModioPlatformName::Switch;
  #endif
+
+ #if PLATFORM_ANDROID
+ return EModioPlatformName::Android;
+ #endif
 }
 
 EModioPortal UModioPlatformHelpersLibrary::GetDefaultPortalForCurrentPlatform()
@@ -59,6 +67,7 @@ EModioPortal UModioPlatformHelpersLibrary::GetDefaultPortalForCurrentPlatform()
  case EModioPlatformName::Switch:
  return EModioPortal::Nintendo;
  case EModioPlatformName::Unknown:
+ case EModioPlatformName::iOS:
  return EModioPortal::None;
  default:
  return EModioPortal::None;

Source/Modio/Private/ModioModule.cpp

@@ -29,6 +29,11 @@
 #include "ISettingsModule.h"
 #endif
 
+#if PLATFORM_ANDROID
+ #include "Android/AndroidApplication.h"
+ extern JavaVM* GJavaVM;
+#endif
+
 #define LOCTEXT_NAMESPACE "FModioModule"
 
 void FModioModule::StartupModule()
@@ -91,6 +96,13 @@ void FModioModule::StartupModule()
  FMessageDialog::Open(EAppMsgType::Ok, LOCTEXT("ThirdPartyLibraryError", "Failed to load example third party
  library"));
  }*/
+
+
+#if PLATFORM_ANDROID
+ Modio::InitializeAndroidJNI(GJavaVM, AndroidJavaEnv::GetClassLoader());
+ Modio::SetGlobalActivity(FAndroidApplication::GetGameActivityThis());
+ Modio::InitializeAndroid();
+#endif
 }
 
 void FModioModule::UnregisterSettings()