From 9a603339fdfce5649bfabb95cc154caab3503d9f Mon Sep 17 00:00:00 2001 From: Sokomine Date: Tue, 27 Dec 2016 05:05:52 +0100 Subject: [PATCH] updated readme file --- README.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 15bd4f8..274e410 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,34 @@ -This mod is not finished yet. +This mod is not entirely finished, but may already be very useful. -Create a file named +Type "/giveme handle_schematics:build" to get a build chest. +Place the chest in the world and click through the menue. + +The examples/ folder contains some very small saved buildings which +allow you to just spawn them and play with the options even if you +don't have one of your own houses at hand. The example files do +not require much disk space. They are very small. + +NOTE: In order to be able to spawn a schematic, you need to copy +the schematic file to your /schems/ folder. With security +enabled in your minetest.conf (in general a very good idea!), mods +cannot even read files from anything that is not stored inside your +world folder or one of its subfolders. + +Supported schematic types: + *.mts Minetest schematic + *.we WorldEdit savefile format + *.schematic Used in the Minecraft world + +Optional: You can also create a file named list_of_schematics.txt in the folder containing this mod (not the world!). Each line of the file ought to contain the name and full path to a schematic. Those will be offered to you in the build chest's menu under "main". +The advantage of this method is low as with security enabled, files can only +be read from the / folder. You can ignore this option for now. + +Author: Sokomine +License: GPLv3.0 +Last update: 27.12.2016 -Type "/giveme handle_schematics:build" to get a build chest.