diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..94f480d --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto eol=lf \ No newline at end of file diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..10ec787 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @Chicken \ No newline at end of file diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..c07d9ca --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,131 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +- Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or + advances of any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email + address, without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at [antti@antti.codes](mailto:antti@antti.codes). +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][mozilla coc]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][faq]. Translations are available +at [https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html +[mozilla coc]: https://github.com/mozilla/diversity +[faq]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..d539b7f --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# Contributing + +## Suggestions & Issues + +To suggest features for the project use the GitHub issue tracker. + +For issues and bugs follow the instructions of [SECURITY.md](SECURITY.md) + +## Pull requests + +Contributors are welcome. Feel free to fork and submit a pull request for review. + +1. Fork & clone +1. Create a new branch +1. Code away +1. Commit & push +1. Submit the pull request + +## Guidelines + +To make sure that your pull request gets accepted you need to follow some guidelines. +This is not everything but a list of basic things. Think before you do. + +- Follow some best practices +- Keep the code clean looking and formatted +- Resolve requested changes +- Do proper testing diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..e74dc43 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,24 @@ +--- +name: Bug report +about: Found a bug? Report it using this! +title: "Bug: " +labels: "bug" +assignees: "" +--- + +**Description of the bug** + + + +**Reproducing** + + + +**Expected behavior** + + diff --git a/.github/ISSUE_TEMPLATE/feature_requst.md b/.github/ISSUE_TEMPLATE/feature_requst.md new file mode 100644 index 0000000..a521af3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_requst.md @@ -0,0 +1,15 @@ +--- +name: Feature request +about: A great new idea for the project! +title: "Feat: " +labels: "enchantment" +assignees: "" +--- + +**Goal of this feature** + + + +**Describe the feature** + + diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..f6fdebe --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,11 @@ +# Security Policy + +## Supported Versions + +Support is limited to the latest release and latest revision of the master branch. + +## Reporting a Vulnerability + +If you find a vulnerability in the project please report it immediately. +If you deem the vulnerability exploitable in any shape or form please report it through [email](mailto:antti@antti.codes), [matrix](https://matrix.to/#/@antti:antti.codes) or Discord (Chicken#4127). +In case the vulnerability is not exploitable report it through the GitHub issue tracker. diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..75d5418 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,33 @@ +name: Java CI + +on: [push, pull_request] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + + - name: Set up Java + uses: actions/setup-java@v3 + with: + distribution: 'temurin' + java-version: 17 + + - uses: actions/cache@v3 + with: + path: | + ~/.gradle/caches + ~/.gradle/wrapper + key: "${{ runner.os }}-bmt-${{ hashFiles('**/*.gradle*') }}" + restore-keys: ${{ runner.os }}-bmt- + + - name: Build with Gradle + run: ./gradlew clean build + + - name: Upload output + uses: actions/upload-artifact@v3 + with: + name: output + path: build/libs/* \ No newline at end of file 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 b/LICENSE new file mode 100644 index 0000000..e72bfdd --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..7996867 --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# BlueMap-Towny + +> *[BlueMap](https://github.com/BlueMap-Minecraft/BlueMap) addon for showing your [Towny](https://github.com/TownyAdvanced/Towny) towns on your beautiful map* + +## Installation + +Put the plugin jar file inside your plugins folder and have both Towny and BlueMap installed. + +## Config + +```yml +# BlueMap-Towny configuration +# https://github.com/Chicken/BlueMap-Towny#config + +# Seconds between checks for marker updates +update-interval: 30 +# Set by /n set mapcolor +dynamic-nation-colors: true +# Set by /t set mapcolor +dynamic-town-colors: true +# HTML for town popup, placeholders documented in README +popup: '%name% (%nation%)
Mayor %mayor%
Residents %residents%
Bank %bank%' + +style: + # Y-level to put markers at + y-level: 62 + # Town border settings + border-color: '#FF0000' + border-opacity: 0.8 + border-width: 3 + # Town fill settings + fill-color: '#FF0000' + fill-opacity: 0.35 + # Path to icons on web or a link + # Town home + home-icon-enabled: false + home-icon: assets/house.png + # Nation capital + capital-icon-enabled: false + capital-icon: assets/king.png +``` + +### Popup placeholders + +| Placeholder | Content | +|--------------------------|----------------------------------| +| `%name%` | Town name | +| `%mayor%` | Town mayor | +| `%residents%` | Town residents | +| `%assistants%` | Town assistants | +| `%residentdisplaynames%` | Town residents but display names | +| `%residentcount%` | Number of town residents | +| `%founded%` | Town founding date | +| `%board%` | Town board text | +| `%trusted%` | Town trusted residents | +| `%tax%` | Town tax | +| `%bank%` | Town bank balance | +| `%nation%` | Nation of the town | +| `%nationstatus%` | Capital/Member of ... | +| `%public%` | Town publicity status | +| `%peaceful%` | Is the town peaceful | +| `%flags%` | Flags of the town (pvp, mobs...) | + +## Building + +`./gradlew clean build` + +Output in `build/libs/` \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..0ca0a98 --- /dev/null +++ b/build.gradle @@ -0,0 +1,57 @@ +plugins { + id 'java' +} + +group = 'codes.antti' +version = '1.0.0' + +repositories { + mavenCentral() + maven { + name = 'papermc' + url = 'https://repo.papermc.io/repository/maven-public/' + } + maven { + name = 'sonatype' + url = 'https://oss.sonatype.org/content/groups/public/' + } + maven { + name = 'glaremasters' + url = 'https://repo.glaremasters.me/repository/towny/' + } + maven { + name = 'jitpack' + url 'https://jitpack.io/' + } +} + +dependencies { + compileOnly 'io.papermc.paper:paper-api:1.18.2-R0.1-SNAPSHOT' + compileOnly 'com.palmergames.bukkit.towny:towny:0.98.3.0' + compileOnly 'com.github.BlueMap-Minecraft:BlueMapAPI:v2.1.0' +} + +def targetJavaVersion = 17 +java { + def javaVersion = JavaVersion.toVersion(targetJavaVersion) + sourceCompatibility = javaVersion + targetCompatibility = javaVersion + if (JavaVersion.current() < javaVersion) { + toolchain.languageVersion = JavaLanguageVersion.of(targetJavaVersion) + } +} + +tasks.withType(JavaCompile).configureEach { + if (targetJavaVersion >= 10 || JavaVersion.current().isJava10Compatible()) { + options.release = targetJavaVersion + } +} + +processResources { + def props = [version: version] + inputs.properties props + filteringCharset 'UTF-8' + filesMatching('plugin.yml') { + expand props + } +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..7454180 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..2e6e589 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/gradlew @@ -0,0 +1,234 @@ +#!/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/master/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 + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# 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"' + +# 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 + which java >/dev/null 2>&1 || 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 + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + 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 + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# 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..ac1b06f --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@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=. +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%" == "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%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..926808f --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'BlueMap-Towny' diff --git a/src/main/java/codes/antti/bluemaptowny/BlueMapTowny.java b/src/main/java/codes/antti/bluemaptowny/BlueMapTowny.java new file mode 100644 index 0000000..29b3701 --- /dev/null +++ b/src/main/java/codes/antti/bluemaptowny/BlueMapTowny.java @@ -0,0 +1,237 @@ +package codes.antti.bluemaptowny; + +import com.flowpowered.math.vector.Vector2d; +import com.flowpowered.math.vector.Vector2i; +import com.flowpowered.math.vector.Vector3d; +import com.palmergames.bukkit.config.ConfigNodes; +import com.palmergames.bukkit.towny.TownyAPI; +import com.palmergames.bukkit.towny.TownyEconomyHandler; +import com.palmergames.bukkit.towny.TownyFormatter; +import com.palmergames.bukkit.towny.TownySettings; +import com.palmergames.bukkit.towny.object.Town; +import com.palmergames.bukkit.towny.object.TownyObject; +import com.palmergames.bukkit.towny.utils.TownRuinUtil; +import de.bluecolored.bluemap.api.BlueMapAPI; +import de.bluecolored.bluemap.api.markers.*; +import de.bluecolored.bluemap.api.math.Color; +import de.bluecolored.bluemap.api.math.Line; +import de.bluecolored.bluemap.api.math.Shape; +import org.bukkit.Bukkit; +import org.bukkit.Location; +import org.bukkit.World; +import org.bukkit.configuration.Configuration; +import org.bukkit.entity.Player; +import org.bukkit.plugin.java.JavaPlugin; + +import java.util.*; +import java.util.concurrent.ConcurrentHashMap; +import java.util.stream.Collectors; + +public final class BlueMapTowny extends JavaPlugin { + private final Map townMarkerSets = new ConcurrentHashMap<>(); + private Configuration config; + + @Override + public void onEnable() { + BlueMapAPI.onEnable((api) -> { + reloadConfig(); + saveDefaultConfig(); + this.config = getConfig(); + initMarkerSets(); + Bukkit.getScheduler().runTaskTimer(this, this::updateMarkers, 0, this.config.getLong("update-interval") * 20); + }); + BlueMapAPI.onDisable((api) -> { + Bukkit.getScheduler().cancelTasks(this); + }); + } + + private void initMarkerSets() { + BlueMapAPI.getInstance().ifPresent((api) -> { + townMarkerSets.clear(); + for (World world : Bukkit.getWorlds()) { + api.getWorld(world.getName()).ifPresent((bmWorld) -> { + MarkerSet set = new MarkerSet("Towns"); + townMarkerSets.put(world.getName(), set); + bmWorld.getMaps().forEach((map) -> { + map.getMarkerSets().put("towny", set); + }); + }); + } + }); + } + + private Color getFillColor(Town town) { + String opacity = String.format("%02X", (int) (this.config.getDouble("style.fill-opacity") * 255)); + + if (this.config.getBoolean("dynamic-town-colors")) { + String hex = town.getMapColorHexCode(); + if (hex != null) { + return new Color("#" + hex + opacity); + } + } + + if (this.config.getBoolean("dynamic-nation-colors")) { + String hex = town.getNationMapColorHexCode(); + if (hex != null) { + return new Color("#" + hex + opacity); + } + } + + return new Color(this.config.getString("style.fill-color") + opacity); + } + + private Color getLineColor(Town town) { + String opacity = String.format("%02X", (int) (this.config.getDouble("style.border-opacity") * 255)); + + if (this.config.getBoolean("dynamic-nation-colors")) { + String hex = town.getNationMapColorHexCode(); + if (hex != null) { + return new Color("#" + hex + opacity); + } + } + + if (this.config.getBoolean("dynamic-town-colors")) { + String hex = town.getMapColorHexCode(); + if (hex != null) { + return new Color("#" + hex + opacity); + } + } + + return new Color(this.config.getString("style.border-color") + opacity); + } + + private String fillPlaceholders(String template, Town town) { + String t = template; + + t = t.replace("%name%", town.getName()); + + t = t.replace("%mayor%", town.hasMayor() ? town.getMayor().getName() : ""); + + String[] residents = town.getResidents().stream().map(TownyObject::getName).toList().toArray(String[]::new); + if (residents.length > 34) { + String[] old = residents; + residents = new String[35 + 1]; + System.arraycopy(old, 0, residents, 0, 35); + residents[35] = "and more..."; + } + t = t.replace("%residents%", String.join(", ", residents)); + + String[] residentsDisplay = town.getResidents().stream().map((r) -> { + Player p = Bukkit.getPlayer(r.getName()); + if (p == null) return r.getFormattedName(); + return p.displayName().toString(); + }).toList().toArray(String[]::new); + if (residentsDisplay.length > 34) { + String[] old = residentsDisplay; + residentsDisplay = new String[35 + 1]; + System.arraycopy(old, 0, residentsDisplay, 0, 35); + residentsDisplay[35] = "and more..."; + } + t = t.replace("%residentdisplaynames%", String.join(", ", residentsDisplay)); + + t = t.replace("%assistants%", String.join(", ", town.getRank("assistant").stream().map(TownyObject::getName).toList().toArray(new String[0]))); + + t = t.replace("%residentcount%", "" + town.getResidents().size()); + + t = t.replace("%founded%", town.getRegistered() != 0 ? TownyFormatter.registeredFormat.format(town.getRegistered()) : "None"); + + t = t.replace("%board%", town.getBoard()); + + t = t.replace("%trusted%", town.getTrustedResidents().isEmpty() ? "None" : town.getTrustedResidents().stream().map(TownyObject::getName).collect(Collectors.joining(", "))); + + if (TownySettings.isUsingEconomy() && TownyEconomyHandler.isActive()) { + if (town.isTaxPercentage()) t = t.replace("%tax%", town.getTaxes() + "%"); + else t = t.replace("%tax%", TownyEconomyHandler.getFormattedBalance(town.getTaxes())); + t = t.replace("%bank%", TownyEconomyHandler.getFormattedBalance(town.getAccount().getCachedBalance())); + } + + String nation = town.hasNation() ? Objects.requireNonNull(town.getNationOrNull()).getName() : ""; + t = t.replace("%nation%", nation); + t = t.replace("%nationstatus%", town.hasNation() ? (town.isCapital() ? "Capital of " + nation : "Member of " + nation) : ""); + + t = t.replace("%public%", town.isPublic() ? "true" : "false"); + + t = t.replace("%peaceful%", town.isNeutral() ? "true" : "false"); + + List flags = new ArrayList<>(); + flags.add("Has Upkeep: " + town.hasUpkeep()); + flags.add("PvP: " + town.isPVP()); + flags.add("Mobs: " + town.hasMobs()); + flags.add("Explosion: " + town.isBANG()); + flags.add("Fire: " + town.isFire()); + flags.add("Nation: " + nation); + if (TownySettings.getBoolean(ConfigNodes.TOWN_RUINING_TOWN_RUINS_ENABLED)) { + String ruinedString = "Ruined: " + town.isRuined(); + if (town.isRuined()) ruinedString += " (Time left: " + (TownySettings.getTownRuinsMaxDurationHours() - TownRuinUtil.getTimeSinceRuining(town)) + " hours)"; + flags.add(ruinedString); + } + t = t.replace("%flags%", String.join("
", flags)); + + return t; + } + + private void updateMarkers() { + BlueMapAPI.getInstance().ifPresent((api) -> { + for (World world : Bukkit.getWorlds()) { + if (api.getWorld(world.getName()).isEmpty()) continue; + Map markers = townMarkerSets.get(world.getName()).getMarkers(); + markers.clear(); + Objects.requireNonNull(TownyAPI.getInstance().getTownyWorld(world)).getTowns().forEach((k, town) -> { + List> borders = new ArrayList<>(); + List> areas = new ArrayList<>(); + Set chunks = town.getTownBlocks().stream().map((tb) -> new Vector2i(tb.getX(), tb.getZ())).collect(Collectors.toSet()); + MapUtils.areaToBlockPolygon(chunks, TownySettings.getTownBlockSize(), areas, borders); + int layerY = this.config.getInt("style.y-level"); + String townName = town.getName(); + String townDetails = fillPlaceholders(this.config.getString("popup"), town); + int seq = 0; + for (List area : areas) { + ShapeMarker chunkMarker = new ShapeMarker.Builder() + .label(townName) + .detail(townDetails) + .lineColor(new Color(0)) + .fillColor(getFillColor(town)) + .depthTestEnabled(false) + .shape(new Shape(area), (float) layerY) + .centerPosition() + .build(); + markers.put("towny." + townName + ".area." + seq, chunkMarker); + seq += 1; + } + seq = 0; + for (List border : borders) { + LineMarker borderMarker = new LineMarker.Builder() + .label(townName) + .detail(townDetails) + .lineColor(getLineColor(town)) + .lineWidth(this.config.getInt("style.border-width")) + .depthTestEnabled(false) + .line(new Line(border.stream().map(v2 -> Vector3d.from(v2.getX(), layerY, v2.getY())).toList())) + .centerPosition() + .build(); + markers.put("towny." + townName + ".border." + seq, borderMarker); + seq += 1; + } + Optional spawn = Optional.ofNullable(town.getSpawnOrNull()); + if (this.config.getBoolean("style.capital-icon-enabled") && spawn.isPresent() && town.isCapital()) { + POIMarker iconMarker = new POIMarker.Builder() + .label(townName) + // TODO: .detail(townDetails) - not a BlueMap feature yet + .icon(this.config.getString("style.capital-icon"), 8, 8) + .position((int) spawn.get().getX(), layerY, (int) spawn.get().getZ()) + .build(); + markers.put("towny." + townName + ".icon", iconMarker); + } else if (this.config.getBoolean("style.home-icon-enabled") && spawn.isPresent()) { + POIMarker iconMarker = new POIMarker.Builder() + .label(townName) + // TODO: .detail(townDetails) - not a BlueMap feature yet + .icon(this.config.getString("style.home-icon"), 8, 8) + .position((int) spawn.get().getX(), layerY, (int) spawn.get().getZ()) + .build(); + markers.put("towny." + townName + ".icon", iconMarker); + } + }); + } + }); + } +} diff --git a/src/main/java/codes/antti/bluemaptowny/MapUtils.java b/src/main/java/codes/antti/bluemaptowny/MapUtils.java new file mode 100644 index 0000000..9f9a81b --- /dev/null +++ b/src/main/java/codes/antti/bluemaptowny/MapUtils.java @@ -0,0 +1,230 @@ +/* + * Code from: Mark-225/NeincraftPlugin (https://github.com/Mark-225/NeincraftPlugin/blob/3a87dcd2f9c9d63a1ac43726f9bacd93c9f138cb/src/main/java/de/neincraft/neincraftplugin/modules/plots/util/PlotUtils.java) + * License: GNU General Public License v3.0 (https://github.com/Mark-225/NeincraftPlugin/blob/3a87dcd2f9c9d63a1ac43726f9bacd93c9f138cb/LICENSE) + * Author: Mark-225 (https://github.com/Mark-225) + * Changes: Class renamed, unused methods removed and support for non 16x16 chunks + */ + +package codes.antti.bluemaptowny; + +import com.flowpowered.math.vector.Vector2d; +import com.flowpowered.math.vector.Vector2i; + +import java.util.*; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +public abstract class MapUtils { + /** + * Entrypoint for the polygon conversion algorithm + * @param chunks the chunks to convert + * @param areaPolygons a list of polygons to fill with area polygons (in chunk coordinates) + * @param borderPolygons a list of polygons to fill with border polygons (in chunk coordinates) + */ + public static void areaToPolygons(Set chunks, List> areaPolygons, List> borderPolygons) { + List> sectors = findSectors(chunks); + sectors.forEach(sector -> traceArea(sector, areaPolygons, borderPolygons)); + } + + /** + * Most user-friendly entry point. Converts a set of chunk coordinates to multiple area and border polygons. + * @param chunks The set of chunk coordinates to convert. + * @param areaPolygons The list to add the area polygons to. + * @param borderPolygons The list to add the border polygons to. + */ + public static void areaToBlockPolygon(Set chunks, int blockSize, List> areaPolygons, List> borderPolygons){ + List> areaChunkPolygons = new ArrayList<>(); + List> borderChunkPolygons = new ArrayList<>(); + areaToPolygons(chunks, areaChunkPolygons, borderChunkPolygons); + areaPolygons.addAll(areaChunkPolygons.stream().map(polygon -> polygon.stream().map(vector -> vector.mul(blockSize).toDouble()).toList()).toList()); + borderPolygons.addAll(borderChunkPolygons.stream().map(polygon -> polygon.stream().map(vector -> vector.mul(blockSize).toDouble()).toList()).toList()); + } + + /** + * Creates border polygons and splits the area into two sectors if a hole is found. Then recursively calls itself for each sector. + * @param chunks the sector to convert into polygons + * @param areaPolygons the list of polygons that will be filled with the area polygons + * @param borderPolygons the list of polygons that will be filled with the border polygons + */ + private static void traceArea(Set chunks, List> areaPolygons, List> borderPolygons){ + Set westBorders = new HashSet<>(); + Set southBorders = new HashSet<>(); + Set northBorders = new HashSet<>(); + Set eastBorders = new HashSet<>(); + + chunks.forEach(chunk -> { + if(!chunks.contains(chunk.add(-1, 0))) + westBorders.add(chunk); + if(!chunks.contains(chunk.add(1, 0))) + eastBorders.add(chunk); + if(!chunks.contains(chunk.add(0, 1))) + southBorders.add(chunk); + if(!chunks.contains(chunk.add(0, -1))) + northBorders.add(chunk); + }); + + Map westSegments = findSegments(westBorders, Vector2i.from(0, -1)); + Map southSegments = findSegments(southBorders, Vector2i.from(-1, 0)); + Map eastSegments = findSegments(eastBorders, Vector2i.from(0, 1)); + Map northSegments = findSegments(northBorders, Vector2i.from(1, 0)); + + Map> segments = Map.of( + Direction.NORTH, new HashMap<>(northSegments), + Direction.EAST, new HashMap<>(eastSegments), + Direction.SOUTH, new HashMap<>(southSegments), + Direction.WEST, new HashMap<>(westSegments)); + + while(!segments.get(Direction.NORTH).isEmpty()) { + Vector2i startVector = findNext(segments.get(Direction.NORTH).keySet()); + List coordinates = new ArrayList<>(); + coordinates.add(startVector); + coordinates.addAll(traceOneLoop(segments, startVector)); + borderPolygons.add(coordinates); + } + + if(borderPolygons.size() > 1){ + int splitY = borderPolygons.get(1).get(0).getY(); + Set northChunks = chunks.stream().filter(chunk -> chunk.getY() < splitY).collect(Collectors.toSet()); + Set southChunks = chunks.stream().filter(chunk -> chunk.getY() >= splitY).collect(Collectors.toSet()); + for(Set northSector : findSectors(northChunks)){ + traceArea(northSector, areaPolygons, new ArrayList<>()); + } + for(Set southSector : findSectors(southChunks)){ + traceArea(southSector, areaPolygons, new ArrayList<>()); + } + }else if(!borderPolygons.isEmpty()){ + areaPolygons.add(borderPolygons.get(0)); + } + } + + /** + * Creates a polygon by tracing border vectors until it reaches the starting vector again. + * @param segments the border segments (represented by vector pairs) to trace + * @param start the starting vector + * @return A list of vectors representing the polygon + */ + private static List traceOneLoop(Map> segments, Vector2i start){ + List coordinates = new ArrayList<>(); + Direction currentDirection = Direction.NORTH; + Vector2i currentTarget; + Vector2i currentStart = start; + while((currentTarget = segments.get(currentDirection).get(currentStart)) != null){ + Vector2i coordinateTarget = currentTarget.add(currentDirection == Direction.NORTH || currentDirection == Direction.EAST ? 1 : 0, currentDirection == Direction.EAST || currentDirection == Direction.SOUTH ? 1 : 0); + coordinates.add(coordinateTarget); + segments.get(currentDirection).remove(currentStart); + if(segments.get(currentDirection.getPrimary()).containsKey(currentTarget)){ + currentDirection = currentDirection.getPrimary(); + currentStart = currentTarget; + }else if(segments.get(currentDirection.getSecondary()).containsKey(currentTarget.add(currentDirection.getSecondaryOffset()))){ + currentStart = currentTarget.add(currentDirection.getSecondaryOffset()); + currentDirection = currentDirection.getSecondary(); + }else{ + break; + } + } + return coordinates; + } + + /** + * Splits a set of chunks into sectors using breadth-first search. A sector is a subset of chunks in which each chunk can be reached by every other chunk using only straight lines. + * @param chunks The chunks to split into sectors. + * @return A list of sectors. + */ + private static List> findSectors(Set chunks){ + List> sectors = new ArrayList<>(); + while (!chunks.isEmpty()){ + Set sector = new HashSet<>(); + boolean changed = true; + Set searchSources = new HashSet<>(); + Vector2i firstChunk = chunks.iterator().next(); + sector.add(firstChunk); + searchSources.add(firstChunk); + while(changed){ + changed = false; + Set addedChunks = new HashSet<>(); + for(Vector2i chunk : searchSources){ + addedChunks.addAll(Stream.of(chunk.add(0, -1), + chunk.add(0, 1), + chunk.add(1, 0), + chunk.add(-1, 0)) + .filter(c -> !sector.contains(c) && chunks.contains(c)).collect(Collectors.toCollection(HashSet::new))); + } + if(!addedChunks.isEmpty()){ + changed = true; + searchSources = addedChunks; + sector.addAll(addedChunks); + } + } + sectors.add(sector); + chunks.removeAll(sector); + } + return sectors; + } + + /** + * Finds the most north-west vector in a set of vectors. + * Ensures some predictability for the order in which the algorithm operates + * @param vectors the set of vectors + */ + private static Vector2i findNext(Set vectors){ + Vector2i min = null; + for(Vector2i cur : vectors){ + if(min == null || cur.getY() < min.getY()|| (cur.getY() == min.getY() && cur.getX() < min.getX())){ + min = cur; + } + } + return min; + } + + /** + * Creates border vector pairs from a collection of border chunks + * @param borders the collection of border chunks + * @param forwardOffset the vector that defines the "forward" direction for the given border chunks + */ + private static Map findSegments(Set borders, Vector2i forwardOffset){ + Map segments = new HashMap<>(); + while(!borders.isEmpty()){ + Vector2i start = borders.iterator().next(); + Vector2i prev; + while(borders.contains(prev = start.sub(forwardOffset))) start = prev; + + Vector2i end = start; + Vector2i next; + borders.remove(start); + while(borders.contains(next = end.add(forwardOffset))){ + end = next; + borders.remove(next); + } + segments.put(start, end); + } + return segments; + } + + public static enum Direction{ + NORTH(1, 3, Vector2i.from(1, -1)), + EAST(2, 0, Vector2i.from(1, 1)), + SOUTH(3, 1, Vector2i.from(-1, 1)), + WEST(0, 2, Vector2i.from(-1, -1)); + + private final int primary; + private final int secondary; + private final Vector2i secondaryOffset; + Direction(int primary, int secondary, Vector2i secondaryOffset) { + this.primary = primary; + this.secondary = secondary; + this.secondaryOffset = secondaryOffset; + } + + public Direction getPrimary(){ + return Direction.values()[primary]; + } + + public Direction getSecondary(){ + return Direction.values()[secondary]; + } + + public Vector2i getSecondaryOffset() { + return secondaryOffset; + } + } +} \ No newline at end of file diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml new file mode 100644 index 0000000..bd979b1 --- /dev/null +++ b/src/main/resources/config.yml @@ -0,0 +1,29 @@ +# BlueMap-Towny configuration +# https://github.com/Chicken/BlueMap-Towny#config + +# Seconds between checks for marker updates +update-interval: 30 +# Set by /n set mapcolor +dynamic-nation-colors: true +# Set by /t set mapcolor +dynamic-town-colors: true +# HTML for town popup, placeholders documented in README +popup: '%name% (%nation%)
Mayor %mayor%
Residents %residents%
Bank %bank%' + +style: + # Y-level to put markers at + y-level: 62 + # Town border settings + border-color: '#FF0000' + border-opacity: 0.8 + border-width: 3 + # Town fill settings + fill-color: '#FF0000' + fill-opacity: 0.35 + # Path to icons on web or a link + # Town home + home-icon-enabled: false + home-icon: assets/house.png + # Nation capital + capital-icon-enabled: false + capital-icon: assets/king.png diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml new file mode 100644 index 0000000..15f7e1d --- /dev/null +++ b/src/main/resources/plugin.yml @@ -0,0 +1,7 @@ +name: BlueMap-Towny +description: 'BlueMap addon for showing your Towny towns on your beautiful map' +version: '${version}' +author: 'Antti ' +main: codes.antti.bluemaptowny.BlueMapTowny +api-version: 1.18 +depend: [ BlueMap, Towny ] \ No newline at end of file