2023.3

* EGS authentication is now supported
* ModioCreateModLibrary members are now public
* New "Getting Started" screen added with links to Discord, documentation and more
* NativeSDK updated

Modio.uplugin

@@ -98,6 +98,11 @@
 			"WhitelistPlatforms": [
 				"Linux"
 			]
+		},
+		{
+			"Name": "ModioEditor",
+			"Type": "Editor",
+			"LoadingPhase": "PostEngineInit"
 		}
 	],
 	"LocalizationTargets": [

README.adoc

@@ -76,9 +76,9 @@ To begin using the Plugin, either from Blueprint or from C++, please read our li
 * link:Doc/getting-started.adoc#plugin-quick-start-browsing-available-mods[Mod Browsing]
 * link:Doc/getting-started.adoc#plugin-quick-start-mod-subscriptions-and-management[Mod Subscription Management]
 
-== Example Projects
+== Sample
 
-We provide an example Blueprint implementation of the plugin in a simple demonstration project. You can find the example project https://github.com/modio/modio-ue4-sample[here].
+A UE4.26 and UE4.27-compatible sample is available at link:https://go.mod.io/ue-samples[this location].
 
 == Large studios and Publishers
 A private white label option is available to license, if you want a fully featured mod-platform that you can control and host in-house. mailto:developers@mod.io[Contact us,Whitelabel Inquiry] to discuss.

Source/MSDFSupportEditor/MSDFSupportEditor.build.cs

@@ -140,7 +140,8 @@ public void CopyCommonGeneratedHeaders(string GeneratedHeaderPath)
                 foreach (string HeaderFile in HeaderFiles)
                 {
                     //Add the original file in our upstream repository as a dependency, so if a user edits it we will copy it over
-                    ExternalDependencies.Add(HeaderFile);
+                    //Causes spurious rebuilds for some reason, disabling the dependency for now
+                    //ExternalDependencies.Add(HeaderFile);
                     //Preserve subdirectory structure (msdfgen includes headers via relative paths in a few places, grumble grumble)
                     string RelativeDestinationPath = HeaderFile.Replace(Path.Combine(ModuleDirectory, "../ThirdParty/msdfgen/"), "");
                     string DestinationPath = Path.Combine(GeneratedHeaderPath, RelativeDestinationPath);

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

@@ -37,6 +37,10 @@ FORCEINLINE Modio::AuthenticationProvider ToModio(EModioAuthenticationProvider P
 			return Modio::AuthenticationProvider::Discord;
 		case EModioAuthenticationProvider::PSN:
 			return Modio::AuthenticationProvider::PSN;
+		case EModioAuthenticationProvider::Epic:
+			return Modio::AuthenticationProvider::Epic;
+		case EModioAuthenticationProvider::Oculus:
+			return Modio::AuthenticationProvider::Oculus;
 	}
 
 	return Modio::AuthenticationProvider::Steam;
@@ -53,6 +57,7 @@ FORCEINLINE Modio::AuthenticationParams ToModio(const FModioAuthenticationParams
 		                   ? Modio::Optional<std::string>(ToModio(UnrealParams.UserEmail))
 		                   : Modio::Optional<std::string>();
 	Params.bUserHasAcceptedTerms = UnrealParams.bUserHasAcceptedTerms;
+	Params.ExtendedParameters = ToModio(UnrealParams.ExtendedParameters);
 
 	return Params;
 }

Source/Modio/Private/Internal/ModioConvert.cpp

@@ -27,6 +27,16 @@ std::vector<std::string> ToModio(const TArray<FString>& StringArray)
 	return Result;
 }
 
+std::map<std::string, std::string> ToModio(const TMap<FString, FString>& StringMap)
+{
+	std::map<std::string, std::string> Result;
+	for (const TPair<FString, FString>& It : StringMap)
+	{
+		Result.emplace(std::make_pair(ToModio(It.Key), ToModio(It.Value)));
+	}
+	return Result;
+}
+
 std::chrono::system_clock::time_point ToModioDateTime(FDateTime Time)
 {
 	return std::chrono::system_clock::time_point(std::chrono::system_clock::duration(Time.ToUnixTimestamp()));

Source/Modio/Private/Internal/ModioConvert.h

@@ -39,6 +39,7 @@ struct FModioUnsigned64 ToUnreal(const Modio::FileSize& In);
 
 std::string ToModio(const FString& String);
 std::vector<std::string> ToModio(const TArray<FString>& StringArray);
+std::map<std::string, std::string> ToModio(const TMap<FString, FString>& StringMap);
 std::chrono::system_clock::time_point ToModioDateTime(FDateTime Time);
 Modio::ApiKey ToModio(const FModioApiKey& In);
 Modio::EmailAddress ToModio(const FModioEmailAddress& In);

Source/Modio/Public/Libraries/ModioCreateModLibrary.h

@@ -25,7 +25,7 @@ UCLASS()
 class MODIO_API UModioCreateModLibrary : public UBlueprintFunctionLibrary
 {
 	GENERATED_BODY()
-
+public:
 	UFUNCTION(BlueprintCallable, Category = "mod.io|Create Mod Params")
 	static void SetInitialVisibility(UPARAM(ref) FModioCreateModParams& In, bool InitialVisibility);
 
@@ -55,5 +55,5 @@ class MODIO_API UModioCreateModLibrary : public UBlueprintFunctionLibrary
 
 	UFUNCTION(BlueprintCallable, Category = "mod.io|Create Mod File Params")
 	static void SetModfilePlatforms(UPARAM(ref) FModioCreateModFileParams& In,
-							 UPARAM(ref) TArray<EModioModfilePlatform>& Platforms);
+									UPARAM(ref) TArray<EModioModfilePlatform>& Platforms);
 };

Source/Modio/Public/Types/ModioAuthenticationParams.h

@@ -24,7 +24,9 @@ enum class EModioAuthenticationProvider : uint8
 	Itch,
 	Switch,
 	Discord,
-	PSN
+	PSN, 
+	Epic,
+	Oculus
 };
 
 /** @brief Simple struct to encapsulate data passed to external authentication systems */
@@ -51,4 +53,10 @@ struct MODIO_API FModioAuthenticationParams
 	**/
 	UPROPERTY(BlueprintReadWrite, EditInstanceOnly, Category = "mod.io|Authentication")
 	bool bUserHasAcceptedTerms = false;
+
+	/**
+	 * Stored property of extended parameters required by some providers.
+	 **/
+	UPROPERTY(BlueprintReadWrite, EditInstanceOnly, Category = "mod.io|Authentication")
+	TMap<FString, FString> ExtendedParameters;
 };

Source/ModioEditor/ModioEditor.build.cs

@@ -0,0 +1,25 @@
+/* 
+ *  Copyright (C) 2021 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>)
+ *   
+ */
+
+using UnrealBuildTool;
+using System.IO;
+
+public class ModioEditor : ModuleRules
+{
+	public ModioEditor(ReadOnlyTargetRules Target) : base(Target)
+	{
+        PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;
+
+		PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "UnrealEd", "Blutility", "LevelEditor", "UMGEditor", "UMG", "MainFrame"});
+
+        PublicIncludePaths.AddRange(new string[] { Path.Combine(ModuleDirectory, "Public") });
+        PrivateIncludePaths.AddRange(new string[] { Path.Combine(ModuleDirectory, "Private") });
+	}
+}

Source/ModioEditor/Private/ModioEditor.cpp

@@ -0,0 +1,76 @@
+#include "ModioEditor.h"
+#include "ModioEditorSettings.h"
+
+#if WITH_EDITOR
+	#include "ISettingsModule.h"
+	#include "Modules/ModuleManager.h"
+	#include "EditorUtilityWidgetBlueprint.h"
+	#include "Editor.h"
+	#include "Interfaces/IMainFrameModule.h"
+	#include "EditorUtilitySubsystem.h"
+#endif
+
+DEFINE_LOG_CATEGORY(ModioEditor);
+
+#define LOCTEXT_NAMESPACE "FModioEditor"
+
+void FModioEditor::StartupModule()
+{
+#if WITH_EDITOR
+	if (ISettingsModule* SettingsModule = FModuleManager::GetModulePtr<ISettingsModule>("Settings"))
+	{
+		SettingsModule->RegisterSettings(
+			"Project", "Plugins", "mod.io Editor", LOCTEXT("EditorSettingsName", "mod.io Editor"),
+			LOCTEXT("EditorSettingsDescription", "Configure the mod.io plugin's editor-specific behaviour"),
+			GetMutableDefault<UModioEditorSettings>());
+	}
+	if (GetMutableDefault<UModioEditorSettings>()->bShowGettingStartedOnStartup)
+	{
+		IMainFrameModule& MainFrameModule = IMainFrameModule::Get();
+		if (MainFrameModule.IsWindowInitialized())
+		{
+			DisplayGettingStarted();
+		}
+		else
+		{
+			MainFrameModule.OnMainFrameCreationFinished().AddStatic(&FModioEditor::DisplayGettingStarted_PostMainFrame);
+		}
+	}
+#endif
+}
+
+void FModioEditor::ShutdownModule()
+{
+#if WITH_EDITOR
+	if (ISettingsModule* SettingsModule = FModuleManager::GetModulePtr<ISettingsModule>("Settings"))
+	{
+		SettingsModule->UnregisterSettings("Project", "Plugins", "mod.io Editor");
+	}
+#endif // WITH_EDITOR
+}
+
+void FModioEditor::DisplayGettingStarted_PostMainFrame(TSharedPtr<SWindow>, bool)
+{
+	DisplayGettingStarted();
+}
+
+void FModioEditor::DisplayGettingStarted()
+{
+#if WITH_EDITOR
+
+	UEditorUtilityWidgetBlueprint* Blueprint =
+		GetMutableDefault<UModioEditorSettings>()->GettingStartedWidget.LoadSynchronous();
+
+	if (Blueprint)
+	{
+		if (UEditorUtilitySubsystem* Subsystem = GEditor->GetEditorSubsystem<UEditorUtilitySubsystem>())
+		{
+			Subsystem->SpawnAndRegisterTab(Blueprint);
+		}
+	}
+#endif
+}
+
+#undef LOCTEXT_NAMESPACE
+
+IMPLEMENT_MODULE(FModioEditor, ModioEditor)

Source/ModioEditor/Private/ModioEditorSettings.cpp

@@ -0,0 +1,17 @@
+/*
+ *  Copyright (C) 2021 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 "ModioEditorSettings.h"
+
+UModioEditorSettings::UModioEditorSettings(const FObjectInitializer& Initializer) : Super(Initializer)
+{
+	GettingStartedWidget = TSoftObjectPtr<UEditorUtilityWidgetBlueprint>(
+		FSoftObjectPath("/Modio/GettingStarted/OnboardingGuideWidget.OnboardingGuideWidget"));
+}

Source/ModioEditor/Private/ModioEditorUtilityFunctions.cpp

@@ -0,0 +1,50 @@
+// Fill out your copyright notice in the Description page of Project Settings.
+
+#include "ModioEditorUtilityFunctions.h"
+#include "AssetRegistry/AssetRegistryModule.h"
+#include "CoreGlobals.h"
+#include "Editor.h"
+#include "Modules/ModuleManager.h"
+#include "Templates/UnrealTemplate.h"
+#include "ModioEditorSettings.h"
+#include "LevelEditor.h"
+
+void UModioEditorUtilityFunctions::SelectAssetsInContentBrowser(const TArray<FString>& AssetPaths)
+{
+	TGuardValue<bool> UnattendedScriptGuard(GIsRunningUnattendedScript, true);
+
+	if (GEditor)
+	{
+		TArray<FAssetData> Assets;
+		for (const FString& AssetPath : AssetPaths)
+		{
+			FString FailureReason;
+			FAssetRegistryModule& AssetRegistryModule =
+				FModuleManager::LoadModuleChecked<FAssetRegistryModule>("AssetRegistry");
+			FAssetData Asset = AssetRegistryModule.Get().GetAssetByObjectPath(*AssetPath);
+			if (Asset.IsValid())
+			{
+				Assets.Add(Asset);
+			}
+		}
+		if (Assets.Num() > 0)
+		{
+			GEditor->SyncBrowserToObjects(Assets);
+		}
+	}
+}
+
+void UModioEditorUtilityFunctions::SetDisplayGettingStartedWidgetOnStartup(bool bNewValue) 
+{
+	if (UModioEditorSettings* EditorSettings = GetMutableDefault<UModioEditorSettings>())
+	{
+		EditorSettings->bShowGettingStartedOnStartup = bNewValue;
+		EditorSettings->SaveConfig();
+	}
+}
+
+void UModioEditorUtilityFunctions::OpenTutorialBrowser()
+{
+	FLevelEditorModule& LevelEditorModule = FModuleManager::GetModuleChecked<FLevelEditorModule>(TEXT("LevelEditor"));
+	LevelEditorModule.GetLevelEditorTabManager()->TryInvokeTab(FTabId("TutorialsBrowser"));
+}

Source/ModioEditor/Public/ModioEditor.h

@@ -0,0 +1,21 @@
+#pragma once
+#include "Widgets/SWindow.h"
+#include "Templates/SharedPointer.h"
+
+#include "Modules/ModuleManager.h"
+
+DECLARE_LOG_CATEGORY_EXTERN(ModioEditor, All, All);
+
+class FModioEditor : public IModuleInterface
+{
+	public:
+
+	/* Called when the module is loaded */
+	virtual void StartupModule() override;
+
+	/* Called when the module is unloaded */
+	virtual void ShutdownModule() override;
+	static void DisplayGettingStarted_PostMainFrame(TSharedPtr<SWindow>, bool);
+
+	static void DisplayGettingStarted();
+};

Source/ModioEditor/Public/ModioEditorSettings.h

@@ -0,0 +1,28 @@
+/*
+ *  Copyright (C) 2021 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 "ModioEditorSettings.generated.h"
+
+UCLASS(Config = Editor, defaultconfig)
+class UModioEditorSettings : public UObject
+{
+	GENERATED_BODY()
+public:
+	UModioEditorSettings(const FObjectInitializer& Initializer);
+
+	UPROPERTY(BlueprintReadOnly, EditAnywhere, Config, Category = "modio Editor")
+	bool bShowGettingStartedOnStartup = true;
+
+	UPROPERTY(BlueprintReadOnly, EditAnywhere, Config, Category = "modio Editor")
+	TSoftObjectPtr<class UEditorUtilityWidgetBlueprint> GettingStartedWidget;
+};
+

Source/ModioEditor/Public/ModioEditorUtilityFunctions.h

@@ -0,0 +1,25 @@
+// Fill out your copyright notice in the Description page of Project Settings.
+
+#pragma once
+
+#include "CoreMinimal.h"
+#include "EditorUtilityLibrary.h"
+#include "ModioEditorUtilityFunctions.generated.h"
+
+/**
+ *
+ */
+UCLASS()
+class MODIOEDITOR_API UModioEditorUtilityFunctions : public UEditorUtilityLibrary
+{
+	GENERATED_BODY()
+
+	UFUNCTION(BlueprintCallable, Category = "Modio|EditorUtilities")
+	static void SelectAssetsInContentBrowser(const TArray<FString>& AssetPaths);
+
+	UFUNCTION(BlueprintCallable, Category = "Modio|EditorUtilities")
+	static void SetDisplayGettingStartedWidgetOnStartup(bool bNewValue);
+
+	UFUNCTION(BlueprintCallable, Category = "Modio|EditorUtilities")
+	static void OpenTutorialBrowser();
+};