https://github.com/jaredallard/modpacker

✨ run and create modded minecraft installations from the CLI
https://github.com/jaredallard/modpacker

minecraft minecraft-forge-mod minecraft-modpack

Last synced: 7 days ago
JSON representation

✨ run and create modded minecraft installations from the CLI

• Host: GitHub
• URL: https://github.com/jaredallard/modpacker
• Owner: jaredallard
• License: bsd-3-clause
• Archived: true
• Created: 2019-10-24T06:12:57.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T06:37:54.000Z (about 2 years ago)
• Last Synced: 2024-09-20T13:02:16.278Z (4 months ago)
• Topics: minecraft, minecraft-forge-mod, minecraft-modpack
• Language: JavaScript
• Homepage:
• Size: 298 KB
• Stars: 12
• Watchers: 2
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# modpacker

Modpacker is a modded minecraft installer and creator that runs entirely from the CLI

![modpacker help screen](.github/modpacker.png)

## Installation

Until binaries are created, you can install this via [npm](https://npmjs.org):

```bash

$ npm install -g modpacker

```

or, if you prefer yarn (like I do)

```bash

$ yarn global add modpacker

```

## Usage

### Building a modpack

First create `modpack.yaml` in your `.minecraft` directory where the modpack is currently "installed"

```yaml

version: 1.0.0

name: MODPACK_NAME

author: YOUR NAME 

minecraft:

  javaArgs: >-

    -Xmx8G -Xms2G -XX:+UnlockExperimentalVMOptions -XX:+UseG1GC

    -XX:G1NewSizePercent=20 -XX:G1ReservePercent=20 -XX:MaxGCPauseMillis=50

    -XX:G1HeapRegionSize=32M

  version: 1.12.2

forge:

  version: 14.23.5.2847

mods: []

```

Then run `modpacker build` inside of that directory, make sure that `mods` and `config` exists in that directory.

This will create two `.tar.gz` files in that directory, a server version and a client version. Your `.yaml` file

will have been edited to reflect the mods under the `mods` section. Set `client` to true if you want to ONLY include

this mod in the "client" version of the mod, i.e map mods, etc.

That's your modpack!

### Installing a modpack

Find your modpack online, or use a `file://` link to your modpack's location and supply that to

`modpack install`

This will take care of installing forge, installing the modpack, and creating a minecraft launcher profile for your modpack.

If you launch the Minecraft launcher, you will see your ModPack is available as the entry in `name` of the config.

### Developing

Make sure you have eslint installed to enforce style rules and better code in general.

To build binaries, run:

```bash

$ yarn build

```

Tests will be added one day, maybe.

## License

BSD-3-Clause