Created README

master
ExpandingDev 2019-10-13 20:30:00 +00:00
parent db2cece862
commit 0a0b2c8680
1 changed files with 17 additions and 0 deletions

17
README.md Normal file
View File

@ -0,0 +1,17 @@
# Better MCL2 Converter
This is a second iteration at attempts to create the best Minecraft to Mine Clone 2 texture pack converter.
This script breaks apart each outputted image into individual JSON files known as "conversion targets".
The script iterates through the conversion targets in the `conversion-data` directory to find the instructions on how to convert each image for MCL2.
## Requirements
Image magick 6 or 7 need to be installed. Python 3 is required.
## Usage
python3 convert-mc-resource-pack.py [OPTIONS] INPUT-RESOURCE-PACK.zip [OUTPUT-NAME]
INPUT-RESOURCE-PACK does not have to be in a .zip file. If it is unzipped already then that is ok. If it is zipped, this script will unzip it into this directory.
OUTPUT-NAME is optional, if no output name is given, the resulting MineClone2 texture pack will be written to OUTPUT-NAME, or set to the value of .pack.name in the pack.mcmeta file.
OPTIONS may be one of:
-h --help Display this usage text.
-v --version Display the version of this script and then exit.
-d --debug Enables debug mode and logging to log and warning files.