README.md

   1 # Schematic Editor [`schemedit`]
   2
   3 ## Version
   4 1.5.1
   5
   6 ## Description
   7 This is a mod which allows you to edit and export schematics (`.mts` files).
   8
   9 This mod works in Minetest 5.0.0 or later, but recommended is version 5.1.0
  10 or later.
  11
  12 It supports node probabilities, forced node placement and slice probabilities.
  13
  14 It adds 3 items:
  15
  16 * Schematic Creator: Used to mark a region and export or import it as schematic
  17 * Schematic Void: Marks a position in a schematic which should not replace anything when placed as a schematic
  18 * Schematic Node Probability Tool: Set per-node probabilities and forced node placement
  19
  20 Note: The import feature requires Minetest 5.1.0 or later.
  21
  22 It also adds these server commands:
  23
  24 * `placeschem` to place a schematic
  25 * `mts2lua` to convert .mts files to .lua files (Lua code)
  26
  27 There's also a setting `schemedit_export_lua` to enable automatic export to .lua files.
  28
  29 ## Usage help
  30 This mod assumes you already have a basic understanding about how schematics in Minetest work.
  31 If not, refer to the Minetest Lua API documentation to understand more about schematics.
  32
  33 To learn how to use all the items in this mod, read `USAGE.md`.
  34
  35 You can also find the same help texts in-game if you if you use the optional Help modpack
  36 (mods `doc` and `doc_items`).
  37
  38 ## License of everything
  39 MIT License