SSO/External authentication
Nintendo Switch
PlayStation™ Network
+PlayStation™Network
Steam
@@ -2367,12 +2393,15 @@SSO/External authentication
Xbox Live
Oculus
+OpenID
-
When you are ready to initialize the plugin for the current user, you’ll need to call InitializeAsync, passing in an instance of FModioInitializeOptions, and a delegate so you know when the plugin is initialized correctly. Here, you can specify your Game ID, API Key, Environment, and Portal. You can get the default portal for the current platform using Get Default Portal for Current Platform function.
When you are ready to initialize the plugin for the current user, you’ll need to call InitializeAsync, passing in an instance of FModioInitializeOptions, and a delegate so you know when the plugin is initialized correctly. Here, you can specify your Game ID, API Key, Environment, and Portal. You can get the default portal for the current platform using Get Default Portal for Current Platform function.
@@ -2358,7 +2384,7 @@
-
+
+
-
Please note that the ability to authenticate players using OpenID is feature for advanced partners only. If you are interested in becoming an advanced partner, please contact developers@mod.io
+Please note that the ability to authenticate players using OpenID is a premium feature. If you are interested in mod.io premium features, please contact developers@mod.io.
To use SSO with mod.io, a user must have accepted the mod.io Terms of Use in order to create an account.
@@ -3317,6 +3346,212 @@Installing Temporary Mods
+
Plugin quick-start: Monetization
+
+
+
+The Mod.io Unreal Engine Plugin supports a range of Monetization features, allowing you to sell a per-game virtual currency to your players that they can use to purchase mods, with a share of the revenue split between creators and your studio. Visit here for an overview of the mod.io monetization system.
+
+
+Every platform requires specific setup for monetization features to work, with regards to the virtual currency configuration and API calls, however the following documentation is generically applicable, with only small differences per-platform that are documented within the platform-specific monetization documentation.
+
+
+Initialization
+
+
+The mod.io monetization features are enabled as part of the onboarding process on your game profile. Once that is setup, there is nothing further you need to do for initialization in the Plugin.
+
+
+Ensure that you have set the appropriate Portal when initializing the SDK for the portal you are using for purchasing - for instance, on Steam, you must initialize with Modio::Portal::Steam in order to redeem entitlements for Steam.
+
+
+Getting the user’s wallet
+
+
+On startup, you can make a call to UModioSubsystem::GetUserWalletBalanceAsync to get the balance of the current user’s wallet. If no wallet exists for the user, one will be created for them automatically. This call returns the users wallet balance for the current game. The only time you need to make this call is on startup.
+
+We recommend that you cache the value of this result in your game code rather than making consistent calls to UModioSubsystem::GetUserWalletBalanceAsync and update your local state from the return values of other calls that affect wallet balance.
+
+Blueprint Example
+
+
+
+
+
+
+
+
+
+
+C++ Example
+
+
+
+
+
+
+void UModioManager::GetUserWallet()
+{
+ if (GEngine->GetEngineSubsystem<UModioSubsystem>())
+ {
+ GEngine->GetEngineSubsystem<UModioSubsystem>()->GetUserWalletBalanceAsync(FOnGetUserWalletBalanceDelegate::CreateUObject(this, &UModioManager::OnGetUserWalletCallback));
+ }
+}
+
+void UModioManager::OnGetUserWalletCallback(FModioErrorCode ErrorCode, FModioOptionalUInt64 WalletBalance)
+{
+ if (ErrorCode == false)
+ {
+ // Wallet Balance Successfully Retrieved
+ }
+}
+
+Querying & Purchasing Mods
+
+
+As part UModioSubsystem::ListAllModsAsync, you can include an additional filter for whether you list paid mods. By default, only free mods are shown, but you can set RevenueType on the [ModioFilterParams](#ModioFilterParams) object passed to UModioSubsystem::ListAllModsAsync to include free and paid content, or just paid content. All mods returned will have a Price property, indicating the virtual currency price that must be paid in order to purchase.
+
+Currently filtering for Paid/Unpaid content is not exposed to Blueprint.
+
+
+Purchasing Mods
+
+
+You can call UModioSubsystem::PurchaseModAsync to purchase a given mod. PurchaseModAsync takes two parameters = the ModID of the mod to purchase, and the ExpectedPrice, which is the price displayed to the user from UModioSubsystem::ListAllModsAsync. You must include this parameter for safety, so the user is not charged more or less than the price displayed to them in case the price of the mod has changed between the call to ListAllModsAsync and purchase time.
+
+Once a mod is purchased, it is automatically subscribed to for the user.
+
+
+You should validate that the user has enough virtual currency to make the purchase by comparing it to the balance you received from UModioSubsystem::GetUserWalletBalanceAsync. Note this is purely for user experience (ie for graying out the purchase button in the UI, or upselling the user a virtual currenct pack), and UModioSubsystem::PurchaseModAsync will return an error if the user does not have enough in their wallet.
+
+The updated wallet balance after the purchase amount is subtracted is returned in the callback of UModioSubsystem::PurchaseModAsync.
+
+Blueprint Example
+
+
+
+
+
+
+
+
+
+
+C++ Example
+
+
+
+
+
+
+void UModioManager::PurchaseMod(FModioModID ModId, FModioUnsigned64 ExpectedPrice)
+{
+ if (GEngine->GetEngineSubsystem<UModioSubsystem>())
+ {
+ GEngine->GetEngineSubsystem<UModioSubsystem>()->PurchaseModAsync(ModId, ExpectedPrice, FOnPurchaseModDelegate::CreateUObject(this, &UModioManager::OnPurchaseModCallback));
+ }
+}
+
+void UModioManager::OnPurchaseModCallback(FModioErrorCode ErrorCode, FModioOptionalTransactionRecord Transaction)
+{
+ if (ErrorCode == false)
+ {
+ // Mod Purchase Successful
+ }
+}
+
+Showing user purchases
+
+
+Even though all purchased mods are automatically subscribed, the user can still unsubscribe from them and uninstall them; however, they still remain owned and purchased by the user. They must re-subscribe to the mod in order to have it installed. This is facilitated by UModioSubsystem::FetchUserPurchasesAsync, which will fetch a list of a users purchased mods. After a successful call, you can then display them with UModioSubsystem::QueryUserPurchasedMods, allowing re-subscription if necessary.
+
+Blueprint Example
+
+
+
+
+
+
+
+
+
+
+C++ Example
+
+
+
+
+
+
+void UModioManager::FetchUserPurchases()
+{
+ if (GEngine->GetEngineSubsystem<UModioSubsystem>())
+ {
+ GEngine->GetEngineSubsystem<UModioSubsystem>()->FetchUserPurchasesAsync(FOnFetchUserPurchasesDelegate::CreateUObject(this, &UModioManager::OnFetchUserPurchasesCallback));
+ }
+}
+
+void UModioManager::OnFetchUserPurchasesCallback(FModioErrorCode ErrorCode)
+{
+ if (ErrorCode == false)
+ {
+ // Purchases Successfully Fetched
+ if (GEngine->GetEngineSubsystem<UModioSubsystem>())
+ {
+ // We can now access the list of purchased mods directly
+ TMap<FModioModID, FModioModInfo> PurchasedMods = GEngine->GetEngineSubsystem<UModioSubsystem>()->QueryUserPurchasedMods();
+ }
+ }
+}
+
Getting a User Delegation Token
+
+
+User Delegation Tokens can be used by a backend server for S2S (Server to Server) transactions/functionality. You can get one for the current user by calling UModioSubsystem::GetUserDelegationTokenAsync, the callback for which contains the Token as a FString.
+
+Blueprint Example
+
+
+
+
+
+
+
+
+
+
+C++ Example
+
+
+
+
+
+
+void UModioManager::GetUserDelegationToken()
+{
+ if (GEngine->GetEngineSubsystem<UModioSubsystem>())
+ {
+ GEngine->GetEngineSubsystem<UModioSubsystem>()->GetUserDelegationTokenAsync(FOnGetUserDelegationTokenDelegateFast::CreateUObject(this, &UModioManager::OnGetUserDelegationTokenCallback));
+ }
+}
+
+void UModioManager::OnGetUserDelegationTokenCallback(FModioErrorCode ErrorCode, FString UserDelegationToken)
+{
+ if (ErrorCode == false)
+ {
+ // Successfully got User Delegation Token
+ }
+}How to Set Up Common UI for Project to Use Mod.io UE5 UI
@@ -10824,7 +11059,7 @@
@@ -11788,19 +12023,19 @@
Parameters
Locale
Language to set
Error Values
-
GetUserDerivedTokenAsync
+GetUserDelegationTokenAsync
-
+
+
-
void K2_GetUserDerivedTokenAsync(FOnGetUserDerivedTokenDelegate Callback)void K2_GetUserDelegationTokenAsync(FOnGetUserDelegationTokenDelegate Callback)
-
Get a User Derived Token that can be used for S2S service calls
+Get a User Delegation Token that can be used for S2S service calls
Requirements
@@ -12475,6 +12710,44 @@
Parameters
+
+
+
+
+GetLanguage
+
+
+
+
+
+
+
+
+
+
+EModioLanguage K2_GetLanguage()
+
+Get the currently applied language
+Parameters
+Target |
+Modio Subsystem Object Reference |
+
Return Value |
+Current language |
+
Returns
+
+
+Current language
++
GetGameInfoAsync
@@ -12500,7 +12773,7 @@
-Requirements
Parameters
+Parameters
Returns
+Returns
Error code indicating the status of the TempModSet. Will be empty if it was successful
Requirements
-Parameters
+Parameters
Returns
+Returns
Error code indicating the status of the TempModSet. Will be empty if it was successful
Is Mod Management Busy
Checks if the automatic management process is currently installing or removing mods
Parameters
+Parameters
Returns
+Returns
True if automatic management is currently performing an operation
Requirements
-Parameters
+Parameters
Returns
+Returns
Collection of FModioValidationError objects, or empty collection if there were no validation failures
Disable Mod Management
Disables automatic installation or uninstallation of mods based on the user’s subscriptions. Allows currently processing installation to complete; will cancel any pending operations when called.
Parameters
+Parameters
Returns
+Returns
Array with its corresponding info tags
Set Operation State Delegate
Call this to pass in a delegate that will receive operation state change notifications
Parameters
+Parameters
Size of the file in bytes. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| + | FilesizeUncompressed |
+Total size of all files in the mod after installation. |
+|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Filename |
Filename including extension. |
@@ -15082,7 +15360,7 @@
| + | PresetName |
++ |
| + | Tags |
++ |
| + | ExcludedTags |
++ |
| + | Direction |
++ |
| + | SortField |
++ |
| + | Count |
++ |
+
+
+
-ModioImageWrapper
+Variables
+ImagePath |
@@ -15226,7 +15548,7 @@ |
| + | Changes |
++ |
+
ModioModCollectionEntry
ModioModDependency
Variables
+Variables
ModName |
+ | |
| + | DateAdded |
++ |
| + | DateUpdated |
++ |
| + | DependencyDepth |
++ |
| + | Logo |
++ |
| + | FileInfo |
++ |
| + | Status |
++ |
| + | Visibility |
++ |
@@ -15326,7 +15702,7 @@
ModioModDependencyList
Variables
+Variables
InternalList |
+ | |
| + | TotalFilesize |
++ |
| + | TotalFilesizeUncompressed |
++ |
-
-
-ModioMapPreview
--
ModioModProgressInfo
-Variables
+Variables
ManageLink |
Link to the mod.io Manage User Account page |
+|
| + | TermsText |
+The plaintext version of the mod.io terms of use |
+
ModioTransactionRecord
-Variables
+Variables
| - | TabId |
++ | ModMemory |
+
+
+
ModioNotificationParams
+Variables
+| - | TabText |
++ | ErrorCode |
|
| - | TabButtonType |
++ | NotificationContextObject |
|
| - | TabButtonStyle |
++ | Duration |
| - | CharacterBorderBrushBase |
++ | CategoryName |
|
| - | CharacterBorderBrushFocused |
++ | Tags |
|
| - | CharacterBorderPadding |
++ | ExcludedTags |
|
| - | FakeCaretBrush |
++ | Direction |
|
| - | FakeCaretHorizontalAlignment |
++ | SortField |
|
| - | FakeCaretVerticalAlignment |
++ | Count |
|
| - | CharacterPadding |
++ | SearchKeywords |
|
| - | CharacterSpacing |
++ | InstalledField |
|
| - | MinimumCharacterWidth |
++ | QueuedField |
|
| - | HintText |
++ | EnabledFilter |
|
| + | + | ManualSortField |
++ |
+
+
+
+
+
+ModioCommonTabDescriptor
+Variables
+| + | TabId |
++ |
| + | TabText |
++ |
| + | TabButtonType |
++ |
| + | TabButtonStyle |
++ |
+
+
+
+ModioCommonAuthParamsSettings
++
+
+
+ModioCommonEmailAuthCodeParamsSettings
++
+
+
+ModioCommonEmailAuthLoadingParamsSettings
++
+
+
+ModioCommonEmailAuthParamsSettings
++
+
+
+ModioCommonTermsOfUseParamsSettings
++
+
+
-
-
@@ -15921,7 +16309,7 @@
-
-
@@ -15963,7 +16351,7 @@
-
ModioCommonCodeInputTextBoxInputStyle
+Variables
+| + | CharacterBorderBrushBase |
++ | |
| + | CharacterBorderBrushFocused |
++ | |
| + | CharacterBorderPadding |
++ | |
| + | FakeCaretBrush |
++ | |
| + | FakeCaretHorizontalAlignment |
++ | |
| + | FakeCaretVerticalAlignment |
++ | |
| + | CharacterPadding |
++ | |
| + | CharacterSpacing |
++ | |
| + | MinimumCharacterWidth |
++ | |
| + | HintText |
++ | |
Font |
| - | ErrorCode |
-- |
| - | NotificationContextObject |
-- |
| - | Duration |
-- |
-
-
-
-
-
-
@@ -15879,7 +16267,7 @@ ModioModCategoryParams
-Variables
-| - | CategoryName |
-- |
| - | Tags |
-- |
| - | ExcludedTags |
-- |
| - | Direction |
-- |
| - | SortField |
-- |
| - | Count |
-- |
| - | SearchKeywords |
-- |
| - | InstalledField |
-- |
| - | QueuedField |
-- |
| - | EnabledFilter |
-- |
| - | ManualSortField |
-- |
-
Set Session Identifier
Changes the session identifier for the provided set of initialization options
Parameters
+Parameters
Returns
+Returns
New Initialization Options object with the session identifier set to the desired value
Set Portal
Changes the portal for the provided set of initialization options
Parameters
+Parameters
Returns
+Returns
New Initialization Options object with the portal set to the desired value
ModioModID != ModioModID
Compares two ModioModIDs, returning true if not equal
Parameters
+Parameters
Returns
+Returns
The constructed FModioAuthenticationParams object for use with AuthenticateUserExternalAsync
Make Api Key
Create a ApiKey id from a string, should only be used in conjunction with InitializeAsync
Parameters
+Parameters
Returns
+Returns
The underlying value
ModioModID == ModioModID
Compares two ModioModIDs, returning true if equal
Parameters
+Parameters
+
Enum Name |
+The Name from a given enum value |
+
Return Value |
+localized Text for the specified enum value, or dummy FText if not found |
+
Returns
+
+
localized Text for the specified enum value, or dummy FText if not found
-
+
+
+
Set Initial Visibility
+FileSizeToText (Unsigned64)
-
+
+
-
void SetInitialVisibility(FModioCreateModParams In, EModioObjectVisibilityFlags InitialVisibility)FText FileSizeUnsigned64_ToText(FModioUnsigned64 FileSize, int32 MinDecimals, int32 MaxDecimals, TEnumAsByte<EFileSizeUnit> Unit, bool bIncludeUnitName)Parameters
+File Size |
+Filesize in bytes |
+
Min Decimals |
++ |
Max Decimals |
+Maximum amount of decimals to display of the filesize |
+
Unit |
+If Largest, then it tries to display the size in the largest unit that will have a integral part > 0, else it displays the filesize in the specified unit |
+
Include Unit Name |
++ |
Return Value |
+A text formatted from your specifications |
+
Returns
+
+
A text formatted from your specifications
+
-
+
+
+
Set Homepage URL
+Get Localized Text from Default Table by Key
-
+
+
-
void SetHomepageURL(FModioCreateModParams In, FString HomepageURL)FText GetLocalizedTextFromDefaultTableByKey(FString StringKey)
+
+Returns the string table FText for a given string key //
+Parameters
+String Key |
+The key to look up in the table |
+
Return Value |
+localized Text for the specified key, or StringKey if not found |
+
Returns
+
+
localized Text for the specified key, or StringKey if not found
+
-
+
+
Set Description
+Reconstruct Error
-
+
+
-
void SetDescription(FModioCreateModParams In, FString Description)FModioErrorCode ReconstructError(int32 Value, int32 Category)Parameters
+Value |
+The numeric value of the code |
+
Category |
+The category ID (populated by native code) |
+
Return Value |
++ |
-
+
+
+
@@ -16422,7 +17003,7 @@ Set Changelog String
+IsError
-
+
+
-
void SetChangelogString(FModioCreateModFileParams In, FString Changelog)bool IsErrorAsExec(FModioErrorCode Error)Parameters
+Error |
++ |
Returns
+
+
true if the error code is a error
Get Value
int32 GetValue(FModioErrorCode Error)Parameters
+Parameters
Returns
+Returns
0 if there is no error
Get Message
FString GetMessage(FModioErrorCode Error)Parameters
+Parameters
Returns
+Returns
@@ -16492,7 +17073,7 @@
-
-
@@ -16534,7 +17115,7 @@
-
Error Code Matches
Checks if the passed-in ErrorCode matches the specified error condition
Parameters
+Parameters
Returns
+Returns
true if the code matches the condition
List User Subscription Async
Runs a filter over the user’s subscription list
Parameters
+Parameters
+Returns
+Returns
Dimensions of the logo if displayed in a 1:1 pixel ratio
Get Gallery Size
FVector2D GetGallerySize(UTexture* GalleryImage, EModioGallerySize GallerySize)Parameters
+Parameters
Returns
+Returns
Dimensions of the gallery image if displayed in a 1:1 pixel ratio
Get Avatar Size
FVector2D GetAvatarSize(UTexture* Avatar, EModioAvatarSize AvatarSize)Parameters
+Parameters
Returns
+Returns
Dimensions of the avatar if displayed in a 1:1 pixel ratio
Get Path
FString GetPath(FModioModCollectionEntry Entry)Parameters
+Parameters
Returns
+Returns
Path to the mod’s installation folder on disk NOTE: If the mod is not yet installed this path may not yet exist. Check Get Mod State before trying to load files in this location
Get Mod State
EModioModState GetModState(FModioModCollectionEntry Entry)Parameters
+Parameters
Returns
+Returns
EModioModState enum representing current state of the mod
Get Mod Profile
FModioModInfo GetModProfile(FModioModCollectionEntry Entry)Parameters
+Parameters
Returns
+Returns
FModioModInfo containing mod profile data
Get ID
FModioModID GetID(FModioModCollectionEntry Entry)Parameters
+Parameters
Returns
+Returns
Mod ID
Returns
Get Total Progress
-
+
+
+
+
+
+
+
+
+FModioUnsigned64 GetTotalProgress(FModioModProgressInfo Info, EModioModProgressState State)
+
+Retrieves the total amount of progress required for the specified state.
+Parameters
+Info |
+the progress struct to query |
+
State |
+which state to query total progress for |
+
Return Value |
+Modio::FileSize for total progress in bytes |
+
Returns
+
+
+Modio::FileSize for total progress in bytes
++ +
+
+
+
+
+Get Current State
+
+
+
+
+
+
+
+
+
+
+EModioModProgressState GetCurrentState(FModioModProgressInfo Info)
+
+Returns a EModioModProgressState indicating which state the mod operation is in
+Parameters
+Info |
+the progress struct to query |
+
Return Value |
++ |
+
+
-
Get Current Progress
+
+
+
-
FModioUnsigned64 GetTotalProgress(FModioModProgressInfo Info, EModioModProgressState State)FModioUnsigned64 GetCurrentProgress(FModioModProgressInfo Info, EModioModProgressState State)
-
-Retrieves the total amount of progress required for the specified state.
+Retrieves the progress value for the specified state. CurrentProgress == TotalProgress for states which have completed, for example if a mod is currently Extracting, then passing in Downloading would give you a value equal to the total download size because the download has completed
Parameters
+Parameters
State |
-which state to query total progress for |
+which state to query progress information for |
Return Value |
-Modio::FileSize for total progress in bytes |
+FModioUnsigned64 containing current progress in bytes |
Returns
+Returns
-
Modio::FileSize for total progress in bytes
+FModioUnsigned64 containing current progress in bytes
-
-
+
Get Current State
+Get Tags
-
+
+
-
+EModioModProgressState GetCurrentState(FModioModProgressInfo Info)TArray<FModioModTagInfo> GetTags(FModioModTagOptions ModTags)
-
-Returns a EModioModProgressState indicating which state the mod operation is in
Parameters
+Parameters
Info |
-the progress struct to query |
+Mod Tags |
+|
Return Value |
@@ -16968,24 +17636,22 @@
Returns
-
-
-
Get Current Progress
+Get Paged Result
-
+
+
-
FModioUnsigned64 GetCurrentProgress(FModioModProgressInfo Info, EModioModProgressState State)FModioPagedResult GetPagedResult(FModioModTagOptions ModTags)
-
-Retrieves the progress value for the specified state. CurrentProgress == TotalProgress for states which have completed, for example if a mod is currently Extracting, then passing in Downloading would give you a value equal to the total download size because the download has completed
Parameters
+Parameters
Info |
-the progress struct to query |
-||
State |
-which state to query progress information for |
+Mod Tags |
+|
Return Value |
-FModioUnsigned64 containing current progress in bytes |
+
Returns
-
-
+FModioUnsigned64 containing current progress in bytes
-Returns
@@ -17027,7 +17686,7 @@ Get Default Portal for Current Platf
-
@@ -17061,7 +17720,7 @@ Get Default Auth Provider for
-
@@ -17095,7 +17754,7 @@
-
-
Get Default Portal for Current Platf
Get the default portal for the platform the game is running on.
-Parameters
+Parameters
Get the default portal for the platform the game is running on.
Returns
+Returns
EModioPortal of the portal to use
Get Default Auth Provider for
Get the default Authentication Provider for the current platform the game is running on
-Parameters
+Parameters
Get the default Authentication Provider for the current platform the game is running on
Returns
+Returns
EModioAuthenticationProvider to use for authentication calls
Get Current Platform
Gets the current platform that the game is running on
Parameters
+Parameters
Returns
+Returns
@@ -17126,7 +17785,7 @@
-
Round Number String
Sets the correct decimals depending on the file size or speed
+
+
+
+
-
-
+
+