Merge pull request #12 from Thomas--S/api

Seperate signs API from signs definitions
This commit is contained in:
Pierre-Yves Rollo 2018-02-13 21:12:04 +01:00 committed by GitHub
commit 9c877a0244
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
43 changed files with 831 additions and 327 deletions

@ -2,9 +2,10 @@
This modpack provides mods with dynamic display. Mods are :
- **display_lib**: A library for adding display entities to nodes;
- **font_lib**: A library for displaying fonts on entities;
- **display_api**: A library for adding display entities to nodes;
- **font_api**: A library for displaying fonts on entities;
- **ontime_clocks**: A mod providing clocks which display the ingame time;
- **signs_api**: A library for the easy creation of signs;
- **signs**: A mod providing signs and direction signs displaying text;
- **signs_road**: A mod providing road signs displaying text;
- **steles**: A mod providing stone steles with text;

@ -40,9 +40,9 @@ This is a helper to register entities used for display.
* Register display entities with `register_display_entity`
* Register node with :
- `on_place`, `on_construct`, `on_destruct` and `on_rotate` callbacks using display_lib callbacks.
- `on_place`, `on_construct`, `on_destruct` and `on_rotate` callbacks using display_api callbacks.
 
- `display_lib_node` group. This will make this node have their entities updated as soon as the mapblock is loaded (Useful after /clearobjects).
- `display_modpack_node` group. This will make this node have their entities updated as soon as the mapblock is loaded (Useful after /clearobjects).
 
- a `display_entities` field in node definition containing a entity name indexed table. See below for description of each display_entities fields.
@ -51,12 +51,12 @@ This is a helper to register entities used for display.
`depth`, `right` and `heigh` : Entity position regarding to node facedir/wallmounted main axis. Values for these fields can be any number between -0.5 and 0.5 (default value is 0). Position 0,0,0 is the center of the node. `depth` goes from front (-0.5) to rear (0.5), `height` goes from bottom (-0.5) to top (0.5) and `right` goes from left (-0.5) to right (0.5).
In order to avoid flickering text, it's better to have text a little behind node surface. A good spacing value is given by `display_lib.entity_spacing` variable.
In order to avoid flickering text, it's better to have text a little behind node surface. A good spacing value is given by `display_api.entity_spacing` variable.
### Example
display_lib.register_display_entity("mymod:entity1")
display_lib.register_display_entity("mymod:entity2")
display_api.register_display_entity("mymod:entity1")
display_api.register_display_entity("mymod:entity2")
function my_display_update1(pos, objref)
objref:set_properties({ textures= {"mytexture1.png"},
@ -72,7 +72,7 @@ In order to avoid flickering text, it's better to have text a little behind node
...
paramtype2 = "facedir",
...
groups = { display_lib_node = 1, ... },
groups = { display_modpack_node = 1, ... },
...
display_entities = {
["mymod:entity1"] = {
@ -83,9 +83,9 @@ In order to avoid flickering text, it's better to have text a little behind node
on_display_update = my_display_update2 },
},
...
on_place = display_lib.on_place,
on_construct = display_lib.on_construct,
on_destruct = display_lib.on_destruct,
on_rotate = display_lib.on_rotate,
on_place = display_api.on_place,
on_construct = display_api.on_construct,
on_destruct = display_api.on_destruct,
on_rotate = display_api.on_rotate,
...
})

@ -8,7 +8,7 @@ This library's purpose is to ease creation of nodes with one or more displays on
**License**: LPGL
**API**: See [API.md](https://github.com/pyrollo/display_modpack/blob/master/display_lib/API.md) document please.
**API**: See [API.md](https://github.com/pyrollo/display_modpack/blob/master/display_api/API.md) document please.
For more information, see the [forum topic](https://forum.minetest.net/viewtopic.php?t=19365) at the Minetest forums.

@ -1,5 +1,5 @@
--[[
display_lib mod for Minetest - Library to add dynamic display
display_api mod for Minetest - Library to add dynamic display
capabilities to nodes
(c) Pierre-Yves Rollo
@ -17,12 +17,12 @@
along with this program. If not, see <http://www.gnu.org/licenses/>.
--]]
display_lib = {}
display_api = {}
-- Prefered gap between node and entity
-- Entity positionment is up to mods but it is a good practice to use this
-- variable as spacing between entity and node
display_lib.entity_spacing = 0.002
display_api.entity_spacing = 0.002
-- Miscelaneous values depending on wallmounted param2
local wallmounted_values = {
@ -144,25 +144,25 @@ local function call_node_on_display_update(pos, objref)
end
--- Force entity update
function display_lib.update_entities(pos)
function display_api.update_entities(pos)
local objrefs = place_entities(pos)
for _, objref in pairs(objrefs) do
call_node_on_display_update(pos, objref)
end
end
--- On_activate callback for display_lib entities. Calls on_display_update callbacks
--- On_activate callback for display_api entities. Calls on_display_update callbacks
--- of corresponding node for each entity.
function display_lib.on_activate(entity, staticdata)
function display_api.on_activate(entity, staticdata)
if entity then
entity.object:set_armor_groups({immortal=1})
call_node_on_display_update(entity.object:getpos(), entity.object)
end
end
--- On_place callback for display_lib items. Does nothing more than preventing item
--- On_place callback for display_api items. Does nothing more than preventing item
--- from being placed on ceiling or ground
function display_lib.on_place(itemstack, placer, pointed_thing)
function display_api.on_place(itemstack, placer, pointed_thing)
local ndef = itemstack:get_definition()
local above = pointed_thing.above
local under = pointed_thing.under
@ -189,13 +189,13 @@ function display_lib.on_place(itemstack, placer, pointed_thing)
end
--- On_construct callback for display_lib items. Creates entities and update them.
function display_lib.on_construct(pos)
display_lib.update_entities(pos)
--- On_construct callback for display_api items. Creates entities and update them.
function display_api.on_construct(pos)
display_api.update_entities(pos)
end
--- On_destruct callback for display_lib items. Removes entities.
function display_lib.on_destruct(pos)
--- On_destruct callback for display_api items. Removes entities.
function display_api.on_destruct(pos)
local objrefs = get_entities(pos)
for _, objref in pairs(objrefs) do
@ -203,8 +203,8 @@ function display_lib.on_destruct(pos)
end
end
-- On_rotate (screwdriver) callback for display_lib items. Prevents axis rotation and reorients entities.
function display_lib.on_rotate(pos, node, user, mode, new_param2)
-- On_rotate (screwdriver) callback for display_api items. Prevents axis rotation and reorients entities.
function display_api.on_rotate(pos, node, user, mode, new_param2)
if mode ~= 1 then return false end
local values = get_values(node)
@ -219,22 +219,24 @@ function display_lib.on_rotate(pos, node, user, mode, new_param2)
end
--- Creates display entity with some fields and the on_activate callback
function display_lib.register_display_entity(entity_name)
function display_api.register_display_entity(entity_name)
if not minetest.registered_entity then
minetest.register_entity(':'..entity_name, {
collisionbox = { 0, 0, 0, 0, 0, 0 },
visual = "upright_sprite",
textures = {},
on_activate = display_lib.on_activate,
on_activate = display_api.on_activate,
})
end
end
minetest.register_lbm({
label = "Update display_lib entities",
name = "display_lib:update_entities",
label = "Update display_api entities",
name = "display_api:update_entities",
run_at_every_load = true,
nodenames = {"group:display_lib_node"},
action = function(pos, node) display_lib.update_entities(pos) end,
nodenames = {"group:display_modpack_node", "group:display_lib_node"},
action = function(pos, node) display_api.update_entities(pos) end,
})
-- Compatibility
display_lib = display_api

@ -46,7 +46,7 @@ Builds texture for a multiline colored text
### register\_font
**font\_lib.register_font(font\_name, height, widths)**
Registers a new font in font_lib.
Registers a new font in font_api.
**font\_name**: Name of the font to register (this name will be used to address the font later)
If registering different sizes of the same font, add size in the font name (e.g. times\_10, times\_12...).
@ -81,7 +81,7 @@ __Syntax__
**make\_font\_texture.sh <fontfile> <fontname> <fontsize>**
**<fontfile>**: A TTF font file to use to create textures.
**<fontname>**: The font name to be used in font_lib (should be simple, with no spaces).
**<fontname>**: The font name to be used in font_api (should be simple, with no spaces).
**<fontsize>**: Font height to be rendered.
### make_font_lua.sh
@ -94,14 +94,14 @@ __Syntax__
**make\_font_lua.sh <fontname>**
**<fontname>**: The font name to be used in font_lib (same as given to make\_font\_texture.sh)
**<fontname>**: The font name to be used in font_api (same as given to make\_font\_texture.sh)
### An exemple generating a font mod
mkdir font_myfont
cd font_myfont
/<path_to_font_lib>/tools/make_font_texture.sh myfont.ttf myfont 12
/<path_to_font_lib>/tools/make_font_lua.sh myfont
/<path_to_font_api>/tools/make_font_texture.sh myfont.ttf myfont 12
/<path_to_font_api>/tools/make_font_lua.sh myfont
mv font_myfont.lua init.lua

@ -1,6 +1,6 @@
# Font Lib
This library for font display on entities (to be used with display_lib for sign creation).
This library for font display on entities (to be used with display_api for sign creation).
**Dependancies**: default
@ -8,7 +8,7 @@ This library for font display on entities (to be used with display_lib for sign
(Default font taken from VanessaE's homedecor/signs_lib, originally under WTFPL)
**API**: See [API.md](https://github.com/pyrollo/display_modpack/blob/master/font_lib/API.md) document please.
**API**: See [API.md](https://github.com/pyrollo/display_modpack/blob/master/font_api/API.md) document please.
For more information, see the [forum topic](https://forum.minetest.net/viewtopic.php?t=13563) at the Minetest forums.

@ -1,6 +1,6 @@
--[[
font_lib mod for Minetest - Library to add font display capability
to display_lib mod.
font_api mod for Minetest - Library to add font display capability
to display_api mod.
(c) Pierre-Yves Rollo
This program is free software: you can redistribute it and/or modify
@ -20,10 +20,10 @@
-- Global variables
-------------------
font_lib = {}
font_lib.name = minetest.get_current_modname()
font_lib.path = minetest.get_modpath(font_lib.name)
font_lib.registered_fonts = {}
font_api = {}
font_api.name = minetest.get_current_modname()
font_api.path = minetest.get_modpath(font_api.name)
font_api.registered_fonts = {}
-- Local variables
------------------
@ -59,7 +59,7 @@ local function get_default_font()
local settings_font = minetest.settings:get("default_font")
if settings_font ~= nil and settings_font ~= "" then
default_font = font_lib.registered_fonts[settings_font]
default_font = font_api.registered_fonts[settings_font]
if default_font == nil then
minetest.log("warning", "Default font in settings (\""..
@ -69,7 +69,7 @@ local function get_default_font()
-- If failed, choose first font
if default_font == nil then
for _, font in pairs(font_lib.registered_fonts) do
for _, font in pairs(font_api.registered_fonts) do
default_font = font
break
end
@ -88,7 +88,7 @@ end
-- Returns font properties to be used according to font_name
local function get_font(font_name)
local font = font_lib.registered_fonts[font_name]
local font = font_api.registered_fonts[font_name]
if font == nil then
local message
@ -150,7 +150,7 @@ end
-- @param text Text to be rendered
-- @return Rendered text (width, height)
function font_lib.get_text_size(font_name, text)
function font_api.get_text_size(font_name, text)
local char
local width = 0
local pos = 1
@ -181,7 +181,7 @@ end
-- @param y Vertical position of the line in texture
-- @return Texture string
function font_lib.make_line_texture(font_name, text, width, x, y)
function font_api.make_line_texture(font_name, text, width, x, y)
local texture = ""
local char
local pos = 1
@ -193,7 +193,7 @@ function font_lib.make_line_texture(font_name, text, width, x, y)
-- Replace chars with no texture by the NULL(0) char
if font.widths[char] == nil then
print(string.format("["..font_lib.name
print(string.format("["..font_api.name
.."] Missing char %d (%04x)",char,char))
char = 0
end
@ -222,7 +222,7 @@ end
-- @param color Color of the text (optional)
-- @return Texture string
function font_lib.make_multiline_texture(font_name, text, width, height,
function font_api.make_multiline_texture(font_name, text, width, height,
maxlines, halign, valign, color)
local texture = ""
local lines = {}
@ -230,7 +230,7 @@ function font_lib.make_multiline_texture(font_name, text, width, height,
local y, w, h
for num, line in pairs(split_lines(text, maxlines)) do
w, h = font_lib.get_text_size(font_name, line)
w, h = font_api.get_text_size(font_name, line)
lines[num] = { text = line, width = w, height = h, }
textheight = textheight + h
end
@ -248,15 +248,15 @@ function font_lib.make_multiline_texture(font_name, text, width, height,
for _, line in pairs(lines) do
if halign == "left" then
texture = texture..
font_lib.make_line_texture(font_name, line.text, width,
font_api.make_line_texture(font_name, line.text, width,
0, y)
elseif halign == "right" then
texture = texture..
font_lib.make_line_texture(font_name, line.text, width,
font_api.make_line_texture(font_name, line.text, width,
width - line.width, y)
else
texture = texture..
font_lib.make_line_texture(font_name, line.text, width,
font_api.make_line_texture(font_name, line.text, width,
(width - line.width) / 2, y)
end
y = y + line.height
@ -278,9 +278,9 @@ end
-- @param height Font height in pixels
-- @param widths Array of character widths in pixels, indexed by UTF codepoints
function font_lib.register_font(font_name, height, widths)
function font_api.register_font(font_name, height, widths)
if font_lib.registered_fonts[font_name] ~= nil then
if font_api.registered_fonts[font_name] ~= nil then
minetest.log("error", "Font \""..font_name.."\" already registered.")
return
end
@ -303,7 +303,7 @@ function font_lib.register_font(font_name, height, widths)
return
end
font_lib.registered_fonts[font_name] =
font_api.registered_fonts[font_name] =
{ name = font_name, height = height, widths = widths }
-- Force to choose again default font
@ -317,7 +317,7 @@ end
-- @param pos Node position
-- @param objref Object reference of entity
function font_lib.on_display_update(pos, objref)
function font_api.on_display_update(pos, objref)
local meta = minetest.get_meta(pos)
local text = meta:get_string("display_text")
local ndef = minetest.registered_nodes[minetest.get_node(pos).name]
@ -328,7 +328,7 @@ function font_lib.on_display_update(pos, objref)
local font = get_font(def.font_name)
objref:set_properties({
textures={font_lib.make_multiline_texture(
textures={font_api.make_multiline_texture(
def.font_name, text,
def.size.x * def.resolution.x * font.height,
def.size.y * def.resolution.y * font.height,
@ -338,3 +338,6 @@ function font_lib.on_display_update(pos, objref)
end
end
-- Compatibility
font_lib = font_api

@ -39,18 +39,18 @@ $luafile generated by $scriptname $(LANG=en_US date)
--]]
font_lib.register_font(
font_api.register_font(
'$font_name',
$font_height,
{ $font_widths }
);
" > font_$font_name.lua
if grep -q font_lib depends.txt &>/dev/null
if grep -q font_api depends.txt &>/dev/null
then
echo "font_lib already in depends.txt."
echo "font_api already in depends.txt."
else
echo "adding font_lib to depends.txt."
echo "font_lib" >> depends.txt
echo "adding font_api to depends.txt."
echo "font_api" >> depends.txt
fi

@ -1,6 +1,6 @@
#!/bin/bash
# This program generates a bitmap font for font_lib mod for Minetest game.
# This program generates a bitmap font for font_api mod for Minetest game.
# (c) Andrzej Pieńkowski <pienkowski.andrzej@gmail.com>
# (c) Pierre-Yves Rollo <dev@pyrollo.com>
# License: GPL
@ -8,7 +8,7 @@
usage() {
echo "Usage: $0 fontfile fontname fontsize"
echo "fontfile: A TTF font file to use to create textures."
echo "fontname: The font name to be used in font_lib (should be simple, with no spaces)."
echo "fontname: The font name to be used in font_api (should be simple, with no spaces)."
echo "fontsize: Font height to be rendered."
}

@ -1,10 +1,10 @@
# Font Epilepsy
Font mod for font_lib mod.
Font mod for font_api mod.
**Font**: EpilepsySansBold by Kreative Software under KREATIVE SOFTWARE RELAY FONTS FREE USE LICENSE version 1.2f.
**Dependancies**:font_lib
**Dependancies**:font_api
**License**: LPGL for the cod, KREATIVE SOFTWARE RELAY FONTS FREE USE LICENSE version 1.2f for the font (see FONT LICENSE.txt)

@ -1 +1 @@
font_lib
font_api

File diff suppressed because one or more lines are too long

@ -4,7 +4,7 @@ This mod provides clocks that display real ingame time.
For more information, see the [forum topic](https://forum.minetest.net/viewtopic.php?t=19365) at the Minetest forums.
**Dependancies**: display_lib, default
**Dependancies**: display_api, default
**License**: Code under LGPL, textures under CC-BY-SA

@ -19,7 +19,7 @@
--]]
-- Entity for time display
display_lib.register_display_entity("ontime_clocks:display")
display_api.register_display_entity("ontime_clocks:display")
function ontime_clocks.get_h24()
return math.floor(minetest.get_timeofday()*24)%24

@ -1,5 +1,5 @@
default
dye
display_lib
display_api
intllib?

@ -35,7 +35,7 @@ minetest.register_node("ontime_clocks:green_digital", {
wall_top = { -0.5, -0.5, -0.5, 0.5, 0.5, 0.5 }
},
tiles = {"ontime_clocks_digital.png"},
groups = {oddly_breakable_by_hand = 1, not_blocking_trains = 1, display_lib_node = 1},
groups = {oddly_breakable_by_hand = 1, not_blocking_trains = 1, display_modpack_node = 1},
display_entities = {
["ontime_clocks:display"] = {
depth = 13/32 - 0.01,
@ -45,17 +45,17 @@ minetest.register_node("ontime_clocks:green_digital", {
"#040", "#0F0", ontime_clocks.get_h24(), ontime_clocks.get_m12()))
end },
},
on_place = display_lib.on_place,
on_construct = display_lib.on_construct,
on_destruct = display_lib.on_destruct,
on_rotate = display_lib.on_rotate,
on_place = display_api.on_place,
on_construct = display_api.on_construct,
on_destruct = display_api.on_destruct,
on_rotate = display_api.on_rotate,
})
minetest.register_abm({
nodenames = {"ontime_clocks:green_digital"},
interval = 5,
chance = 1,
action = display_lib.update_entities,
action = display_api.update_entities,
})
-- Red digital clock
@ -73,7 +73,7 @@ minetest.register_node("ontime_clocks:red_digital", {
wall_top = { -0.5, -0.5, -0.5, 0.5, 0.5, 0.5 }
},
tiles = {"ontime_clocks_digital.png"},
groups = {oddly_breakable_by_hand = 1, not_blocking_trains = 1, display_lib_node = 1},
groups = {oddly_breakable_by_hand = 1, not_blocking_trains = 1, display_modpack_node = 1},
display_entities = {
["ontime_clocks:display"] = {
depth = 13/32 - 0.01,
@ -83,17 +83,17 @@ minetest.register_node("ontime_clocks:red_digital", {
"#400", "#F00", ontime_clocks.get_h24(), ontime_clocks.get_m12()))
end },
},
on_place = display_lib.on_place,
on_construct = display_lib.on_construct,
on_destruct = display_lib.on_destruct,
on_rotate = display_lib.on_rotate,
on_place = display_api.on_place,
on_construct = display_api.on_construct,
on_destruct = display_api.on_destruct,
on_rotate = display_api.on_rotate,
})
minetest.register_abm({
nodenames = {"ontime_clocks:red_digital"},
interval = 5,
chance = 1,
action = display_lib.update_entities,
action = display_api.update_entities,
})
@ -111,7 +111,7 @@ minetest.register_node("ontime_clocks:white", {
wall_top = { -7/16, 0.5, -7/16, 7/16, 7/16, 7/16},
},
tiles = {"ontime_clocks_white.png"},
groups = {choppy = 1, oddly_breakable_by_hand = 1, not_blocking_trains = 1, display_lib_node = 1},
groups = {choppy = 1, oddly_breakable_by_hand = 1, not_blocking_trains = 1, display_modpack_node = 1},
display_entities = {
["ontime_clocks:display"] = {
depth = 6/16 - 0.01,
@ -121,17 +121,17 @@ minetest.register_node("ontime_clocks:white", {
"#000", 36, ontime_clocks.get_h12(), ontime_clocks.get_m12()))
end },
},
on_place = display_lib.on_place,
on_construct = display_lib.on_construct,
on_destruct = display_lib.on_destruct,
on_rotate = display_lib.on_rotate,
on_place = display_api.on_place,
on_construct = display_api.on_construct,
on_destruct = display_api.on_destruct,
on_rotate = display_api.on_rotate,
})
minetest.register_abm({
nodenames = {"ontime_clocks:white"},
interval = 5,
chance = 1,
action = display_lib.update_entities,
action = display_api.update_entities,
})
minetest.register_node("ontime_clocks:frameless_black", {
@ -148,7 +148,7 @@ minetest.register_node("ontime_clocks:frameless_black", {
wall_top = { -0.5, -0.5, -0.5, 0.5, 0.5, 0.5 }
},
tiles = {"ontime_clocks_frameless.png"},
groups = {choppy = 1, oddly_breakable_by_hand = 1, not_blocking_trains = 1, display_lib_node = 1},
groups = {choppy = 1, oddly_breakable_by_hand = 1, not_blocking_trains = 1, display_modpack_node = 1},
display_entities = {
["ontime_clocks:display"] = {
depth = 7/16,
@ -158,17 +158,17 @@ minetest.register_node("ontime_clocks:frameless_black", {
"#000", 48, ontime_clocks.get_h12(), ontime_clocks.get_m12()))
end },
},
on_place = display_lib.on_place,
on_construct = display_lib.on_construct,
on_destruct = display_lib.on_destruct,
on_rotate = display_lib.on_rotate,
on_place = display_api.on_place,
on_construct = display_api.on_construct,
on_destruct = display_api.on_destruct,
on_rotate = display_api.on_rotate,
})
minetest.register_abm({
nodenames = {"ontime_clocks:frameless_black"},
interval = 5,
chance = 1,
action = display_lib.update_entities,
action = display_api.update_entities,
})
minetest.register_node("ontime_clocks:frameless_gold", {
@ -185,7 +185,7 @@ minetest.register_node("ontime_clocks:frameless_gold", {
wall_top = { -0.5, -0.5, -0.5, 0.5, 0.5, 0.5 }
},
tiles = {"ontime_clocks_frameless.png^[colorize:#FF0"},
groups = {choppy = 1, oddly_breakable_by_hand = 1, not_blocking_trains = 1, display_lib_node = 1},
groups = {choppy = 1, oddly_breakable_by_hand = 1, not_blocking_trains = 1, display_modpack_node = 1},
display_entities = {
["ontime_clocks:display"] = {
depth = 7/16,
@ -195,17 +195,17 @@ minetest.register_node("ontime_clocks:frameless_gold", {
"#FF0", 48, ontime_clocks.get_h12(), ontime_clocks.get_m12()))
end },
},
on_place = display_lib.on_place,
on_construct = display_lib.on_construct,
on_destruct = display_lib.on_destruct,
on_rotate = display_lib.on_rotate,
on_place = display_api.on_place,
on_construct = display_api.on_construct,
on_destruct = display_api.on_destruct,
on_rotate = display_api.on_rotate,
})
minetest.register_abm({
nodenames = {"ontime_clocks:frameless_gold"},
interval = 5,
chance = 1,
action = display_lib.update_entities,
action = display_api.update_entities,
})
minetest.register_node("ontime_clocks:frameless_white", {
@ -222,7 +222,7 @@ minetest.register_node("ontime_clocks:frameless_white", {
wall_top = { -0.5, -0.5, -0.5, 0.5, 0.5, 0.5 }
},
tiles = {"ontime_clocks_frameless.png^[colorize:#FFF"},
groups = {choppy = 1, oddly_breakable_by_hand = 1, not_blocking_trains = 1, display_lib_node = 1},
groups = {choppy = 1, oddly_breakable_by_hand = 1, not_blocking_trains = 1, display_modpack_node = 1},
display_entities = {
["ontime_clocks:display"] = {
depth = 7/16,
@ -232,15 +232,15 @@ minetest.register_node("ontime_clocks:frameless_white", {
"#FFF", 48, ontime_clocks.get_h12(), ontime_clocks.get_m12()))
end },
},
on_place = display_lib.on_place,
on_construct = display_lib.on_construct,
on_destruct = display_lib.on_destruct,
on_rotate = display_lib.on_rotate,
on_place = display_api.on_place,
on_construct = display_api.on_construct,
on_destruct = display_api.on_destruct,
on_rotate = display_api.on_rotate,
})
minetest.register_abm({
nodenames = {"ontime_clocks:frameless_white"},
interval = 5,
chance = 1,
action = display_lib.update_entities,
action = display_api.update_entities,
})

@ -21,113 +21,40 @@
local S = signs.intllib
local F = function(...) return minetest.formspec_escape(S(...)) end
function signs.set_display_text(pos,text)
local meta = minetest.get_meta(pos)
meta:set_string("display_text", text)
meta:set_string("infotext", "\""..text.."\"")
display_lib.update_entities(pos)
--Backwards compatibility functions
signs.set_display_text = function(...)
minetest.log("warning", "signs.set_display_text() is deprecated, please use signs_api.set_display_text() instead.")
return signs_api.set_display_text(...)
end
function signs.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
signs.set_formspec = function(...)
minetest.log("warning", "signs.set_formspec() is deprecated, please use signs_api.set_formspec() instead.")
return signs_api.set_formspec(...)
end
function signs.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.set_display_text(pos, fields.display_text)
end
end
signs.on_receive_fields = function(...)
minetest.log("warning", "signs.on_receive_fields() is deprecated, please use signs_api.on_receive_fields() instead.")
return signs_api.on_receive_fields(...)
end
-- On place callback for direction signs
-- (chooses which sign according to look direction)
function signs.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
signs.on_place_direction = function(...)
minetest.log("warning", "signs.on_place_direction() is deprecated, please use signs_api.on_place_direction() instead.")
return signs_api.on_place_direction(...)
end
-- Handles screwdriver rotation. Direction is affected for direction signs
function signs.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_lib.update_entities(pos)
end
else
display_lib.on_rotate(pos, node, user, mode, new_param2)
end
return false;
signs.on_rotate = function(...)
minetest.log("warning", "signs.on_rotate() is deprecated, please use signs_api.on_rotate() instead.")
return signs_api.on_rotate(...)
end
signs.register_sign = function(...)
minetest.log("warning", "signs.register_sign() is deprecated, please use signs_api.register_sign() instead.")
return signs_api.register_sign(...)
end
-- Generic callback for show_formspec displayed formspecs of "sign" mod
minetest.register_on_player_receive_fields(function(player, formname, fields)
@ -142,59 +69,3 @@ minetest.register_on_player_receive_fields(function(player, formname, fields)
end
end
end)
function signs.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_lib_node = 1},
sounds = default.node_sound_defaults(),
display_entities = {
["signs:display_text"] = {
on_display_update = font_lib.on_display_update,
depth = 0.5 - display_lib.entity_spacing - model.depth,
size = { x = model.width, y = model.height },
resolution = { x = 64, y = 64 },
maxlines = 1,
},
},
on_place = display_lib.on_place,
on_construct = function(pos)
signs.set_formspec(pos)
display_lib.on_construct(pos)
end,
on_destruct = display_lib.on_destruct,
on_rotate = signs.on_rotate,
on_receive_fields = signs.on_receive_fields,
on_punch = function(pos, node, player, pointed_thing) display_lib.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

@ -43,9 +43,9 @@ local function compatibility_check_1(pos, node)
node.name = convert_nodes[node.name]
if node.name then
node.param2 = wallmounted_to_facedir[node.param2]
display_lib.on_destruct(pos)
display_api.on_destruct(pos)
minetest.swap_node(pos, node)
display_lib.on_construct(pos)
display_api.on_construct(pos)
end
end
@ -76,7 +76,7 @@ local function compatibility_check_2(pos, node)
end
end
-- Create new entity
display_lib.update_entities(pos)
display_api.update_entities(pos)
end
minetest.register_lbm({ name = "signs:conpatibility_2",

@ -1,4 +1,5 @@
default
intllib?
display_lib
font_lib
display_api
font_api
signs_api

@ -28,7 +28,7 @@ local function display_poster(pos, node, player)
local def = minetest.registered_nodes[node.name].display_entities["signs:display_text"]
-- Title texture
local titletexture = font_lib.make_multiline_texture(
local titletexture = font_api.make_multiline_texture(
def.font_name, meta:get_string("display_text"),
116, 12, def.maxlines, def.valign, def.color)
@ -61,9 +61,9 @@ local function edit_poster(pos, node, player)
"size[6.5,7.5]"..
default.gui_bg .. default.gui_bg_img .. default.gui_slots ..
"field[0.5,0.7;6,1;display_text;"..F("Title")..";"..
minetest.formspec_escape(meta:get_string("display_text")).."]"..
minetest.formspec_escape(meta:get_string("display_text")).."]"..
"textarea[0.5,1.7;6,6;text;"..F("Text")..";"..
minetest.formspec_escape(meta:get_string("text")).."]"..
minetest.formspec_escape(meta:get_string("text")).."]"..
"button_exit[2.25,7;2,1;write;"..F("Write").."]"
minetest.show_formspec(player:get_player_name(),
node.name.."@"..minetest.pos_to_string(pos)..":edit",
@ -87,14 +87,14 @@ local function on_receive_fields_poster(pos, formname, fields, player)
meta:set_string("text", fields.text)
meta:set_string("infotext", "\""..fields.display_text
.."\"\n"..S("(right-click to read more text)"))
display_lib.update_entities(pos)
display_api.update_entities(pos)
display_poster(pos, node, player)
end
end
end
-- Text entity for all signs
display_lib.register_display_entity("signs:display_text")
display_api.register_display_entity("signs:display_text")
-- Sign models and registration
local models = {
@ -103,7 +103,7 @@ local models = {
width = 14/16,
height = 7/16,
entity_fields = {
right = -3/32,
right = -3/32,
size = { x = 12/16, y = 6/16 },
resolution = { x = 9, y = 5 },
maxlines = 2,
@ -113,8 +113,8 @@ local models = {
description = S("Wooden direction sign"),
tiles = { "signs_wooden_direction.png" },
inventory_image = "signs_wooden_inventory.png",
signs_other_dir = 'signs:wooden_left_sign',
on_place = signs.on_place_direction,
signs_other_dir = 'signs:wooden_left_sign',
on_place = signs_api.on_place_direction,
drawtype = "mesh",
mesh = "signs_dir_right.obj",
selection_box = { type="fixed", fixed = {-0.5, -7/32, 0.5, 7/16, 7/32, 7/16}},
@ -126,7 +126,7 @@ local models = {
width = 14/16,
height = 7/16,
entity_fields = {
right = 3/32,
right = 3/32,
size = { x = 12/16, y = 6/16 },
resolution = { x = 9, y = 5 },
maxlines = 2,
@ -136,7 +136,7 @@ local models = {
description = S("Wooden direction sign"),
tiles = { "signs_wooden_direction.png" },
inventory_image = "signs_wooden_inventory.png",
signs_other_dir = 'signs:wooden_right_sign',
signs_other_dir = 'signs:wooden_right_sign',
drawtype = "mesh",
mesh = "signs_dir_left.obj",
selection_box = { type="fixed", fixed = {-7/16, -7/32, 0.5, 0.5, 7/32, 7/16}},
@ -158,10 +158,10 @@ local models = {
node_fields = {
description = S("Poster"),
tiles = { "signs_poster_sides.png", "signs_poster_sides.png",
"signs_poster_sides.png", "signs_poster_sides.png",
"signs_poster_sides.png", "signs_poster.png" },
"signs_poster_sides.png", "signs_poster_sides.png",
"signs_poster_sides.png", "signs_poster.png" },
inventory_image = "signs_poster_inventory.png",
on_construct = display_lib.on_construct,
on_construct = display_api.on_construct,
on_rightclick = display_poster,
on_receive_fields = on_receive_fields_poster,
},
@ -171,6 +171,6 @@ local models = {
-- Node registration
for name, model in pairs(models)
do
signs.register_sign("signs", name, model)
signs_api.register_sign("signs", name, model)
end

166
signs_api/LICENSE.txt Normal file

@ -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.

29
signs_api/README.md Normal file

@ -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.

188
signs_api/common.lua Normal file

@ -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")

10
signs_api/copyright.txt Normal file

@ -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)

4
signs_api/depends.txt Normal file

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

33
signs_api/init.lua Normal file

@ -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")

45
signs_api/intllib.lua Normal file

@ -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

49
signs_api/locale/fr.po Normal file

@ -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"

46
signs_api/locale/ms.po Normal file

@ -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"

@ -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 ""

25
signs_api/tools/updatepo.sh Executable file

@ -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

@ -45,9 +45,9 @@ local function compatibility_check(pos, node)
node.name = convert_nodes[node.name]
if node.name then
node.param2 = wallmounted_to_facedir[node.param2]
display_lib.on_destruct(pos)
display_api.on_destruct(pos)
minetest.swap_node(pos, node)
display_lib.on_construct(pos)
display_api.on_construct(pos)
end
end
@ -69,7 +69,7 @@ local function compatibility_check_2(pos, node)
end
end
-- Create new entity
display_lib.update_entities(pos)
display_api.update_entities(pos)
end
minetest.register_lbm({ name = "signs_road:conpatibility_2",

@ -1,6 +1,6 @@
default
intllib?
dye
display_lib
font_lib
signs
display_api
font_api
signs_api

@ -131,7 +131,7 @@ local models = {
width = 1,
height = 0.5,
entity_fields = {
resolution = { x = 7, y = 5 },
resolution = { x = 7, y = 5 },
maxlines = 1,
color = "#000",
},
@ -142,8 +142,8 @@ local models = {
"signs_road_sides.png", "signs_road_black_dir_right.png" },
inventory_image = "signs_road_black_dir_inventory.png",
signs_other_dir = "signs_road:black_left_sign",
on_place = signs.on_place_direction,
on_rightclick = signs.on_right_click_direction,
on_place = signs_api.on_place_direction,
on_rightclick = signs_api.on_right_click_direction,
},
},
black_left_sign = {
@ -164,8 +164,8 @@ local models = {
signs_other_dir = "signs_road:black_right_sign",
groups = { not_in_creative_inventory = 1 },
drop = "signs_road:black_right_sign",
on_place = signs.on_place_direction,
on_rightclick = signs.on_right_click_direction,
on_place = signs_api.on_place_direction,
on_rightclick = signs_api.on_right_click_direction,
},
},
@ -174,7 +174,7 @@ local models = {
width = 14/16,
height = 7/16,
entity_fields = {
right = -3/32,
right = -3/32,
size = { x = 12/16, y = 6/16 },
resolution = { x = 9, y = 5.5 },
maxlines = 2,
@ -185,8 +185,8 @@ local models = {
tiles = { "signs_road_green_direction.png" },
inventory_image = "signs_road_green_dir_inventory.png",
signs_other_dir = "signs_road:green_left_sign",
on_place = signs.on_place_direction,
on_rightclick = signs.on_right_click_direction,
on_place = signs_api.on_place_direction,
on_rightclick = signs_api.on_right_click_direction,
drawtype = "mesh",
mesh = "signs_dir_right.obj",
selection_box = { type = "fixed", fixed = { -0.5, -7/32, 0.5, 7/16, 7/32, 7/16 } },
@ -198,7 +198,7 @@ local models = {
width = 14/16,
height = 7/16,
entity_fields = {
right = 3/32,
right = 3/32,
size = { x = 12/16, y = 6/16 },
resolution = { x = 9, y = 5.5 },
maxlines = 2,
@ -209,8 +209,8 @@ local models = {
tiles = { "signs_road_green_direction.png" },
inventory_image = "signs_road_green_dir_inventory.png",
signs_other_dir = "signs_road:green_right_sign",
on_place = signs.on_place_direction,
on_rightclick = signs.on_right_click_direction,
on_place = signs_api.on_place_direction,
on_rightclick = signs_api.on_right_click_direction,
drawtype = "mesh",
mesh = "signs_dir_left.obj",
selection_box = { type = "fixed", fixed = { -7/16, -7/32, 0.5, 0.5, 7/32, 7/16 } },
@ -224,7 +224,7 @@ local models = {
width = 14/16,
height = 7/16,
entity_fields = {
right = -3/32,
right = -3/32,
size = { x = 12/16, y = 6/16 },
resolution = { x = 9, y = 5.5 },
maxlines = 2,
@ -235,8 +235,8 @@ local models = {
tiles = { "signs_road_yellow_direction.png" },
inventory_image = "signs_road_yellow_dir_inventory.png",
signs_other_dir = "signs_road:yellow_left_sign",
on_place = signs.on_place_direction,
on_rightclick = signs.on_right_click_direction,
on_place = signs_api.on_place_direction,
on_rightclick = signs_api.on_right_click_direction,
drawtype = "mesh",
mesh = "signs_dir_right.obj",
selection_box = { type = "fixed", fixed = { -0.5, -7/32, 0.5, 7/16, 7/32, 7/16 } },
@ -248,7 +248,7 @@ local models = {
width = 14/16,
height = 7/16,
entity_fields = {
right = 3/32,
right = 3/32,
size = { x = 12/16, y = 6/16 },
resolution = { x = 9, y = 5.5 },
maxlines = 2,
@ -259,8 +259,8 @@ local models = {
tiles = { "signs_road_yellow_direction.png" },
inventory_image = "signs_road_yellow_dir_inventory.png",
signs_other_dir = "signs_road:yellow_right_sign",
on_place = signs.on_place_direction,
on_rightclick = signs.on_right_click_direction,
on_place = signs_api.on_place_direction,
on_rightclick = signs_api.on_right_click_direction,
drawtype = "mesh",
mesh = "signs_dir_left.obj",
selection_box = { type = "fixed", fixed = { -7/16, -7/32, 0.5, 0.5, 7/32, 7/16 } },
@ -274,7 +274,7 @@ local models = {
width = 14/16,
height = 7/16,
entity_fields = {
right = -3/32,
right = -3/32,
size = { x = 12/16, y = 6/16 },
resolution = { x = 9, y = 5.5 },
maxlines = 2,
@ -285,8 +285,8 @@ local models = {
tiles = { "signs_road_white_direction.png" },
inventory_image = "signs_road_white_dir_inventory.png",
signs_other_dir = "signs_road:white_left_sign",
on_place = signs.on_place_direction,
on_rightclick = signs.on_right_click_direction,
on_place = signs_api.on_place_direction,
on_rightclick = signs_api.on_right_click_direction,
drawtype = "mesh",
mesh = "signs_dir_right.obj",
selection_box = { type = "fixed", fixed = { -0.5, -7/32, 0.5, 7/16, 7/32, 7/16 } },
@ -298,7 +298,7 @@ local models = {
width = 14/16,
height = 7/16,
entity_fields = {
right = 3/32,
right = 3/32,
size = { x = 12/16, y = 6/16 },
resolution = { x = 9, y = 5.5 },
maxlines = 2,
@ -309,8 +309,8 @@ local models = {
tiles = { "signs_road_white_direction.png" },
inventory_image = "signs_road_white_dir_inventory.png",
signs_other_dir = "signs_road:white_right_sign",
on_place=signs.on_place_direction,
on_rightclick = signs.on_right_click_direction,
on_place=signs_api.on_place_direction,
on_rightclick = signs_api.on_right_click_direction,
drawtype = "mesh",
mesh = "signs_dir_left.obj",
selection_box = { type = "fixed", fixed = { -7/16, -7/32, 0.5, 0.5, 7/32, 7/16 } },
@ -324,7 +324,7 @@ local models = {
-- Node registration
for name, model in pairs(models)
do
signs.register_sign("signs_road", name, model)
signs_api.register_sign("signs_road", name, model)
end

@ -1,5 +1,5 @@
default
intllib?
display_lib
font_lib
display_api
font_api
technic?

@ -21,7 +21,7 @@
local S = steles.intllib
local F = function(...) return minetest.formspec_escape(S(...)) end
display_lib.register_display_entity("steles:text")
display_api.register_display_entity("steles:text")
for i, material in ipairs(steles.materials) do
@ -30,7 +30,7 @@ for i, material in ipairs(steles.materials) do
if ndef then
local groups = table.copy(ndef.groups)
local parts = material:split(":")
groups.display_lib_node = 1
groups.display_modpack_node = 1
minetest.register_node("steles:"..parts[2].."_stele", {
description = steles.materials_desc[i],
@ -49,8 +49,8 @@ for i, material in ipairs(steles.materials) do
groups = groups,
display_entities = {
["steles:text"] = {
on_display_update = font_lib.on_display_update,
depth = -2/16 - display_lib.entity_spacing, height = 2/16,
on_display_update = font_api.on_display_update,
depth = -2/16 - display_api.entity_spacing, height = 2/16,
size = { x = 14/16, y = 12/16 },
resolution = { x = 11, y = 5 },
maxlines = 3,
@ -58,7 +58,7 @@ for i, material in ipairs(steles.materials) do
},
on_place = function(itemstack, placer, pointed_thing)
minetest.rotate_node(itemstack, placer, pointed_thing)
display_lib.on_place(itemstack, placer, pointed_thing)
display_api.on_place(itemstack, placer, pointed_thing)
end,
on_construct = function(pos)
local meta = minetest.get_meta(pos)
@ -68,21 +68,21 @@ for i, material in ipairs(steles.materials) do
..F("Displayed text (3 lines max)")
..";${display_text}]"
.."button_exit[2,3;2,1;ok;"..F("Write").."]")
display_lib.on_construct(pos)
display_api.on_construct(pos)
end,
on_destruct = display_lib.on_destruct,
on_rotate = display_lib.on_rotate,
on_destruct = display_api.on_destruct,
on_rotate = display_api.on_rotate,
on_receive_fields = function(pos, formname, fields, player)
if not minetest.is_protected(pos, player:get_player_name()) then
local meta = minetest.get_meta(pos)
if fields and fields.ok then
meta:set_string("display_text", fields.display_text)
meta:set_string("infotext", "\""..fields.display_text.."\"")
display_lib.update_entities(pos)
display_api.update_entities(pos)
end
end
end,
on_punch = display_lib.update_entities,
on_punch = display_api.update_entities,
})
end
end