https://github.com/nothub/mrpack-install

Modrinth Modpack server deployment
https://github.com/nothub/mrpack-install

golang modrinth mrpack

Last synced: 10 days ago
JSON representation

Modrinth Modpack server deployment

Host: GitHub
URL: https://github.com/nothub/mrpack-install
Owner: nothub
License: mit
Created: 2022-08-30T18:02:00.000Z (over 2 years ago)
Default Branch: trunk
Last Pushed: 2024-10-29T08:31:59.000Z (6 months ago)
Last Synced: 2024-10-29T09:51:43.484Z (6 months ago)
Topics: golang, modrinth, mrpack
Language: Go
Homepage: https://pkg.go.dev/github.com/nothub/mrpack-install
Size: 383 KB
Stars: 151
Watchers: 2
Forks: 8
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

awesome - nothub/mrpack-install - Modrinth Modpack server deployment (Mod managers/updaters / CLI)

README

# mrpack-install

[![downloads](https://img.shields.io/github/downloads/nothub/mrpack-install/total.svg?style=flat-square&labelColor=5c5c5c&color=007D9C)](https://github.com/nothub/mrpack-install/releases/latest)
[![discord](https://img.shields.io/discord/1149744662131777546?style=flat-square&labelColor=5c5c5c&color=007D9C)](https://discord.gg/QNbTeGHBRm)
[![go pkg](https://pkg.go.dev/badge/github.com/nothub/mrpack-install.svg)](https://pkg.go.dev/github.com/nothub/mrpack-install)

A cli application for installing Minecraft servers and [Modrinth](https://modrinth.com/) [modpacks](https://support.modrinth.com/en/articles/8802351-modrinth-modpack-format-mrpack).

---

## Commands

### root

```
Deploys a Modrinth modpack including Minecraft server.

Usage:
mrpack-install ( | | [] | []) [flags]
mrpack-install [command]

Examples:
mrpack-install https://example.org/data/cool-pack.mrpack
mrpack-install downloads/cool-pack.mrpack --proxy socks5://127.0.0.1:7890
mrpack-install adrenaserver --server-file srv.jar
mrpack-install yK0ISmKn 1.0.0-1.18 --server-dir mcserver
mrpack-install communitypack9000 --host api.labrinth.example.org
mrpack-install example.mrpack --optional-select 'foo\.jar' \
--optional-select 'bar-[\d+\.]+\.jar'

Available Commands:
completion Generate the autocompletion script for the specified shell
help Help about any command
ping Ping a Labrinth instance
server Prepare a plain server environment
update Update the deployed modpack
version Print version infos

Flags:
--dl-retries uint8 Retries when download fails (default 3)
--dl-threads uint8 Concurrent download threads (default 8)
-h, --help help for mrpack-install
--host string Labrinth host address (default "api.modrinth.com")
--optional-disable-all Disable all optional mods
--optional-select stringArray Select optional mods by file path (regex)
--proxy string Proxy url for http connections
--server-dir string Server directory path (default "mc")
--server-file string Server jar file name
-v, --verbose Enable verbose output
-V, --version Print version and exit

Use "mrpack-install [command] --help" for more information about a command.

```

### ping

```
Connect to a Labrinth instance and display basic information.

Usage:
mrpack-install ping [flags]

Flags:
-h, --help help for ping

Global Flags:
--dl-retries uint8 Retries when download fails (default 3)
--dl-threads uint8 Concurrent download threads (default 8)
--host string Labrinth host address (default "api.modrinth.com")
--proxy string Proxy url for http connections
--server-dir string Server directory path (default "mc")
--server-file string Server jar file name
-v, --verbose Enable verbose output

```

### server

```
Download and configure one of several Minecraft server flavors.

Examples:
mrpack-install server fabric --server-dir fabric-srv
mrpack-install server paper --minecraft-version 1.18.2 --server-file srv.jar

Flags:
--flavor-version string Flavor version (default "latest")
-h, --help help for server
--minecraft-version string Minecraft version (default "latest")

```

### update

```
Update the deployed modpacks files, creating backups if necessary.

Usage:
mrpack-install update [] [flags]

Flags:
--backup-dir string Backup directory path
-h, --help help for update
--optional-disable-all Disable all optional mods
--optional-select stringArray Select optional mods by file path (regex)

```

### version

```
Extract and display the running binaries embedded version information.

Usage:
mrpack-install version [flags]

Flags:
-h, --help help for version

```

## Build

To build an executable, run:

```sh
go tool goreleaser build --clean --snapshot --single-target
```

## Release

To build a local snapshot release, run:

```sh
go tool goreleaser release --clean --snapshot
```