https://github.com/therandomlabs/curseapi-minecraft

An extension of CurseAPI for parsing CurseForge modpack manifests and for performing more Minecraft-specific operations.
https://github.com/therandomlabs/curseapi-minecraft

curse curseapi curseforge java java-library minecraft minecraft-modpack

Last synced: 9 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/therandomlabs/curseapi-minecraft
• Owner: TheRandomLabs
• License: mit
• Created: 2017-12-24T07:23:08.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-04-30T05:44:09.000Z (almost 5 years ago)
• Last Synced: 2025-05-05T21:37:32.697Z (12 months ago)
• Topics: curse, curseapi, curseforge, java, java-library, minecraft, minecraft-modpack
• Language: Java
• Homepage:
• Size: 511 KB
• Stars: 7
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# CurseAPI-Minecraft

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

![Build](https://github.com/TheRandomLabs/CurseAPI-Minecraft/workflows/Build/badge.svg?branch=master)

[![Dependabot](https://badgen.net/dependabot/TheRandomLabs/CurseAPI-Minecraft/?icon=dependabot)](https://dependabot.com/)

[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/TheRandomLabs/CurseAPI-Minecraft.svg)](http://isitmaintained.com/project/TheRandomLabs/CurseAPI-Minecraft "Average time to resolve an issue")

An extension of [CurseAPI](https://github.com/TheRandomLabs/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](https://github.com/TheRandomLabs/CurseAPI#using-with-gradle),

add this to your dependencies:

```groovy

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

```