This page documents the intended process for uploading a mod to the Curse Forge backend.

Reference

How To: Upload a Mod to Curse Forge
Miro

Take me to...

• Login and authorization flow
• How does one create a mod?
• Uploading your Mod to CurseForge
• Complete Flow

Login and authorization flow

If the user is not logged into WB Games, i.e. they have not linked their WB Games account with their Epic Games or CurseForge accounts, the user is prompted to login to WB Games.

The Link account button will take you a WB Games Account web portal that will allow the user to Link their Epic and Curseforge accounts. Linking to their WB Games Account is required to continue, but you can link your Curseforge account later by attempting to upload your Mod.

Prematurely closing or not completing the account linking process will cause the linking dialogue to continue to open, until the User links their account.

How does one create a mod?

In order to start working on a new mod the user needs to Create a Mod with the Create Mod dialogue so that the Creator Kit environment puts all the file updates into the proper Mod/plugin directory.

The user must enter all the required fields and selections in order to create a mod:

• Select a Mod Template
• Enter a Mod Name in the input field
• Enter a Author’s name (optional)
• Enter a Mod Summary description (optional)
• Enter a Mod Description (optional)
  
  

To make sure you are working on the correct mod, the user needs to set their mod.

Your mod contents need to be associated within the contents of a plugin.

NOTE: it is important that this plugin be located in the project’s mods plugin directory, which for our purposes is:

<your-workspace-root-directory>\PhoenixGame\Mods\

To assign the appropriate content to work in use the Set Mod tool.

Uploading your mod to CurseForge

To upload a mod to the CurseForge server, you need to use the Upload Mod button mentioned. Clicking that button will present the Mod Upload Window, like so:

In order to upload your mod the user must fill in all the required information.

• Select your current or intended Mod to upload (your current mod will be selected by default)
• Upload your Mod Logo Image
• Enter some text in the Mod Summary field
• Enter some text in the Mod Description field

At this point, you can also go to your project on the CurseForge web portal and make additional Mod Detail Edits.

Once it has been Approved, it should be ready for consumption by the game.

 Complete Flow

Sample of Curseforge Mod user flow