/CurseAPI-Minecraft

An extension of CurseAPI for parsing CurseForge modpack manifests and for performing more Minecraft-specific operations.

Primary LanguageJavaMIT LicenseMIT

CurseAPI-Minecraft

License: MIT

Build Dependabot

Average time to resolve an issue

An extension of CurseAPI for parsing CurseForge modpack manifests and for performing more Minecraft-specific operations.

All public-facing code is documented with Javadoc and (mostly) tested with JUnit.

Usage

Before using CurseAPI-Minecraft, CurseAPIMinecraft#initialize() should be called so that CurseAPI-Minecraft can perform any necessary initialization and register itself with CurseAPI.

  • MCVersion represents a Minecraft version supported by CurseForge. MCVersion instances can be retrieved by accessing the constants and methods in the MCVersions class.
  • MCVersionGroups contains CurseGameVersionGroup constants that represent Minecraft version groups.
  • CurseModpack#fromJSON(String) and CurseModpack#fromJSON(Path) can be used to parse CurseForge modpack manifest JSONs.
  • CurseModpack#createEmpty() can be used to create a new CurseModpack instance.
  • CurseModpack instances can be converted back to JSONs by calling CurseModpack#toJSON() or CurseModpack#toJSON(Path).

Using with Gradle

To use CurseAPI-Minecraft with CurseAPI, add this to your dependencies:

api "com.github.TheRandomLabs:CurseAPI-Minecraft:master-SNAPSHOT"