diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..097f9f9 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,9 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# Linux start script should use lf +/gradlew text eol=lf + +# These are Windows script files and should use crlf +*.bat text eol=crlf + diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..b01da52 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,37 @@ +# Automatically build the project and run any configured tests for every push +# and submitted pull request. This can help catch issues that only occur on +# certain platforms or Java versions, and provides a first line of defence +# against bad commits. + +name: build +on: [pull_request, push] + +jobs: + build: + strategy: + matrix: + # Use these Java versions + java: [ + 21, # Current Java LTS + ] + runs-on: ubuntu-22.04 + steps: + - name: checkout repository + uses: actions/checkout@v4 + - name: validate gradle wrapper + uses: gradle/wrapper-validation-action@v2 + - name: setup jdk ${{ matrix.java }} + uses: actions/setup-java@v4 + with: + java-version: ${{ matrix.java }} + distribution: 'microsoft' + - name: make gradle wrapper executable + run: chmod +x ./gradlew + - name: build + run: ./gradlew build + - name: capture build artifacts + if: ${{ matrix.java == '21' }} # Only upload artifacts built from latest java + uses: actions/upload-artifact@v4 + with: + name: Artifacts + path: build/libs/ \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c476faf --- /dev/null +++ b/.gitignore @@ -0,0 +1,40 @@ +# gradle + +.gradle/ +build/ +out/ +classes/ + +# eclipse + +*.launch + +# idea + +.idea/ +*.iml +*.ipr +*.iws + +# vscode + +.settings/ +.vscode/ +bin/ +.classpath +.project + +# macos + +*.DS_Store + +# fabric + +run/ + +# java + +hs_err_*.log +replay_*.log +*.hprof +*.jfr diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e72bfdd --- /dev/null +++ b/LICENSE @@ -0,0 +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 +. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..7d68f37 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# Features + - [ ] Fix 3D overlay \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..344b827 --- /dev/null +++ b/build.gradle @@ -0,0 +1,80 @@ +plugins { + id 'fabric-loom' version '1.7-SNAPSHOT' + id 'maven-publish' +} + +version = project.mod_version +group = project.maven_group + +base { + archivesName = project.archives_base_name +} + +repositories { + // Add repositories to retrieve artifacts from in here. + // You should only use this when depending on other mods because + // Loom adds the essential maven repositories to download Minecraft and libraries from automatically. + // See https://docs.gradle.org/current/userguide/declaring_repositories.html + // for more information about repositories. +} + +fabricApi { + configureDataGeneration() +} + +dependencies { + // To change the versions see the gradle.properties file + minecraft "com.mojang:minecraft:${project.minecraft_version}" + mappings "net.fabricmc:yarn:${project.yarn_mappings}:v2" + modImplementation "net.fabricmc:fabric-loader:${project.loader_version}" + + // Fabric API. This is technically optional, but you probably want it anyway. + modImplementation "net.fabricmc.fabric-api:fabric-api:${project.fabric_version}" + +} + +processResources { + inputs.property "version", project.version + + filesMatching("fabric.mod.json") { + expand "version": project.version + } +} + +tasks.withType(JavaCompile).configureEach { + it.options.release = 21 +} + +java { + // Loom will automatically attach sourcesJar to a RemapSourcesJar task and to the "build" task + // if it is present. + // If you remove this line, sources will not be generated. + withSourcesJar() + + sourceCompatibility = JavaVersion.VERSION_21 + targetCompatibility = JavaVersion.VERSION_21 +} + +jar { + from("LICENSE") { + rename { "${it}_${project.base.archivesName.get()}"} + } +} + +// configure the maven publication +publishing { + publications { + create("mavenJava", MavenPublication) { + artifactId = project.archives_base_name + from components.java + } + } + + // See https://docs.gradle.org/current/userguide/publishing_maven.html for information on how to set up publishing. + repositories { + // Add repositories to publish to here. + // Notice: This block does NOT have the same function as the block in the top level. + // The repositories here will be used for publishing your artifact, not for + // retrieving dependencies. + } +} \ No newline at end of file diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..e21446b --- /dev/null +++ b/gradle.properties @@ -0,0 +1,17 @@ +# Done to increase the memory available to gradle. +org.gradle.jvmargs=-Xmx1G +org.gradle.parallel=true + +# Fabric Properties +# check these on https://fabricmc.net/develop +minecraft_version=1.21 +yarn_mappings=1.21+build.9 +loader_version=0.15.11 + +# Mod Properties +mod_version=1.0.0 +maven_group=net.orange.horsedebugext +archives_base_name=horsedebugext + +# Fabric API +fabric_version=0.102.0+1.21 \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..e644113 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..a441313 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..b740cf1 --- /dev/null +++ b/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..25da30d --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@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=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@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" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +: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 %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 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! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..75c4d72 --- /dev/null +++ b/settings.gradle @@ -0,0 +1,10 @@ +pluginManagement { + repositories { + maven { + name = 'Fabric' + url = 'https://maven.fabricmc.net/' + } + mavenCentral() + gradlePluginPortal() + } +} \ No newline at end of file diff --git a/src/main/java/net/orange/horsedebugext/BuildAPI.java b/src/main/java/net/orange/horsedebugext/BuildAPI.java new file mode 100644 index 0000000..5b5ab5a --- /dev/null +++ b/src/main/java/net/orange/horsedebugext/BuildAPI.java @@ -0,0 +1,8 @@ +package net.orange.horsedebugext; + +public interface BuildAPI { + /** + * the API name (Rift, Forge, (...)) + */ + public String getAPIName(); +} diff --git a/src/main/java/net/orange/horsedebugext/HorseDebug.java b/src/main/java/net/orange/horsedebugext/HorseDebug.java new file mode 100644 index 0000000..afb5b8c --- /dev/null +++ b/src/main/java/net/orange/horsedebugext/HorseDebug.java @@ -0,0 +1,14 @@ +package net.orange.horsedebugext; + +import net.fabricmc.api.ModInitializer; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class HorseDebug implements ModInitializer { + public static final String MOD_ID = "horsedebugext"; + public static final Logger LOGGER = LoggerFactory.getLogger(MOD_ID); + @Override + public void onInitialize() { + + } +} diff --git a/src/main/java/net/orange/horsedebugext/HorseDebugClient.java b/src/main/java/net/orange/horsedebugext/HorseDebugClient.java new file mode 100644 index 0000000..0cebb5a --- /dev/null +++ b/src/main/java/net/orange/horsedebugext/HorseDebugClient.java @@ -0,0 +1,36 @@ +package net.orange.horsedebugext; + +import net.fabricmc.api.ClientModInitializer; +import net.fabricmc.fabric.api.client.event.lifecycle.v1.ClientTickEvents; +import net.fabricmc.fabric.api.client.rendering.v1.HudRenderCallback; +import net.fabricmc.fabric.api.client.rendering.v1.WorldRenderContext; +import net.fabricmc.fabric.api.client.rendering.v1.WorldRenderEvents; +import net.minecraft.client.gui.DrawContext; +import net.minecraft.client.render.RenderTickCounter; + +public class HorseDebugClient implements ClientModInitializer, HudRenderCallback, BuildAPI, WorldRenderEvents.AfterEntities { + + private final HorseDebugMain mod; + + public HorseDebugClient() { this.mod = HorseDebugMain.registerAPI(this); } + public String getAPIName() { return "Fabric"; } + + + @Override + public void onInitializeClient() { + HudRenderCallback.EVENT.register(this); + WorldRenderEvents.AFTER_ENTITIES.register(this); + ClientTickEvents.END_CLIENT_TICK.register(client -> mod.onKey()); + mod.setup(); + } + + @Override + public void onHudRender(DrawContext drawContext, RenderTickCounter tickCounter) { + mod.renderOverlay(drawContext, tickCounter); + } + + @Override + public void afterEntities(WorldRenderContext context) { + mod.renderWorld(context.world().getEntities(), context.matrixStack(), context.camera(), context.consumers()); + } +} diff --git a/src/main/java/net/orange/horsedebugext/HorseDebugMain.java b/src/main/java/net/orange/horsedebugext/HorseDebugMain.java new file mode 100644 index 0000000..9c28096 --- /dev/null +++ b/src/main/java/net/orange/horsedebugext/HorseDebugMain.java @@ -0,0 +1,466 @@ +package net.orange.horsedebugext; + +import com.google.common.collect.Lists; +import net.fabricmc.fabric.api.client.keybinding.v1.KeyBindingHelper; +import net.minecraft.client.MinecraftClient; +import net.minecraft.client.font.TextRenderer; +import net.minecraft.client.gui.DrawContext; +import net.minecraft.client.gui.screen.ingame.InventoryScreen; +import net.minecraft.client.network.ClientPlayerEntity; +import net.minecraft.client.option.KeyBinding; +import net.minecraft.client.render.Camera; +import net.minecraft.client.render.RenderTickCounter; +import net.minecraft.client.render.VertexConsumerProvider; +import net.minecraft.client.resource.language.I18n; +import net.minecraft.client.util.InputUtil; +import net.minecraft.client.util.Window; +import net.minecraft.client.util.math.MatrixStack; +import net.minecraft.entity.Entity; +import net.minecraft.entity.EntityType; +import net.minecraft.entity.LivingEntity; +import net.minecraft.entity.attribute.EntityAttribute; +import net.minecraft.entity.attribute.EntityAttributeInstance; +import net.minecraft.entity.attribute.EntityAttributes; +import net.minecraft.entity.passive.*; +import net.minecraft.registry.Registries; +import net.minecraft.registry.entry.RegistryEntry; +import net.minecraft.text.Text; +import net.minecraft.util.Formatting; +import net.minecraft.util.Identifier; +import net.minecraft.util.hit.EntityHitResult; +import net.minecraft.util.hit.HitResult; +import net.minecraft.util.math.Box; +import net.minecraft.util.math.Vec3d; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import org.joml.Matrix4f; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; +import java.util.Properties; + +public class HorseDebugMain { + public static final String UTF8_STAR = "\u2B50"; + public static final String UTF8_HEART = "\u2764"; + private static final Logger log = LogManager.getLogger("HorseDebug"); + private static HorseDebugMain instance; + + public static void log(String message) { + log.info("[" + log.getName() + "] " + message); + } + + private static double getBaseValue(LivingEntity entity, EntityAttribute attribute) { + RegistryEntry registryEntry = RegistryEntry.of(attribute); + EntityAttributeInstance inst = entity.getAttributeInstance(registryEntry); + if (inst == null) { + return attribute.getDefaultValue(); + } + return inst.getBaseValue(); + } + + /** + * get this mod + */ + public static HorseDebugMain getMod() { + return instance; + } + + /** + * true if an API is already register for it + */ + public static boolean isAPIRegister() { + return instance != null; + } + + /** + * register an API for HorseDebug + * + * @throws IllegalStateException if an API is already register for it + */ + public static HorseDebugMain registerAPI(BuildAPI api) throws IllegalStateException { + instance = new HorseDebugMain(); + log("Starting HorseDebug with " + api.getAPIName()); + return instance; + } + + public static String getHorseColorNameDescription(HorseColor color) { + return switch (color.getId()) { + case 0 -> "white"; + case 1 -> "creamy"; + case 2 -> "chestnut"; + case 3 -> "brown"; + case 4 -> "black"; + case 5 -> "gray"; + case 6 -> "darkbrown"; + default -> "unknown"; + }; + } + + public static String getHorseColorNameDescription(HorseMarking color) { + return switch (color.getId()) { + case 0 -> "none"; + case 1 -> "white"; + case 2 -> "white_field"; + case 3 -> "white_dots"; + case 4 -> "black_dots"; + default -> "unknown"; + }; + } + + public static String getHorseColorName(HorseColor color, HorseMarking marking) { + return I18n.translate("gui.act.invView.horse.variant." + getHorseColorNameDescription(color)) + " / " + + I18n.translate("gui.act.invView.horse.variant.marking." + getHorseColorNameDescription(marking)); + } + + public static String getCatColorName(CatVariant color) { + Identifier id = Registries.CAT_VARIANT.getId(color); + if (id == null) { + return I18n.translate("gui.act.invView.cat.variant.unknown"); + } + return I18n.translate("gui.act.invView.cat.variant." + id.getPath()); + } + + private boolean show3DOverlay; + private KeyBinding configKey; + + private HorseDebugMain() { + if (isAPIRegister()) + throw new IllegalStateException("An API is already register for this mod!"); + } + + public static final StatValue STAT_HEALTH = StatValue.builder().base(15.0).add(8).add(9).showScale(0.5) + .build(); + public static final StatValue STAT_JUMP = StatValue.builder().base(0.4000000059604645D).add(0.2).add(0.2).add( + 0.2).showFunc(d -> -0.2 * Math.pow(d, 3) + 3.7 * Math.pow(d, 2) + 2.1 * d - 0.4) + .build(); + public static final StatValue STAT_SPEED = StatValue.builder().base(0.44999998807907104D).add(0.3).add(0.3).add(0.3) + .scale(0.25).showScale(43).build(); + + /** + * @deprecated use {@link #STAT_HEALTH} instead + */ + @Deprecated + public static final double BAD_HP = STAT_HEALTH.getBadValue(); + /** + * @deprecated use {@link #STAT_JUMP} instead + */ + @Deprecated + public static final double BAD_JUMP = STAT_JUMP.getBadValue(); + /** + * @deprecated use {@link #STAT_HEALTH} instead + */ + @Deprecated + public static final double BAD_SPEED = STAT_SPEED.getBadValue(); + /** + * @deprecated use {@link #STAT_HEALTH} instead + */ + @Deprecated + public static final double EXELLENT_HP = STAT_HEALTH.getExcellentValue(); + /** + * @deprecated use {@link #STAT_JUMP} instead + */ + @Deprecated + public static final double EXELLENT_JUMP = STAT_JUMP.getExcellentValue(); + /** + * @deprecated use {@link #STAT_HEALTH} instead + */ + @Deprecated + public static final double EXELLENT_SPEED = STAT_HEALTH.getExcellentValue(); + + public void drawInventory(DrawContext dContext, MinecraftClient mc, int posX, int posY, String[] addText, + LivingEntity entity) { + + int l = addText.length; + if (l == 0) + return; + int sizeX = 0; + int sizeY = 0; + for (String s : addText) { + sizeY += mc.textRenderer.fontHeight + 1; + int a = mc.textRenderer.getWidth(s) + 10; + if (a > sizeX) + sizeX = a; + } + if (entity != null) { + sizeX += 100; + if (sizeY < 100) + sizeY = 100; + } + Window mw = mc.getWindow(); + DrawContext drawContext = new DrawContext(mc, mc.getBufferBuilders().getEffectVertexConsumers()); + posX += 5; + posY += 5; + if (posX + sizeX > mw.getScaledWidth()) + posX -= sizeX + 10; + if (posY + sizeY > mw.getScaledHeight()) + posY -= sizeY + 10; + int posY1 = posY + 5; + for (String s : addText) { + drawContext.drawTextWithShadow(mc.textRenderer, s, posX + 5, posY1, 0xffffffff); + posY1 += (mc.textRenderer.fontHeight + 1); + } + if (entity != null) { + int entitySize = (int) (120 / getCornerLength(entity.getBoundingBox())); + InventoryScreen.drawEntity(dContext, posX + sizeX - 55, posY + sizeY + 105, posX + sizeX - 55 + sizeX, posY + sizeY + 105 + sizeY, entitySize, 0, 50, 50, entity); + } + } + + private static double getJump(LivingEntity e) { + return getBaseValue(e, EntityAttributes.GENERIC_JUMP_STRENGTH.value()); + } + + public String[] getEntityData(LivingEntity entity) { + List text = Lists.newArrayList(); + text.add("\u00a7b" + entity.getDisplayName().getString()); + text.add("\u00a77" + EntityType.getId(entity.getType()).toString()); + + if (entity instanceof CatEntity cat) { + var color = cat.getVariant(); + text.add(I18n.translate("gui.act.invView.horse.variant") + ": " + getCatColorName(color.value()) + " (" + Registries.CAT_VARIANT.getId(color.value()) + + ")"); + } else if (entity instanceof SheepEntity sheep) { + var color = sheep.getColor(); + text.add(I18n.translate("gui.act.invView.horse.variant") + ": " + color.getName() + " (" + color.getId() + ")"); + } else if (entity instanceof AbstractHorseEntity baby) { + if (baby instanceof HorseEntity horse) { + var color = horse.getVariant(); + var markings = horse.getMarking(); + var id = color.getId() + markings.getId() << 8; + text.add(I18n.translate("gui.act.invView.horse.variant") + ": " + getHorseColorName(color, markings) + " (" + + id + ")"); + } + + text.add(I18n.translate("gui.act.invView.horse.jump") + ": " + + STAT_JUMP.getFormattedText(getJump(baby))); + text.add(I18n.translate("gui.act.invView.horse.speed") + ": " + + STAT_SPEED.getFormattedText(getBaseValue(baby, EntityAttributes.GENERIC_MOVEMENT_SPEED.value())) + + " m/s " + "(" + significantNumbers(getBaseValue(baby, EntityAttributes.GENERIC_MOVEMENT_SPEED.value())) + + " iu)"); + text.add(I18n.translate("gui.act.invView.horse.health") + ": " + + STAT_HEALTH.getFormattedText((baby.getMaxHealth())) + " HP"); + } + return text.toArray(String[]::new); + } + + public static String significantNumbers(double d) { + boolean negative = d < 0; + if (negative) { + d *= -1; + } + int d1 = (int) (d); + d %= 1; + String s = String.format("%.3G", d); + if (s.length() > 0) + s = s.substring(1); + if (s.contains("E+")) + s = String.format(Locale.US, "%.0f", Double.valueOf(String.format("%.3G", d))); + return (negative ? "-" : "") + d1 + s; + } + + public void renderOverlay(DrawContext drawContext, RenderTickCounter tickCounter) { + MinecraftClient mc = MinecraftClient.getInstance(); + if (!mc.getDebugHud().shouldShowDebugHud()) + return; + Window mw = mc.getWindow(); + if (mc.player.getVehicle() instanceof AbstractHorseEntity baby) { + drawInventory(drawContext, mc, mw.getScaledWidth(), mw.getScaledHeight(), getEntityData(baby), baby); + } else { + HitResult obj = mc.crosshairTarget; + if (obj instanceof EntityHitResult eo) { + if (eo.getEntity() instanceof LivingEntity) + drawInventory(drawContext, mc, mw.getScaledWidth(), mw.getScaledHeight(), + getEntityData((LivingEntity) eo.getEntity()), (LivingEntity) eo.getEntity()); + } + } + } + + /** + * sum the 3 normalized values of jump/health/speed + * + * @param jump the jump power + * @param health the health + * @param speed the speed + * @return a score + */ + public double score(double jump, double health, double speed) { + return STAT_JUMP.normalized(jump) + STAT_HEALTH.normalized(health) + STAT_SPEED.normalized(speed); + } + + public void renderWorld(Iterable entities, MatrixStack matrices, + Camera camera, VertexConsumerProvider source) { + if (!show3DOverlay) { + return; + } + List horses = new ArrayList<>(); + double bestScore = 0; + double bestJump = 0; + double bestSpeed = 0; + double bestHealth = 0; + + MinecraftClient mc = MinecraftClient.getInstance(); + ClientPlayerEntity player = mc.player; + if (player == null) { + return; + } + + for (Entity entity : entities) + if (entity instanceof AbstractHorseEntity h) { + + double distance = player.getPos().squaredDistanceTo(h.getPos()); + + if (distance > 4096.0D) { + continue; + } + + horses.add(h); + + double jump = getJump(h); + double health = h.getMaxHealth(); + double speed = getBaseValue(h, EntityAttributes.GENERIC_MOVEMENT_SPEED.value()); + double score = score(jump, health, speed); + + + if (jump > bestJump) { + bestJump = jump; + } + if (health > bestHealth) { + bestHealth = health; + } + if (speed > bestSpeed) { + bestSpeed = speed; + } + if (score > bestScore) { + bestScore = score; + } + } + TextRenderer textRenderer = mc.textRenderer; + float opacity = mc.options.getTextBackgroundOpacity(0.25F); + + Text[] texts = new Text[4]; + + for (AbstractHorseEntity h : horses) { + double jump = getJump(h); + double health = h.getMaxHealth(); + double speed = getBaseValue(h, EntityAttributes.GENERIC_MOVEMENT_SPEED.value()); + double score = score(jump, health, speed); + + texts[0] = Text.literal(STAT_JUMP.getFormattedText(jump, " b", jump >= bestJump)); + texts[1] = Text.literal( + STAT_HEALTH.getFormattedText(health, " " + Formatting.RED + UTF8_HEART, health >= bestHealth)); + texts[2] = Text.literal(STAT_SPEED.getFormattedText(speed, " m/s", speed >= bestSpeed)); + + if (score >= bestScore) { + texts[3] = Text.literal(Formatting.YELLOW + "" + UTF8_STAR); + } else { + texts[3] = null; + } + + float textHeight = h.getHeight() + 0.5F; + + Entity e = h; + + while (!e.getPassengerList().isEmpty()) { + e = e.getPassengerList().get(0); + } + + double textY = e.getY(); + + matrices.push(); + matrices.translate(h.getX() - camera.getPos().x, textY - camera.getPos().y + textHeight, + h.getZ() - camera.getPos().z); + matrices.multiply(camera.getRotation()); + matrices.scale(-0.025F, -0.025F, 0.025F); + Matrix4f matrix4f = matrices.peek().getPositionMatrix(); + ; + int background = (int) (opacity * 255.0F) << 24; + int y = (h.hasCustomName() ? -(textRenderer.fontHeight + 4) : 0); + for (Text text : texts) { + if (text == null) { + continue; + } + + float x = (float) (-textRenderer.getWidth(text) / 2); + textRenderer.draw(text, + x, (float) y, 0x22FFFFFF, false, matrix4f, source, TextRenderer.TextLayerType.NORMAL, background, 15728880); + textRenderer.draw(text, + x, (float) y, 0xffFFFFFF, false, matrix4f, source, TextRenderer.TextLayerType.NORMAL, 0, 15728880); + + y -= textRenderer.fontHeight + 2; + } + + matrices.pop(); + } + } + + public void setup() { + log("Initialization"); + + configKey = new KeyBinding("gui.act.invView.horse", InputUtil.UNKNOWN_KEY.getCode(), "key.categories.horsedebug"); + KeyBindingHelper.registerKeyBinding(configKey); + + syncConfig(); + } + + public void onKey() { + if (configKey.wasPressed()) { + setShow3DOverlay(!isShow3DOverlay()); + } + } + + public void setShow3DOverlay(boolean show3DOverlay) { + this.show3DOverlay = show3DOverlay; + saveConfig(); + } + + public boolean isShow3DOverlay() { + return show3DOverlay; + } + + public void syncConfig() { + Properties prop = new Properties(); + try (InputStream stream = Files.newInputStream(getConfigFile())) { + prop.load(stream); + } catch (IOException | IllegalArgumentException e) { + // ignore + } + + show3DOverlay = String.valueOf(prop.getOrDefault("show3DOverlay", show3DOverlay)).equals("true"); + + saveConfig(); + } + + public void saveConfig() { + Properties prop = new Properties(); + prop.setProperty("show3DOverlay", String.valueOf(show3DOverlay)); + + try (OutputStream stream = Files.newOutputStream(getConfigFile())) { + prop.store(stream, ""); + } catch (IOException | IllegalArgumentException e) { + // ignore + } + } + + public Path getConfigFile() { + return MinecraftClient.getInstance().runDirectory.toPath().resolve("horsedebug.cfg"); + } + + + public Vec3d getMinVec(Box box) { + return new Vec3d(box.minX, box.minY, box.minZ); + } + + public Vec3d getMaxVec(Box box) { + return new Vec3d(box.maxX, box.maxY, box.maxZ); + } + + public double getCornerLength(Box box) { + return getMinVec(box).distanceTo(getMaxVec(box)); + } + +} diff --git a/src/main/java/net/orange/horsedebugext/StatValue.java b/src/main/java/net/orange/horsedebugext/StatValue.java new file mode 100644 index 0000000..f0b6d4a --- /dev/null +++ b/src/main/java/net/orange/horsedebugext/StatValue.java @@ -0,0 +1,179 @@ +package net.orange.horsedebugext; + +import net.minecraft.util.Formatting; + +import java.util.function.DoubleFunction; + +public class StatValue { + public static class StatValueBuilder { + private double base = 0; + private double scale = 1; + private double added = 0; + private DoubleFunction showFunction = d -> d; + + private StatValueBuilder() { + } + + /** + * add to the base + * + * @param base the value to add + * @return the builder + */ + public StatValueBuilder base(double base) { + this.base += base; + return this; + } + + /** + * scale the stat + * + * @param scale the value to scale + * @return the builder + */ + public StatValueBuilder scale(double scale) { + this.scale *= scale; + return this; + } + + /** + * scale the stat when formatting + * + * @param scale the value to scale + * @return the builder + */ + public StatValueBuilder showScale(double scale) { + return showFunc(d -> d * scale); + } + + /** + * scale the stat when formatting + * + * @param showFunction the function + * @return the builder + */ + public StatValueBuilder showFunc(DoubleFunction showFunction) { + this.showFunction = showFunction; + return this; + } + + /** + * add to the base + * + * @param value the value to add + * @return the builder + */ + public StatValueBuilder add(double value) { + this.added += value; + return this; + } + + /** + * build the StatValue + * + * @return the statvalue + */ + public StatValue build() { + double min = base * scale; + double max = (base + added) * scale; + return new StatValue(min, max, showFunction); + } + } + + /** + * @return a builder of StatValue + */ + public static StatValueBuilder builder() { + return new StatValueBuilder(); + } + + private final double min; + private final double max; + private final DoubleFunction showFunction; + + private StatValue(double min, double max, DoubleFunction showFunction) { + this.min = min; + this.max = max; + this.showFunction = showFunction; + } + + /** + * @return the maximum value + */ + public double getMax() { + return max; + } + + /** + * @return the average value + */ + public double getAverage() { + return (max + min) / 2; + } + + /** + * @return the minimum value + */ + public double getMin() { + return min; + } + + /** + * @return the scale + */ + public double getScale() { + return max - min; + } + + /** + * normalize a value + * + * @param value the value to normalize + * @return the normalize value + */ + public double normalized(double value) { + return value / getScale(); + } + + /** + * @return the minimum 80% + */ + public double getBadValue() { + return getMin() + getScale() / 5; + } + + /** + * @return the top 20% + */ + public double getExcellentValue() { + return getMax() - getScale() / 5; + } + + /** + * format a value with this stat + * + * @param value the value to format + * @return the formatted value + */ + public String getFormattedText(double value) { + return getFormattedText(value, "", false); + } + + /** + * + * format a value with this stat + * + * @param value the value to format + * @param unit the unit to format + * @param stared if the value is stared + * @return the formatted value + */ + public String getFormattedText(double value, String unit, boolean stared) { + return (value >= getExcellentValue() ? Formatting.GOLD + : (value <= getBadValue()) ? Formatting.RED : Formatting.GREEN) + + HorseDebugMain.significantNumbers(showFunction.apply(value)) + + unit + + (stared ? (Formatting.YELLOW + " " + HorseDebugMain.UTF8_STAR) : ""); + } + +} \ No newline at end of file diff --git a/src/main/java/net/orange/horsedebugext/mixin/ExampleMixin.java b/src/main/java/net/orange/horsedebugext/mixin/ExampleMixin.java new file mode 100644 index 0000000..836ef61 --- /dev/null +++ b/src/main/java/net/orange/horsedebugext/mixin/ExampleMixin.java @@ -0,0 +1,15 @@ +package net.orange.horsedebugext.mixin; + +import net.minecraft.server.MinecraftServer; +import org.spongepowered.asm.mixin.Mixin; +import org.spongepowered.asm.mixin.injection.At; +import org.spongepowered.asm.mixin.injection.Inject; +import org.spongepowered.asm.mixin.injection.callback.CallbackInfo; + +@Mixin(MinecraftServer.class) +public class ExampleMixin { + @Inject(at = @At("HEAD"), method = "loadWorld") + private void init(CallbackInfo info) { + // This code is injected into the start of MinecraftServer.loadWorld()V + } +} \ No newline at end of file diff --git a/src/main/resources/assets/horsedebugext/icon.png b/src/main/resources/assets/horsedebugext/icon.png new file mode 100644 index 0000000..365ad32 Binary files /dev/null and b/src/main/resources/assets/horsedebugext/icon.png differ diff --git a/src/main/resources/assets/horsedebugext/lang/en_us.json b/src/main/resources/assets/horsedebugext/lang/en_us.json new file mode 100644 index 0000000..ae6e41c --- /dev/null +++ b/src/main/resources/assets/horsedebugext/lang/en_us.json @@ -0,0 +1,38 @@ +{ + "gui.act.invView.horse.jump": "Jump", + "gui.act.invView.horse.speed": "Speed", + "gui.act.invView.horse.health": "Health", + "gui.act.invView.horse.variant": "Variant", + + "gui.act.invView.horse.variant.white": "White", + "gui.act.invView.horse.variant.creamy": "Creamy", + "gui.act.invView.horse.variant.chestnut": "Chestnut", + "gui.act.invView.horse.variant.brown": "Brown", + "gui.act.invView.horse.variant.black": "Black", + "gui.act.invView.horse.variant.gray": "Gray", + "gui.act.invView.horse.variant.darkbrown": "Darkbrown", + "gui.act.invView.horse.variant.unknown": "Unknown", + + "gui.act.invView.horse.variant.marking.none": "None", + "gui.act.invView.horse.variant.marking.white": "White", + "gui.act.invView.horse.variant.marking.white_field": "White field", + "gui.act.invView.horse.variant.marking.white_dots": "White dots", + "gui.act.invView.horse.variant.marking.black_dots": "Black dots", + "gui.act.invView.horse.variant.marking.unknown": "Unknown", + + "gui.act.invView.cat.variant.tabby": "Tabby", + "gui.act.invView.cat.variant.black": "Black", + "gui.act.invView.cat.variant.red": "Red", + "gui.act.invView.cat.variant.siamese": "Siamese", + "gui.act.invView.cat.variant.british_shorthair": "British shorthair", + "gui.act.invView.cat.variant.calico": "Calico", + "gui.act.invView.cat.variant.persian": "Persian", + "gui.act.invView.cat.variant.ragdoll": "Ragdoll", + "gui.act.invView.cat.variant.white": "White", + "gui.act.invView.cat.variant.jellie": "Jellie", + "gui.act.invView.cat.variant.all_black": "All black", + "gui.act.invView.cat.variant.unknown": "Unknown", + + "key.categories.horsedebug": "Horse Debug", + "gui.act.invView.horse": "Toggle 3D overlay" +} diff --git a/src/main/resources/fabric.mod.json b/src/main/resources/fabric.mod.json new file mode 100644 index 0000000..2049212 --- /dev/null +++ b/src/main/resources/fabric.mod.json @@ -0,0 +1,39 @@ +{ + "schemaVersion": 1, + "id": "horsedebugext", + "version": "${version}", + "name": "Horse Debug Extended", + "description": "Minecraft mod to get information about entities", + "authors": [ + "ATE47", + "OrangevichHeh" + ], + "contact": { + "homepage": "https://github.com/ate47/HorseInfo/", + "sources": "https://github.com/orangevichHeh/HorseDebugExt/tree/1.21-fabric", + "issues": "https://github.com/orangevichHeh/HorseDebugExt/issues" + }, + "license": "GNU GPL3", + "icon": "assets/horsedebugext/icon.png", + "environment": "*", + "entrypoints": { + "main": [ + "net.orange.horsedebugext.HorseDebug" + ], + "client": [ + "net.orange.horsedebugext.HorseDebugClient" + ] + }, + "mixins": [ + "horsedebugext.mixins.json" + ], + "depends": { + "fabricloader": ">=0.15.11", + "minecraft": "~1.21", + "java": ">=21", + "fabric-api": "*" + }, + "suggests": { + "another-mod": "*" + } +} \ No newline at end of file diff --git a/src/main/resources/horsedebugext.mixins.json b/src/main/resources/horsedebugext.mixins.json new file mode 100644 index 0000000..a2fdde9 --- /dev/null +++ b/src/main/resources/horsedebugext.mixins.json @@ -0,0 +1,11 @@ +{ + "required": true, + "package": "net.orange.horsedebugext.mixin", + "compatibilityLevel": "JAVA_21", + "mixins": [ + "ExampleMixin" + ], + "injectors": { + "defaultRequire": 1 + } +} \ No newline at end of file