README

MCmod is a command line tool developed by Indemnity83 that aids in packing mods for distribution. It allows you to easily produce the zip file required by Technic Solder for distribution in a single command. It's the tool we use to package mods in our modpacks!

MCmod reads data directly from the forge mcmod.info file located in the jar file. This means packaging mod files into distribution zips takes almost no effort on your part.

Installation & Setup

Installing PHP & Composer

MCmod requires composer and php be installed on your system. Installation of these tools is beyond the scope of this document, but support can be found below

Windows

• PHP Install
• Composer Install

OSX

• PHP Install
• Composer Install

Linux

• PHP Install
• Composer Install

Installing MCmod

Once PHP and Composer have been installed, you are ready to install the MCmod CLI tool using the Composer global command:

composer global require "indemnity83/mcmod"

Make sure to place the ~/.composer/vendor/bin directory in your PATH so the MCmod executable is found when you run the bakery command in your terminal.

Quick Start

To package a mod file (.jar or .zip) into a distribution package, simply use the following command. The mcmod.info will be read from the mod file and used to create a folder, containing a zip that is named by a pre-established convention of --.zip

mcmod pack <path to mod file>