2.2.3 • Published 4 years ago

mc-curseforge-api v2.2.3

Weekly downloads
33
License
MIT
Repository
github
Last release
4 years ago

mc-curseforge-api Codacy Badge npm bundle size npm (tag)

Yeah a terrible package name but whatever.

This package should make dealing with the Minecraft Mods Curseforge API a lot easier. Just quickly require it and you're good to go!

Installation

Using yarn (which is obviously better)\ yarn add mc-curseforge-api

Using npm\ npm install mc-curseforge-api --save

Examples

Get a list of mods:

const curseforge = require("mc-curseforge-api");

curseforge.getMods().then((mods) => {
    console.log(mods);
});

Search for mods by a string:

curseforge.getMods({ searchFilter: "Vazkii_" }).then((mods) => {
    console.log(mods);
});

Get a list of mods for a specific minecraft version:

curseforge.getMods({ gameVersion: "1.12.2" }).then((mods) => {
    console.log(mods);
});

Use paging for getting mods:

curseforge.getMods({ index: 3, pageSize: 5 }).then((mods) => {
    console.log(mods);
});

See curseforge.getMods for more options.

Download the mod file for a mod:

mod.getFiles().then((files) => {
    files[0].download("./Mod.jar");
});

Get mod files for a specific minecraft version:

curseforge.getModFiles(225643).then((files) => {
    console.log(files);
});

See curseforge.getModFiles for more options.

Documentation

See the docs for more information here.\ (Those got made with JSDoc and I have no clue how to make them look better.)

2.2.3

4 years ago

2.2.2

4 years ago

2.2.1

4 years ago

2.2.0

4 years ago

2.1.1

5 years ago

2.1.0

5 years ago

2.0.1

5 years ago

2.0.0

5 years ago

1.0.6

6 years ago

1.0.4-d

6 years ago

1.0.4

6 years ago

1.0.3-d

6 years ago

1.0.3

6 years ago

1.0.2-d

6 years ago

1.0.2

6 years ago

1.0.1-d

6 years ago

1.0.1

6 years ago

1.0.0

6 years ago