diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..8f93929 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,43 @@ +# 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: + - workflow_call + - workflow_dispatch + +jobs: + build: + strategy: + matrix: + # Use these Java versions + java: [ + 17, # Current Java LTS & minimum supported by Minecraft + 21, # Current Java LTS + ] + # and run on both Linux and Windows + os: [ubuntu-22.04, windows-2022] + runs-on: ${{ matrix.os }} + steps: + - name: checkout repository + uses: actions/checkout@v4 + - name: validate gradle wrapper + uses: gradle/wrapper-validation-action@v1 + - name: setup jdk ${{ matrix.java }} + uses: actions/setup-java@v4 + with: + java-version: ${{ matrix.java }} + distribution: 'microsoft' + - name: make gradle wrapper executable + if: ${{ runner.os != 'Windows' }} + run: chmod +x ./gradlew + - name: build + run: ./gradlew build + - name: capture build artifacts + if: ${{ runner.os == 'Linux' && matrix.java == '21' }} # Only upload artifacts built from latest java on one OS + uses: actions/upload-artifact@v4.3.0 + with: + name: Artifacts + path: build/libs/ diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..1331cec --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,26 @@ +name: release +on: + push: + tags: + - '*' + +jobs: + build: + uses: ./.github/workflows/build.yml + release: + needs: [ build ] + runs-on: ubuntu-22.04 + permissions: + contents: write + steps: + - name: Download artifacts + uses: actions/download-artifact@v4.1.1 + with: + name: Artifacts + path: ./ + - name: Draft release + uses: ncipollo/release-action@v1.13.0 + with: + artifacts: ./*.jar + artifactErrorsFailBuild: true + draft: true 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..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ff5c238 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Cloth Gamerules Screen + +A complete reimplementation of the gamerules menu using **[Cloth Config API](https://modrinth.com/mod/cloth-config)**. + +This aims to make this menu more convenient to use, by bringing it some of Cloth's functionalities. Notably: +- Search gamerules by name or by key +- Reset button for each rule. +- Filter rules by mod + + +## Integration +### Gamerules +Mod developpers don't need to take any action to ensure their gamerules show up in this screen. + +In order to figure out which mod a rule belongs to, this menu uses the namespace of the rule's category. Rules that use vanilla categories will inevitably be sorted into the vanilla gamerules. + +### Menus +**This mod only replaces the gamerule screen on New World creation**. If other mods use the gamerule screen in other places, they will need to check for this mod's installation, and make the swap on their end. diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..eb760fa --- /dev/null +++ b/build.gradle @@ -0,0 +1,98 @@ +plugins { + id 'fabric-loom' version '1.5-SNAPSHOT' + id 'maven-publish' +} + +version = "${project.mod_version}+${project.minecraft_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. + maven { url "https://maven.shedaniel.me/" } + maven { url "https://maven.terraformersmc.com/releases/" } + + maven { + name = "Modrinth" + url = "https://api.modrinth.com/maven" + } +} + +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}" + + // Uncomment the following line to enable the deprecated Fabric API modules. + // These are included in the Fabric API production distribution and allow you to update your mod to the latest modules at a later more convenient time. + + // modImplementation "net.fabricmc.fabric-api:fabric-api-deprecated:${project.fabric_version}" + + modApi "com.terraformersmc:modmenu:${project.modmenu_version}" + modApi("me.shedaniel.cloth:cloth-config-fabric:${project.cloth_version}") { + exclude(group: "net.fabricmc.fabric-api") + } + + // Optional dependencies + modImplementation "maven.modrinth:preferred-gamerules:${project.preferredGamerules_version}" + modCompileOnly "maven.modrinth:packrule-menus:${project.packruleMenu_version}" +} + +processResources { + inputs.property "version", project.version + + filesMatching("fabric.mod.json") { + expand "version": project.version + } + + exclude "**/*.xcf" +} + +tasks.withType(JavaCompile).configureEach { + // Minecraft 1.18 (1.18-pre2) upwards uses Java 17. + it.options.release = 17 +} + +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_17 + targetCompatibility = JavaVersion.VERSION_17 +} + +jar { + from("LICENSE") { + rename { "${it}_${project.base.archivesName.get()}"} + } +} + +// configure the maven publication +publishing { + publications { + mavenJava(MavenPublication) { + 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. + } +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..cb6c73e --- /dev/null +++ b/gradle.properties @@ -0,0 +1,25 @@ +# 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.19.4 +yarn_mappings=1.19.4+build.2 +loader_version=0.15.7 + +#Fabric api +fabric_version=0.87.2+1.19.4 + +# Mod Properties +mod_version=1.0.0 +maven_group=tk.estecka.cloth-gamerules +archives_base_name=cloth-gamerules + +# Dependencies +cloth_version=10.1.117 + +# Optional Dependencies +modmenu_version=6.3.1 +preferredGamerules_version=1.0.0+1.19.4 +packruleMenu_version=1.1.0+1.19.4 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..d64cd49 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..1af9e09 --- /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.5-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..1aa94a4 --- /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/subprojects/plugins/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..93e3f59 --- /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. +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 execute + +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 + +: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/tk/estecka/clothgamerules/ClothGamerules.java b/src/main/java/tk/estecka/clothgamerules/ClothGamerules.java new file mode 100644 index 0000000..a2a0dda --- /dev/null +++ b/src/main/java/tk/estecka/clothgamerules/ClothGamerules.java @@ -0,0 +1,12 @@ +package tk.estecka.clothgamerules; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import net.fabricmc.loader.api.FabricLoader; + +public class ClothGamerules +{ + static public final Logger LOGGER = LoggerFactory.getLogger("cloth-gamerules"); + + static public final boolean IS_PREFRULE_INSTALLED = FabricLoader.getInstance().isModLoaded("preferred-gamerules"); +} diff --git a/src/main/java/tk/estecka/clothgamerules/GamerulesMenuFactory.java b/src/main/java/tk/estecka/clothgamerules/GamerulesMenuFactory.java new file mode 100644 index 0000000..50cd784 --- /dev/null +++ b/src/main/java/tk/estecka/clothgamerules/GamerulesMenuFactory.java @@ -0,0 +1,182 @@ +package tk.estecka.clothgamerules; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.function.Consumer; +import org.jetbrains.annotations.Nullable; +import me.shedaniel.clothconfig2.api.AbstractConfigListEntry; +import me.shedaniel.clothconfig2.api.ConfigBuilder; +import me.shedaniel.clothconfig2.api.ConfigCategory; +import me.shedaniel.clothconfig2.api.ConfigEntryBuilder; +import me.shedaniel.clothconfig2.gui.entries.TextListEntry; +import me.shedaniel.clothconfig2.impl.builders.AbstractFieldBuilder; +import me.shedaniel.clothconfig2.impl.builders.StringFieldBuilder; +import me.shedaniel.clothconfig2.impl.builders.SubCategoryBuilder; +import me.shedaniel.clothconfig2.impl.builders.TextDescriptionBuilder; +import net.fabricmc.fabric.api.gamerule.v1.CustomGameRuleCategory; +import net.fabricmc.fabric.api.gamerule.v1.rule.EnumRule; +import net.minecraft.client.gui.screen.Screen; +import net.minecraft.client.resource.language.I18n; +import net.minecraft.text.Text; +import net.minecraft.util.Formatting; +import net.minecraft.util.Identifier; +import net.minecraft.world.GameRules; +import net.minecraft.world.GameRules.*; +import tk.estecka.preferredgamerules.IRuleFactory; + +public class GamerulesMenuFactory +{ + static public final Text DEFAULT_TITLE = Text.translatable("editGamerule.title"); + static private final Text WILDCARD_TITLE = Text.translatable("cloth-gamerules.wildcardTab").formatted(Formatting.YELLOW); + + /** + * https://github.com/shedaniel/cloth-config/issues/245 + * Cloth's subcategories don't seem to work well with the search bar. Until + * this is sorted out, I'm mocking them up with text descriptions. + */ + static class CategoryEntries { + public final TextListEntry header; + public final List> entries = new ArrayList<>(); + + CategoryEntries(ConfigEntryBuilder entryBuilder, IRuleCategory cat){ + this.header = entryBuilder.startTextDescription(cat.GetTitle()).build(); + } + }; + + static public final Text MISSING_WIDGET = Text.empty().formatted(Formatting.RED) + .append("(") + .append(Text.translatable("cloth-gamerules.missing_widget")) + .append(")") + ; + + static public Screen CreateScreen(Screen parent, Text title, GameRules rules, GameRules resetValues, Consumer> onClose){ + final ConfigBuilder builder = ConfigBuilder.create(); + final ConfigEntryBuilder entries = builder.entryBuilder(); + + Map tabs = new HashMap<>(); + // Map subs = new HashMap<>(); + Map subs = new HashMap<>(); + + builder.setParentScreen(parent); + builder.setTitle(title); + builder.setSavingRunnable(() -> onClose.accept(Optional.of(rules))); + + final var wildcard = builder.getOrCreateCategory(WILDCARD_TITLE); + builder.setFallbackCategory(wildcard); + + GameRules.accept(new GameRules.Visitor() { + @Override public > void visit(Key key, Type type){ + IRuleCategory cat = GetCategory(key); + Identifier catId = cat.GetId(); + + tabs.computeIfAbsent(catId.getNamespace(), ns -> builder.getOrCreateCategory(Text.literal(ns))); + // var sub = subs.computeIfAbsent(catId, id -> entries.startSubCategory(cat.GetTitle())); + var sub = subs.computeIfAbsent(catId, id -> new CategoryEntries(entries, cat)); + + var field = StartRuleField(entries, key, type, rules.get(key), resetValues.get(key)); + AbstractConfigListEntry entry = (field != null) ? field.build() : StartMissingType(entries, key, type).build(); + sub.entries.add(entry); + + List searchTags = new ArrayList(); + searchTags.add(key.getTranslationKey()); + searchTags.add(I18n.translate(key.getTranslationKey())); + entry.appendSearchTags(searchTags); + sub.header.appendSearchTags(searchTags); + } + }); + + + for (var entry : subs.entrySet()) { + Identifier id = entry.getKey(); + ConfigCategory tab = tabs.get(id.getNamespace()); + // SubCategoryBuilder sub = entry.getValue(); + CategoryEntries sub = entry.getValue(); + + // sub.setExpanded(true); + // tab.addEntry(sub.build()); + wildcard.addEntry(sub.header); + tab.addEntry(sub.header); + sub.entries.forEach(e -> {tab.addEntry(e); wildcard.addEntry(e);}); + } + + return builder.build(); + } + + static public IRuleCategory GetCategory(Key key){ + var custom = CustomGameRuleCategory.getCategory(key); + if (custom.isPresent()) + return IRuleCategory.Of(custom.get()); + else + return IRuleCategory.Of(key.getCategory()); + } + + static public Optional CreateTooltip(Key key, Type type){ + ArrayList tooltip = new ArrayList<>(4); + String descKey = key.getTranslationKey()+".description"; + + tooltip.add(Text.literal(key.getName()).formatted(Formatting.YELLOW)); + if (I18n.hasTranslation(descKey)) + tooltip.add(Text.translatable(descKey)); + + if (ClothGamerules.IS_PREFRULE_INSTALLED){ + var factory = IRuleFactory.Of(type); + tooltip.add(Text.translatable("editGamerule.preferred", factory.preferredgamerules$CreatePreferredRule().serialize()).formatted(Formatting.GRAY)); + tooltip.add(Text.translatable("editGamerule.default", factory.preferredgamerules$CreateDefaultRule ().serialize()).formatted(Formatting.GRAY)); + } + else + tooltip.add(Text.translatable("editGamerule.default", type.createRule().serialize()).formatted(Formatting.GRAY)); + + return Optional.of(tooltip.toArray(new Text[1])); + } + + static public > @Nullable AbstractFieldBuilder StartRuleField(ConfigEntryBuilder entryBuilder, Key key, Type type, Rule rule, Rule resetValue) { + AbstractFieldBuilder field = null; + + String nameKey = key.getTranslationKey(); + Text displayName = Text.translatable(nameKey); + + IRuleString validateableRule = IRuleString.Of(rule); + if (validateableRule != null){ + field = entryBuilder.startStrField(displayName, validateableRule.GetValue()) + .setSaveConsumer(s -> validateableRule.Validate(nameKey)) + .setErrorSupplier(validateableRule::ErrorProvider) + .setDefaultValue(resetValue.serialize()) + ; + } + else if (rule instanceof BooleanRule boolRule){ + field = entryBuilder.startBooleanToggle(displayName, boolRule.get()) + .setSaveConsumer(b -> boolRule.set(b, null)) + .setDefaultValue(((BooleanRule)resetValue).get()) + ; + } + else if (rule instanceof EnumRule enumRule){ + @SuppressWarnings("unchecked") + Class> enumClass = enumRule.getEnumClass(); + field = entryBuilder.startEnumSelector(displayName, enumClass, enumRule.get()) + .setSaveConsumer(e -> enumRule.set(e, null)) + .setErrorSupplier(e -> enumRule.supports(e) ? Optional.empty() : Optional.of(Text.translatable("argument.enum.invalid", e.toString()))) + .setDefaultValue(((EnumRule)resetValue).get()) + ; + } + + if (field != null) + field.setTooltipSupplier(() -> CreateTooltip(key, type)); + + return field; + } + + static public TextDescriptionBuilder StartMissingType(ConfigEntryBuilder entryBuilder, Key key, Type type){ + Text text = Text.translatable(key.getTranslationKey()).formatted(Formatting.GRAY) + .append(" ") + .append(MISSING_WIDGET) + ; + + var entry = entryBuilder.startTextDescription(text); + entry.setTooltipSupplier(() -> CreateTooltip(key, type)); + return entry; + } + +} diff --git a/src/main/java/tk/estecka/clothgamerules/IRuleCategory.java b/src/main/java/tk/estecka/clothgamerules/IRuleCategory.java new file mode 100644 index 0000000..ed02dc4 --- /dev/null +++ b/src/main/java/tk/estecka/clothgamerules/IRuleCategory.java @@ -0,0 +1,44 @@ +package tk.estecka.clothgamerules; + +import net.fabricmc.fabric.api.gamerule.v1.CustomGameRuleCategory; +import net.minecraft.text.Text; +import net.minecraft.util.Formatting; +import net.minecraft.util.Identifier; +import net.minecraft.world.GameRules; + +public interface IRuleCategory +{ + Text GetTitle(); + Identifier GetId(); + + +/******************************************************************************/ +/* # Wrappers */ +/******************************************************************************/ + + static public IRuleCategory Of(GameRules.Category vanilla){ + return new IRuleCategory() { + @Override public Text GetTitle(){ + return Text.translatable(vanilla.getCategory()).formatted(Formatting.BOLD, Formatting.YELLOW); + } + + @Override public Identifier GetId(){ + return new Identifier("minecraft", vanilla.getCategory().replace('.', '_')); + } + + }; + } + + static public IRuleCategory Of(CustomGameRuleCategory fabric){ + return new IRuleCategory() { + @Override public Text GetTitle(){ + return fabric.getName(); + } + + @Override public Identifier GetId(){ + return fabric.getId(); + } + + }; + } +} diff --git a/src/main/java/tk/estecka/clothgamerules/IRuleString.java b/src/main/java/tk/estecka/clothgamerules/IRuleString.java new file mode 100644 index 0000000..299d3c0 --- /dev/null +++ b/src/main/java/tk/estecka/clothgamerules/IRuleString.java @@ -0,0 +1,51 @@ +package tk.estecka.clothgamerules; + +import java.util.Optional; +import org.jetbrains.annotations.Nullable; +import net.fabricmc.fabric.api.gamerule.v1.rule.DoubleRule; +import net.minecraft.text.Text; +import net.minecraft.world.GameRules; +import net.minecraft.world.GameRules.IntRule; + +public interface IRuleString +{ + boolean Validate(String value); + String GetValue(); + + default String GetErrorString(){ + return "argument.enum.invalid"; + } + + default Optional ErrorProvider(String value){ + return this.Validate(value) ? + Optional.empty(): + Optional.of(Text.translatable(this.GetErrorString(), value)); + } + + +/******************************************************************************/ +/* # Wrappers */ +/******************************************************************************/ + + static public @Nullable IRuleString Of(GameRules.Rule rule){ + if (rule instanceof IntRule typedRule) return Of(typedRule); + if (rule instanceof DoubleRule typedRule) return Of(typedRule); + return null; + } + + static public IRuleString Of(IntRule rule) { + return new IRuleString() { + @Override public boolean Validate(String value){ return rule.validate(value); } + @Override public String GetValue(){ return String.valueOf(rule.get()); } + @Override public String GetErrorString() { return "parsing.int.invalid"; } + }; + } + + static public IRuleString Of(DoubleRule rule) { + return new IRuleString() { + @Override public boolean Validate(String value){ return rule.validate(value); } + @Override public String GetValue(){ return String.valueOf(rule.get()); } + @Override public String GetErrorString() { return "parsing.double.invalid"; } + }; + } +} diff --git a/src/main/java/tk/estecka/clothgamerules/ModMenu.java b/src/main/java/tk/estecka/clothgamerules/ModMenu.java new file mode 100644 index 0000000..38f7318 --- /dev/null +++ b/src/main/java/tk/estecka/clothgamerules/ModMenu.java @@ -0,0 +1,20 @@ +package tk.estecka.clothgamerules; + +import com.terraformersmc.modmenu.api.ConfigScreenFactory; +import com.terraformersmc.modmenu.api.ModMenuApi; +import net.minecraft.client.gui.screen.Screen; +import net.minecraft.text.Text; +import net.minecraft.world.GameRules; +import tk.estecka.clothgamerules.api.ClothGamerulesScreenFactory; + +public class ModMenu +implements ModMenuApi +{ + public ConfigScreenFactory getModConfigScreenFactory(){ + return parent -> getModConfigScreen(parent); + } + + public Screen getModConfigScreen(Screen parent){ + return ClothGamerulesScreenFactory.CreateScreen(parent, Text.literal("Test Screen"), new GameRules(), noop->{}); + } +} diff --git a/src/main/java/tk/estecka/clothgamerules/TestRules.java b/src/main/java/tk/estecka/clothgamerules/TestRules.java new file mode 100644 index 0000000..1860f56 --- /dev/null +++ b/src/main/java/tk/estecka/clothgamerules/TestRules.java @@ -0,0 +1,36 @@ +package tk.estecka.clothgamerules; + +import net.fabricmc.api.ModInitializer; +import net.fabricmc.fabric.api.gamerule.v1.CustomGameRuleCategory; +import net.fabricmc.fabric.api.gamerule.v1.GameRuleFactory; +import net.fabricmc.fabric.api.gamerule.v1.GameRuleRegistry; +import net.fabricmc.loader.api.FabricLoader; +import net.minecraft.text.Text; +import net.minecraft.util.Identifier; + +public class TestRules +implements ModInitializer +{ + static public enum ETestEnum { + NONE, + SOME, + ALL + } + + @Override + public void onInitialize() { + if (FabricLoader.getInstance().isDevelopmentEnvironment()) + { + CustomGameRuleCategory category = new CustomGameRuleCategory(new Identifier("cloth-gamerules", "test_rules"), Text.literal("Test Rules")); + GameRuleRegistry.register("clothrule.bool", category, GameRuleFactory.createBooleanRule(true)); + GameRuleRegistry.register("clothrule.int", category, GameRuleFactory.createIntRule(1)); + GameRuleRegistry.register("clothrule.double", category, GameRuleFactory.createDoubleRule(1.0)); + GameRuleRegistry.register("clothrule.enum", category, GameRuleFactory.createEnumRule(ETestEnum.SOME)); + + GameRuleRegistry.register("clothrule.int.bounded", category, GameRuleFactory.createIntRule(1, 0, 16)); + GameRuleRegistry.register("clothrule.double.bounded", category, GameRuleFactory.createDoubleRule(1.0, 0.1, 9.999)); + GameRuleRegistry.register("clothrule.enum.limited", category, GameRuleFactory.createEnumRule(ETestEnum.SOME, new ETestEnum[]{ ETestEnum.NONE, ETestEnum.SOME })); + } + + } +} diff --git a/src/main/java/tk/estecka/clothgamerules/api/ClothGamerulesScreenFactory.java b/src/main/java/tk/estecka/clothgamerules/api/ClothGamerulesScreenFactory.java new file mode 100644 index 0000000..17104f8 --- /dev/null +++ b/src/main/java/tk/estecka/clothgamerules/api/ClothGamerulesScreenFactory.java @@ -0,0 +1,28 @@ +package tk.estecka.clothgamerules.api; + +import java.util.Optional; +import java.util.function.Consumer; +import net.minecraft.client.gui.screen.Screen; +import net.minecraft.text.Text; +import net.minecraft.world.GameRules; +import tk.estecka.clothgamerules.GamerulesMenuFactory; +import static tk.estecka.clothgamerules.GamerulesMenuFactory.DEFAULT_TITLE; + +public interface ClothGamerulesScreenFactory +{ + static public Screen CreateScreen(Screen parent, GameRules rules, Consumer> onClose){ + return GamerulesMenuFactory.CreateScreen(parent, DEFAULT_TITLE, rules, new GameRules(), onClose); + } + + static public Screen CreateScreen(Screen parent, GameRules rules, GameRules resetValues, Consumer> onClose){ + return GamerulesMenuFactory.CreateScreen(parent, DEFAULT_TITLE, rules, resetValues, onClose); + } + + static public Screen CreateScreen(Screen parent, Text title, GameRules rules, Consumer> onClose){ + return GamerulesMenuFactory.CreateScreen(parent, title, rules, new GameRules(), onClose); + } + + static public Screen CreateScreen(Screen parent, Text title, GameRules rules, GameRules resetValues, Consumer> onClose){ + return GamerulesMenuFactory.CreateScreen(parent, title, rules, resetValues, onClose); + } +} diff --git a/src/main/java/tk/estecka/clothgamerules/mixin/CreateWorldMoreTabMixin.java b/src/main/java/tk/estecka/clothgamerules/mixin/CreateWorldMoreTabMixin.java new file mode 100644 index 0000000..c6fb0ba --- /dev/null +++ b/src/main/java/tk/estecka/clothgamerules/mixin/CreateWorldMoreTabMixin.java @@ -0,0 +1,36 @@ +package tk.estecka.clothgamerules.mixin; + +import java.util.Optional; +import java.util.function.Consumer; +import org.spongepowered.asm.mixin.Mixin; +import org.spongepowered.asm.mixin.Shadow; +import org.spongepowered.asm.mixin.injection.At; +import org.spongepowered.asm.mixin.injection.ModifyArg; +import com.llamalad7.mixinextras.injector.wrapoperation.Operation; +import com.llamalad7.mixinextras.injector.wrapoperation.WrapOperation; +import com.llamalad7.mixinextras.sugar.Share; +import com.llamalad7.mixinextras.sugar.ref.LocalRef; +import net.minecraft.client.gui.screen.Screen; +import net.minecraft.client.gui.screen.world.CreateWorldScreen; +import net.minecraft.client.gui.screen.world.EditGameRulesScreen; +import net.minecraft.world.GameRules; +import tk.estecka.clothgamerules.api.ClothGamerulesScreenFactory; + +@Mixin(targets="net/minecraft/client/gui/screen/world/CreateWorldScreen$MoreTab") +public class CreateWorldMoreTabMixin +{ + // CreateWorldScreen.this + @Shadow private CreateWorldScreen field_42178; + + @WrapOperation( method="openGameRulesScreen", expect=1, at=@At(value="NEW", target="net/minecraft/client/gui/screen/world/EditGameRulesScreen") ) + private EditGameRulesScreen CatchArguments(GameRules rules, Consumer> saveConsumer, Operation original, @Share("rules") LocalRef ruleRef, @Share("consumer") LocalRef>> consumerRef){ + ruleRef.set(rules); + consumerRef.set(saveConsumer); + return original.call(rules, saveConsumer); + } + + @ModifyArg( method="openGameRulesScreen", expect=1, at=@At(value="INVOKE", target="net/minecraft/client/MinecraftClient.setScreen (Lnet/minecraft/client/gui/screen/Screen;)V") ) + private Screen ReplaceGameruleScreen(Screen original, @Share("rules") LocalRef ruleRef, @Share("consumer") LocalRef>> consumerRef){ + return ClothGamerulesScreenFactory.CreateScreen(field_42178, ruleRef.get(), consumerRef.get()); + } +} diff --git a/src/main/resources/assets/cloth-gamerules/icon.png b/src/main/resources/assets/cloth-gamerules/icon.png new file mode 100644 index 0000000..524f496 Binary files /dev/null and b/src/main/resources/assets/cloth-gamerules/icon.png differ diff --git a/src/main/resources/assets/cloth-gamerules/icon.xcf b/src/main/resources/assets/cloth-gamerules/icon.xcf new file mode 100644 index 0000000..8b513c6 Binary files /dev/null and b/src/main/resources/assets/cloth-gamerules/icon.xcf differ diff --git a/src/main/resources/assets/cloth-gamerules/lang/en_us.json b/src/main/resources/assets/cloth-gamerules/lang/en_us.json new file mode 100644 index 0000000..7030431 --- /dev/null +++ b/src/main/resources/assets/cloth-gamerules/lang/en_us.json @@ -0,0 +1,5 @@ +{ + "editGamerule.preferred": "Preferred: %s", + "cloth-gamerules.missing_widget": "Missing widget", + "cloth-gamerules.wildcardTab": "*" +} diff --git a/src/main/resources/cloth-gamerules.mixins.json b/src/main/resources/cloth-gamerules.mixins.json new file mode 100644 index 0000000..49d92e5 --- /dev/null +++ b/src/main/resources/cloth-gamerules.mixins.json @@ -0,0 +1,11 @@ +{ + "required": true, + "package": "tk.estecka.clothgamerules.mixin", + "compatibilityLevel": "JAVA_17", + "mixins": [ + "CreateWorldMoreTabMixin" + ], + "injectors": { + "defaultRequire": 1 + } +} \ No newline at end of file diff --git a/src/main/resources/fabric.mod.json b/src/main/resources/fabric.mod.json new file mode 100644 index 0000000..361c295 --- /dev/null +++ b/src/main/resources/fabric.mod.json @@ -0,0 +1,39 @@ +{ + "schemaVersion": 1, + "id": "cloth-gamerules", + "version": "${version}", + "name": "Cloth Gamerules", + "description": "A Cloth Config screen version of the Gamerules menu.", + "authors": [ + "Estecka" + ], + "contact": { + "homepage": "https://modrinth.com/mod/cloth-gamerules/", + "sources": "https://github.com/Estecka/mc-Cloth-Gamerules" + }, + "license": "GNU AGPLv3", + "icon": "assets/cloth-gamerules/icon.png", + "environment": "*", + "entrypoints": { + "main": [ + "tk.estecka.clothgamerules.TestRules" + ], + "modmenu": [ + "tk.estecka.clothgamerules.ModMenu" + ] + }, + "mixins": [ + "cloth-gamerules.mixins.json" + ], + "depends": { + "minecraft": "*", + "cloth-config": "*", + "fabricloader": ">=0.15.7", + "java": ">=17", + "fabric-api": "*" + }, + "recommends": { + "cloth-config": ">=10.1.117", + "minecraft": "^1.19.4" + } +}