snxraven/mod-manager
1
0
Fork 0
mirror of https://git.bits.team/Bits/mod-manager.git synced 2024-11-23 14:38:21 -05:00
Code Issues Packages Projects Releases Wiki Activity
A package manager-like utility for installing, upgrading and migrating mods on Fabric Minecraft servers
71 Commits 1 Branch 0 Tags 185 KiB
TypeScript 89.8%
JavaScript 6.9%
Shell 3.3%
4e744d11fd
Go to file
Kallum Jones 4e744d11fd
Add install by id functionality
2022-08-14 14:59:41 +01:00
src Add install by id functionality 2022-08-14 14:59:41 +01:00
.gitignore Ensure script is ran with sudo 2022-08-09 17:55:41 +01:00
install.sh Fix out directory of ncc 2022-08-09 19:01:03 +01:00
package-lock.json Require confirmation when uninstalling mods that are depended on 2022-08-14 14:33:03 +01:00
package.json Require confirmation when uninstalling mods that are depended on 2022-08-14 14:33:03 +01:00
README.md Add examples to readme 2022-08-09 23:33:09 +01:00
tsconfig.json Update build directory for Typescript Compiler 2022-08-09 16:57:56 +01:00

README.md

Mod Manager

A package manager-like CLI utility for managing installing, updating and migrating mods on Fabric Minecraft Servers.

Features

  • Installing mods from Modrinth and Curseforge
  • Uninstalling mods
  • Updating mods with a single command
  • Migrating mods to a new Minecraft version

Demo

A terminal window showing the usage of mod-manager

Usage/Examples

$ mod-manager
Usage: mod-manager [options] [command]

A package (mod) manager for Fabric Minecraft Servers

Options:
  -v, --version                         Reports the version of the Minecraft server
  -h, --help                            display help for command

Commands:
  init                                  Initialises mod manager
  install [options] <mods...>           Installs the provided mods
  list                                  Lists installed mods
  uninstall <mods...>                   Uninstalls the provided mods
  essential <mods...>                   Toggles the mods essential statuses
  update                                Checks for and updates mods that have a newer available version
  migrate-possible [options] [version]  Reports whether it is possible to upgrade to the provided Minecraft version
  migrate [options] [version]           Migrates all mods to provided Minecraft version
  help [command]                        display help for command

Initialising Mod Manager:

$ mod-manager init
? What Minecraft version is your server running? 1.19.1
Sucessfully initialised Mod Manager!

Installing a mod:

$ mod-manager install lithium
✔ Successfully installed Lithium

Listing installed mods:

$ mod-manager list
Name    | Id       | File Name                         | Version        | Source   | Essential | Dependencies
-------------------------------------------------------------------------------------------------------------
Lithium | gvQqBUqZ | lithium-fabric-mc1.19.2-0.8.3.jar | mc1.19.2-0.8.3 | Modrinth | false     |

Environment Variables

The following are the required environment variables for running Mod Manager

CURSEFORGE_API_KEY # Set to your api key for curseforge. Leaving it unset will skip all Curseforge related functionality

Installation

Prerequisites

  • A version of Node.js greater than 12 must be installed, along with npm and npx.

Mod Manager can be installed with the following command (watch out for the sudo password prompt, it can be hard to spot)

curl https://hogwarts.bits.team/git/Bits/mod-manager/raw/branch/master/install.sh | sudo -E env "PATH=$PATH" bash