Added README

This commit is contained in:
ExpandingDev 2019-10-10 14:58:21 -04:00
parent 1b719b31dc
commit 47d6250e84
1 changed files with 28 additions and 0 deletions

28
README.md Normal file
View File

@ -0,0 +1,28 @@
# MCL2 Resource Pack Converter
This is a cross-platform Python 3 script that can convert **almost** any recent Minecraft resource pack into a MineClone2 texture pack.
## Requirements
The script requires Python 3 installed along with Image Magick version 7. Image Magick version 6 is currently unsupported.
## Usage
convert-mc-resource-pack.sh [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_DIR, 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.
## Unsupported Features
o. Still needs tested on Linux environment.
o. Does not work with Image Magick version 6
o. Cropping of mobs, chests, and armor still unsupported.
o. Does not convert normal and specular maps.
## Tested Platforms
o. Windows 10, Image Magick version 7
## Roadmap
1. Test current functionality on Linux distribution
2. Enable conversion of normal and specular maps.
3. Cropping of Chests
5. Cropping of armor