Talk to us
Содержание:
Backwards Compatibility
During the many years this service has been operating it has been through
many iterations, some required by changes to CurseForge and others
required to ensure service reliability. Although the API is always
intended to be backwards compatible, there is the potential for breaking
changes when data we offer is no longer available through CurseForge. API
consumers should be mindful that it is possible that at some point in
future data you depend on now may no longer be available and should
integrate accordingly. For example, monthly download counts were removed
by CurseForge in November 2017.
From 2013 — 2017 this service was available at widget.mcf.li, with API
requests made by appending .json to widget URLs. Developers making use of
this old format are encouraged to update their integrations to make use of
the new request endpoint, however this is not required as the legacy
widget.mcf.li URLs redirect and will do so indefinitely.
From 2019, it served stale data due to the sell of MinecraftForum to MagicFind.
Since 2019, caching has also been implemented on top of the API. Calls to the API
will be cached for up to 2 minutes.
From 2020, the syncing process has been restored. However, not all data may be present
due to the change in APIs used to gather this data.
Following fields will no longer have accurate values due to the API changes:
- File downloads
- License
- Donate
- Versions will not provide Java version
- Summary
- File display name
As of April 11th, URLs which contain the Project ID in them (i.e /minecraft/mc-mods/12345)
will resolve to the proper ID. This was done to ensure that if we could not determine the path,
that there is always a way to do so.
Also, urls which use the legacy format (mc-mods/minecraft) will now redirect to the correct path
(minecraft/mc-mods).
As of January 1st, 2021, due to the transfer of CurseForge to Overwolf, the API will no longer be able to
resolve paths to projects that do not contain the ID. As a result of this change, the following URL formats
are the only ways to resolve a project.
- /{game}/{type}/{id}-{name}
- /{id}
Getting Started
Modified on: Sun, 7 Feb, 2021 at 5:45 PM
Log in with Twitch credentials
You can go ahead and start using the new CurseForge app without logging in — your installed games and mods automatically.
If you wish to access the syncing features, you will need to log into your CurseForge account with your Twitch credentials, by clicking on the ‘Log in’ button in the side-bar menu:
When clicking ‘Connect with Twitch’ you will be taken to a webpage in your browser where you will be asked to provide your credentials, as well as ‘Authorize’ Twitch to share your basic information (username and avatar) with Overwolf/CurseForge.
That’s it — now you’re logged in! 🙂
Creating an Overwolf account
Creating an Overwolf account is not mandatory, but it is recommended since, as part of the migration from Twitch to Overwolf, logging in with Twitch credential will be available only temporarily (until the migration process is complete). From there on, logging into the app and into CurseForge will be possible with Overwolf credentials only.You can find additional info here.
Creating an Overwolf account is simple and quick — check out this guide to learn more!
How to detect my games and mods
Your installed games and mods should be automatically detected by the app, but if you notice anything missing — no worries! You can first try to initiate a scan, or browse your system to add a game manually.
- Follow the next steps to initiate the scanning process:
- Head over to the app’s Settings
- Click the ‘+’ button
- Choose ‘Scan computer for games’:
- The app will inform you of the scan’s completion and its results:
- Follow the next steps to add your game manually:
- Head over to the app’s Settings
- Click the ‘+’ button
- Choose ‘Manually add a game’:
- Navigate to the game’s installation directory:
- Select the game’s main folder
- Your game should be now successfully added to the app!
Which games are supported in the CurseForge app?
The CurseForge app currently supports the following games:
- Chronicles of Arcadia
- Darkest Dungeon
- Kerbal Space Program
- Minecraft
- Rift
- Runes of Magic
- Secret World Legends
- Stardew Valley
- Surviving Mars
- The Elder Scrolls Online
- The Secret World
- World of Tanks
- World of Warcraft
How to set auto updates
To allow the app’s auto updater to check for updates and install them, please visit the following settings (*this feature will only work ):
-
Addons > Updates
You can choose how frequently CurseForge will check for updates available for your addons:
-
Game Specific > Choose a game > Auto Install Updates
Choose whether or not to allow the app to install available updates automatically:
Moderation staff working hours
Project/File moderation is done between 8AM to 3PM CET (11PM-6AM PST), Sunday through Thursday, excluding holidays.
This process is First in, First out and any files submitted late in the day may not be checked until the next review day.
Useful settings
To open CurseForge’s settings, click on the cogwheel button located at the bottom of the menu:The settings menu is divided into two sections: General CurseForge settings and game specific settings:Here are some useful settings and options you should know about:
-
Start with Windows
When turned on, Overwolf will also launch on startup, as CurseForge requires Overwolf to run. If you wish, you can also set the startup setting for Overwolf separately (click ‘here’ to open Overwolf’s General settings).
Addons multi-selection
The CurseForge app allows you to select multiple addons and perform actions for all of them at once, like updating or deleting them from the ‘My Addons’ section, or installing brand new ones. To select multiple addons you can:
- Press and hold down the Ctrl key in your keyboard and add each addon to your selection with the left-click button of your mouse.
- Click on an addon with your mouse, press and hold down the Shift key and click with your mouse on another addon to create a range selection.
*A multi-selection checkbox feature is planned for future versions of the app!
Once you have multi-selected the addons you can click one of the options on top of the addons list to apply it to all of them. In the following example, we have selected multiple addons and installed them all at once:
How to get logs
If you need to export your logs for any purpose, you can do so through Overwolf by following a few easy steps:
- Right-click your Overwolf tray icon and hit ‘Support’
- Click on ‘Create logs zip’
- The location window will pop automatically, with the zip highlighted — send it to us 🙂
If you’re having trouble with these steps, you can also .
Did you find it helpful?
Yes
No
Send feedback Sorry we couldn’t be helpful. Help us improve this article with your feedback.
Responses
Each request response is a JSON document containing either project data or
an error.
-
200 Project found and
data included as the body of the response. -
202 Path not found in
local database so it has been queued for processing. Retry request in a
few seconds. -
301 Project is
available in database however the path used for the request is not the
canonical path. Retry request using the canonical path. -
400 Path provided is
not a valid CurseForge path or a valid legacy curse.com project path. -
404 Path is valid but
CurseForge responded that no project exists. This may be because no
project has ever lived at this path, or a project does but is hidden
from public view. -
500 An unknown error
occurred processing your request.
«Oops, that was not supposed to happen!» ▾
There are several possible causes for this issue:
- Firewall and/or antivirus software may block Overwolf/the CurseForge app, and thus prevent them from connecting to CurseForge’s servers.Please check your firewall/antivirus software and unblock/provide permissions accordingly.
-
DNS Issues
To resolve any existing DNS issues that could affect the app’s connection to CurseForge’s servers, you can try to set\change change your IPv4 DNS server address by following these steps:
- Open the Control Panel
- Click ‘Network and Internet’
- Click ‘Network and Sharing Center’
- Click the ‘Change adapter settings’ option in the left pane
- Right-click the network interface that connects Windows to the internet, and select ‘Properties’
- Select and check the Internet Protocol Version 4 (TCP/IPv4) option
- Click the ‘Properties’ button
- Select the ‘Use the following DNS server addresses’ option
- For ‘Preferred DNS server’ type in: 1.1.1.1
- Open the System Preferences
- Click ‘Network’
- Select your connection and click ‘Advanced’
- Click the ‘+’ at the button of the ‘DNS Servers’ section
- Type in 1.1.1.1
- Click ‘OK’
- Relaunch CurseForge
-
At times, this issue can be caused by a certain issue with CurseForge’s plugin.To solve it, please uninstall the CurseForge from Overwolf, and install it again from the or run the app’s installer file (if you still have it).
- Certain ISPs (Internet Service Providers) may block your connection to the CurseForge domain. Please try connecting to a different network (a mobile hotspot may work as well), or try a VPN connection.
-
IPv6
Disabling IPv6 may resolve this issue, but please note this is a last resort solution and is generally not recommended by Microsoft.To disable IPv6, please follow these steps:
- Open the Control Panel
- Click ‘Network and Internet’
- Click ‘Network and Sharing Center’
- Click the ‘Change adapter settings’ option in the left pane
- Right-click the network interface that connects Windows to the internet, and select ‘Properties’
- Uncheck the box for ‘Internet Protocol Version 6’
Download
Each response includes a object which
is
one of the files available on the project. By default the download
is the most recent file with a type of ,
with a
fallback to and then if no
acceptable file can be found.
An optional parameter can be included
when making a
request, this will determine which file is used as the download. You may
pass a version number, release type, file ID or a combination of version
number and release type. For example:
-
version=alpha
Most recent file where is equal to
. -
version=1.7.9
Most recent file where is equal to
. -
version=1.7.9/beta
Most recent file where is equal to
and is equal to
. -
version=2288310
File where is equal to .
When a request is made for a version that cannot be satisified the system
will fall back to providing the most recent file as the download,
except when the version is a number and release
type, in that situation the system will try and satisfy the version number
alone before falling back to the most recent file.
Installed mod is not detected ▾
The CurseForge app is connected to the same repository as the CurseForge website, and allows many mod authors to upload their projects to it and share it with the world!
If you’re using a mod that cannot be found in the CurseForge app or website, it can mean:
- That the mod is pending review by CurseForge’s moderators, and should be available once it’s approved (check out the working hours of the moderation team ).Or
- The project is not available in the repository, and therefore will not be detected by the CurseForge app.
Why don’t certain mods get uploaded to CurseForge?
Mods and addons in the CurseForge repository are submitted and managed directly by their creators.
Some authors prefer to host their addons and mods in other sources, in which case their projects will not be available in CurseForge.
If you would like to see an addons or mods you enjoy in CurseForge, contact the authors and submit a request to them.
«This addon might be corrupt» Warning (World of Warcraft) ▾
You may notice this warning message for certain addons that you currently have installed. This warning indicates that the installed addon does not match the game’s current instance, or that there may be something wrong with the addon’s files.
To resolve this issue, simply right click the addon and choose ‘Reinstall’ (or ‘Update’):
If reinstalling the mod didn’t help, please delete it, make sure you are currently set on the right instance (if you have more than one installed), search for the mod and install it again. If you are unable to find the mod when searching for it, it means that it’s not available for your currently set instance, and is meant to be installed for a different one.
Need help resolving the ‘corrupt’ warning? Contact us and we will do our best to assist you!
*You may notice the ‘corrupt’ warning being displayed despite the addon(s) working properly in-game.
**Please note that mods in ‘Modified’ or ‘Working Copy’ states will not get automatically updated. This is not an issue, but rather made intentionally in order to protect these mods’ files from getting overwritten or deleted by updates.
***As of May 19th, 2021 a new instance of the game named ‘Burning Crusade Classic’ — These instructions are relevant for this new instance as well. Follow the Tooltip box instructions and click ‘Update All’.
References
- https://web.archive.org/web/20071224063512/https://curseforge.com/
- https://web.archive.org/web/20080430143106/https://curseforge.com/
- https://web.archive.org/web/20080503043205/http://www.curseforge.com/announcements/forks-and-clones-and-multiple-repositories/
- https://web.archive.org/web/20080503024753/http://www.curseforge.com/announcements/beginning-the-import-from-cursecom/
- https://web.archive.org/web/20081201151534/http://www.curseforge.com/announcements/news-flash-incoming-improvements-to-the-curse-client/
- https://web.archive.org/web/20110820080718/http://www.curseforge.com:80/games/
- See the 2056 server mods compared to 76 client mods https://web.archive.org/web/20111224110958/http://www.curseforge.com/
- https://web.archive.org/web/20111124112304/http://dev.bukkit.org/server-mods/
- https://web.archive.org/web/20111124112050/http://dev.bukkit.org/client-mods/
- https://web.archive.org/web/20120804111536/http://www.curseforge.com/
- https://web.archive.org/web/20130304222120/http://www.curseforge.com/
- https://web.archive.org/web/20130701000616/http://www.curseforge.com/announcements/curse-forge-is-now-hosting-forge-mods/
- https://forum.feed-the-beast.com/threads/ftb-and-forge-curse-partnership.38512/
- https://www.geekwire.com/2016/amazon-owned-twitch-acquires-gaming-content-platform-curse/
- https://medium.com/curseforge/curseforge-is-getting-a-new-look-d182fdf0c658
- https://forum.feed-the-beast.com/threads/on-the-31st-october-2019-the-partnership-between-ftb-and-twitch-will-be-ending.300783/
- See the last page of https://www.curseforge.com/minecraft/bukkit-plugins?filter-sort=1
- See the last page of . The username «_ForgeUser6844997» appears to be autogenerated.
- See the last page on . The username «_ForgeUser6851927 » appears to be autogenerated.
- See the last page of
- See the last page of https://www.curseforge.com/minecraft/modpacks?filter-sort=1
- See the last page of . The username «_ForgeUser19098107» appears to autogenerated.
- See the last page of . The username «_ForgeUser22781877» appears to be autogenerated.
- https://www.curseforge.com/all-games
- https://authors.curseforge.com/store
Maven
CurseForge includes a maven endpoint so that you can include your dependancies using any build scripts that support maven. Please note that due to how maven works you do not provide your API key as a header, but as part of the maven URL.
https://www.curseforge.com/api/maven/{projectSlug}/{mavenArtifact}/{mavenVersion}/{projectFileNameArtifact}-{projectFileNameVersion}-{projectFileNameTag}.jar
This is the Maven full URL. Below is the explanation of each part, and where you can find that information. For the examples below we will be using the CoFHCore Project.
: The slug of the project you want to use. In our example its cofhcore
: This should be the files name, in our example CoFHCore-1.10.2
: This should be what release you want, in our case we are going to use release as this gives us the latest, but you can also use the file version in the name (Such as 4.1.0.155 for CoFHCore-1.10.2-4.1.0.155-universal.jar)
: The same as mavenArtifact
: The same as mavenVersion
: The name tag on the file, on older mods it would be dev on newer ones it might be universal, in our case its universal
This puts our final example link at:
https://minecraft.curseforge.com/api/maven/cofhcore/CoFHCore-1.10.2/release/CoFHCore-1.10.2-release-universal.jar
If you want to use the maven with ForgeGradle I’ve also provided the same example in the script below
This goes above
repositories {
maven {
name = "CurseForge"
url = "https://minecraft.curseforge.com/api/maven/"
}
}
Then add this to dependencies
compile ‘cofhcore:CoFHCore-1.10.2:release:universal’
CurseForge today
The front page of CurseForge in December 2019.
CurseForge hosts third party content for the several games, the largest being Minecraft. It also has content for World of Warcraft, StarCraft II, Kerbal Space Program, WildStar, Terraria, World of Tanks, Rift, Runes of Magic, The Elder Scrolls V: Skyrim, The Secret World, The Elder Scrolls Online, Stardew Valley, Secret World Legends, Chronicles Of Arcadia, Surviving Mars, Darkest Dungeon, Grand Theft Auto V, and Staxel.
For Minecraft, CurseForge hosts Bukkit plugins, modpacks, customizations (miscellaneous content, mainly mod configurations), addons, mods, texture packs, and worlds. Each type can be filtered by various categories, and can be sorted by date created, last uploaded, name, popularity, and most downloads. Creators earn «Curse Points» for the popularity of their projects, which can be redeemed for PayPal or Amazon (for Amazon.com, Amazon.co.uk, Amazon.de, and Amazon.ca only) giftcards. The amount of Curse Points given is in proportion to a secret formula determining popularity to avoid creators releasing as many updates to a project as possible to rack up Curse Points.
History
The earliest archived version of CurseForge was taken in late 2007. Then, it just linked to various World of Warcraft advertisements, since the URL was reserved by GoDaddy. In 2008 it was taken by Curse, Inc., as a repository of World of Warcraft addons. The repository was imported from curse.com. The website was also paired with a CurseClient, which helped install addons. The CurseClient would be the predecessor to CurseVoice, which was renamed to the Twitch Desktop App after Curse, Inc. was bought by Twitch.tv.
CurseForge was originally oriented to addon developers rather than users, while curse.com was oriented towards the general public. Besides from World Of Warcraft, CurseForge expanded to Warhammer Online: Age of Reckoning, Age of Conan, and Runes of Magic, with the potential for other games. In mid-2011, CurseForge started hosting Minecraft content.
At first, CurseForge mainly hosted «server mods» instead of «client mods.» The term server mods referred to Bukkit plugins, while the term client mods referred to all content that required the client to modified in order to function, including language packs (non-English translation weren’t supported by the game until version 1.1), texture packs, and conventional mods. Although listed on CurseForge, mods were actually hosted on dev.bukkit.org, a sub-website. In mid-2012, texture packs were separated from client mods. In early 2013, worlds (custom saves, also called maps) were added to CurseForge.
In June 2013, CurseForge announced that they would orient to modders who used Minecraft Forge by separating the «client mods» into a subsection of CurseForge for all mods. Mods could be categorized as being based through Minecraft Forge, ModLoader, or through the modification of the Minecraft.jar, or a combination of the three. minecraft.curseforge.com became the subdomain for all third party content developed for modded Minecraft, excluding Bukkit plugins, which remained on dev.bukkit.org.
In January 2014, Feed The Beast announced a partnership with Curse, Inc. Some of Feed The Beast’s websites would be moved onto Curse servers, and eventually their modpacks would be hosted on CurseForge and would be downloaded through CurseVoice, Curse Inc’s new mod manager and communication software, instead of through the Feed The Beast launcher. Despite skepticism in the community over Curse Inc’s commercialism, the plan went through, and as a result, CurseForge had a massive increase of popularity and usage. While modders previously self-hosted mods using sites like MediaFire, CurseForge became the primary repository for mods. Many modpacks also moved onto CurseForge. This likely because of the convenience of a centralized repository, the monetary incentives for popularity of a project (reaching a significant popularity for a project would give «Curse Points» that could be exchanged for PayPal, Amazon, or Steam giftcards), the feature that a modpack download would contribute a download to the count of each mod (meaning that modders could make money off of their mods being downloaded indirectly through modpacks), the allowance of CurseForge modpack makers to be include any mod on CurseForge in their modpacks, and the presence and endorsement of popular curators such as Feed The Beast and Jadedcat.
In August 2016, Curse, Inc. was bought by Twitch.tv. CurseVoice was transformed into the Twitch Desktop App, but there was not much change to CurseForge, except for a merging of accounts. In June 2019, the curse.com website was merged with CurseForge, with CurseForge working as a singular front for both developers and users.
On October 8th, 2019, Feed The Beast announced that their contract with Curse, Inc. had ended and that they would no longer use the service and would instead recreate their own launcher. They planned to remove their content from the site on the 31st of October, although the content is still available.
First projects
- First Bukkit plugin (or «server mod,» as it was originally called): Heroes by LordKainzo, created on August 3rd, 2011.
- First mod: Invinci-Dogs by an unknown user, created on August 25th, 2011 for Minecraft Beta 1.7.3.
- First texture pack: Pocok’s texture pack by a user likely named Pocok, created on September 3rd, 2011.
- First world: Texture Pack Viewer by Pluto_mcpvp, created on January 29th, 2013.
- First modpack: Aesthetic Construction by jadedcat, created on October 23rd, 2014.
- First customization: LUCKY BLOCK BROWN MOD by a user likely named Josh7506EI, created on February 21st, 2015.
- First addon: Castle Siege by an unknown user, created on October 21, 2016.
Project File Management API
To update a file, issue a POST multipart/form-data request to , containing the field: . The ID of your project will be in the URL when you go to its overview page.
must contain a json object with the following fields:
{
fileID: 20402, // This is the file ID you are updating. This is required.
// Note: These are all optional fields, you can include any of these in any combination.
// The API will fail if you do not include any settings to change.
changelog: "A string describing changes.", // Can be HTML or markdown if changelogType is set.
changelogType: , // Choose one, defaults to text
displayName: "Foo", // A friendly display name used on the site if provided.
gameVersions: , // A list of supported game versions, see the Game Versions API for details. Not supported if parentFileID is provided.
releaseType: "alpha", // One of "alpha", "beta", "release".
relations: {
projects: [{
slug: "mantle", // Slug of related plugin.
type: // Choose one
}]
} // Optional: An array of project relations by slug and type of dependency for inclusion in your project.
}
On successful upload, returns a json object containing the old file ID:
{
id: 20402
}
Maven
CurseForge includes a maven endpoint so that you can include your dependancies using any build scripts that support maven. Please note that due to how maven works you do not provide your API key as a header, but as part of the maven URL.
https://www.curseforge.com/api/maven/{projectSlug}/{mavenArtifact}/{mavenVersion}/{projectFileNameArtifact}-{projectFileNameVersion}-{projectFileNameTag}.jar
This is the Maven full URL. Below is the explanation of each part, and where you can find that information. For the examples below we will be using the CoFHCore Project.
: The slug of the project you want to use. In our example its cofhcore
: This should be the files name, in our example CoFHCore-1.10.2
: This should be what release you want, in our case we are going to use release as this gives us the latest, but you can also use the file version in the name (Such as 4.1.0.155 for CoFHCore-1.10.2-4.1.0.155-universal.jar)
: The same as mavenArtifact
: The same as mavenVersion
: The name tag on the file, on older mods it would be dev on newer ones it might be universal, in our case its universal
This puts our final example link at:
https://minecraft.curseforge.com/api/maven/cofhcore/CoFHCore-1.10.2/release/CoFHCore-1.10.2-release-universal.jar
If you want to use the maven with ForgeGradle I’ve also provided the same example in the script below
This goes above
repositories {
maven {
name = "CurseForge"
url = "https://minecraft.curseforge.com/api/maven/"
}
}
Then add this to dependencies
compile ‘cofhcore:CoFHCore-1.10.2:release:universal’
Export
The localization API allows exporting via a GET request. Below is the list of optional parameters that are accepted by the endpoint. These all correspond to the available feature on the export page, and none are required.
https://wow.curseforge.com/api/projects/{projectID}/localization/export
