MineClone2/tools/README.md
teknomunk b582afeb1f Update documentation for Minetest rename to Luanti (#4706)
This updates the VoxeLibre documentation by replacing "Minetest" with "Luanti" and updating links.

Done:
* Update "Minetest" in documentation and comments to "Luanti"
* Update links to forums, ContentDB and Luanti project web page

Reviewed-on: https://git.minetest.land/VoxeLibre/VoxeLibre/pulls/4706
Reviewed-by: the-real-herowl <the-real-herowl@noreply.git.minetest.land>
Co-authored-by: teknomunk <teknomunk@protonmail.com>
Co-committed-by: teknomunk <teknomunk@protonmail.com>
2024-11-28 20:55:48 +01:00

44 lines
1.4 KiB
Markdown

# VoxeLibre Tools
This directory is for tools and scripts for VoxeLibre.
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 Luanti so it can be used with VoxeLibre.
**WARNING**: This script is currently incomplete, not all textures will be
converted. Some texture conversions are even buggy!
Coverage is close to 100%, but it's not quite there yet.
For a 100% complete texture pack, a bit of manual work on the textures
will be required afterwards.
Modes of operation:
- Can create a Luanti texture pack (default)
- Can update the VoxeLibre 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
- Convert the textures
- Put the new texture directory in the Luanti texture pack directory, just like
any other Luanti texture pack
## Luacheck Globals Generators
This is a Python script which list every single global tables in VoxeLibre source code.
It outputs a list to be used in luacheck conf files.
Modes of operation:
- List global tables
Requirements:
- Know how to use the console
- Python 3
Usage:
- In the console, run `python3 ./tools/create_luacheck.py` in the MineClone2 directory