minepkg

README

minepkg is a package manager designed to install Minecraft mods and modpacks.

---

This project is not ready for use yet! Please join our discord if you are interested in testing

List of current limitations

Features

• Installs mods from minepkg (with dependency resolution)
• Can launch Minecraft
• Join compatible modded Servers with one command (Installs modpack and launches Minecraft & joins the server for you)
• Saves your installed mods in a sharable minepkg.toml
  • minepkg.toml modpacks can extend other modpacks
• Publish mods and modpacks to minepkg.io

Installation

You can read the installation docs here for more detailed instructions.

Linux & MacOS

Run this in your favorite shell.

curl -s https://preview.minepkg.io/install.sh | bash

Windows

Run this in powershell

. { iwr -useb https://preview.minepkg.io/install.ps1} | iex

Usage

• FAQ
• Manifest Documentation
• Mod publishing

$ minepkg --help
Manage Minecraft mods with ease

Usage:
  minepkg [command]

Examples:

  minepkg init -l fabric
  minepkg install modmenu@latest
  minepkg join demo.minepkg.host

Available Commands:
  build               Runs the set buildCmd (falls back to gradle build)
  help                Help about any command
  init                Creates a new mod or modpack in the current directory
  install             Installs one or more packages in your current modpack or mod
  join                Joins a compatible server without any setup
  launch              Launch the given or local modpack.
  login               Sign in to Mojang in order to start Minecraft
  minepkg-login       Sign in to minepkg.io (mainly for publishing)
  publish             Publishes the local package in the current directory
  remove              Removes specified package from the current package
  selfupdate          Updates minepkg to the latest version
  try                 Lets you try a mod or modpack in Minecraft
  update              Updates all installed dependencies
  update-requirements Updates installed requirements (minecraft & loader version)

Flags:
  -a, --accept-minecraft-eula   Accept Minecraft's eula. […]
      --config string           config file (default is $HOME/.minepkg/config.toml)
  -h, --help                    help for minepkg
      --no-color                disable color output
      --system-java             Use system java instead […]
      --verbose                 More verbose logging. Not really implemented yet
  -v, --version                 version for minepkg

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

Demo

Building

Requires go ~ 1.16+. Could also work with older go versions. Just go run main.go [commands] or go build -o out/minepkg

git clone https://github.com/minepkg/minepkg.git
cd minepkg
go run main.go --help