Initial commit

LICENSE.txt

@@ -0,0 +1,17 @@
+path_markers mod for Minetest
+
+Copyright (C) 2017 FaceDeer
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

depends.txt

@@ -0,0 +1,2 @@
+default
+doc?

description.txt

@@ -0,0 +1 @@
+Path marker signs for use when exploring a twisty maze of passages that are all alike.

init.lua

@@ -0,0 +1,219 @@
+-- Tags are simple signs used to mark a path. They contain the following info:
+-- label (very short string)
+-- number (increments with each item placed from a stack)
+-- position of the previous tag placed
+-- name of the player who placed it
+
+-- They are crafted blank. Blank tags can't be placed.
+-- On use of blank tag, pop open a formspec to get initial values. Start of a path.
+-- When a blank tag stack is used to punch an in-world tag, it inherits that tag's values (continues the chain)
+-- Can turn a tag stack blank again via crafting menu
+
+local formspec = "size[8,2]" .. default.gui_bg ..
+	default.gui_bg_img ..
+	"field[0.5,1;7.5,0;label;Label:;]" ..
+	"button_exit[2.5,1.5;3,1;save;Save]"
+
+minetest.register_on_player_receive_fields(function(player, formname, fields)
+	if formname ~= "path_markers:blank" then return end
+	local inv = player:get_inventory()
+	local stack = player:get_wielded_item()
+
+	if fields.save and fields.label ~= "" then
+		local data = {}
+		data.label = fields.label
+		data.number = 1
+		local new_stack = ItemStack({name="path_markers:marker", count=stack:get_count(), wear=0, metadata=minetest.serialize(data)})
+		player:set_wielded_item(new_stack)
+	end
+end)
+
+local tag_to_itemstack = function(pos, count)
+	local meta = minetest.get_meta(pos)
+	local data = {}
+	data.label = meta:get_string("label")
+	data.number = meta:get_int("number") + 1
+	data.previous_pos = pos
+	local new_stack = ItemStack({name="path_markers:marker", count=count, wear=0, metadata=minetest.serialize(data)})
+	return new_stack
+end
+
+local read_pointed_thing_tag = function(itemstack, pointed_thing)
+	if pointed_thing.type == "node" then
+		local pos = pointed_thing.under
+		local node = minetest.get_node(pos)
+		if node.name == "path_markers:marker" then
+			itemstack = tag_to_itemstack(pos, itemstack:get_count())
+			return itemstack, true
+		end
+	end
+	return itemstack, false
+end
+
+minetest.register_craftitem("path_markers:blank", {
+	description = "Blank Marker",
+	_doc_items_longdesc = "A blank path marker sign, ready to have a label affixed",
+    _doc_items_usagehelp = "To start marking a new path, wield a stack of blank markers. You'll be presented with a form to fill in a short text label that this path will bear, after which you can begin placing path markers as you explore. You can also use a blank marker stack on an existing path marker that's already been placed and you'll copy the marker's label and continue the path from that point when laying down new markers from your copied stack.",
+	inventory_image = "path_markers_base.png",
+	wield_image = "path_markers_base.png",
+	groups = {flammable = 3},
+
+	
+	on_place = function(itemstack, player, pointed_thing)
+		local itemstack, success = read_pointed_thing_tag(itemstack, pointed_thing)
+		if success then return itemstack end
+		-- Show formspec and start a new path
+		minetest.show_formspec(player:get_player_name(), "path_markers:blank", formspec)
+	end,
+	
+	on_use = function(itemstack, player, pointed_thing)
+		local itemstack, success = read_pointed_thing_tag(itemstack, pointed_thing)
+		if success then return itemstack end
+		-- Show formspec and start a new path
+		minetest.show_formspec(player:get_player_name(), "path_markers:blank", formspec)
+	end,
+})
+
+minetest.register_node("path_markers:marker", {
+	description = "Marker",
+	_doc_items_longdesc = "A path marker with a label affixed",
+    _doc_items_usagehelp = "This marker has had a label assigned and is counting the markers you've been laying down. Each marker knows the location of the previous marker in your path, and right-clicking on it will cause it to emit a stream of indicators that only you can see pointing the direction it lies in. If you place a marker incorrectly you can \"undo\" the placement by clicking on it with the stack you used to place it. Otherwise, markers can only be removed with an axe. Labeled markers can be turned back into blank markers via the crafting grid.",
+	drawtype = "nodebox",
+	tiles = {"path_markers_wall.png^path_markers_text.png"},
+	inventory_image = "path_markers_base.png^path_markers_text.png",
+	wield_image = "path_markers_base.png^path_markers_text.png",
+	drop = "path_markers:blank",
+	paramtype = "light",
+	paramtype2 = "wallmounted",
+	sunlight_propagates = true,
+	is_ground_content = false,
+	walkable = false,
+	sounds = default.node_sound_wood_defaults(),
+	light_source = 4,
+	node_box = {
+		type = "wallmounted",
+		wall_top    = {-0.3125, 0.4375, -0.3125, 0.3125, 0.5, 0.3125},
+		wall_bottom = {-0.3125, -0.5, -0.3125, 0.3125, -0.4375, 0.3125},
+		wall_side   = {-0.5, -0.3125, -0.3125, -0.4375, 0.3125, 0.3125},
+	},
+	groups = {flammable = 3, not_in_creative_inventory = 1, choppy=3},
+
+	on_place = function(itemstack, placer, pointed_thing)
+		if pointed_thing.type ~= "node" then return itemstack end
+
+		local pos = pointed_thing.above
+		if not minetest.registered_nodes[minetest.get_node(pos).name].buildable_to then return itemstack end
+
+		local playername = placer:get_player_name()
+		if minetest.is_protected(pos, playername) then return itemstack end
+
+		local meta = itemstack:get_metadata()
+		local data = minetest.deserialize(meta)
+		
+		if not data then return itemstack end
+
+		local success
+		itemstack, success = minetest.item_place(itemstack, placer, pointed_thing)
+	
+		if not success then return itemstack end
+		
+		local node_meta = minetest.get_meta(pos)
+		node_meta:set_string("label", data.label)
+		node_meta:set_int("number", data.number)
+		
+		if data.number > 1 and data.previous_pos then
+			node_meta:set_int("previous_pos_x", data.previous_pos.x)
+			node_meta:set_int("previous_pos_y", data.previous_pos.y)
+			node_meta:set_int("previous_pos_z", data.previous_pos.z)
+			local dist = vector.distance(pos, data.previous_pos)
+			node_meta:set_string("infotext",
+				string.format("%s #%d\nPlaced by %s\n%dm from last marker", data.label, data.number, playername, dist))
+		else
+			node_meta:set_string("infotext",
+				string.format("%s #%d\nPlaced by %s", data.label, data.number, playername))
+		end
+		
+		data.number = data.number + 1
+		data.previous_pos = pos
+		itemstack:set_metadata(minetest.serialize(data))
+	
+		return itemstack
+	end,
+	
+	-- "Undo" capability. If a player uses a stack on a marker that they just placed with it, the marker will be removed
+	-- and the stack restored to the state before it was placed.
+	on_use = function(itemstack, player, pointed_thing)
+		if pointed_thing.type ~= "node" or itemstack:get_count() == itemstack:get_stack_max() then
+			return itemstack
+		end
+		local pos = pointed_thing.under
+		local node = minetest.get_node(pos)
+		if node.name ~= "path_markers:marker" then return itemstack end
+		
+		local node_meta = minetest.get_meta(pos)
+		local item_data = minetest.deserialize(itemstack:get_metadata())
+		
+		if node_meta:get_string("label") == item_data.label and
+			node_meta:get_int("number") == item_data.number - 1 then
+			item_data.number = item_data.number - 1
+			item_data.previous_pos.x = node_meta:get_int("previous_pos_x")
+			item_data.previous_pos.y = node_meta:get_int("previous_pos_y")
+			item_data.previous_pos.z = node_meta:get_int("previous_pos_z")
+			itemstack:set_metadata(minetest.serialize(item_data))
+			itemstack:set_count(itemstack:get_count() + 1)
+			minetest.remove_node(pos)
+		end
+		return itemstack
+	end,
+	
+	on_rightclick = function(pos, node, player, itemstack, pointed_thing)
+		if itemstack:get_name() == "path_markers:blank"	then
+			return tag_to_itemstack(pos, itemstack:get_count())
+		end
+	
+		local meta = minetest.get_meta(pos)
+		local previous_pos = {}
+		previous_pos.x = meta:get_int("previous_pos_x")
+		previous_pos.y = meta:get_int("previous_pos_y")
+		previous_pos.z = meta:get_int("previous_pos_z")
+				
+		if meta:get_int("number") > 1 and previous_pos.x and previous_pos.y and previous_pos.z then
+			local dir = vector.multiply(vector.direction(pos, previous_pos), 2)
+			minetest.add_particlespawner({
+				amount = 100,
+				time = 10,
+				minpos = pos,
+				maxpos = pos,
+				minvel = dir,
+				maxvel = dir,
+				minacc = {x=0, y=0, z=0},
+				maxacc = {x=0, y=0, z=0},
+				minexptime = 10,
+				maxexptime = 10,
+				minsize = 1,
+				maxsize = 1,
+				collisiondetection = false,
+				vertical = false,
+				texture = "default_cloud.png",
+				playername = player:get_player_name()
+			})			
+		end
+		
+		return itemstack
+	end,
+})
+
+minetest.register_craft({
+	output = "path_markers:blank",
+	type = "shapeless",
+	recipe = {"path_markers:marker"},
+})
+
+minetest.register_craft({
+	output = "path_markers:blank 8",
+	recipe = {
+		{'', 'group:wood', 'group:wood'},
+		{'', 'group:wood', 'group:wood'},
+		{'', 'group:stick', ''},
+	}
+})

mod.conf

@@ -0,0 +1 @@
+name = path_markers