GithubHelp home page GithubHelp logo

jaredallard / modpacker Goto Github PK

View Code? Open in Web Editor NEW
12.0 2.0 0.0 305 KB

✨ run and create modded minecraft installations from the CLI

License: BSD 3-Clause "New" or "Revised" License

JavaScript 100.00%
minecraft minecraft-modpack minecraft-forge-mod

modpacker's Introduction

modpacker

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

modpacker help screen

Installation

Until binaries are created, you can install this via npm:

$ npm install -g modpacker

or, if you prefer yarn (like I do)

$ yarn global add modpacker

Usage

Building a modpack

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

version: 1.0.0
name: MODPACK_NAME
author: YOUR NAME <[email protected]>
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:

$ yarn build

Tests will be added one day, maybe.

License

BSD-3-Clause

modpacker's People

Contributors

dependabot[bot] avatar jaredallard avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.