aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d88553f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+# Realtime Elevators for Minetest
+
+## Dependencies
+This mod has no dependencies other than default, but has recipes designed for use with technic and homedecor/chains and will detect if those are installed.
+
+## Usage
+Each shaft begins with a motor, and extends down through shaft and elevator nodes. Each elevator node can be used to travel to any other elevator node below the motor and through an unbroken shaft. Only one player can use each shaft at once.