commit b0ea21f0a08b867ee0388dc5ce2c3fd2ada9ffd5 Author: Noodlemire Date: Sun Aug 22 23:35:59 2021 -0500 Initial Commit diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..e9ab0b3 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,458 @@ + 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 + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +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 +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +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 + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +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 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +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. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +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 +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +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 +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +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 +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +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 +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +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 diff --git a/README.md b/README.md new file mode 100644 index 0000000..6ce300a --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +------------------------------------------------------------------------------------------------------------- +Tools Using the Node Damage and Repair System +[nd_tools] +------------------------------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------------------------------- +About +------------------------------------------------------------------------------------------------------------- +This is a mod that takes the node_damage API and applies it to every item in the game, effectively replacing the usual digging interactions. The actual digging times should be about the same, but you get long-lasting node damage, which must be manually repaired or replaced if something important (like a house wall) gets damaged. + +To help in repairing, you can make a variety of "mallets" with support from a wide variety of mods that add ores. Mallets work like any usual tool, except instead of breaking blocks, they repair them. However, mallets also need you to have glue in your inventory to work. This mod can either add its own glue or rely on Mesecon's glue if it exists, and each piece of glue allows to 9 repairs to be done. + +An api.txt file is provided if you wish to work with this system or make new mallets in your own mod. + +------------------------------------------------------------------------------------------------------------- +Dependencies and Support +------------------------------------------------------------------------------------------------------------- +Required mods: + node\_damage: https://content.minetest.net/packages/Noodlemire/node_damage/ + controls: https://github.com/mt-mods/controls (This fork is necessary for updated support) + +Optional mods: + cloud_items + default + ethereal + hardtrees + mesecons_materials + moreores + +------------------------------------------------------------------------------------------------------------- +License +------------------------------------------------------------------------------------------------------------- +The LGPL v2.1 License is used with this mod. See https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html or LICENSE.txt for more details. + +------------------------------------------------------------------------------------------------------------- +Installation +------------------------------------------------------------------------------------------------------------- +Download, unzip, and place within the usual minetest/current/mods folder, and it will behave in relation to the Minetest engine like any other mod. However, the first time its loaded, it won't do anything until the world is reloaded once. The reload is necessary so this mod can query all of the nodes that will exist in this world, which is necessary to automatically register cracked versions of them regardless of mod load order. This process will need repeating if any new mods are installed after this one. diff --git a/api.txt b/api.txt new file mode 100644 index 0000000..75564fe --- /dev/null +++ b/api.txt @@ -0,0 +1,35 @@ +Groups +------ + +nd_tools + --Provided automatically to items that use the nd_tools system. (Mallets don't count.) + +nd_tools_deny + --Any tool with this group will be excluded from the nd_tools system. + +nd_tools_glue + --Add this to an item's definition to make it usable by mallets. + --The exact value defines how many mallet uses will be provided before another item of glue is consumed. + --Also enables the item to be used to craft mallets. + + + +Regristration Functions +----------------------- + +nd_tools.register_mallet(name, durability, efficiency, hand_matl, head_matl) + --A shortcut function to register new mallets, as well as their crafting recipes. + --To provide a texture, provide a file named "(your mod name)_mallet_(lowercase name).png", e.g. "nd_tools_mallet_wood.png" + + --name: Provides the name and description of the item. + --Should be provided as a description, e.g. "Wood" + --Will automatically be suffixed with " Mallet" + --The itemstring will also be automatically created. Will be prefixed with "(current_modname):", turned lowercase, and spaces replaced by underscores. + + --durability: The amount of times this item can be used before breaking + + --efficiency: An optional multiplier to the amount of times this item can be used per consumption of glue. Defaults to 1 + + --hand_matl, head_matl: Optional; When provided, will be used to automatically create a crafting recipe. + --Hand Material is used for the handle of the tool + --Head Material is used for the head of the tool diff --git a/init.lua b/init.lua new file mode 100644 index 0000000..e9b7963 --- /dev/null +++ b/init.lua @@ -0,0 +1,400 @@ +--[[ +Tools Using the Node Damage and Repair System +Copyright (C) 2020 Noodlemire + +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 +--]] + +--Mod-specific global variable +nd_tools = {} + +--A table that keeps track of players who are currently digging a node. +local digging_node_info = {} + +--A table for keeping track of the exact times that objects were punched, for the "time_from_last_punch" variable. +local punch_times = {} + + + +--If possible, attempt to damage the node-type pointed_thing with the given item. +--Yes, the pointed_thing has to be a node. +local function damage_node(player, itemstack, pointed_thing) + --Get the pointed node and its definition right away. + local node = minetest.get_node(pointed_thing.under) + local def = minetest.registered_nodes[node.name] + + --Give up if an undefined node is targeted. + if not def then return end + + --Now that we know we have a definition, we can get the dig params according to the tool used. + local dig_params = minetest.get_dig_params(def.groups, itemstack:get_tool_capabilities()) + + --If the node was determined to be diggable... + if dig_params.diggable then + --Attempt to damage it. If it failed to be damaged after all, give up. + if not node_damage.damage(pointed_thing.under, node, player) then return end + --Refresh the itemstack to avoid an issue where, if you tried to dig a node using itself, the dug node would cease to exist. + itemstack = player:get_wielded_item() + + --Create an entry for this tool use, targeting the node and timed knowing that four hits total will destroy a node. + digging_node_info[player:get_player_name()] = {time = dig_params.time / 4, target = pointed_thing} + --Wear the tool at 1/4 the rate, since it takes four hits to destroy a node. + itemstack:add_wear(dig_params.wear / 4) + + --If the node was already at the 3rd damage stage... + if def.groups.node_damage == 3 then + --Play the dig sound + minetest.sound_play(def.sounds.dug, {gain = 1.0, pos = pointed_thing.under}, true) + else + --Otherwise, play the dig sound only as a default + local dig_sound = def.sounds.dig + + --Try to get a place sound if it exists + if not dig_sound or dig_sound == "__group" then + dig_sound = def.sounds.place + end + + --Play whichever sound was found, related to simply punching a node. + minetest.sound_play(dig_sound, {gain = 1.0, pos = pointed_thing.under}, true) + end + + --Finally, return the itemstack itself + return itemstack + end +end + + + +--Whenever a player leaves, their digging info is discarded. +minetest.register_on_leaveplayer(function(player) + digging_node_info[player:get_player_name()] = nil +end) + +--This function causes on_use to be called repeatedly whenever left mouse button is held. +controls.register_on_hold(function(player, control, time) + if control == "LMB" then + --Check the player's wielded item + local tool = player:get_wielded_item() + + --If the tool is not part of the nd_tools system... + if minetest.get_item_group(tool:get_name(), "nd_tools") <= 0 then + --If the player was previously digging something... + if digging_node_info[player:get_player_name()] then + --Stop digging by only deleting the stored target node info. This allows the dig time to still work when rapidly clicking. + digging_node_info[player:get_player_name()].target = nil + end + + --Either way, stop here. + return + end + + --Get the position of the player's eyes, to determine pointed_thing + local pos = player:get_pos() + pos.y = pos.y + player:get_properties().eye_height + --Get the tool's definition, to check its digparams and range + local def = tool:get_definition() + --Create a ray between the player's eyes and where they're looking, limited by their tool's range + local ray = Raycast(pos, vector.add(pos, vector.multiply(player:get_look_dir(), def.range or minetest.registered_items[""].range or 4))) + + --Store a pointed_thing based on the first walkable node found + local pointed_thing = nil + for pt in ray do + if pt.type == "node" then + pointed_thing = pt + break + end + end + + --If a pointed thing was found... + if pointed_thing then + --If the player was digging something before + if digging_node_info[player:get_player_name()] then + --Make them dig the new node instead + digging_node_info[player:get_player_name()].target = pointed_thing + else + --If there's no data at all, it means the timer ran out, so it's safe to also damage the node right away. + damage_node(player, tool, pointed_thing) + end + + --Ensure the definition and on_use exist + if def and def.on_use then + --Call on_use, and store what it returns + tool = def.on_use(tool, player, pointed_thing) + + --If on_use returned something, replace the player's wielded item with it. + if tool then + player:set_wielded_item(tool) + end + end + --Otherwise, if the player was digging something before, stop digging it. + elseif digging_node_info[player:get_player_name()] then + digging_node_info[player:get_player_name()].target = nil + end + end +end) + +--Upon release of left mouse button... +controls.register_on_release(function(player, control, held_time) + if control == "LMB" and digging_node_info[player:get_player_name()] then + --Stop digging by only deleting the stored target node info. This allows the dig time to still work when rapidly clicking. + digging_node_info[player:get_player_name()].target = nil + end +end) + +--During every globalstep, regardless of which button is held... +minetest.register_globalstep(function(dtime) + --For each player... + for _, player in pairs(minetest.get_connected_players()) do + --Store the name right away + local pname = player:get_player_name() + + --If they weren't digging anything, stop. + if not digging_node_info[pname] then + return + end + + --If there's still time left before the player can dig something, decrease that time and stop. + if digging_node_info[pname].time > 0 then + digging_node_info[pname].time = digging_node_info[pname].time - dtime + return + end + + --If the player isn't still trying to dig something, stop. + if not digging_node_info[pname].target then + return + end + + --If the player is trying to dig something... + if controls.players[pname].LMB then + --Finally damage whatever they are digging, and store the result + local item = damage_node(player, player:get_wielded_item(), digging_node_info[pname].target) + + --If there was a result, update the player's wielded item to it. + if item then + player:get_inventory():set_stack("main", player:get_wield_index(), item) + end + end + end +end) + +--Once all the mods have loaded... +minetest.register_on_mods_loaded(function() + --Look through every registered item + for name, def in pairs(minetest.registered_items) do + --If the item doesn't already have its own on_use function, and it isn't set to deny the nd_tools functionality... + if def.on_use == nil and minetest.get_item_group(name, "nd_tools_deny") == 0 then + --Get the def's groups and add nd_tools to it. + local groups = def.groups or {} + groups.nd_tools = 1 + + --Override the item to formally set the groups in... + minetest.override_item(name, { + groups = groups, + + --Give the item an on_use function + on_use = function(itemstack, user, pointed_thing) + --Look up the most recent on_use call if it exists, while storing the current time. + local old_time = punch_times[user:get_player_name()] or 0 + punch_times[user:get_player_name()] = os.clock() + + --If nothing is punched, give up. + if pointed_thing.type == "nothing" then + return itemstack + --If an object is punched, replicate the default punching behavior. + --The difference between old and current time is used to create the "time_from_last_punch" variable. + elseif pointed_thing.type == "object" then + local wear = pointed_thing.ref:punch(user, os.clock() - old_time, itemstack:get_tool_capabilities(), user:get_look_dir()) + + if not minetest.is_creative_enabled(user:get_player_name()) then + itemstack:add_wear(wear) + end + + return itemstack + end + + --Store the user's name + local pname = user:get_player_name() + + --If they were digging something before, update it to this new target. + if digging_node_info[pname] then + digging_node_info[pname].target = pointed_thing + end + + --Otherwise, as long as the player isn't on cooldown from their last damaged node... + if not (digging_node_info[pname] and digging_node_info[pname].time > 0) then + --Finally attempt to damage the node. + return damage_node(user, itemstack, pointed_thing) + end + end, + }) + end + end +end) + + + +--If a form of glue already exists because of the Mesecons mod... +if minetest.registered_items["mesecons_materials:glue"] then + --Add the needed group so mallets can use it + local groups = minetest.registered_items["mesecons_materials:glue"].groups + groups.nd_tools_glue = 9 + + --Override the item to formally set the group in place + minetest.override_item("mesecons_materials:glue", {groups = groups}) +else + --Otherwise, create our own + minetest.register_craftitem("nd_tools:glue", { + image = "nd_tools_glue.png", + description="Glue", + groups = {nd_tools_glue = 9} + }) + + --To create this variant of glue, simply cook any item in the "sapling" group. Should have fairly high compatability. + minetest.register_craft({ + type = "cooking", + output = "nd_tools:glue 2", + recipe = "group:sapling", + cooktime = 2 + }) +end + + + +--This is the function you can use to make a new mallet. +function nd_tools.register_mallet(name, durability, efficiency, hand_matl, head_matl) + --Convert the given description into a usable name format. It is turned to lowercase, and spaces are turned to underscores. + local n = name:lower():gsub(' ', '_') + --Also get the current modname for an automatic prefix. + local prefix = minetest.get_current_modname() + + --Register the new mallet with all of that in mind... + minetest.register_tool(prefix..":mallet_"..n, { + description = name.." Mallet", + + --All mallets to into the given group + groups = {nd_mallet = 1}, + + --Keep in mind how the naming works when making an inventory image. + inventory_image = prefix.."_mallet_"..n..".png", + + --Efficiency affects how many uses you can get out of each consumed glue. Higher is better. + efficiency = efficiency, + + --On left-click... + on_use = function(itemstack, user, pointed_thing) + --Get the user's inventory + local inv = user:get_inventory() + --Get the metadata to check the glue level + local meta = itemstack:get_meta() + local glue = meta:get_int("nd_tools:glue") + + --If more glue is needed... + if glue <= 0 then + --Iterate through only the user's main inventory + for i = 1, inv:get_size("main") do + --Get the current stack + local gluestack = inv:get_stack("main", i) + + --Check if it has the "nd_tools_glue" category, which any item can use if it should be able to fuel mallets. + if minetest.get_item_group(gluestack:get_name(), "nd_tools_glue") > 0 then + --Set the glue level and remove 1 piece of glue. + --The default glue level is equal to the number given to the group itself, multiplied by the mallet's efficiency. + glue = math.ceil(minetest.get_item_group(gluestack:get_name(), "nd_tools_glue") * (itemstack:get_definition().efficiency or 1)) + gluestack:take_item() + inv:set_stack("main", i, gluestack) + + --Once we found one piece of glue, we can stop the loop and keep going to the next part of the function. + break + end + end + end + + --If there is any glue on the hammer... + if glue > 0 then + --Get the pointed node and its definition + local node = minetest.get_node(pointed_thing.under) + local def = minetest.registered_nodes[node.name] + + --Check if it was capable of being repaired. If not, give up. + if not node_damage.repair(pointed_thing.under, node, player) then return end + + --Apply appropriate wear to the mallet + itemstack:add_wear(65535 / durability) + + --Decrease the glue level by 1 + glue = glue - 1 + meta:set_int("nd_tools:glue", glue) + + --Play a quieter sound, closer to a footstep than the louder breaking noise. + minetest.sound_play(def.sounds.footstep, {gain = 1.0, pos = pointed_thing.under}, true) + + return itemstack + else + --If there's still no glue, it's good to notify the player of the problem. + minetest.chat_send_player(user:get_player_name(), "You must have some kind of glue in your inventory to repair nodes with your mallet.") + end + end + }) + + --If crafting materials were provided, create a default recipe out of them and the glue group. + --You can choose not to provide materials for this, but if you don't, you're responsible for distributing the matter yourself. + if hand_matl and head_matl then + minetest.register_craft({ + output = prefix..":mallet_"..n, + recipe = { + {head_matl, "group:nd_tools_glue", head_matl}, + {"", hand_matl, ""}, + {"", hand_matl, ""} + } + }) + end +end + + + +--Mallets for the default ores, scaled to a similar power level but given no other special gimmicks. +if minetest.get_modpath("default") then + nd_tools.register_mallet("Wood", 15, nil, "group:stick", "group:wood") + nd_tools.register_mallet("Stone", 25, nil, "group:stick", "group:stone") + nd_tools.register_mallet("Bronze", 35, nil, "group:stick", "default:bronze_ingot") + nd_tools.register_mallet("Steel", 35, nil, "group:stick", "default:steel_ingot") + nd_tools.register_mallet("Mese", 44, nil, "group:stick", "default:mese_crystal") + nd_tools.register_mallet("Diamond", 50, nil, "group:stick", "default:diamond") +end + +--Hardtrees provides its own tier of very weak rock tools. Probably won't ever get made, but oh well. +if minetest.get_modpath("hardtrees") then + nd_tools.register_mallet("Rock", 8, nil, "group:stick", "hardtrees:rock") +end + +--Silver and Mithril are distinct for being slow but having high durability. Speed isn't a factor, so instead it gets decreased efficiency. +if minetest.get_modpath("moreores") then + nd_tools.register_mallet("Silver", 105, 0.5, "group:stick", "moreores:silver_ingot") + nd_tools.register_mallet("Mithril", 215, 0.5, "group:stick", "moreores:mithril_ingot") +end + +--The rest of these are probably about what you might expect. All three are adjusted according to their general power level. + +if minetest.get_modpath("ethereal") then + nd_tools.register_mallet("Crystal", 60, nil, "default:steel_ingot", "ethereal:crystal_ingot") +end + +if minetest.get_modpath("obsidianstuff") then + nd_tools.register_mallet("Obsidian", 60, nil, "default:obsidian_shard", "obsidianstuff:ingot") +end + +if minetest.get_modpath("cloud_items") then + nd_tools.register_mallet("Cloud", 80, nil, "group:stick", "cloud_items:cloud_ingot") +end diff --git a/mod.conf b/mod.conf new file mode 100644 index 0000000..48d928f --- /dev/null +++ b/mod.conf @@ -0,0 +1,4 @@ +name = nd_tools +description = Overrides pre-existing tools to make them cause persistent node damage. Also adds hammers that can repair damaged nodes, but have low durability. +depends = controls, node_damage +optional_depends = cloud_items, default, ethereal, hardtrees, mesecons_materials, moreores diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..5838d41 Binary files /dev/null and b/screenshot.png differ diff --git a/textures/nd_tools_glue.png b/textures/nd_tools_glue.png new file mode 100644 index 0000000..3d28e5b Binary files /dev/null and b/textures/nd_tools_glue.png differ diff --git a/textures/nd_tools_mallet_bronze.png b/textures/nd_tools_mallet_bronze.png new file mode 100644 index 0000000..714a018 Binary files /dev/null and b/textures/nd_tools_mallet_bronze.png differ diff --git a/textures/nd_tools_mallet_cloud.png b/textures/nd_tools_mallet_cloud.png new file mode 100644 index 0000000..a94daf5 Binary files /dev/null and b/textures/nd_tools_mallet_cloud.png differ diff --git a/textures/nd_tools_mallet_crystal.png b/textures/nd_tools_mallet_crystal.png new file mode 100644 index 0000000..ad865c7 Binary files /dev/null and b/textures/nd_tools_mallet_crystal.png differ diff --git a/textures/nd_tools_mallet_diamond.png b/textures/nd_tools_mallet_diamond.png new file mode 100644 index 0000000..dd2c348 Binary files /dev/null and b/textures/nd_tools_mallet_diamond.png differ diff --git a/textures/nd_tools_mallet_mese.png b/textures/nd_tools_mallet_mese.png new file mode 100644 index 0000000..8ba8e53 Binary files /dev/null and b/textures/nd_tools_mallet_mese.png differ diff --git a/textures/nd_tools_mallet_mithril.png b/textures/nd_tools_mallet_mithril.png new file mode 100644 index 0000000..f610b9e Binary files /dev/null and b/textures/nd_tools_mallet_mithril.png differ diff --git a/textures/nd_tools_mallet_obsidian.png b/textures/nd_tools_mallet_obsidian.png new file mode 100644 index 0000000..fce1a4c Binary files /dev/null and b/textures/nd_tools_mallet_obsidian.png differ diff --git a/textures/nd_tools_mallet_rock.png b/textures/nd_tools_mallet_rock.png new file mode 100644 index 0000000..46038a6 Binary files /dev/null and b/textures/nd_tools_mallet_rock.png differ diff --git a/textures/nd_tools_mallet_silver.png b/textures/nd_tools_mallet_silver.png new file mode 100644 index 0000000..b06fdb9 Binary files /dev/null and b/textures/nd_tools_mallet_silver.png differ diff --git a/textures/nd_tools_mallet_steel.png b/textures/nd_tools_mallet_steel.png new file mode 100644 index 0000000..1830af0 Binary files /dev/null and b/textures/nd_tools_mallet_steel.png differ diff --git a/textures/nd_tools_mallet_stone.png b/textures/nd_tools_mallet_stone.png new file mode 100644 index 0000000..7cca6d7 Binary files /dev/null and b/textures/nd_tools_mallet_stone.png differ diff --git a/textures/nd_tools_mallet_wood.png b/textures/nd_tools_mallet_wood.png new file mode 100644 index 0000000..d900aa8 Binary files /dev/null and b/textures/nd_tools_mallet_wood.png differ