Wrench support extend

.luacheckrc

@@ -1,16 +1,22 @@
 unused_args = false
 allow_defined_top = true
-max_line_length = 999
 
 globals = {
-    "technic", "minetest",
+	"minetest",
 }
 
 read_globals = {
-    string = {fields = {"split", "trim"}},
-    table = {fields = {"copy", "getn"}},
+	string = {fields = {"split"}},
+	table = {fields = {"copy"}},
 
-    "intllib", "ItemStack", "drawers",
-}
+	-- Minetest
+	"ItemStack",
 
-files["init.lua"].ignore = { "name", "stack" }
+	-- Mods
+	"digilines",
+	"drawers",
+	"mesecon",
+	"pipeworks",
+	"signs_lib",
+	"xdecor",
+}

API.md

@@ -0,0 +1,88 @@
+# API
+
+## Node registration
+
+Schematic:
+```lua
+wrench.register_node(node.name, {
+	lists = list,
+	-- inventory list
+
+	lists_ignore = lists_ignore,
+	-- ignored and not saved inventory list
+
+	metas = table,
+	-- Table for node metadata:
+		-- name: Meta name
+		-- type: Data type:
+			-- `wrench.META_TYPE_IGNORE` ignored and not saved
+			-- `wrench.META_TYPE_FLOAT` for float
+			-- `wrench.META_TYPE_STRING` for string
+			-- `wrench.META_TYPE_INT` for integer
+
+	description = nil,
+	-- Default behavior:
+		-- when `lists` is not `nil`
+			-- `minetest.registered_nodes[node.name].description` + " with items"
+		-- when `lists` is `nil` and only `metas.channel` is defined
+			-- `minetest.registered_nodes[node.name].description` + " with channel '<CHANNEL>'"
+		-- when `lists` is `nil`
+			-- `minetest.registered_nodes[node.name].description` + " with configuration"
+	description = `wrench.description_with_items`,
+	-- Description of the node + " with items"
+	description = `wrench.description_with_configuration`,
+	-- Description of the node + " with configuration"
+	description = `wrench.description_with_channel`,
+	-- Description of the node + " with channel " + channel
+	description = `wrench.description_with_text`,
+	-- Description of the node + " with text " + text
+	description = function(pos, meta, node, player),
+	-- Function returns description
+
+	drop = nil,
+	-- Default dropped item is the node itself
+	drop = true,
+	-- Use `minetest.registered_nodes[node.name].drop`
+	drop = "default:cobble",
+	-- Name of dropped item
+
+	owned = nil,
+	-- Default: anyone can pickup this node
+	owned = true,
+	-- Only `metas["owner"]` can pickup this node
+
+	timer = nil,
+	-- Default
+	timer = true,
+	-- Save node timers
+
+	before_pickup = nil,
+	-- Default
+	before_pickup = function(pos, meta, node, player)
+	-- Function called before pickup node
+
+	after_pickup = nil,
+	-- default
+	after_pickup = function(pos, node, meta_table, player)
+	-- Function called after pickup node
+
+	after_place = nil,
+	-- Default
+	after_place = function(pos, player, itemstack, pointed_thing),
+	-- Function called after place node
+})
+```
+
+Example:
+```lua
+wrench.register_node("bones:bones", {
+	lists = {"main"},
+	metas = {
+		owner = wrench.META_TYPE_STRING,
+		infotext = wrench.META_TYPE_STRING,
+		formspec = wrench.META_TYPE_STRING,
+		time = wrench.META_TYPE_INT,
+	},
+	owned = true,
+})
+```

README.md

@@ -1,2 +1,161 @@
 ![](https://github.com/mt-mods/wrench/workflows/luacheck/badge.svg)
 [![License](https://img.shields.io/badge/license-LGPLv2.0%2B-purple.svg)](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.en.html)
+
+<!--
+[![ContentDB](https://content.minetest.net/packages/mt-mods/wrench/shields/downloads/)](https://content.minetest.net/packages/mt-mods/wrench/)
+-->
+
+# Wrench
+
+<img src="textures/technic_wrench.png"/>
+
+The wrench tool allows you to left-click on nodes with inventories to pick them up.
+
+This mod is a fork from wrench/ in https://github.com/mt-mods/technic
+
+# Supported Mods and Nodes
+
+* https://github.com/minetest/minetest_game
+  - bones:bones
+  - default:chest
+  - default:chest_locked
+  - default:furnace
+  - default:sign_wall_wood
+  - default:sign_wall_steel
+  - vessels:shelf
+* https://github.com/minetest-mods/3d_armor
+  - 3d_armor_stand:armor_stand
+  - 3d_armor_stand:locked_armor_stand
+* https://github.com/mt-mods/basic_signs
+  - basic_signs:sign_wall_glass
+  - basic_signs:sign_wall_locked
+  - basic_signs:sign_wall_obsidian_glass
+  - basic_signs:sign_wall_plastic
+  - basic_signs:sign_wall_steel_\*
+* https://notabug.org/TenPlus1/bees
+  - bees:hive_wild
+* https://github.com/Lokrates/Biofuel
+  - biofuel:refinery
+* https://github.com/HybridDog/connected_chests
+* https://github.com/minetest-mods/digilines
+  - digilines:chest
+  - digilines:lcd
+  - digilines:lightsensor
+  - digilines:rtc
+* https://cheapiesystems.com/git/digiscreen/
+* https://github.com/mt-mods/digistuff
+  - digistuff:advtouchscreen
+  - digistuff:button_\*
+  - digistuff:camera
+  - digistuff:card_reader
+  - digistuff:controller_programmed
+  - digistuff:detector
+  - digistuff:eeprom
+  - digistuff:gpu
+  - digistuff:ioexpander_\*
+  - digistuff:light_\*
+  - digistuff:movestone
+  - digistuff:nic
+  - digistuff:noteblock
+  - digistuff:panel
+  - digistuff:piezo
+  - digistuff:piston\*
+  - digistuff:ram
+  - digistuff:timer
+  - digistuff:touchscreen
+  - digistuff:wall_knob_configured
+* https://github.com/minetest-mods/digtron
+  - digtron:battery_holder
+  - digtron:inventory
+  - digtron:fuelstore
+  - digtron:combined_storage
+* https://github.com/minetest-mods/drawers
+  - drawers:wood
+  - drawers:acacia_wood
+  - drawers:aspen_wood
+  - drawers:junglewood
+  - drawers:pine_wood
+* https://github.com/minetest-mods/mesecons
+  - mesecons_commandblock:commandblock_\*
+  - mesecons_detector:node_detector_\*
+  - mesecons_detector:object_detector_\*
+  - mesecons_luacontroller:luacontroller\*
+  - mesecons_microcontroller:microcontroller\*
+* https://notabug.org/tenplus1/mobs_redo
+  - mobs:spawner
+* https://github.com/minetest-mods/more_chests
+  - more_chests:cobble
+  - more_chests:dropbox
+  - more_chests:fridge
+  - more_chests:big_fridge
+  - more_chests:shared
+  - more_chests:secret
+  - more_chests:toolbox_\*
+* https://github.com/mt-mods/pipeworks
+  - pipeworks:autocrafter
+  - pipeworks:deployer_\*
+  - pipeworks:digiline_detector_tube_\*
+  - pipeworks:dispenser_\*
+  - pipeworks:nodebreaker_\*
+  - pipeworks:\*filter
+  - pipeworks:lua_tube\*
+  - pipeworks:mese_sand_tube_\*
+  - pipeworks:mese_tube_\*
+  - pipeworks:teleport_tube_\*
+* https://notabug.org/tenplus1/protector
+  - protector:chest
+  - protector:protect
+  - protector:protect2
+* https://github.com/mt-mods/signs_lib
+* https://github.com/mt-mods/technic
+  - technic:cnc\*
+  - technic:coal_alloy_furnace\*
+  - technic:\*chest\*
+  - technic:injector
+  - technic:power_monitor
+  - technic:supply_converter
+  - technic:switching_station
+  - technic:tool_workshop
+  - technic:\*_alloy_furnace\*
+  - technic:\*_battery_box\*
+  - technic:\*_centrifuge\*
+  - technic:\*_compressor\*
+  - technic:\*_electric_furnace\*
+  - technic:\*_extractor\*
+  - technic:\*_freezer\*
+  - technic:\*_generator\*
+  - technic:\*_grinder\*
+* https://github.com/minetest-mods/xdecor
+  - realchess:chessboard
+  - xdecor:cabinet
+  - xdecor:cabinet_half
+  - xdecor:empty_shelf
+  - xdecor:multishelf
+  - xdecor:cauldron_\*
+  - xdecor:enchantment_table
+  - xdecor:itemframe
+  - xdecor:mailbox
+
+# Settings in `minetest.conf`
+```ini
+# Allows the wrench to be crafted if either the 'technic' or 'default' mod is installed.
+wrench.enable_crafting = true
+```
+
+# Contributors
+
+* Nekogloop
+* ShadowNinja
+* BuckarooBanzay
+* OgelGames
+* int-ua
+* S-S-X
+* H-V-Smacker
+* groxxda
+* And many others...
+
+# License
+
+Unless otherwise stated, all components of this modpack are licensed under the
+LGPL, V2 or later.  See also the individual mod folders for their
+secondary/alternate licenses, if any.

api.lua

@@ -0,0 +1,59 @@
+
+function wrench.register_node(name, def)
+	assert(type(name) == "string", "wrench.register_node invalid type for name")
+	assert(type(def) == "table", "wrench.register_node invalid type for def")
+	local node_def = minetest.registered_nodes[name]
+	if node_def then
+		wrench.registered_nodes[name] = table.copy(def)
+	else
+		minetest.log("warning", "[wrench] Attempt to register unknown node: "..name)
+	end
+end
+
+function wrench.unregister_node(name)
+	assert(type(name) == "string", "wrench.unregister_node invalid type for name")
+	if wrench.registered_nodes[name] then
+		wrench.registered_nodes = nil
+	else
+		minetest.log("warning", "[wrench] Attempt to unregister unsupported node: "..name)
+	end
+end
+
+function wrench.blacklist_item(name)
+	assert(type(name) == "string", "wrench.blacklist_item invalid type for name")
+	local node_def = minetest.registered_items[name]
+	if node_def then
+		wrench.blacklisted_items[name] = true
+	else
+		minetest.log("warning", "[wrench] Attempt to blacklist unknown item: "..name)
+	end
+end
+
+minetest.register_on_mods_loaded(function()
+	for name, def in pairs(wrench.registered_nodes) do
+		local node_def = minetest.registered_nodes[name]
+		if node_def then
+			local old_after_place = node_def.after_place_node
+			minetest.override_item(name, {
+				after_place_node = function(...)
+					if not wrench.restore_node(...) and old_after_place then
+						return old_after_place(...)
+					end
+				end
+			})
+			if def.drop == true and type(node_def.drop) == "string" then
+				def.drop = node_def.drop
+			elseif def.drop and type(def.drop) ~= "string" then
+				minetest.log("warning", "[wrench] Ignoring invalid type for drop in definition for "..name)
+				def.drop = nil
+			end
+			if def.drop and not wrench.registered_nodes[def.drop] then
+				minetest.log("warning", "[wrench] Ignoring unsupported node for drop in definition for "..name)
+				def.drop = nil
+			end
+		else
+			minetest.log("warning", "[wrench] Registered node is now unknown: "..name)
+			wrench.registered_nodes[name] = nil
+		end
+	end
+end)