From 308d9e218c8460efcfe3a0a369d2daa30a536363 Mon Sep 17 00:00:00 2001 From: bzt Date: Mon, 16 Dec 2019 23:26:15 +0100 Subject: [PATCH] Docs --- README.md | 5 +++-- docs/batch.md | 3 ++- docs/import.md | 4 ++-- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 721d62b..5094d48 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,9 @@ Minetest MTS Editor Batch Mode ---------- -You can convert MTS files and generate preview images for them from a script with this tool. You can also generate the block -images for the editor. [Read more](https://gitlab.com/bztsrc/mtsedit/blob/master/docs/batch.md). +You can convert MTS files and [other formats](https://gitlab.com/bztsrc/mtsedit/blob/master/docs/import.md), generate preview +images or blueprints for them from a script with this tool. You can also generate the block images for the editor. +[Read more](https://gitlab.com/bztsrc/mtsedit/blob/master/docs/batch.md). Interactive Mode ---------------- diff --git a/docs/batch.md b/docs/batch.md index bb7e68a..0766e75 100644 --- a/docs/batch.md +++ b/docs/batch.md @@ -54,7 +54,8 @@ doesn't care, it can import both blueprint types. ### Conversion (or Remap Output) -You can convert different formats like Minecraft NBT Schematics and Goxel and Magicavoxel voxel images with this tool. +You can convert [different formats](https://gitlab.com/bztsrc/mtsedit/blob/master/docs/import.md) like Minecraft NBT Schematics +and Goxel and Magicavoxel voxel images with this tool. ``` ./mtsedit from.schematic structure.mts ``` diff --git a/docs/import.md b/docs/import.md index b98beeb..73c6478 100644 --- a/docs/import.md +++ b/docs/import.md @@ -10,7 +10,7 @@ Blueprint PNG MTSEdit is capable to save schematic blueprints to PNG files using the `-b` or `-B` flags. These can be imported too. Blueprints are simple 32 bit PNG images, which has layers from top to bottom, separated by 1 pixel vertically, starting at the -2nd coloumn. In the first coloumn, there's a black pixel (full transparent black, 0xFF000000) for each layer start. This is used +2nd coloumn. In the first coloumn, there's a black pixel (full opaque black, 0xFF000000) for each layer start. This is used to detect where the first layer starts and what the layer's height is. If that particular layer is the ground level, then that pixel is full red (0xFF0000FF). That's all. Layer width ends at the first blue background pixel (0xFF3F0000, which must not be used in node encodings) or at image width minus 1. @@ -32,7 +32,7 @@ Limitations: rotation info are not imported properly, but works for basic nodes Model 3D Files -------------- -This is an application independent, universal [Model 3D](https://bztsrc.github.io/model3d) format, capable of storing voxel images. +This is an application independent, universal [Model 3D](https://bztsrc.gitlab.io/model3d) format, capable of storing voxel images. More than that, because it can store names and rotation info to voxel types, it is perfectly capable to reliably store schematic. If voxel type names are not specified, then it fallbacks to closest color match. Typical extension is `.m3d`.