aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBeha <shacknetisp@mail.com>2021-06-16 22:54:34 -0400
committerBeha <shacknetisp@mail.com>2021-06-16 22:58:00 -0400
commit6d6e6968e1c1ac04e5d7616cf1adb9492fd444c5 (patch)
tree7d16c96e0ced582bf66654c34d98a99b66e517e2
parent65d677371aa4d8b28dbfce573e3b117936ecf75f (diff)
downloadelevator-6d6e6968e1c1ac04e5d7616cf1adb9492fd444c5.tar.gz
elevator-6d6e6968e1c1ac04e5d7616cf1adb9492fd444c5.tar.bz2
elevator-6d6e6968e1c1ac04e5d7616cf1adb9492fd444c5.zip
Add doc_items help.
-rw-r--r--components.lua7
-rw-r--r--mod.conf2
2 files changed, 8 insertions, 1 deletions
diff --git a/components.lua b/components.lua
index 8a879f2..53f68a8 100644
--- a/components.lua
+++ b/components.lua
@@ -76,6 +76,8 @@ end
minetest.register_node("elevator:shaft", {
description = "Elevator Shaft",
+ _doc_items_longdesc = "An elevator shaft that connects elevators to other elevators and motors.",
+ _doc_items_usagehelp = "Building a vertical stack of elevators and shafts with an elevator motor on top allows vertical transportation.",
tiles = { moditems.el_shaft_gfx },
drawtype = "nodebox",
use_texture_alpha = "clip",
@@ -117,6 +119,8 @@ minetest.register_node("elevator:shaft", {
minetest.register_node("elevator:motor", {
description = "Elevator Motor",
+ _doc_items_longdesc = "The engine powering an elevator shaft. Placed at the top.",
+ _doc_items_usagehelp = "Place the motor on the top of a stack of elevators and elevator shafts. The elevators will activate and you can then use them.",
tiles = {
moditems.steel_block_image,
moditems.steel_block_image,
@@ -235,6 +239,9 @@ for _,mode in ipairs({"on", "off"}) do
on_rotate = moditems.on_rotate_disallow,
climbable = true,
+ _doc_items_longdesc = on and "An active elevator, ready for transporting." or "An inactive elevator, not connected to a motor.",
+ _doc_items_usagehelp = on and "Step inside this elevator and use it (right-click) to be transported to any other elevator along the shaft." or "This elevator is inactive; it is disconnected from a motor. It may be extended with shafts and other elevators in a vertical line with an elevator motor on top to power the whole shaft and enable transport.",
+
selection_box = {
type = "fixed",
fixed = box,
diff --git a/mod.conf b/mod.conf
index f433fcb..396e669 100644
--- a/mod.conf
+++ b/mod.conf
@@ -1,4 +1,4 @@
name = elevator
description = An entity-based elevator allowing fast realtime travel in Minetest. Supports Minetest Game, MineClone2, and Aurum
-optional_depends = default, technic, homedecor, chains, farming, mcl_core, mcl_sounds, aurum, screwdriver
+optional_depends = default, technic, homedecor, chains, farming, mcl_core, mcl_sounds, aurum, screwdriver, doc_items
min_minetest_version = 5.4