mods/ITEMS/mcl_books/init.lua

   1 local S =minetest.get_translator("mcl_books")
   2
   3 local max_text_length = 4500 -- TODO: Increase to 12800 when scroll bar was added to written book
   4 local max_title_length = 64
   5
   6 local header = ""
   7 if minetest.get_modpath("mcl_init") then
   8         header = "no_prepend[]" .. mcl_vars.gui_nonbg .. mcl_vars.gui_bg_color ..
   9                 "style_type[button;border=false;bgimg=mcl_books_button9.png;bgimg_pressed=mcl_books_button9_pressed.png;bgimg_middle=2,2]"
  10 end
  11
  12 -- Book
  13 minetest.register_craftitem("mcl_books:book", {
  14         description = S("Book"),
  15         _doc_items_longdesc = S("Books are used to make bookshelves and book and quills."),
  16         inventory_image = "default_book.png",
  17         stack_max = 64,
  18         groups = { book=1, craftitem = 1 },
  19 })
  20
  21 if minetest.get_modpath("mcl_core") and minetest.get_modpath("mcl_mobitems") then
  22         minetest.register_craft({
  23                 type = 'shapeless',
  24                 output = 'mcl_books:book',
  25                 recipe = { 'mcl_core:paper', 'mcl_core:paper', 'mcl_core:paper', 'mcl_mobitems:leather', }
  26         })
  27 end
  28
  29 -- Get the included text out of the book item
  30 -- itemstack: Book item
  31 -- meta: Meta of book (optional)
  32 local get_text = function(itemstack)
  33         -- Grab the text
  34         local meta = itemstack:get_meta()
  35         local text = meta:get_string("text")
  36
  37         -- Backwards-compability with MCL2 0.21.0
  38         -- Remember that get_metadata is deprecated since MT 0.4.16!
  39         if text == nil or text == "" then
  40                 local meta_legacy = itemstack:get_metadata()
  41                 if itemstack:get_name() == "mcl_books:written_book" then
  42                         local des = minetest.deserialize(meta_legacy)
  43                         if des then
  44                                 text = des.text
  45                         end
  46                 else
  47                         text = meta_legacy
  48                 end
  49         end
  50
  51         -- Security check
  52         if not text then
  53                 text = ""
  54         end
  55         return text
  56 end
  57
  58 local make_description = function(title, author, generation)
  59         local desc
  60         if generation == 0 then
  61                 desc = S("“@1”", title)
  62         elseif generation == 1 then
  63                 desc = S("Copy of “@1”", title)
  64         elseif generation == 2 then
  65                 desc = S("Copy of Copy of “@1”", title)
  66         else
  67                 desc = S("Tattered Book")
  68         end
  69         desc = desc .. "\n" .. minetest.colorize("#AAAAAA", S("by @1", author))
  70         return desc
  71 end
  72
  73 local cap_text_length = function(text, max_length)
  74         return string.sub(text, 1, max_length)
  75 end
  76
  77 local write = function(itemstack, user, pointed_thing)
  78         -- Call on_rightclick if the pointed node defines it
  79         if pointed_thing.type == "node" then
  80                 local node = minetest.get_node(pointed_thing.under)
  81                 if user and not user:get_player_control().sneak then
  82                         if minetest.registered_nodes[node.name] and minetest.registered_nodes[node.name].on_rightclick then
  83                                 return minetest.registered_nodes[node.name].on_rightclick(pointed_thing.under, node, user, itemstack) or itemstack
  84                         end
  85                 end
  86         end
  87
  88         local text = get_text(itemstack)
  89         local formspec = "size[8,9]"..
  90                 header..
  91                 "background[-0.5,-0.5;9,10;mcl_books_book_bg.png]"..
  92                 "textarea[0.75,0.1;7.25,9;text;;"..minetest.formspec_escape(text).."]"..
  93                 "button[0.75,7.95;3,1;sign;"..minetest.formspec_escape(S("Sign")).."]"..
  94                 "button_exit[4.25,7.95;3,1;ok;"..minetest.formspec_escape(S("Done")).."]"
  95         minetest.show_formspec(user:get_player_name(), "mcl_books:writable_book", formspec)
  96 end
  97
  98 local read = function(itemstack, user, pointed_thing)
  99         -- Call on_rightclick if the pointed node defines it
 100         if pointed_thing.type == "node" then
 101                 local node = minetest.get_node(pointed_thing.under)
 102                 if user and not user:get_player_control().sneak then
 103                         if minetest.registered_nodes[node.name] and minetest.registered_nodes[node.name].on_rightclick then
 104                                 return minetest.registered_nodes[node.name].on_rightclick(pointed_thing.under, node, user, itemstack) or itemstack
 105                         end
 106                 end
 107         end
 108
 109         local text = get_text(itemstack)
 110         local formspec = "size[8,9]"..
 111                 header..
 112                 "background[-0.5,-0.5;9,10;mcl_books_book_bg.png]"..
 113                 "textarea[0.75,0.1;7.25,9;;"..minetest.formspec_escape(text)..";]"..
 114                 "button_exit[2.25,7.95;3,1;ok;"..minetest.formspec_escape(S("Done")).."]"
 115         minetest.show_formspec(user:get_player_name(), "mcl_books:written_book", formspec)
 116 end
 117
 118 -- Book and Quill
 119 minetest.register_craftitem("mcl_books:writable_book", {
 120         description = S("Book and Quill"),
 121         _tt_help = S("Write down some notes"),
 122         _doc_items_longdesc = S("This item can be used to write down some notes."),
 123         _doc_items_usagehelp = S("Hold it in the hand, then rightclick to read the current notes and edit then. You can edit the text as often as you like. You can also sign the book which turns it into a written book which you can stack, but it can't be edited anymore.").."\n"..
 124         S("A book can hold up to 4500 characters. The title length is limited to 64 characters."),
 125         inventory_image = "mcl_books_book_writable.png",
 126         groups = { book=1 },
 127         stack_max = 1,
 128         on_place = write,
 129         on_secondary_use = write,
 130 })
 131
 132 minetest.register_on_player_receive_fields(function ( player, formname, fields )
 133         if ((formname == "mcl_books:writable_book") and fields and fields.text) then
 134                 local stack = player:get_wielded_item()
 135                 if (stack:get_name() and (stack:get_name() == "mcl_books:writable_book")) then
 136                         local meta = stack:get_meta()
 137                         local text = cap_text_length(fields.text, max_text_length)
 138                         if fields.ok then
 139                                 meta:set_string("text", text)
 140                                 player:set_wielded_item(stack)
 141                         elseif fields.sign then
 142                                 meta:set_string("text", text)
 143                                 player:set_wielded_item(stack)
 144
 145                                 local name = player:get_player_name()
 146                                 local formspec = "size[8,9]"..
 147                                         header..
 148                                         "background[-0.5,-0.5;9,10;mcl_books_book_bg.png]"..
 149                                         "field[0.75,1;7.25,1;title;"..minetest.formspec_escape(minetest.colorize("#000000", S("Enter book title:")))..";]"..
 150                                         "label[0.75,1.5;"..minetest.formspec_escape(minetest.colorize("#404040", S("by @1", name))).."]"..
 151                                         "button_exit[0.75,7.95;3,1;sign;"..minetest.formspec_escape(S("Sign and Close")).."]"..
 152                                         "tooltip[sign;"..minetest.formspec_escape(S("Note: The book will no longer be editable after signing")).."]"..
 153                                         "button[4.25,7.95;3,1;cancel;"..minetest.formspec_escape(S("Cancel")).."]"
 154                                 minetest.show_formspec(player:get_player_name(), "mcl_books:signing", formspec)
 155                         end
 156                 end
 157         elseif ((formname == "mcl_books:signing") and fields and fields.sign and fields.title) then
 158                 local newbook = ItemStack("mcl_books:written_book")
 159                 local book = player:get_wielded_item()
 160                 local name = player:get_player_name()
 161                 if book:get_name() == "mcl_books:writable_book" then
 162                         local title = fields.title
 163                         if string.len(title) == 0 then
 164                                 title = S("Nameless Book")
 165                         end
 166                         title = cap_text_length(title, max_title_length)
 167                         local meta = newbook:get_meta()
 168                         local text = cap_text_length(get_text(book), max_text_length)
 169                         meta:set_string("title", title)
 170                         meta:set_string("author", name)
 171                         meta:set_string("text", text)
 172                         meta:set_string("description", make_description(title, name, 0))
 173
 174                         -- The book copy counter. 0 = original, 1 = copy of original, 2 = copy of copy of original, …
 175                         meta:set_int("generation", 0)
 176
 177                         player:set_wielded_item(newbook)
 178                 else
 179                         minetest.log("error", "[mcl_books] "..name.." failed to sign a book!")
 180                 end
 181         elseif ((formname == "mcl_books:signing") and fields and fields.cancel) then
 182                 local book = player:get_wielded_item()
 183                 if book:get_name() == "mcl_books:writable_book" then
 184                         write(book, player, { type = "nothing" })
 185                 end
 186         end
 187 end)
 188
 189 if minetest.get_modpath("mcl_dye") and minetest.get_modpath("mcl_mobitems") then
 190         minetest.register_craft({
 191                 type = "shapeless",
 192                 output = "mcl_books:writable_book",
 193                 recipe = { "mcl_books:book", "mcl_dye:black", "mcl_mobitems:feather" },
 194         })
 195 end
 196
 197 -- Written Book
 198 minetest.register_craftitem("mcl_books:written_book", {
 199         description = S("Written Book"),
 200         _doc_items_longdesc = S("Written books contain some text written by someone. They can be read and copied, but not edited."),
 201         _doc_items_usagehelp = S("Hold it in your hand, then rightclick to read the book.").."\n\n"..
 202
 203 S("To copy the text of the written book, place it into the crafting grid together with a book and quill (or multiple of those) and craft. The written book will not be consumed. Copies of copies can not be copied."),
 204         inventory_image = "mcl_books_book_written.png",
 205         groups = { not_in_creative_inventory=1, book=1, no_rename=1 },
 206         stack_max = 16,
 207         on_place = read,
 208         on_secondary_use = read
 209 })
 210
 211 -- Copy books
 212
 213 -- This adds 8 recipes
 214 local baq = "mcl_books:writable_book"
 215 local wb = "mcl_books:written_book"
 216 local recipes = {
 217         {wb, baq},
 218         {baq, baq, wb},
 219         {baq, baq, wb, baq},
 220         {baq, baq, baq, baq, wb},
 221         {baq, baq, baq, baq, wb, baq},
 222         {baq, baq, baq, baq, wb, baq, baq},
 223         {baq, baq, baq, baq, wb, baq, baq, baq},
 224         {baq, baq, baq, baq, wb, baq, baq, baq, baq},
 225 }
 226 for r=#recipes, 1, -1 do
 227         minetest.register_craft({
 228                 type = "shapeless",
 229                 output = "mcl_books:written_book "..r,
 230                 recipe = recipes[r],
 231         })
 232 end
 233
 234 minetest.register_craft_predict(function(itemstack, player, old_craft_grid, craft_inv)
 235         if itemstack:get_name() ~= "mcl_books:written_book" then
 236                 return
 237         end
 238
 239         local original
 240         local index
 241         for i = 1, player:get_inventory():get_size("craft") do
 242                 if old_craft_grid[i]:get_name() == "mcl_books:written_book" then
 243                         original = old_craft_grid[i]
 244                         index = i
 245                 end
 246         end
 247         if not original then
 248                 return
 249         end
 250
 251         local ometa = original:get_meta()
 252         local generation = ometa:get_int("generation")
 253
 254         -- Check generation, don't allow crafting with copy of copy of book
 255         if generation >= 2 then
 256                 return ItemStack("")
 257         else
 258                 -- Valid copy. Let's update the description field of the result item
 259                 -- so it is properly displayed in the crafting grid.
 260                 local imeta = itemstack:get_meta()
 261                 local title = cap_text_length(ometa:get_string("title"), max_title_length)
 262                 local author = ometa:get_string("author")
 263
 264                 -- Increase book generation and update description
 265                 generation = generation + 1
 266                 if generation < 1 then
 267                         generation = 1
 268                 end
 269
 270                 local desc = make_description(title, author, generation)
 271                 imeta:set_string("description", desc)
 272                 return itemstack
 273         end
 274 end)
 275
 276 minetest.register_on_craft(function(itemstack, player, old_craft_grid, craft_inv)
 277         if itemstack:get_name() ~= "mcl_books:written_book" then
 278                 return
 279         end
 280
 281         local original
 282         local index
 283         for i = 1, player:get_inventory():get_size("craft") do
 284                 if old_craft_grid[i]:get_name() == "mcl_books:written_book" then
 285                         original = old_craft_grid[i]
 286                         index = i
 287                 end
 288         end
 289         if not original then
 290                 return
 291         end
 292
 293         -- copy of the book
 294         local text = get_text(original)
 295         if not text or text == "" then
 296                 local copymeta = original:get_metadata()
 297                 itemstack:set_metadata(copymeta)
 298         else
 299                 local ometa = original:get_meta()
 300                 local generation = ometa:get_int("generation")
 301
 302                 -- No copy of copy of copy of book allowed
 303                 if generation >= 2 then
 304                         return ItemStack("")
 305                 end
 306
 307                 -- Copy metadata
 308                 local imeta = itemstack:get_meta()
 309                 local title = cap_text_length(ometa:get_string("title"), max_title_length)
 310                 local author = ometa:get_string("author")
 311                 imeta:set_string("title", title)
 312                 imeta:set_string("author", author)
 313                 imeta:set_string("text", cap_text_length(text, max_text_length))
 314
 315                 -- Increase book generation and update description
 316                 generation = generation + 1
 317                 if generation < 1 then
 318                         generation = 1
 319                 end
 320
 321                 local desc = make_description(title, author, generation)
 322
 323                 imeta:set_string("description", desc)
 324                 imeta:set_int("generation", generation)
 325         end
 326         -- put the book with metadata back in the craft grid
 327         craft_inv:set_stack("craft", index, original)
 328 end)
 329
 330 local wood_sound
 331 if minetest.get_modpath("mcl_sounds") then
 332         wood_sound = mcl_sounds.node_sound_wood_defaults()
 333 end
 334
 335 -- Bookshelf
 336 minetest.register_node("mcl_books:bookshelf", {
 337         description = S("Bookshelf"),
 338         _doc_items_longdesc = S("Bookshelves are used for decoration."),
 339         tiles = {"mcl_books_bookshelf_top.png", "mcl_books_bookshelf_top.png", "default_bookshelf.png"},
 340         stack_max = 64,
 341         is_ground_content = false,
 342         groups = {handy=1,axey=1, flammable=3,building_block=1, material_wood=1, fire_encouragement=30, fire_flammability=20},
 343         drop = "mcl_books:book 3",
 344         sounds = wood_sound,
 345         _mcl_blast_resistance = 1.5,
 346         _mcl_hardness = 1.5,
 347 })
 348
 349 minetest.register_craft({
 350         output = 'mcl_books:bookshelf',
 351         recipe = {
 352                 {'group:wood', 'group:wood', 'group:wood'},
 353                 {'mcl_books:book', 'mcl_books:book', 'mcl_books:book'},
 354                 {'group:wood', 'group:wood', 'group:wood'},
 355         }
 356 })
 357
 358 minetest.register_craft({
 359         type = "fuel",
 360         recipe = "mcl_books:bookshelf",
 361         burntime = 15,
 362 })
 363