Modrinth-updater NPM

modrinth-updater

A simple CLI tool to update your mods from a config file using the modrinth API

Setup

Create a .modlist.json file in your mods folder that looks something like this:

{
	"minecraftVersion": "(the minecraft version you play on)",
	"loaderType": "(fabric, forge, quilt or liteloader)",
	"unsafe": {
		"allowUnstable": "(true or false)",
		"allowFailHash": "(true or false)"
	},
	"mods": [
		"(last part of the project's url on modrinth e.g. fabric-api for the Fabric API)",
		"(put more mods on a new line and make sure there's a comma at the end of the previous line)",
		"(and so on...)"
	],
	"externalMods": [
        "(the filename of a mod that is not on modrinth and should be kept when updating, (including the .jar extension)",
        "(and so on...)"
    ]
}

For example, this is my config file:

{
	"minecraftVersion": "1.19.2",
	"loaderType": "fabric",
	"unsafe": {
		"allowUnstable": false,
		"allowFailHash": false
	},
	"mods": [
		"fabric-api",
		"sodium",
		"betterf3",
		"capes",
		"fabric-language-kotlin",
		"iris",
		"lambdynamiclights",
		"lithium",
		"logical-zoom",
		"modmenu",
		"no-chat-reports",
		"starlight",
		"lazydfu"
	],
	"externalMods": []
}

Installation

You can run this tool directly with npx:

$ npx modrinth-updater

You can also install the package globally and run it like this:

$ npm install -g modrinth-updater
$ modrinth-updater

Help

Usage: modrinth-updater [options]

A tool to update your mods from Modrinth

Options:
  -V, --version           output the version number
  -m, --modfolder <path>  The path to your mods folder
  -h, --help              display help for command