diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3c37caf --- /dev/null +++ b/.gitignore @@ -0,0 +1,118 @@ +# User-specific stuff +.idea/ + +*.iml +*.ipr +*.iws + +# IntelliJ +out/ +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Compiled class file +*.class + +# Log file +*.log + +# BlueJ files +*.ctxt + +# Package Files # +*.jar +*.war +*.nar +*.ear +*.zip +*.tar.gz +*.rar + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* + +*~ + +# temporary files which can be created if a process still has a handle open of a deleted file +.fuse_hidden* + +# KDE directory preferences +.directory + +# Linux trash folder which might appear on any partition or disk +.Trash-* + +# .nfs files are created when an open file is removed but is still being accessed +.nfs* + +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +# Windows thumbnail cache files +Thumbs.db +Thumbs.db:encryptable +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +.gradle +build/ + +# Ignore Gradle GUI config +gradle-app.setting + +# Cache of project +.gradletasknamecache + +**/build/ + +# Common working directory +run/ + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..ffa44af --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,692 @@ +Copyright (c) 2024 arvitus + +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 + + + + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..d5c5fa6 --- /dev/null +++ b/README.MD @@ -0,0 +1,135 @@ +
+ +# Server Messages + +[![Static Badge](https://img.shields.io/badge/modrinth-00AF5C?logo=modrinth&logoColor=white)](https://modrinth.com/mod/servermessages) +[![Static Badge](https://img.shields.io/badge/GitHub-181717?logo=github)](https://github.com/arvitus/ServerMessages) +[![Static Badge](https://img.shields.io/badge/Discord-5662f6?logo=discord&logoColor=white)](https://discord.gg/xzdbetZVrn) + +A Minecraft mod to customize any server message, with support for text formatting and placeholders. + +
+ +## What does it do? + +This mod enables you to modify any¹ server message to your liking. You can replace the message itself, add or change +the [formatting](https://placeholders.pb4.eu/user/quicktext/) and even use [placeholders](https://placeholders.pb4.eu/). +The format is fully compatible with +the [translated text format](https://minecraft.wiki/w/Raw_JSON_text_format#Translated_Text) used by language files. + +> Originally, I just needed the option to change the "not on whitelist" message and the "server closed" message. This +> mod is what emerged from it. + +## How do I use it? + +To modify a message, you simply add the corresponding +[translation key](https://github.com/InventivetalentDev/minecraft-assets/blob/1.21/assets/minecraft/lang/en_us.json) +to the config and change its value to your liking. +You can reload the config by using `/reload`. The text format is based on +the [translated text format](https://minecraft.wiki/w/Raw_JSON_text_format#Translated_Text), and also supports +the [QuickText Format](https://placeholders.pb4.eu/user/quicktext) for text formatting +and global [placeholders](https://placeholders.pb4.eu/user/default-placeholders/). + +The format for placeholders is `${placeholder}` and for most messages you can only use placeholders that do NOT depend +on a player/entity! So `${server:tps}` and `${world:name}` (overworld) are perfectly fine, but `${player:name}` will +not always work. +*For more information, see [Placeholder Contexts](#placeholder-contexts).* + +The config format is compatible with the minecraft language file format. So you could simply replace the config with a +language file (strongly discouraged) and it would work fine. Note, however, that this would NOT overwrite the language +setting of the players! For reference, you can find a list of all language files currently +available [here](https://github.com/InventivetalentDev/minecraft-assets/tree/1.21/assets/minecraft/lang). + +> [!NOTE] +> Any other mod that modifies server messages (e.g. [BanHammer](https://modrinth.com/mod/banhammer)), will most +> certainly take precedence over changes made by this mod.** + +### Example Config + +```json5 +{ + // only change formatting + "multiplayer.disconnect.not_whitelisted": "", + // replace message; use placeholder + "multiplayer.disconnect.server_shutdown": "We'll be right back!\nUptime: ${server:uptime}", + // add text; use nested translation argument + "multiplayer.player.joined": ". Good to see you!", + // replace message; use translation argument + "multiplayer.player.left": "See you soon, %s!" +} +``` + +> [!IMPORTANT] +> Don't copy this as is! The config is using the [json](https://en.wikipedia.org/wiki/JSON) format and json does NOT +> support comments. The comments in the example are just for clarification. **Do not copy the comments!** + +### Supported Translation Keys + +In theory, every translation key is supported when it is used explicitly (e.g. in +a [translation tag](https://placeholders.pb4.eu/user/quicktext/#translations)). +But natively, the server only uses a few translations. +All translation keys, that are parsed on the server, are supported. That includes most of the messages you can see when +playing on a server. + +For a more detailed list of supported keys, see [here](src/main/resources/assets/translationKeySupport.json). +> [!NOTE] +> The information in this list may not be accurate! +> Though it can be helpful to get a quick overview, it's only based on my findings and a lot of assumptions. + +### Placeholder Contexts + +*Contexts are additional information that allows different placeholders to work. For example, some mods like AfkPlus +require the `player` context for their placeholders to work. This may not always be available in every message, +so please check the additional contexts of your desired message in the list below.* + +All messages support the basic contexts, meaning +the [Server](https://placeholders.pb4.eu/user/default-placeholders/#server) and +the [Overworld](https://placeholders.pb4.eu/user/default-placeholders/#world), but NOT +the [Player](https://placeholders.pb4.eu/user/default-placeholders/#player). +Some messages support additional contexts. See the list below. + +| Translation Key(s) | Extra Context | +|------------------------------------------|:-------------:| +| `chat.type.advancement.*` | `player` | +| `commands.kick.success` | `player` | +| `multiplayer.disconnect.banned.*` | `profile` | +| `multiplayer.disconnect.banned_ip.*` | `profile` | +| `multiplayer.disconnect.not_whitelisted` | `profile` | +| `multiplayer.disconnect.kicked` | `player` | +| `multiplayer.disconnect.server_shutdown` | `player` | +| `multiplayer.player.joined` | `player` | +| `multiplayer.player.joined.renamed` | `player` | +| `multiplayer.player.left` | `player` | + +> I will be adding more contexts over time, but since I have to do this manually for each message, it can take a while. +> If you want a specific context added, please [open an issue](https://github.com/arvitus/ServerMessages/issues/new) and +> I'll prioritize it. + +## Why do I need it? + +Almost every text message, a vanilla server sends to its players, uses a translation key to display the corresponding +message. So instead of sending actual text (e.g. ` joined the game`), it sends something +like `translate[multiplayer.player.joined]`. The client then converts this into actual text, using the player's selected +language. This way the game ensures that each player will see the message in their preferred language. While this is +pretty helpful, sometimes it may not be the behaviour you want, because you cannot change the formatting of those +messages without forcing your players to use a custom resource pack. This is why this mod exists. + +Usually those messages are displayed as plain old white text, which is pretty boring. So to spice things up, you need to +be able to change those messages server wide. For example, you can change the "not on whitelist" message to give your +new players some more information. You could also change the color of the "you have been banned" message to make it +stand out. There are a lot of those server messages that you may want to customize, so give it a try! + +## How does it work? + +This mod replaces the translation key with the text you specified in the config, **before** the text is +sent to the player. This way the player receives your custom message instead of the default one. This does not +necessarily affect the translation of the messages. So you can add formatting to messages without losing the +auto translation feature (see [example config](#example-config)). + +Any translation keys used in your custom messages will use the default values/formatting, NOT the values you +provided. This is necessary to prevent infinite recursion. + +--- +**[ ¹ ]:** *There are some special cases where it might not work as expected due to how minecraft handles certain +messages. If you encounter one of those, please [open an issue](https://github.com/arvitus/ServerMessages/issues/new), +and I'll see what can be done to make them work too.* \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..31b24bc --- /dev/null +++ b/build.gradle @@ -0,0 +1,95 @@ +plugins { + id 'fabric-loom' version '1.7-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.nucleoid.xyz/" + name "Nucleoid" + } +} + +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}" + + include modImplementation("eu.pb4:placeholder-api:${project.placeholder_api_version}") +} + +processResources { + inputs.property "version", project.version + inputs.property "minecraft_version", project.minecraft_version + inputs.property "loader_version", project.loader_version + filteringCharset "UTF-8" + + filesMatching("fabric.mod.json") { + expand "version": project.mod_version, + "minecraft_version": project.minecraft_version, + "loader_version": project.loader_version + } +} + +def targetJavaVersion = 21 +tasks.withType(JavaCompile).configureEach { + // ensure that the encoding is set to UTF-8, no matter what the system default is + // this fixes some edge cases with special characters not displaying correctly + // see http://yodaconditions.net/blog/fix-for-java-file-encoding-problems-with-gradle.html + // If Javadoc is generated, this must be specified in that task too. + it.options.encoding = "UTF-8" + if (targetJavaVersion >= 10 || JavaVersion.current().isJava10Compatible()) { + it.options.release.set(targetJavaVersion) + } +} + +java { + def javaVersion = JavaVersion.toVersion(targetJavaVersion) + if (JavaVersion.current() < javaVersion) { + toolchain.languageVersion = JavaLanguageVersion.of(targetJavaVersion) + } + // 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() +} + +jar { + from("LICENSE") { + rename {"${it}_${project.archivesBaseName}"} + } +} + +// 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. + } +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..77676d8 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,18 @@ +# Done to increase the memory available to gradle. +org.gradle.jvmargs=-Xmx2G + +# 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+beta1 +maven_group=de.arvitus +archives_base_name=servermessages + +# Dependencies +# check this on https://fabricmc.net/develop/ +fabric_version=0.102.0+1.21 +placeholder_api_version=2.4.1+1.21 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..f91a4fe --- /dev/null +++ b/settings.gradle @@ -0,0 +1,9 @@ +pluginManagement { + repositories { + maven { + name = 'Fabric' + url = 'https://maven.fabricmc.net/' + } + gradlePluginPortal() + } +} diff --git a/src/main/java/de/example/servermessages/Config.java b/src/main/java/de/example/servermessages/Config.java new file mode 100644 index 0000000..e6ae5d1 --- /dev/null +++ b/src/main/java/de/example/servermessages/Config.java @@ -0,0 +1,95 @@ +package de.example.servermessages; + +import com.google.common.collect.ImmutableMap; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonElement; +import com.google.gson.JsonParser; +import com.mojang.serialization.Codec; +import com.mojang.serialization.DataResult; +import com.mojang.serialization.JsonOps; +import eu.pb4.placeholders.api.ParserContext; +import eu.pb4.placeholders.api.node.DynamicTextNode; +import eu.pb4.placeholders.api.parsers.NodeParser; +import eu.pb4.placeholders.api.parsers.TagLikeParser; +import net.minecraft.text.Text; + +import java.io.*; +import java.nio.file.Path; +import java.util.Map; +import java.util.function.Function; + +import static de.example.servermessages.ServerMessages.*; + +public class Config { + public static final Path PATH = CONFIG_DIR.resolve("config.json"); + public static final ParserContext.Key> DYN_KEY = DynamicTextNode.key(MOD_ID); + public static final NodeParser PARSER = NodeParser.builder() + .quickText() + .simplifiedTextFormat() + .legacyAll() + .globalPlaceholders(TagLikeParser.PLACEHOLDER_USER) + .placeholders(TagLikeParser.Format.of('%', 's'), DYN_KEY) + .staticPreParsing() + .build(); + public static final Codec> CODEC = Codec.unboundedMap( + Codec.STRING, + Codec.STRING.xmap(x -> WrappedLangText.from(PARSER, x), WrappedLangText::input) + ); + private static final ImmutableMap DEFAULT_DATA = ImmutableMap.of( + "multiplayer.disconnect.not_whitelisted", + WrappedLangText.from(PARSER, ""), + "multiplayer.disconnect.server_shutdown", + WrappedLangText.from(PARSER, "") + ); + private static ImmutableMap data = DEFAULT_DATA; + private static boolean ready = false; + + private Config() {} + + public static void load() { + Config.ready = false; + Map data = null; + try (Reader reader = new FileReader(PATH.toFile())) { + DataResult> result = CODEC.parse( + JsonOps.INSTANCE, + JsonParser.parseReader(reader) + ); + data = result.getOrThrow(); + } catch (FileNotFoundException e) { + Config.createDefaultFile(); + data = DEFAULT_DATA; + } catch (Exception e) { + LOGGER.warn("Error during config load, using previous config instead", e); + } + + if (data != null) Config.data = ImmutableMap.copyOf(data); + Config.ready = true; + } + + private static void createDefaultFile() { + CONFIG_DIR.toFile().mkdir(); + try (Writer writer = new FileWriter(PATH.toFile())) { + DataResult result = CODEC.encodeStart(JsonOps.INSTANCE, DEFAULT_DATA); + new GsonBuilder().setPrettyPrinting().disableHtmlEscaping().create().toJson(result.getOrThrow(), writer); + } catch (Exception e) { + LOGGER.warn("Error during creation of default config", e); + } + } + + public static boolean isReady() { + return Config.ready; + } + + public static WrappedLangText get(String key) { + return Config.getData().get(key); + } + + public static boolean contains(String key) { + return Config.getData().containsKey(key); + } + + public static ImmutableMap getData() { + if (Config.data == null) Config.load(); + return Config.data; + } +} diff --git a/src/main/java/de/example/servermessages/ContextStore.java b/src/main/java/de/example/servermessages/ContextStore.java new file mode 100644 index 0000000..12bf75e --- /dev/null +++ b/src/main/java/de/example/servermessages/ContextStore.java @@ -0,0 +1,29 @@ +package de.example.servermessages; + +import eu.pb4.placeholders.api.PlaceholderContext; +import org.jetbrains.annotations.Nullable; + +import java.util.HashMap; +import java.util.Map; + +public class ContextStore { + private final Map data = new HashMap<>(); + + @Nullable + public PlaceholderContext pop(String key) { + while (!data.containsKey(key)) { + int index = key.lastIndexOf('.'); + if (index > 0) key = key.substring(0, index); + else break; + } + return data.remove(key); + } + + public PlaceholderContext put(String key, PlaceholderContext value) { + return data.put(key, value); + } + + public String toString() { + return data.toString(); + } +} diff --git a/src/main/java/de/example/servermessages/ServerMessages.java b/src/main/java/de/example/servermessages/ServerMessages.java new file mode 100644 index 0000000..356b6ef --- /dev/null +++ b/src/main/java/de/example/servermessages/ServerMessages.java @@ -0,0 +1,42 @@ +package de.example.servermessages; + +import net.fabricmc.api.ModInitializer; +import net.fabricmc.fabric.api.event.lifecycle.v1.ServerLifecycleEvents; +import net.fabricmc.loader.api.FabricLoader; +import net.fabricmc.loader.api.metadata.ModMetadata; +import net.fabricmc.loader.api.metadata.Person; +import net.minecraft.server.MinecraftServer; +import org.jetbrains.annotations.Nullable; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.nio.file.Path; + +public class ServerMessages implements ModInitializer { + public static final String MOD_ID = "servermessages"; + public static final Path CONFIG_DIR = FabricLoader.getInstance().getConfigDir().resolve(MOD_ID); + public static final Logger LOGGER = LoggerFactory.getLogger(MOD_ID); + public static final ContextStore CONTEXT_STORE = new ContextStore(); + @Nullable + public static MinecraftServer SERVER; + + + @Override + public void onInitialize() { + FabricLoader.getInstance().getModContainer(MOD_ID).ifPresent(modContainer -> { + ModMetadata meta = modContainer.getMetadata(); + LOGGER.info( + "Loaded {} v{} by {}", + meta.getName(), + meta.getVersion(), + meta.getAuthors().stream().findFirst().map(Person::getName).orElse("unknown") + ); + }); + + Config.load(); + + ServerLifecycleEvents.SERVER_STARTED.register(server -> SERVER = server); + ServerLifecycleEvents.SERVER_STOPPING.register(server -> SERVER = null); + ServerLifecycleEvents.END_DATA_PACK_RELOAD.register((server, resourceManager, success) -> Config.load()); + } +} diff --git a/src/main/java/de/example/servermessages/WrappedLangText.java b/src/main/java/de/example/servermessages/WrappedLangText.java new file mode 100644 index 0000000..eb070b8 --- /dev/null +++ b/src/main/java/de/example/servermessages/WrappedLangText.java @@ -0,0 +1,18 @@ +package de.example.servermessages; + +import eu.pb4.placeholders.api.node.TextNode; +import eu.pb4.placeholders.api.parsers.NodeParser; + +public record WrappedLangText(String input, TextNode textNode) { + public static WrappedLangText from(NodeParser parser, String input) { + int index = 1; + while (input.contains("%s")) { + input = input.replaceFirst("%s", "%" + index + "\\$s"); + index++; + } + + var node = TextNode.asSingle(parser.parseNodes(TextNode.of(input))); + + return new WrappedLangText(input, node); + } +} diff --git a/src/main/java/de/example/servermessages/mixin/MutableTextMixin.java b/src/main/java/de/example/servermessages/mixin/MutableTextMixin.java new file mode 100644 index 0000000..209210d --- /dev/null +++ b/src/main/java/de/example/servermessages/mixin/MutableTextMixin.java @@ -0,0 +1,63 @@ +package de.example.servermessages.mixin; + +import de.example.servermessages.Config; +import eu.pb4.placeholders.api.ParserContext; +import eu.pb4.placeholders.api.PlaceholderContext; +import eu.pb4.placeholders.api.node.TextNode; +import net.minecraft.text.MutableText; +import net.minecraft.text.Text; +import net.minecraft.text.TextContent; +import net.minecraft.text.TranslatableTextContent; +import org.spongepowered.asm.mixin.Mixin; +import org.spongepowered.asm.mixin.Unique; +import org.spongepowered.asm.mixin.injection.At; +import org.spongepowered.asm.mixin.injection.Inject; +import org.spongepowered.asm.mixin.injection.callback.CallbackInfoReturnable; + +import java.util.Arrays; +import java.util.HashMap; +import java.util.Map; + +import static de.example.servermessages.ServerMessages.CONTEXT_STORE; +import static de.example.servermessages.ServerMessages.SERVER; + +@Mixin(MutableText.class) +public abstract class MutableTextMixin { + @Unique + private static boolean parsing = false; + + @Inject(method = "of", at = @At("HEAD"), cancellable = true) + private static void myOf(TextContent content, CallbackInfoReturnable cir) { + if ( + // (SERVER != null && !SERVER.isOnThread()) || // only call on logical server + parsing || + !Config.isReady() || // to avoid recursion + !(content instanceof TranslatableTextContent translatable) || + !Config.contains(translatable.getKey()) + ) return; + + TextNode node = Config.get(translatable.getKey()).textNode(); + + Map argPlaceholders = new HashMap<>(); + if (translatable.getArgs().length > 0) { + for (Object arg : Arrays.stream(translatable.getArgs()).toList()) { + Text text; + if (arg instanceof Text t) text = t; + else text = Text.of(String.valueOf(arg)); + argPlaceholders.put((argPlaceholders.size() + 1) + "$", text); + } + } + + PlaceholderContext storedContext = CONTEXT_STORE.pop(translatable.getKey()); + if (storedContext == null && SERVER != null) storedContext = PlaceholderContext.of(SERVER); + + ParserContext context = ParserContext.of(Config.DYN_KEY, argPlaceholders::get); + if (storedContext != null) context.with(PlaceholderContext.KEY, storedContext); + + parsing = true; + MutableText text = node.toText(context).copy(); + parsing = false; + + cir.setReturnValue(text); + } +} diff --git a/src/main/java/de/example/servermessages/mixin/context/AdvancementFrameMixin.java b/src/main/java/de/example/servermessages/mixin/context/AdvancementFrameMixin.java new file mode 100644 index 0000000..6a0a18e --- /dev/null +++ b/src/main/java/de/example/servermessages/mixin/context/AdvancementFrameMixin.java @@ -0,0 +1,25 @@ +package de.example.servermessages.mixin.context; + +import eu.pb4.placeholders.api.PlaceholderContext; +import net.minecraft.advancement.AdvancementEntry; +import net.minecraft.advancement.AdvancementFrame; +import net.minecraft.server.network.ServerPlayerEntity; +import net.minecraft.text.MutableText; +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.CallbackInfoReturnable; + +import static de.example.servermessages.ServerMessages.CONTEXT_STORE; + +@Mixin(AdvancementFrame.class) +public abstract class AdvancementFrameMixin { + @Inject(method = "getChatAnnouncementText", at = @At("HEAD")) + private void setAdvancementContext( + AdvancementEntry advancementEntry, + ServerPlayerEntity player, + CallbackInfoReturnable cir + ) { + CONTEXT_STORE.put("chat.type.advancement", PlaceholderContext.of(player)); + } +} diff --git a/src/main/java/de/example/servermessages/mixin/context/ClientConnectionMixin.java b/src/main/java/de/example/servermessages/mixin/context/ClientConnectionMixin.java new file mode 100644 index 0000000..c0ca8ea --- /dev/null +++ b/src/main/java/de/example/servermessages/mixin/context/ClientConnectionMixin.java @@ -0,0 +1,47 @@ +package de.example.servermessages.mixin.context; + +import com.google.common.net.InetAddresses; +import eu.pb4.placeholders.api.PlaceholderContext; +import io.netty.channel.ChannelHandlerContext; +import net.minecraft.network.ClientConnection; +import net.minecraft.network.packet.Packet; +import net.minecraft.server.network.ServerPlayerEntity; +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.Inject; +import org.spongepowered.asm.mixin.injection.callback.CallbackInfo; + +import java.net.InetSocketAddress; +import java.net.SocketAddress; +import java.util.List; + +import static de.example.servermessages.ServerMessages.CONTEXT_STORE; +import static de.example.servermessages.ServerMessages.SERVER; + +@Mixin(ClientConnection.class) +public abstract class ClientConnectionMixin { + @Shadow + private SocketAddress address; + + @Inject( + method = "channelRead0(Lio/netty/channel/ChannelHandlerContext;Lnet/minecraft/network/packet/Packet;)V", + at = @At( + value = "INVOKE", + target = "Lnet/minecraft/text/Text;translatable(Ljava/lang/String;)Lnet/minecraft/text/MutableText;", + ordinal = 0 + ) + ) + private void setDisconnectContext(ChannelHandlerContext channelHandlerContext, Packet packet, CallbackInfo ci) { + if (SERVER == null) return; + + String ip = this.address instanceof InetSocketAddress inetSocketAddress + ? InetAddresses.toAddrString(inetSocketAddress.getAddress()) + : ""; + + List players = SERVER.getPlayerManager().getPlayersByIp(ip); + if (players.isEmpty()) return; + + CONTEXT_STORE.put("multiplayer.disconnect.server_shutdown", PlaceholderContext.of(players.getFirst())); + } +} diff --git a/src/main/java/de/example/servermessages/mixin/context/MinecraftServerMixin.java b/src/main/java/de/example/servermessages/mixin/context/MinecraftServerMixin.java new file mode 100644 index 0000000..88b7926 --- /dev/null +++ b/src/main/java/de/example/servermessages/mixin/context/MinecraftServerMixin.java @@ -0,0 +1,27 @@ +package de.example.servermessages.mixin.context; + +import com.llamalad7.mixinextras.sugar.Local; +import eu.pb4.placeholders.api.PlaceholderContext; +import net.minecraft.server.MinecraftServer; +import net.minecraft.server.command.ServerCommandSource; +import net.minecraft.server.network.ServerPlayerEntity; +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; + +import static de.example.servermessages.ServerMessages.CONTEXT_STORE; + +@Mixin(MinecraftServer.class) +public abstract class MinecraftServerMixin { + @Inject( + method = "kickNonWhitelistedPlayers", + at = @At( + value = "INVOKE", + target = "Lnet/minecraft/text/Text;translatable(Ljava/lang/String;)Lnet/minecraft/text/MutableText;" + ) + ) + private void setWhitelistContext(ServerCommandSource source, CallbackInfo ci, @Local ServerPlayerEntity player) { + CONTEXT_STORE.put("multiplayer.disconnect.not_whitelisted", PlaceholderContext.of(player)); + } +} diff --git a/src/main/java/de/example/servermessages/mixin/context/PlayerManagerMixin.java b/src/main/java/de/example/servermessages/mixin/context/PlayerManagerMixin.java new file mode 100644 index 0000000..fbf3ddc --- /dev/null +++ b/src/main/java/de/example/servermessages/mixin/context/PlayerManagerMixin.java @@ -0,0 +1,86 @@ +package de.example.servermessages.mixin.context; + +import com.llamalad7.mixinextras.sugar.Local; +import com.mojang.authlib.GameProfile; +import eu.pb4.placeholders.api.PlaceholderContext; +import net.minecraft.network.ClientConnection; +import net.minecraft.server.MinecraftServer; +import net.minecraft.server.PlayerManager; +import net.minecraft.server.network.ConnectedClientData; +import net.minecraft.server.network.ServerPlayerEntity; +import net.minecraft.text.Text; +import org.spongepowered.asm.mixin.Final; +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.Inject; +import org.spongepowered.asm.mixin.injection.callback.CallbackInfo; +import org.spongepowered.asm.mixin.injection.callback.CallbackInfoReturnable; + +import java.net.SocketAddress; +import java.util.List; + +import static de.example.servermessages.ServerMessages.CONTEXT_STORE; + +@Mixin(PlayerManager.class) +public abstract class PlayerManagerMixin { + @Shadow + @Final + private MinecraftServer server; + + @Shadow + @Final + private List players; + + @Inject( + method = "onPlayerConnect", + at = @At( + value = "INVOKE", + target = "Ljava/lang/String;equalsIgnoreCase(Ljava/lang/String;)Z" + ) + ) + private void setJoinContext( + ClientConnection connection, + ServerPlayerEntity player, + ConnectedClientData clientData, + CallbackInfo ci + ) { + CONTEXT_STORE.put("multiplayer.player.joined", PlaceholderContext.of(player)); + } + + @Inject( + method = "checkCanJoin", + at = { + @At( + value = "INVOKE", + target = "Lnet/minecraft/text/Text;translatable(Ljava/lang/String;)Lnet/minecraft/text/MutableText;" + ), + @At( + value = "INVOKE", + target = "Lnet/minecraft/text/Text;translatable(Ljava/lang/String;[Ljava/lang/Object;)" + + "Lnet/minecraft/text/MutableText;" + ) + } + ) + private void setDisconnectContext(SocketAddress address, GameProfile profile, CallbackInfoReturnable cir) { + CONTEXT_STORE.put("multiplayer.disconnect", PlaceholderContext.of(profile, this.server)); + } + + @Inject(method = "checkCanJoin", at = @At("RETURN")) + private void resetDisconnectContext(SocketAddress address, GameProfile profile, CallbackInfoReturnable cir) { + CONTEXT_STORE.pop("multiplayer.disconnect"); + } + + @Inject( + method = "disconnectAllPlayers", + at = @At( + value = "INVOKE", + target = "Lnet/minecraft/text/Text;translatable(Ljava/lang/String;)Lnet/minecraft/text/MutableText;" + ) + ) + private void setServerStopContext(CallbackInfo ci, @Local int i) { + ServerPlayerEntity player = this.players.get(i); + CONTEXT_STORE.put("multiplayer.disconnect.server_shutdown", PlaceholderContext.of(player)); + } +} + diff --git a/src/main/java/de/example/servermessages/mixin/context/ServerPlayNetworkHandlerMixin.java b/src/main/java/de/example/servermessages/mixin/context/ServerPlayNetworkHandlerMixin.java new file mode 100644 index 0000000..9dcfb4f --- /dev/null +++ b/src/main/java/de/example/servermessages/mixin/context/ServerPlayNetworkHandlerMixin.java @@ -0,0 +1,23 @@ +package de.example.servermessages.mixin.context; + +import eu.pb4.placeholders.api.PlaceholderContext; +import net.minecraft.server.network.ServerPlayNetworkHandler; +import net.minecraft.server.network.ServerPlayerEntity; +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.Inject; +import org.spongepowered.asm.mixin.injection.callback.CallbackInfo; + +import static de.example.servermessages.ServerMessages.CONTEXT_STORE; + +@Mixin(ServerPlayNetworkHandler.class) +public abstract class ServerPlayNetworkHandlerMixin { + @Shadow + public ServerPlayerEntity player; + + @Inject(method = "cleanUp", at = @At("HEAD")) + private void setLeaveContext(CallbackInfo ci) { + CONTEXT_STORE.put("multiplayer.player.left", PlaceholderContext.of(this.player)); + } +} diff --git a/src/main/java/de/example/servermessages/mixin/context/commands/KickCommand.java b/src/main/java/de/example/servermessages/mixin/context/commands/KickCommand.java new file mode 100644 index 0000000..6fb935f --- /dev/null +++ b/src/main/java/de/example/servermessages/mixin/context/commands/KickCommand.java @@ -0,0 +1,62 @@ +package de.example.servermessages.mixin.context.commands; + +import com.llamalad7.mixinextras.sugar.Local; +import com.llamalad7.mixinextras.sugar.ref.LocalRef; +import com.mojang.brigadier.context.CommandContext; +import eu.pb4.placeholders.api.PlaceholderContext; +import net.minecraft.server.command.ServerCommandSource; +import net.minecraft.server.network.ServerPlayerEntity; +import net.minecraft.text.Text; +import org.spongepowered.asm.mixin.Mixin; +import org.spongepowered.asm.mixin.Unique; +import org.spongepowered.asm.mixin.injection.At; +import org.spongepowered.asm.mixin.injection.Inject; +import org.spongepowered.asm.mixin.injection.callback.CallbackInfoReturnable; + +import java.util.Collection; + +import static de.example.servermessages.ServerMessages.CONTEXT_STORE; + +@Mixin(net.minecraft.server.command.KickCommand.class) +public abstract class KickCommand { + @Unique + private static boolean withoutReason = false; + + @Inject(method = "method_13409", at = @At("HEAD")) + private static void setType(CommandContext context, CallbackInfoReturnable cir) { + withoutReason = true; + } + + @Inject( + method = "execute", + at = @At( + value = "FIELD", + target = "Lnet/minecraft/server/network/ServerPlayerEntity;" + + "networkHandler:Lnet/minecraft/server/network/ServerPlayNetworkHandler;" + ) + ) + private static void setKickContext( + ServerCommandSource source, + Collection targets, + Text reason, + CallbackInfoReturnable cir, + @Local ServerPlayerEntity player, + @Local(argsOnly = true) LocalRef reasonRef + ) { + PlaceholderContext context = PlaceholderContext.of(player); + CONTEXT_STORE.put("commands.kick.success", context); + if (!withoutReason) return; + CONTEXT_STORE.put("multiplayer.disconnect.kicked", context); + reasonRef.set(Text.translatable("multiplayer.disconnect.kicked")); + } + + @Inject(method = "execute", at = @At("RETURN")) + private static void resetType( + ServerCommandSource source, + Collection targets, + Text reason, + CallbackInfoReturnable cir + ) { + withoutReason = false; + } +} diff --git a/src/main/resources/assets/implementedTranslationKeys.json b/src/main/resources/assets/implementedTranslationKeys.json new file mode 100644 index 0000000..93099cd --- /dev/null +++ b/src/main/resources/assets/implementedTranslationKeys.json @@ -0,0 +1,84 @@ +{ + "multiplayer": { + "disconnect": { + "server_shutdown": { + "#mixins": [ + "PlayerManager::disconnectAllPlayers", + "ClientConnection::channelRead0" + ], + "#context": "player" + }, + "not_whitelisted": { + "#mixins": [ + "PlayerManager::checkCanJoin/profile", + "MinecraftServer::kickNonWhitelistedPlayers/player" + ], + "#context": "profile" + }, + "kicked": { + "#mixin": "KickCommand::execute", + "#context": "player" + }, + "banned": { + "reason": { + "#mixin": "PlayerManager::checkCanJoin", + "#context": "profile" + }, + "expiration": { + "#mixin": "PlayerManager::checkCanJoin", + "#context": "profile" + } + }, + "banned_ip": { + "reason": { + "#mixin": "PlayerManager::checkCanJoin", + "#context": "profile" + }, + "expiration": { + "#mixin": "PlayerManager::checkCanJoin", + "#context": "profile" + } + } + }, + "player": { + "joined": { + "#mixin": "PlayerManager::onPlayerConnect", + "#context": "player", + "renamed": { + "#mixin": "PlayerManager::onPlayerConnect", + "#context": "player" + } + }, + "left": { + "#mixin": "ServerPlayNetworkHandler::cleanUp", + "#context": "player" + } + } + }, + "commands": { + "kick": { + "success": { + "#mixin": "KickCommand::execute", + "#context": "player" + } + } + }, + "chat": { + "type": { + "advancement": { + "task": { + "#mixin": "AdvancementFrame::getChatAnnouncementText", + "#context": "player" + }, + "challenge": { + "#mixin": "AdvancementFrame::getChatAnnouncementText", + "#context": "player" + }, + "goal": { + "#mixin": "AdvancementFrame::getChatAnnouncementText", + "#context": "player" + } + } + } + } +} \ No newline at end of file diff --git a/src/main/resources/assets/translationKeySupport.json b/src/main/resources/assets/translationKeySupport.json new file mode 100644 index 0000000..471f594 --- /dev/null +++ b/src/main/resources/assets/translationKeySupport.json @@ -0,0 +1,57 @@ +{ + "// EXPLANATIONS //": "// ------ //", + "fully ... side": "these messages are only used by this side, the other side never uses this", + "primarily ... side": "these messages are primarily used by this side, but sometimes also by the other", + "mostly ... side": "most of these messages are used by this side", + "some ... side": "some of these messages are used by this side", + "// SERVER //": "// ------ //", + "advancement.*": "fully server side", + "build.*": "fully server side", + "clear.*": "fully server side", + "commands.*": "fully server side", + "death.*": "fully server side", + "parsing.*": "primarily server side", + "// BOTH //": "// ------ //", + "command.*": "mostly server side", + "multiplayer.disconnect.*": "mostly server side", + "multiplayer.player.*": "mostly server side", + "chat.*": "some server side", + "multiplayer.*": "some server side", + "argument.*": "server and client side; errors are shown as preview on client using client lang and as error message from the server using this value; Everything else is (probably) purely client sided", + "chat.type.*": "mostly client side, can be easily overwritten server wide using data packs; see [Chat type](https://minecraft.wiki/w/Chat_type)", + "// CLIENT //": "// ------ //", + "advancements.*": "primarily client side; can be easily overwritten server wide using data packs; see [Advancement definition](https://minecraft.wiki/w/Advancement_definition)", + "attribute.*": "primarily client side", + "biome.*": "primarily client side", + "block.*": "primarily client side", + "container.*": "primarily client side", + "effect.*": "primarily client side", + "enchantment.*": "primarily client side", + "entity.*": "primarily client side", + "filled_map.*": "primarily client side", + "item.*": "primarily client side", + "painting.*": "primarily client side", + "// CLIENT ONLY //": "// ------ //", + "disconnect.*": "(probably) fully client side", + "book.*": "fully client side", + "color.*": "fully client side", + "connect.*": "fully client side", + "controls.*": "fully client side", + "createWorld.*": "fully client side", + "dataPack.*": "fully client side", + "deathScreen.*": "fully client side", + "debug.*": "fully client side", + "gamerule.*": "fully client side", + "gui.*": "fully client side", + "key.*": "fully client side", + "menu.*": "fully client side", + "options.*": "fully client side", + "pack.*": "fully client side", + "resourcePack.*": "fully client side", + "sleep.*": "fully server side", + "stat.*": "fully client side", + "subtitles.*": "fully client side", + "title.*": "fully client side", + "// OTHER //": "// ------ //", + "everything else": "fully client side / not relevant" +} \ 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..a6037dd --- /dev/null +++ b/src/main/resources/fabric.mod.json @@ -0,0 +1,30 @@ +{ + "schemaVersion": 1, + "id": "servermessages", + "version": "${version}", + "name": "Server Messages", + "description": "", + "authors": [ + "arvitus" + ], + "contact": { + "issues": "https://github.com/arvitus/ServerMessages", + "sources": "https://github.com/arvitus/ServerMessages" + }, + "license": "GPL-3.0", + "icon": "assets/icon.png", + "environment": "server", + "entrypoints": { + "main": [ + "de.example.servermessages.ServerMessages" + ] + }, + "mixins": [ + "servermessages.mixins.json" + ], + "depends": { + "fabricloader": ">=${loader_version}", + "fabric": "*", + "minecraft": "${minecraft_version}" + } +} diff --git a/src/main/resources/servermessages.mixins.json b/src/main/resources/servermessages.mixins.json new file mode 100644 index 0000000..0bc4531 --- /dev/null +++ b/src/main/resources/servermessages.mixins.json @@ -0,0 +1,18 @@ +{ + "required": true, + "minVersion": "0.8", + "package": "de.example.servermessages.mixin", + "compatibilityLevel": "JAVA_21", + "mixins": [ + "MutableTextMixin", + "context.AdvancementFrameMixin", + "context.ClientConnectionMixin", + "context.MinecraftServerMixin", + "context.PlayerManagerMixin", + "context.ServerPlayNetworkHandlerMixin", + "context.commands.KickCommand" + ], + "injectors": { + "defaultRequire": 1 + } +}