Adding UGC

There are a few ways to allow users to add their UGC creations to your game. You can either allow users to build and submit UGC from inside your game, or you could take advantage of Unreal Engine's built-in tooling to empower users to create and upload UGC to your game.

This guide covers:

• In-game UGC submissions
• Unreal Engine Creation & Upload Tool

In-game UGC submissions

Submitting UGC from inside your game and making it visible to other players involves two steps:

1. Submitting new UGC
2. Submitting the data of the UGC (aka "the mod file")

These steps are outlined below. UGC can also be edited after submission, which you can learn via the API Reference

Submitting new UGC

To submit a piece of UGC, you must first create a mod handle using GetModCreationHandle, and use that handle when calling SubmitNewModAsync. Note that newly created UGC will remain hidden until a mod file is added in the next step.

Blueprint

C++

void UModioManagerSubsystem::SubmitNewMod()
{
   if (UModioSubsystem* Subsystem = GEngine->GetEngineSubsystem<UModioSubsystem>())
   {
   	FModioModCreationHandle Handle = Subsystem->GetModCreationHandle();

   	FModioCreateModParams Params;
   	Params.Name = TEXT("My Amazing Mod");
   	Params.Description = TEXT("This mod does amazing things");
   	Params.PathToLogoFile = TEXT("C:\\path\\to\\image.png");

   	Subsystem->SubmitNewModAsync(Handle, Params, FOnSubmitNewModDelegateFast::CreateUObject(this, &UModioManagerSubsystem::OnSubmitNewModComplete));
   }
}

void UModioManagerSubsystem::OnSubmitNewModComplete(FModioErrorCode ErrorCode, TOptional<FModioModID> ModId)
{
   if (!ErrorCode)
   {
   	// Mod was successfully submitted 
   	// We can now call SubmitNewModFileForMod with this ModId
   }
}

Submitting the data for the UGC

Once you have successfully submitted a piece of UGC, you can submit a mod file for that UGC using SubmitNewModFileForMod. When you submit a mod file, you pass a ModioCreateModFileParams containing the directory containing all the files that you want to submit. The plugin will compress this folder into a .zip file and upload it as the active version of the UGC.

In the future, if the mod is updated and requires a new mod file, SubmitNewModFileForMod can be called again. The most recent mod file uploaded by SubmitNewModFileForMod will be set as the active version.

note

There is no callback for SubmitNewModFileForMod; you’ll be notified of the completed upload by your mod management callback.

Blueprint

After the callback for submitting UGC has completed, you can get the Mod Id to use for file submission.

C++

void UModioManagerSubsystem::SubmitNewModFile(FModioModID ModId)
{
   if (UModioSubsystem* Subsystem = GEngine->GetEngineSubsystem<UModioSubsystem>())
   {
   	FModioCreateModFileParams Params;
   	Params.PathToModRootDirectory = TEXT("C:\\path\\to\\mod-folder");
   	Subsystem->SubmitNewModFileForMod(ModId, Params);
   }
}

Unreal Engine Creation & Upload Tool

The mod.io Unreal Engine's plugin includes an editor module which provides an embedded mod.io - Content Creation and Upload Tool.

Editor-specific plugin modules

Module Name	Description	Module Type
ModioEditor	Editor details customization and asset factories for UE content creation and upload tool classes	Editor

Opening the tool

Click the mod.io icon in Unreal Engine to show a drop down menu, click the Create & Upload menu. Once opened, it may require mod.io authentication as below.

Authenticating

Authentication may be required either being a first time user of the module or not logged in previously. If you are already logged in, you will automatically be redirected to creating or editing mods.

The user will be authenticated if not already logged in to a mod.io account.

Email: Enter your email in the text box shown below and click Login, a verification code will be sent to the submitted email address.

Verification code

Verification Code: Enter the code received in your email and click Authenticate.

If everything goes correctly, you will be authenticated successfully.

Create or Edit Mods

After successful authentication, you can either Create Mod or Edit Mods.

"Create Mod"

Create Mod lets you create new UGC.

"Edit Mods"

Edit Mods lets you edit existing UGC and change any specific values or mod files within them.

Creating UGC

Creating UGC is made easy from within Unreal Engine described in the process below.

"Create Mod"

Click Create Mod and fill the following required fields:

Create Mod Properties

Fields	Description
Path to Logo File	Browse to select your .png file for logo
Name	Name of the mod
Summary	A brief summary of the mod

Once filled all the required fields, click Submit to create the mod.

TIP: You may get an error dialog if the game doesn't support your platform or the game is locked.

Once everything goes successful you will be asked if you also want to upload a mod file right away.

If Yes is selected you will be redirected to STEP 6.

Edit existing UGC

Editing existing UGC is made easy in the same way as creating UGC directly from within Unreal Engine described in the process below.

"Edit Mods"

By clicking Edit Mods, a list of UGC will be shown to edit. You can select UGC by clicking on it.

Browse Mods

Name	Description
Your mod name	Your mod description

Once UGC is selected, click Edit Mod to edit the UGC.

Edit Mod Properties

Field	Description
Name	Your mod name
Summary	Your mod summary
Homepage URL	Your mod homepage url

If you want to change the mod properties, make desirable changes to above fields and click Submit.

Then click Edit Files to see a list of existing mod files.

Modfile

Name	Platform	Version	Status
Your mod file name	Your mod platform	Your mod file version	Your mod file status

Uploading a new modfile

To upload a mod file, a workspace directory path is mandatory which is described in the process below.

Click New Modfile

You may need to select Create mod for PC

Fill the required fields:

TIP: You may get an error dialog if the game doesn't support your platform or the game is locked.

Upload Mod File

Field	Description
Version	Your mod file version
Changelog	Your mod file platform
Set as Active Release	Whether to set as Active Release
Path to Mod Root Directory	Path to the workspace directory

Once all fields are filled out, click Submit

Once submitted, the progress bar will be displayed about the workspace directory being zipped and uploaded with all other information provided for the new mod file.

Mod file upload

TIP: You may get an error dialog if the game doesn't support your platform or the game is locked or any error that occurs due to internet issues or any other circumstances.

Next steps

Now you've activated the ability to add UGC to your game, the next step is to allow users to find UGC by implementing the Searching for UGC guide.

If you've already done this, we recommend working your way through the Unreal Getting Started Guides as they will teach you how to implement the fundamentals of the Unreal Engine Plugin before moving onto exploring our Features