minepkg

command module
v0.1.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 6, 2022 License: MIT Imports: 1 Imported by: 0

README

minepkg

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


main builds Maintainability Discord

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

$ 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:
  bump                Bumps the version number of this package
  config              Manage global config options
  dev                 Advanced package dev related tasks (eg. 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.
  publish             Publishes the local package in the current directory to minepkg.io
  remove              Removes supplied package from the current directory & 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. See https://www.minecraft.net/en-us/eula/
      --config string           config file (default is /home/fiws/.config/minepkg/config.toml)
  -h, --help                    help for minepkg
      --non-interactive         Do not prompt for anything (use defaults 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

minepkg install preview

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

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
dev
internals
api
Package api is a client for the minepkg API https://api.minepkg/docs
Package api is a client for the minepkg API https://api.minepkg/docs
fabric
mostly stolen from https://gist.github.com/crgimenes/c3b8b4fcce8529e9201f83c8da134f32
mostly stolen from https://gist.github.com/crgimenes/c3b8b4fcce8529e9201f83c8da134f32
minecraft/mojang
Package mojang allows to login to a mojang account in order to start Minecraft
Package mojang allows to login to a mojang account in order to start Minecraft
pkg
manifest
Package manifest defines the file format that describes a mod or modpack.
Package manifest defines the file format that describes a mod or modpack.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL