Take me to...
- File Types and Additional Fields
- Project Types
- Adding Files to a Project
- Archiving or Deleting Files
- Minecraft Fabric/Forge File Tagging
- MacOS Specific Rejections
File Release Types and Additional Fields
Release: Syncs to the CurseForge App by Default. These are the files that will auto download when a user clicks the default download button on a project. You must have at least one of these files for the project to be available in the website and client.
Beta: Will sync to the CurseForge App provided 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 CurseForge App unless the user chooses to receive alpha files. These files will also not appear in the sidebar for all games (except Minecraft).
New projects on CurseForge: A Release File or Beta must be uploaded and approved for the project to sync to the CurseForge App. Projects without approved Release/Beta or those that include Alpha files only will be available on the CurseForge website.
Note - File Type Can be edited at anytime from the File Page (Project Page>Files>click on File Name>Edit button. After changing the Release Type don't forget to scroll down and hit Save!)
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.
Experimental: Will not sync to the CurseForge app and will not appear in the website searches. The files in this project type can be played using the client import feature. Experimental projects can be changed to regular status by clicking on the 'Submit Project for non-experimental' button in the main project page in the warning box (see image below). Until then, experimental is great as a testing environment for your mods and addons, or a way to setup your project page before publishing it publicly.
Abandoned: Projects with this status are either set to this by the project owner, or due to the project owner not migrating his account (accounts were migrated twice in the past, once from Curse to Twitch, and as of recent (Dec. 2020), from Twitch to Overwolf. Once the owner migrated his account, his projects will revert to their previous status.
Setting your project as abandoned is mostly useful when a project is not working as intended and the owner does not plan on releasing fixes or updates.
Adding Files to a Project
Navigate to your Project Dashboard. To the right of your project title is a button labelled 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 labelled "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.
Minecraft Fabric/Forge File Tagging
My project files were changed and are now tagged to support 'Forge', what happened?
As part of our efforts to add support for the Fabric modloader, we now require proper tagging of all project files to be correctly displayed and functional in the client. We have defaulted all untagged files to 'Forge', however you can still change the file tags through each file editing page as we explained in our Newsletter.
If you already have an existing project, this is how you can edit the modloader tag:
- Open the Project Page.
- Click the Files Tab.
- Click the File name.
- Click the Edit button.
- Change the Supported Modloader Versions selector to Fabric.
- Scroll down and click Update File
MacOS Specific Rejections
Mac users might get a rejection message that the file was rejected since it contained blacklisted files - what does this mean?
The default Mac compressor ("Archive") creates an additional folder '__macosx', and an additional file '.ds_store', both of which are picked up by the processor and rejected. Please use an alternative 3rd party program to compress and zip.
The 'Customization' category is a special space for people to upload user made configs for mods that are open ended.
To use the files, you first need the mod which the files were created for (can usually be found in the description) and then you place them where the mod says to. Usually in some folder to replace the config file.