Add README into tools directory
This commit is contained in:
parent
64fe90257d
commit
0e00c85f99
2 changed files with 29 additions and 13 deletions
26
tools/README.md
Normal file
26
tools/README.md
Normal file
|
@ -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
|
||||||
|
|
|
@ -1,17 +1,7 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
# EXPERIMENTAL texture pack converting utility.
|
# Texture Converter.
|
||||||
# This Python script helps in converting Minecraft texture packs. It has 2 main features:
|
# Converts Minecraft resource packs to Minetest texture packs.
|
||||||
# - Can create a Minetest texture pack (default)
|
# See README.md.
|
||||||
# - 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
|
|
||||||
|
|
||||||
__author__ = "Wuzzy"
|
__author__ = "Wuzzy"
|
||||||
__license__ = "MIT License"
|
__license__ = "MIT License"
|
||||||
|
|
Reference in a new issue