init.lua

   1 -- Boilerplate to support localized strings if intllib mod is installed.
   2 local S
   3 if minetest.get_modpath("intllib") then
   4         S = intllib.Getter(minetest.get_current_modname())
   5 else
   6         S = function(s,a,...)a={a,...}return s:gsub("@(%d+)",function(n)return a[tonumber(n)]end)end
   7 end
   8
   9 local groupdefs = {
  10         ["book"] = S("Books"),
  11         ["vessel"] = S("Vessels"),
  12         ["dye"] = S("Dyes"),
  13         ["stick"] = S("Sticks"),
  14         ["wool"] = S("Wool"),
  15         ["sand"] = S("Sand"),
  16         ["wood"] = S("Wood"),
  17         ["stone"] = S("Stones"),
  18         ["metal"] = S("Metal"),
  19         ["tree"] = S("Tree Trunks"),
  20         ["fence"] = S("Fences"),
  21         ["wall"] = S("Walls"),
  22         ["leaves"] = S("Leaves and Needles"),
  23         ["flower"] = S("Flowers"),
  24         ["sapling"] = S("Saplings"),
  25         ["water"] = S("Water"),
  26         ["lava"] = S("Lava"),
  27         ["coal"] = S("Coal"),
  28         ["water_bucket"] = S("Water buckets"),
  29         ["flora"] = S("Flora"),
  30         ["snowy"] = S("Snowy"),
  31
  32         ["cracky"] = S("Cracky"),
  33         ["crumbly"] = S("Crumbly"),
  34         ["choppy"] = S("Choppy"),
  35         ["snappy"] = S("Snappy"),
  36         ["oddly_breakable_by_hand"] = S("Hand-breakable"),
  37
  38         ["fleshy"] = S("Flesh"),
  39 }
  40
  41 local miscgroups = {
  42         "book",  -- for placing in bookshelf
  43         "vessel", -- for placing in vessels shelf
  44         "sand", -- for cactus growth ABM
  45         "flora", -- for the plant spreading ABM
  46         "sapling", -- for the sapling growth ABM
  47         "water", -- for the obsidian and farming ABMs
  48 }
  49
  50 local forced_items = {
  51         "fire:basic_flame",
  52         "farming:wheat_8",
  53         "farming:cotton_8",
  54 }
  55
  56 local suppressed_items = {
  57         "default:water_flowing",
  58         "default:river_water_flowing",
  59         "default:lava_flowing",
  60         "default:dry_grass_2",
  61         "default:dry_grass_3",
  62         "default:dry_grass_4",
  63         "default:dry_grass_5",
  64         "default:grass_2",
  65         "default:grass_3",
  66         "default:grass_4",
  67         "default:grass_5",
  68         "default:furnace_active",
  69         "doors:door_wood",
  70         "doors:door_steel",
  71         "doors:door_glass",
  72         "doors:door_obsidian_glass",
  73         "doors:door_wood_a",
  74         "doors:door_steel_a",
  75         "doors:door_glass_a",
  76         "doors:door_obsidian_glass_a",
  77         "doors:door_wood_b",
  78         "doors:door_steel_b",
  79         "doors:door_glass_b",
  80         "doors:door_obsidian_glass_b",
  81         "doors:gate_wood_open",
  82         "doors:gate_junglewood_open",
  83         "doors:gate_acacia_wood_open",
  84         "doors:gate_aspen_wood_open",
  85         "doors:gate_pine_wood_open",
  86         "doors:trapdoor_steel_open",
  87         "doors:trapdoor_open",
  88         "doors:hidden",
  89         "xpanes:pane",
  90         "xpanes:bar",
  91         "default:chest_open",
  92         "default:chest_locked_open",
  93 }
  94
  95 local hidden_items = {
  96         "default:cloud",
  97         "default:dirt_with_grass_footsteps",
  98 }
  99
 100 local item_name_overrides = {
 101         ["screwdriver:screwdriver"] = S("Screwdriver"),
 102         ["map:mapping_kit"] = S("Mapping Kit"),
 103         ["binoculars:binoculars"] = S("Binoculars"),
 104         ["carts:cart"] = S("Cart"),
 105         ["fire:basic_flame"] = S("Basic Flame"),
 106         ["farming:wheat_8"] = S("Wheat Plant"),
 107         ["farming:cotton_8"] = S("Cotton Plant"),
 108         ["default:lava_source"] = S("Lava"),
 109         ["default:water_source"] = S("Water"),
 110         ["default:river_water_source"] = S("River Water"),
 111         ["doors:door_wood_a"] = minetest.registered_items["doors:door_wood"].description,
 112         ["doors:door_steel_a"] = minetest.registered_items["doors:door_steel"].description,
 113         ["doors:door_glass_a"] = minetest.registered_items["doors:door_glass"].description,
 114         ["doors:door_obsidian_glass_a"] = minetest.registered_items["doors:door_obsidian_glass"].description,
 115 }
 116
 117 local image_overrides = {
 118         ["doors:door_wood_a"] = minetest.registered_items["doors:door_wood"].inventory_image,
 119         ["doors:door_steel_a"] = minetest.registered_items["doors:door_steel"].inventory_image,
 120         ["doors:door_glass_a"] = minetest.registered_items["doors:door_glass"].inventory_image,
 121         ["doors:door_obsidian_glass_a"] = minetest.registered_items["doors:door_obsidian_glass"].inventory_image,
 122 }
 123
 124 doc.sub.items.add_friendly_group_names(groupdefs)
 125 doc.sub.items.add_notable_groups(miscgroups)
 126
 127 for i=1, #hidden_items do
 128         local item = minetest.registered_items[hidden_items[i]]
 129         if item then
 130                 minetest.override_item(hidden_items[i], { _doc_items_hidden = true } )
 131         end
 132 end
 133 for i=1, #forced_items do
 134         local item = minetest.registered_items[forced_items[i]]
 135         if item then
 136                 minetest.override_item(forced_items[i], { _doc_items_create_entry = true} )
 137         end
 138 end
 139 for i=1, #suppressed_items do
 140         local item = minetest.registered_items[suppressed_items[i]]
 141         if item then
 142                 minetest.override_item(suppressed_items[i], { _doc_items_create_entry = false} )
 143         end
 144 end
 145 for itemstring, data in pairs(item_name_overrides) do
 146         if minetest.registered_items[itemstring] ~= nil then
 147                 minetest.override_item(itemstring, { _doc_items_entry_name = data} )
 148         end
 149 end
 150 for itemstring, data in pairs(image_overrides) do
 151         if minetest.registered_items[itemstring] ~= nil then
 152                 minetest.override_item(itemstring, { _doc_items_image = data} )
 153         end
 154 end
 155
 156 -- Minetest Game Factoids
 157
 158 -- Lava cooling
 159 local function f_cools_lava(itemstring, def)
 160         if def.groups.cools_lava ~= nil or def.groups.water ~= nil then
 161                 return S("This block turns adjacent lava sources into obsidian and adjacent flowing lava into stone.")
 162         else
 163                 return ""
 164         end
 165 end
 166
 167 -- Groups flammable, puts_out_fire
 168 local function f_fire(itemstring, def)
 169         local s = ""
 170         -- Fire
 171         if def.groups.flammable ~= nil then
 172                 s = s .. S("This block is flammable.")
 173         end
 174
 175         if def.groups.puts_out_fire ~= nil then
 176                 if def.groups.flammable ~= nil then
 177                         s = s .. "\n"
 178                 end
 179                 s = s .. S("This block will extinguish nearby fire.")
 180         end
 181
 182         if def.groups.igniter ~= nil then
 183                 if def.groups.flammable ~= nil or def.groups.puts_out_fire ~= nil then
 184                         s = s .. "\n"
 185                 end
 186                 s = s .. S("This block will set flammable blocks within a radius of @1 on fire.", def.groups.igniter)
 187                 if def.walkable == false then
 188                         s = s .. S(" It also destroys flammable items which have been dropped inside.")
 189                 end
 190         end
 191         return s
 192 end
 193
 194 -- flora group
 195 local function f_flora(itemstring, def)
 196         if def.groups.flora == 1 then
 197                 local groupname = doc.sub.items.get_group_name("flora")
 198                 -- Dry shrub rule not complete; flora dies on group:sand except default:sand. But that's okay.
 199                 -- The missing nodes will be covered on their own entries by the f_and_dry_shrub factoid.
 200                 return S("This block belongs to the @1 group. It a living organism which likes to grow and spread on dirt with grass and similar “soil”-type blocks when it is in light. Spreading will stop when the surrounding area is too crammed with @2 blocks. On silver sand and desert sand, it will wither and die and turn into a dry shrub.", groupname, groupname)
 201         else
 202                 return ""
 203         end
 204 end
 205
 206 -- sand nodes which turn flora blocks into dry shrub (e.g. silver sand, desert sand)
 207 local function f_sand_dry_shrub(itemstring, def)
 208         if def.groups.sand == 1 and itemstring ~= "default:sand" then
 209
 210                 return S("Flowers and other blocks in the @1 group will slowly turn into dry shrubs when placed on this block.", doc.sub.items.get_group_name("flora"))
 211         else
 212                 return ""
 213         end
 214 end
 215
 216 -- soil group
 217 local function f_soil(itemstring, def)
 218         if def.groups.soil == 1 then
 219                 return S("This block serves as a soil for saplings and small plants. Blocks in the “@1” group will grow into trees. Blocks in the “@2” group will spread slowly.", doc.sub.items.get_group_name("sapling"), doc.sub.items.get_group_name("flora"))
 220         elseif def.groups.soil == 2 or def.groups.soil == 3 then
 221                 return S("This block serves as a soil for saplings and other small plants as well as plants grown from seeds. It supports their growth.")
 222         else
 223                 return ""
 224         end
 225 end
 226
 227 local function f_leafdecay(itemstring, def)
 228         local formstring = ""
 229         if def.groups.leafdecay ~= nil then
 230                 if def.groups.leafdecay_drop ~= nil then
 231                         formstring = S("This block may drop as an item when there is no trunk or stem of its species within a distance of @1. Leaf decay does not occour when the block has been manually placed by a player.", def.groups.leafdecay)
 232                 else
 233                         if def.drop ~= "" and def.drop ~= nil and def.drop ~= itemstring then
 234                                 formstring = S("This block quickly decays when there is no trunk or stem block of its species within a distance of @1. When decaying, it disappears and may drop one of its mining drops (but not itself). The block does not decay when the block has been placed by a player.", def.groups.leafdecay)
 235                         else
 236                                 formstring = S("This block quickly decays and disappears when there is no trunk or stem block of its species within a distance of @1. The block does not decay when the block has been placed by a player.", def.groups.leafdecay)
 237                         end
 238                 end
 239         end
 240         return formstring
 241 end
 242
 243 local function f_spreading_dirt_type(itemstring, def)
 244         if def.groups.spreading_dirt_type then
 245                 return S("Under sunlight, this block slowly spreads its dirt cover towards nearby dirt blocks. In the shadows, this block eventually loses its dirt cover and turns into plain dirt.")
 246         else
 247                 return ""
 248         end
 249 end
 250
 251 local function f_hoe_soil(itemstring, def)
 252         if def.soil then
 253                 local name, node
 254                 nodedef = minetest.registered_nodes[def.soil.dry]
 255                 if nodedef then
 256                         name = nodedef.description
 257                 end
 258                 if name then
 259                         return S("This block can be turned into @1 with a hoe.", name)
 260                 else
 261                         return S("This block can be cultivated by a hoe.")
 262                 end
 263         else
 264                 return ""
 265         end
 266 end
 267
 268 --[[ Node defines skeleton key and key callbacks which probably implies that
 269 it can be unlocked by keys ]]
 270 local function f_key(itemstring, def)
 271         if def.on_key_use and def.on_skeleton_key_use then
 272                 return S("This block is compatible with keys.")
 273         else
 274                 return ""
 275         end
 276 end
 277
 278 doc.sub.items.register_factoid("nodes", "use", f_key)
 279 doc.sub.items.register_factoid("nodes", "use", f_hoe_soil)
 280 doc.sub.items.register_factoid("nodes", "groups", f_cools_lava)
 281 doc.sub.items.register_factoid("nodes", "groups", f_fire)
 282 doc.sub.items.register_factoid("nodes", "groups", f_flora)
 283 doc.sub.items.register_factoid("nodes", "groups", f_sand_dry_shrub)
 284 doc.sub.items.register_factoid("nodes", "groups", f_leafdecay)
 285 doc.sub.items.register_factoid("nodes", "groups", f_soil)
 286 doc.sub.items.register_factoid("nodes", "groups", f_spreading_dirt_type)
 287
 288 -- Add node aliases
 289 for i=2,5 do
 290         doc.add_entry_alias("nodes", "default:grass_1", "nodes", "default:grass_"..i)
 291         doc.add_entry_alias("nodes", "default:dry_grass_1", "nodes", "default:dry_grass_"..i)
 292 end
 293 for i=1,7 do
 294         doc.add_entry_alias("nodes", "farming:wheat_8", "nodes", "farming:wheat_"..i)
 295         doc.add_entry_alias("nodes", "farming:cotton_8", "nodes", "farming:cotton_"..i)
 296 end
 297 doc.add_entry_alias("nodes", "default:lava_source", "nodes", "default:lava_flowing")
 298 doc.add_entry_alias("nodes", "default:water_source", "nodes", "default:water_flowing")
 299 doc.add_entry_alias("nodes", "default:river_water_source", "nodes", "default:river_water_flowing")
 300 doc.add_entry_alias("nodes", "default:furnace", "nodes", "default:furnace_active")
 301 doc.add_entry_alias("nodes", "default:torch", "nodes", "default:torch_wall")
 302 doc.add_entry_alias("nodes", "default:torch", "nodes", "default:torch_ceiling")
 303 doc.add_entry_alias("nodes", "doors:door_wood_fake", "craftitems", "doors:door_wood")
 304 doc.add_entry_alias("nodes", "doors:door_steel_fake", "craftitems", "doors:door_steel")
 305 doc.add_entry_alias("nodes", "doors:door_glass_fake", "craftitems", "doors:door_glass")
 306 doc.add_entry_alias("nodes", "doors:door_obsidian_glass_fake", "craftitems", "doors:door_obsidian_glass")
 307 doc.add_entry_alias("nodes", "doors:door_wood_fake", "nodes", "doors:door_wood_a")
 308 doc.add_entry_alias("nodes", "doors:door_steel_fake", "nodes", "doors:door_steel_a")
 309 doc.add_entry_alias("nodes", "doors:door_glass_fake", "nodes", "doors:door_glass_a")
 310 doc.add_entry_alias("nodes", "doors:door_obsidian_glass_fake", "nodes", "doors:door_obsidian_glass_a")
 311 doc.add_entry_alias("nodes", "doors:door_wood_fake", "nodes", "doors:door_wood_b")
 312 doc.add_entry_alias("nodes", "doors:door_steel_fake", "nodes", "doors:door_steel_b")
 313 doc.add_entry_alias("nodes", "doors:door_glass_fake", "nodes", "doors:door_glass_b")
 314 doc.add_entry_alias("nodes", "doors:door_obsidian_glass_fake", "nodes", "doors:door_obsidian_glass_b")
 315 doc.add_entry_alias("nodes", "doors:gate_wood_closed", "nodes", "doors:gate_wood_open")
 316 doc.add_entry_alias("nodes", "doors:gate_junglewood_closed", "nodes", "doors:gate_junglewood_open")
 317 doc.add_entry_alias("nodes", "doors:gate_acacia_wood_closed", "nodes", "doors:gate_acacia_wood_open")
 318 doc.add_entry_alias("nodes", "doors:gate_aspen_wood_closed", "nodes", "doors:gate_aspen_wood_open")
 319 doc.add_entry_alias("nodes", "doors:gate_pine_wood_closed", "nodes", "doors:gate_pine_wood_open")
 320 doc.add_entry_alias("nodes", "doors:trapdoor", "nodes", "doors:trapdoor_open")
 321 doc.add_entry_alias("nodes", "doors:trapdoor_steel", "nodes", "doors:trapdoor_steel_open")
 322 doc.add_entry_alias("nodes", "tnt:tnt", "nodes", "tnt:tnt_burning")
 323 doc.add_entry_alias("nodes", "tnt:gunpowder", "nodes", "tnt:gunpowder_burning")
 324 doc.add_entry_alias("nodes", "xpanes:pane_flat", "nodes", "xpanes:pane")
 325 doc.add_entry_alias("nodes", "xpanes:bar_flat", "nodes", "xpanes:bar")
 326 doc.add_entry_alias("nodes", "default:chest", "nodes", "default:chest_open")
 327 doc.add_entry_alias("nodes", "default:chest_locked", "nodes", "default:chest_locked_open")
 328
 329 -- Gather help texts
 330 dofile(minetest.get_modpath("doc_minetest_game") .. "/helptexts.lua")
 331
 332 -- Register boat object for doc_identifier
 333 if minetest.get_modpath("doc_identifier") ~= nil then
 334         doc.sub.identifier.register_object("boats:boat", "craftitems", "boats:boat")
 335         doc.sub.identifier.register_object("carts:cart", "craftitems", "carts:cart")
 336 end
 337
 338
 339 --[[ Completely create door entries from scratch. We suppressed all normal door entries
 340 before. This is quite a hack, but required because of the weird way how door items are
 341 implemented in Minetest Game.
 342 CHECKME: As doors are sensitive, check this entire section after each Minetest Game release.
 343 ]]
 344
 345 local doors = { "doors:door_wood", "doors:door_steel", "doors:door_glass", "doors:door_obsidian_glass" }
 346
 347 for d=1, #doors do
 348         local door = doors[d]
 349         local def1 = table.copy(minetest.registered_items[door])
 350         local def2 = table.copy(minetest.registered_items[door.."_a"])
 351
 352         def2._doc_items_image = def1.inventory_image
 353         def2.drop = nil
 354         def2.stack_max = def1.stack_max or minetest.nodedef_default.stack_max
 355         def2.liquidtype = "none"
 356         def2._doc_items_longdesc = def1._doc_items_longdesc
 357         def2._doc_items_usagehelp = def1._doc_items_usagehelp
 358
 359         doc.add_entry("nodes", door.."_fake", {
 360                 name = def2.description,
 361                 hidden = def2._doc_items_hidden == true,
 362                 data = {
 363                         itemstring = door,
 364                         longdesc = def2._doc_items_longdesc,
 365                         usagehelp = def2._doc_items_usagehelp,
 366                         def = def2
 367                 }
 368         })
 369 end
 370
 371 -- Remove the superficial “help” comment from screwdriver and cart description as redundant
 372 minetest.override_item("screwdriver:screwdriver", {description = item_name_overrides["screwdriver:screwdriver"]})
 373 minetest.override_item("carts:cart", {description = item_name_overrides["carts:cart"]})