From c5ad404910b4fc11182aa3b08af803a191df2257 Mon Sep 17 00:00:00 2001 From: Dmitry Kostenko Date: Thu, 18 Feb 2021 00:43:00 +0100 Subject: [PATCH] Add important notes to README.md Reword description of Undo tool. --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1a46181..87bb671 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ you can use to add, remove or reshape the terrain. The brush features: * Painting with random patterns using multiple block types. * Mask support for conditional painting and replacing. * Multilevel undo (see below) -* Drrawing modifiers: +* Drawing modifiers: * **Scatter** - randomly fill 5% of the paintable blocks. * **Surface** - only change blocks under air. * **Decorate** - only place new blocks on top of surface blocks. @@ -46,7 +46,8 @@ How to use: ![(undo icon)](textures/terraform_tool_undo.png "Undo tool icon") -The name speaks for itself. The tool adds an in-memory undo engine that captures edits of each player and allows them to undo their changes to the world. +The tool adds an in-memory undo engine that captures both edits with the Brush tool and +usual 'digs' and 'places'. "Place" (Right click) to undo one change, hold to undo many changes (fun to watch). @@ -66,3 +67,22 @@ This is a tiny helper tool to correct light and shadow problems in the world, wh "Place" (Right click) to recalculate light in a cuboid within 100 blocks from the target. +## Before you start + +Here are important notes to know before you enable the mod on your server: + +* You need "terraform" privilege to be able to use the tools. As server owner, grant + terraform privilege only to trusted users. +* Several players using undo very close to each other may cause unexpected results. +* Current implementation of the undo engine consumes server memory and will lead + to server crash if used for a very long time or by many players at once. +* Light recalculation, flow of liquids and falling of physical blocks (e.g. sand) are + not triggered by the mod's tools and are not supported by the undo engine. + You can fix the light with the Light fixer tool, trigger water flow by placing a water + source and cause blocks to fall by digging one of them. + +## Installation + +Unpack the release package into `mods/terraform` folder of your Minetest installation. +Read more about installing mods in Minetest [here](https://wiki.minetest.net/Installing_Mods). +