An open API service indexing awesome lists of open source software.

https://github.com/ThunderClapLP/mc-get

A console application to download and install modpacks or mods for Minecraft
https://github.com/ThunderClapLP/mc-get

modding modrinth

Last synced: 10 months ago
JSON representation

A console application to download and install modpacks or mods for Minecraft

Awesome Lists containing this project

README

          

# mc-get

A console application to download and install mods and modpacks for Minecraft or a Minecraft server

> [!NOTE]
> This readme is for the development version, it may differ from the latest release. You can view the readme for the latest release [here](../release-0.4.x/readme.md).

> [!NOTE]
> Breaking change from 0.3.x: mc-get no longer installs modpacks in the .minecraft folder directly! It now supports managing multiple concurrent Minecraft installations.

## Modding Platform Support

Supports downloading from the two major modding platforms [Modrinth](https://modrinth.com/) and [CurseForge](https://www.curseforge.com/)!\
⚠️ CurseForge needs extra configuration to work. [Click here](https://github.com/ThunderClapLP/mc-get/issues/1) for a more detailed explanation. ⚠️

How to set the CurseForge API key:

mc-get --set cfApiKey=

## Usage

Usage:
mc-get (flags)
mc-get (flags) (parameters)

Flags:
-h, --help : displays this help page
-s, --silent : performs a silent install. No user input needed
-p, --platform : installs from specified platform
either modrinth (mr) or curseforge (cf)
-m, --mc-path : specifies minecraft installation path
--path : specifies the target installation path
can also be used as a filter in other commands
--mc-version : specifies the minecraft version
--server : installs mod / modpack as server
--set = : sets a setting to the specified value
--unset : resets a setting to its default value
--version : displays the current version

Commands:
install ::
installs a mod / modpack

search
searches for modrinth/curseforge projects

list installs
lists all installed modpacks
list mods
lists all custom mods in installation
that fit the search term (either slug or id)

remove installation
removes an installation that fits the search term (either slug or id)
--path can also be used as a filter
remove mod
removes a mod from an installation
both and are search terms (either slug or id)
--path can also be used as a filter

Examples:
mc-get install sodium:0.6.6:fabric
mc-get --mc-version 1.19.3 install fabulously-optimized
mc-get install fabulously-optimized
mc-get -s install fabulously-optimized
mc-get Fabulously.Optimized-4.10.5.mrpack
mc-get list mods
mc-get list mods fabulously-optimized
mc-get remove installation 123
mc-get remove installation fabulously-optimized
mc-get remove mod fabulously-optimized sodium

## OS Compatibility

- Windows: Working (last tested: v0.4.0)
- Linux: Working (last tested: v0.4.0)
- MacOS: Working (last tested: v0.4.0 dev build)

## Supported Modloaders

- Forge
- NeoForge
- Fabric
- Quilt

## Building

Requires the [.Net 8 Sdk](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
> [!NOTE]
> Can be built with .net 6, but some features may not be available

Run following command to generate an executable:

dotnet build

For more informations about building .Net applications visit [this article](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-build)