diff --git a/mods/HELP/mcl_craftguide/.luacheckrc b/mods/HELP/mcl_craftguide/.luacheckrc index a21bce1f3..5a495c7af 100644 --- a/mods/HELP/mcl_craftguide/.luacheckrc +++ b/mods/HELP/mcl_craftguide/.luacheckrc @@ -4,4 +4,9 @@ allow_defined_top = true read_globals = { "minetest", "default", + "sfinv", + "sfinv_buttons", + "vector", + "string", + "table", } diff --git a/mods/HELP/mcl_craftguide/API.md b/mods/HELP/mcl_craftguide/API.md new file mode 100644 index 000000000..e03a0e2b5 --- /dev/null +++ b/mods/HELP/mcl_craftguide/API.md @@ -0,0 +1,173 @@ +## API + +### Custom recipes + +#### Registering a custom crafting type (example) + +```Lua +craftguide.register_craft_type("digging", { + description = "Digging", + icon = "default_tool_steelpick.png", +}) +``` + +#### Registering a custom crafting recipe (example) + +```Lua +craftguide.register_craft({ + type = "digging", + width = 1, + output = "default:cobble 2", + items = {"default:stone"}, +}) +``` + +--- + +### Recipe filters + +Recipe filters can be used to filter the recipes shown to players. Progressive +mode is implemented as a recipe filter. + +#### `craftguide.add_recipe_filter(name, function(recipes, player))` + +Adds a recipe filter with the given name. The filter function should return the +recipes to be displayed, given the available recipes and an `ObjectRef` to the +user. Each recipe is a table of the form returned by +`minetest.get_craft_recipe`. + +Example function to hide recipes for items from a mod called "secretstuff": + +```lua +craftguide.add_recipe_filter("Hide secretstuff", function(recipes) + local filtered = {} + for _, recipe in ipairs(recipes) do + if recipe.output:sub(1,12) ~= "secretstuff:" then + filtered[#filtered + 1] = recipe + end + end + + return filtered +end) +``` + +#### `craftguide.remove_recipe_filter(name)` + +Removes the recipe filter with the given name. + +#### `craftguide.set_recipe_filter(name, function(recipe, player))` + +Removes all recipe filters and adds a new one. + +#### `craftguide.get_recipe_filters()` + +Returns a map of recipe filters, indexed by name. + +--- + +### Search filters + +Search filters are used to perform specific searches inside the search field. +They can be used like so: `+=,,<...>` + +Examples: + +- `+groups=cracky,crumbly`: search for groups `cracky` and `crumbly` in all items. +- `sand+groups=falling_node`: search for group `falling_node` for items which contain `sand` in their names. + +Notes: +- If `optional name` is omitted, the search filter will apply to all items, without pre-filtering. +- Filters can be combined. +- The `groups` filter is currently implemented by default. + +#### `craftguide.add_search_filter(name, function(item, values))` + +Adds a search filter with the given name. +The search function should return a boolean value (whether the given item should be listed or not). + +Example function to show items which contain at least a recipe of given width(s): + +```lua +craftguide.add_search_filter("widths", function(item, widths) + local has_width + local recipes = recipes_cache[item] + + if recipes then + for i = 1, #recipes do + local recipe_width = recipes[i].width + for j = 1, #widths do + local width = tonumber(widths[j]) + if width == recipe_width then + has_width = true + break + end + end + end + end + + return has_width +end) +``` + +#### `craftguide.remove_search_filter(name)` + +Removes the search filter with the given name. + +#### `craftguide.get_search_filters()` + +Returns a map of search filters, indexed by name. + +--- + +### Custom formspec elements + +#### `craftguide.add_formspec_element(name, def)` + +Adds a formspec element to the current formspec. +Supported types: `box`, `label`, `image`, `button`, `tooltip`, `item_image`, `image_button`, `item_image_button` + +Example: + +```lua +craftguide.add_formspec_element("export", { + type = "button", + element = function(data) + -- Should return a table of parameters according to the formspec element type. + -- Note: for all buttons, the 'name' parameter *must not* be specified! + if data.recipes then + return { + data.iX - 3.7, -- X + sfinv_only and 7.9 or 8, -- Y + 1.6, -- W + 1, -- H + ESC(S("Export")) -- label + } + end + end, + -- Optional. + action = function(player, data) + -- When the button is pressed. + print("Exported!") + end +}) +``` + +#### `craftguide.remove_formspec_element(name)` + +Removes the formspec element with the given name. + +#### `craftguide.get_formspec_elements()` + +Returns a map of formspec elements, indexed by name. + +--- + +### Miscellaneous + +#### `craftguide.show(player_name, item, show_usages)` + +Opens the Crafting Guide with the current filter applied. + + * `player_name`: string param. + * `item`: optional, string param. If set, this item is pre-selected. If the item does not exist or has no recipe, use the player's previous selection. By default, player's previous selection is used + * `show_usages`: optional, boolean param. If true, show item usages. diff --git a/mods/HELP/mcl_craftguide/LICENSE b/mods/HELP/mcl_craftguide/LICENSE deleted file mode 100644 index fedaf1ee5..000000000 --- a/mods/HELP/mcl_craftguide/LICENSE +++ /dev/null @@ -1,681 +0,0 @@ -┌───────────────────────────────────────────────────────────────────┐ -│ Copyright (c) 2015-2017 kilbith │ -│ │ -│ Code: GPL version 3 │ -│ Textures: WTFPL (credits: Gambit) │ -└───────────────────────────────────────────────────────────────────┘ - - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, 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 -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If 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 convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU 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 -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state 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 program's name and a brief idea of what it does.} - Copyright (C) {year} {name of author} - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program 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 General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - {project} Copyright (C) {year} {fullname} - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/mods/HELP/mcl_craftguide/README.md b/mods/HELP/mcl_craftguide/README.md index c3b1a1584..f02ad3462 100644 --- a/mods/HELP/mcl_craftguide/README.md +++ b/mods/HELP/mcl_craftguide/README.md @@ -1,14 +1,11 @@ -## ![Preview1](http://i.imgur.com/fIPNYkb.png) Crafting Guide ## +# Crafting Guide (MineClone 2 edition) -#### A Crafting Guide for Minetest that doesn't suck. #### +#### `mcl_craftguide` is based on, `craftguide` the most comprehensive crafting guide on Minetest. +#### Consult the [Minetest Wiki](http://wiki.minetest.net/Crafting_guide) for more details. -#### `craftguide` is simply the most comprehensive mod of his category, with the cleanest code. #### -#### Consult the [Minetest Wiki](http://wiki.minetest.net/Crafting_guide) for more details and comparisons. #### +This crafting guide can be accessed from the invenotory menu (book icon). -#### This crafting guide is usable with a blue book named *"Crafting Guide"*. #### +Crafting guide starts out empty and will be filled with more recipes whenever you hold on +to a new items that you can use to new recipes. -#### This crafting guide features two modes : Standard and Progressive. #### -The Progressive mode is a Terraria-like system that only shows recipes you can craft from items in inventory. -The progressive mode can be enabled with `craftguide_progressive_mode = true` in `minetest.conf`. - -![Preview2](http://i.imgur.com/3q7rVSo.png) +For developers, there's a modding API (see `API.md`). diff --git a/mods/HELP/mcl_craftguide/depends.txt b/mods/HELP/mcl_craftguide/depends.txt index de1a2085e..5bff11578 100644 --- a/mods/HELP/mcl_craftguide/depends.txt +++ b/mods/HELP/mcl_craftguide/depends.txt @@ -2,3 +2,5 @@ mcl_core mcl_compass mcl_clock doc +sfinv? +sfinv_buttons? diff --git a/mods/HELP/mcl_craftguide/init.lua b/mods/HELP/mcl_craftguide/init.lua index 144a9e8c8..28cae912f 100644 --- a/mods/HELP/mcl_craftguide/init.lua +++ b/mods/HELP/mcl_craftguide/init.lua @@ -1,50 +1,57 @@ mcl_craftguide = {} -local craftguide, datas, mt = {}, {}, minetest --- Progressive Mode: --- true: Only show recipes which include at least one of the items the player posesses --- false: Show all crafting recipes -local progressive_mode = false -if mt.settings:get_bool("craftguide_progressive_mode") == true then - progressive_mode = true -end -local get_recipe = mt.get_craft_recipe -local get_result, show_formspec = mt.get_craft_result, mt.show_formspec -local reg_items = mt.registered_items +local M = minetest +local player_data = {} -local get_recipes = function(query_item) - local recipes = mt.get_all_craft_recipes(query_item) +-- Caches +local init_items = {} +local searches = {} +local recipes_cache = {} +local usages_cache = {} +local fuel_cache = {} - -- Manually add repairing recipes (workaround, because get_all_craft_recipes - -- doesn't return repairing recipes) - if minetest.get_modpath("mcl_core") then - local def = minetest.registered_items[query_item] - if not def then - return - end - if def.type == "tool" then - if recipes == nil then - recipes = {} - end - if minetest.get_item_group(query_item, "disable_repair") ~= 1 then - table.insert(recipes, { - type = "normal", - width = 0, - items = { [1] = query_item, [2] = query_item }, - output = query_item, - -- Special marker for repairing recipes - _is_toolrepair = true, - }) - end - end - end - return recipes -end +local progressive_mode = M.settings:get_bool("craftguide_progressive_mode") and rawget(_G, "sfinv") +local sfinv_only = M.settings:get_bool("craftguide_sfinv_only") and rawget(_G, "sfinv") + +local colorize = M.colorize +local reg_items = M.registered_items +local get_result = M.get_craft_result +local show_formspec = M.show_formspec +local get_player_by_name = M.get_player_by_name +local serialize, deserialize = M.serialize, M.deserialize + +local ESC = M.formspec_escape +local S = M.get_translator("mcl_craftguide") + +local maxn, sort, concat, insert, copy = + table.maxn, table.sort, table.concat, table.insert, + table.copy + +local fmt, find, gmatch, match, sub, split, lower = + string.format, string.find, string.gmatch, string.match, + string.sub, string.split, string.lower --- Lua 5.3 removed `table.maxn`, use this alternative in case of breakage: --- https://github.com/kilbith/xdecor/blob/master/handlers/helpers.lua#L1 -local remove, maxn, sort = table.remove, table.maxn, table.sort local min, max, floor, ceil = math.min, math.max, math.floor, math.ceil +local pairs, next, unpack = pairs, next, unpack +local vec_add, vec_mul = vector.add, vector.multiply + +local DEFAULT_SIZE = 10 +local MIN_LIMIT, MAX_LIMIT = 10, 12 +DEFAULT_SIZE = min(MAX_LIMIT, max(MIN_LIMIT, DEFAULT_SIZE)) + +local GRID_LIMIT = 5 +local POLL_FREQ = 0.25 + +local FMT = { + box = "box[%f,%f;%f,%f;%s]", + label = "label[%f,%f;%s]", + image = "image[%f,%f;%f,%f;%s]", + button = "button[%f,%f;%f,%f;%s;%s]", + tooltip = "tooltip[%s;%s]", + item_image = "item_image[%f,%f;%f,%f;%s]", + image_button = "image_button[%f,%f;%f,%f;%s;%s;%s]", + item_image_button = "item_image_button[%f,%f;%f,%f;%s;%s;%s]", +} local group_stereotypes = { wool = "mcl_wool:white", @@ -67,544 +74,1108 @@ local group_stereotypes = { clock = mcl_clock.sterotype, } -local group_names = { - shulker_box = "Any shulker box", - wool = "Any wool", - wood = "Any wood planks", - tree = "Any wood", - sand = "Any sand", - normal_sandstone = "Any normal sandstone", - red_sandstone = "Any red sandstone", - carpet = "Any carpet", - dye = "Any dye", - water_bucket = "Any water bucket", - flower = "Any flower", - mushroom = "Any mushroom", - wood_slab = "Any wooden slab", - wood_stairs = "Any wooden stairs", - coal = "Any coal", - quartz_block = "Any kind of quartz block", - purpur_block = "Any kind of purpur block", - stonebrick = "Any stone bricks", +local item_lists = { + "main", + "craft", + "craftpreview", } -function craftguide:group_to_item(item) - if item:sub(1,6) == "group:" then - local itemsub = item:sub(7) - if group_stereotypes[itemsub] then - item = group_stereotypes[itemsub] - elseif reg_items["mcl_core:"..itemsub] then - item = item:gsub("group:", "mcl_core:") - else - for name, def in pairs(reg_items) do - if def.groups[item:match("[^,:]+$")] then - item = name - end - end +local function table_merge(t, t2) + t, t2 = t or {}, t2 or {} + local c = #t + + for i = 1, #t2 do + c = c + 1 + t[c] = t2[i] + end + + return t +end + +local function table_replace(t, val, new) + for k, v in pairs(t) do + if v == val then + t[k] = new end end - return item:sub(1,6) == "group:" and "" or item +end + +local function table_diff(t, t2) + local hash = {} + + for i = 1, #t do + local v = t[i] + hash[v] = true + end + + for i = 1, #t2 do + local v = t2[i] + hash[v] = nil + end + + local diff, c = {}, 0 + + for i = 1, #t do + local v = t[i] + if hash[v] then + c = c + 1 + diff[c] = v + end + end + + return diff +end + +local function __func() + return debug.getinfo(2, "n").name +end + +local custom_crafts, craft_types = {}, {} + +function mcl_craftguide.register_craft_type(name, def) + local func = "mcl_craftguide." .. __func() .. "(): " + assert(name, func .. "'name' field missing") + assert(def.description, func .. "'description' field missing") + assert(def.icon, func .. "'icon' field missing") + + craft_types[name] = def +end + +function mcl_craftguide.register_craft(def) + local func = "mcl_craftguide." .. __func() .. "(): " + assert(def.type, func .. "'type' field missing") + assert(def.width, func .. "'width' field missing") + assert(def.output, func .. "'output' field missing") + assert(def.items, func .. "'items' field missing") + + custom_crafts[#custom_crafts + 1] = def +end + +local recipe_filters = {} + +function mcl_craftguide.add_recipe_filter(name, f) + local func = "mcl_craftguide." .. __func() .. "(): " + assert(name, func .. "filter name missing") + assert(f and type(f) == "function", func .. "filter function missing") + + recipe_filters[name] = f +end + +function mcl_craftguide.remove_recipe_filter(name) + recipe_filters[name] = nil +end + +function mcl_craftguide.set_recipe_filter(name, f) + local func = "mcl_craftguide." .. __func() .. "(): " + assert(name, func .. "filter name missing") + assert(f and type(f) == "function", func .. "filter function missing") + + recipe_filters = {[name] = f} +end + +function mcl_craftguide.get_recipe_filters() + return recipe_filters +end + +local function apply_recipe_filters(recipes, player) + for _, filter in pairs(recipe_filters) do + recipes = filter(recipes, player) + end + + return recipes +end + +local search_filters = {} + +function mcl_craftguide.add_search_filter(name, f) + local func = "mcl_craftguide." .. __func() .. "(): " + assert(name, func .. "filter name missing") + assert(f and type(f) == "function", func .. "filter function missing") + + search_filters[name] = f +end + +function mcl_craftguide.remove_search_filter(name) + search_filters[name] = nil +end + +function mcl_craftguide.get_search_filters() + return search_filters +end + +local formspec_elements = {} + +function mcl_craftguide.add_formspec_element(name, def) + local func = "mcl_craftguide." .. __func() .. "(): " + assert(def.element, func .. "'element' field not defined") + assert(def.type, func .. "'type' field not defined") + assert(FMT[def.type], func .. "'" .. def.type .. "' type not supported by the API") + + formspec_elements[name] = { + type = def.type, + element = def.element, + action = def.action, + } +end + +function mcl_craftguide.remove_formspec_element(name) + formspec_elements[name] = nil +end + +function mcl_craftguide.get_formspec_elements() + return formspec_elements +end + +local function item_has_groups(item_groups, groups) + for i = 1, #groups do + local group = groups[i] + if not item_groups[group] then + return + end + end + + return true end local function extract_groups(str) - if str:sub(1,6) ~= "group:" then return end - return str:sub(7):split(",") + return split(sub(str, 7), ",") end -local function colorize(str) - -- If client <= 0.4.14, don't colorize for compatibility. - return mt.colorize and mt.colorize("#FFFF00", str) or str -end - -local function get_fueltime(item) - return get_result({method="fuel", width=1, items={item}}).time -end - -function craftguide:get_tooltip(item, recipe_type, cooktime, groups) - local raw = self:get_tooltip_raw(item, recipe_type, cooktime, groups) - if raw == "" then - return raw - else - local tooltip = "tooltip["..item..";" - tooltip = tooltip .. raw - tooltip = tooltip .. "]" - return tooltip - end -end - -function craftguide:get_tooltip_raw(item, recipe_type, cooktime, groups) - local tooltip, item_desc = "", "" - local fueltime = get_fueltime(item) - local has_extras = groups or recipe_type == "cooking" or fueltime > 0 - - if reg_items[item] then - if not groups then - item_desc = reg_items[item].description +local function item_in_recipe(item, recipe) + for _, recipe_item in pairs(recipe.items) do + if recipe_item == item then + return true end - else - return tooltip.."Unknown Item ("..item..")]" end +end + +local function groups_item_in_recipe(item, recipe) + local item_groups = reg_items[item].groups + for _, recipe_item in pairs(recipe.items) do + if sub(recipe_item, 1, 6) == "group:" then + local groups = extract_groups(recipe_item) + if item_has_groups(item_groups, groups) then + local usage = copy(recipe) + table_replace(usage.items, recipe_item, item) + return usage + end + end + end +end + +local function get_item_usages(item) + local usages, c = {}, 0 + + for _, recipes in pairs(recipes_cache) do + for i = 1, #recipes do + local recipe = recipes[i] + if item_in_recipe(item, recipe) then + c = c + 1 + usages[c] = recipe + else + recipe = groups_item_in_recipe(item, recipe) + if recipe then + c = c + 1 + usages[c] = recipe + end + end + end + end + + if fuel_cache[item] then + usages[#usages + 1] = {type = "fuel", width = 1, items = {item}} + end + + return usages +end + +local function get_filtered_items(player) + local items, c = {}, 0 + + for i = 1, #init_items do + local item = init_items[i] + local recipes = recipes_cache[item] + local usages = usages_cache[item] + + if recipes and #apply_recipe_filters(recipes, player) > 0 or + usages and #apply_recipe_filters(usages, player) > 0 then + c = c + 1 + items[c] = item + end + end + + return items +end + +local function cache_recipes(output) + local recipes = M.get_all_craft_recipes(output) or {} + local c = 0 + + for i = 1, #custom_crafts do + local custom_craft = custom_crafts[i] + if match(custom_craft.output, "%S*") == output then + c = c + 1 + recipes[c] = custom_craft + end + end + + if #recipes > 0 then + recipes_cache[output] = recipes + return true + end +end + +local function get_recipes(item, data, player) + local recipes = recipes_cache[item] + local usages = usages_cache[item] + + if recipes then + recipes = apply_recipe_filters(recipes, player) + end + + local no_recipes = not recipes or #recipes == 0 + if no_recipes and not usages then + return + elseif usages and no_recipes then + data.show_usages = true + end + + if data.show_usages then + recipes = apply_recipe_filters(usages_cache[item], player) + if #recipes == 0 then + return + end + end + + return recipes +end + +local function get_burntime(item) + return get_result({method = "fuel", width = 1, items = {item}}).time +end + +local function cache_fuel(item) + local burntime = get_burntime(item) + if burntime > 0 then + fuel_cache[item] = burntime + return true + end +end + +local function groups_to_item(groups) + if #groups == 1 then + local group = groups[1] + local def_gr = "default:" .. group + + if group_stereotypes[group] then + return group_stereotypes[group] + elseif reg_items[def_gr] then + return def_gr + end + end + + for name, def in pairs(reg_items) do + if item_has_groups(def.groups, groups) then + return name + end + end + + return "" +end + +local function get_tooltip(item, groups, cooktime, burntime) + local tooltip + if groups then - local gcol = "#FFAAFF" - local groupstr - if #groups == 1 then - local g = group_names[groups[1]] - -- Treat the groups “compass” and “clock” as fake groups - -- and just print the normal group name without special formatting - if groups[1] == "compass" or groups[1] == "clock" then - gcol = "" - groupstr = reg_items[item].description - elseif group_names[groups[1]] then - -- Use the special group name string - groupstr = group_names[groups[1]] - else - --[[ Fallback: Generic group explanation: This always - works, but the internally used group name (which - looks ugly) is exposed to the user. ]] - groupstr = "Any item belonging to the " .. groups[1] .. " group" - end - else - groupstr = "Any item belonging to the following groups: " - for i=1, #groups do - groupstr = groupstr .. groups[i].. - (groups[i+1] and " and " or "") - end + local groupstr, c = {}, 0 + + for i = 1, #groups do + c = c + 1 + groupstr[c] = colorize("yellow", groups[i]) end - tooltip = tooltip..core.colorize(gcol, groupstr) - end - tooltip = tooltip .. item_desc - if recipe_type == "cooking" then - tooltip = tooltip.."\nCooking time: ".. - colorize(cooktime) - end - if fueltime > 0 and not groups then - tooltip = tooltip.."\nBurning time: ".. - colorize(fueltime) - end - return tooltip -end - -function craftguide:get_recipe(iY, xoffset, tooltip_raw, item, recipe_num, recipes) - local formspec, recipes_total = "", #recipes - if recipes_total > 1 then - formspec = formspec.. - "button[0,"..(iY+3)..";2,1;alternate;Alternate]".. - "label[0,"..(iY+2)..".5;Recipe ".. - recipe_num.." of "..recipes_total.."]" - end - local recipe_type = recipes[recipe_num].type - - local items = recipes[recipe_num].items - local width = recipes[recipe_num].width - local output = recipes[recipe_num].output - local cooking_time = 10 - local is_shapeless = false - if recipe_type == "normal" and width == 0 then - is_shapeless = true - if #items <= 4 then - width = 2 - else - width = min(3, #items) - end - end - - --[[ Recipe type symbols ]] - - -- Cooking (furnace) - if recipe_type == "cooking" then - cooking_time = width - width = 1 - formspec = formspec.. - "image["..(xoffset-0.8)..","..(iY+1).. - ".5;0.5,0.5;default_furnace_front_active.png]" - -- Shapeless recipes (intertwined arrows) - elseif is_shapeless then - formspec = formspec.. - "image["..(xoffset-0.8)..","..(iY+1).. - ".5;0.5,0.5;craftguide_shapeless.png]" - end - - -- Recipe only available in v6 (“v6” icon) - -- TODO/FIXME: This only works for the unique red sand recipe. - -- Remove this when red sand becomes regularily available. - local v6_only_recipe = false - if output == "mcl_core:redsand 8" and - width == 3 and - items[1] == "mcl_core:sand" and - items[2] == "mcl_core:sand" and - items[3] == "mcl_core:sand" and - items[4] == "mcl_core:sand" and - items[5] == "mcl_nether:nether_wart_item" and - items[6] == "mcl_core:sand" and - items[7] == "mcl_core:sand" and - items[8] == "mcl_core:sand" and - items[9] == "mcl_core:sand" then - v6_only_recipe = true - end - - if v6_only_recipe then - formspec = formspec.. - "image["..(xoffset-0.8)..","..(iY+2.75).. - ".5;0.5,0.5;mcl_craftguide_v6.png]" - end - - -- Render slots - - local rows = ceil(maxn(items) / width) - local btn_size, craftgrid_limit = 1, 5 - - if recipe_type == "normal" and - width > craftgrid_limit or rows > craftgrid_limit then - formspec = formspec.. - "label["..xoffset..","..(iY+2).. - ";Recipe is too big to\nbe displayed (".. - width.."x"..rows..")]" + groupstr = concat(groupstr, ", ") + tooltip = S("Any item belonging to the group(s): @1", groupstr) else - for i, v in pairs(items) do - local X = (i-1) % width + xoffset - 4 + (3 - max(1, width)) - local Y = ceil(i / width + iY+2 - min(2, rows)) - - if recipe_type == "normal" and - width > 3 or rows > 3 then - btn_size = width > 3 and 3 / width or 3 / rows - X = btn_size * (i % width) + xoffset - 4 + (3 - max(1, width)) - - Y = btn_size * floor((i-1) / width) + iY+3 - - min(2, rows) - end - - local groups = extract_groups(v) - local label = "" - -- Add the “G” symbols for group item slots - if groups then - --[[ Exception: Groups “compass” and “clock” since the items in these groups should - be treated as a single item from the user perspective. ]] - if not (#groups == 1 and (groups[1] == "compass" or groups[1] == "clock")) then - label = "\nG" or "" - end - end - local item_r = self:group_to_item(v) - local tltip = self:get_tooltip( - item_r, recipe_type, cooking_time, groups) - - formspec = formspec.. - "item_image_button["..X..","..Y..";".. - btn_size..","..btn_size..";"..item_r.. - ";"..item_r..";"..label.."]"..tltip - end + tooltip = reg_items[item].description end - local label = "" - if recipes[recipe_num]._is_toolrepair then - tooltip_raw = tooltip_raw .. "\n" .. core.colorize("#00FF00", string.format("Repaired by %.0f%%", (mcl_core.repair*100))) - label = "\nR" + + if cooktime then + tooltip = tooltip .. "\n" .. + S("Cooking time: @1", colorize("yellow", cooktime)) end - return formspec.. - "image["..(xoffset-1)..","..(iY+2).. - ".12;0.9,0.7;craftguide_arrow.png]".. - "item_image_button["..(xoffset)..","..(iY+2)..";1,1;".. - output..";"..item.."_out"..";"..label.."]".."tooltip["..item.."_out"..";"..minetest.formspec_escape(tooltip_raw).."]" + + if burntime then + tooltip = tooltip .. "\n" .. + S("Burning time: @1", colorize("yellow", burntime)) + end + + return fmt(FMT.tooltip, item, ESC(tooltip)) end -function craftguide:get_formspec(player_name, is_fuel) - local data = datas[player_name] - local iY = data.iX - 5 +local function get_recipe_fs(data, iY) + local fs = {} + local recipe = data.recipes[data.rnum] + local width = recipe.width + local xoffset = data.iX / 2.15 + local cooktime, shapeless + + if recipe.type == "cooking" then + cooktime, width = width, 1 + elseif width == 0 then + shapeless = true + width = min(3, #recipe.items) + end + + local rows = ceil(maxn(recipe.items) / width) + local rightest, btn_size, s_btn_size = 0, 1.1 + + local btn_lab = data.show_usages and + ESC(S("Usage @1 of @2", data.rnum, #data.recipes)) or + ESC(S("Recipe @1 of @2", data.rnum, #data.recipes)) + + fs[#fs + 1] = fmt(FMT.button, + sfinv_only and 5.8 or data.iX - 2.6, + sfinv_only and 7.9 or iY + 3.3, + 2.2, + 1, + "alternate", + btn_lab) + + if width > GRID_LIMIT or rows > GRID_LIMIT then + fs[#fs + 1] = fmt(FMT.label, + (data.iX / 2) - 2, + iY + 2.2, + ESC(S("Recipe is too big to be displayed (@1x@2)", width, rows))) + + return concat(fs) + end + + for i, item in pairs(recipe.items) do + local X = ceil((i - 1) % width + xoffset - width) - + (sfinv_only and 0 or 0.2) + local Y = ceil(i / width + (iY + 2) - min(2, rows)) + + if width > 3 or rows > 3 then + btn_size = width > 3 and 3 / width or 3 / rows + s_btn_size = btn_size + X = btn_size * (i % width) + xoffset - 2.65 + Y = btn_size * floor((i - 1) / width) + (iY + 3) - min(2, rows) + end + + if X > rightest then + rightest = X + end + + local groups + if sub(item, 1, 6) == "group:" then + groups = extract_groups(item) + item = groups_to_item(groups) + end + + local label = groups and "\nG" or "" + + fs[#fs + 1] = fmt(FMT.item_image_button, + X, + Y + (sfinv_only and 0.7 or 0.2), + btn_size, + btn_size, + item, + match(item, "%S*"), + ESC(label)) + + local burntime = fuel_cache[item] + + if groups or cooktime or burntime then + fs[#fs + 1] = get_tooltip(item, groups, cooktime, burntime) + end + end + + local custom_recipe = craft_types[recipe.type] + + if custom_recipe or shapeless or recipe.type == "cooking" then + local icon = custom_recipe and custom_recipe.icon or + shapeless and "shapeless" or "furnace" + + if recipe.type == "cooking" then + icon = "default_furnace_front_active.png" + elseif not custom_recipe then + icon = fmt("craftguide_%s.png", icon) + end + + fs[#fs + 1] = fmt(FMT.image, + rightest + 1.2, + sfinv_only and 6.2 or iY + 1.7, + 0.5, + 0.5, + icon) + + local tooltip = custom_recipe and custom_recipe.description or + shapeless and S("Shapeless") or S("Cooking") + + fs[#fs + 1] = fmt("tooltip[%f,%f;%f,%f;%s]", + rightest + 1.2, + sfinv_only and 6.2 or iY + 1.7, + 0.5, + 0.5, + ESC(tooltip)) + end + + local arrow_X = rightest + (s_btn_size or 1.1) + local output_X = arrow_X + 0.9 + + fs[#fs + 1] = fmt(FMT.image, + arrow_X, + sfinv_only and 6.85 or iY + 2.35, + 0.9, + 0.7, + "craftguide_arrow.png") + + if recipe.type == "fuel" then + fs[#fs + 1] = fmt(FMT.image, + output_X, + sfinv_only and 6.68 or iY + 2.18, + 1.1, + 1.1, + "mcl_craftguide_fuel.png") + else + local output_name = match(recipe.output, "%S+") + local burntime = fuel_cache[output_name] + + fs[#fs + 1] = fmt(FMT.item_image_button, + output_X, + sfinv_only and 6.7 or iY + 2.2, + 1.1, + 1.1, + recipe.output, + ESC(output_name), + "") + + if burntime then + fs[#fs + 1] = get_tooltip(output_name, nil, nil, burntime) + + fs[#fs + 1] = fmt(FMT.image, + output_X + 1, + sfinv_only and 6.83 or iY + 2.33, + 0.6, + 0.4, + "craftguide_arrow.png") + + fs[#fs + 1] = fmt(FMT.image, + output_X + 1.6, + sfinv_only and 6.68 or iY + 2.18, + 0.6, + 0.6, + "mcl_craftguide_fuel.png") + end + end + + return concat(fs) +end + +local function make_formspec(name) + local data = player_data[name] + local iY = sfinv_only and 4 or data.iX - 5 local ipp = data.iX * iY - if not data.items then - data.items = datas.init_items - end data.pagemax = max(1, ceil(#data.items / ipp)) - local formspec = "size["..data.iX..","..(iY+3)..".6;]".. - mcl_vars.inventory_header.. - [=[background[1,1;1,1;craftguide_bg.png;true] - button[2.4,0.21;0.8,0.5;search;?] - button[3.05,0.21;0.8,0.5;clear;X] - tooltip[search;Search] - tooltip[clear;Reset] - tooltip[size_inc;Increase window size] - tooltip[size_dec;Decrease window size] - field_close_on_enter[filter;false]]=].. - "button["..(data.iX/2)..",-0.02;0.7,1;size_inc;+]".. - "button["..((data.iX/2) + 0.5).. - ",-0.02;0.7,1;size_dec;-]".. - "button["..(data.iX-3)..".4,0;0.8,0.95;prev;<]".. - "label["..(data.iX-2)..".1,0.18;".. - colorize(data.pagenum).." / "..data.pagemax.."]".. - "button["..(data.iX-1)..".2,0;0.8,0.95;next;>]".. - "field[0.3,0.32;2.5,1;filter;;".. - mt.formspec_escape(data.filter).."]" + local fs = {} - local even_num = data.iX % 2 == 0 - local xoffset = data.iX / 2 + (even_num and 0.5 or 0) + 2 + if not sfinv_only then + fs[#fs + 1] = fmt("size[%f,%f;]", data.iX - 0.35, iY + 4) - if not next(data.items) then - local msg = "" - if data.filter == "" then - msg = "You don't know any crafting recipes yet.\nCollect some items and open the recipe book again." - else - msg = "No crafting recipes found.\nReset the search and try again." + fs[#fs + 1] = [[ + no_prepend[] + background[1,1;1,1;craftguide_bg.png;true] + ]] + + fs[#fs + 1] = fmt([[ tooltip[size_inc;%s] + tooltip[size_dec;%s] ]], + ESC(S("Increase window size")), + ESC(S("Decrease window size"))) + + fs[#fs + 1] = fmt([[ + image_button[%f,0.12;0.8,0.8;craftguide_zoomin_icon.png;size_inc;] + image_button[%f,0.12;0.8,0.8;craftguide_zoomout_icon.png;size_dec;] ]], + data.iX * 0.47, + data.iX * 0.47 + 0.6) + end + + fs[#fs + 1] = [[ + image_button[2.4,0.12;0.8,0.8;craftguide_search_icon.png;search;] + image_button[3.05,0.12;0.8,0.8;craftguide_clear_icon.png;clear;] + field_close_on_enter[filter;false] + ]] + + fs[#fs + 1] = fmt([[ tooltip[search;%s] + tooltip[clear;%s] + tooltip[prev;%s] + tooltip[next;%s] ]], + ESC(S("Search")), + ESC(S("Reset")), + ESC(S("Previous page")), + ESC(S("Next page"))) + + fs[#fs + 1] = fmt("label[%f,%f;%s / %u]", + sfinv_only and 6.3 or data.iX - 2.2, + 0.22, + colorize("yellow", data.pagenum), + data.pagemax) + + fs[#fs + 1] = fmt([[ + image_button[%f,0.12;0.8,0.8;craftguide_prev_icon.png;prev;] + image_button[%f,0.12;0.8,0.8;craftguide_next_icon.png;next;] ]], + sfinv_only and 5.5 or data.iX - 3.1, + sfinv_only and 7.3 or (data.iX - 1.2) - (data.iX >= 11 and 0.08 or 0)) + + fs[#fs + 1] = fmt("field[0.3,0.32;2.5,1;filter;;%s]", ESC(data.filter)) + + if #data.items == 0 then + local no_item = S("No item to show") + local pos = (data.iX / 2) - 1 + + if next(recipe_filters) and #init_items > 0 and data.filter == "" then + no_item = S("Collect items to reveal more recipes") + pos = pos - 1 end - formspec = formspec.."label[0,2;"..mt.formspec_escape(msg).."]" + + fs[#fs + 1] = fmt(FMT.label, pos, 2, ESC(no_item)) end local first_item = (data.pagenum - 1) * ipp for i = first_item, first_item + ipp - 1 do - local name = data.items[i+1] - if not name then break end + local item = data.items[i + 1] + if not item then + break + end + local X = i % data.iX local Y = (i % ipp - X) / data.iX + 1 - formspec = formspec.. - "item_image_button["..X..","..Y..";1,1;".. - name..";"..name.."_inv;]" + fs[#fs + 1] = fmt("item_image_button[%f,%f;%f,%f;%s;%s_inv;]", + X - (sfinv_only and 0 or (X * 0.05)), + Y, + 1.1, + 1.1, + item, + item) end - if data.item and reg_items[data.item] then - local tooltip_raw = self:get_tooltip_raw(data.item) - local tooltip = "" - if tooltip_raw ~= "" then - tooltip = "tooltip["..data.item..";"..minetest.formspec_escape(tooltip_raw).."]" - end - if not data.recipes_item or (is_fuel and not - get_recipe(data.item).items) then - formspec = formspec.. - "image["..(xoffset-1)..","..(iY+2).. - ".12;0.9,0.7;craftguide_arrow.png]".. - "item_image_button["..(xoffset-2)..","..(iY+2).. - ";1,1;"..data.item..";"..data.item..";]".. - tooltip.. - "image["..(xoffset)..",".. - -- TODO: Remove fire icon, find better way to represent fuel - (iY+1.98)..";1,1;mcl_craftguide_fuel.png]" - else - formspec = formspec..self:get_recipe( - iY, xoffset, tooltip_raw, data.item, - data.recipe_num, data.recipes_item) - end + if data.recipes and #data.recipes > 0 then + fs[#fs + 1] = get_recipe_fs(data, iY) end - data.formspec = formspec - show_formspec(player_name, "craftguide", formspec) -end - -local function player_has_item(T) - for i=1, #T do - if T[i] then return true end - end -end - -local function group_to_items(group) - local items_with_group, counter = {}, 0 - for name, def in pairs(reg_items) do - if def.groups[group:sub(7)] then - counter = counter + 1 - items_with_group[counter] = name - end - end - return items_with_group -end - -local function item_in_inv(inv, item) - return inv:contains_item("main", item) -end - --- Returns true if player knows the item. Used for progressive mode (EXPERIMENTAL). -local function knows_item(playername, item) - local has_item = doc.entry_exists("nodes", item) and doc.entry_revealed(playername, "nodes", item) - if not has_item then - has_item = doc.entry_exists("tools", item) and doc.entry_revealed(playername, "tools", item) - end - if not has_item then - has_item = doc.entry_exists("craftitems", item) and doc.entry_revealed(playername, "craftitems", item) - end - return has_item -end - -function craftguide:recipe_in_inv(inv, item_name, recipes_f, playername) - local recipes = recipes_f or get_recipes(item_name) or {} - local show_item_recipes = {} - - for i=1, #recipes do - show_item_recipes[i] = false - for _, item in pairs(recipes[i].items) do - local group_in_inv = false - if item:sub(1,6) == "group:" then - local groups = group_to_items(item) - for j=1, #groups do - if item_in_inv(inv, groups[j]) then - group_in_inv = true - end - end + for elem_name, def in pairs(formspec_elements) do + local element = def.element(data) + if element then + if find(def.type, "button") then + insert(element, #element, elem_name) end - if group_in_inv or item_in_inv(inv, item) or knows_item(playername, item) then - show_item_recipes[i] = true - end - end - end - for i=#show_item_recipes, 1, -1 do - if not show_item_recipes[i] then - remove(recipes, i) + + fs[#fs + 1] = fmt(FMT[def.type], unpack(element)) end end - return recipes, player_has_item(show_item_recipes) + return concat(fs) end -function craftguide:get_init_items() - local items_list, counter = {}, 0 - for name, def in pairs(reg_items) do - local is_fuel = get_fueltime(name) > 0 - local is_tool = def.type == "tool" - if (not def.groups.not_in_craft_guide or def.groups.not_in_craft_guide == 0) - and (get_recipe(name).items or is_fuel or is_tool) - and def.description and def.description ~= "" then - counter = counter + 1 - items_list[counter] = name +local show_fs = function(player, name) + if sfinv_only then + sfinv.set_player_inventory_formspec(player) + else + show_formspec(name, "mcl_craftguide", make_formspec(name)) + end +end + +mcl_craftguide.add_search_filter("groups", function(item, groups) + local itemdef = reg_items[item] + local has_groups = true + + for i = 1, #groups do + local group = groups[i] + if not itemdef.groups[group] then + has_groups = nil + break end end - sort(items_list) - datas.init_items = items_list -end + return has_groups +end) -function craftguide:get_filter_items(data, player) +local function search(data) local filter = data.filter - local items_list = progressive_mode and data.init_filter_items or - datas.init_items - local inv = player:get_inventory() - local filtered_list, counter = {}, 0 - for i=1, #items_list do - local item = items_list[i] - local item_desc = reg_items[item].description:lower() + if searches[filter] then + data.items = searches[filter] + return + end - if filter ~= "" then - if item:find(filter, 1, true) or - item_desc:find(filter, 1, true) then - counter = counter + 1 - filtered_list[counter] = item - end - elseif progressive_mode then - local _, has_item = self:recipe_in_inv(inv, item, nil, player:get_player_name()) - if has_item then - counter = counter + 1 - filtered_list[counter] = item + local filtered_list, c = {}, 0 + local extras = "^(.-)%+([%w_]+)=([%w_,]+)" + local search_filter = next(search_filters) and match(filter, extras) + local filters = {} + + if search_filter then + for filter_name, values in gmatch(filter, sub(extras, 6, -1)) do + if search_filters[filter_name] then + values = split(values, ",") + filters[filter_name] = values end end end - if progressive_mode and not data.items then - data.init_filter_items = filtered_list + for i = 1, #data.items_raw do + local item = data.items_raw[i] + local def = reg_items[item] + local desc = lower(def.description) + local search_in = item .. desc + local to_add + + if search_filter then + for filter_name, values in pairs(filters) do + local func = search_filters[filter_name] + to_add = func(item, values) and (search_filter == "" or + find(search_in, search_filter, 1, true)) + end + else + to_add = find(search_in, filter, 1, true) + end + + if to_add then + c = c + 1 + filtered_list[c] = item + end end + + if not next(recipe_filters) then + -- Cache the results only if searched 2 times + if searches[filter] == nil then + searches[filter] = false + else + searches[filter] = filtered_list + end + end + data.items = filtered_list end -mt.register_on_player_receive_fields(function(player, formname, fields) - if formname ~= "craftguide" then return end - local player_name = player:get_player_name() - local data = datas[player_name] +local function get_inv_items(player) + local inv = player:get_inventory() + local stacks = {} + + for i = 1, #item_lists do + local list = inv:get_list(item_lists[i]) + table_merge(stacks, list) + end + + local inv_items, c = {}, 0 + + for i = 1, #stacks do + local stack = stacks[i] + if not stack:is_empty() then + local name = stack:get_name() + if reg_items[name] then + c = c + 1 + inv_items[c] = name + end + end + end + + return inv_items +end + +local function init_data(name) + player_data[name] = { + filter = "", + pagenum = 1, + iX = sfinv_only and 8 or DEFAULT_SIZE, + items = init_items, + items_raw = init_items, + } +end + +local function reset_data(data) + data.filter = "" + data.pagenum = 1 + data.rnum = 1 + data.query_item = nil + data.show_usages = nil + data.recipes = nil + data.items = data.items_raw +end + +local function cache_usages() + for i = 1, #init_items do + local item = init_items[i] + usages_cache[item] = get_item_usages(item) + end +end + +local function get_init_items() + local c = 0 + for name, def in pairs(reg_items) do + local is_fuel = cache_fuel(name) + if not (def.groups.not_in_craft_guide == 1 or + def.groups.not_in_creative_inventory == 1) and + def.description and def.description ~= "" and + (cache_recipes(name) or is_fuel) then + c = c + 1 + init_items[c] = name + end + end + + sort(init_items) + cache_usages() +end + +local function on_receive_fields(player, fields) + local name = player:get_player_name() + local data = player_data[name] + + for elem_name, def in pairs(formspec_elements) do + if fields[elem_name] and def.action then + return def.action(player, data) + end + end if fields.clear then - data.filter, data.item, data.pagenum, data.recipe_num = - "", nil, 1, 1 - data.items = progressive_mode and data.init_filter_items or - datas.init_items - craftguide:get_formspec(player_name) + reset_data(data) + show_fs(player, name) + elseif fields.alternate then - local recipe = data.recipes_item[data.recipe_num + 1] - data.recipe_num = recipe and data.recipe_num + 1 or 1 - craftguide:get_formspec(player_name) + if #data.recipes == 1 then + return + end + + local num_next = data.rnum + 1 + data.rnum = data.recipes[num_next] and num_next or 1 + show_fs(player, name) + elseif (fields.key_enter_field == "filter" or fields.search) and fields.filter ~= "" then - data.filter = fields.filter:lower() + local fltr = lower(fields.filter) + if data.filter == fltr then + return + end + + data.filter = fltr data.pagenum = 1 - craftguide:get_filter_items(data, player) - craftguide:get_formspec(player_name) + search(data) + show_fs(player, name) + elseif fields.prev or fields.next then + if data.pagemax == 1 then + return + end + data.pagenum = data.pagenum - (fields.prev and 1 or -1) + if data.pagenum > data.pagemax then data.pagenum = 1 elseif data.pagenum == 0 then data.pagenum = data.pagemax end - craftguide:get_formspec(player_name) - elseif (fields.size_inc and data.iX < 12) or - (fields.size_dec and data.iX > 8) then + + show_fs(player, name) + + elseif (fields.size_inc and data.iX < MAX_LIMIT) or + (fields.size_dec and data.iX > MIN_LIMIT) then data.pagenum = 1 - data.iX = data.iX - (fields.size_dec and 1 or -1) - craftguide:get_formspec(player_name) - elseif (fields.quit) then - datas[player_name] = nil + data.iX = data.iX + (fields.size_inc and 1 or -1) + show_fs(player, name) else - for item in pairs(fields) do - if item:find(":") then - if item:sub(-4) == "_inv" or item:sub(-4) == "_out" then - item = item:sub(1,-5) + local item + for field in pairs(fields) do + if find(field, ":") then + item = field + break end + end - local is_fuel = get_fueltime(item) > 0 - local recipes = get_recipes(item) - if not recipes and not is_fuel then return end + if not item then + return + elseif sub(item, -4) == "_inv" then + item = sub(item, 1, -5) + end - if item == data.item then - if data.recipes_item and #data.recipes_item >= 2 then - local recipe = data.recipes_item[data.recipe_num + 1] - data.recipe_num = recipe and data.recipe_num + 1 or 1 - craftguide:get_formspec(player_name) + if item ~= data.query_item then + data.show_usages = nil + else + data.show_usages = not data.show_usages + end + + local recipes = get_recipes(item, data, player) + if not recipes then + return + end + + data.query_item = item + data.recipes = recipes + data.rnum = 1 + + show_fs(player, name) + end +end + +M.register_on_mods_loaded(get_init_items) + +M.register_on_joinplayer(function(player) + local name = player:get_player_name() + init_data(name) +end) + +M.register_on_leaveplayer(function(player) + local name = player:get_player_name() + player_data[name] = nil +end) + +if sfinv_only then + sfinv.register_page("craftguide:craftguide", { + title = S("Craft Guide"), + + get = function(self, player, context) + local name = player:get_player_name() + local formspec = make_formspec(name) + + return sfinv.make_formspec(player, context, formspec) + end, + + on_enter = function(self, player, context) + if next(recipe_filters) then + local name = player:get_player_name() + local data = player_data[name] + + data.items_raw = get_filtered_items(player) + search(data) + end + end, + + on_player_receive_fields = function(self, player, context, fields) + on_receive_fields(player, fields) + end, + }) +else + M.register_on_player_receive_fields(function(player, formname, fields) + if formname == "mcl_craftguide" then + on_receive_fields(player, fields) + end + end) + + local function on_use(user) + local name = user:get_player_name() + + if next(recipe_filters) then + local data = player_data[name] + data.items_raw = get_filtered_items(user) + search(data) + end + + show_formspec(name, "mcl_craftguide", make_formspec(name)) + end + +end + +if progressive_mode then + local function item_in_inv(item, inv_items) + local inv_items_size = #inv_items + + if sub(item, 1, 6) == "group:" then + local groups = extract_groups(item) + for i = 1, inv_items_size do + local inv_item = reg_items[inv_items[i]] + if inv_item then + local item_groups = inv_item.groups + if item_has_groups(item_groups, groups) then + return true + end end + end + else + for i = 1, inv_items_size do + if inv_items[i] == item then + return true + end + end + end + end + + local function recipe_in_inv(recipe, inv_items) + for _, item in pairs(recipe.items) do + if not item_in_inv(item, inv_items) then + return + end + end + + return true + end + + local function progressive_filter(recipes, player) + local name = player:get_player_name() + local data = player_data[name] + + if #data.inv_items == 0 then + return {} + end + + local filtered, c = {}, 0 + for i = 1, #recipes do + local recipe = recipes[i] + if recipe_in_inv(recipe, data.inv_items) then + c = c + 1 + filtered[c] = recipe + end + end + + return filtered + end + + -- Workaround. Need an engine call to detect when the contents + -- of the player inventory changed, instead. + local function poll_new_items() + local players = M.get_connected_players() + for i = 1, #players do + local player = players[i] + local name = player:get_player_name() + local data = player_data[name] + local inv_items = get_inv_items(player) + local diff = table_diff(inv_items, data.inv_items) + + if #diff > 0 then + data.inv_items = table_merge(diff, data.inv_items) + end + end + + M.after(POLL_FREQ, poll_new_items) + end + + poll_new_items() + + mcl_craftguide.add_recipe_filter("Default progressive filter", progressive_filter) + + M.register_on_joinplayer(function(player) + local meta = player:get_meta() + local name = player:get_player_name() + local data = player_data[name] + + data.inv_items = deserialize(meta:get_string("inv_items")) or {} + end) + + local function save_meta(player) + local meta = player:get_meta() + local name = player:get_player_name() + local data = player_data[name] + + meta:set_string("inv_items", serialize(data.inv_items)) + end + + M.register_on_leaveplayer(save_meta) + + M.register_on_shutdown(function() + local players = M.get_connected_players() + for i = 1, #players do + local player = players[i] + save_meta(player) + end + end) +end + +M.register_chatcommand("craft", { + description = S("Show recipe(s) of the pointed node"), + func = function(name) + local player = get_player_by_name(name) + local ppos = player:get_pos() + local dir = player:get_look_dir() + local eye_h = {x = ppos.x, y = ppos.y + 1.625, z = ppos.z} + local node_name + + for i = 1, 10 do + local look_at = vec_add(eye_h, vec_mul(dir, i)) + local node = M.get_node(look_at) + + if node.name ~= "air" then + node_name = node.name + break + end + end + + local red = colorize("red", "[mcl_craftguide] ") + + if not node_name then + return false, red .. S("No node pointed") + end + + local data = player_data[name] + reset_data(data) + + local recipes = recipes_cache[node_name] + local usages = usages_cache[node_name] + + if recipes then + recipes = apply_recipe_filters(recipes, player) + end + + if not recipes or #recipes == 0 then + local ylw = colorize("yellow", node_name) + local msg = red .. "%s: " .. ylw + + if usages then + recipes = usages_cache[node_name] + if #recipes > 0 then + data.show_usages = true + end + elseif recipes_cache[node_name] then + return false, fmt(msg, S("You don't know a recipe for this node")) else - - if progressive_mode then - local inv = player:get_inventory() - local _, has_item = craftguide:recipe_in_inv(inv, item, nil, player:get_player_name()) - - if not has_item then return end - recipes = craftguide:recipe_in_inv(inv, item, recipes, player_name) - end - - data.item = item - data.recipe_num = 1 - data.recipes_item = recipes - - craftguide:get_formspec(player_name, is_fuel) + return false, fmt(msg, S("No recipe for this node")) end end - end - end -end) -function craftguide:on_use(user) - if not datas.init_items then - craftguide:get_init_items() - end + data.query_item = node_name + data.recipes = recipes - local player_name = user:get_player_name() - local data = datas[player_name] + return true, show_fs(player, name) + end, +}) - if progressive_mode or not data then - datas[player_name] = {filter="", pagenum=1, iX=9} - if progressive_mode then - craftguide:get_filter_items( - datas[player_name], user) - end - craftguide:get_formspec(player_name) - else - show_formspec(player_name, "craftguide", data.formspec) - end +function mcl_craftguide.show(name, item, show_usages) + local func = "mcl_craftguide." .. __func() .. "(): " + assert(name, func .. "player name missing") + + local data = player_data[name] + local player = get_player_by_name(name) + local query_item = data.query_item + + reset_data(data) + + item = reg_items[item] and item or query_item + + data.query_item = item + data.show_usages = show_usages + data.recipes = get_recipes(item, data, player) + + show_fs(player, name) end -mcl_craftguide.show_craftguide = function(player) - craftguide:on_use(player) -end +--[[ Custom recipes (>3x3) test code -mt.register_on_player_receive_fields(function(player, formname, fields) - if fields.__mcl_craftguide then - craftguide:on_use(player) +M.register_craftitem(":secretstuff:custom_recipe_test", { + description = "Custom Recipe Test", +}) + +local cr = {} +for x = 1, 6 do + cr[x] = {} + for i = 1, 10 - x do + cr[x][i] = {} + for j = 1, 10 - x do + cr[x][i][j] = "group:wood" + end end -end) -mt.register_on_leaveplayer(function(player) - datas[player:get_player_name()] = nil -end) + M.register_craft({ + output = "secretstuff:custom_recipe_test", + recipe = cr[x] + }) +end +]] diff --git a/mods/HELP/mcl_craftguide/license.txt b/mods/HELP/mcl_craftguide/license.txt new file mode 100644 index 000000000..57174d4d6 --- /dev/null +++ b/mods/HELP/mcl_craftguide/license.txt @@ -0,0 +1,58 @@ +License of source code +---------------------- + +The MIT License (MIT) + +Copyright (c) 2015-2019 Jean-Patrick Guerrero and contributors. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + + +Licenses of media (textures) +---------------------------- + +Copyright © Diego Martínez (kaeza): craftguide_*_icon.png (CC BY-SA 3.0) + +You are free to: +Share — copy and redistribute the material in any medium or format. +Adapt — remix, transform, and build upon the material for any purpose, even commercially. +The licensor cannot revoke these freedoms as long as you follow the license terms. + +Under the following terms: + +Attribution — You must give appropriate credit, provide a link to the license, and +indicate if changes were made. You may do so in any reasonable manner, but not in any way +that suggests the licensor endorses you or your use. + +ShareAlike — If you remix, transform, or build upon the material, you must distribute +your contributions under the same license as the original. + +No additional restrictions — You may not apply legal terms or technological measures that +legally restrict others from doing anything the license permits. + +Notices: + +You do not have to comply with the license for elements of the material in the public +domain or where your use is permitted by an applicable exception or limitation. +No warranties are given. The license may not give you all of the permissions necessary +for your intended use. For example, other rights such as publicity, privacy, or moral +rights may limit how you use the material. + +For more details: +http://creativecommons.org/licenses/by-sa/3.0/ diff --git a/mods/HELP/mcl_craftguide/locale/mcl_craftguide.de.tr b/mods/HELP/mcl_craftguide/locale/mcl_craftguide.de.tr new file mode 100644 index 000000000..f97ba9b02 --- /dev/null +++ b/mods/HELP/mcl_craftguide/locale/mcl_craftguide.de.tr @@ -0,0 +1,25 @@ +# textdomain: mcl_craftguide + +Craft Guide=Rezeptbuch +Crafting Guide=Rezeptbuch +Crafting Guide Sign=Rezepttafel +Search=Suche +Reset=Zurücksetzen +Previous page=Vorherige Seite +Next page=Nächste Seite +Usage @1 of @2=Verwendung @1 von @2 +Recipe @1 of @2=Rezept @1 von @2 +Burning time: @1=Brennzeit: @1 +Cooking time: @1=Kochzeit: @1 +Any item belonging to the group(s): @1=Beliebiger Gegenstand aus Gruppe(n): @1 +Recipe is too big to be displayed (@1x@2)=Rezept ist zu groß für die Anzeige (@1×@2) +Shapeless=Formlos +Cooking=Kochen +Increase window size=Fenster vergrößern +Decrease window size=Fenster verkleinern +No item to show=Nichts anzuzeigen +Collect items to reveal more recipes=Gegenstände aufsammeln, um mehr Rezepte aufzudecken +Show recipe(s) of the pointed node=Rezept(e) des gezeigten Blocks anzeigen +No node pointed=Auf keinen Block gezeigt +You don't know a recipe for this node=Sie kennen kein Rezept für diesen Block +No recipe for this node=Kein Rezept für diesen Block diff --git a/mods/HELP/mcl_craftguide/locale/mcl_craftguide.fr.tr b/mods/HELP/mcl_craftguide/locale/mcl_craftguide.fr.tr new file mode 100644 index 000000000..94de87fbd --- /dev/null +++ b/mods/HELP/mcl_craftguide/locale/mcl_craftguide.fr.tr @@ -0,0 +1,24 @@ +# textdomain: mcl_craftguide + +Craft Guide=Guide de recettes +Crafting Guide=Guide de recettes +Search=Rechercher +Reset=Réinitialiser +Previous page=Page précédente +Next page=Page suivante +Usage @1 of @2=Usage @1 de @2 +Recipe @1 of @2=Recette @1 de @2 +Burning time: @1=Temps de combustion : @1 +Cooking time: @1=Temps de cuisson : @1 +Any item belonging to the group(s): @1=Tout item appartenant au(x) groupe(s) : @1 +Recipe is too big to be displayed (@1x@2)=La recette est trop grande pour être affichée (@1x@2) +Shapeless=Sans forme +Cooking=Cuisson +Increase window size=Agrandir la fenêtre +Decrease window size=Réduire la fenêtre +No item to show=Aucun item à afficher +Collect items to reveal more recipes=Collecte des items pour révéler plus de recettes +Show recipe(s) of the pointed node=Affiche les recettes du bloc visé +No node pointed=Aucun bloc visé +You don't know a recipe for this node=Tu ne connais aucune recette pour ce bloc +No recipe for this node=Aucune recette pour ce bloc diff --git a/mods/HELP/mcl_craftguide/locale/mcl_craftguide.ru.tr b/mods/HELP/mcl_craftguide/locale/mcl_craftguide.ru.tr new file mode 100644 index 000000000..04723dbea --- /dev/null +++ b/mods/HELP/mcl_craftguide/locale/mcl_craftguide.ru.tr @@ -0,0 +1,25 @@ +# textdomain: mcl_craftguide + +Craft Guide=книга рецептов крафта +Crafting Guide=книга рецептов крафта +Crafting Guide Sign=Знак с книгой рецептов +Search=Поиск +Reset=Сброс +Previous page=Предыдущая страница +Next page=Следущая страница +Usage @1 of @2=использование @1 из @2 +Recipe @1 of @2=Рецепт @1 из @2 +Burning time: @1=Время горения: @1 +Cooking time: @1=Время преготовления: @1 +Any item belonging to the group(s): @1=Любой элемент из группы: @1 +Recipe is too big to be displayed (@1x@2)=Рецепт слишком большой для показа (@1x@2) +Shapeless=Бесформенный +Cooking=Приготовление +Increase window size=Увеличить окно +Decrease window size=Уменьшить окно +No item to show=Нет элемента для показа +Collect items to reveal more recipes=Собирайте предметы, чтобы раскрыть больше рецептов +Show recipe(s) of the pointed node=Показать рецепт(ы) выбранной ноды +No node pointed=Не указана нода +You don't know a recipe for this node=Вы не знаете рецепт для этой ноды +No recipe for this node=Нет рецептов для этой ноды diff --git a/mods/HELP/mcl_craftguide/locale/template b/mods/HELP/mcl_craftguide/locale/template new file mode 100644 index 000000000..d051c275c --- /dev/null +++ b/mods/HELP/mcl_craftguide/locale/template @@ -0,0 +1,25 @@ +# textdomain: craftguide + +Craft Guide= +Crafting Guide= +Crafting Guide Sign= +Search= +Reset= +Previous page= +Next page= +Usage @1 of @2= +Recipe @1 of @2= +Burning time: @1= +Cooking time: @1= +Any item belonging to the group(s): @1= +Recipe is too big to be displayed (@1x@2)= +Shapeless= +Cooking= +Increase window size= +Decrease window size= +No item to show= +Collect items to reveal more recipes= +Show recipe(s) of the pointed node= +No node pointed= +You don't know a recipe for this node= +No recipe for this node= diff --git a/mods/HELP/mcl_craftguide/settingtypes.txt b/mods/HELP/mcl_craftguide/settingtypes.txt new file mode 100644 index 000000000..14198aeb0 --- /dev/null +++ b/mods/HELP/mcl_craftguide/settingtypes.txt @@ -0,0 +1,5 @@ +# The progressive mode shows recipes you can craft from items you ever had in your inventory. +craftguide_progressive_mode (Progressive Mode) bool false + +# Integration in the default Minetest Game inventory. +craftguide_sfinv_only (Sfinv only) bool false \ No newline at end of file diff --git a/mods/HELP/mcl_craftguide/textures/craftguide_clear_icon.png b/mods/HELP/mcl_craftguide/textures/craftguide_clear_icon.png new file mode 100644 index 000000000..9244264ad Binary files /dev/null and b/mods/HELP/mcl_craftguide/textures/craftguide_clear_icon.png differ diff --git a/mods/HELP/mcl_craftguide/textures/craftguide_next_icon.png b/mods/HELP/mcl_craftguide/textures/craftguide_next_icon.png new file mode 100644 index 000000000..82cf3d361 Binary files /dev/null and b/mods/HELP/mcl_craftguide/textures/craftguide_next_icon.png differ diff --git a/mods/HELP/mcl_craftguide/textures/craftguide_prev_icon.png b/mods/HELP/mcl_craftguide/textures/craftguide_prev_icon.png new file mode 100644 index 000000000..b26cd157f Binary files /dev/null and b/mods/HELP/mcl_craftguide/textures/craftguide_prev_icon.png differ diff --git a/mods/HELP/mcl_craftguide/textures/craftguide_search_icon.png b/mods/HELP/mcl_craftguide/textures/craftguide_search_icon.png new file mode 100644 index 000000000..aace8044a Binary files /dev/null and b/mods/HELP/mcl_craftguide/textures/craftguide_search_icon.png differ diff --git a/mods/HELP/mcl_craftguide/textures/craftguide_zoomin_icon.png b/mods/HELP/mcl_craftguide/textures/craftguide_zoomin_icon.png new file mode 100644 index 000000000..5b8ecc2cb Binary files /dev/null and b/mods/HELP/mcl_craftguide/textures/craftguide_zoomin_icon.png differ diff --git a/mods/HELP/mcl_craftguide/textures/craftguide_zoomout_icon.png b/mods/HELP/mcl_craftguide/textures/craftguide_zoomout_icon.png new file mode 100644 index 000000000..7db747fda Binary files /dev/null and b/mods/HELP/mcl_craftguide/textures/craftguide_zoomout_icon.png differ diff --git a/mods/HUD/mcl_inventory/depends.txt b/mods/HUD/mcl_inventory/depends.txt index 46d93c42a..b1bb24873 100644 --- a/mods/HUD/mcl_inventory/depends.txt +++ b/mods/HUD/mcl_inventory/depends.txt @@ -1,4 +1,5 @@ mcl_init mcl_player? +mcl_craftguide? _mcl_autogroup? 3d_armor? diff --git a/mods/HUD/mcl_inventory/init.lua b/mods/HUD/mcl_inventory/init.lua index 899abeba9..5d6c8ca66 100644 --- a/mods/HUD/mcl_inventory/init.lua +++ b/mods/HUD/mcl_inventory/init.lua @@ -5,6 +5,7 @@ mcl_inventory = {} local show_armor = minetest.get_modpath("3d_armor") ~= nil local mod_player = minetest.get_modpath("mcl_player") ~= nil +local mod_craftguide = minetest.get_modpath("mcl_craftguide") ~= nil -- Returns a single itemstack in the given inventory to the main inventory, or drop it when there's no space left local function return_item(itemstack, dropper, pos, inv) @@ -130,6 +131,8 @@ minetest.register_on_player_receive_fields(function(player, formname, fields) if not minetest.settings:get_bool("creative_mode") and (formname == "" or formname == "main") then set_inventory(player) end + elseif fields.__mcl_craftguide and mod_craftguide then + mcl_craftguide.show(player:get_player_name()) end end)