add writing table

.gitattributes

@@ -0,0 +1,15 @@
+# Creating an archive
+
+.* export-ignore
+assets export-ignore
+scripts export-ignore
+bin export-ignore
+docs export-ignore
+types export-ignore
+*.zip export-ignore
+bitbucket-pipelines.yml export-ignore
+package.json export-ignore
+package-lock.json export-ignore
+screenshot*.png export-ignore
+i18n.py export-ignore
+config.ld export-ignore

LICENSE.txt

@@ -1,8 +1,7 @@
                   GNU LESSER GENERAL PUBLIC LICENSE
                        Version 2.1, February 1999
 
- Copyright (C) 1991, 1999 Free Software Foundation, Inc.
- 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ Copyright (C) 2023 SaKeL <juraj.vajda@gmail.com>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -55,7 +54,7 @@ modified by someone else and passed on, the recipients should know
 that what they have is not the original version, so that the original
 author's reputation will not be affected by problems that might be
 introduced by others.
-
+
   Finally, software patents pose a constant threat to the existence of
 any free program.  We wish to make sure that a company cannot
 effectively restrict the users of a free program by obtaining a
@@ -111,7 +110,7 @@ modification follow.  Pay close attention to the difference between a
 "work based on the library" and a "work that uses the library".  The
 former contains code derived from the library, whereas the latter must
 be combined with the library in order to run.
-
+
                   GNU LESSER GENERAL PUBLIC LICENSE
    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
@@ -158,7 +157,7 @@ Library.
   You may charge a fee for the physical act of transferring a copy,
 and you may at your option offer warranty protection in exchange for a
 fee.
-
+
   2. You may modify your copy or copies of the Library or any portion
 of it, thus forming a work based on the Library, and copy and
 distribute such modifications or work under the terms of Section 1
@@ -216,7 +215,7 @@ instead of to this License.  (If a newer version than version 2 of the
 ordinary GNU General Public License has appeared, then you can specify
 that version instead if you wish.)  Do not make any other change in
 these notices.
-
+
   Once this change is made in a given copy, it is irreversible for
 that copy, so the ordinary GNU General Public License applies to all
 subsequent copies and derivative works made from that copy.
@@ -267,7 +266,7 @@ Library will still fall under Section 6.)
 distribute the object code for the work under the terms of Section 6.
 Any executables containing that work also fall under Section 6,
 whether or not they are linked directly with the Library itself.
-
+
   6. As an exception to the Sections above, you may also combine or
 link a "work that uses the Library" with the Library to produce a
 work containing portions of the Library, and distribute that work
@@ -329,7 +328,7 @@ restrictions of other proprietary libraries that do not normally
 accompany the operating system.  Such a contradiction means you cannot
 use both them and the Library together in an executable that you
 distribute.
-
+
   7. 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 not covered by this License, and distribute such a combined
@@ -370,7 +369,7 @@ subject to these terms and conditions.  You may not impose any further
 restrictions on the recipients' exercise of the rights granted herein.
 You are not responsible for enforcing compliance by third parties with
 this License.
-
+
   11. If, as a consequence of a court judgment or allegation of patent
 infringement or for any other reason (not limited to patent issues),
 conditions are imposed on you (whether by court order, agreement or
@@ -422,7 +421,7 @@ conditions either of that version or of any later version published by
 the Free Software Foundation.  If the Library does not specify a
 license version number, you may choose any version ever published by
 the Free Software Foundation.
-
+
   14. If you wish to incorporate parts of the Library into other free
 programs whose distribution conditions are incompatible with these,
 write to the author to ask for permission.  For software which is
@@ -454,49 +453,3 @@ RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
 FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
 SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
 DAMAGES.
-
-                     END OF TERMS AND CONDITIONS
-
-           How to Apply These Terms to Your New Libraries
-
-  If you develop a new library, and you want it to be of the greatest
-possible use to the public, we recommend making it free software that
-everyone can redistribute and change.  You can do so by permitting
-redistribution under these terms (or, alternatively, under the terms of the
-ordinary General Public License).
-
-  To apply these terms, attach the following notices to the library.  It is
-safest to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least the
-"copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the library's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This library is free software; you can redistribute it and/or
-    modify it under the terms of the GNU Lesser General Public
-    License as published by the Free Software Foundation; either
-    version 2.1 of the License, or (at your option) any later version.
-
-    This library is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-    Lesser General Public License for more details.
-
-    You should have received a copy of the GNU Lesser General Public
-    License along with this library; if not, write to the Free Software
-    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
-
-Also add information on how to contact you by electronic and paper mail.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the library, if
-necessary.  Here is a sample; alter the names:
-
-  Yoyodyne, Inc., hereby disclaims all copyright interest in the
-  library `Frob' (a library for tweaking knobs) written by James Random Hacker.
-
-  <signature of Ty Coon>, 1 April 1990
-  Ty Coon, President of Vice
-
-That's all there is to it!

README.md

@@ -6,8 +6,10 @@ Adds Enchanting Mechanics and API.
 
 ## Features
 
+* does not add new tools/items, it's using MT API to change existing items instead
 * adds enchanting table
 * supports all registered tools with known tool groups: pickaxe, shovel, axe, sword, e.g. `groups = {pickaxe = 1}`
+* supports all bows with group `{bow = 1}`
 * supports `default:bookshelf` or anything with `group:bookshelf`
 * enchanting trade is for `default:mese_crystal` or anything with `groups = {enchanting_trade = 1}`
 * adds enchantability for all MT default tools, for custom tools the enchantability can be set in the item group, e.g. `groups = {enchantability = 15}`
@@ -16,8 +18,6 @@ Adds Enchanting Mechanics and API.
 * mesh node model
 * mesh entity model and animations
 
-NOTE: item inventory/wield image will not be adjusted until this feature is supported by MT engine, see: https://github.com/minetest/minetest/issues/5686
-
 ## How To
 
 ### Enchanting Setup
@@ -50,30 +50,125 @@ Items enchantibility from worst to best:
 
 Increases melee damage.
 
+groups: sword
+
 #### Fortune
 
-Increases the number and/or chances of specific item drops. This value is not used in the engine; it is the responsibility of the game/mod code to implement this.
+Increases the number and/or chances of specific item drops. Works with groups: stone, soil, sand, snowy, slippery, tree, leaves and all registered ores.
+
+Incompatible: Silk Touch
+
+groups: pickaxe, shovel, axe
 
 #### Unbreaking
 
 Increases the item's durability.
 
+groups: any
+
 #### Efficiency
 
 Increases the player's mining speed. Also adds mining groupcaps to item, e.g. enchanted wood pickaxe can mine level 1 nodes (e.g. obsidian) after enchantment.
 
+groups: pickaxe, shovel, axe
+
 #### Silk Touch
 
 Causes certain blocks to drop themselves as items instead of their usual drops when mined. Mods can prevent this behaviour with adding group `{ no_silktouch = 1 }` to the nodes.
 
+Incompatible: Fortune
+
+groups: pickaxe, shovel, axe
+
 #### Curse of Vanishing
 
 Causes the item to disappear on death.
 
-### Knockback
+groups: any
+
+#### Knockback
 
 Increases knockback (players only).
 
+groups: sword
+
+#### Looting
+
+Cause mobs to drop more items. This value is not used in the engine; it is the responsibility of the game/mod code to implement this.
+
+Supported: mobs_monster, mobs_animal, animalia
+
+groups: sword
+
+#### Power
+
+Increases arrow damage.
+Damage has to be calculated in the MOD where the bow comes from!
+
+groups: bow
+
+#### Punch
+
+Increases arrow knockback.
+Knockback has to be calculated in the MOD where the bow comes from!
+
+This can be obtained from tool meta:
+
+groups: bow
+
+#### Infinity
+
+Prevents regular arrows from being consumed when shot.
+One arrow is needed INSIDE QUIVER to use a bow enchanted with Infinity.
+Fired arrows cannot be retrieved even if they are not fired from Quiver.
+Only set in item meta, logic for this has to be in the MOD where the bow comes from!
+
+groups: bow
+
+## API
+
+`ItemStackMetaRef`
+
+* `get_float(key)`: Returns `0` if key not present. `key` can be enchantment id prefixed with `is_`,
+e.g. enchantment `punch` would have stored meta as `is_punch`. If returned value is bigger than zero
+then the value represents enchantment level bonus. See below fields for bow:
+    * `power` Increase percentage
+    * `punch` Multiplier
+    * `infinity` If `1` then it is infinity enchanted
+* `get_string(key)`: Returns `""` if key not present. See below fields for all enchantments:
+    * `x_enchanting` Serialized table with key/value pairs where: `key` is enchantment `id` and `value` is `Enchantment` definition
+
+`Enchantment` definition
+
+* `value` number, Value of the enchantment based on level, e.g. multiplier, percentage/number increase...
+
+example:
+
+```lua
+-- For simplicity assuming that all meta are present (biggger than zero or not "")
+-- MODs have to add those checks individually
+
+local itemstack_meta = itemstack:get_meta()
+
+local power_value = itemstack_meta:get_float('is_power')
+local punch_value = itemstack_meta:get_float('is_punch')
+local infinity_value = itemstack_meta:get_float('is_infinity')
+
+-- Or for list of all enchantments
+local x_enchanting = minetest.deserialize(itemstack_meta:get_string('x_enchanting')) or {}
+local power_enchantment = enchantments.power
+local punch_enchantment = enchantments.punch
+local infinity_enchantment = enchantments.infinity
+
+-- Custom logic
+local new_damage = damage + damage * (punch_enchantment.value / 100)
+local new_knockback = knockback * punch_enchantment.value
+
+if enchantments.infinity.value > 0 then
+    -- Some logic for infinity
+end
+```
+
 ## Dependencies
 
 - none
@@ -81,6 +176,7 @@ Increases knockback (players only).
 ## Optional Dependencies
 
 - xdecor (adjusts conflicting recipe)
+- item_drop (make sure fortune will execute before item_drop mod overrides `handle_node_drops`)
 
 ## License:
 
@@ -90,7 +186,7 @@ GNU Lesser General Public License v2.1 or later (see included LICENSE file)
 
 ### Textures
 
-**CC BY-SA 4.0, Pixel Perfection by XSSheep**, https://minecraft.curseforge.com/projects/pixel-perfection-freshly-updated
+**CC-BY-SA-4.0, Pixel Perfection by XSSheep**, https://minecraft.curseforge.com/projects/pixel-perfection-freshly-updated
 
 - x_enchanting_symbol_1.png
 - x_enchanting_symbol_2.png
@@ -119,7 +215,7 @@ GNU Lesser General Public License v2.1 or later (see included LICENSE file)
 - x_enchanting_symbol_25.png
 - x_enchanting_symbol_26.png
 
-**LGPL-2.1-or-later, by SaKeL**
+**CC-BY-SA-4.0, by SaKeL**
 
 - x_enchanting_image_button_disabled.png
 - x_enchanting_image_button.png
@@ -130,11 +226,15 @@ GNU Lesser General Public License v2.1 or later (see included LICENSE file)
 - x_enchanting_scroll_mesh.png -- Derived from a texture TumeniNodes (CC BY-SA 3.0)
 - x_enchanting_scroll_particle.png
 - x_enchanting_table.png
-- x_enchanting_trade_slot.png
+- x_enchanting_gui_slot_bg.png -- Derived from texture Pixel Perfection by XSSheep (CC-BY-SA-4.0)
+- x_enchanting_gui_cloth_bg.png -- Derived from texture Pixel Perfection by XSSheep (CC-BY-SA-4.0)
+- x_enchanting_gui_cloth_trade_bg.png -- Derived from texture Pixel Perfection by XSSheep (CC-BY-SA-4.0)
+- x_enchanting_gui_formbg.png -- Derived from texture Pixel Perfection by XSSheep (CC-BY-SA-4.0)
+- x_enchanting_gui_hb_bg.png -- Derived from texture Pixel Perfection by XSSheep (CC-BY-SA-4.0)
 
 ### Models
 
-**LGPL-2.1-or-later, by SaKeL**
+**CC-BY-SA-4.0, by SaKeL**
 
 - x_enchanting_scroll.b3d
 - x_enchanting_table.obj

bitbucket-pipelines.yml

@@ -31,36 +31,6 @@ pipelines:
                     script:
                         - nvm use v17.2.0
                         - npm run lua-diagnostics
-    branches:
-        master:
-            - step:
-                name: Install Node Dependencies
-                caches:
-                    - node-modules
-                    - npm
-                    - nvm
-                script:
-                    - nvm install v17.2.0
-                    - npm i -g npm@8
-                    - npm ci
-            - parallel:
-                - step:
-                    name: Lua Check
-                    script:
-                        - apt-get update
-                        - apt-get -y install lua5.1
-                        - apt-get -y install luarocks
-                        - luarocks install luacheck
-                        - luacheck .
-                - step:
-                    name: Lua Diagnostics
-                    caches:
-                        - node-modules
-                        - npm
-                        - nvm
-                    script:
-                        - nvm use v17.2.0
-                        - npm run lua-diagnostics
     tags:
         "*":
             - step:
@@ -73,24 +43,24 @@ pipelines:
                     - nvm install v17.2.0
                     - npm i -g npm@8
                     - npm ci
-            - parallel:
-                - step:
-                    name: Lua Check
-                    script:
-                        - apt-get update
-                        - apt-get -y install lua5.1
-                        - apt-get -y install luarocks
-                        - luarocks install luacheck
-                        - luacheck .
-                - step:
-                    name: Lua Diagnostics
-                    caches:
-                        - node-modules
-                        - npm
-                        - nvm
-                    script:
-                        - nvm use v17.2.0
-                        - npm run lua-diagnostics
+            # - parallel:
+            - step:
+                name: Lua Check
+                script:
+                    - apt-get update
+                    - apt-get -y install lua5.1
+                    - apt-get -y install luarocks
+                    - luarocks install luacheck
+                    - luacheck .
+                # - step:
+                #     name: Lua Diagnostics
+                #     caches:
+                #         - node-modules
+                #         - npm
+                #         - nvm
+                #     script:
+                #         - nvm use v17.2.0
+                #         - npm run lua-diagnostics
             - step:
                 name: Deploy to ContentDB
                 caches:

init.lua

@@ -1,20 +1,185 @@
--- X Enchanting
--- by SaKeL
+--[[
+    X Enchanting. Adds Enchanting Mechanics and API.
+    Copyright (C) 2023 SaKeL <juraj.vajda@gmail.com>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to juraj.vajda@gmail.com
+--]]
 
 local path = minetest.get_modpath('x_enchanting')
 local mod_start_time = minetest.get_us_time()
 
 dofile(path .. '/api.lua')
 dofile(path .. '/table.lua')
+dofile(path .. '/writing_table.lua')
+
+---Check if string X starts with string Y
+---@param str string
+---@param start string
+---@return boolean
+local function starts_with(str, start)
+    return str:sub(1, #start) == start
+end
 
 minetest.register_on_mods_loaded(function()
+    -- Tools override
     for name, tool_def in pairs(minetest.registered_tools) do
         if XEnchanting:has_tool_group(name) then
-            XEnchanting:set_tool_enchantability(tool_def)
+            XEnchanting:set_enchantability(tool_def)
+        end
+    end
+
+    -- Craft items override
+    for name, tool_def in pairs(minetest.registered_craftitems) do
+        if XEnchanting:has_tool_group(name) then
+            XEnchanting:set_enchantability(tool_def)
+        end
+    end
+
+    -- Ores override - Fortune
+    for _, def in pairs(minetest.registered_ores) do
+        if not XEnchanting.registered_ores[def.ore] then
+            XEnchanting.registered_ores[def.ore] = true
+        end
+    end
+
+    -- Entities override - Looting
+    for name, def in pairs(minetest.registered_entities) do
+        if starts_with(name, 'mobs_animal:')
+            or starts_with(name, 'mobs_monster:')
+        then
+            if def.on_punch and def.drops then
+                local prev_on_punch = def.on_punch
+
+                ---@param self table
+                ---@param puncher ObjectRef|nil
+                ---@param time_from_last_punch number|integer|nil
+                ---@param tool_capabilities ToolCapabilitiesDef|nil
+                ---@param dir Vector
+                ---@param damage number|integer
+                ---@return boolean|nil
+                def.on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir, damage)
+                    if not self
+                        or not self.object
+                        or not self.object:get_luaentity()
+                        or not puncher
+                        or not tool_capabilities
+                    then
+                        return prev_on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir, damage)
+                    end
+
+                    local wield_stack = puncher:get_wielded_item()
+                    local wield_stack_meta = wield_stack:get_meta()
+                    local looting = wield_stack_meta:get_float('is_looting')
+
+                    if looting == 0 then
+                        return prev_on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir, damage)
+                    end
+
+                    local pos = self.object:get_pos()
+
+                    prev_on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir, damage)
+
+                    if self.health and self.health <= 0 then
+                        local death_by_player = self.cause_of_death
+                            and self.cause_of_death.puncher
+                            and self.cause_of_death.puncher:is_player()
+
+                        if death_by_player and pos then
+                            for _, drop in ipairs(def.drops) do
+                                if math.random(10, 100) / 100 < looting / (looting + 1) then
+                                    local drop_min = drop.min or 0
+                                    local drop_max = drop.max or 0
+                                    local count = math.random(drop_min, drop_max)
+                                    local stack = ItemStack({
+                                        name = drop.name,
+                                        count = count
+                                    })
+                                    local chance = math.random(1, tool_capabilities.max_drop_level)
+
+                                    stack:set_count(stack:get_count() * chance)
+
+                                    if stack:get_count() > 0 then
+                                        minetest.item_drop(stack, puncher, pos)
+                                    end
+                                end
+                            end
+                        end
+                    end
+                end
+            end
+        elseif starts_with(name, 'animalia:') then
+            if def.death_func and def.drops then
+                local prev_death_func = def.death_func
+
+                ---@param self table
+                def.death_func = function(self)
+                    local puncher = self._puncher
+
+                    if not self
+                        or not self.object
+                        or not self.object:get_luaentity()
+                        or not puncher
+                        or not puncher:is_player()
+                        or self._looting_dropped
+                    then
+                        return prev_death_func(self)
+                    end
+
+                    local wield_stack = puncher:get_wielded_item()
+                    local wield_stack_meta = wield_stack:get_meta()
+                    local looting = wield_stack_meta:get_float('is_looting')
+
+                    if looting == 0 then
+                        return prev_death_func(self)
+                    end
+
+                    local pos = self.object:get_pos()
+
+                    prev_death_func(self)
+
+                    local death_by_player = puncher and puncher:is_player()
+
+                    if death_by_player and pos then
+                        local tool_capabilities = wield_stack:get_tool_capabilities()
+                        self._looting_dropped = true
+
+                        for _, drop in ipairs(def.drops) do
+                            if math.random(10, 100) / 100 < looting / (looting + 1) then
+                                local drop_min = drop.min or 0
+                                local drop_max = drop.max or 0
+                                local count = math.random(drop_min, drop_max)
+                                local stack = ItemStack({
+                                    name = drop.name,
+                                    count = count
+                                })
+                                local chance = math.random(1, tool_capabilities.max_drop_level)
+
+                                stack:set_count(stack:get_count() * chance)
+
+                                if stack:get_count() > 0 then
+                                    minetest.item_drop(stack, puncher, pos)
+                                end
+                            end
+                        end
+                    end
+                end
+            end
         end
     end
 end)
 
+---@diagnostic disable-next-line: unused-local
 minetest.register_on_joinplayer(function(player, last_login)
     XEnchanting.form_context[player:get_player_name()] = nil
 
@@ -23,11 +188,11 @@ minetest.register_on_joinplayer(function(player, last_login)
     end
 end)
 
+---@diagnostic disable-next-line: unused-local
 minetest.register_on_leaveplayer(function(player, timed_out)
     XEnchanting.form_context[player:get_player_name()] = nil
 end)
 
--- Silk Touch
 local old_handle_node_drops = minetest.handle_node_drops
 
 function minetest.handle_node_drops(pos, drops, digger)
@@ -37,29 +202,64 @@ function minetest.handle_node_drops(pos, drops, digger)
         return old_handle_node_drops(pos, drops, digger)
     end
 
+    local node = minetest.get_node(pos)
     local wield_stack = digger:get_wielded_item()
     local wield_stack_meta = wield_stack:get_meta()
 
-    if wield_stack_meta:get_float('is_silk_touch') == 0 then
+    -- Fortune
+    local fortune = wield_stack_meta:get_float('is_fortune')
+
+    if fortune > 0 then
+        local new_drops = {}
+
+        for _, itemstring in ipairs(drops) do
+            if XEnchanting.registered_ores[node.name]
+                or minetest.get_item_group(node.name, 'stone') > 0
+                or minetest.get_item_group(node.name, 'soil') > 0
+                or minetest.get_item_group(node.name, 'sand') > 0
+                or minetest.get_item_group(node.name, 'snowy') > 0
+                or minetest.get_item_group(node.name, 'slippery') > 0
+                or minetest.get_item_group(node.name, 'tree') > 0
+                or minetest.get_item_group(node.name, 'leaves') > 0
+            then
+                local tool_capabilities = wield_stack:get_tool_capabilities()
+                local stack = ItemStack(itemstring)
+                local chance = math.random(1, tool_capabilities.max_drop_level)
+
+                stack:set_count(stack:get_count() * chance)
+
+                if stack:get_count() > 0 then
+                    table.insert(new_drops, stack)
+                end
+            end
+        end
+
+        if #new_drops > 0 then
+            return old_handle_node_drops(pos, new_drops, digger)
+        end
+
         return old_handle_node_drops(pos, drops, digger)
     end
 
-    local node = minetest.get_node(pos)
+    -- Silk Touch
+    local silk_touch = wield_stack_meta:get_float('is_silk_touch')
 
-    if minetest.get_item_group(node.name, 'no_silktouch') == 1 then
-        return old_handle_node_drops(pos, drops, digger)
+    if silk_touch > 0
+        and minetest.get_item_group(node.name, 'no_silktouch') == 0
+    then
+        -- drop raw item/node
+        return old_handle_node_drops(pos, { ItemStack(node.name) }, digger)
     end
 
-    -- drop raw item/node
-    return old_handle_node_drops(pos, { ItemStack(node.name) }, digger)
+    return old_handle_node_drops(pos, drops, digger)
 end
 
+---@diagnostic disable-next-line: unused-local
 minetest.register_on_player_hpchange(function(player, hp_change, reason)
+    -- Curse of Vanishing
     if (player:get_hp() + hp_change) <= 0 then
         -- Going to die
         local player_inv = player:get_inventory() --[[@as InvRef]]
-
-        -- Curse of Vanishing
         local player_inventory_lists = { 'main', 'craft' }
 
         for _, list_name in ipairs(player_inventory_lists) do
@@ -72,8 +272,6 @@ minetest.register_on_player_hpchange(function(player, hp_change, reason)
                         player_inv:set_stack(list_name, i, ItemStack(''))
                     end
                 end
-
-                player_inv:set_list(list_name, {})
             end
         end
     end

locale/template.txt

@@ -1,14 +1,17 @@
 # textdomain: x_enchanting
 Sharpness=
+Looting=
 Fortune=
 Unbreaking=
 Efficiency=
 Silk Touch=
 Curse of Vanishing=
 Knockback=
+Power=
+Punch=
+Infinity=
 Enchanted=
 Enchant=
-level=
 Enchanting Table=
 owned by=
 Scroll of Enchantments=

locale/x_enchanting.sk.tr

@@ -1,14 +1,17 @@
 # textdomain: x_enchanting
 Sharpness=Ostrosť
+Looting=
 Fortune=Šťastie
 Unbreaking=Nelámavosť
 Efficiency=Výkonnosť
 Silk Touch=Hodvábny dotyk
 Curse of Vanishing=Kliatba zmiznutia
 Knockback=Spätný úder
+Power=
+Punch=
+Infinity=
 Enchanted=Očarený
 Enchant=Očarovať
-level=level
 Enchanting Table=Čarovný stôl
 owned by=vlastník
 Scroll of Enchantments=Čarovný Zvitok

mod.conf

@@ -1,6 +1,6 @@
 name = x_enchanting
 description = Adds Enchanting Mechanics and API.
 depends =
-optional_depends = xdecor
+optional_depends = xdecor, item_drop
 supported_games = minetest_game
 min_minetest_version = 5.4

scripts/deploy.js

@@ -1,3 +1,21 @@
+/**
+ * Deploy code to CDB
+ * Copyright (C) 2023 SaKeL <juraj.vajda@gmail.com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to juraj.vajda@gmail.com
+ */
+
 import fetch from 'node-fetch'
 import yargs from 'yargs/yargs'
 import {hideBin} from 'yargs/helpers'

scripts/lls-check.js

@@ -1,3 +1,21 @@
+/**
+ * Run LUA diagnostics in continuous integration
+ * Copyright (C) 2023 SaKeL <juraj.vajda@gmail.com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to juraj.vajda@gmail.com
+ */
+
 import * as path from 'node:path'
 import * as fs from 'node:fs'
 import {exec} from 'node:child_process'

table.lua

@@ -1,3 +1,22 @@
+--[[
+    X Enchanting. Adds Enchanting Mechanics and API.
+    Copyright (C) 2023 SaKeL <juraj.vajda@gmail.com>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to juraj.vajda@gmail.com
+--]]
+
+---@diagnostic disable-next-line
 screwdriver = minetest.global_exists('screwdriver') and screwdriver --[[@as MtgScrewdriver]]
 
 local S = minetest.get_translator(minetest.get_current_modname())
@@ -12,6 +31,7 @@ minetest.register_node('x_enchanting:table', {
     drawtype = 'mesh',
     mesh = 'x_enchanting_table.obj',
     tiles = { 'x_enchanting_table.png' },
+    use_texture_alpha = 'clip',
     paramtype = 'light',
     paramtype2 = 'facedir',
     walkable = true,
@@ -59,6 +79,7 @@ minetest.register_node('x_enchanting:table', {
     ---@param placer ObjectRef | nil
     ---@param itemstack ItemStack
     ---@param pointed_thing PointedThingDef
+    ---@diagnostic disable-next-line: unused-local
     after_place_node = function(pos, placer, itemstack, pointed_thing)
         local meta = minetest.get_meta(pos)
 
@@ -79,6 +100,7 @@ minetest.register_node('x_enchanting:table', {
     ---@param clicker ObjectRef
     ---@param itemstack ItemStack
     ---@param pointed_thing? PointedThingDef
+    ---@diagnostic disable-next-line: unused-local
     on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
         local meta = minetest.get_meta(pos)
         local p_name = clicker:get_player_name()
@@ -107,7 +129,7 @@ minetest.register_node('x_enchanting:table', {
             local data = XEnchanting:get_enchantment_data(
                 clicker,
                 #bookshelfs,
-                minetest.registered_tools[item_stack:get_name()]
+                minetest.registered_tools[item_stack:get_name()] or minetest.registered_craftitems[item_stack:get_name()]
             )
             local formspec = XEnchanting:get_formspec(pos, p_name, data)
 
@@ -123,6 +145,7 @@ minetest.register_node('x_enchanting:table', {
     ---@param pos Vector
     ---@param intensity? number
     ---@return table | nil
+    ---@diagnostic disable-next-line: unused-local
     on_blast = function(pos, intensity)
         if minetest.is_protected(pos, '') then
             return
@@ -159,11 +182,13 @@ minetest.register_node('x_enchanting:table', {
             and inv:is_empty('trade')
             and not minetest.is_protected(pos, player:get_player_name())
     end,
+    ---@diagnostic disable-next-line: unused-local
     on_rotate = function(pos, node, user, mode, new_param2)
         return false
     end,
     ---@param pos Vector
     ---@param elapsed number
+    ---@diagnostic disable-next-line: unused-local
     on_timer = function(pos, elapsed)
         -- entity
         local table_scroll = minetest.get_objects_inside_radius(pos, 0.9)
@@ -234,6 +259,7 @@ minetest.register_node('x_enchanting:table', {
         end
 
         -- symbol particles
+        ---@diagnostic disable-next-line: unused-local
         for i = 1, 10, 1 do
             local pos_random = bookshelfs[math.random(1, #bookshelfs)]
             local x = pos.x - pos_random.x
@@ -275,6 +301,7 @@ minetest.register_node('x_enchanting:table', {
     ---@param index number
     ---@param stack ItemStack
     ---@param player ObjectRef
+    ---@diagnostic disable-next-line: unused-local
     allow_metadata_inventory_put = function(pos, listname, index, stack, player)
         local st_meta = stack:get_meta()
         local st_name = stack:get_name()
@@ -302,6 +329,7 @@ minetest.register_node('x_enchanting:table', {
     ---@param index number
     ---@param stack ItemStack
     ---@param player ObjectRef
+    ---@diagnostic disable-next-line: unused-local
     allow_metadata_inventory_take = function(pos, listname, index, stack, player)
         local st_name = stack:get_name()
 
@@ -325,6 +353,7 @@ minetest.register_node('x_enchanting:table', {
     ---@param to_index number
     ---@param count number
     ---@param player ObjectRef
+    ---@diagnostic disable-next-line: unused-local
     allow_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player)
         return 0
     end,
@@ -333,12 +362,16 @@ minetest.register_node('x_enchanting:table', {
     ---@param index number
     ---@param stack ItemStack
     ---@param player ObjectRef
+    ---@diagnostic disable-next-line: unused-local
     on_metadata_inventory_put = function(pos, listname, index, stack, player)
         local meta = minetest.get_meta(pos)
         local p_name = player:get_player_name()
         local inv = meta:get_inventory()
+        local item_stack = inv:get_stack('item', 1)
+        local item_stack_meta = item_stack:get_meta()
+        local is_enchanted = item_stack_meta:get_int('is_enchanted')
 
-        if not inv:is_empty('item') then
+        if not inv:is_empty('item') and is_enchanted == 0 then
             -- bookshelfs
             local bookshelfs = minetest.find_nodes_in_area(
                 { x = pos.x - 2, y = pos.y, z = pos.z - 2 },
@@ -346,11 +379,10 @@ minetest.register_node('x_enchanting:table', {
                 { 'default:bookshelf', 'group:bookshelf' }
             )
 
-            local item_stack = inv:get_stack('item', 1)
             local data = XEnchanting:get_enchantment_data(
                 player,
                 #bookshelfs,
-                minetest.registered_tools[item_stack:get_name()]
+                minetest.registered_tools[item_stack:get_name()] or minetest.registered_craftitems[item_stack:get_name()]
             )
             local formspec = XEnchanting:get_formspec(pos, p_name, data)
 
@@ -366,12 +398,16 @@ minetest.register_node('x_enchanting:table', {
     ---@param index number
     ---@param stack ItemStack
     ---@param player ObjectRef
+    ---@diagnostic disable-next-line: unused-local
     on_metadata_inventory_take = function(pos, listname, index, stack, player)
         local meta = minetest.get_meta(pos)
         local p_name = player:get_player_name()
         local inv = meta:get_inventory()
+        local item_stack = inv:get_stack('item', 1)
+        local item_stack_meta = item_stack:get_meta()
+        local is_enchanted = item_stack_meta:get_int('is_enchanted')
 
-        if not inv:is_empty('item') then
+        if not inv:is_empty('item') and is_enchanted == 0 then
             -- bookshelfs
             local bookshelfs = minetest.find_nodes_in_area(
                 { x = pos.x - 2, y = pos.y, z = pos.z - 2 },
@@ -379,11 +415,10 @@ minetest.register_node('x_enchanting:table', {
                 { 'default:bookshelf', 'group:bookshelf' }
             )
 
-            local item_stack = inv:get_stack('item', 1)
             local data = XEnchanting:get_enchantment_data(
                 player,
                 #bookshelfs,
-                minetest.registered_tools[item_stack:get_name()]
+                minetest.registered_tools[item_stack:get_name()] or minetest.registered_craftitems[item_stack:get_name()]
             )
             local formspec = XEnchanting:get_formspec(pos, p_name, data)
 
@@ -399,6 +434,7 @@ minetest.register_node('x_enchanting:table', {
     ---@param formname string
     ---@param fields table
     ---@param sender ObjectRef
+    ---@diagnostic disable-next-line: unused-local
     on_receive_fields = function(pos, formname, fields, sender)
         local p_name = sender:get_player_name()
 
@@ -451,7 +487,7 @@ minetest.register_node('x_enchanting:table', {
 })
 
 ----
---- Entity (Scroll)
+--- Entity - Scroll
 ----
 
 minetest.register_entity('x_enchanting:table_scroll', {
@@ -477,12 +513,14 @@ minetest.register_entity('x_enchanting:table_scroll', {
     },
     ---@param self table
     ---@param killer ObjectRef
+    ---@diagnostic disable-next-line: unused-local
     on_death = function(self, killer)
         self.object:remove()
     end,
     ---@param self table
     ---@param staticdata StringAbstract
     ---@param dtime_s number
+    ---@diagnostic disable-next-line: unused-local
     on_activate = function(self, staticdata, dtime_s)
         self._scroll_closed = true
         self._tablechecktimer = 5
@@ -496,6 +534,7 @@ minetest.register_entity('x_enchanting:table_scroll', {
     ---@param self table
     ---@param dtime number
     ---@param moveresult? table
+    ---@diagnostic disable-next-line: unused-local
     on_step = function(self, dtime, moveresult)
         local pos = self.object:get_pos()
 
@@ -524,6 +563,7 @@ minetest.register_entity('x_enchanting:table_scroll', {
             local found_player = false
 
             if #objects > 0 then
+                ---@diagnostic disable-next-line: unused-local
                 for i, obj in ipairs(objects) do
                     if obj:is_player() and obj:get_pos() then
                         -- player
@@ -531,6 +571,7 @@ minetest.register_entity('x_enchanting:table_scroll', {
                         local distance = vector.distance(pos, obj:get_pos())
 
                         if distance < shortest_distance then
+                            shortest_distance = distance
                             self._player = obj
                         end
                     end
@@ -584,6 +625,7 @@ minetest.register_entity('x_enchanting:table_scroll', {
     ---@param dir Vector
     ---@param damage number
     ---@return boolean | nil
+    ---@diagnostic disable-next-line: unused-local
     on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir, damage)
         return true
     end

types/entity.type.lua

@@ -14,3 +14,4 @@
 ---@field on_detach_child fun(self: table, child: ObjectRef): nil Function receive a "luaentity" table as `self`. `child`: an `ObjectRef` of the child that detaches
 ---@field on_detach fun(self: table, parent: ObjectRef|nil): nil Function receive a "luaentity" table as `self`. `parent`: an `ObjectRef` (can be `nil`) from where it got detached. This happens before the parent object is removed from the world.
 ---@field get_staticdata fun(self: table) Function receive a "luaentity" table as `self`. Should return a string that will be passed to `on_activate` when the object is instantiated the next time.
+---@field drops table Custom for mob drops

types/minetest.type.lua

@@ -15,6 +15,8 @@
 ---@field add_entity fun(pos: Vector, name: string, staticdata?: string): ObjectRef|nil  Spawn Lua-defined entity at position. Returns `ObjectRef`, or `nil` if failed.
 ---@field get_node fun(pos: Vector): NodeDef Returns the node at the given position as table in the format `{name="node_name", param1=0, param2=0}`, returns `{name="ignore", param1=0, param2=0}` for unloaded areas.
 ---@field registered_nodes table<string, NodeDef|ItemDef> Map of registered node definitions, indexed by name
+---@field registered_ores table<string, table> Map of registered ore definitions, indexed by name
+---@field registered_craftitems table<string, table> Map of registered craft items, indexed by name
 ---@field after fun(time: number|integer, func: fun(...), ...): JobTable Call the function `func` after `time` seconds, may be fractional. Optional: Variable number of arguments that are passed to `func`.
 ---@field sound_play fun(spec: SimpleSoundSpec|string, parameters: SoundParamDef, ephemeral?: boolean): any Returns a `handle`. Ephemeral sounds will not return a handle and can't be stopped or faded. It is recommend to use this for short sounds that happen in response to player actions (e.g. door closing).
 ---@field add_particlespawner fun(particlespawner_definition: ParticlespawnerDef): number|integer Add a `ParticleSpawner`, an object that spawns an amount of particles over `time` seconds. Returns an `id`, and -1 if adding didn't succeed.
@@ -87,11 +89,13 @@
 ---@field place_node fun(pos: Vector, node: SetNodeTable): nil Place node with the same effects that a player would cause
 ---@field add_particle fun(def: ParticleDef): nil
 ---@field registered_tools table<string, ItemDef> Map of registered tool definitions, indexed by name
----@field registered_entities table<string, ObjectRef> Map of registered entity definitions, indexed by name
+---@field registered_entities table<string, EntityDef> Map of registered entity definitions, indexed by name
 ---@field has_feature fun(args: table<string, boolean> | string): boolean | table returns `boolean, missing_features`, `arg`: string or table in format `{foo=true, bar=true}`, `missing_features`: `{foo=true, bar=true}`
 ---@field handle_node_drops fun(pos: Vector, drops: string[], digger: ObjectRef) `drops`: list of itemstrings. Handles drops from nodes after digging: Default action is to put them into digger's inventory. Can be overridden to get different functionality (e.g. dropping items on ground)
 ---@field register_on_dieplayer fun(func: fun(player: ObjectRef, reason?: string)): nil Called when a player dies. `reason`: a PlayerHPChangeReason table, see register_on_player_hpchange
 ---@field register_on_player_hpchange fun(func: fun(player, hp_change, reason), modifier): number Called when the player gets damaged or healed. `player`: ObjectRef of the player. `hp_change`: the amount of change. Negative when it is damage.. `reason`: a PlayerHPChangeReason table.. The `type` field will have one of the following values: `set_hp`: A mod or the engine called `set_hp` without giving a type - use this for custom damage types.. `punch`: Was punched. `reason.object` will hold the puncher, or nil if none. `fall`, `node_damage`: `damage_per_second` from a neighbouring node. `reason.node` will hold the node name or nil. `drown` `respawn`. Any of the above types may have additional fields from mods. `reason.from` will be `mod` or `engine`. `modifier`: when true, the function should return the actual `hp_change`. Note: modifiers only get a temporary `hp_change` that can be modified by later modifiers. Modifiers can return true as a second argument to stop the execution of further functions. Non-modifiers receive the final HP change calculated by the modifiers.
+---@field itemstring_with_palette fun(item: string | ItemStack, palette_index: integer): string returns an item string. Creates an item string which contains palette index information for hardware colorization. You can use the returned string as an output in a craft recipe. `item`: the item stack which becomes colored. Can be in string, table and native form. `palette_index`: this index is added to the item stack
+---@field get_player_information fun(player_name: string): table Table containing information about a player
 
 ---Minetest settings
 ---@class MinetestSettings

types/mtg-farming.type.lua

@@ -5,6 +5,8 @@
 ---@class MtgFarming
 ---@field hoe_on_use fun(itemstack: ItemStack, user: ObjectRef, pointed_thing: PointedThingDef, uses: number): ItemStack | nil
 ---@field place_seed fun(itemstack: ItemStack, placer: ObjectRef, pointed_thing: PointedThingDef, plantname: string): ItemStack Seed placement
+---@field grow_plant fun(pos: Vector, elapsed: number): nil
+---@field register_plant fun(name: string, def: table): nil
 
 ----Node definition. Used by `minetest.register_node`.
 ---@class NodeDefMtgFarming

types/node.type.lua

@@ -20,6 +20,7 @@
 ---@field walkable boolean If true, objects collide with node.
 ---@field after_dig_node fun(pos: Vector, oldnode: NodeDef, oldmetadata: table, digger: ObjectRef): nil  oldmetadata is in table format. Called after destructing node when node was dug using minetest.node_dig / minetest.dig_node., default: nil
 ---@field paramtype2 string
+---@field palette string Image
 ---@field can_dig fun(pos: Vector, player?: ObjectRef): boolean | nil Returns true if node can be dug, or false if not.default: nil
 ---@field on_rotate fun(pos: Vector, node: table, user: ObjectRef, mode: table, new_param2: string): boolean Only for screwdriver mod.
 ---@field on_construct fun(pos: Vector): nil Node constructor; called after adding node. Can set up metadata and stuff like that. Not called for bulk node placement (i.e. schematics and VoxelManip). default: nil
@@ -27,6 +28,7 @@
 ---@field on_destruct fun(pos: Vector) Node destructor; called before removing node. Not called for bulk node placement. default: nil
 ---@field on_blast fun(pos: Vector, intensity?: number): nil intensity: 1.0 = mid range of regular TNT. If defined, called when an explosion touches the node, instead of removing the node.
 ---@field on_timer fun(pos: Vector, elapsed: number): boolean | nil default: nil, called by NodeTimers, see minetest.get_node_timer and NodeTimerRef. elapsed is the total time passed since the timer was started. return true to run the timer for another cycle with the same timeout value.
+---@field _next_state string Only for x_farming composter
 
 ---Textures of node; +Y, -Y, +X, -X, +Z, -Z. List can be shortened to needed length.
 ---@class NodeTilesDef

types/object.type.lua

@@ -45,6 +45,7 @@
 ---@field get_rotation fun(self: ObjectRef): Vector returns the rotation, a vector (radians)
 ---@field get_attach fun(self: ObjectRef): any Returns parent, bone, position, rotation, forced_visible, or nil if it isn't attached.
 ---@field set_attach fun(self: ObjectRef, parent: ObjectRef, bone?: string, position?: Vector, rotation?: Vector, forced_visible?: boolean): any Returns parent, bone, position, rotation, forced_visible, or nil if it isn't attached.
+---@field drops table Custom for mob drops
 
 ---`ObjectRef` armor groups
 ---@class ObjectRefArmorGroups

types/table.type.lua

@@ -6,3 +6,4 @@
 ---Table helpers
 ---@class TableAbstract
 ---@field copy fun(table: table): table returns a deep copy of `table`
+---@field indexof fun(list: table, value: any): number returns the smallest numerical index containing the value `val` in the table `list`. Non-numerical indices are ignored. If `val` could not be found, `-1` is returned. `list` must not have negative indices.

types/unified_inventory.type.lua

@@ -1,8 +0,0 @@
----@diagnostic disable: codestyle-check
----Base class Unified Inventory
----@class UnifiedInventory
----@field set_inventory_formspec fun(player: ObjectRef, formspecname: string): nil
----@field register_button fun(name: string, def: table): nil
----@field single_slot fun(x: number, y: number): nil
----@field register_page fun(name: string, def: table): nil
----@field style_full table

types/xenchanting.type.lua

@@ -6,7 +6,7 @@
 ---@field roman_numbers table<number, string>  Convert Arabic numbers to Roman numbers
 ---@field enchantment_defs table<'sharpness' | 'fortune' | 'unbreaking' | 'efficiency' | 'silk_touch' | 'curse_of_vanishing' | 'knockback', EnchantmentDef>
 ---@field has_tool_group fun(self: XEnchanting, name: string): string | boolean Check if tool has one of the known tool groups, returns `false` otherwise.
----@field set_tool_enchantability fun(self: XEnchanting, tool_def: ItemDef): nil Sets `enchantibility` group and values from base table (`XEnchanting.tools_enchantability`) to all registered tools (atching known group names). If tool has already `enchantibility` group defined it will take the defined value insted.
+---@field set_enchantability fun(self: XEnchanting, tool_def: ItemDef): nil Sets `enchantibility` group and values from base table (`XEnchanting.tools_enchantability`) to all registered tools (atching known group names). If tool has already `enchantibility` group defined it will take the defined value insted.
 ---@field get_enchanted_tool_capabilities fun(self: XEnchanting, tool_def: ItemDef, enchantments: Enchantment[]): ToolCapabilitiesDef Applies enchantments to item tool capabilities.
 ---@field set_enchanted_tool fun(self: XEnchanting, pos: Vector, itemstack: ItemStack, level: number, player_name: string): nil Set choosen enchantment and its modified tool capabilities to itemstack and `item` inventory. This will also get new `randomseed`.
 ---@field get_enchantment_data fun(self: XEnchanting, player: ObjectRef, nr_of_bookshelfs: number, tool_def: ItemDef): EnchantmentData Algoritm to get aplicable random enchantments.
@@ -14,6 +14,8 @@
 ---@field form_context table<string, FormContextDef> Additional form data for player.
 ---@field scroll_animations table<string, table> Parameters for `ObjectRef` `set_animation` method
 ---@field player_seeds table<string, number | integer>
+---@field registered_ores table<string, boolean> Table with registered ores, `key` ore name
+---@field settings {["x_enchanting_small_formspec"]: boolean}
 
 
 ---Enchantment definition
@@ -23,6 +25,8 @@
 ---@field level_def table<number, number> Level bonus. Value will be set in item meta as float.
 ---@field weight number Enchantment weight
 ---@field secondary boolean Will not appear in masked description and can be applied only as additional enchantment by probability chance.
+---@field groups string[] | nil List of groups for items what are compatible with this enchantment. If `nil` then all groups are compatible.
+---@field incompatible string[] | nil List of incompatible enchantments
 
 
 ---Form context
@@ -36,14 +40,15 @@
 
 
 ---@class Enchantment
----@field id string
----@field value number
----@field level number
----@field secondary boolean Will not appear in masked description and can be applied only as additional enchantment by probability chance.
+---@field id string Unique ID of the enchantment
+---@field value number Value of the enchantment based on level
+---@field level number Level of the enchantment
+---@field secondary boolean | nil Will not appear in masked description and can be applied only as additional enchantment by probability chance.
+---@field incompatible string[] | nil List of incompatible enchantments
 
 
 ---@class EnchantmentDataSlot
 ---@field level number
 ---@field final_enchantments Enchantment[]
----@field tool_cap_data ToolCapabilitiesDef
+---@field tool_cap_data ToolCapabilitiesDef | nil
 ---@field descriptions {["enchantments_desc"]: string, ["enchantments_desc_masked"]: string }

writing_table.lua

@@ -0,0 +1,329 @@
+screwdriver = minetest.global_exists('screwdriver') and screwdriver --[[@as MtgScrewdriver]]
+
+local S = minetest.get_translator(minetest.get_current_modname())
+
+----
+--- Table Node
+----
+
+minetest.register_node('x_enchanting:writing_table', {
+    description = S('Writing Table'),
+    short_description = S('Writing Table'),
+    ---top, bottom, sides...front
+    tiles = {
+        'x_enchanting_writing_table_top.png',
+        'x_enchanting_writing_table_bottom.png',
+        'x_enchanting_writing_table_side.png',
+        'x_enchanting_writing_table_side.png',
+        'x_enchanting_writing_table_side.png',
+        'x_enchanting_writing_table_front.png'
+    },
+    paramtype = 'light',
+    paramtype2 = 'facedir',
+    walkable = true,
+    wield_scale = { x = 2, y = 2, z = 2 },
+    sounds = {
+        footstep = {
+            name = 'x_enchanting_scroll',
+            gain = 0.2
+        },
+        dug = {
+            name = 'x_enchanting_scroll',
+            gain = 1.0
+        },
+        place = {
+            name = 'x_enchanting_scroll',
+            gain = 1.0
+        }
+    },
+    is_ground_content = false,
+    groups = { choppy = 2, oddly_breakable_by_hand = 2, flammable = 2 },
+    mod_origin = 'x_enchanting',
+    ---@param pos Vector
+    on_construct = function(pos)
+        local meta = minetest.get_meta(pos)
+        local inv = meta:get_inventory()
+
+        meta:set_string('infotext', S('Writing Table'))
+        meta:set_string('owner', '')
+        inv:set_size('item', 1)
+        inv:set_size('sacrifice', 1)
+        inv:set_size('result', 1)
+        inv:set_size('trade', 1)
+    end,
+    ---@param pos Vector
+    ---@param placer ObjectRef | nil
+    ---@param itemstack ItemStack
+    ---@param pointed_thing PointedThingDef
+    after_place_node = function(pos, placer, itemstack, pointed_thing)
+        local meta = minetest.get_meta(pos)
+
+        if not placer then
+            return
+        end
+
+        local player_name = placer:get_player_name()
+
+        local props = {
+            player_name = player_name
+        }
+
+        meta:set_string('owner', player_name)
+        meta:set_string('infotext', S('Writing Table') .. ' (' .. S('owned by') .. ' ' .. player_name .. ')')
+
+        local formspec = XEnchanting:get_formspec_writing_table(pos, props)
+        meta:set_string('formspec', formspec)
+    end,
+    ---@param pos Vector
+    ---@param node NodeDef
+    ---@param clicker ObjectRef
+    ---@param itemstack ItemStack
+    ---@param pointed_thing? PointedThingDef
+    on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
+        local meta = minetest.get_meta(pos)
+        local inv = meta:get_inventory()
+        local p_name = clicker:get_player_name()
+        local props = {
+            player_name = p_name,
+            inv = inv
+        }
+
+        if minetest.is_protected(pos, p_name) then
+            return itemstack
+        end
+
+        minetest.sound_play('x_enchanting_scroll', {
+            gain = 0.3,
+            pos = pos,
+            max_hear_distance = 10
+        }, true)
+
+        local data = XEnchanting:get_writing_table_total_data(props)
+
+        props.data = data
+
+        local formspec = XEnchanting:get_formspec_writing_table(pos, props)
+        meta:set_string('formspec', formspec)
+
+        return itemstack
+    end,
+    ---@param pos Vector
+    ---@param intensity? number
+    ---@return table | nil
+    on_blast = function(pos, intensity)
+        if minetest.is_protected(pos, '') then
+            return
+        end
+
+        local drops = {}
+        local inv = minetest.get_meta(pos):get_inventory()
+        local stack_item = inv:get_stack('item', 1)
+        local stack_sacrifice = inv:get_stack('sacrifice', 1)
+        local stack_result = inv:get_stack('result', 1)
+        local stack_trade = inv:get_stack('trade', 1)
+
+        if not stack_item:is_empty() then
+            drops[#drops + 1] = stack_item:to_table()
+        end
+
+        if not stack_sacrifice:is_empty() then
+            drops[#drops + 1] = stack_sacrifice:to_table()
+        end
+
+        if not stack_result:is_empty() then
+            drops[#drops + 1] = stack_result:to_table()
+        end
+
+        if not stack_trade:is_empty() then
+            drops[#drops + 1] = stack_trade:to_table()
+        end
+
+        drops[#drops + 1] = 'x_enchanting:writing_table'
+        minetest.remove_node(pos)
+
+        return drops
+    end,
+    ---@param pos Vector
+    ---@param player? ObjectRef
+    can_dig = function(pos, player)
+        if not player then
+            return false
+        end
+
+        local inv = minetest.get_meta(pos):get_inventory()
+
+        return inv:is_empty('item')
+            and inv:is_empty('sacrifice')
+            and inv:is_empty('result')
+            and inv:is_empty('trade')
+            and not minetest.is_protected(pos, player:get_player_name())
+    end,
+    on_rotate = function(pos, node, user, mode, new_param2)
+        return false
+    end,
+    ---@param pos Vector
+    ---@param listname string
+    ---@param index number
+    ---@param stack ItemStack
+    ---@param player ObjectRef
+    allow_metadata_inventory_put = function(pos, listname, index, stack, player)
+        print('allow_metadata_inventory_put')
+        local st_name = stack:get_name()
+        local st_meta = stack:get_meta()
+
+        if listname == 'result' then
+            return 0
+        end
+
+        if listname == 'item'
+            and (st_meta:get_int('is_enchanted') > 0 or minetest.get_item_group(st_name, 'scroll') > 0)
+        then
+            return stack:get_count()
+        elseif listname == 'sacrifice'
+            and st_meta:get_int('is_enchanted') > 0
+            and minetest.get_item_group(st_name, 'scroll') > 0
+        then
+            return stack:get_count()
+        elseif listname == 'trade'
+            and (
+                st_name == 'default:mese_crystal'
+                or minetest.get_item_group(st_name, 'enchanting_trade') > 0
+            )
+        then
+            return stack:get_count()
+        end
+
+        return 0
+    end,
+    ---@param pos Vector
+    ---@param listname string
+    ---@param index number
+    ---@param stack ItemStack
+    ---@param player ObjectRef
+    allow_metadata_inventory_take = function(pos, listname, index, stack, player)
+        print('allow_metadata_inventory_take')
+        local st_name = stack:get_name()
+
+        if listname == 'item' then
+            return stack:get_count()
+        elseif listname == 'sacrifice' then
+            return stack:get_count()
+        elseif listname == 'result' then
+            return stack:get_count()
+        elseif listname == 'trade'
+            and (
+                st_name == 'default:mese_crystal'
+                or minetest.get_item_group(st_name, 'enchanting_trade') > 0
+            )
+        then
+            return stack:get_count()
+        end
+
+        return 0
+    end,
+    ---@param pos Vector
+    ---@param from_list string
+    ---@param from_index number
+    ---@param to_list string
+    ---@param to_index number
+    ---@param count number
+    ---@param player ObjectRef
+    allow_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player)
+        print('allow_metadata_inventory_move')
+        print('allow_metadata_inventory_move')
+        print('from_list', from_index, from_list)
+        print('to_list', to_index, to_list)
+
+        if (to_list == 'item' or to_list == 'sacrifice')
+            and (from_list == 'item' or from_list == 'sacrifice')
+        then
+            return count
+        end
+
+        return 0
+    end,
+    ---@param pos Vector
+    ---@param listname string
+    ---@param index number
+    ---@param stack ItemStack
+    ---@param player ObjectRef
+    on_metadata_inventory_put = function(pos, listname, index, stack, player)
+        print('on_metadata_inventory_put')
+        local meta = minetest.get_meta(pos)
+        local inv = meta:get_inventory()
+        local props = {
+            player_name = player:get_player_name(),
+            inv = inv
+        }
+
+        local data = XEnchanting:get_writing_table_total_data(props)
+
+        props.data = data
+
+        local formspec = XEnchanting:get_formspec_writing_table(pos, props)
+        meta:set_string('formspec', formspec)
+    end,
+    ---@param pos Vector
+    ---@param listname string
+    ---@param index number
+    ---@param stack ItemStack
+    ---@param player ObjectRef
+    on_metadata_inventory_take = function(pos, listname, index, stack, player)
+        print('on_metadata_inventory_take')
+        local meta = minetest.get_meta(pos)
+        local inv = meta:get_inventory()
+
+        if listname == 'result' then
+            inv:set_stack('item', 1, ItemStack(''))
+            inv:set_stack('sacrifice', 1, ItemStack(''))
+            inv:set_stack('result', 1, ItemStack(''))
+            return
+        end
+
+        local props = {
+            player_name = player:get_player_name(),
+            inv = inv
+        }
+
+        local data = XEnchanting:get_writing_table_total_data(props)
+
+        props.data = data
+
+        local formspec = XEnchanting:get_formspec_writing_table(pos, props)
+        meta:set_string('formspec', formspec)
+    end,
+    on_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player)
+        print('on_metadata_inventory_move')
+        local meta = minetest.get_meta(pos)
+        local inv = meta:get_inventory()
+        local props = {
+            player_name = player:get_player_name(),
+            inv = inv
+        }
+
+        local data = XEnchanting:get_writing_table_total_data(props)
+
+        props.data = data
+
+        local formspec = XEnchanting:get_formspec_writing_table(pos, props)
+        meta:set_string('formspec', formspec)
+    end,
+    -- form receive fields
+    ---@param pos Vector
+    ---@param formname string
+    ---@param fields table
+    ---@param sender ObjectRef
+    on_receive_fields = function(pos, formname, fields, sender)
+
+    end
+})
+
+-- Scroll Item
+minetest.register_craftitem('x_enchanting:scroll_item', {
+    description = S('Scroll'),
+    short_description = S('Scroll'),
+    inventory_image = 'x_enchanting_scroll_item.png^[colorize:#8F00FF:60',
+    wield_image = 'x_enchanting_scroll_item.png^[transformFXR90^[colorize:#8F00FF:60',
+    groups = { scroll = 1, flammable = 3 },
+    stack_max = 1
+})