From 58e381e4502811d38fe9cf9e5b36c1882f4a40d7 Mon Sep 17 00:00:00 2001 From: torm <5649457+Torm@users.noreply.github.com> Date: Mon, 30 Mar 2020 03:56:04 +0200 Subject: [PATCH] Add configuration. --- .gitignore | 46 +- LICENSE | 1348 ++++++++--------- README.md | 28 +- build.gradle | 36 +- gradle/wrapper/gradle-wrapper.properties | 12 +- gradlew.bat | 168 +- settings.gradle | 4 +- .../farmingupgrade/ConfigurationWatcher.java | 86 ++ .../java/no/hyp/farmingupgrade/CropType.java | 24 + .../no/hyp/farmingupgrade/FarmingUpgrade.java | 1254 ++++++++------- .../UpgradedBlockBreakEvent.java | 26 +- .../UpgradedBlockFadeEvent.java | 26 +- .../UpgradedMoistureChangeEvent.java | 26 +- .../UpgradedPlayerInteractEvent.java | 21 + src/main/resources/config.yml | 26 + src/main/resources/plugin.yml | 10 +- 16 files changed, 1728 insertions(+), 1413 deletions(-) create mode 100644 src/main/java/no/hyp/farmingupgrade/ConfigurationWatcher.java create mode 100644 src/main/java/no/hyp/farmingupgrade/CropType.java create mode 100644 src/main/java/no/hyp/farmingupgrade/UpgradedPlayerInteractEvent.java create mode 100644 src/main/resources/config.yml diff --git a/.gitignore b/.gitignore index a1c2a23..4f63cd8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,23 +1,23 @@ -# Compiled class file -*.class - -# Log file -*.log - -# BlueJ files -*.ctxt - -# Mobile Tools for Java (J2ME) -.mtj.tmp/ - -# Package Files # -*.jar -*.war -*.nar -*.ear -*.zip -*.tar.gz -*.rar - -# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml -hs_err_pid* +# Compiled class file +*.class + +# Log file +*.log + +# BlueJ files +*.ctxt + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + +# Package Files # +*.jar +*.war +*.nar +*.ear +*.zip +*.tar.gz +*.rar + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* diff --git a/LICENSE b/LICENSE index f288702..3877ae0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,674 @@ - 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. - - - Copyright (C) - - 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: - - Copyright (C) - 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 -. + 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. + + + Copyright (C) + + 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: + + Copyright (C) + 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/README.md b/README.md index 6b662c8..c7bb359 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ -# FarmingUpgrade -Upgraded farming mechanics. -### Compatibility -Tested for Spigot 1.15.2. -### Features -- Harvesting a grown crop with a hoe automatically replants the crop. -- Hoes do not break crops that are not fully grown. -- Hoes harvest grown crops within a range. Wood and stone have a range of 0, iron and gold a range of 1 and diamond a range of 2. -- Hoes with higher enchantment levels of Unbreaking have a lower chance to take damage when harvesting crops. -- Higher levels of Efficiency increases the range of the hoe. For every 2 levels of Efficiency, the hoe gains 1 range. -- Farmland is no longer trampled. Instead, the crop that is planted on it is reset to its first growth stage. -- Water can be placed up to 2 blocks underneath Farmland to hydrate it. -### Installation -Place the FarmingUpgrade jar file in the Bukkit server's plugins directory. +# FarmingUpgrade +Upgraded farming mechanics. +### Compatibility +Tested for Spigot 1.15.2. +### Features +- Harvesting a grown crop with a hoe automatically replants the crop. +- Hoes do not break crops that are not fully grown. +- Hoes harvest grown crops within a range. Wood and stone have a range of 0, iron and gold a range of 1 and diamond a range of 2. +- Hoes with higher enchantment levels of Unbreaking have a lower chance to take damage when harvesting crops. +- Higher levels of Efficiency increases the range of the hoe. For every 2 levels of Efficiency, the hoe gains 1 range. +- Farmland is no longer trampled. Instead, the crop that is planted on it is reset to its first growth stage. +- Water can be placed up to 2 blocks underneath Farmland to hydrate it. +### Installation +Place the FarmingUpgrade jar file in the Bukkit server's plugins directory. diff --git a/build.gradle b/build.gradle index d9571ae..83ef5d1 100644 --- a/build.gradle +++ b/build.gradle @@ -1,18 +1,18 @@ -plugins { - id 'java' -} - -group 'no.hyp' -version '1.0.0' - -sourceCompatibility = 1.8 - -repositories { - mavenLocal() - mavenCentral() -} - -dependencies { - compileOnly 'org.spigotmc:spigot-api:1.15.1-R0.1-SNAPSHOT' - testCompile group: 'junit', name: 'junit', version: '4.12' -} +plugins { + id 'java' +} + +group 'no.hyp' +version '1.1.0' + +sourceCompatibility = 1.8 + +repositories { + mavenLocal() + mavenCentral() +} + +dependencies { + compileOnly 'org.spigotmc:spigot-api:1.15.2-R0.1-SNAPSHOT' + testCompile group: 'junit', name: 'junit', version: '4.12' +} diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index a95c2b9..8cd4834 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ -#Tue Mar 24 00:37:42 CET 2020 -distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-all.zip -distributionBase=GRADLE_USER_HOME -distributionPath=wrapper/dists -zipStorePath=wrapper/dists -zipStoreBase=GRADLE_USER_HOME +#Tue Mar 24 00:37:42 CET 2020 +distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-all.zip +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStorePath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME diff --git a/gradlew.bat b/gradlew.bat index 6d57edc..0f8d593 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -1,84 +1,84 @@ -@if "%DEBUG%" == "" @echo off -@rem ########################################################################## -@rem -@rem Gradle startup script for Windows -@rem -@rem ########################################################################## - -@rem Set local scope for the variables with windows NT shell -if "%OS%"=="Windows_NT" setlocal - -set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. -set APP_BASE_NAME=%~n0 -set APP_HOME=%DIRNAME% - -@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS="-Xmx64m" - -@rem Find java.exe -if defined JAVA_HOME goto findJavaFromJavaHome - -set JAVA_EXE=java.exe -%JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto init - -echo. -echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:findJavaFromJavaHome -set JAVA_HOME=%JAVA_HOME:"=% -set JAVA_EXE=%JAVA_HOME%/bin/java.exe - -if exist "%JAVA_EXE%" goto init - -echo. -echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:init -@rem Get command-line arguments, handling Windows variants - -if not "%OS%" == "Windows_NT" goto win9xME_args - -:win9xME_args -@rem Slurp the command line arguments. -set CMD_LINE_ARGS= -set _SKIP=2 - -:win9xME_args_slurp -if "x%~1" == "x" goto execute - -set CMD_LINE_ARGS=%* - -:execute -@rem Setup the command line - -set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar - -@rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% - -:end -@rem End local scope for the variables with windows NT shell -if "%ERRORLEVEL%"=="0" goto mainEnd - -:fail -rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of -rem the _cmd.exe /c_ return code! -if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 -exit /b 1 - -:mainEnd -if "%OS%"=="Windows_NT" endlocal - -:omega +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle index 990ed4a..633ebd2 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1,2 +1,2 @@ -rootProject.name = 'FarmingUpgrade' - +rootProject.name = 'FarmingUpgrade' + diff --git a/src/main/java/no/hyp/farmingupgrade/ConfigurationWatcher.java b/src/main/java/no/hyp/farmingupgrade/ConfigurationWatcher.java new file mode 100644 index 0000000..e52ec55 --- /dev/null +++ b/src/main/java/no/hyp/farmingupgrade/ConfigurationWatcher.java @@ -0,0 +1,86 @@ +package no.hyp.farmingupgrade; + +import org.bukkit.Bukkit; + +import java.io.IOException; +import java.nio.file.*; + +import static java.nio.file.StandardWatchEventKinds.*; + +/** + * This runnable watches for changes to the configuration file. When the configuration is modified, + * the plugin reads the configuration again. This allows a user to edit the configuration and see + * the changes in game without reloading the server. + */ +class ConfigurationWatcher implements Runnable { + + private final FarmingUpgrade plugin; + + private final Path path; + + public ConfigurationWatcher(FarmingUpgrade plugin, Path path) { + this.plugin = plugin; + this.path = path; + } + + @Override + public void run() { + // Create a WatchService that watches for changes to the configuration file. + WatchService configurationWatcher; + try { + configurationWatcher = FileSystems.getDefault().newWatchService(); + path.register(configurationWatcher, ENTRY_CREATE, ENTRY_DELETE, ENTRY_MODIFY); + } catch (IOException e) { + e.printStackTrace(); + return; + } + // Keep polling the WatchService for changes. + while (true) { + WatchKey key; + try { + key = configurationWatcher.take(); + // Sleep a short time to collect duplicate events. + Thread.sleep(50); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + break; + } + for (WatchEvent event : key.pollEvents()) { + if (event.context() instanceof Path) { + WatchEvent pathEvent = (WatchEvent) event; + if (pathEvent.context().toString().equals("config.yml")) { + // If the configuration is created, read it. + if (event.kind() == ENTRY_CREATE) { + Bukkit.getScheduler().runTask(plugin, (() -> { + plugin.getLogger().info("Configuration was created."); + plugin.reloadConfig(); + })); + // If the configuration is deleted, the user is probably replacing it. Do nothing in the meanwhile. + } else if (event.kind() == ENTRY_DELETE) { + Bukkit.getScheduler().runTask(plugin, (() -> { + plugin.getLogger().info("Configuration was deleted."); + })); + // If the configuration is modified, reload it. + } else if (event.kind() == ENTRY_MODIFY) { + Bukkit.getScheduler().runTask(plugin, (() -> { + plugin.getLogger().info("Configuration was modified."); + plugin.reloadConfig(); + })); + } + } + } + } + key.reset(); + } + // Finish by closing the WatchService. + try { + configurationWatcher.close(); + } catch (IOException e) { + e.printStackTrace(); + Bukkit.getScheduler().runTask(plugin, () -> { + plugin.getLogger().severe("Error closing configuration watcher."); + }); + } + } + +} \ No newline at end of file diff --git a/src/main/java/no/hyp/farmingupgrade/CropType.java b/src/main/java/no/hyp/farmingupgrade/CropType.java new file mode 100644 index 0000000..c704c84 --- /dev/null +++ b/src/main/java/no/hyp/farmingupgrade/CropType.java @@ -0,0 +1,24 @@ +package no.hyp.farmingupgrade; + +import org.bukkit.Material; + +public class CropType { + + private final Material material; + + private final Material seed; + + public CropType(Material material, Material seed) { + this.material = material; + this.seed = seed; + } + + public Material getMaterial() { + return material; + } + + public Material getSeed() { + return seed; + } + +} diff --git a/src/main/java/no/hyp/farmingupgrade/FarmingUpgrade.java b/src/main/java/no/hyp/farmingupgrade/FarmingUpgrade.java index 222b626..42b856f 100644 --- a/src/main/java/no/hyp/farmingupgrade/FarmingUpgrade.java +++ b/src/main/java/no/hyp/farmingupgrade/FarmingUpgrade.java @@ -1,548 +1,706 @@ -package no.hyp.farmingupgrade; - -import org.bukkit.*; -import org.bukkit.block.Block; -import org.bukkit.block.BlockState; -import org.bukkit.block.data.Ageable; -import org.bukkit.block.data.BlockData; -import org.bukkit.block.data.type.Farmland; -import org.bukkit.enchantments.Enchantment; -import org.bukkit.entity.Player; -import org.bukkit.event.*; -import org.bukkit.event.block.*; -import org.bukkit.event.player.PlayerInteractEvent; -import org.bukkit.inventory.ItemStack; -import org.bukkit.inventory.meta.Damageable; -import org.bukkit.inventory.meta.ItemMeta; -import org.bukkit.plugin.java.JavaPlugin; - -import java.util.*; - -public class FarmingUpgrade extends JavaPlugin implements Listener { - - private Random random; - - /** - * A map of hoes and their ranges. - */ - private Map toolMaterials; - - private Set cropMaterials; - - @Override - public void onEnable() { - this.getServer().getPluginManager().registerEvents(this, this); - - random = new Random(); - - toolMaterials = new HashMap<>(); - toolMaterials.put(Material.WOODEN_HOE, 0); - toolMaterials.put(Material.STONE_HOE, 0); - toolMaterials.put(Material.GOLDEN_HOE, 1); - toolMaterials.put(Material.IRON_HOE, 1); - toolMaterials.put(Material.DIAMOND_HOE, 2); - - cropMaterials = new HashSet<>(); - cropMaterials.add(Material.BEETROOTS); - cropMaterials.add(Material.CARROTS); - cropMaterials.add(Material.NETHER_WART); - cropMaterials.add(Material.POTATOES); - cropMaterials.add(Material.WHEAT); - - super.onEnable(); - } - - @Override - public void onDisable() { - super.onDisable(); - } - - /** - * A PlayerInteractEvent is called for Farmland when it is trampled by a player. The result of this - * event is to call a BlockFadeEvent afterwards, therefore we will not cancel it - * - * @param e - */ - @EventHandler(priority = EventPriority.MONITOR) - public void onFarmlandTrample(PlayerInteractEvent e) { - Player p; - if (!e.isCancelled()) { - Block block = e.getClickedBlock(); - if (block != null && e.getClickedBlock().getType() == Material.FARMLAND && e.getAction() == Action.PHYSICAL) { - Block crop = block.getRelative(0, 1, 0); - if (cropMaterials.contains(crop.getType())) { - crop.getWorld().spawnParticle(Particle.BLOCK_CRACK, crop.getLocation().add(0.5, 0.5, 0.5), 200, crop.getBlockData()); - crop.getWorld().playSound(crop.getLocation().add(0.5, 0.5, 0.5), Sound.BLOCK_CROP_BREAK, 1, 1); - crop.setType(crop.getType()); - } - } - } - } - - /** - * A BlockFadeEvent is called for a Farmland block with a moisture level of 0 when Minecraft - * wants to turn it into Dirt. It is also called when a player tramples (jumps on) a Farmland block. - * We do not want Farmland to dry into Dirt so we will cancel this event for Farmland. - * - * @param e The event. - */ - @EventHandler(priority = EventPriority.LOWEST) - public void onFarmlandDry(BlockFadeEvent e) { - if (!(e instanceof UpgradedBlockFadeEvent)) { - // Check that the fading block is farmland. - Block block = e.getBlock(); - if (block.getType() == Material.FARMLAND) { - Block above = block.getRelative(0, 1, 0); - if (cropMaterials.contains(above.getType()) || above.getType() == Material.AIR) { - e.setCancelled(true); - farmlandChangeMoisture(block); - } - } - } - } - - /** - * Overwrite the Vanilla mechanics by cancelling all Farmland MoistureChangeEvents and - * implementing a custom handler. - * - * @param e - */ - @EventHandler(priority = EventPriority.LOWEST) - public void onFarmlandDry(MoistureChangeEvent e) { - if (!(e instanceof UpgradedMoistureChangeEvent)) { - Block block = e.getBlock(); - if (block.getType() == Material.FARMLAND) { - Block above = block.getRelative(0, 1, 0); - if (cropMaterials.contains(above.getType()) || above.getType() == Material.AIR) { - e.setCancelled(true); - farmlandChangeMoisture(block); - } - } - } - } - - public void farmlandChangeMoisture(Block block) { - if (block.getType() == Material.FARMLAND) { - BlockState state = block.getState(); - determineMoisture(state); - if (state.getType() == Material.FARMLAND) { - UpgradedMoistureChangeEvent event = new UpgradedMoistureChangeEvent(block, state); - this.getServer().getPluginManager().callEvent(event); - if (!event.isCancelled()) { - state.update(true); - } - } else { - UpgradedBlockFadeEvent event = new UpgradedBlockFadeEvent(block, state); - this.getServer().getPluginManager().callEvent(event); - if (!event.isCancelled()) { - state.update(true); - } - } - } - } - - public void determineMoisture(BlockState state) { - Material aboveType = state.getBlock().getRelative(0, 1, 0).getType(); - if (aboveType == Material.AIR || cropMaterials.contains(aboveType)) { - if (isHydrated(state.getBlock(), 4, 0, -2)) { - BlockData data = state.getBlockData(); - Farmland farmland = (Farmland) data; - farmland.setMoisture(Math.min(farmland.getMoisture() + 1, farmland.getMaximumMoisture())); - state.setBlockData(data); - } else { - BlockData data = state.getBlockData(); - Farmland farmland = (Farmland) data; - if (farmland.getMoisture() == 0) { - //state.setType(Material.DIRT); - } else { - farmland.setMoisture(Math.max(farmland.getMoisture() - 1, 0)); - state.setBlockData(data); - } - } - } else { - state.setType(Material.DIRT); - } - } - - /** - * Calculate the drops from a broken crop. (Currently not used). - * - * @param itemStack The tool used to harvest the crop. - * @param block The crop. - * @param replant If the crop is replanted, one seed is removed from the drops. - * @return The drops of this crop. - */ - public Set cropCalculateDrops(ItemStack itemStack, Block block, boolean replant) { - Set drops = new HashSet<>(); - // If broken with a hoe, Fortune is applied. - boolean hoe = itemStack != null && toolMaterials.containsKey(itemStack.getType()); - Optional maybeGrown = isGrown(block); - boolean grown = maybeGrown.isPresent() && maybeGrown.get() == true; - int fortune = itemStack != null ? itemStack.getEnchantmentLevel(Enchantment.LOOT_BONUS_BLOCKS) : 0; - Material cropType = block.getType(); - // Beetroots - if (cropType == Material.BEETROOTS) { - int beetroots = 0; - int beetrootSeeds = 1; - if (replant) { - beetrootSeeds--; - } - if (grown) { - beetroots++; - if (hoe) { - double beetrootChance = 0.25 + Math.min(0.15 * fortune, 0.45); - if (random.nextFloat() < beetrootChance) { - beetroots++; - } - // Chance to get an extra beetroot seed. - // Fortune 0: 0.5%, Fortune 1: 1%, Fortune 2: 1.5%, Fortune >=3: 2%. - double seedChance = 0.005 + Math.min(0.005 * fortune, 0.015); - if (random.nextFloat() < seedChance) { - beetrootSeeds++; - } - } else { - double beetrootChance = 0.25; - if (random.nextFloat() < beetrootChance) { - beetroots++; - } - double seedChance = 0.005; - if (random.nextFloat() < seedChance) { - beetrootSeeds++; - } - } - } - if (beetroots > 0) { - drops.add(new ItemStack(Material.BEETROOT, beetroots)); - } - if (beetrootSeeds > 0) { - drops.add(new ItemStack(Material.BEETROOT_SEEDS, beetrootSeeds)); - } - // Carrots - } else if (cropType == Material.CARROTS) { - int carrots = 1; - if (replant) { - carrots--; - } - if (grown) { - if (hoe) { - double chance = 0.40 + Math.min(0.20 * fortune, 0.60); - if (random.nextFloat() < chance) { - carrots++; - } - } else { - double chance = 0.40; - if (random.nextFloat() < chance) { - carrots++; - } - } - } - if (carrots > 0) { - drops.add(new ItemStack(Material.CARROT, carrots)); - } - // Netherwart - } else if (cropType == Material.NETHER_WART) { - int netherwart = 1; - if (replant) { - netherwart--; - } - if (grown) { - if (hoe) { - double chance = 0.40 + Math.min(0.10 * fortune, 0.30); - if (random.nextFloat() < chance) { - netherwart++; - } - } else { - double chance = 0.40; - if (random.nextFloat() < chance) { - netherwart++; - } - } - } - if (netherwart > 0) { - drops.add(new ItemStack(Material.NETHER_WART, netherwart)); - } - // Carrots - } else if (cropType == Material.POTATOES) { - int potatoes = 1; - if (replant) { - potatoes--; - } - if (grown) { - if (hoe) { - double chance = 0.60 + Math.min(0.10 * fortune, 0.30); - if (random.nextFloat() < chance) { - potatoes++; - } - } else { - double chance = 0.60; - if (random.nextFloat() < chance) { - potatoes++; - } - } - } - if (potatoes > 0) { - drops.add(new ItemStack(Material.POTATO, potatoes)); - } - // Wheat - } else if (cropType == Material.WHEAT) { - int wheat = 0; - int seeds = 1; - if (replant) { - seeds--; - } - if (grown) { - wheat++; - if (hoe) { - double wheat2Chance = 0.50 + Math.min(0.50 * fortune, 0.50); - if (random.nextFloat() < wheat2Chance) { - wheat++; - } - double wheat3Chance = 0.10 + Math.min(0.10 * fortune, 0.10); - if (random.nextFloat() < wheat3Chance) { - wheat++; - } - double wheat4Chance = Math.min(0.10 * fortune, 0.30); - if (random.nextFloat() < wheat4Chance) { - wheat++; - } - double seedChance = 0.05 + Math.min(0.10 * fortune, 0.30); - if (random.nextFloat() < seedChance) { - seeds++; - } - } else { - double wheat2Chance = 0.50; - if (random.nextFloat() < wheat2Chance) { - wheat++; - } - double wheat3Chance = 0.10; - if (random.nextFloat() < wheat3Chance) { - wheat++; - } - double seedChance = 0.05; - if (random.nextFloat() < seedChance) { - seeds++; - } - } - } - if (wheat > 0) { - drops.add(new ItemStack(Material.WHEAT, wheat)); - } - if (seeds > 0) { - drops.add(new ItemStack(Material.WHEAT_SEEDS, seeds)); - } - } - return drops; - } - - /** - * Determine if a block has water in its vicinity. - * - * @param block The centre block. - * @param radius The horizontal radius (of a square circle) to search within. - * @param highest The greatest height to search in, relative to the block. - * @param lowest The lowest height to search in, relative to the block. - * @return If there is water in the searched region. - */ - public boolean isHydrated(Block block, int radius, int highest, int lowest) { - int i = -radius; - while (i <= radius) { - int k = -radius; - while (k <= radius) { - int j = lowest; - while (j <= highest) { - if (block.getRelative(i, j, k).getType() == Material.WATER) { - return true; - } - j++; - } - k++; - } - i++; - } - return false; - } - - /** - * If a player breaks a crop with a hoe, handle this event manually. Find the adjacent crops - * and call custom UpgradedBlockBreakEvents on the to give other plugins a chance to catch them. - * - * Since this is a mechanic the event should be caught and cancelled as early as possible (LOWEST priority). - * Then we can dispatch new events that we can control the outcome of ourselves. - */ - @EventHandler(priority = EventPriority.LOWEST) - public void onFarm(BlockBreakEvent e) { - if (!(e instanceof UpgradedBlockBreakEvent)) { - Player player = e.getPlayer(); - Block block = e.getBlock(); - // Handle breaking of crops. - if (cropMaterials.contains(block.getType())) { - ItemStack tool = player.getInventory().getItemInMainHand(); - // If broken by a hoe, all crops within range are harvested and automatically replanted. - if (toolMaterials.containsKey(tool.getType())) { - e.setCancelled(true); - // Calculate the radius of the hoe sweep. - // Radius is affected by hoe material and the Efficiency enchantment (1 radius per 2 levels). - int range = Math.min(7, toolMaterials.get(tool.getType()) + tool.getEnchantmentLevel(Enchantment.DIG_SPEED) / 2); - // Get the adjacent crops in range. - Set adjacentCrops = new HashSet<>(); - adjacentCrops.add(block); - int radius = 1; - while (radius <= range) { - adjacentCrops.addAll(findRadiallyAdjacentMaterials(cropMaterials, block, radius)); - radius++; - } - // For every crop block, simulate a BlockBreakEvent for other plugins to react to. - for (Block crop : adjacentCrops) { - // Only break crops that are fully grown. - Optional grown = isGrown(crop); - if (grown.isPresent() && grown.get() == true) { - // Call an event that is handled by the plugin. - UpgradedBlockBreakEvent sweepEvent = new UpgradedBlockBreakEvent(crop, player); - this.getServer().getPluginManager().callEvent(sweepEvent); - if (!sweepEvent.isCancelled()) { - // Get the state of the crop before it is broken, and drop. - BlockState state = crop.getState(); - // Send a drop event indicating the dropped items. - // TODO: Maybe call BlockDropItemEvent here. - if (player.getGameMode() == GameMode.SURVIVAL || player.getGameMode() == GameMode.ADVENTURE) { - crop.breakNaturally(tool); - damageTool(player, tool, 1); - } else { - crop.setType(Material.AIR); - } - // Plant a new crop. - crop.setType(state.getType()); - // Apply damage to the hoe if in survival or adventure mode. - } - } - } - } - } - } - } - - /** - * Apply damage to a player's item. Does nothing if the item is not Damageable. - * Also checks that the Player is in Survival or Adventure mode before applying damage. - * - * @param player The player whose tool might take damage. - * @param tool The item to take damage. - * @param damage The amount of damage to apply. - */ - public void damageTool(Player player, ItemStack tool, int damage) { - if (player.getGameMode() == GameMode.SURVIVAL || player.getGameMode() == GameMode.ADVENTURE || tool.getItemMeta().isUnbreakable()) { - // Calculate the chance of the tool taking damage with the standard Minecraft formula, - // which depends on the level of the Unbreaking enchantment. - double damageChance = 1.0 / (tool.getEnchantmentLevel(Enchantment.DURABILITY) + 1.0); - if (random.nextFloat() < damageChance) { - boolean destroyed = damageTool(tool, damage); - if (destroyed) { - player.spawnParticle(Particle.ITEM_CRACK, player.getLocation(), 1, tool); - player.playSound(player.getLocation(), Sound.ENTITY_ITEM_BREAK, 1, 1); - tool.setAmount(tool.getAmount() - 1); - } - } - } - } - - /** - * Apply damage to a tool. Does nothing if the item is not Damageable. - * If a player is in creative mode, their tools probably should not take damage. - * - * @param tool The item to take damage. - * @param damage The amount of damage to apply. - * @return If the tool reaches zero or less durability. - */ - public boolean damageTool(ItemStack tool, int damage) { - ItemMeta meta = tool.getItemMeta(); - if (meta instanceof Damageable) { - Damageable damageable = (Damageable) meta; - damageable.setDamage(damageable.getDamage() + damage); - tool.setItemMeta(meta); - return damageable.getDamage() >= tool.getType().getMaxDurability(); - } - return false; - } - - /** - * Check if a block is fully grown. - * - * @param block The block. - * @return If the block is fully grown or not. Empty if the block is not Ageable. - */ - public Optional isGrown(Block block) { - BlockData data = block.getBlockData(); - if (data instanceof Ageable) { - Ageable ageable = (Ageable) data; - return Optional.of(ageable.getAge() == ageable.getMaximumAge()); - } else { - return Optional.empty(); - } - } - - /** - * In a ring centred on a block with the given radius, locate the blocks whose material is one of the given types. - * - * @param materials The materials to search for. - * @param centre The centre block. - * @param radius The radius of the ring. - * @return The blocks in the ring whose material matches one of those searched for. - */ - public Set findRadiallyAdjacentMaterials(Collection materials, Block centre, int radius) { - Set ring = new HashSet<>(); - // Centre coordinates. - World world = centre.getWorld(); - int x = centre.getX(); - int y = centre.getY(); - int z = centre.getZ(); - // Relative to centre coordinates. - int i = -radius; - int k = -radius; - // Iterate over the columns in the given radius. - while (i < radius) { - Optional block = findHighestMaterial(materials, world, x + i, z + k, y + radius, y - radius); - block.ifPresent(ring::add); - i++; - } - while (k < radius) { - Optional block = findHighestMaterial(materials, world, x + i, z + k, y + radius, y - radius); - block.ifPresent(ring::add); - k++; - } - while (i > -radius) { - Optional block = findHighestMaterial(materials, world, x + i, z + k, y + radius, y - radius); - block.ifPresent(ring::add); - i--; - } - while (k > -radius) { - Optional block = findHighestMaterial(materials, world, x + i, z + k, y + radius, y - radius); - block.ifPresent(ring::add); - k--; - } - return ring; - } - - /** - * Find the highest block that has a material of one of the given types. - * - * @param materials The materials to search for. - * @param world The world to search in. - * @param x Block x coordinate. - * @param z Block z coordinate. - * @param highest Highest y coordinate. - * @param lowest Lowest y coordinate. - * @return The highest block of one of the materials in the column, otherwise empty. - */ - public Optional findHighestMaterial(Collection materials, World world, int x, int z, int highest, int lowest) { - int y = highest; - while (y >= lowest) { - Block block = world.getBlockAt(x, y, z); - if (materials.contains(block.getType())) { - return Optional.of(block); - } - y--; - } - return Optional.empty(); - } - -} +package no.hyp.farmingupgrade; + +import com.google.common.collect.Lists; +import org.bukkit.*; +import org.bukkit.block.Block; +import org.bukkit.block.BlockState; +import org.bukkit.block.data.Ageable; +import org.bukkit.block.data.BlockData; +import org.bukkit.block.data.type.Farmland; +import org.bukkit.configuration.ConfigurationSection; +import org.bukkit.enchantments.Enchantment; +import org.bukkit.entity.Item; +import org.bukkit.entity.Player; +import org.bukkit.event.*; +import org.bukkit.event.block.*; +import org.bukkit.event.player.PlayerInteractEvent; +import org.bukkit.inventory.ItemStack; +import org.bukkit.inventory.meta.Damageable; +import org.bukkit.inventory.meta.ItemMeta; +import org.bukkit.plugin.java.JavaPlugin; + +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.*; + +public class FarmingUpgrade extends JavaPlugin implements Listener { + + private Thread watcherThread; + + private Path path; + + private Random random; + + /** + * A map of hoes and their ranges. + */ + private Map toolMaterials; + + private Map cropMaterials; + + private final String CONFIGURATION_TRAMPLE_CROPS = "trampleCrops"; + + private final String CONFIGURATION_HYDRATION_UPGRADE = "hydrationUpgrade"; + + private final String CONFIGURATION_HYDRATION_RANGE = "hydrationRange"; + + private final String CONFIGURATION_HYDRATION_DEPTH = "hydrationDepth"; + + private final String CONFIGURATION_DRY_FARMLAND = "dryFarmland"; + + private final String CONFIGURATION_HOE_UPGRADE = "hoeUpgrade"; + + private final String CONFIGURATION_HOE_REPLANT = "hoeReplant"; + + @Override + public void onEnable() { + this.saveDefaultConfig(); + this.getServer().getPluginManager().registerEvents(this, this); + + random = new Random(); + + toolMaterials = new HashMap<>(); + toolMaterials.put(Material.WOODEN_HOE, 0); + toolMaterials.put(Material.STONE_HOE, 0); + toolMaterials.put(Material.GOLDEN_HOE, 1); + toolMaterials.put(Material.IRON_HOE, 1); + toolMaterials.put(Material.DIAMOND_HOE, 2); + + cropMaterials = new HashMap<>(); + cropMaterials.put(Material.BEETROOTS, new CropType(Material.BEETROOTS, Material.BEETROOT_SEEDS)); + cropMaterials.put(Material.CARROTS, new CropType(Material.CARROTS, Material.CARROT)); + cropMaterials.put(Material.NETHER_WART, new CropType(Material.NETHER_WART, Material.NETHER_WART)); + cropMaterials.put(Material.POTATOES, new CropType(Material.POTATOES, Material.POTATO)); + cropMaterials.put(Material.WHEAT, new CropType(Material.WHEAT, Material.WHEAT_SEEDS)); + + this.path = Paths.get(this.getDataFolder().getPath()); + configurationWatcherEnable(); + super.onEnable(); + } + + @Override + public void onDisable() { + configurationWatcherDisable(); + super.onDisable(); + } + + /** + * Start/restart the configuration watcher thread. + */ + public void configurationWatcherEnable() { + // + this.configurationWatcherDisable(); + this.watcherThread = new Thread(new ConfigurationWatcher(this, this.path)); + this.watcherThread.start(); + } + + /** + * Stop the configuration watcher thread. + */ + public void configurationWatcherDisable() { + if (this.watcherThread != null) { + this.watcherThread.interrupt(); + } + } + + /** + * A PlayerInteractEvent is called for Farmland when it is trampled by a player. The result of this + * event is to call a BlockFadeEvent afterwards. + * + * @param e + */ + @EventHandler(priority = EventPriority.LOWEST) + public void onFarmlandTrample(PlayerInteractEvent e) { + if (!(e instanceof UpgradedPlayerInteractEvent)) { + Block farmland = e.getClickedBlock(); + if (farmland != null && e.getClickedBlock().getType() == Material.FARMLAND && e.getAction() == Action.PHYSICAL) { + // Cancel to handle manually. + e.setUseInteractedBlock(Event.Result.DENY); + // Trample crops or trample Farmland. + if (this.getConfig().getBoolean(CONFIGURATION_TRAMPLE_CROPS, true)) { + // Trample the crop above the farmland. + Block crop = farmland.getRelative(0, 1, 0); + if (cropMaterials.containsKey(crop.getType())) { + // Send an InteractEvent for the trampled crop. + UpgradedPlayerInteractEvent trampleEvent = new UpgradedPlayerInteractEvent(e.getPlayer(), e.getAction(), e.getItem(), crop, e.getBlockFace()); + this.getServer().getPluginManager().callEvent(trampleEvent); + if (trampleEvent.useInteractedBlock() == Event.Result.ALLOW) { + // Calculate the state of the crop after being trampled. + BlockState oldState = crop.getState(); + BlockState state = crop.getState(); + state.setType(Material.AIR); + state.setType(crop.getType()); + // Send a BlockFadeEvent to indicate the crop being reset. + UpgradedBlockFadeEvent fadeEvent = new UpgradedBlockFadeEvent(crop, state); + this.getServer().getPluginManager().callEvent(fadeEvent); + if (!fadeEvent.isCancelled()) { + state.update(true); + breakBlockEffect(crop, oldState, Sound.BLOCK_CROP_BREAK); + } + } + } + } else { + // Send an InteractEvent for the trampled Farmland. + UpgradedPlayerInteractEvent trampleEvent = new UpgradedPlayerInteractEvent(e.getPlayer(), e.getAction(), e.getItem(), farmland, e.getBlockFace()); + this.getServer().getPluginManager().callEvent(trampleEvent); + if (trampleEvent.useInteractedBlock() == Event.Result.ALLOW) { + // Calculate the state of the Farmland after being trampled. + BlockState state = farmland.getState(); + state.setType(Material.DIRT); + // Send a BlockFadeEvent to indicate the Farmland turning to Dirt. + UpgradedBlockFadeEvent fadeEvent = new UpgradedBlockFadeEvent(farmland, state); + this.getServer().getPluginManager().callEvent(fadeEvent); + if (!fadeEvent.isCancelled()) { + // Move the player up from the Farmland so they do not get stuck in the Dirt. + Player player = e.getPlayer(); + Location location = player.getLocation(); + Location blockLocation = farmland.getRelative(0, 1, 0).getLocation(); + if (location.getY() < blockLocation.getY()) { + location.setY(blockLocation.getY()); + player.teleport(location); + } + state.update(true); + } + } + } + } + } + } + + @EventHandler(priority = EventPriority.MONITOR) + public void onCropGrow(BlockGrowEvent e) { + if (!e.isCancelled()) { + Block below = e.getBlock().getRelative(0, -1, 0); + if (below.getType() == Material.FARMLAND) { + farmlandUpgradedChangeMoisture(below); + } + } + } + + /** + * A BlockFadeEvent is called for a Farmland block with a moisture level of 0 when Minecraft + * wants to turn it into Dirt. It is also called when a player tramples (jumps on) a Farmland block. + * We do not want Farmland to dry into Dirt so we will cancel this event for Farmland. + * + * @param e The event. + */ + @EventHandler(priority = EventPriority.LOWEST) + public void onFarmlandDry(BlockFadeEvent e) { + if (!(e instanceof UpgradedBlockFadeEvent)) { + // Check that the fading block is farmland. + Block farmland = e.getBlock(); + if (farmland.getType() == Material.FARMLAND) { + // Check if using upgraded hydration mechanics. + if (this.getConfig().getBoolean(CONFIGURATION_HYDRATION_UPGRADE, true)) { + e.setCancelled(true); + farmlandUpgradedChangeMoisture(farmland); + } else { + Block above = farmland.getRelative(0, 1, 0); + if (!configDryFarmland()) { + if (cropMaterials.containsKey(above.getType()) || above.getType() == Material.AIR) { + e.setCancelled(true); + } + } + } + } + } + } + + /** + * Overwrite the Vanilla mechanics by cancelling all Farmland MoistureChangeEvents and + * implementing a custom handler. + * + * @param e + */ + @EventHandler(priority = EventPriority.LOWEST) + public void onFarmlandMoistureChange(MoistureChangeEvent e) { + if (!(e instanceof UpgradedMoistureChangeEvent)) { + if (this.getConfig().getBoolean(CONFIGURATION_HYDRATION_UPGRADE, true)) { + Block block = e.getBlock(); + if (block.getType() == Material.FARMLAND) { + e.setCancelled(true); + farmlandUpgradedChangeMoisture(block); + } + } + } + } + + public void farmlandUpgradedChangeMoisture(Block farmland) { + if (farmland.getType() == Material.FARMLAND) { + BlockState state = farmland.getState(); + farmlandDetermineUpgradedMoisture(state); + if (state.getType() == Material.FARMLAND) { + UpgradedMoistureChangeEvent event = new UpgradedMoistureChangeEvent(farmland, state); + this.getServer().getPluginManager().callEvent(event); + if (!event.isCancelled()) { + state.update(true); + } + } else { + UpgradedBlockFadeEvent event = new UpgradedBlockFadeEvent(farmland, state); + this.getServer().getPluginManager().callEvent(event); + if (!event.isCancelled()) { + state.update(true); + } + } + } + } + + public void farmlandDetermineUpgradedMoisture(BlockState state) { + Material aboveType = state.getBlock().getRelative(0, 1, 0).getType(); + if (aboveType == Material.AIR || cropMaterials.containsKey(aboveType)) { + ConfigurationSection configuration = this.getConfig(); + int range = configuration.getInt(CONFIGURATION_HYDRATION_RANGE, 4); + int depth = configuration.getInt(CONFIGURATION_HYDRATION_DEPTH, 2); + if (isHydrated(state.getBlock(), range, 0, -depth)) { + BlockData data = state.getBlockData(); + Farmland farmland = (Farmland) data; + farmland.setMoisture(Math.min(farmland.getMoisture() + 1, farmland.getMaximumMoisture())); + state.setBlockData(data); + } else { + BlockData data = state.getBlockData(); + Farmland farmland = (Farmland) data; + if (farmland.getMoisture() <= 0) { + if (configDryFarmland()) { + state.setType(Material.DIRT); + } + } else { + farmland.setMoisture(Math.max(farmland.getMoisture() - 1, 0)); + state.setBlockData(data); + } + } + } else { + state.setType(Material.DIRT); + } + } + + /** + * Calculate the drops from a broken crop. (Currently not used). + * + * @param itemStack The tool used to harvest the crop. + * @param block The crop. + * @param replant If the crop is replanted, one seed is removed from the drops. + * @return The drops of this crop. + */ + public Set cropCalculateDrops(ItemStack itemStack, Block block, boolean replant) { + Set drops = new HashSet<>(); + // If broken with a hoe, Fortune is applied. + boolean hoe = itemStack != null && toolMaterials.containsKey(itemStack.getType()); + Optional maybeGrown = isGrown(block); + boolean grown = maybeGrown.isPresent() && maybeGrown.get() == true; + int fortune = itemStack != null ? itemStack.getEnchantmentLevel(Enchantment.LOOT_BONUS_BLOCKS) : 0; + Material cropType = block.getType(); + // Beetroots + if (cropType == Material.BEETROOTS) { + int beetroots = 0; + int beetrootSeeds = 1; + if (replant) { + beetrootSeeds--; + } + if (grown) { + beetroots++; + if (hoe) { + double beetrootChance = 0.25 + Math.min(0.15 * fortune, 0.45); + if (random.nextFloat() < beetrootChance) { + beetroots++; + } + // Chance to get an extra beetroot seed. + // Fortune 0: 0.5%, Fortune 1: 1%, Fortune 2: 1.5%, Fortune >=3: 2%. + double seedChance = 0.005 + Math.min(0.005 * fortune, 0.015); + if (random.nextFloat() < seedChance) { + beetrootSeeds++; + } + } else { + double beetrootChance = 0.25; + if (random.nextFloat() < beetrootChance) { + beetroots++; + } + double seedChance = 0.005; + if (random.nextFloat() < seedChance) { + beetrootSeeds++; + } + } + } + if (beetroots > 0) { + drops.add(new ItemStack(Material.BEETROOT, beetroots)); + } + if (beetrootSeeds > 0) { + drops.add(new ItemStack(Material.BEETROOT_SEEDS, beetrootSeeds)); + } + // Carrots + } else if (cropType == Material.CARROTS) { + int carrots = 1; + if (replant) { + carrots--; + } + if (grown) { + if (hoe) { + double chance = 0.40 + Math.min(0.20 * fortune, 0.60); + if (random.nextFloat() < chance) { + carrots++; + } + } else { + double chance = 0.40; + if (random.nextFloat() < chance) { + carrots++; + } + } + } + if (carrots > 0) { + drops.add(new ItemStack(Material.CARROT, carrots)); + } + // Netherwart + } else if (cropType == Material.NETHER_WART) { + int netherwart = 1; + if (replant) { + netherwart--; + } + if (grown) { + if (hoe) { + double chance = 0.40 + Math.min(0.10 * fortune, 0.30); + if (random.nextFloat() < chance) { + netherwart++; + } + } else { + double chance = 0.40; + if (random.nextFloat() < chance) { + netherwart++; + } + } + } + if (netherwart > 0) { + drops.add(new ItemStack(Material.NETHER_WART, netherwart)); + } + // Carrots + } else if (cropType == Material.POTATOES) { + int potatoes = 1; + if (replant) { + potatoes--; + } + if (grown) { + if (hoe) { + double chance = 0.60 + Math.min(0.10 * fortune, 0.30); + if (random.nextFloat() < chance) { + potatoes++; + } + } else { + double chance = 0.60; + if (random.nextFloat() < chance) { + potatoes++; + } + } + } + if (potatoes > 0) { + drops.add(new ItemStack(Material.POTATO, potatoes)); + } + // Wheat + } else if (cropType == Material.WHEAT) { + int wheat = 0; + int seeds = 1; + if (replant) { + seeds--; + } + if (grown) { + wheat++; + if (hoe) { + double wheat2Chance = 0.50 + Math.min(0.50 * fortune, 0.50); + if (random.nextFloat() < wheat2Chance) { + wheat++; + } + double wheat3Chance = 0.10 + Math.min(0.10 * fortune, 0.10); + if (random.nextFloat() < wheat3Chance) { + wheat++; + } + double wheat4Chance = Math.min(0.10 * fortune, 0.30); + if (random.nextFloat() < wheat4Chance) { + wheat++; + } + double seedChance = 0.05 + Math.min(0.10 * fortune, 0.30); + if (random.nextFloat() < seedChance) { + seeds++; + } + } else { + double wheat2Chance = 0.50; + if (random.nextFloat() < wheat2Chance) { + wheat++; + } + double wheat3Chance = 0.10; + if (random.nextFloat() < wheat3Chance) { + wheat++; + } + double seedChance = 0.05; + if (random.nextFloat() < seedChance) { + seeds++; + } + } + } + if (wheat > 0) { + drops.add(new ItemStack(Material.WHEAT, wheat)); + } + if (seeds > 0) { + drops.add(new ItemStack(Material.WHEAT_SEEDS, seeds)); + } + } + return drops; + } + + /** + * Determine if a block has water in its vicinity. + * + * @param block The centre block. + * @param radius The horizontal radius (of a square circle) to search within. + * @param highest The greatest height to search in, relative to the block. + * @param lowest The lowest height to search in, relative to the block. + * @return If there is water in the searched region. + */ + public boolean isHydrated(Block block, int radius, int highest, int lowest) { + int i = -radius; + while (i <= radius) { + int k = -radius; + while (k <= radius) { + int j = lowest; + while (j <= highest) { + if (block.getRelative(i, j, k).getType() == Material.WATER) { + return true; + } + j++; + } + k++; + } + i++; + } + return false; + } + + /** + * If a player breaks a crop with a hoe, handle this event manually. Find the adjacent crops + * and call custom UpgradedBlockBreakEvents on the to give other plugins a chance to catch them. + * + * Since this is a mechanic the event should be caught and cancelled as early as possible (LOWEST priority). + * Then we can dispatch new events that we can control the outcome of ourselves. + */ + @EventHandler(priority = EventPriority.LOWEST) + public void onFarm(BlockBreakEvent e) { + if (this.getConfig().getBoolean(CONFIGURATION_HOE_UPGRADE, true)) { + if (!(e instanceof UpgradedBlockBreakEvent)) { + Player player = e.getPlayer(); + Block block = e.getBlock(); + // Handle breaking of crops. + if (cropMaterials.containsKey(block.getType())) { + ItemStack tool = player.getInventory().getItemInMainHand(); + // If broken by a hoe, all crops within range are harvested and automatically replanted. + if (toolMaterials.containsKey(tool.getType())) { + e.setCancelled(true); + // Calculate the radius of the hoe sweep. + // Radius is affected by hoe material and the Efficiency enchantment (1 radius per 2 levels). + int range = Math.min(7, toolMaterials.get(tool.getType()) + tool.getEnchantmentLevel(Enchantment.DIG_SPEED) / 2); + // Get the adjacent crops in range. + Set adjacentCrops = new HashSet<>(); + adjacentCrops.add(block); + int radius = 1; + while (radius <= range) { + adjacentCrops.addAll(findRadiallyAdjacentMaterials(cropMaterials.keySet(), block, radius)); + radius++; + } + // For every crop block, simulate a BlockBreakEvent for other plugins to react to. + for (Block crop : adjacentCrops) { + // Only break crops that are fully grown. + Optional grown = isGrown(crop); + if (grown.isPresent() && grown.get() == true) { + // Call an event that is handled by the plugin. + UpgradedBlockBreakEvent sweepEvent = new UpgradedBlockBreakEvent(crop, player); + this.getServer().getPluginManager().callEvent(sweepEvent); + if (!sweepEvent.isCancelled()) { + // Get the state of the harvested crop. + BlockState state = crop.getState(); + Collection itemDrops = crop.getDrops(tool); + // Break the crop and spawn effects. + breakBlockEffect(crop, state, Sound.BLOCK_CROP_BREAK); + crop.setType(Material.AIR); + // Damage the player's tool if they are in survival. + damageTool(player, tool, 1); + boolean replant = false; + GameMode mode = player.getGameMode(); + if (mode == GameMode.CREATIVE && this.getConfig().getBoolean(CONFIGURATION_HOE_REPLANT, true)) { + replant = true; + } + if (sweepEvent.isDropItems() && mode != GameMode.CREATIVE) { + // Calculate the drops from the crop. + List drops = new ArrayList<>(); + Material seed = cropMaterials.get(state.getType()).getSeed(); + for (ItemStack itemDrop : itemDrops) { + // If replanting is enabled, and a seed is not found yet, search for one in this ItemStack. + if (this.getConfig().getBoolean(CONFIGURATION_HOE_REPLANT, true) && !replant) { + int amount = itemDrop.getAmount(); + if (itemDrop.getType() == seed && amount >= 1) { + itemDrop.setAmount(amount - 1); + replant = true; + } + } + drops.add(crop.getWorld().dropItemNaturally(crop.getLocation(), itemDrop)); + } + // Drop the items and send an event. + List copy = Lists.newArrayList(drops); + BlockDropItemEvent dropEvent = new BlockDropItemEvent(crop, state, player, copy); + this.getServer().getPluginManager().callEvent(dropEvent); + // Clear all items from the copy if the event is cancelled. + if (dropEvent.isCancelled()) { + copy.clear(); + } + // Kill those items that were removed from the copied drop list. + for (Item drop : drops) { + if (!copy.contains(drop)) { + drop.remove(); + } + } + } + // Use a seed to replant the crop. + if (replant) { + crop.setType(state.getType()); + } + } + } + } + } + } + } + } + } + + public void breakBlockEffect(Location location, BlockState state, Sound sound) { + location.getWorld().spawnParticle(Particle.BLOCK_CRACK, location, 50, 0.5, 0.5, 0.1, state.getBlockData()); + location.getWorld().playSound(location, sound, 1, 1); + } + + public void breakBlockEffect(Block block, BlockState state, Sound sound) { + breakBlockEffect(block.getLocation().clone().add(0.5, 0.5, 0.5), state, sound); + } + + /** + * Apply damage to a player's item. Does nothing if the item is not Damageable. + * Also checks that the Player is in Survival or Adventure mode before applying damage. + * + * @param player The player whose tool might take damage. + * @param tool The item to take damage. + * @param damage The amount of damage to apply. + */ + public void damageTool(Player player, ItemStack tool, int damage) { + if (player.getGameMode() == GameMode.SURVIVAL || player.getGameMode() == GameMode.ADVENTURE || tool.getItemMeta().isUnbreakable()) { + // Calculate the chance of the tool taking damage with the standard Minecraft formula, + // which depends on the level of the Unbreaking enchantment. + double damageChance = 1.0 / (tool.getEnchantmentLevel(Enchantment.DURABILITY) + 1.0); + if (random.nextFloat() < damageChance) { + boolean destroyed = damageTool(tool, damage); + if (destroyed) { + player.spawnParticle(Particle.ITEM_CRACK, player.getLocation(), 1, tool); + player.playSound(player.getLocation(), Sound.ENTITY_ITEM_BREAK, 1, 1); + tool.setAmount(tool.getAmount() - 1); + } + } + } + } + + /** + * Apply damage to a tool. Does nothing if the item is not Damageable. + * If a player is in creative mode, their tools probably should not take damage. + * + * @param tool The item to take damage. + * @param damage The amount of damage to apply. + * @return If the tool reaches zero or less durability. + */ + public boolean damageTool(ItemStack tool, int damage) { + ItemMeta meta = tool.getItemMeta(); + if (meta instanceof Damageable) { + Damageable damageable = (Damageable) meta; + damageable.setDamage(damageable.getDamage() + damage); + tool.setItemMeta(meta); + return damageable.getDamage() >= tool.getType().getMaxDurability(); + } + return false; + } + + /** + * Check if a block is fully grown. + * + * @param block The block. + * @return If the block is fully grown or not. Empty if the block is not Ageable. + */ + public Optional isGrown(Block block) { + BlockData data = block.getBlockData(); + if (data instanceof Ageable) { + Ageable ageable = (Ageable) data; + return Optional.of(ageable.getAge() == ageable.getMaximumAge()); + } else { + return Optional.empty(); + } + } + + /** + * In a ring centred on a block with the given radius, locate the blocks whose material is one of the given types. + * + * @param materials The materials to search for. + * @param centre The centre block. + * @param radius The radius of the ring. + * @return The blocks in the ring whose material matches one of those searched for. + */ + public Set findRadiallyAdjacentMaterials(Collection materials, Block centre, int radius) { + Set ring = new HashSet<>(); + // Centre coordinates. + World world = centre.getWorld(); + int x = centre.getX(); + int y = centre.getY(); + int z = centre.getZ(); + // Relative to centre coordinates. + int i = -radius; + int k = -radius; + // Iterate over the columns in the given radius. + while (i < radius) { + Optional block = findHighestMaterial(materials, world, x + i, z + k, y + radius, y - radius); + block.ifPresent(ring::add); + i++; + } + while (k < radius) { + Optional block = findHighestMaterial(materials, world, x + i, z + k, y + radius, y - radius); + block.ifPresent(ring::add); + k++; + } + while (i > -radius) { + Optional block = findHighestMaterial(materials, world, x + i, z + k, y + radius, y - radius); + block.ifPresent(ring::add); + i--; + } + while (k > -radius) { + Optional block = findHighestMaterial(materials, world, x + i, z + k, y + radius, y - radius); + block.ifPresent(ring::add); + k--; + } + return ring; + } + + /** + * Find the highest block that has a material of one of the given types. + * + * @param materials The materials to search for. + * @param world The world to search in. + * @param x Block x coordinate. + * @param z Block z coordinate. + * @param highest Highest y coordinate. + * @param lowest Lowest y coordinate. + * @return The highest block of one of the materials in the column, otherwise empty. + */ + public Optional findHighestMaterial(Collection materials, World world, int x, int z, int highest, int lowest) { + int y = highest; + while (y >= lowest) { + Block block = world.getBlockAt(x, y, z); + if (materials.contains(block.getType())) { + return Optional.of(block); + } + y--; + } + return Optional.empty(); + } + + private boolean configDryFarmland() { + return this.getConfig().getBoolean(CONFIGURATION_DRY_FARMLAND, false); + } + +} diff --git a/src/main/java/no/hyp/farmingupgrade/UpgradedBlockBreakEvent.java b/src/main/java/no/hyp/farmingupgrade/UpgradedBlockBreakEvent.java index 8e99792..0ec3ede 100644 --- a/src/main/java/no/hyp/farmingupgrade/UpgradedBlockBreakEvent.java +++ b/src/main/java/no/hyp/farmingupgrade/UpgradedBlockBreakEvent.java @@ -1,13 +1,13 @@ -package no.hyp.farmingupgrade; - -import org.bukkit.block.Block; -import org.bukkit.entity.Player; -import org.bukkit.event.block.BlockBreakEvent; - -public class UpgradedBlockBreakEvent extends BlockBreakEvent { - - public UpgradedBlockBreakEvent(Block block, Player player) { - super(block, player); - } - -} +package no.hyp.farmingupgrade; + +import org.bukkit.block.Block; +import org.bukkit.entity.Player; +import org.bukkit.event.block.BlockBreakEvent; + +public class UpgradedBlockBreakEvent extends BlockBreakEvent { + + public UpgradedBlockBreakEvent(Block block, Player player) { + super(block, player); + } + +} diff --git a/src/main/java/no/hyp/farmingupgrade/UpgradedBlockFadeEvent.java b/src/main/java/no/hyp/farmingupgrade/UpgradedBlockFadeEvent.java index a328a93..2cea50f 100644 --- a/src/main/java/no/hyp/farmingupgrade/UpgradedBlockFadeEvent.java +++ b/src/main/java/no/hyp/farmingupgrade/UpgradedBlockFadeEvent.java @@ -1,13 +1,13 @@ -package no.hyp.farmingupgrade; - -import org.bukkit.block.Block; -import org.bukkit.block.BlockState; -import org.bukkit.event.block.BlockFadeEvent; - -public class UpgradedBlockFadeEvent extends BlockFadeEvent { - - public UpgradedBlockFadeEvent(Block block, BlockState newState) { - super(block, newState); - } - -} +package no.hyp.farmingupgrade; + +import org.bukkit.block.Block; +import org.bukkit.block.BlockState; +import org.bukkit.event.block.BlockFadeEvent; + +public class UpgradedBlockFadeEvent extends BlockFadeEvent { + + public UpgradedBlockFadeEvent(Block block, BlockState newState) { + super(block, newState); + } + +} diff --git a/src/main/java/no/hyp/farmingupgrade/UpgradedMoistureChangeEvent.java b/src/main/java/no/hyp/farmingupgrade/UpgradedMoistureChangeEvent.java index 4041ffa..6c0bb75 100644 --- a/src/main/java/no/hyp/farmingupgrade/UpgradedMoistureChangeEvent.java +++ b/src/main/java/no/hyp/farmingupgrade/UpgradedMoistureChangeEvent.java @@ -1,13 +1,13 @@ -package no.hyp.farmingupgrade; - -import org.bukkit.block.Block; -import org.bukkit.block.BlockState; -import org.bukkit.event.block.MoistureChangeEvent; - -public class UpgradedMoistureChangeEvent extends MoistureChangeEvent { - - public UpgradedMoistureChangeEvent(Block block, BlockState newState) { - super(block, newState); - } - -} +package no.hyp.farmingupgrade; + +import org.bukkit.block.Block; +import org.bukkit.block.BlockState; +import org.bukkit.event.block.MoistureChangeEvent; + +public class UpgradedMoistureChangeEvent extends MoistureChangeEvent { + + public UpgradedMoistureChangeEvent(Block block, BlockState newState) { + super(block, newState); + } + +} diff --git a/src/main/java/no/hyp/farmingupgrade/UpgradedPlayerInteractEvent.java b/src/main/java/no/hyp/farmingupgrade/UpgradedPlayerInteractEvent.java new file mode 100644 index 0000000..4ddc7b0 --- /dev/null +++ b/src/main/java/no/hyp/farmingupgrade/UpgradedPlayerInteractEvent.java @@ -0,0 +1,21 @@ +package no.hyp.farmingupgrade; + +import org.bukkit.block.Block; +import org.bukkit.block.BlockFace; +import org.bukkit.entity.Player; +import org.bukkit.event.block.Action; +import org.bukkit.event.player.PlayerInteractEvent; +import org.bukkit.inventory.EquipmentSlot; +import org.bukkit.inventory.ItemStack; + +public class UpgradedPlayerInteractEvent extends PlayerInteractEvent { + + public UpgradedPlayerInteractEvent(Player who, Action action, ItemStack item, Block clickedBlock, BlockFace clickedFace) { + super(who, action, item, clickedBlock, clickedFace); + } + + public UpgradedPlayerInteractEvent(Player who, Action action, ItemStack item, Block clickedBlock, BlockFace clickedFace, EquipmentSlot hand) { + super(who, action, item, clickedBlock, clickedFace, hand); + } + +} diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml new file mode 100644 index 0000000..9bc4018 --- /dev/null +++ b/src/main/resources/config.yml @@ -0,0 +1,26 @@ +# FarmingUpgrade Configuration + +# Configuration version. Do not change. +version: 1 + +# Crops are trampled instead of Farmland. +trampleCrops: true + +# Use upgraded water search to hydrate Farmland. Disable to use Vanilla hydration. +hydrationUpgrade: true + +# The horizontal radius from a Farmland to look for water. Vanilla has a radius of 4. +hydrationRange: 4 + +# The number of blocks under the Farmland to look for water. Set to 0 to only search on the same level. Vanilla has +# a depth of 0. +hydrationDepth: 2 + +# Farmland that is not hydrated will eventually turn to Dirt. true in Vanilla. +dryFarmland: false + +# Enable upgraded hoes that only break fully grown crops, and has a range. +hoeUpgrade: true + +# If hoeUpgrade is enabled, this controls whether crops are automatically replanted after being destroyed by a hoe. +hoeReplant: true \ No newline at end of file diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml index 1304654..c55cbd6 100644 --- a/src/main/resources/plugin.yml +++ b/src/main/resources/plugin.yml @@ -1,6 +1,6 @@ -name: FarmingUpgrade -author: Torm -description: Upgraded farming mechanics. -version: 1.0.0 -main: no.hyp.farmingupgrade.FarmingUpgrade +name: FarmingUpgrade +author: Torm +description: Upgraded farming mechanics. +version: 1.1.0 +main: no.hyp.farmingupgrade.FarmingUpgrade api-version: 1.13 \ No newline at end of file