Add README into tools directory
[MineClone/MineClone2.git] / tools / README.md
blob3f069877068dfb8266f7da128678702949206b5b
1 # MineClone 2 Tools
2 This directory is for tools and scripts for MineClone 2.
3 Currently, the only tool is Texture Converter.
5 ## Texture Converter (EXPERIMENTAL)
6 This is a Python script which converts a resource pack for Minecraft to
7 a texture pack for Minetest (and thus, MineClone 2).
9 **WARNING**: This script is currently incomplete, not all textures will be
10 converted. Some texture conversions are even buggy!
11 For a 100% complete texture pack, a bit of manual work will be required
12 afterwards.
14 Modes of operation:
15 - Can create a Minetest texture pack (default)
16 - Can update the MineClone 2 textures
18 Requirements:
19 - Know how to use the console
20 - Python 3
21 - ImageMagick
23 Usage:
24 - Make sure the file “`Conversion_Table.csv`” is in the same directory as the script
25 - In the console, run `./Texture_Converter.py -h` to learn the available options