On move support aka jumpdrive compat (#9)

* whitespace and minetest. -> core.

- use same whitespace style throughout and fix some indents.
- change from minetest. to core. namespace.

* Update Readme: Minetest -> Luanti

* add luacheck

* update optional depends

* luacheck cleanups

- unused arguments
- shaddowed vars
- var redeclarations
- some whitespace involved in above lines

* clean close of file after reading

* avoid duplicate code

save some lines and some extra method calls.

* avoid error: "unknown global"

* stray whitespace fixups

* whitespace: switch all files to same indent character

tabs -> spaces

* refactor weird declaration

* whitespace: two stray spaces

...that slipped through the cracks on previous whitespace edit

* fix shaddowing global table

* reduce amount of times transformation string is calculated

* use ipairs feature

or use the faster repeat-until-loop

* cap max amount of layers

fixes #5

* fix #5 make transform history non-global

fixes #5
transformation history was shared by all users and kept growing as it
was never truely reset. Every time a user
used a banner a white background was dumped on top of the
stack making it possible to crash the server through an
overflow to core.serialize() function.

* minimize metadata size

also changed banners.max_transformations to
banners.max_undo_levels and lowered the value substantially.

* add versioning

* add recoverable per player history with saved colour

* rename update_all -> update_preview_inv

since it isn't updating everything, only
the preview and the inventory item

* dynamically update masks

to reflect the currently selected colour.

* banner always exists

even if only "" it exists and there isn't an error.
not adding "" or texture string, causes a non critical error.

* use same function declaration style throughout

* remove set_banner_texture()

only used once and is easy enough to have inline

* preserve player undo-history over joins

player could have timed-out and thus lost their history.
It isn't crucial to remove their history, so let's give
them this feature.

* refactor: reusable transformation string creation

unfortunately the git diff is a bit messy on this one.
Nothing changed with:
- banners.Banner
- banners.Banner:new
- banners.Banner:push_transform
- banners.Banner:pop_transform

content of banners.Banner:get_transform_string was moved
to banners.transform_table_to_string with very few changes

* add transform_string_to_table

allows us to add more features such as:
- clean existing banners to slim down data
- read transforms from items in inventory -> allow players
  to change existing patterns without having to start from
  scratch.

* cleanup old banners when their entities are generated

* read item meta allowing players to edit existing banners

* version bump

* oopsie fixes

* remove stray debug point

* add chatcommand banners_fix

fixes #7
provides a work-around for the engine problem with entities.

* sensitive github luacheck syntax

* version bump

* cleanup: compact node definitions

* adds [jumpdrive] compat

github.com/mt-mods/jumpdrive

closes https://github.com/mt-mods/jumpdrive/issues/90

* also make factions banners jump-able

just for completeness sake

.github/workflows/luacheck.yml

@@ -0,0 +1,10 @@
+name: luacheck
+on: [push, pull_request]
+jobs:
+  luacheck:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+      - name: Luacheck
+        uses: lunarmodules/luacheck@master

.luacheckrc

@@ -0,0 +1,14 @@
+globals = {
+    "banners",
+    "smartfs",
+}
+
+read_globals = {
+    "core",
+    "dump",
+    "factions",
+    "inventory_plus",
+    ["table"] = { fields = { "insert_all" } },
+    "unified_inventory",
+    "vector",
+}

README.md

@@ -1,4 +1,4 @@
-###Banners mod for Minetest
+###Banners mod for Luanti (formerly Minetest)
-This is the banner mod for minetest.
+This is a banner mod for Luanti.
 The source code is licensed under GPLv3, and the game assets are licensed under Creative Commons 0 (CC0, [https://wiki.creativecommons.org/wiki/CC0](see here)).
 

chatcommands.lua

@@ -0,0 +1,53 @@
+-- Due to some engine troubles there are sometimes stray
+-- banner entities and more rarely there are banner nodes without entities.
+-- Calling this command fixes both situations.
+core.register_chatcommand("banners_fix", {
+    description = "recreates the banner-visuals in your area",
+    func = function(name)
+        local player = core.get_player_by_name(name)
+        if not player then
+            return
+        end
+
+        local pos = player:get_pos()
+        local t1 = core.get_us_time()
+
+        local radius = 10
+        local entity_count = 0
+        local objects = core.get_objects_inside_radius(pos, radius)
+        for _, v in ipairs(objects) do
+            local e = v:get_luaentity()
+            if e and e.name == "banners:banner_ent" then
+                entity_count = entity_count + 1
+                v:remove()
+            end
+        end
+
+        local pos1 = vector.subtract(pos, radius)
+        local pos2 = vector.add(pos, radius)
+        local nodes = {
+            "banners:wooden_banner",
+            "banners:steel_banner",
+        }
+        if core.get_modpath("factions") then
+            table.insert_all(nodes, {
+                "banners:power_banner",
+                "banners:death_banner",
+
+            })
+        end
+        local pos_list = core.find_nodes_in_area(pos1, pos2, nodes)
+
+        for _, node_pos in ipairs(pos_list) do
+            core.add_entity(node_pos, "banners:banner_ent")
+        end
+
+        local t2 = core.get_us_time()
+        local diff = t2 - t1
+        local millis = diff / 1000
+
+        return true, "Removed " .. entity_count .. " banner entities and restored "
+            .. #pos_list .. " banners in " .. millis .. " ms"
+    end
+})
+

crafts.lua

@@ -1,78 +1,73 @@
 
 -- craft recipes
-minetest.register_craft( -- wooden flag pole
-    {
-        output = "banners:wooden_pole 1",
-        recipe = {
-            {"", "", "default:stick"},
-            {"", "default:stick", ""},
-            {"default:stick", "", ""}
-        }
-    }
-)
 
-minetest.register_craft( -- steel flag pole
+-- wooden flag pole
-    {
+core.register_craft({
-        output = "banners:steel_pole 1",
+    output = "banners:wooden_pole 1",
-        recipe = {
+    recipe = {
-            {"", "", "default:steel_ingot"},
+        { "", "", "default:stick" },
-            {"default:stick", "default:steel_ingot", "default:stick"},
+        { "", "default:stick", "" },
-            {"default:steel_ingot", "", ""}
+        { "default:stick", "", "" }
-        }
     }
-)
+})
 
-minetest.register_craft( -- wooden flag support base
+-- steel flag pole
-    {
+core.register_craft({
-        output = "banners:wooden_base 1",
+    output = "banners:steel_pole 1",
-        recipe = {
+    recipe = {
-            {"", "default:stick", ""},
+        { "", "", "default:steel_ingot" },
-            {"default:stick", "", "default:stick"},
+        { "default:stick", "default:steel_ingot", "default:stick" },
-            {"group:wood", "group:wood", "group:wood"}
+        { "default:steel_ingot", "", "" }
-        }
     }
-)
+})
 
-minetest.register_craft( -- steel support
+-- wooden flag support base
-    {
+core.register_craft({
-        output = "banners:steel_base",
+    output = "banners:wooden_base 1",
-        recipe = {
+    recipe = {
-            {"", "default:steel_ingot", ""},
+        { "", "default:stick", "" },
-            {"default:steel_ingot", "", "default:steel_ingot"},
+        { "default:stick", "", "default:stick" },
-            {"", "default:steelblock", ""}
+        { "group:wood", "group:wood", "group:wood" }
-        }
     }
-)
+})
 
-minetest.register_craft( -- banner sheet
+-- steel support
-    {
+core.register_craft({
-        output = "banners:banner_sheet 1",
+    output = "banners:steel_base",
-        recipe = {
+    recipe = {
-            {"", "", ""},
+        { "", "default:steel_ingot", "" },
-            {"farming:cotton", "farming:cotton", "farming:cotton"},
+        { "default:steel_ingot", "", "default:steel_ingot" },
-            {"farming:cotton", "farming:cotton", "farming:cotton"}
+        { "", "default:steelblock", "" }
-        }
     }
-)
+})
 
-minetest.register_craft( -- wooden support
+-- banner sheet
-    {
+core.register_craft({
-        output = "banners:wooden_banner 1",
+    output = "banners:banner_sheet 1",
-        recipe = {
+    recipe = {
-            {"", "banners:banner_sheet", ""},
+        { "", "", "" },
-            {"", "banners:wooden_pole", ""},
+        { "farming:cotton", "farming:cotton", "farming:cotton" },
-            {"", "banners:wooden_base", ""}
+        { "farming:cotton", "farming:cotton", "farming:cotton" }
-        }
     }
-)
+})
 
-minetest.register_craft( -- steel support
+-- wooden support
-    {
+core.register_craft({
-        output = "banners:steel_banner 1",
+    output = "banners:wooden_banner 1",
-        recipe = {
+    recipe = {
-            {"", "banners:banner_sheet", ""},
+        { "", "banners:banner_sheet", "" },
-            {"", "banners:steel_pole", ""},
+        { "", "banners:wooden_pole", "" },
-            {"", "banners:steel_base", ""}
+        { "", "banners:wooden_base", "" }
-        }
     }
-)
+})
+
+-- steel support
+core.register_craft({
+    output = "banners:steel_banner 1",
+    recipe = {
+        { "", "banners:banner_sheet", "" },
+        { "", "banners:steel_pole", "" },
+        { "", "banners:steel_base", "" }
+    }
+})
+

depends.txt

@@ -1,2 +0,0 @@
-default
-farming

description.txt

@@ -1 +0,0 @@
-Adds customisable banners.

factions.lua

@@ -1,43 +1,43 @@
 banners.power_per_banner = 10.
 
 -- items
-minetest.register_craftitem("banners:golden_finial", {
+core.register_craftitem("banners:golden_finial", {
     groups = {},
     description = "Golden finial",
     inventory_image = "gold_finial.png",
 })
 
-minetest.register_craftitem("banners:silver_pole", {
+core.register_craftitem("banners:silver_pole", {
     groups = {},
     description = "Silver pole",
     inventory_image = "silver_pole.png"
 })
 
-minetest.register_craftitem("banners:power_pole", {
+core.register_craftitem("banners:power_pole", {
     groups = {},
     description = "Power pole",
     inventory_image = "power_pole.png"
 })
 
-minetest.register_craftitem("banners:golden_sheet", {
+core.register_craftitem("banners:golden_sheet", {
     groups = {},
     description = "Golden sheet",
     inventory_image = "golden_sheet.png"
 })
 
-minetest.register_craftitem("banners:death_pole", {
+core.register_craftitem("banners:death_pole", {
     groups = {},
     description = "Death pole",
     inventory_image = "death_pole.png"
 })
 
-minetest.register_craftitem("banners:death_sheet", {
+core.register_craftitem("banners:death_sheet", {
     groups = {},
     description = "Death sheet",
     inventory_image = "death_sheet.png"
 })
 
-minetest.register_craftitem("banners:death_base", {
+core.register_craftitem("banners:death_base", {
     groups = {},
     description = "Death base",
     inventory_image = "death_base.png"
@@ -46,122 +46,110 @@ minetest.register_craftitem("banners:death_base", {
 
 -- crafts
 
-minetest.register_craft( -- silver flag pole
+-- silver flag pole
-    {
+core.register_craft({
-        output = "banners:silver_pole 1",
+    output = "banners:silver_pole 1",
-        recipe = {
+    recipe = {
-            {"", "", "moreores:silver_ingot"},
+        { "", "", "moreores:silver_ingot" },
-            {"", "moreores:silver_ingot", ""},
+        { "", "moreores:silver_ingot", "" },
-            {"moreores:silver_ingot", "", ""}
+        { "moreores:silver_ingot", "", "" }
-        }
     }
-)
+})
 
-minetest.register_craft( -- death flag pole
+-- death flag pole
-    {
+core.register_craft({
-        output = "banners:death_pole 1",
+    output = "banners:death_pole 1",
-        recipe = {
+    recipe = {
-            {"", "", "default:diamond"},
+        { "", "", "default:diamond" },
-            {"", "default:obsidian", ""},
+        { "", "default:obsidian", "" },
-            {"default:obsidian", "", ""}
+        { "default:obsidian", "", "" }
-        }
     }
-)
+})
 
-minetest.register_craft( -- golden finial
+-- golden finial
-    {
+core.register_craft({
-        output = "banners:golden_finial",
+    output = "banners:golden_finial",
-        recipe = {
+    recipe = {
-            {"", "default:gold_ingot", "default:gold_ingot"},
+        { "", "default:gold_ingot", "default:gold_ingot" },
-            {"", "default:gold_ingot", "default:gold_ingot"},
+        { "", "default:gold_ingot", "default:gold_ingot" },
-            {"default:gold_ingot", "", ""}
+        { "default:gold_ingot", "", "" }
-        }
     }
-)
+})
 
-minetest.register_craft( -- power flag pole
+-- power flag pole
-    {
+core.register_craft({
-        output = "banners:power_pole 1",
+    output = "banners:power_pole 1",
-        recipe = {
+    recipe = {
-            {"", "", ""},
+        { "", "", "" },
-            {"", "banners:golden_finial", ""},
+        { "", "banners:golden_finial", "" },
-            {"banners:silver_pole", "", ""}
+        { "banners:silver_pole", "", "" }
-        }
     }
-)
+})
 
-minetest.register_craft( -- golden sheet
+-- golden sheet
-    {
+core.register_craft({
-        output = "banners:golden_sheet 1",
+    output = "banners:golden_sheet 1",
-        type = "shapeless",
+    type = "shapeless",
-        recipe = { "default:gold_ingot", "banners:banner_sheet"}
+    recipe = { "default:gold_ingot", "banners:banner_sheet" }
-    }
+})
-)
 
-minetest.register_craft( -- death sheet
+-- death sheet
-    {
+core.register_craft({
-        output = "banners:death_sheet 1",
+    output = "banners:death_sheet 1",
-        type = "shapeless",
+    type = "shapeless",
-        recipe = { "default:obsidian", "banners:banner_sheet"}
+    recipe = { "default:obsidian", "banners:banner_sheet" }
-    }
+})
-)
 
-minetest.register_craft( -- death sheet
+-- death sheet
-    {
+core.register_craft({
-        output = "banners:death_base 1",
+    output = "banners:death_base 1",
-        recipe = {
+    recipe = {
-            {"", "", ""},
+        { "", "", "" },
-            {"", "banners:steel_base", ""},
+        { "", "banners:steel_base", "" },
-            {"default:obsidian", "default:obsidian", "default:obsidian"}
+        { "default:obsidian", "default:obsidian", "default:obsidian" }
-        }
     }
-)
+})
 
-minetest.register_craft( -- power banner
+-- power banner
-    {
+core.register_craft({
-        output = "banners:power_banner",
+    output = "banners:power_banner",
-        recipe = {
+    recipe = {
-            {"", "banners:golden_sheet", ""},
+        { "", "banners:golden_sheet", "" },
-            {"", "banners:power_pole", ""},
+        { "", "banners:power_pole", "" },
-            {"", "banners:steel_base", ""}
+        { "", "banners:steel_base", "" }
-        }
     }
-)
+})
 
-minetest.register_craft( -- death banner
+-- death banner
-    {
+core.register_craft({
-        output = "banners:death_banner",
+    output = "banners:death_banner",
-        recipe = {
+    recipe = {
-            {"", "banners:death_sheet", ""},
+        { "", "banners:death_sheet", "" },
-            {"", "banners:death_pole", ""},
+        { "", "banners:death_pole", "" },
-            {"", "banners:death_base", ""}
+        { "", "banners:death_base", "" }
-        }
     }
-)
+})
 
 
 -- nodes
-minetest.register_node("banners:power_banner", {
+core.register_node("banners:power_banner", {
     drawtype = "mesh",
     mesh = "banner_support.x",
-    tiles = {"gold_support.png"},
+    tiles = { "gold_support.png" },
     description = "Power Banner",
-    groups = {cracky=3},
+    groups = { cracky = 3 },
+    is_ground_content = false,
     diggable = true,
     stack_max = 1,
     paramtype = "light",
     paramtype2 = "facedir",
-    after_place_node = function (pos, player, itemstack, pointed_thing)
+    after_place_node = banners.after_powerbanner_placed,
-        banners.after_powerbanner_placed(pos, player, itemstack, pointed_thing)
+    on_destruct = banners.banner_on_destruct,
-      end,
-    on_destruct = function(pos)
-        banners.banner_on_destruct(pos)
-    end,
     on_dig = function(pos, n, p)
-        if minetest.is_protected(pos, p:get_player_name()) then
+        if core.is_protected(pos, p:get_player_name()) then
             return
         end
-        local meta = minetest.get_meta(pos)
+        local meta = core.get_meta(pos)
         local facname = meta:get_string("faction")
         if facname then
             local faction = factions.factions[facname]
@@ -171,29 +159,28 @@ minetest.register_node("banners:power_banner", {
         end
         banners.banner_on_dig(pos, n, p)
     end,
+    on_movenode = banners.banner_on_movenode,
 })
 
-minetest.register_node("banners:death_banner", {
+core.register_node("banners:death_banner", {
     drawtype = "mesh",
     mesh = "banner_support.x",
-    tiles = {"death_uv.png"},
+    tiles = { "death_uv.png" },
     description = "Death Banner",
-    groups = {cracky=3},
+    groups = { cracky = 3 },
+    is_ground_content = false,
     diggable = true,
     stack_max = 1,
     paramtype = "light",
     paramtype2 = "facedir",
-    after_place_node = function (pos, player, itemstack, pointed_thing)
+    after_place_node = banners.after_deathbanner_placed,
-        banners.after_deathbanner_placed(pos, player, itemstack, pointed_thing)
+    on_destruct = banners.banner_on_destruct,
-      end,
+    -- (pos, node, player)
-    on_destruct = function(pos)
+    on_dig = function(pos, _, player)
-        banners.banner_on_destruct(pos)
+        if core.is_protected(pos, player:get_player_name()) then
-    end,
-    on_dig = function(pos, n, p)
-        if minetest.is_protected(pos, p:get_player_name()) then
             return
         end
-        local meta = minetest.get_meta(pos)
+        local meta = core.get_meta(pos)
         local defending_facname = meta:get_string("faction")
         local parcelpos = factions.get_parcel_pos(pos)
         if defending_facname then
@@ -202,34 +189,37 @@ minetest.register_node("banners:death_banner", {
                 faction:stop_attack(parcelpos)
             end
         end
-        minetest.remove_node(pos)
+        core.remove_node(pos)
     end,
+    on_movenode = banners.banner_on_movenode,
 })
 
-banners.after_powerbanner_placed = function(pos, player, itemstack, pointed_thing)
+-- (pos, player, itemstack, pointed_thing)
-    minetest.get_node(pos).param2 = banners.determine_flag_direction(pos, pointed_thing)
+banners.after_powerbanner_placed = function(pos, player, _, pointed_thing)
+    core.get_node(pos).param2 = banners.determine_flag_direction(pos, pointed_thing)
     local faction = factions.players[player:get_player_name()]
     if not faction then
-        minetest.get_meta(pos):set_string("banner", "bg_white.png")
+        core.get_meta(pos):set_string("banner", "bg_white.png")
     else
         local banner_string = factions.factions[faction].banner
-        minetest.get_meta(pos):set_string("banner", banner_string)
+        core.get_meta(pos):set_string("banner", banner_string)
-        minetest.get_meta(pos):set_string("faction", faction)
+        core.get_meta(pos):set_string("faction", faction)
         factions.factions[faction]:increase_maxpower(banners.power_per_banner)
     end
-    minetest.add_entity(pos, "banners:banner_ent")
+    core.add_entity(pos, "banners:banner_ent")
 end
 
-banners.after_deathbanner_placed = function(pos, player, itemstack, pointed_thing)
+-- (pos, player, itemstack, pointed_thing)
-    minetest.get_node(pos).param2 = banners.determine_flag_direction(pos, pointed_thing)
+banners.after_deathbanner_placed = function(pos, player, _, pointed_thing)
+    core.get_node(pos).param2 = banners.determine_flag_direction(pos, pointed_thing)
     local attacking_faction = factions.players[player:get_player_name()]
     if attacking_faction then
         local parcelpos = factions.get_parcel_pos(pos)
         attacking_faction = factions.factions[attacking_faction]
         attacking_faction:attack_parcel(parcelpos)
-        minetest.get_meta(pos):set_string("faction", attacking_faction.name)
+        core.get_meta(pos):set_string("faction", attacking_faction.name)
     end
-    minetest.get_meta(pos):set_string("banner", "death_uv.png")
+    core.get_meta(pos):set_string("banner", "death_uv.png")
-    minetest.add_entity(pos, "banners:banner_ent")
+    core.add_entity(pos, "banners:banner_ent")
 end
 

init.lua

@@ -1,6 +1,9 @@
-dofile(minetest.get_modpath("banners").."/smartfs.lua")
+local MP = core.get_modpath("banners") .. "/"
+dofile(MP .. "smartfs.lua")
 
-banners = {}
+banners = {
+    version = 20241130.1920
+}
 
 banners.masks = {
     "bend_left", "bend_left_outline",
@@ -28,6 +31,15 @@ banners.masks = {
     "star_chevron", "checkered_8_4", "checkered_16_8"
 }
 
+-- It is now unlikely for the server to crash from too long
+-- history since we now trim out garbage when converting to
+-- metadata. This limit is now just to avoid run-time
+-- memory bloat.
+banners.max_undo_levels = 256
+
+-- cache of player histories
+local histories = {}
+
 banners.colors = {
     "black", "cyan", "green", "white",
     "blue", "darkblue", "red", "yellow",
@@ -35,58 +47,91 @@ banners.colors = {
     "brown", "darkbrown"
 }
 
-banners.base_transform = ({texture = "bg_white.png",
+local valid_masks = {}
-    mask="mask_background.png"})
+local valid_colors = {}
+do
+    local i, s
+    i = #banners.masks
+    repeat
+        s = banners.masks[i]
+        valid_masks[s .. ".png"] = true
+        i = i - 1
+    until i == 0
 
-banners.creation_form_func = function(state)
+    i = #banners.colors
+    repeat
+        s = banners.colors[i]
+        valid_colors["bg_" .. s .. ".png"] = true
+        i = i - 1
+    until i == 0
+end
+
+banners.base_transform = {
+    texture = "bg_white.png",
+    mask = "mask_background.png"
+}
+
+function banners.creation_form_func(state)
     -- helper functions
-    state.update_player_inv = function(self)
+    function state:update_player_inv(transform_string)
-        local player = minetest.get_player_by_name(self.player)
+        local player = core.get_player_by_name(self.player)
         local newbanner = player:get_wielded_item()
-        newbanner:set_metadata(state.banner:get_transform_string())
+        newbanner:get_meta():set_string("", transform_string)
         player:set_wielded_item(newbanner)
     end
-    state.update_preview = function(self)
+    function state:update_preview(transform_string)
-        self:get("banner_preview"):setImage(self.banner:get_transform_string())
+        self:get("banner_preview"):setImage(transform_string)
         self:get("color_indicator"):setImage(self.current_color)
     end
-    state.update_all = function(self)
+    function state:update_preview_inv()
-        self:update_preview()
+        local transform_string = self.banner:get_transform_string()
-        self:update_player_inv()
+        self:update_preview(transform_string)
+        self:update_player_inv(transform_string)
     end
-    -- initialize with empty banner
+    if histories[state.player] then
-    state.banner = banners.Banner:new(nil)
+        -- initialize with saved history
-    state.banner:push_transform(banners.base_transform)
+        state.banner = histories[state.player]
-    state.current_color = "bg_white.png"
+    else
-    state:size(20,10)
+        -- initialize with empty banner
+        state.banner = banners.Banner:new(nil)
+        state.banner:push_transform(banners.base_transform)
+        histories[state.player] = state.banner
+    end
+    state.banner:read_item(state.player)
+    state.current_color = state.banner.color
+    state:size(20, 10)
     state:image(3, 0.4, 4, 2, "banner_preview", nil)
     state:image(2.4, 0.8, 0.7, 0.7, "color_indicator", state.current_color)
-    state:update_all()
+    state:update_preview_inv()
     -- color indicator
     -- undo button
-    state:button(0.5, 0.3, 2, 1, "undo", "Undo"):click(function(self, state)
+    state:button(0.5, 0.3, 2, 1, "undo", "Undo"):click(function(_, state2)
-            if #state.banner.transforms > 1 then
+        if #state2.banner.transforms > 1 then
-                state.banner:pop_transform()
+            state2.banner:pop_transform()
-                state:update_all()
+            state2:update_preview_inv()
-            end
+        end
-        end)
+    end)
     -- delete button
-    state:button(0.5, 1.3, 2, 1, "delete", "Delete"):click(function(self, state)
+    state:button(0.5, 1.3, 2, 1, "delete", "Delete"):click(function(_, state2)
-            state.banner.transforms = {banners.base_transform}
+        state2.banner.transforms = { banners.base_transform }
-            state:update_all()
+        state2:update_preview_inv()
-        end)
+    end)
     -- add banners colors
     local x = 7
     local y = .3
-    for i in ipairs(banners.colors) do 
+    for _, color in ipairs(banners.colors) do
-        local b = state:button(x, y, 1, 1, banners.colors[i], "")
+        local b = state:button(x, y, 1, 1, color, "")
-        b:setImage("bg_"..banners.colors[i]..".png")
+        b:setImage("bg_" .. color .. ".png")
-        b:click(function(self, state)
+        b:click(function(self, state2)
-                    state.current_color = "bg_"..self.name..".png"
+            state2.current_color = "bg_" .. self.name .. ".png"
-                    state:update_preview()
+            state2:get("color_indicator"):setImage(state2.current_color)
-                    -- todo: update masks or something
+            state2.banner.color = state2.current_color
-                end
+            -- update masks
-            )
+            for _, mask in ipairs(banners.masks) do
+                state2:get(mask):setImage("(" .. state2.current_color
+                    .. "^[mask:" .. mask .. ".png^[makealpha:0,0,0)")
+            end
+        end)
         x = x + 1
         if x > 19 then
             y = y + 1
@@ -94,16 +139,19 @@ banners.creation_form_func = function(state)
         end
     end
     -- add banners buttons
-    local x = 1
+    x = 1
-    local y = 3
+    y = 3
-    for i in ipairs(banners.masks) do
+    for _, mask in ipairs(banners.masks) do
-        local b = state:button(x, y, 2, 1, banners.masks[i], "")
+        local b = state:button(x, y, 2, 1, mask, "")
-        b:setImage(banners.masks[i]..".png")
+        b:setImage("(" .. state.current_color
-        b:click(function(self, state)
+            .. "^[mask:" .. mask .. ".png^[makealpha:0,0,0)")
-                    state.banner:push_transform({texture=state.current_color, mask=self.name..".png"})
+        b:click(function(self, state2)
-                    state:update_all()
+            state2.banner:push_transform({
-                end
+                texture = state2.current_color,
-        )
+                mask = self.name .. ".png"
+            })
+            state2:update_preview_inv()
+        end)
         x = x + 2
         if x > 17.5 then
             y = y + 1
@@ -114,62 +162,133 @@ banners.creation_form_func = function(state)
 end
 
 banners.creation_form = smartfs.create("banners:banner_creation",
-    banners.creation_form_func);
+    banners.creation_form_func)
 
+function banners.transform_string_to_table(transform_string)
+    local mask, parts, texture
+    local transforms = {}
+    for part in transform_string:gmatch("%(([^%)]+)%)") do
+        parts = part:split("^[")
+        if 3 == #parts then
+            texture = parts[1]
+            mask = parts[2]:sub(6)
+            if valid_masks[mask] and valid_colors[texture] then
+                table.insert(transforms, {
+                    texture = texture,
+                    mask = mask
+                })
+            end
+        end
+    end
+    return transforms
+end
+
+function banners.transform_table_to_string(transforms)
+    local i = #transforms
+    if 0 == i then return "" end
+
+    local final = {}
+    local used = {}
+    local transform
+    -- work backwards to keep resulting data small
+    repeat
+        transform = transforms[i]
+        -- duplicate mask can be trimmed out only use most recent
+        if not used[transform.mask] then
+            used[transform.mask] = true
+            table.insert(final, 1, "(" .. transform.texture
+                .. "^[mask:" .. transform.mask .. "^[makealpha:0,0,0)")
+            -- anything before a background is fully covered
+            if "mask_background.png" == transform.mask then
+                break
+            end
+        end
+        i = i - 1
+    until i == 0
+    return table.concat(final, "^")
+end
 
 -- banner definition
-banners.Banner = {
+banners.Banner = {}
-    transforms = {}
+
-}
 function banners.Banner:new(banner)
-    banner = banner or {}
+    banner = banner or { color = "bg_black.png", transforms = {} }
     setmetatable(banner, self)
     self.__index = self
     return banner
 end
-function banners.Banner.push_transform(self, transform)
+
+function banners.Banner:push_transform(transform)
     table.insert(self.transforms, transform)
+    if #self.transforms > banners.max_undo_levels then
+        table.remove(self.transforms, 1)
+    end
 end
-function banners.Banner.pop_transform(self)
+
+function banners.Banner:pop_transform()
     table.remove(self.transforms)
 end
-function banners.Banner.get_transform_string(self)
+
-    local final = {}
+function banners.Banner:get_transform_string()
-    for i in ipairs(self.transforms) do
+    return banners.transform_table_to_string(self.transforms)
-        table.insert(final, "("..self.transforms[i].texture.."^[mask:"..self.transforms[i].mask.."^[makealpha:0,0,0)")
+end
-    end
+
-    local ret = table.concat(final, "^")
+function banners.Banner:read_item(player_name)
-    return ret
+    local player = core.get_player_by_name(player_name)
+    local item = player:get_wielded_item()
+    if "banners:" ~= item:get_name():sub(1, 8) then return end
+
+    local transforms = banners.transform_string_to_table(
+        item:get_meta():get_string(""))
+    local total = #transforms
+    if 0 == total then return end
+
+    local i = 1
+    repeat
+        self:push_transform(transforms[i])
+        i = i + 1
+    until i > total
 end
 
 -- helper function for determining the flag's direction
-banners.determine_flag_direction = function(pos, pointed_thing)
+-- (pos, pointed_thing)
+function banners.determine_flag_direction(_, pointed_thing)
     local above = pointed_thing.above
     local under = pointed_thing.under
-    local dir = {x = under.x - above.x,
+    local dir = {
-                 y = under.y - above.y,
+        x = under.x - above.x,
-                 z = under.z - above.z}
+        y = under.y - above.y,
-    return minetest.dir_to_wallmounted(dir)
+        z = under.z - above.z
+    }
+    return core.dir_to_wallmounted(dir)
 end
 
-banners.banner_on_use = function(itemstack, player, pointed_thing)
+-- (itemstack, player, pointed_thing)
+function banners.banner_on_use(_, player)
     if player.is_player then
         banners.creation_form:show(player:get_player_name())
     end
 end
 
-banners.banner_on_dig = function(pos, node, player)
+function banners.banner_on_dig(pos, node, player)
-    local meta = minetest.get_meta(pos)
+    if not player or core.is_protected(pos, player:get_player_name()) then
-    if player then 
+		return
-        local inventory = player:get_inventory()
+	end
-        inventory:add_item("main", {name=node.name, count=1, wear=0, metadata=meta:get_string("banner")})
+    local meta = core.get_meta(pos)
-    end
+    local inventory = player:get_inventory()
-    minetest.remove_node(pos)
+    inventory:add_item("main", {
+        name = node.name,
+        count = 1,
+        wear = 0,
+        metadata = meta:get_string("banner")
+    })
+    core.remove_node(pos)
 end
 
-banners.banner_on_destruct = function(pos, node, player)
+-- (pos, node, player)
-    local objects = minetest.get_objects_inside_radius(pos, 0.5)
+function banners.banner_on_destruct(pos)
-    for _,v in ipairs(objects) do
+    local objects = core.get_objects_inside_radius(pos, 0.5)
+    for _, v in ipairs(objects) do
         local e = v:get_luaentity()
         if e and e.name == "banners:banner_ent" then
             v:remove()
@@ -177,23 +296,35 @@ banners.banner_on_destruct = function(pos, node, player)
     end
 end
 
-banners.banner_after_place = function (pos, player, itemstack, pointed_thing)
+-- (pos, player, itemstack, pointed_thing)
-    minetest.get_node(pos).param2 = banners.determine_flag_direction(pos, pointed_thing)
+function banners.banner_after_place(pos, _, itemstack, pointed_thing)
-    minetest.get_meta(pos):set_string("banner", itemstack:get_metadata())
+    core.get_node(pos).param2 = banners.determine_flag_direction(pos, pointed_thing)
-    minetest.add_entity(pos, "banners:banner_ent")
+    local meta = core.get_meta(pos)
+    meta:set_string("banner", itemstack:get_meta():get_string(""))
+    meta:set_float("version", banners.version)
+    core.add_entity(pos, "banners:banner_ent")
+end
+
+-- [jumpdrive] compat
+-- (from_pos, to_pos, additional_info)
+function banners.banner_on_movenode(_, to_pos)
+    core.add_entity(to_pos, "banners:banner_ent")
 end
 
 -- banner entity
-local set_banner_texture
-set_banner_texture = function (obj, texture)
-    obj:set_properties({textures={"banner_uv_text.png^"..texture}})
-end
 
-
+function banners:banner_on_activate()
-banners.banner_on_activate = function(self)
+    local pos = self.object:get_pos()
-    local pos = self.object:getpos()
+    local meta = core.get_meta(pos)
-    local banner = minetest.get_meta(pos):get_string("banner")
+    local banner = meta:get_string("banner")
-    local banner_face = minetest.get_node(pos).param2
+    -- cleanup meta of old banners
+    if meta:get_float("version") < 20241122 then
+        meta:set_float("version", banners.version)
+        banner = banners.transform_table_to_string(
+            banners.transform_string_to_table(banner))
+        meta:set_string("banner", banner)
+    end
+    local banner_face = core.get_node(pos).param2
     local yaw = 0.
     if banner_face == 2 then
         yaw = 0.
@@ -204,27 +335,28 @@ banners.banner_on_activate = function(self)
     elseif banner_face == 3 then
         yaw = 4.71238898038469 -- 3 * pi / 2
     end
-    self.object:setyaw(yaw)
+    self.object:set_yaw(yaw)
-    if banner then
+    self.object:set_properties({
-        set_banner_texture(self.object, banner)
+        textures = { "banner_uv_text.png^" .. banner }
-    end
+    })
 end
 
-minetest.register_entity("banners:banner_ent",
+core.register_entity("banners:banner_ent", {
-    {
+    initial_properties = {
-        collisionbox = {0,0,0,0,0,0},
+        collisionbox = { 0, 0, 0, 0, 0, 0 },
         visual = "mesh",
-        textures = {"banner_uv_text"},
+        textures = { "banner_uv_text" },
         mesh = "banner_pole.x",
-        on_activate = banners.banner_on_activate,
+    },
-    }
+    on_activate = banners.banner_on_activate,
-)
+})
 
-if minetest.get_modpath("factions") then
+if core.get_modpath("factions") then
-    dofile(minetest.get_modpath("banners").."/factions.lua")
+    dofile(MP .. "factions.lua")
 end
 
-dofile(minetest.get_modpath("banners").."/items.lua")
+dofile(MP .. "items.lua")
-dofile(minetest.get_modpath("banners").."/nodes.lua")
+dofile(MP .. "nodes.lua")
-dofile(minetest.get_modpath("banners").."/crafts.lua")
+dofile(MP .. "crafts.lua")
+dofile(MP .. "chatcommands.lua")
 

items.lua

@@ -2,44 +2,35 @@
 
 -- items
 
-minetest.register_craftitem("banners:banner_sheet",
+core.register_craftitem("banners:banner_sheet", {
-    {
+    groups = {},
-        groups = {},
+    description = "Banner sheet",
-        description = "Banner sheet",
+    inventory_image = "banner_sheet.png",
-        inventory_image = "banner_sheet.png",
+    stack_max = 1,
-        stack_max = 1,
+    metadata = "",
-        metadata = "",
+})
-    }
-)
 
-minetest.register_craftitem("banners:wooden_pole",
+core.register_craftitem("banners:wooden_pole", {
-    {
+    groups = {},
-        groups = {},
+    description = "Wooden pole",
-        description = "Wooden pole",
+    inventory_image = "wooden_pole.png"
-        inventory_image = "wooden_pole.png"
+})
-    }
-)
 
-minetest.register_craftitem("banners:wooden_base",
+core.register_craftitem("banners:wooden_base", {
-    {
+    groups = {},
-        groups = {},
+    description = "Wooden base",
-        description = "Wooden base",
+    inventory_image = "wooden_base.png"
-        inventory_image = "wooden_base.png"
+})
-    }
-)
 
-minetest.register_craftitem("banners:steel_pole",
+core.register_craftitem("banners:steel_pole", {
-    {
+    groups = {},
-        groups = {},
+    description = "Steel pole",
-        description = "Steel pole",
+    inventory_image = "steel_pole.png"
-        inventory_image = "steel_pole.png"
+})
-    }
+
-)
+core.register_craftitem("banners:steel_base", {
+    groups = {},
+    description = "Steel base",
+    inventory_image = "steel_base.png"
+})
 
-minetest.register_craftitem("banners:steel_base",
-    {
-        groups = {},
-        description = "Steel base",
-        inventory_image = "steel_base.png"
-    }
-)

mod.conf

@@ -0,0 +1,4 @@
+name = banners
+description = Adds customisable banners.
+depends = default, farming
+optional_depends = factions, inventory_plus, unified_inventory

nodes.lua

@@ -1,55 +1,38 @@
 -- da wooden banner
-minetest.register_node("banners:wooden_banner",
+core.register_node("banners:wooden_banner", {
-    {
+    drawtype = "mesh",
-        drawtype = "mesh",
+    mesh = "banner_support.x",
-        mesh = "banner_support.x",
+    tiles = { "banner_support.png" },
-        tiles = {"banner_support.png"},
+    description = "Wooden banner",
-        description = "Wooden banner",
+    groups = { choppy = 2, dig_immediate = 2 },
-        groups = {choppy=2, dig_immediate=2},
+    is_ground_content = false,
-        diggable = true,
+    diggable = true,
-        stack_max = 1,
+    stack_max = 1,
-        paramtype="light",
+    paramtype = "light",
-        paramtype2="facedir",
+    paramtype2 = "facedir",
-        after_place_node = function (pos, player, itemstack, pointed_thing)
+    after_place_node = banners.banner_after_place,
-            banners.banner_after_place(pos, player, itemstack, pointed_thing)
+    on_destruct = banners.banner_on_destruct,
-          end,
+    on_use = banners.banner_on_use,
-        on_destruct = function(pos)
+    on_dig = banners.banner_on_dig,
-            banners.banner_on_destruct(pos)
+    on_movenode = banners.banner_on_movenode,
-        end,
+})
-        on_use = function(i, p, pt)
-            banners.banner_on_use(i, p, pt)
-        end,
-        on_dig = function(pos, n, p) 
-            banners.banner_on_dig(pos, n, p)
-        end
-    }
-)
 
 -- steel banner
-minetest.register_node("banners:steel_banner",
+core.register_node("banners:steel_banner", {
-    {
+    drawtype = "mesh",
-        drawtype = "mesh",
+    mesh = "banner_support.x",
-        mesh = "banner_support.x",
+    tiles = { "steel_support.png" },
-        tiles = {"steel_support.png"},
+    description = "Steel banner",
-        description = "Steel banner",
+    groups = { cracky = 2 },
-        groups = {cracky=2},
+    is_ground_content = false,
-        diggable = true,
+    diggable = true,
-        stack_max = 1,
+    stack_max = 1,
-        paramtype = "light",
+    paramtype = "light",
-        paramtype2 = "facedir",
+    paramtype2 = "facedir",
-        after_place_node = function (pos, player, itemstack, pointed_thing)
+    after_place_node = banners.banner_after_place,
-            banners.banner_after_place(pos, player, itemstack, pointed_thing)
+    on_destruct = banners.banner_on_destruct,
-          end,
+    on_use = banners.banner_on_use,
-        on_destruct = function(pos)
+    on_dig = banners.banner_on_dig,
-            banners.banner_on_destruct(pos)
+    on_movenode = banners.banner_on_movenode,
-        end,
+})
-        on_use = function(i, p, pt)
-            banners.banner_on_use(i, p, pt)
-        end,
-        on_dig = function(pos, n, p) 
-            banners.banner_on_dig(pos, n, p)
-        end
-
-    }
-)