Add quick start instructions in README

This commit is contained in:
Wuzzy 2023-12-23 20:23:50 +01:00
parent 70eeedf85c
commit 85efb7d371

View File

@ -26,11 +26,49 @@ It also adds these server commands:
There's also a setting `schemedit_export_lua` to enable automatic export to .lua files.
## Usage help
This mod assumes you already have a basic understanding about how schematics in Minetest work.
If not, refer to the Minetest Lua API documentation to understand more about schematics.
## Quick Start
To learn how to use all the items in this mod, read `USAGE.md`.
### Creating a schematic
To create a schematic file:
1. Choose a cuboid area you like to become a schematic
2. Place a Schematic Creator in front of one of the bottom 4 corners of the area
3. Use (rightclick) the Schematic Creator
4. Enter a size and click on “Save size”
5. Enter a schematic name and click on “Export schematic”
The schematic will be saved in your world directory; you'll see the exact location in chat.
### Importing a schematic
You can import a schematic file if it already exists in your world directory under `schems`.
Then do the following:
1. Place a schematic creator on the ground
2. Enter the schematic file name
3. Click on “Import schematic”
This will both place the schematic and import advanced schematic information
(probabilities, force-placement).
### Placing a schematic
Use the `/placeschem` chat command to place a schematic as if it were placed by the game.
This is useful to test a schematic to see the end result.
## Advanced usage
By default, if you export a schematic and place it again, every node will be placed,
including air.
But you can place a special Schematic Void to mark positions that should not be overridden
when the schematic is placed. This is very useful for trees.
You can also set probabilities for certain nodes to be placed, or tell the game to
force-place nodes.
For detailed information read `USAGE.md`.
You can also find the same help texts in-game if you if you use the optional Help modpack
(mods `doc` and `doc_items`).