From 0e00c85f993c15f276d48df246a714cdc2413ee7 Mon Sep 17 00:00:00 2001 From: Wuzzy Date: Tue, 5 Jun 2018 01:44:57 +0200 Subject: [PATCH] Add README into tools directory --- tools/README.md | 26 ++++++++++++++++++++++++++ tools/Texture_Converter.py | 16 +++------------- 2 files changed, 29 insertions(+), 13 deletions(-) create mode 100644 tools/README.md diff --git a/tools/README.md b/tools/README.md new file mode 100644 index 000000000..3f0698770 --- /dev/null +++ b/tools/README.md @@ -0,0 +1,26 @@ +# MineClone 2 Tools +This directory is for tools and scripts for MineClone 2. +Currently, the only tool is Texture Converter. + +## Texture Converter (EXPERIMENTAL) +This is a Python script which converts a resource pack for Minecraft to +a texture pack for Minetest (and thus, MineClone 2). + +**WARNING**: This script is currently incomplete, not all textures will be +converted. Some texture conversions are even buggy! +For a 100% complete texture pack, a bit of manual work will be required +afterwards. + +Modes of operation: +- Can create a Minetest texture pack (default) +- Can update the MineClone 2 textures + +Requirements: +- Know how to use the console +- Python 3 +- ImageMagick + +Usage: +- Make sure the file “`Conversion_Table.csv`” is in the same directory as the script +- In the console, run `./Texture_Converter.py -h` to learn the available options + diff --git a/tools/Texture_Converter.py b/tools/Texture_Converter.py index 22a6fe6b7..3f449a15e 100755 --- a/tools/Texture_Converter.py +++ b/tools/Texture_Converter.py @@ -1,17 +1,7 @@ #!/usr/bin/env python -# EXPERIMENTAL texture pack converting utility. -# This Python script helps in converting Minecraft texture packs. It has 2 main features: -# - Can create a Minetest texture pack (default) -# - Can update the MineClone 2 textures -# This script is currently incomplete, not all textures are converted. -# -# Requirements: -# - Python 3 -# - ImageMagick -# -# Usage: -# - Make sure the file “Conversion_Table.csv” is in the same directory as the script -# - Run ./Texture_Converter.py -h to learn the available options +# Texture Converter. +# Converts Minecraft resource packs to Minetest texture packs. +# See README.md. __author__ = "Wuzzy" __license__ = "MIT License"