Seperate signs API from signs definitions

Change modnames from *_lib to *_api

LICENSE.txt

@@ -0,0 +1,166 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
+

README.md

@@ -0,0 +1,29 @@
+# Signs API
+
+This mod provides various helper functions for registereing signs with text display. Text is locked if area is protected.
+No actual signs get registered by this mod, the signs are defined in the sign submod.
+
+For more information, see the [forum topic](https://forum.minetest.net/viewtopic.php?t=19365) at the Minetest forums.
+
+**Dependancies**: default, display\_lib, font\_lib
+
+**License**: Code under LGPL, Textures and models under CC-BY-SA
+
+## API Functions
+### `signs_api.set_display_text(pos, text)`
+Sets the text of a sign. Usually called in `on_receive_fields`.
+
+### `signs_api.set_formspec(pos)`
+Usually called in `on_construct` to set the formspec.
+
+### `signs_api.on_receive_fields(pos, formname, fields, player)`
+Helper function for `on_receive_fields`. Sets the display text and checks for protection.
+
+### `signs_api.on_place_direction(itemstack, placer, pointed_thing)`
+On place callback for direction signs (chooses which sign according to look direction).
+
+### `signs_api.on_rotate(pos, node, player, mode, new_param2)`
+Handles screwdriver rotation. Direction is affected for direction signs.
+
+### `signs_api.register_sign(mod, name, model)`
+A method to quickly register signs.

common.lua

@@ -0,0 +1,188 @@
+--[[
+    signs mod for Minetest - Various signs with text displayed on
+    (c) Pierre-Yves Rollo
+
+    This file is part of signs.
+
+    signs is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    signs 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 General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with signs.  If not, see <http://www.gnu.org/licenses/>.
+--]]
+
+local S = signs_api.intllib
+local F = function(...) return minetest.formspec_escape(S(...)) end
+
+function signs_api.set_display_text(pos,text)
+	local meta = minetest.get_meta(pos)
+	meta:set_string("display_text", text)
+	meta:set_string("infotext", "\""..text.."\"")
+	display_api.update_entities(pos)
+end
+
+function signs_api.set_formspec(pos)
+	local meta = minetest.get_meta(pos)
+	local ndef = minetest.registered_nodes[minetest.get_node(pos).name]
+	if ndef and ndef.display_entities and ndef.display_entities["signs:display_text"] then
+		local maxlines = ndef.display_entities["signs:display_text"].maxlines
+		local formspec
+
+		if maxlines == 1 then
+			formspec = "size[6,3]"..
+				default.gui_bg .. default.gui_bg_img .. default.gui_slots ..
+				"field[0.5,0.7;5.5,1;display_text;"..F("Text")..";${display_text}]"..
+				"button_exit[2,2;2,1;ok;"..F("Write").."]"
+		else
+			local extralabel = ""
+			if maxlines then
+				extralabel = F(" (first %s lines only)"):format(maxlines)
+			end
+
+			formspec = "size[6,4]"..
+				default.gui_bg .. default.gui_bg_img .. default.gui_slots ..
+				"textarea[0.5,0.7;5.5,2;display_text;"..F("Text")..""..extralabel..";${display_text}]"..
+				"button_exit[2,3;2,1;ok;"..F("Write").."]"
+		end
+
+		meta:set_string("formspec", formspec)
+	end
+end
+
+function signs_api.on_receive_fields(pos, formname, fields, player)
+	if not minetest.is_protected(pos, player:get_player_name()) then
+		if fields and (fields.ok or fields.key_enter) then
+			signs_api.set_display_text(pos, fields.display_text)
+		end
+	end
+end
+
+-- On place callback for direction signs
+-- (chooses which sign according to look direction)
+function signs_api.on_place_direction(itemstack, placer, pointed_thing)
+	local name = itemstack:get_name()
+	local ndef = minetest.registered_nodes[name]
+
+    local bdir = {x = pointed_thing.under.x - pointed_thing.above.x,
+                  y = pointed_thing.under.y - pointed_thing.above.y,
+                  z = pointed_thing.under.z - pointed_thing.above.z}
+	local pdir = placer:get_look_dir()
+
+	local ndir, test
+
+	if ndef.paramtype2 == "facedir" then
+		if bdir.x == 0 and bdir.z == 0 then
+			-- Ceiling or floor pointed (facedir chosen from player dir)
+			ndir = minetest.dir_to_facedir({x=pdir.x, y=0, z=pdir.z})
+		else
+			-- Wall pointed
+			ndir = minetest.dir_to_facedir(bdir)
+		end
+
+		test = {[0]=-pdir.x, pdir.z, pdir.x, -pdir.z}
+    end
+
+	if ndef.paramtype2 == "wallmounted" then
+		ndir = minetest.dir_to_wallmounted(bdir)
+		if ndir == 0 or ndir == 1 then
+			-- Ceiling or floor
+			ndir = minetest.dir_to_wallmounted({x=pdir.x, y=0, z=pdir.z})
+		end
+
+		test = {0, pdir.z, -pdir.z, -pdir.x, pdir.x}
+	end
+
+	-- Only for direction signs
+	if ndef.signs_other_dir then
+		if test[ndir] > 0 then
+			itemstack:set_name(ndef.signs_other_dir)
+		end
+		itemstack = minetest.item_place(itemstack, placer, pointed_thing, ndir)
+		itemstack:set_name(name)
+
+		return itemstack
+	else
+		return minetest.item_place(itemstack, placer, pointed_thing, ndir)
+	end
+end
+
+-- Handles screwdriver rotation. Direction is affected for direction signs
+function signs_api.on_rotate(pos, node, player, mode, new_param2)
+	if mode == 2 then
+		local ndef = minetest.registered_nodes[node.name]
+	    if ndef.signs_other_dir then
+		    minetest.swap_node(pos, {name = ndef.signs_other_dir,
+                param1 = node.param1, param2 = node.param2})
+			display_api.update_entities(pos)
+	    end
+	else
+        display_api.on_rotate(pos, node, user, mode, new_param2)
+	end
+    return false;
+end
+
+function signs_api.register_sign(mod, name, model)
+	-- Default fields
+	local fields = {
+		sunlight_propagates = true,
+		paramtype = "light",
+		paramtype2 = "facedir",
+		drawtype = "nodebox",
+		node_box = {
+			type = "fixed",
+			fixed = {-model.width/2, -model.height/2, 0.5,
+					 model.width/2, model.height/2, 0.5 - model.depth},
+		},
+		groups = {choppy=2, dig_immediate=2, not_blocking_trains = 1, display_modpack_node = 1},
+		sounds = default.node_sound_defaults(),
+		display_entities = {
+			["signs:display_text"] = {
+					on_display_update = font_api.on_display_update,
+					depth = 0.5 - display_api.entity_spacing - model.depth,
+					size = { x = model.width, y = model.height },
+					resolution = { x = 64, y = 64 },
+					maxlines = 1,
+			},
+
+		},
+		on_place = display_api.on_place,
+		on_construct = 	function(pos)
+							signs_api.set_formspec(pos)
+							display_api.on_construct(pos)
+						end,
+		on_destruct = display_api.on_destruct,
+		on_rotate = signs_api.on_rotate,
+		on_receive_fields =  signs_api.on_receive_fields,
+		on_punch = function(pos, node, player, pointed_thing) display_api.update_entities(pos) end,
+	}
+
+	-- Node fields override
+	for key, value in pairs(model.node_fields) do
+		if key == "groups" then
+			for key2, value2 in pairs(value) do
+				fields[key][key2] = value2
+			end
+		else
+			fields[key] = value
+		end
+	end
+
+	if not fields.wield_image then fields.wield_image = fields.inventory_image end
+
+	-- Entity fields override
+	for key, value in pairs(model.entity_fields) do
+		fields.display_entities["signs:display_text"][key] = value
+	end
+
+	minetest.register_node(mod..":"..name, fields)
+end
+
+-- Text entity for all signs
+display_api.register_display_entity("signs:display_text")

copyright.txt

@@ -0,0 +1,10 @@
+Code by Pierre-Yves Rollo (pyrollo)
+intllib support (i18n) by (fat115)
+intllib fallback code and tools by Diego Martínez (kaeza)
+Extra contributors:
+(gpcf)
+(Thomas--S)
+Translations:
+Muhammad Nur Hidayat Yasuyoshi (MuhdNurHidayat)
+(fat115)
+

depends.txt

@@ -0,0 +1,4 @@
+default
+intllib?
+display_api
+font_api

init.lua

@@ -0,0 +1,33 @@
+--[[
+    signs mod for Minetest - Various signs with text displayed on
+    (c) Pierre-Yves Rollo
+
+    This file is part of signs.
+
+    signs is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    signs 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 General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with signs.  If not, see <http://www.gnu.org/licenses/>.
+--]]
+
+signs_api = {}
+signs_api.name = minetest.get_current_modname()
+signs_api.path = minetest.get_modpath(signs_api.name)
+
+-- Load support for intllib.
+local S, NS = dofile(signs_api.path.."/intllib.lua")
+signs_api.intllib = S
+
+dofile(signs_api.path.."/common.lua")
+
+
+
+

intllib.lua

@@ -0,0 +1,45 @@
+
+-- Fallback functions for when `intllib` is not installed.
+-- Code released under Unlicense <http://unlicense.org>.
+
+-- Get the latest version of this file at:
+--   https://raw.githubusercontent.com/minetest-mods/intllib/master/lib/intllib.lua
+
+local function format(str, ...)
+	local args = { ... }
+	local function repl(escape, open, num, close)
+		if escape == "" then
+			local replacement = tostring(args[tonumber(num)])
+			if open == "" then
+				replacement = replacement..close
+			end
+			return replacement
+		else
+			return "@"..open..num..close
+		end
+	end
+	return (str:gsub("(@?)@(%(?)(%d+)(%)?)", repl))
+end
+
+local gettext, ngettext
+if minetest.get_modpath("intllib") then
+	if intllib.make_gettext_pair then
+		-- New method using gettext.
+		gettext, ngettext = intllib.make_gettext_pair()
+	else
+		-- Old method using text files.
+		gettext = intllib.Getter()
+	end
+end
+
+-- Fill in missing functions.
+
+gettext = gettext or function(msgid, ...)
+	return format(msgid, ...)
+end
+
+ngettext = ngettext or function(msgid, msgid_plural, n, ...)
+	return format(n==1 and msgid or msgid_plural, ...)
+end
+
+return gettext, ngettext

locale/fr.po

@@ -0,0 +1,49 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2018-02-01 05:56+0100\n"
+"PO-Revision-Date: 2017-05-08 07:08+0200\n"
+"Last-Translator: Peppy <peppy@twang-factory.com>\n"
+"Language-Team: \n"
+"Language: fr\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: Poedit 1.8.12\n"
+
+#: common.lua
+msgid "Text"
+msgstr "Texte"
+
+#: common.lua
+msgid "Write"
+msgstr "Écrire"
+
+#: common.lua
+#, lua-format
+msgid " (first %s lines only)"
+msgstr " (uniquement les %s premières lignes)"
+
+#~ msgid "Title"
+#~ msgstr "Titre"
+
+#~ msgid "Close"
+#~ msgstr "Fermer"
+
+#~ msgid "(right-click to read more text)"
+#~ msgstr "(Clic-droit pour afficher le texte entier)"
+
+#~ msgid "Wooden direction sign"
+#~ msgstr "Panneau de direction en bois"
+
+#~ msgid "Poster"
+#~ msgstr "Affiche"
+
+#~ msgid "Textd"
+#~ msgstr "Texte"

locale/ms.po

@@ -0,0 +1,46 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# Muhammad Nur Hidayat <muhdnurhidayat96@yahoo.com>, 2017.
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2018-02-01 05:56+0100\n"
+"PO-Revision-Date: 2017-08-27 15:50+0800\n"
+"Last-Translator: Muhammad Nur Hidayat <muhdnurhidayat96@yahoo.com>\n"
+"Language-Team: Malay <muhdnurhidayat96@yahoo.com>\n"
+"Language: ms\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"X-Generator: Vé 0.1.4\n"
+
+#: common.lua
+msgid "Text"
+msgstr "Teks"
+
+#: common.lua
+msgid "Write"
+msgstr "Tulis"
+
+#: common.lua
+#, lua-format
+msgid " (first %s lines only)"
+msgstr "( %s baris pertama sahaja )"
+
+#~ msgid "Title"
+#~ msgstr "Tajuk"
+
+#~ msgid "Close"
+#~ msgstr "Tutup"
+
+#~ msgid "(right-click to read more text)"
+#~ msgstr "(klik-kanan untuk baca teks penuh)"
+
+#~ msgid "Wooden direction sign"
+#~ msgstr "Papan tanda arah kayu"
+
+#~ msgid "Poster"
+#~ msgstr "Poster"

locale/template.pot

@@ -0,0 +1,31 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2018-02-01 05:56+0100\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=CHARSET\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+#: common.lua
+msgid "Text"
+msgstr ""
+
+#: common.lua
+msgid "Write"
+msgstr ""
+
+#: common.lua
+#, lua-format
+msgid " (first %s lines only)"
+msgstr ""

tools/updatepo.sh

@@ -0,0 +1,25 @@
+#! /bin/bash
+
+# To create a new translation:
+#   msginit --locale=ll_CC -o locale/ll_CC.po -i locale/template.pot
+
+cd "$(dirname "${BASH_SOURCE[0]}")/..";
+
+# Extract translatable strings.
+xgettext --from-code=UTF-8 \
+		--language=Lua \
+		--sort-by-file \
+		--keyword=S \
+		--keyword=NS:1,2 \
+		--keyword=N_ \
+		--keyword=F \
+		--add-comments='Translators:' \
+		--add-location=file \
+		-o locale/template.pot \
+		$(find . -name '*.lua')
+
+# Update translations.
+find locale -name '*.po' | while read -r file; do
+	echo $file
+	msgmerge --update $file locale/template.pot;
+done