File Types and Additional Fields

  • Release: Syncs to the Twitch Desktop App by Default. These are the files that will auto download when a user clicks the default download button on a project.
  • Beta: Will not sync to the Twitch Desktop App unless the user chooses to receive Beta files. These files will also not appear in the sidebar for all games (except Minecraft).
  • Alpha: Will not sync to the Twitch Desktop App instances set to receive Alphas. These files will also not appear in the sidebar for all games (except Minecraft).
  • Additional Files - These are files attached to another file. Usually these are development files for other mod developers who need access to un-obfuscated code. They do not download with the main file. Instead a developer would go to the file page and download them individually. To upload additional files you would select the file you wish to attach them to in the file view and then select the button on the individual file page that says "Upload Additional Files".
  • Project Relationships - These are set on individual files. They can be embedded libraries, optional libraries, required libraries, tools or incompatible files. Once app integration occurs required libraries will automatically be downloaded with the file, optional files will display a message informing the player, and incompatible files will warn the player that installing the 2 files together is at their own risk. 

 

Adding Files to a Project

Navigate to your Project Dashboard. To the right of your project title is a button labeled File. Clicking this will take you to the Files tab and once uploaded, will list your project files. This page will differ slightly based on what game your project is for. Below is a list of fields that you will fill out to have your file submitted:

   

  • Upload file: Pick the file you want to upload
  • Display Name: Your project file is named v2.0 , but you want it to look a bit fancier, type in a name here that will show up in the file list. It is NOT recommended to give every file the same name, and this field is optional.
  • Release Type: Detailed Above
  • Changelog: A place to put all the updates you have done between versions
  • Supported Version: Pick which versions of the game your project is compatible with. You can choose multiple versions.
  • Supported Java versions (Minecraft Only): If your project only works in Java 6, this is the spot to say so.
  • Related Projects: Dependencies and Incompatibilities. This is where you can link to other projects on CurseForge. You can link to a required project, or to a recommended project, or to a project that you know does not work well with your project.

After filling out all of the appropriate fields, click Submit File. You will be redirected to your Files tab and you should be able to see your newly added file. You can add more files by following the same process you just went through. At this point your file will be labeled "Under Review" and it is off to the moderators to review and approve it. They may send it back to you requesting changes. They may also reject it. Changes and rejection reasons are covered under Changes Required and Rejected Files

 

Archiving or Deleting Files

There are two ways to remove a file from your project.

 

Archiving: Removes a file from the public view. It can no longer be downloaded on its own. However if a content pack or another mod depends on it they can still download it as a dependency. This is useful for CoreMods or API/Libraries where you want to remove an old file but not break a mod that depends on the old file. Archived files can be restored by their owner at any time

 

Deleting: Once a file is archived, an author has the option of deleting the file. Once the file is deleted any files that depend on it can no longer access it. Make sure you want to erase the file before doing so.  In most cases Archiving is the better option. Deleted files require a site admin to restore.