mirror of
https://github.com/MiniPlaceholders/MiniPlaceholders.git
synced 2026-11-04 16:50:11 -05:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Adrian3d04
|
17a2ff73b2 |
No files matched your search
+13
-2
@@ -1,2 +1,13 @@
|
||||
github: 4drian3d
|
||||
custom: https://paypal.me/4drian3d
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
|
||||
patreon: # Replace with a single Patreon username
|
||||
open_collective: # Replace with a single Open Collective username
|
||||
ko_fi: # Replace with a single Ko-fi username
|
||||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||
liberapay: # Replace with a single Liberapay username
|
||||
issuehunt: # Replace with a single IssueHunt username
|
||||
otechie: # Replace with a single Otechie username
|
||||
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
|
||||
custom: https://paypal.me/4drian3d # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
||||
@@ -8,24 +8,24 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@v7
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Set up JDK 25
|
||||
uses: actions/setup-java@v6
|
||||
- name: Set up JDK 17
|
||||
uses: actions/setup-java@v2
|
||||
with:
|
||||
java-version: 25
|
||||
distribution: 'zulu'
|
||||
java-version: 17
|
||||
distribution: 'temurin'
|
||||
cache: 'gradle'
|
||||
|
||||
- name: Build with Gradle
|
||||
uses: nick-invision/retry@v4
|
||||
uses: nick-invision/retry@v2
|
||||
with:
|
||||
timeout_minutes: 10
|
||||
timeout_minutes: 4
|
||||
max_attempts: 2
|
||||
command: gradle build
|
||||
|
||||
- name: Upload Artifacts
|
||||
uses: actions/upload-artifact@v7
|
||||
uses: actions/upload-artifact@v2
|
||||
with:
|
||||
name: MiniPlaceholders
|
||||
path: jar/MiniPlaceholders-*.jar
|
||||
path: build/libs/MiniPlaceholders.jar
|
||||
@@ -2,7 +2,6 @@
|
||||
/.idea/
|
||||
build/
|
||||
bin/
|
||||
jar/
|
||||
|
||||
# Visual Studio Code
|
||||
|
||||
|
||||
Vendored
+1
-1
@@ -1,3 +1,3 @@
|
||||
FROM gitpod/workspace-full
|
||||
|
||||
RUN bash -c ". /home/gitpod/.sdkman/bin/sdkman-init.sh && sdk install java 21.0.6.fx-zulu"
|
||||
RUN bash -c ". /home/gitpod/.sdkman/bin/sdkman-init.sh && sdk install java 17.0.1.fx-zulu"
|
||||
@@ -1,55 +0,0 @@
|
||||
<!--
|
||||
MiniPlaceholders Changelog
|
||||
-->
|
||||
|
||||
# 3.2.2 (unreleased)
|
||||
|
||||
### Features
|
||||
|
||||
|
||||
### Fixes
|
||||
|
||||
|
||||
### API Additions
|
||||
|
||||
|
||||
<!-- -->
|
||||
|
||||
# 3.2.1 (07/09/2026)
|
||||
|
||||
### Fixes
|
||||
|
||||
- Fixed Fabric 26.2 support
|
||||
|
||||
|
||||
## 3.2.0 (27/03/2026)
|
||||
|
||||
### Features
|
||||
|
||||
- Added support to Fabric 26.1+
|
||||
- Added Minestom support
|
||||
- Updated to Java 25
|
||||
|
||||
|
||||
## 3.1.0 (10/10/2025)
|
||||
|
||||
### Features
|
||||
|
||||
- [feat: Sponge commands implementation](https://github.com/MiniPlaceholders/MiniPlaceholders/commit/7633ada70ed62571b707cbf709fbb5c027c44f46)
|
||||
- [feat: Implement parserel subcommand](https://github.com/MiniPlaceholders/MiniPlaceholders/commit/ea725a81210911a8779545781b56a647d6b84cf3)
|
||||
- [feat: Add --null argument to parse node](https://github.com/MiniPlaceholders/MiniPlaceholders/commit/3cdb7de9f2e675f494c84df693142a817535fe9a)
|
||||
- [misc: Added bstats metrics](https://github.com/MiniPlaceholders/MiniPlaceholders/commit/f648dd8f836d5f2911eaf0bc53f6769ed2a0fdcc)
|
||||
|
||||
### Fixes
|
||||
|
||||
- [fix: Fixed multiple loading expansions](https://github.com/MiniPlaceholders/MiniPlaceholders/commit/f67690f41347031a32d4acd7bb4bb493b42bb4f9)
|
||||
- [fix: Added nullability checks to RelationalAudience](https://github.com/MiniPlaceholders/MiniPlaceholders/commit/8aec3e592ff6774737602a3a3a6187ddb577a681)
|
||||
- [fix: Fixed command formatting](https://github.com/MiniPlaceholders/MiniPlaceholders/commit/de7d14d55d6aeff8dbaf1706dd06bb6812b54390)
|
||||
|
||||
|
||||
### API Additions
|
||||
|
||||
- [feat: Added LoadRequirement#requiredClass and LoadRequirement#anyOf](https://github.com/MiniPlaceholders/MiniPlaceholders/commit/31ee16e41234cabf992736f81eda5bbbdc09d954)
|
||||
- [docs: Replaced some uses of JetBrains annotations with jspecify](https://github.com/MiniPlaceholders/MiniPlaceholders/commit/0f48a4baed91ec5d0fe285649822f189e69a5b57)
|
||||
- [feat: Allow the use of injected constructors when creating an ExpansionProvider](https://github.com/MiniPlaceholders/MiniPlaceholders/commit/bf995b71030064a174532d38282407ab6baa7170)
|
||||
|
||||
@@ -1,201 +1,674 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
1. Definitions.
|
||||
Preamble
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
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.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
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.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
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.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
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.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
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.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
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.
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
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.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
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.
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
0. Definitions.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
"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.
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
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.
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
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.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
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.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
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.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
1. Source Code.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
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.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
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.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
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.
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
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.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
Copyright 2023 4drian3d
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
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
|
||||
2. Basic Permissions.
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
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.
|
||||
|
||||
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.
|
||||
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 <https://www.gnu.org/licenses/>.
|
||||
|
||||
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:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
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
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
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
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
@@ -1,71 +1,13 @@
|
||||
# MiniPlaceholders
|
||||
[](https://github.com/MiniPlaceholders/MiniPlaceholders/actions)
|
||||
[](https://ci.codemc.io/job/MiniPlaceholders/job/MiniPlaceholders/)
|
||||
|
||||
[](https://discord.gg/5NMMzK5mAn)
|
||||
|
||||
|
||||
MiniMessage Component-based Placeholders for PaperMC and Velocity platforms
|
||||
|
||||
|
||||
|
||||
MiniMessage Component-based Placeholders API for Minecraft Platforms.
|
||||
|
||||
## Compatibility
|
||||
- Paper 1.21+
|
||||
- Velocity 3.5+
|
||||
- Fabric 26.1+
|
||||
- Sponge API 12+
|
||||
- Minestom 1.21.11+
|
||||
|
||||
## User Usage
|
||||
|
||||
Check our user usage wiki [here](https://miniplaceholders.github.io/docs/user-guide/User-Getting-Started)
|
||||
## Commands:
|
||||
### Velocity
|
||||
`/vminiplaceholders <parse|help> <me|player> <player-to-parse>`
|
||||
### Paper
|
||||
`/miniplaceholders <parse|help> <me|player> <player-to-parse>`
|
||||
|
||||
## API
|
||||
Check the available javadocs [here](https://javadoc.jitpack.io/com/github/4drian3d/MiniPlaceholders/latest/javadoc/index.html)
|
||||
|
||||
Check the available [Javadocs](https://javadoc.io/doc/io.github.miniplaceholders/miniplaceholders-api)
|
||||
|
||||
Or check the [Developer Wiki](https://miniplaceholders.github.io/docs/developer-guide/Developer-Getting-Started)
|
||||
|
||||
### Java
|
||||
```java
|
||||
|
||||
class Main {
|
||||
public static void registerExpansion() {
|
||||
final Expansion expansion = Expansion.builder("my-expansion")
|
||||
.audiencePlaceholder(Player.class, "name", (player, ctx, queue) -> {
|
||||
return Tag.selfClosingInserting(player.getName());
|
||||
})
|
||||
.globalPlaceholder("tps", (ctx, queue) ->
|
||||
Tag.selfClosingInserting(Component.text(Bukkit.getTps()[0]))
|
||||
).build;
|
||||
|
||||
expansion.register();
|
||||
|
||||
Player player;
|
||||
final TagResolver playerResolver = MiniPlaceholders.audiencePlaceholders();
|
||||
player.sendMessage(miniMessage().deserialize("Player Name: <my-expansion_name>", player, playerResolver));
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
### Kotlin
|
||||
```kotlin
|
||||
fun register() {
|
||||
val expansion = expansion("my-expansion") {
|
||||
audience<Player>("name") { player, _, _ ->
|
||||
aud.getName().asClosingTag()
|
||||
}
|
||||
global("tps") { _, _ ->
|
||||
Component.text(Bukkit.getTps()[0]).asInsertingTag()
|
||||
}
|
||||
}
|
||||
|
||||
expansion.register()
|
||||
|
||||
val player: Player
|
||||
val playerResolver = MiniPlaceholders.audiencePlaceholders()
|
||||
player.sendMessage(miniMessage().deserialize("Player Name: <my-expansion_name>", player, playerResolver))
|
||||
}
|
||||
```
|
||||
Or check the wiki [here](https://github.com/4drian3d/MiniPlaceholders/wiki)
|
||||
+57
-80
@@ -1,56 +1,26 @@
|
||||
import java.time.LocalDate
|
||||
|
||||
plugins {
|
||||
id("miniplaceholders.base")
|
||||
alias(libs.plugins.jmh)
|
||||
`java-library`
|
||||
id("com.vanniktech.maven.publish")
|
||||
id("me.champeau.jmh") version "0.6.6"
|
||||
`maven-publish`
|
||||
}
|
||||
|
||||
repositories {
|
||||
mavenCentral()
|
||||
}
|
||||
|
||||
dependencies {
|
||||
compileOnly(libs.adventure.api)
|
||||
compileOnly(libs.adventure.minimessage)
|
||||
compileOnly(libs.adventure.serializer.legacy)
|
||||
compileOnly(projects.miniplaceholdersConnect)
|
||||
compileOnlyApi(libs.unnamedinject)
|
||||
|
||||
testImplementation(platform(libs.junit.bom))
|
||||
compileOnly("net.kyori:adventure-api:4.11.0")
|
||||
compileOnly("net.kyori:adventure-text-minimessage:4.11.0")
|
||||
compileOnly("net.kyori:adventure-text-serializer-legacy:4.11.0")
|
||||
compileOnly(project(":miniplaceholders-connect"))
|
||||
implementation("com.google.code.gson:gson:2.9.1")
|
||||
testImplementation(platform("org.junit:junit-bom:5.8.1"))
|
||||
testImplementation("org.junit.jupiter:junit-jupiter")
|
||||
testRuntimeOnly("org.junit.platform:junit-platform-launcher")
|
||||
testImplementation(libs.adventure.api)
|
||||
testImplementation(libs.adventure.minimessage)
|
||||
testImplementation(libs.adventure.serializer.plain)
|
||||
testImplementation(libs.adventure.serializer.legacy)
|
||||
|
||||
compileOnly(libs.jspecify)
|
||||
}
|
||||
|
||||
jmh {
|
||||
warmupIterations.set(2)
|
||||
iterations.set(2)
|
||||
fork.set(2)
|
||||
testImplementation("net.kyori:adventure-api:4.11.0")
|
||||
testImplementation("net.kyori:adventure-text-minimessage:4.11.0")
|
||||
testImplementation("net.kyori:adventure-text-serializer-plain:4.11.0")
|
||||
}
|
||||
|
||||
tasks {
|
||||
processResources {
|
||||
filteringCharset = Charsets.UTF_8.name()
|
||||
}
|
||||
javadoc {
|
||||
val o = options as StandardJavadocDocletOptions
|
||||
o.encoding = Charsets.UTF_8.name()
|
||||
o.links(
|
||||
"https://jd.papermc.io/adventure/${libs.versions.adventure.get()}/",
|
||||
)
|
||||
o.tags(
|
||||
"apiNote:a:API Note:",
|
||||
"implSpec:a:Implementation Requirements:",
|
||||
"implNote:a:Implementation Note:",
|
||||
"sinceMinecraft:a:Since Minecraft:"
|
||||
)
|
||||
}
|
||||
compileTestJava {
|
||||
options.encoding = Charsets.UTF_8.name()
|
||||
}
|
||||
test {
|
||||
useJUnitPlatform()
|
||||
testLogging {
|
||||
@@ -59,42 +29,49 @@ tasks {
|
||||
}
|
||||
}
|
||||
|
||||
mavenPublishing {
|
||||
publishToMavenCentral()
|
||||
signAllPublications()
|
||||
coordinates(project.group as String, "miniplaceholders-api", project.version as String)
|
||||
jmh {
|
||||
warmupIterations.set(2)
|
||||
iterations.set(2)
|
||||
fork.set(2)
|
||||
}
|
||||
|
||||
pom {
|
||||
name.set(project.name)
|
||||
description.set(project.description)
|
||||
inceptionYear.set(LocalDate.now().year.toString())
|
||||
url.set("https://github.com/MiniPlaceholders/MiniPlaceholders")
|
||||
licenses {
|
||||
license {
|
||||
name.set("The Apache License, Version 2.0")
|
||||
url.set("http://www.apache.org/licenses/LICENSE-2.0.txt")
|
||||
distribution.set("http://www.apache.org/licenses/LICENSE-2.0.txt")
|
||||
}
|
||||
}
|
||||
developers {
|
||||
developer {
|
||||
id.set("4drian3d")
|
||||
name.set("Adrian Gonzales")
|
||||
email.set("adriangonzalesval@gmail.com")
|
||||
}
|
||||
}
|
||||
scm {
|
||||
connection.set("scm:git:https://github.com/MiniPlaceholders/MiniPlaceholders.git")
|
||||
developerConnection.set("scm:git:ssh://git@github.com/MiniPlaceholders/MiniPlaceholders.git")
|
||||
url.set("https://github.com/MiniPlaceholders/MiniPlaceholders")
|
||||
}
|
||||
ciManagement {
|
||||
name.set("GitHub Actions")
|
||||
url.set("https://github.com/MiniPlaceholders/MiniPlaceholders/actions")
|
||||
}
|
||||
issueManagement {
|
||||
name.set("GitHub")
|
||||
url.set("https://github.com/MiniPlaceholders/MiniPlaceholders/issues")
|
||||
java {
|
||||
withSourcesJar()
|
||||
withJavadocJar()
|
||||
toolchain.languageVersion.set(JavaLanguageVersion.of(17))
|
||||
}
|
||||
|
||||
val projectGroup: String = project.group as String
|
||||
val projectVersion: String = project.version as String
|
||||
|
||||
publishing {
|
||||
publications {
|
||||
create<MavenPublication>("maven") {
|
||||
groupId = projectGroup
|
||||
artifactId = project.name
|
||||
version = projectVersion
|
||||
from(components["java"])
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
tasks.withType<Javadoc> {
|
||||
(options as StandardJavadocDocletOptions).links(
|
||||
"https://jd.adventure.kyori.net/api/4.10.0/",
|
||||
"https://jd.adventure.kyori.net/text-minimessage/4.11.0/"
|
||||
)
|
||||
}
|
||||
|
||||
tasks {
|
||||
compileJava {
|
||||
options.encoding = Charsets.UTF_8.name()
|
||||
|
||||
options.release.set(11)
|
||||
}
|
||||
javadoc {
|
||||
options.encoding = Charsets.UTF_8.name()
|
||||
}
|
||||
processResources {
|
||||
filteringCharset = Charsets.UTF_8.name()
|
||||
}
|
||||
}
|
||||
@@ -1,57 +0,0 @@
|
||||
package io.github.miniplaceholders.jmh;
|
||||
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.minimessage.MiniMessage;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
|
||||
import org.openjdk.jmh.annotations.Benchmark;
|
||||
import org.openjdk.jmh.annotations.Scope;
|
||||
import org.openjdk.jmh.annotations.State;
|
||||
|
||||
import io.github.miniplaceholders.api.Expansion;
|
||||
import io.github.miniplaceholders.api.MiniPlaceholders;
|
||||
|
||||
@SuppressWarnings("unused")
|
||||
@State(Scope.Benchmark)
|
||||
public class PlaceholderBenchmark {
|
||||
@Benchmark
|
||||
public void placeholderBench() {
|
||||
BenchAudience player = new BenchAudience("4drian3d");
|
||||
Expansion.Builder expansion = Expansion.builder("benchmark")
|
||||
.audiencePlaceholder(
|
||||
BenchAudience.class,
|
||||
"name",
|
||||
(aud, queue, ctx) -> Tag.selfClosingInserting(Component.text(aud.getName()))
|
||||
)
|
||||
.audiencePlaceholder(
|
||||
BenchAudience.class,
|
||||
"uuid",
|
||||
(aud, queue, ctx) -> Tag.selfClosingInserting(Component.text(aud.getUUID().toString()))
|
||||
)
|
||||
.audiencePlaceholder(
|
||||
"tablistfooter",
|
||||
(aud, queue, ctx) -> Tag.selfClosingInserting(Component.text("footer"))
|
||||
);
|
||||
|
||||
Expansion expansionBuilded = expansion.build();
|
||||
expansionBuilded.register();
|
||||
final TagResolver resolvers = MiniPlaceholders.audiencePlaceholders();
|
||||
|
||||
MiniMessage.miniMessage().deserialize("Player Name: <benchmark_name>", player, resolvers);
|
||||
}
|
||||
|
||||
@Benchmark
|
||||
public void singleBench() {
|
||||
Expansion.builder("single")
|
||||
.globalPlaceholder("servername",
|
||||
(queue, ctx) -> Tag.selfClosingInserting(Component.text("Peruviankkit")))
|
||||
.build()
|
||||
.register();
|
||||
|
||||
TagResolver resolvers = MiniPlaceholders.globalPlaceholders();
|
||||
|
||||
MiniMessage.miniMessage().deserialize("Server name: <single_servername>", resolvers);
|
||||
}
|
||||
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
package io.github.miniplaceholders.jmh;
|
||||
package me.dreamerzero.miniplaceholders;
|
||||
|
||||
import java.util.UUID;
|
||||
|
||||
@@ -0,0 +1,50 @@
|
||||
package me.dreamerzero.miniplaceholders;
|
||||
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.minimessage.MiniMessage;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
|
||||
import org.openjdk.jmh.annotations.Benchmark;
|
||||
import org.openjdk.jmh.annotations.Scope;
|
||||
import org.openjdk.jmh.annotations.State;
|
||||
|
||||
import me.dreamerzero.miniplaceholders.api.Expansion;
|
||||
import me.dreamerzero.miniplaceholders.api.MiniPlaceholders;
|
||||
|
||||
@State(Scope.Benchmark)
|
||||
public class PlaceholderBenchmark {
|
||||
@Benchmark
|
||||
public void placeholderBench(){
|
||||
BenchAudience player = new BenchAudience("4drian3d");
|
||||
Expansion.Builder expansion = Expansion.builder("benchmark")
|
||||
.audiencePlaceholder(
|
||||
"name", (aud, queue, ctx) -> Tag.selfClosingInserting(Component.text(((BenchAudience)aud).getName()))
|
||||
)
|
||||
.audiencePlaceholder(
|
||||
"uuid", (aud, queue, ctx) -> Tag.selfClosingInserting(Component.text(((BenchAudience)aud).getUUID().toString()))
|
||||
)
|
||||
.audiencePlaceholder(
|
||||
"tablistfooter", (aud, queue, ctx) ->Tag.selfClosingInserting(Component.text("footer"))
|
||||
);
|
||||
|
||||
Expansion expansionBuilded = expansion.build();
|
||||
expansionBuilded.audiencePlaceholders(player);
|
||||
final TagResolver resolvers = MiniPlaceholders.getAudiencePlaceholders(player);
|
||||
|
||||
MiniMessage.miniMessage().deserialize("Player Name: <benchmark-name>", resolvers);
|
||||
}
|
||||
|
||||
@Benchmark
|
||||
public void singleBench(){
|
||||
Expansion.builder("single")
|
||||
.globalPlaceholder("servername", (queue, ctx) -> Tag.selfClosingInserting(Component.text("Peruviankkit")))
|
||||
.build()
|
||||
.register();
|
||||
|
||||
TagResolver resolvers = MiniPlaceholders.getGlobalPlaceholders();
|
||||
|
||||
MiniMessage.miniMessage().deserialize("Server name: <single-servername>", resolvers);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,393 +0,0 @@
|
||||
package io.github.miniplaceholders.api;
|
||||
|
||||
import io.github.miniplaceholders.api.placeholder.AudiencePlaceholder;
|
||||
import io.github.miniplaceholders.api.placeholder.GlobalPlaceholder;
|
||||
import io.github.miniplaceholders.api.placeholder.RelationalPlaceholder;
|
||||
import io.github.miniplaceholders.api.resolver.AudienceTagResolver;
|
||||
import io.github.miniplaceholders.api.resolver.GlobalTagResolver;
|
||||
import io.github.miniplaceholders.api.resolver.RelationalTagResolver;
|
||||
import io.github.miniplaceholders.api.types.PlaceholderType;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.builder.AbstractBuilder;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
import org.jetbrains.annotations.ApiStatus;
|
||||
import org.jetbrains.annotations.Contract;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
import org.jspecify.annotations.NullMarked;
|
||||
|
||||
import java.util.Collection;
|
||||
|
||||
/**
|
||||
* Expansion that contains placeholders
|
||||
*
|
||||
* <p>Usage Example:</p>
|
||||
* <pre>
|
||||
* Player player = event.getPlayer();
|
||||
* Expansion.Builder builder = Expansion.builder("player")
|
||||
* .resolver(Player.class, "name", (p, queue, ctx) -> Tag.selfClosingInserting(Component.text(p.getUsername()))
|
||||
* .build();
|
||||
* Expansion expansion = builder.build();
|
||||
* // You can also call the {@link Expansion#register} method to register
|
||||
* // the {@link Expansion} in the {@link MiniPlaceholders} global Extensions and
|
||||
* // use it in {@link MiniPlaceholders#audiencePlaceholders()} e.g.
|
||||
* TagResolver resolver = expansion.resolver();
|
||||
* player.sendMessage(MiniMessage.miniMessage().deserialize("Hello {@literal <luckperms_prefix> <player_name>}", player, resolver));
|
||||
* </pre>
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public sealed interface Expansion permits ExpansionImpl {
|
||||
/**
|
||||
* Get the expansion name
|
||||
*
|
||||
* @return the expansion name
|
||||
* @since 1.0.0
|
||||
*/
|
||||
String name();
|
||||
|
||||
/**
|
||||
* Get the author of this expansion
|
||||
*
|
||||
* @return the author or null
|
||||
* @since 2.3.0
|
||||
*/
|
||||
@Nullable String author();
|
||||
|
||||
/**
|
||||
* Get the version of this expansion
|
||||
*
|
||||
* @return the version or null
|
||||
* @since 2.3.0
|
||||
*/
|
||||
@Nullable String version();
|
||||
|
||||
/**
|
||||
* Get the {@link TagResolver} of an {@link Audience}
|
||||
* @return A TagResolver with variable placeholders of an Audience
|
||||
* @since 1.0.0
|
||||
*/
|
||||
TagResolver audiencePlaceholders();
|
||||
|
||||
/**
|
||||
* Get the relational placeholders based on two audiences
|
||||
*
|
||||
* <p>The resulting TagResolver will give results according
|
||||
* to the 2 {@link Audience} provided and when called
|
||||
* at any time will retrieve the required values</p>
|
||||
* @return A TagResolver with variable placeholders between 2 {@link Audience}s
|
||||
* @since 1.0.0
|
||||
*/
|
||||
TagResolver relationalPlaceholders();
|
||||
|
||||
/**
|
||||
* Get global placeholders
|
||||
* @return the global placeholders
|
||||
* @since 1.0.0
|
||||
*/
|
||||
TagResolver globalPlaceholders();
|
||||
|
||||
/**
|
||||
* Register this expansion
|
||||
* @since 1.0.0
|
||||
* @throws IllegalStateException if the expansion you are trying to register is already registered
|
||||
* @see Expansion#registered()
|
||||
*/
|
||||
void register();
|
||||
|
||||
/**
|
||||
* Unregisters this expansion
|
||||
* @since 2.1.0
|
||||
* @throws IllegalStateException if the expansion you are trying to unregister is not registered
|
||||
* @see Expansion#registered()
|
||||
*/
|
||||
void unregister();
|
||||
|
||||
/**
|
||||
* Get the registration status of this expansion
|
||||
* @return true if the expansion is registered, otherwise false
|
||||
* @since 2.1.0
|
||||
*/
|
||||
boolean registered();
|
||||
|
||||
/**
|
||||
* Get the registered audience placeholders
|
||||
*
|
||||
* @return registered audience placeholders
|
||||
*/
|
||||
Collection<AudiencePlaceholder<?>> registeredAudiencePlaceholders();
|
||||
|
||||
/**
|
||||
* Get the registered relational placeholders
|
||||
*
|
||||
* @return registered relational placeholders
|
||||
*/
|
||||
Collection<RelationalPlaceholder<?>> registeredRelationalPlaceholders();
|
||||
|
||||
/**
|
||||
* Get an Audience Placeholder by name
|
||||
*
|
||||
* <pre>{@code
|
||||
* Expansion expansion = MiniPlaceholders.expansionByName("player")
|
||||
* AudiencePlaceholder<?> placeholder = expansion.audiencePlaceholderByName("name");
|
||||
* }</pre>
|
||||
* @param name the name of the placeholder to search
|
||||
* @return the desired placeholder or null
|
||||
*/
|
||||
@Nullable AudiencePlaceholder<?> audiencePlaceholderByName(final String name);
|
||||
|
||||
/**
|
||||
* Get a Relational Placeholder by name
|
||||
*
|
||||
* <pre>{@code
|
||||
* Expansion expansion = MiniPlaceholders.expansionByName("expansion")
|
||||
* RelationalPlaceholder<?> placeholder = expansion.relationalPlaceholderByName("placeholder");
|
||||
* }</pre>
|
||||
* @param name the name of the placeholder to search
|
||||
* @return the desired placeholder or null
|
||||
* @apiNote The name of a relational placeholder does not contain the prefix “rel”,
|
||||
* just the name assigned when it was created
|
||||
*/
|
||||
@Nullable RelationalPlaceholder<?> relationalPlaceholderByName(final String name);
|
||||
|
||||
/**
|
||||
* Get a Global Placeholder by name
|
||||
*
|
||||
* <pre>{@code
|
||||
* Expansion expansion = MiniPlaceholders.expansionByName("player")
|
||||
* GlobalPlaceholder placeholder = expansion.globalPlaceholderByName("name");
|
||||
* }</pre>
|
||||
* @param name the name of the placeholder to search
|
||||
* @return the desired placeholder or null
|
||||
*/
|
||||
@Nullable GlobalPlaceholder globalPlaceholderByName(final String name);
|
||||
|
||||
/**
|
||||
* Checks whether an audience placeholder with the specified name has been registered in this expansion.
|
||||
*
|
||||
* @param name the name of the placeholder to check
|
||||
* @return true if the placeholder is registered, else false
|
||||
*/
|
||||
default boolean hasAudiencePlaceholder(final String name) {
|
||||
return audiencePlaceholderByName(name) != null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether a relational placeholder with the specified name has been registered in this expansion.
|
||||
*
|
||||
* @param name the name of the placeholder to check
|
||||
* @return true if the placeholder is registered, else false
|
||||
*/
|
||||
default boolean hasRelationalPlaceholder(final String name) {
|
||||
return relationalPlaceholderByName(name) != null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether a global placeholder with the specified name has been registered in this expansion.
|
||||
*
|
||||
* @param name the name of the placeholder to check
|
||||
* @return true if the placeholder is registered, else false
|
||||
*/
|
||||
default boolean hasGlobalPlaceholder(final String name) {
|
||||
return globalPlaceholderByName(name) != null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a TagResolver that contains all placeholders of a specific type in this expansion.
|
||||
*
|
||||
* @param type the desired type
|
||||
* @return a TagResolver containing all placeholder of a specific type
|
||||
*/
|
||||
TagResolver placeholdersByType(PlaceholderType type);
|
||||
|
||||
/**
|
||||
* Creates a new Expansion Builder
|
||||
* @param name the expansion name
|
||||
* @return a new expansion builder
|
||||
* @since 1.0.0
|
||||
*/
|
||||
static Expansion.Builder builder(final String name){
|
||||
return new ExpansionImpl.Builder(name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a shorter ToString with the details of this expansion.
|
||||
* @return a shorter ToString
|
||||
* @deprecated Starting with MiniPlaceholders 3.1, the way loaded expansions
|
||||
* are displayed in the console has changed, so this method is no longer used
|
||||
*/
|
||||
@ApiStatus.Internal
|
||||
@Deprecated(forRemoval = true, since = "3.1.0")
|
||||
default String shortToString() {
|
||||
final StringBuilder builder = new StringBuilder(name()).append('[');
|
||||
if (author() != null) {
|
||||
builder.append("Author: ").append(author());
|
||||
}
|
||||
if (version() != null) {
|
||||
if (author() != null) {
|
||||
builder.append(", ");
|
||||
}
|
||||
builder.append("Version: ").append(version());
|
||||
}
|
||||
builder.append(']');
|
||||
return builder.toString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Expansion Builder
|
||||
* <p>Example use:</p>
|
||||
* <pre>
|
||||
* Expansion.Builder builder = Expansion.builder("player");
|
||||
* builder
|
||||
* // Thanks to this filter, a cast can be performed without the probability of a ClassCastException
|
||||
* .filter(Player.class)
|
||||
* .resolver("name", (audience, queue, ctx) -> Tag.selfClosingInserting(Component.text(((Player)audience).getUsername())));
|
||||
* Expansion expansion = builder.build();
|
||||
* </pre>
|
||||
*
|
||||
* then use it:
|
||||
*
|
||||
* <pre>
|
||||
* Player player = event.getPlayer();
|
||||
* TagResolver resolver = expansion.resolver(player);
|
||||
* Component messageReplaced = MiniMessage.deserialize({@link String}, resolver);
|
||||
* </pre>
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@NullMarked
|
||||
interface Builder extends AbstractBuilder<Expansion> {
|
||||
|
||||
/**
|
||||
* Adds an audience placeholder
|
||||
*
|
||||
* <p>This type of Placeholder depends on a specific audience to obtain its values</p>
|
||||
*
|
||||
* <p>The content of this Placeholder is cached
|
||||
* and can mutate depending on when it is invoked</p>
|
||||
*
|
||||
* @param targetClass the target class
|
||||
* @param key the placeholder key, cannot be an empty or black string
|
||||
* @param audiencePlaceholder the single placeholder
|
||||
* @param <A> the type of audience that this placeholder supports, must be the same as targetClass
|
||||
* @return the {@link Builder} itself
|
||||
* @since 1.0.0
|
||||
*/
|
||||
<A extends Audience> Builder audiencePlaceholder(
|
||||
final @Nullable Class<A> targetClass,
|
||||
final String key,
|
||||
final AudienceTagResolver<A> audiencePlaceholder
|
||||
);
|
||||
|
||||
/**
|
||||
* Adds an audience placeholder
|
||||
*
|
||||
* <p>This type of Placeholder depends on a specific audience to obtain its values</p>
|
||||
*
|
||||
* <p>The content of this Placeholder is cached
|
||||
* and can mutate depending on when it is invoked</p>
|
||||
*
|
||||
* @param key the placeholder key, cannot be an empty or black string
|
||||
* @param audiencePlaceholder the single placeholder
|
||||
* @return the {@link Builder} itself
|
||||
* @since 3.0.0
|
||||
*/
|
||||
default Builder audiencePlaceholder(final String key, final AudienceTagResolver<Audience> audiencePlaceholder) {
|
||||
return this.audiencePlaceholder(null, key, audiencePlaceholder);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a Relational Placeholder based on two audiences
|
||||
*
|
||||
* <p>This type of placeholder allows you to create
|
||||
* components based on a 2-audiences relationship,
|
||||
* one is the one on which the placeholder
|
||||
* is based and the other is the one on which
|
||||
* the placeholder is displayed.</p>
|
||||
*
|
||||
* <p>The content of this Placeholder is cached
|
||||
* and can mutate depending on when it is invoked</p>
|
||||
*
|
||||
* @param targetClass the target class
|
||||
* @param key the placeholder key, cannot be an empty or black string
|
||||
* @param relationalPlaceholder the relational placeholder
|
||||
* @param <A> the type of audience that this placeholder supports, must be the same as targetClass
|
||||
* @return the {@link Builder} itself
|
||||
* @since 3.0.0
|
||||
*/
|
||||
<A extends Audience> Builder relationalPlaceholder(
|
||||
final @Nullable Class<A> targetClass,
|
||||
final String key,
|
||||
final RelationalTagResolver<A> relationalPlaceholder
|
||||
);
|
||||
|
||||
/**
|
||||
* Adds a Relational Placeholder based on two audiences
|
||||
*
|
||||
* <p>This type of placeholder allows you to create
|
||||
* components based on a 2-audiences relationship,
|
||||
* one is the one on which the placeholder
|
||||
* is based and the other is the one on which
|
||||
* the placeholder is displayed.</p>
|
||||
*
|
||||
* <p>The content of this Placeholder is cached
|
||||
* and can mutate depending on when it is invoked</p>
|
||||
*
|
||||
* @param key the placeholder key, cannot be an empty or black string
|
||||
* @param relationalResolver the relational placeholder
|
||||
* @return the {@link Builder} itself
|
||||
* @since 3.0.0
|
||||
*/
|
||||
default Builder relationalPlaceholder(
|
||||
final String key,
|
||||
final RelationalTagResolver<Audience> relationalResolver
|
||||
) {
|
||||
return this.relationalPlaceholder(null, key, relationalResolver);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a global placeholder
|
||||
*
|
||||
* <p>The content of this Placeholder is cached
|
||||
* and can mutate depending on when it is invoked</p>
|
||||
* @param key the placeholder key, cannot be an empty or black string
|
||||
* @param resolver the function
|
||||
* @return the {@link Builder} itself
|
||||
* @since 3.0.0
|
||||
*/
|
||||
Builder globalPlaceholder(final String key, final GlobalTagResolver resolver);
|
||||
|
||||
/**
|
||||
* Adds a global placeholder
|
||||
*
|
||||
* <p>This placeholder is not cached and is immutable</p>
|
||||
* @param key the placeholder key, cannot be an empty or black string
|
||||
* @param tag the tag of this placeholder
|
||||
* @return the {@link Builder} itself
|
||||
* @since 1.1.0
|
||||
*/
|
||||
default Builder globalPlaceholder(final String key, final Tag tag) {
|
||||
return this.globalPlaceholder(key, (queue, context) -> tag);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the author of this expansion
|
||||
*
|
||||
* @param author the author of this expansion
|
||||
* @return the {@link Builder} itself
|
||||
* @since 2.3.0
|
||||
*/
|
||||
@Contract("_ -> this")
|
||||
Builder author(final @Nullable String author);
|
||||
|
||||
/**
|
||||
* Sets the version of this expansion
|
||||
*
|
||||
* @param version the version of this expansion
|
||||
* @return the {@link Builder} itself
|
||||
* @since 2.3.0
|
||||
*/
|
||||
@Contract("_ -> this")
|
||||
Builder version(final @Nullable String version);
|
||||
}
|
||||
}
|
||||
@@ -1,275 +0,0 @@
|
||||
package io.github.miniplaceholders.api;
|
||||
|
||||
import io.github.miniplaceholders.api.placeholder.*;
|
||||
import io.github.miniplaceholders.api.resolver.AudienceTagResolver;
|
||||
import io.github.miniplaceholders.api.resolver.GlobalTagResolver;
|
||||
import io.github.miniplaceholders.api.resolver.RelationalTagResolver;
|
||||
import io.github.miniplaceholders.api.types.PlaceholderType;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
import org.intellij.lang.annotations.Subst;
|
||||
import org.jspecify.annotations.NonNull;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
import org.jspecify.annotations.NullUnmarked;
|
||||
|
||||
import java.util.*;
|
||||
|
||||
import static io.github.miniplaceholders.api.utils.Conditions.nonNullOrEmptyString;
|
||||
import static java.util.Objects.requireNonNull;
|
||||
|
||||
final class ExpansionImpl implements Expansion {
|
||||
private static final AudiencePlaceholder<?>[] EMPTY_SINGLE_AUDIENCE = new AudiencePlaceholder[0];
|
||||
private static final RelationalPlaceholder<?>[] EMPTY_RELATIONAL_AUDIENCE = new RelationalPlaceholder[0];
|
||||
private static final GlobalPlaceholder[] EMPTY_GLOBAL_PLACEHOLDER = new GlobalPlaceholder[0];
|
||||
|
||||
private final String name;
|
||||
private final PlaceholderTagResolver audiencePlaceholders;
|
||||
private final PlaceholderTagResolver relationalPlaceholders;
|
||||
private final PlaceholderTagResolver globalPlaceholders;
|
||||
@Nullable
|
||||
private final String author;
|
||||
@Nullable
|
||||
private final String version;
|
||||
|
||||
ExpansionImpl(
|
||||
final String expansionName,
|
||||
@Nullable final Collection<AudiencePlaceholder<?>> audiencePlaceholders,
|
||||
@Nullable final Collection<RelationalPlaceholder<?>> relationalPlaceholders,
|
||||
@Nullable final Collection<GlobalPlaceholder> globalPlaceholders,
|
||||
@Nullable final String author,
|
||||
@Nullable final String version
|
||||
) {
|
||||
this.name = expansionName;
|
||||
this.audiencePlaceholders = audiencePlaceholders != null
|
||||
? new PlaceholderTagResolver(audiencePlaceholders.toArray(EMPTY_SINGLE_AUDIENCE))
|
||||
: PlaceholderTagResolver.EMPTY;
|
||||
this.relationalPlaceholders = relationalPlaceholders != null
|
||||
? new PlaceholderTagResolver(relationalPlaceholders.toArray(EMPTY_RELATIONAL_AUDIENCE))
|
||||
: PlaceholderTagResolver.EMPTY;
|
||||
this.globalPlaceholders = globalPlaceholders == null
|
||||
? PlaceholderTagResolver.EMPTY
|
||||
: new PlaceholderTagResolver(globalPlaceholders.toArray(EMPTY_GLOBAL_PLACEHOLDER));
|
||||
this.author = author;
|
||||
this.version = version;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String name() {
|
||||
return this.name;
|
||||
}
|
||||
|
||||
@Override
|
||||
public @Nullable String author() {
|
||||
return this.author;
|
||||
}
|
||||
|
||||
@Override
|
||||
public @Nullable String version() {
|
||||
return this.version;
|
||||
}
|
||||
|
||||
@Override
|
||||
public TagResolver audiencePlaceholders() {
|
||||
if (audiencePlaceholders.placeholders().length == 0) return TagResolver.empty();
|
||||
|
||||
return this.audiencePlaceholders;
|
||||
}
|
||||
|
||||
@Override
|
||||
public TagResolver relationalPlaceholders() {
|
||||
if (relationalPlaceholders.placeholders().length == 0) return TagResolver.empty();
|
||||
|
||||
return this.relationalPlaceholders;
|
||||
}
|
||||
|
||||
@Override
|
||||
public TagResolver globalPlaceholders() {
|
||||
if (globalPlaceholders.placeholders().length == 0) return TagResolver.empty();
|
||||
|
||||
return this.globalPlaceholders;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void register() {
|
||||
if (this.registered()) {
|
||||
throw new IllegalStateException("Expansion" + this.name + "is already registered");
|
||||
}
|
||||
MiniPlaceholders.expansions.add(this);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void unregister() {
|
||||
if (!this.registered()) {
|
||||
throw new IllegalStateException("Expansion " + this.name + " is not registered");
|
||||
}
|
||||
MiniPlaceholders.expansions.remove(this);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean registered() {
|
||||
return MiniPlaceholders.expansions.contains(this);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Collection<AudiencePlaceholder<?>> registeredAudiencePlaceholders() {
|
||||
return List.of((AudiencePlaceholder<?>[]) audiencePlaceholders.placeholders());
|
||||
}
|
||||
|
||||
@Override
|
||||
public Collection<RelationalPlaceholder<?>> registeredRelationalPlaceholders() {
|
||||
return List.of((RelationalPlaceholder<?>[]) relationalPlaceholders.placeholders());
|
||||
}
|
||||
|
||||
@Override
|
||||
public @Nullable AudiencePlaceholder<?> audiencePlaceholderByName(String name) {
|
||||
requireNonNull(name);
|
||||
for (Placeholder audiencePlaceholder : audiencePlaceholders.placeholders()) {
|
||||
if (Objects.equals(audiencePlaceholder.name(), name)) {
|
||||
return (AudiencePlaceholder<?>) audiencePlaceholder;
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public @Nullable RelationalPlaceholder<?> relationalPlaceholderByName(String name) {
|
||||
requireNonNull(name);
|
||||
for (Placeholder relationalPlaceholder : relationalPlaceholders.placeholders()) {
|
||||
if (Objects.equals(relationalPlaceholder.name(), name)) {
|
||||
return (RelationalPlaceholder<?>) relationalPlaceholder;
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public @Nullable GlobalPlaceholder globalPlaceholderByName(String name) {
|
||||
for (Placeholder placeholder : globalPlaceholders.placeholders()) {
|
||||
if (Objects.equals(placeholder.name(), name)) {
|
||||
return (GlobalPlaceholder) placeholder;
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public TagResolver placeholdersByType(PlaceholderType type) {
|
||||
return switch (type) {
|
||||
case AUDIENCE -> audiencePlaceholders();
|
||||
case RELATIONAL -> relationalPlaceholders();
|
||||
case GLOBAL -> globalPlaceholders();
|
||||
};
|
||||
}
|
||||
|
||||
@NullUnmarked
|
||||
static final class Builder implements Expansion.Builder {
|
||||
private final String expansionName;
|
||||
@Subst("server")
|
||||
private final String expansionPrefix;
|
||||
private Set<AudiencePlaceholder<?>> audiencePlaceholders;
|
||||
private Set<RelationalPlaceholder<?>> relationalPlaceholders;
|
||||
private Set<GlobalPlaceholder> globalPlaceholders;
|
||||
private String author;
|
||||
private String version;
|
||||
|
||||
Builder(final @NonNull String name) {
|
||||
this.expansionName = nonNullOrEmptyString(name, "Expansion name");
|
||||
this.expansionPrefix = name.toLowerCase(Locale.ROOT).concat("_");
|
||||
}
|
||||
|
||||
@Override
|
||||
public <A extends Audience> @NonNull Builder audiencePlaceholder(
|
||||
final @Nullable Class<A> targetClass,
|
||||
final @Subst("name") @NonNull String key,
|
||||
final @NonNull AudienceTagResolver<@NonNull A> audiencePlaceholder
|
||||
) {
|
||||
nonNullOrEmptyString(key, "Placeholder key");
|
||||
requireNonNull(audiencePlaceholder, "the audience placeholder cannot be null");
|
||||
|
||||
if (this.audiencePlaceholders == null) this.audiencePlaceholders = new HashSet<>();
|
||||
|
||||
this.audiencePlaceholders.add(AudiencePlaceholder.single(targetClass, expansionPrefix + key, key, audiencePlaceholder));
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public <A extends Audience> @NonNull Builder relationalPlaceholder(
|
||||
final Class<A> targetClass,
|
||||
final @Subst("relation") @NonNull String key,
|
||||
final @NonNull RelationalTagResolver<@NonNull A> relationalPlaceholder
|
||||
) {
|
||||
nonNullOrEmptyString(key, "Placeholder key");
|
||||
requireNonNull(relationalPlaceholder, "the relational placeholder cannot be null");
|
||||
|
||||
if (this.relationalPlaceholders == null) this.relationalPlaceholders = new HashSet<>();
|
||||
|
||||
final var relationalTag = RelationalPlaceholder.relational(targetClass, expansionPrefix + "rel_" + key, key, relationalPlaceholder);
|
||||
this.relationalPlaceholders.add(relationalTag);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public @NonNull Builder globalPlaceholder(
|
||||
final @Subst("time") @NonNull String key,
|
||||
final @NonNull GlobalTagResolver function
|
||||
) {
|
||||
nonNullOrEmptyString(key, "Placeholder key");
|
||||
requireNonNull(function, "the global placeholder cannot be null");
|
||||
|
||||
if (this.globalPlaceholders == null) this.globalPlaceholders = new HashSet<>();
|
||||
|
||||
final var globalResolver = new GlobalPlaceholder(expansionPrefix + key, key, function);
|
||||
this.globalPlaceholders.add(globalResolver);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public @NonNull Builder author(final @Nullable String author) {
|
||||
this.author = author;
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public @NonNull Builder version(final @Nullable String version) {
|
||||
this.version = version;
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public @NonNull Expansion build() {
|
||||
return new ExpansionImpl(
|
||||
this.expansionName,
|
||||
this.audiencePlaceholders,
|
||||
this.relationalPlaceholders,
|
||||
this.globalPlaceholders,
|
||||
this.author,
|
||||
this.version
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(final Object o) {
|
||||
if (this == o) return true;
|
||||
if (!(o instanceof Expansion that)) return false;
|
||||
|
||||
return that.name().equalsIgnoreCase(this.name());
|
||||
}
|
||||
|
||||
@Override
|
||||
public int hashCode() {
|
||||
return Objects.hash(name.hashCode());
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "ExpansionImpl{" +
|
||||
"name='" + name + '\'' +
|
||||
", audiencePlaceholders=" + audiencePlaceholders +
|
||||
", relationalPlaceholders=" + relationalPlaceholders +
|
||||
", globalPlaceholders=" + globalPlaceholders +
|
||||
", author='" + author + '\'' +
|
||||
", version='" + version + '\'' +
|
||||
'}';
|
||||
}
|
||||
}
|
||||
@@ -1,244 +0,0 @@
|
||||
package io.github.miniplaceholders.api;
|
||||
|
||||
import io.github.miniplaceholders.api.types.PlaceholderType;
|
||||
import io.github.miniplaceholders.api.types.Platform;
|
||||
import io.github.miniplaceholders.api.types.RelationalAudience;
|
||||
import io.github.miniplaceholders.connect.InternalPlatform;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
import org.jetbrains.annotations.Unmodifiable;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
import java.util.Collection;
|
||||
import java.util.Collections;
|
||||
import java.util.Objects;
|
||||
import java.util.Set;
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
|
||||
import static io.github.miniplaceholders.api.utils.Resolvers.applyIfNotEmpty;
|
||||
|
||||
/**
|
||||
* MiniPlaceholders, a component-based placeholders API.
|
||||
*
|
||||
* <p>This class allows you to obtain the {@link TagResolver}
|
||||
* that other plugins provide based on single {@link Audience},
|
||||
* 2-audience or global placeholders</p>
|
||||
*
|
||||
* @author 4drian3d
|
||||
* @see TagResolver
|
||||
* @see Expansion
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public final class MiniPlaceholders {
|
||||
private MiniPlaceholders() {}
|
||||
static final Set<Expansion> expansions = ConcurrentHashMap.newKeySet();
|
||||
|
||||
/**
|
||||
* Get the platform on which MiniPlaceholders is running.
|
||||
*
|
||||
* @return the platform
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public static Platform platform() {
|
||||
return switch (InternalPlatform.platform()) {
|
||||
case PAPER -> Platform.PAPER;
|
||||
case VELOCITY -> Platform.VELOCITY;
|
||||
case FABRIC -> Platform.FABRIC;
|
||||
case SPONGE -> Platform.SPONGE;
|
||||
case MINESTOM -> Platform.MINESTOM;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the global placeholders
|
||||
*
|
||||
* <pre>TagResolver resolver = MiniPlaceholders.globalPlaceholders();
|
||||
* Component messageParsed = MiniMessage.miniMessage().deserialize({@link String}, resolver);</pre>
|
||||
*
|
||||
* @return global placeholders independent of any audience
|
||||
* @see TagResolver
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public static TagResolver globalPlaceholders() {
|
||||
final TagResolver.Builder builder = TagResolver.builder();
|
||||
for (final Expansion expansion : expansions) {
|
||||
final TagResolver resolver = expansion.globalPlaceholders();
|
||||
applyIfNotEmpty(resolver, builder);
|
||||
}
|
||||
return builder.build();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the TagResolver that can get data from an Audience.
|
||||
* <br>
|
||||
* The audience is provided at the time of parsing from the respective MiniMessage instance.
|
||||
*
|
||||
* <pre>TagResolver resolver = MiniPlaceholders.audiencePlaceholders();
|
||||
* Component messageParsed = MiniMessage.miniMessage().deserialize({@link String}, {@link Audience}, resolver);
|
||||
* </pre>
|
||||
*
|
||||
* @return {@link TagResolver} with placeholders based on an audience
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public static TagResolver audiencePlaceholders() {
|
||||
final TagResolver.Builder resolvers = TagResolver.builder();
|
||||
for (final Expansion expansion : expansions) {
|
||||
final TagResolver resolver = expansion.audiencePlaceholders();
|
||||
applyIfNotEmpty(resolver, resolvers);
|
||||
}
|
||||
return resolvers.build();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the relational placeholders based on two audiences
|
||||
* <br>
|
||||
* The audiences are provided at the time of parsing
|
||||
* from the respective MiniMessage instance through the use of a {@link RelationalAudience}.
|
||||
*
|
||||
* <pre>{@code
|
||||
* TagResolver resolver = MiniPlaceholders.relationalPlaceholders();
|
||||
* Component parsed = MiniMessage.miniMessage().deserialize(@link String, {@link RelationalAudience}, resolver);
|
||||
* }</pre>
|
||||
*
|
||||
* @return placeholders based on two audiences
|
||||
* @since 3.0.0
|
||||
* @see RelationalAudience
|
||||
*/
|
||||
public static TagResolver relationalPlaceholders() {
|
||||
final TagResolver.Builder builder = TagResolver.builder();
|
||||
for (final Expansion expansion : expansions) {
|
||||
applyIfNotEmpty(expansion.relationalPlaceholders(), builder);
|
||||
}
|
||||
|
||||
return builder.build();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a TagResolver that can obtain data based on a relationship of 2 audiences
|
||||
* and at the same time from the main audience and global placeholders.
|
||||
* <br>
|
||||
* The audience is provided at the time of parsing from the respective MiniMessage instance.
|
||||
*
|
||||
* <pre>
|
||||
* TagResolver resolver = MiniPlaceholders.audienceGlobalPlaceholders();
|
||||
* TagResolver resolver2 = TagResolver.resolver(
|
||||
* MiniPlaceholders.audienceGlobalPlaceholders(),
|
||||
* MiniPlaceholders.globalPlaceholders()
|
||||
* );
|
||||
* // This two resolvers returns the same TagResolver
|
||||
* assertEquals(resolver, resolver2);
|
||||
* Component parsed = MiniMessage.miniMessage().deserialize({@link String}, {@link Audience}, resolver);
|
||||
* </pre>
|
||||
*
|
||||
* @return {@link TagResolver} with placeholders based on an audience and the global placeholders
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public static TagResolver audienceGlobalPlaceholders() {
|
||||
final TagResolver.Builder builder = TagResolver.builder();
|
||||
|
||||
for (final Expansion expansion : expansions) {
|
||||
applyIfNotEmpty(expansion.audiencePlaceholders(), builder);
|
||||
applyIfNotEmpty(expansion.globalPlaceholders(), builder);
|
||||
}
|
||||
|
||||
return builder.build();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the relational placeholders based on two audiences, based on the first audience,
|
||||
* and the global placeholders
|
||||
*
|
||||
* <pre>
|
||||
* TagResolver resolver = MiniPlaceholders.relationalGlobalPlaceholders();
|
||||
* TagResolver resolver2 = TagResolver.resolver(
|
||||
* MiniPlaceholders.relationalPlaceholders(),
|
||||
* MiniPlaceholders.audiencePlaceholders(),
|
||||
* MiniPlaceholders.globalPlaceholders()
|
||||
* );
|
||||
* // This methods should return the same TagResolver
|
||||
* assertEquals(resolver, resolver2);
|
||||
* Component messageParsed = MiniMessage.miniMessage().deserialize({@link String}, {@link RelationalAudience}, resolver);
|
||||
* </pre>
|
||||
*
|
||||
* @return the placeholders based on two audiences, placeholders based on the first audience and the global placeholders
|
||||
* @since 3.0.0
|
||||
* @apiNote In the case of audience placeholders, the audience to be used will be the {@link RelationalAudience#audience()}
|
||||
* @see RelationalAudience
|
||||
*/
|
||||
public static TagResolver relationalGlobalPlaceholders() {
|
||||
final TagResolver.Builder builder = TagResolver.builder();
|
||||
for (final Expansion expansion : expansions) {
|
||||
applyIfNotEmpty(expansion.audiencePlaceholders(), builder);
|
||||
applyIfNotEmpty(expansion.relationalPlaceholders(), builder);
|
||||
applyIfNotEmpty(expansion.globalPlaceholders(), builder);
|
||||
}
|
||||
|
||||
return builder.build();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a TagResolver based on the desired placeholder type.
|
||||
* <br>
|
||||
* {@link PlaceholderType#GLOBAL} will return {@link #globalPlaceholders()}
|
||||
* <br>
|
||||
* {@link PlaceholderType#AUDIENCE} will return {@link #audiencePlaceholders()}
|
||||
* <br>
|
||||
* {@link PlaceholderType#RELATIONAL} will return {@link #relationalPlaceholders()}
|
||||
*
|
||||
* @param type the desired type
|
||||
* @return the TagResolvers from the respective type
|
||||
* @see PlaceholderType
|
||||
*/
|
||||
public static TagResolver placeholdersByType(final PlaceholderType type) {
|
||||
return switch (type) {
|
||||
case GLOBAL -> globalPlaceholders();
|
||||
case AUDIENCE -> audiencePlaceholders();
|
||||
case RELATIONAL -> relationalPlaceholders();
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the amount of expansion registered.
|
||||
*
|
||||
* @return the amount of expansions registered
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public static int expansionCount(){
|
||||
return expansions.size();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a specific expansion by name
|
||||
* <p>The name of each expansion is set when the expansion is created</p>
|
||||
* <pre>
|
||||
* Expansion expansion = Expansion.builder("example").build();
|
||||
* expansion.register();
|
||||
*
|
||||
* assertThat(MiniPlaceholders.expansionByName("example")).isNotNull();
|
||||
* </pre>
|
||||
*
|
||||
* @param name the name of the required expansion
|
||||
* @return the required expansion, if not present, will return null
|
||||
* @see Expansion#builder(String)
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public static @Nullable Expansion expansionByName(final String name) {
|
||||
for (final Expansion expansion : expansions) {
|
||||
if (Objects.equals(expansion.name(), name)) {
|
||||
return expansion;
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Obtain all available registered expansions
|
||||
*
|
||||
* @return all available registered expansions
|
||||
* @since 3.0.0
|
||||
*/
|
||||
@Unmodifiable
|
||||
public static Collection<Expansion> expansionsAvailable() {
|
||||
return Collections.unmodifiableSet(expansions);
|
||||
}
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
/**
|
||||
* MiniPlaceholders core package
|
||||
*/
|
||||
package io.github.miniplaceholders.api;
|
||||
-109
@@ -1,109 +0,0 @@
|
||||
package io.github.miniplaceholders.api.placeholder;
|
||||
|
||||
import io.github.miniplaceholders.api.resolver.AudienceTagResolver;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.audience.ForwardingAudience;
|
||||
import net.kyori.adventure.pointer.Pointered;
|
||||
import net.kyori.adventure.text.minimessage.Context;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.minimessage.tag.TagPattern;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue;
|
||||
import org.jetbrains.annotations.Nullable;
|
||||
|
||||
import java.util.Objects;
|
||||
|
||||
import static java.util.Objects.requireNonNull;
|
||||
|
||||
/**
|
||||
* A placeholder that can be applied based on an audience of the specified type.
|
||||
*
|
||||
* @param targetClass the type of audience from which this placeholder can obtain information
|
||||
* @param key the full placeholder key
|
||||
* @param name the name of this placeholder
|
||||
* @param resolver the object responsible for obtaining audience information
|
||||
* @param <A> the parametrized type
|
||||
*/
|
||||
public record AudiencePlaceholder<A extends Audience>(
|
||||
@Nullable Class<A> targetClass,
|
||||
@TagPattern String key,
|
||||
String name,
|
||||
AudienceTagResolver<A> resolver
|
||||
) implements Placeholder {
|
||||
|
||||
/**
|
||||
* Creates a new AudiencePlaceholder.
|
||||
*
|
||||
* @param targetClass the type of audience from which this placeholder can obtain information
|
||||
* @param key the placeholder key
|
||||
* @param name the name of this placeholder
|
||||
* @param resolver the object responsible for obtaining audience information
|
||||
* @return a new AudiencePlaceholder
|
||||
* @param <A> the parametrized type
|
||||
*/
|
||||
public static <A extends Audience> AudiencePlaceholder<A> single(
|
||||
@Nullable Class<A> targetClass,
|
||||
@TagPattern String key,
|
||||
String name,
|
||||
AudienceTagResolver<A> resolver
|
||||
) {
|
||||
return new AudiencePlaceholder<>(targetClass, requireNonNull(key), requireNonNull(name), requireNonNull(resolver));
|
||||
}
|
||||
|
||||
@Override
|
||||
public @Nullable Tag resolve(final String name, final ArgumentQueue arguments, final Context ctx) {
|
||||
final Pointered targetRaw = ctx.target();
|
||||
if (targetRaw == null) {
|
||||
return null;
|
||||
}
|
||||
if (targetClass == null) {
|
||||
//noinspection unchecked
|
||||
return this.resolveA(name, (A) targetRaw, arguments, ctx);
|
||||
}
|
||||
final @Nullable A audience = forwardingFilter(targetRaw);
|
||||
if (audience == null) {
|
||||
return null;
|
||||
}
|
||||
return resolveA(name, audience, arguments, ctx);
|
||||
}
|
||||
|
||||
private @Nullable Tag resolveA(String key, A audience, ArgumentQueue queue, Context ctx) {
|
||||
return this.has(key)
|
||||
? resolver.tag(audience, queue, ctx)
|
||||
: null;
|
||||
}
|
||||
|
||||
private @Nullable A forwardingFilter(final Pointered source) {
|
||||
//noinspection DataFlowIssue
|
||||
if (targetClass.isInstance(source)) {
|
||||
return targetClass.cast(source);
|
||||
}
|
||||
if (source instanceof final ForwardingAudience.Single forward) {
|
||||
return forwardingFilter(forward.audience());
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean has(String name) {
|
||||
return key.equalsIgnoreCase(name);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(final Object o) {
|
||||
if (o == this) return true;
|
||||
if (!(o instanceof AudiencePlaceholder<?> that)) return false;
|
||||
return that.key.equalsIgnoreCase(this.key);
|
||||
}
|
||||
|
||||
@Override
|
||||
public int hashCode() {
|
||||
return Objects.hash(key);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "AudiencePlaceholder{" +
|
||||
"key='" + key + '\'' +
|
||||
'}';
|
||||
}
|
||||
}
|
||||
@@ -1,49 +0,0 @@
|
||||
package io.github.miniplaceholders.api.placeholder;
|
||||
|
||||
import io.github.miniplaceholders.api.resolver.GlobalTagResolver;
|
||||
import net.kyori.adventure.text.minimessage.Context;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.minimessage.tag.TagPattern;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
import java.util.Objects;
|
||||
|
||||
/**
|
||||
* A placeholder that can obtain data without the need to provide an {@link net.kyori.adventure.audience.Audience}
|
||||
* or {@link io.github.miniplaceholders.api.types.RelationalAudience}.
|
||||
*
|
||||
* @param key the placeholder key
|
||||
* @param name the placeholder name
|
||||
* @param resolver the object responsible for providing information
|
||||
*/
|
||||
public record GlobalPlaceholder(@TagPattern String key, String name, GlobalTagResolver resolver) implements Placeholder {
|
||||
@Override
|
||||
public @Nullable Tag resolve(final String name, final ArgumentQueue arguments, final Context ctx) {
|
||||
return this.has(name) ? resolver.tag(arguments, ctx) : null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean has(final String name) {
|
||||
return key.equalsIgnoreCase(name);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(final Object obj) {
|
||||
if (this == obj) {
|
||||
return true;
|
||||
}
|
||||
if (obj instanceof GlobalPlaceholder(var oKey, var _, var _)) {
|
||||
return Objects.equals(oKey, this.key);
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "GlobalPlaceholder{" +
|
||||
"key='" + key + '\'' +
|
||||
"name=" + name + '\'' +
|
||||
'}';
|
||||
}
|
||||
}
|
||||
@@ -1,26 +0,0 @@
|
||||
package io.github.miniplaceholders.api.placeholder;
|
||||
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
|
||||
/**
|
||||
* Base class of all Placeholders
|
||||
*/
|
||||
public sealed interface Placeholder extends TagResolver permits AudiencePlaceholder, GlobalPlaceholder, RelationalPlaceholder {
|
||||
/**
|
||||
* The key of this placeholder.<br>
|
||||
* For example, the placeholder <pre>{@code <expansion_placeholder}</pre>
|
||||
* will have the key <code>expansion_placeholder</code>
|
||||
*
|
||||
* @return this placeholder's key
|
||||
*/
|
||||
String key();
|
||||
|
||||
/**
|
||||
* The key of this placeholder.<br>
|
||||
* For example, the placeholder <pre>{@code <expansion_placeholder}</pre>
|
||||
* will have the key <code>placeholder</code>
|
||||
*
|
||||
* @return this placeholder's name
|
||||
*/
|
||||
String name();
|
||||
}
|
||||
-38
@@ -1,38 +0,0 @@
|
||||
package io.github.miniplaceholders.api.placeholder;
|
||||
|
||||
import net.kyori.adventure.text.minimessage.Context;
|
||||
import net.kyori.adventure.text.minimessage.ParsingException;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
import org.jetbrains.annotations.Nullable;
|
||||
|
||||
/**
|
||||
* A TagResolver responsible for containing and processing multiple placeholders.
|
||||
* @param placeholders the placeholders to process
|
||||
*/
|
||||
public record PlaceholderTagResolver(Placeholder... placeholders) implements TagResolver {
|
||||
public static final PlaceholderTagResolver EMPTY = new PlaceholderTagResolver();
|
||||
|
||||
@Override
|
||||
public @Nullable Tag resolve(final String name, final ArgumentQueue arguments, final Context ctx) throws ParsingException {
|
||||
@Nullable Tag tag;
|
||||
for (final Placeholder placeholder : placeholders) {
|
||||
tag = placeholder.resolve(name, arguments, ctx);
|
||||
if (tag != null) {
|
||||
return tag;
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean has(final String name) {
|
||||
for (final Placeholder placeholder : placeholders) {
|
||||
if (placeholder.has(name)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
}
|
||||
-133
@@ -1,133 +0,0 @@
|
||||
package io.github.miniplaceholders.api.placeholder;
|
||||
|
||||
import io.github.miniplaceholders.api.types.RelationalAudience;
|
||||
import io.github.miniplaceholders.api.resolver.RelationalTagResolver;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.audience.ForwardingAudience;
|
||||
import net.kyori.adventure.pointer.Pointered;
|
||||
import net.kyori.adventure.text.minimessage.Context;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.minimessage.tag.TagPattern;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue;
|
||||
import org.jetbrains.annotations.Nullable;
|
||||
|
||||
import java.util.Objects;
|
||||
|
||||
import static java.util.Objects.requireNonNull;
|
||||
|
||||
/**
|
||||
* Relational Placeholder.
|
||||
* <br>
|
||||
* This placeholder is able to obtain data based on a relationship between 2 audiences
|
||||
* using a type-safe filter and a relational resolver.
|
||||
*
|
||||
* @param targetClass the target class, can be null
|
||||
* @param key the key of the entire placeholder
|
||||
* @param name the name of this placeholder
|
||||
* @param resolver the relational resolver,
|
||||
* in charge of obtaining data based on a relationship of 2 audiences
|
||||
* @param <A> the audience type, if not specified, will be a generic {@linkplain Audience}
|
||||
* @apiNote The {@link #key()} method returns the full name of the placeholder,
|
||||
* for example, if the placeholder is {@code <server_name>},
|
||||
* the {@linkplain #key()} method will return {@code server_name}.
|
||||
* @see RelationalTagResolver
|
||||
*/
|
||||
public record RelationalPlaceholder<A extends Audience>(
|
||||
@Nullable Class<A> targetClass,
|
||||
@TagPattern String key,
|
||||
String name,
|
||||
RelationalTagResolver<A> resolver
|
||||
) implements Placeholder {
|
||||
|
||||
/**
|
||||
* Static method capable of creating an instance of a relational placeholder.
|
||||
*
|
||||
* @param targetClass the target class, can be null
|
||||
* @param key the key of the entire placeholder
|
||||
* @param name the name of this placeholder
|
||||
* @param resolver the relational resolver,
|
||||
* in charge of obtaining data based on a relationship of 2 audiences
|
||||
* @param <A> the audience type, if not specified, will be a generic {@linkplain Audience}
|
||||
* @return a new RelationalPlaceholder
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public static <A extends Audience> RelationalPlaceholder<A> relational(
|
||||
final @Nullable Class<A> targetClass,
|
||||
final @TagPattern String key,
|
||||
final String name,
|
||||
final RelationalTagResolver<A> resolver
|
||||
) {
|
||||
return new RelationalPlaceholder<>(targetClass, requireNonNull(key), name, requireNonNull(resolver));
|
||||
}
|
||||
|
||||
@Override
|
||||
public @Nullable Tag resolve(final String name, final ArgumentQueue arguments, final Context ctx) {
|
||||
final Pointered targetRaw = ctx.target();
|
||||
if (targetRaw == null) {
|
||||
return null;
|
||||
}
|
||||
if (!(targetRaw instanceof RelationalAudience<?>(Audience a, Audience b))) {
|
||||
return null;
|
||||
}
|
||||
if (targetClass == null) {
|
||||
//noinspection unchecked
|
||||
return this.resolveA(name, (A) a, (A) b, arguments, ctx);
|
||||
}
|
||||
final @Nullable A audience = forwardingFilter(a);
|
||||
if (audience == null) {
|
||||
return null;
|
||||
}
|
||||
final @Nullable A relationalAudience = forwardingFilter(b);
|
||||
if (relationalAudience == null) {
|
||||
return null;
|
||||
}
|
||||
return this.resolveA(name, audience, relationalAudience, arguments, ctx);
|
||||
}
|
||||
|
||||
private @Nullable Tag resolveA(
|
||||
final String name,
|
||||
final A audience,
|
||||
final A relationalAudience,
|
||||
final ArgumentQueue arguments,
|
||||
final Context ctx
|
||||
) {
|
||||
return this.has(name)
|
||||
? resolver.tag(audience, relationalAudience, arguments, ctx)
|
||||
: null;
|
||||
}
|
||||
|
||||
private @Nullable A forwardingFilter(final Pointered source) {
|
||||
//noinspection DataFlowIssue
|
||||
if (targetClass.isInstance(source)) {
|
||||
return targetClass.cast(source);
|
||||
}
|
||||
if (source instanceof final ForwardingAudience.Single forward) {
|
||||
return forwardingFilter(forward.audience());
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean has(final String name) {
|
||||
return key.equalsIgnoreCase(name);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(final Object o) {
|
||||
if (o == this) return true;
|
||||
if (!(o instanceof final RelationalPlaceholder<?> that)) return false;
|
||||
return that.key.equalsIgnoreCase(this.key);
|
||||
}
|
||||
|
||||
@Override
|
||||
public int hashCode() {
|
||||
return Objects.hash(key);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "RelationalPlaceholder{" +
|
||||
"key='" + key + '\'' +
|
||||
'}';
|
||||
}
|
||||
}
|
||||
@@ -1,6 +0,0 @@
|
||||
/**
|
||||
* Placeholders Package.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
package io.github.miniplaceholders.api.placeholder;
|
||||
@@ -1,27 +0,0 @@
|
||||
package io.github.miniplaceholders.api.provider;
|
||||
|
||||
import io.github.miniplaceholders.api.Expansion;
|
||||
|
||||
/**
|
||||
* An expansion provider.
|
||||
*
|
||||
* @apiNote If necessary, you can obtain platform-dependent instances
|
||||
* by adding a non-final field of the {@link PlatformData} class
|
||||
* with the {@link team.unnamed.inject.Inject} annotation to your ExpansionProvider class.
|
||||
*/
|
||||
public interface ExpansionProvider {
|
||||
/**
|
||||
* Provides an expansion.
|
||||
*
|
||||
* @return an expansion
|
||||
* @apiNote If used outside its MiniPlaceholders dynamic expansion loading context,
|
||||
* you should always check that the loading requirements specified in {@link #loadRequirement} are met.
|
||||
*/
|
||||
Expansion provideExpansion();
|
||||
|
||||
/**
|
||||
* Obtain the requirements that must be met for this expansion to load successfully.
|
||||
* @return the load requirements of this expansion provider
|
||||
*/
|
||||
LoadRequirement loadRequirement();
|
||||
}
|
||||
@@ -1,223 +0,0 @@
|
||||
package io.github.miniplaceholders.api.provider;
|
||||
|
||||
import io.github.miniplaceholders.api.types.Platform;
|
||||
import org.intellij.lang.annotations.Pattern;
|
||||
import org.jetbrains.annotations.ApiStatus;
|
||||
import org.jspecify.annotations.NullMarked;
|
||||
|
||||
import java.util.Arrays;
|
||||
import java.util.function.Predicate;
|
||||
|
||||
import static java.util.Objects.requireNonNull;
|
||||
|
||||
/**
|
||||
* This class specifies the conditions that must be met
|
||||
* in order to load an {@link io.github.miniplaceholders.api.Expansion} from an {@link ExpansionProvider}.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public sealed interface LoadRequirement {
|
||||
|
||||
/**
|
||||
* It means that there is no requirement to load an expansion.
|
||||
*
|
||||
* @return a LoadRequirement that does not perform any validation
|
||||
* @since 3.0.0
|
||||
*/
|
||||
static LoadRequirement none() {
|
||||
return NoneLoadRequirement.INSTANCE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Requirement for a complement, whether a plugin or mod, to be present in order for an expansion to be loaded.<br>
|
||||
* The ability to provide multiple strings is provided because names may vary on some platforms.
|
||||
* For example, Velocity requires plugin IDs to be lowercase, such as {@code miniplaceholders},
|
||||
* while Paper can contain uppercase letters, such as {@code MiniPlaceholders}.
|
||||
*
|
||||
* @param name the principal name of this complement
|
||||
* @param aliases the platform aliases of a complement
|
||||
* @return a load requirement that checks for an available complement
|
||||
* @since 3.0.0
|
||||
*/
|
||||
static LoadRequirement requiredComplement(final String name, final String... aliases) {
|
||||
requireNonNull(name);
|
||||
requireNonNull(aliases);
|
||||
return new AvailableComplementRequirement(name, aliases);
|
||||
}
|
||||
|
||||
/**
|
||||
* Multiple requirement, in case an expansion needs to depend on a platform
|
||||
* as well as one or more add-ons that are installed.
|
||||
*
|
||||
* @param requirements the load requirements
|
||||
* @return a load requirement of many load requirements
|
||||
* @since 3.0.0
|
||||
*/
|
||||
static LoadRequirement allOf(LoadRequirement... requirements) {
|
||||
requireNonNull(requirements);
|
||||
assert requirements.length != 0;
|
||||
return new MultiLoadRequirement(requirements);
|
||||
}
|
||||
|
||||
/**
|
||||
* Requirement that the current execution be on a specific platform.
|
||||
*
|
||||
* @param platforms the supported platforms
|
||||
* @return a load requirement that checks for a supported platform
|
||||
* @since 3.0.0
|
||||
*/
|
||||
static LoadRequirement platform(final Platform... platforms) {
|
||||
requireNonNull(platforms);
|
||||
assert platforms.length != 0;
|
||||
|
||||
return new PlatformRequirement(platforms);
|
||||
}
|
||||
|
||||
/**
|
||||
* Requirement that a specific class be present.
|
||||
*
|
||||
* @param clazz the specified class.
|
||||
* @return a load requirement that checks for a present class
|
||||
* @since 3.1.0
|
||||
*/
|
||||
static LoadRequirement requiredClass(
|
||||
@Pattern("^([a-z_][a-z0-9_]*)(\\.[a-z_][a-z0-9_]*)*(\\.[A-Z][A-Za-z0-9_]*)$") final String clazz
|
||||
) {
|
||||
requireNonNull(clazz);
|
||||
return new ClassRequirement(clazz);
|
||||
}
|
||||
|
||||
/**
|
||||
* This requirement checks whether any of the conditions presented are satisfied.
|
||||
*
|
||||
* @param requirements the requerimients
|
||||
* @return a requirement that checks whether a condition is valid
|
||||
* @since 3.1.0
|
||||
*/
|
||||
static LoadRequirement anyOf(LoadRequirement... requirements) {
|
||||
requireNonNull(requirements);
|
||||
assert requirements.length != 0;
|
||||
return new AnyOfRequirement(requirements);
|
||||
}
|
||||
|
||||
/**
|
||||
* NoneLoadRequirement
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
@ApiStatus.Internal
|
||||
enum NoneLoadRequirement implements LoadRequirement {
|
||||
/**
|
||||
* NoneLoadRequirement instance
|
||||
*/
|
||||
INSTANCE
|
||||
}
|
||||
|
||||
/**
|
||||
* AvailableComplementRequirement
|
||||
*
|
||||
* @param name the main complement name
|
||||
* @param platformAliases the complement aliases
|
||||
* @since 3.0.0
|
||||
*/
|
||||
@ApiStatus.Internal
|
||||
@NullMarked
|
||||
record AvailableComplementRequirement(String name, String... platformAliases) implements LoadRequirement {
|
||||
|
||||
/**
|
||||
* Checks if a complement is loaded
|
||||
*
|
||||
* @param platformComplementTester the checker predicate
|
||||
* @return is this expansion should load
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public boolean shouldLoad(final Predicate<String> platformComplementTester) {
|
||||
if (platformComplementTester.test(name)) {
|
||||
return true;
|
||||
}
|
||||
for (String alias : platformAliases) {
|
||||
if (platformComplementTester.test(alias)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "AvailableComplementRequirement{" +
|
||||
"complement='" + name + '\'' +
|
||||
'}';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* MultiLoadRequirement
|
||||
*
|
||||
* @param requirements the load requirements
|
||||
* @since 3.0.0
|
||||
*/
|
||||
@ApiStatus.Internal
|
||||
@NullMarked
|
||||
record MultiLoadRequirement(LoadRequirement... requirements) implements LoadRequirement {
|
||||
@Override
|
||||
public String toString() {
|
||||
return "MultiLoadRequirement{" +
|
||||
"requirements=" + Arrays.toString(requirements) +
|
||||
'}';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* PlatformLoadRequirement
|
||||
*
|
||||
* @param platforms the platforms supported
|
||||
* @since 3.0.0
|
||||
*/
|
||||
@ApiStatus.Internal
|
||||
@NullMarked
|
||||
record PlatformRequirement(Platform... platforms) implements LoadRequirement {
|
||||
@Override
|
||||
public String toString() {
|
||||
return "PlatformRequirement{" +
|
||||
"platforms=" + Arrays.toString(platforms()) +
|
||||
'}';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* ClassRequirement
|
||||
*
|
||||
* @param clazz a specified class
|
||||
* @since 3.1.0
|
||||
*/
|
||||
@NullMarked
|
||||
@ApiStatus.Internal
|
||||
record ClassRequirement(String clazz) implements LoadRequirement {
|
||||
public boolean shouldLoad() {
|
||||
try {
|
||||
Class.forName(clazz);
|
||||
return true;
|
||||
} catch (ClassNotFoundException e) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* AnyOfLoadRequirement
|
||||
*
|
||||
* @param requirements the requirements
|
||||
* @since 3.1.0
|
||||
*/
|
||||
@ApiStatus.Internal
|
||||
@NullMarked
|
||||
record AnyOfRequirement(LoadRequirement... requirements) implements LoadRequirement {
|
||||
@Override
|
||||
public String toString() {
|
||||
return "AnyOfRequirement{" +
|
||||
"requirements=" + Arrays.toString(requirements) +
|
||||
'}';
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,21 +0,0 @@
|
||||
package io.github.miniplaceholders.api.provider;
|
||||
|
||||
import io.github.miniplaceholders.api.MiniPlaceholders;
|
||||
|
||||
/**
|
||||
* Wrapper for platform-dependent instances.
|
||||
*
|
||||
* @param serverInstance The server instance.<br>
|
||||
* In Paper it will be {@code org.bukkit.Server},<br>
|
||||
* in Velocity it will be {@code com.velocitypowered.api.proxy.ProxyServer},<br>
|
||||
* in Sponge it will be {@code org.spongepowered.api.Server},<br>
|
||||
* and in Fabric it will be {@code net.minecraft.server.MinecraftServer}.
|
||||
* @param complementInstance The main class of MiniPlaceholders, either as a plugin or mod.<br>
|
||||
* In Paper it will be {@code org.bukkit.plugin.java.JavaPlugin},<br>
|
||||
* in Velocity it will be {@code io.github.miniplaceholders.velocity.VelocityPlugin},<br>
|
||||
* in Sponge it will be {@code io.github.miniplaceholders.sponge.SpongePlugin},<br>
|
||||
* and in Fabric it will be {@code net.fabricmc.api.ModInitializer}.
|
||||
* @see MiniPlaceholders#platform()
|
||||
*/
|
||||
public record PlatformData(Object serverInstance, Object complementInstance) {
|
||||
}
|
||||
@@ -1,6 +0,0 @@
|
||||
/**
|
||||
* Package responsible for providing tools to load expansions provided through installable files
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
package io.github.miniplaceholders.api.provider;
|
||||
@@ -1,23 +0,0 @@
|
||||
package io.github.miniplaceholders.api.resolver;
|
||||
|
||||
import net.kyori.adventure.text.minimessage.Context;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
/**
|
||||
* A GlobalResolver is responsible for providing information regardless of additional conditions such as an audience.
|
||||
*/
|
||||
@FunctionalInterface
|
||||
public interface GlobalTagResolver {
|
||||
/**
|
||||
* A global tag.
|
||||
*
|
||||
* @param queue the argument queue
|
||||
* @param context the parsing context
|
||||
* @return a tag
|
||||
* @since 3.0.0
|
||||
*/
|
||||
@Nullable
|
||||
Tag tag(ArgumentQueue queue, Context context);
|
||||
}
|
||||
@@ -1,30 +0,0 @@
|
||||
package io.github.miniplaceholders.api.resolver;
|
||||
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.text.minimessage.Context;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
/**
|
||||
* Relational Placeholder based on two Audiences.
|
||||
*
|
||||
* @param <A> the audiences type
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
@FunctionalInterface
|
||||
public interface RelationalTagResolver<A extends Audience> {
|
||||
/**
|
||||
* A Tag based on two audiences
|
||||
*
|
||||
* @param audience the principal audience
|
||||
* @param relational the another audience
|
||||
* @param queue the argument queue
|
||||
* @param ctx the context
|
||||
* @return a tag
|
||||
* @since 3.0.0
|
||||
*/
|
||||
@Nullable
|
||||
Tag tag(final A audience, final A relational, final ArgumentQueue queue, final Context ctx);
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
/**
|
||||
* Resolvers available based on information obtained from Audiences
|
||||
*/
|
||||
package io.github.miniplaceholders.api.resolver;
|
||||
@@ -1,27 +0,0 @@
|
||||
package io.github.miniplaceholders.api.types;
|
||||
|
||||
/**
|
||||
* Type of Placeholder.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public enum PlaceholderType {
|
||||
/**
|
||||
* The global placeholder type.
|
||||
* <br>
|
||||
* It does not require any type of audience to operate.
|
||||
*/
|
||||
GLOBAL,
|
||||
/**
|
||||
* The audience placeholder type.
|
||||
* <br>
|
||||
* Obtains information from a provided audience.
|
||||
*/
|
||||
AUDIENCE,
|
||||
/**
|
||||
* The relational placeholder type.
|
||||
* <br>
|
||||
* Requires 2 audiences to work, these audiences need to be of the same type.
|
||||
*/
|
||||
RELATIONAL
|
||||
}
|
||||
@@ -1,39 +0,0 @@
|
||||
package io.github.miniplaceholders.api.types;
|
||||
|
||||
/**
|
||||
* Platforms on which MiniPlaceholders can be used.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public enum Platform {
|
||||
/**
|
||||
* Paper Platform
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
PAPER,
|
||||
/**
|
||||
* Velocity Platform
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
VELOCITY,
|
||||
/**
|
||||
* Fabric Platform
|
||||
*
|
||||
* @since 2.1.0
|
||||
*/
|
||||
FABRIC,
|
||||
/**
|
||||
* Sponge Platform
|
||||
*
|
||||
* @since 2.2.0
|
||||
*/
|
||||
SPONGE,
|
||||
/**
|
||||
* Minestom Platform
|
||||
*
|
||||
* @since 3.2.0
|
||||
*/
|
||||
MINESTOM,
|
||||
}
|
||||
@@ -1,34 +0,0 @@
|
||||
package io.github.miniplaceholders.api.types;
|
||||
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.audience.ForwardingAudience;
|
||||
|
||||
import static java.util.Objects.requireNonNull;
|
||||
|
||||
/**
|
||||
* A relationship between 2 Audiences.
|
||||
*
|
||||
* @param audience the principal audience
|
||||
* @param relational the secondary audience, with which the relationship will be evaluated
|
||||
* @param <A> the audiences type
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public record RelationalAudience<A extends Audience>(A audience, A relational) implements ForwardingAudience.Single {
|
||||
public RelationalAudience {
|
||||
requireNonNull(audience);
|
||||
requireNonNull(relational);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new relation between two audiences.
|
||||
*
|
||||
* @param audience the principal audience
|
||||
* @param relational the secondary audience, with which the relationship will be evaluated
|
||||
* @return a new relation
|
||||
* @param <A> the audiences type
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public static <A extends Audience> RelationalAudience<A> from(A audience, A relational) {
|
||||
return new RelationalAudience<>(audience, relational);
|
||||
}
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
/**
|
||||
* Plugin types
|
||||
*/
|
||||
package io.github.miniplaceholders.api.types;
|
||||
@@ -1,78 +0,0 @@
|
||||
package io.github.miniplaceholders.api.utils;
|
||||
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
import java.util.function.Supplier;
|
||||
|
||||
/**
|
||||
* Checks required for the correct operation of the expansions
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public final class Conditions {
|
||||
private Conditions() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a string is null or empty or consists of whitespace characters only.
|
||||
*
|
||||
* @param string the string
|
||||
* @param name the name supplier
|
||||
* @return the string if it is not null or empty
|
||||
* @throws IllegalStateException if the provided string is empty
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public static String nonNullOrEmptyString(final @Nullable String string, final Supplier<String> name) {
|
||||
if (string == null)
|
||||
throw new NullPointerException(name.get() + " cannot be null");
|
||||
if (string.isBlank())
|
||||
throw new IllegalStateException(name.get() + "cannot be an empty string");
|
||||
return string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a string is null or empty or consists of whitespace characters only.
|
||||
*
|
||||
* @param string the string
|
||||
* @param name the name
|
||||
* @return the string if it is not null or empty
|
||||
* @throws IllegalStateException if the provided string is empty
|
||||
* @since 2.2.0
|
||||
*/
|
||||
public static String nonNullOrEmptyString(final @Nullable String string, final String name) {
|
||||
if (string == null)
|
||||
throw new NullPointerException(name + " cannot be null");
|
||||
if (string.isBlank())
|
||||
throw new IllegalStateException(name + "cannot be an empty string");
|
||||
return string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a string is empty or consists of whitespace characters only.
|
||||
*
|
||||
* @param string the string
|
||||
* @param reason the reason supplier
|
||||
* @return the string if it not empty
|
||||
* @throws IllegalStateException if the provided string is empty
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public static String nonEmptyString(final String string, final Supplier<String> reason) {
|
||||
if (string.isBlank()) throw new IllegalStateException(reason.get());
|
||||
return string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a string is empty or consists of whitespace characters only.
|
||||
*
|
||||
* @param string the string
|
||||
* @param reason the reason
|
||||
* @return the string if it not empty
|
||||
* @throws IllegalStateException if the provided string is empty
|
||||
* @since 2.2.0
|
||||
*/
|
||||
public static String nonEmptyString(final String string, final String reason) {
|
||||
if (string.isBlank()) throw new IllegalStateException(reason);
|
||||
return string;
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,165 +0,0 @@
|
||||
package io.github.miniplaceholders.api.utils;
|
||||
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.minimessage.Context;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
import net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
import java.util.function.Function;
|
||||
|
||||
import static java.util.Objects.requireNonNull;
|
||||
import static net.kyori.adventure.text.minimessage.MiniMessage.miniMessage;
|
||||
|
||||
/**
|
||||
* Legacy String utilities.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public final class LegacyStrings {
|
||||
private LegacyStrings() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Legacy serializer with hex support
|
||||
* <p>Use this as the last available alternative,
|
||||
* it is recommended to use MiniMessage instead of this serializer</p>
|
||||
*
|
||||
* @deprecated Legacy format “support” will be removed in future versions
|
||||
*/
|
||||
@Deprecated(since = "3.1.0")
|
||||
public static final LegacyComponentSerializer LEGACY_HEX_SERIALIZER = LegacyComponentSerializer.builder()
|
||||
.character('&')
|
||||
.hexColors()
|
||||
.build();
|
||||
|
||||
/**
|
||||
* Parse a string with possible legacy Ampersand/Section symbols
|
||||
* <br>
|
||||
* <p><b>
|
||||
* This method should only be used in case a String is provided from a legacy plugin/mod
|
||||
* or legacy source, where it is very likely to get a legacy string.
|
||||
* It is not recommended to use this method regularly in any sense
|
||||
* </b></p>
|
||||
*
|
||||
* @param string the string
|
||||
* @return a parsed string
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public static Component parsePossibleLegacy(@Nullable String string) {
|
||||
if (string == null || string.isEmpty()) return Component.empty();
|
||||
if (string.indexOf(LegacyComponentSerializer.SECTION_CHAR) != -1) {
|
||||
string = string.replace(LegacyComponentSerializer.SECTION_CHAR, LegacyComponentSerializer.AMPERSAND_CHAR);
|
||||
}
|
||||
if (string.indexOf(LegacyComponentSerializer.AMPERSAND_CHAR) == -1) {
|
||||
return miniMessage().deserialize(string);
|
||||
}
|
||||
return miniMessage().deserialize(
|
||||
miniMessage().serialize(LEGACY_HEX_SERIALIZER.deserialize(string))
|
||||
.replace("\\<", "<")
|
||||
.replace("\\>", ">")
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse a string with possible legacy Ampersand/Section symbols
|
||||
* using a parsing Context
|
||||
* <p><b>
|
||||
* This method should only be used in case a String is provided from a legacy plugin/mod
|
||||
* or legacy source, where it is very likely to get a legacy string.
|
||||
* It is not recommended to use this method regularly in any sense
|
||||
* </b></p>
|
||||
*
|
||||
* @param string the string
|
||||
* @param context the provided parsing context
|
||||
* @return a parsed string
|
||||
* @since 2.2.1
|
||||
*/
|
||||
public static Component parsePossibleLegacy(@Nullable String string, final Context context) {
|
||||
if (string == null || string.isEmpty()) return Component.empty();
|
||||
if (string.indexOf(LegacyComponentSerializer.SECTION_CHAR) != -1) {
|
||||
string = string.replace(LegacyComponentSerializer.SECTION_CHAR, LegacyComponentSerializer.AMPERSAND_CHAR);
|
||||
}
|
||||
if (string.indexOf(LegacyComponentSerializer.AMPERSAND_CHAR) == -1) {
|
||||
return context.deserialize(string);
|
||||
}
|
||||
return context.deserialize(
|
||||
miniMessage().serialize(LEGACY_HEX_SERIALIZER.deserialize(string))
|
||||
.replace("\\<", "<")
|
||||
.replace("\\>", ">")
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse a string with possible legacy Ampersand/Section symbols
|
||||
* using the provided resolver
|
||||
* <p><b>
|
||||
* This method should only be used in case a String is provided from a legacy plugin/mod
|
||||
* or legacy source, where it is very likely to get a legacy string.
|
||||
* It is not recommended to use this method regularly in any sense
|
||||
* </b></p>
|
||||
*
|
||||
* @param string the string
|
||||
* @param resolver a resolver
|
||||
* @return a parsed string
|
||||
* @since 2.2.1
|
||||
*/
|
||||
public static Component parsePossibleLegacy(@Nullable String string, final TagResolver resolver) {
|
||||
if (string == null || string.isEmpty()) return Component.empty();
|
||||
if (string.indexOf(LegacyComponentSerializer.SECTION_CHAR) != -1) {
|
||||
string = string.replace(LegacyComponentSerializer.SECTION_CHAR, LegacyComponentSerializer.AMPERSAND_CHAR);
|
||||
}
|
||||
if (string.indexOf(LegacyComponentSerializer.AMPERSAND_CHAR) == -1) {
|
||||
return miniMessage().deserialize(string, resolver);
|
||||
}
|
||||
return miniMessage().deserialize(
|
||||
miniMessage().serialize(LEGACY_HEX_SERIALIZER.deserialize(string))
|
||||
.replace("\\<", "<")
|
||||
.replace("\\>", ">"),
|
||||
resolver
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the provided string contains legacy formatting.
|
||||
*
|
||||
* @param string the string input
|
||||
* @return whether the string has legacy content
|
||||
* @see LegacyComponentSerializer#AMPERSAND_CHAR
|
||||
* @see LegacyComponentSerializer#SECTION_CHAR
|
||||
* @since 2.3.0
|
||||
*/
|
||||
public static boolean hasLegacyFormat(final String string) {
|
||||
requireNonNull(string, "string");
|
||||
return string.indexOf(LegacyComponentSerializer.SECTION_CHAR) != -1
|
||||
|| string.indexOf(LegacyComponentSerializer.AMPERSAND_CHAR) != -1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Maps the input to a type depending on whether it contains legacy formatting or not.
|
||||
*
|
||||
* @param string the string input
|
||||
* @param legacyMapping the mapping function in case the string contains legacy formatting
|
||||
* @param modernMapping the mapping function in case the string does not contain any legacy character type,
|
||||
* being safe to use with MiniMessage
|
||||
* @param <R> the result type
|
||||
* @return the mapped result
|
||||
* @see LegacyComponentSerializer#AMPERSAND_CHAR
|
||||
* @see LegacyComponentSerializer#SECTION_CHAR
|
||||
* @see #hasLegacyFormat(String)
|
||||
* @since 2.3.0
|
||||
*/
|
||||
public static <R> R mapLegacyOrElse(
|
||||
final String string,
|
||||
final Function<String, R> legacyMapping,
|
||||
final Function<String, R> modernMapping
|
||||
) {
|
||||
requireNonNull(legacyMapping, "legacyMapping");
|
||||
requireNonNull(modernMapping, "modernInput");
|
||||
if (hasLegacyFormat(string)) {
|
||||
return legacyMapping.apply(string);
|
||||
} else {
|
||||
return modernMapping.apply(string);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,66 +0,0 @@
|
||||
package io.github.miniplaceholders.api.utils;
|
||||
|
||||
import io.github.miniplaceholders.api.resolver.AudienceTagResolver;
|
||||
import io.github.miniplaceholders.api.resolver.GlobalTagResolver;
|
||||
import io.github.miniplaceholders.api.resolver.RelationalTagResolver;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
/**
|
||||
* Tags basic instances.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public final class Tags {
|
||||
private Tags() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Empty Tag
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public static final Tag EMPTY_TAG = Tag.selfClosingInserting(Component.empty());
|
||||
|
||||
/**
|
||||
* Null Tag
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public static final @Nullable Tag NULL_TAG = null;
|
||||
|
||||
/**
|
||||
* An Audience placeholder that returns a null Tag
|
||||
*
|
||||
* @param <A> the placeholder supported type
|
||||
* @return an empty audience resolver
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public static <A extends Audience> AudienceTagResolver<A> emptyAudienceResolver() {
|
||||
return (audience, queue, ctx) -> NULL_TAG;
|
||||
}
|
||||
|
||||
/**
|
||||
* A Relational placeholder that returns a null tag
|
||||
*
|
||||
* @param <A> the audience type supported
|
||||
* @return an empty relational resolver
|
||||
* @since 3.0.0
|
||||
*/
|
||||
public static <A extends Audience> RelationalTagResolver<A> emptyRelationalResolver() {
|
||||
return (audience, relational, queue, ctx) -> NULL_TAG;
|
||||
}
|
||||
|
||||
/**
|
||||
* A Global placeholder that returns a null tag
|
||||
*
|
||||
* @since 3.0.0
|
||||
* @return an empty global placeholder
|
||||
*/
|
||||
public static GlobalTagResolver emptyGlobalPlaceholder() {
|
||||
return (queue, ctx) -> NULL_TAG;
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,205 @@
|
||||
package me.dreamerzero.miniplaceholders.api;
|
||||
|
||||
import org.jetbrains.annotations.Contract;
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
import org.jetbrains.annotations.Nullable;
|
||||
|
||||
import java.util.function.BiFunction;
|
||||
import java.util.function.Predicate;
|
||||
|
||||
import me.dreamerzero.miniplaceholders.api.placeholder.AudiencePlaceholder;
|
||||
import me.dreamerzero.miniplaceholders.api.placeholder.RelationalPlaceholder;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.builder.AbstractBuilder;
|
||||
import net.kyori.adventure.text.minimessage.Context;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
|
||||
/**
|
||||
* Expansion that contains placeholders
|
||||
*
|
||||
* <p>Usage Example:</p>
|
||||
* <pre>
|
||||
* Player player = event.getPlayer();
|
||||
* Expansion.Builder builder = Expansion.builder("player")
|
||||
* .audiencePlaceholder("name", (p, queue, ctx) -> Tag.selfClosingInserting(Component.text(((Player)p).getUsername()))
|
||||
* .build();
|
||||
* Expansion expansion = builder.build();
|
||||
* // You can also call the {@link Expansion#register} method to register
|
||||
* // the {@link Expansion} in the {@link MiniPlaceholders} global Extensions and
|
||||
* // use it in {@link MiniPlaceholders#getAudiencePlaceholders(Audience)} e.g.
|
||||
* TagResolver resolver = expansion.audiencePlaceholder(player);
|
||||
* player.sendMessage(MiniMessage.miniMessage().deserialize("Hello {@literal <luckperms_prefix> <player_name>}", resolver));
|
||||
* </pre>
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public interface Expansion {
|
||||
/**
|
||||
* Get the expansion name
|
||||
* @return the expansion name
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@NotNull String name();
|
||||
|
||||
/**
|
||||
* Get the {@link TagResolver} of the desired {@link Audience}
|
||||
* @param audience the audience
|
||||
* @return A TagResolver with variable placeholders of an Audience
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Contract("null -> fail; !null -> !null")
|
||||
@NotNull TagResolver audiencePlaceholders(final @NotNull Audience audience);
|
||||
|
||||
/**
|
||||
* Get the relational placeholders based on two audiences
|
||||
*
|
||||
* <p>The resulting TagResolver will give results according
|
||||
* to the 2 {@link Audience} provided and when called
|
||||
* at any time will retrieve the required values</p>
|
||||
* @param audience the main audience
|
||||
* @param otherAudience the secondary audience
|
||||
* @return A TagResolver with variable placeholders between 2 {@link Audience}s
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Contract("_, null -> fail, null, _ -> fail; !null, !null -> !null")
|
||||
@NotNull TagResolver relationalPlaceholders(final @NotNull Audience audience, final @NotNull Audience otherAudience);
|
||||
|
||||
/**
|
||||
* Get global placeholders
|
||||
* @return the global placeholders
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@NotNull TagResolver globalPlaceholders();
|
||||
|
||||
/**
|
||||
* Register this expansion
|
||||
* @since 1.0.0
|
||||
*/
|
||||
void register();
|
||||
|
||||
/**
|
||||
* Creates a new Expansion Builder
|
||||
* @param name the expansion name
|
||||
* @return a new expansion builder
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public static @NotNull Expansion.Builder builder(final @NotNull String name){
|
||||
return new ExpansionImpl.Builder(name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Expansion Builder
|
||||
* <p>Example use:</p>
|
||||
* <pre>
|
||||
* Expansion.Builder builder = Expansion.builder("player");
|
||||
* builder
|
||||
* // Thanks to this filter, a cast can be performed without the probability of a ClassCastException
|
||||
* .filter(Player.class)
|
||||
* .audiencePlaceholder("name", (audience, queue, ctx) -> Tag.selfClosingInserting(Component.text(((Player)audience).getUsername())));
|
||||
* Expansion expansion = builder.build();
|
||||
* </pre>
|
||||
*
|
||||
* then use it:
|
||||
*
|
||||
* <pre>
|
||||
* Player player = event.getPlayer();
|
||||
* TagResolver resolver = expansion.audiencePlaceholder(player);
|
||||
* Component messageReplaced = MiniMessage.deserialize({@link String}, resolver);
|
||||
* </pre>
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public static interface Builder extends AbstractBuilder<Expansion> {
|
||||
/**
|
||||
* Adds an audience placeholder
|
||||
*
|
||||
* <p>This type of Placeholder depends on a specific audience to obtain its values</p>
|
||||
*
|
||||
* <p>The content of this Placeholder is cached
|
||||
* and can mutate depending on when it is invoked</p>
|
||||
* @param key the placeholder key, cannot be an empty or black string
|
||||
* @param audiencePlaceholder the single placeholder
|
||||
* @return the {@link Builder} itself
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Contract("null, _ -> fail; _, null -> fail; !null, !null -> this")
|
||||
@NotNull Builder audiencePlaceholder(final @NotNull String key, final @NotNull AudiencePlaceholder audiencePlaceholder);
|
||||
|
||||
/**
|
||||
* Adds an Relational Placeholder based on two audiences
|
||||
*
|
||||
* <p>This type of placeholder allows you to create
|
||||
* components based on a 2-audiences relationship,
|
||||
* one is the one on which the placeholder
|
||||
* is based and the other is the one on which
|
||||
* the placeholder is displayed.</p>
|
||||
*
|
||||
* <p>The content of this Placeholder is cached
|
||||
* and can mutate depending on when it is invoked</p>
|
||||
* @param key the placeholder key, cannot be an empty or black string
|
||||
* @param relationalPlaceholder the relational placeholder
|
||||
* @return the {@link Builder} itself
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Contract("null, _ -> fail; _, null -> fail; !null, !null -> this")
|
||||
@NotNull Builder relationalPlaceholder(final @NotNull String key, final @NotNull RelationalPlaceholder relationalPlaceholder);
|
||||
|
||||
/**
|
||||
* Adds a global placeholder
|
||||
*
|
||||
* <p>The content of this Placeholder is cached
|
||||
* and can mutate depending on when it is invoked</p>
|
||||
* @param key the placeholder key, cannot be an empty or black string
|
||||
* @param function the function
|
||||
* @return the {@link Builder} itself
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Contract("null, _ -> fail; _, null -> fail; !null, !null -> this")
|
||||
@NotNull Builder globalPlaceholder(final @NotNull String key, final @NotNull BiFunction<@NotNull ArgumentQueue, @NotNull Context, @Nullable Tag> function);
|
||||
|
||||
/**
|
||||
* Adds a global placeholder
|
||||
*
|
||||
* <p>This placeholder is not cached and is inmutable</p>
|
||||
* @param key the placeholder key, cannot be an empty or black string
|
||||
* @param tag the tag of this placeholder
|
||||
* @return the {@link Builder} itself
|
||||
* @since 1.1.0
|
||||
*/
|
||||
@Contract("null, _ -> fail; _, null -> fail; !null, !null -> this")
|
||||
@NotNull Builder globalPlaceholder(final @NotNull String key, final @NotNull Tag tag);
|
||||
|
||||
/**
|
||||
* Filter the type of Audiences that this expansion can receive
|
||||
* <p>In case the {@link Expansion#audiencePlaceholders(Audience)} or
|
||||
* {@link Expansion#relationalPlaceholders(Audience, Audience)} method is called
|
||||
* and the provided audiences are not instances of
|
||||
* the specified class, a {@link TagResolver#empty} will be returned</p>
|
||||
*
|
||||
* <p>This eliminates the need to perform a manual
|
||||
* <pre>if(!(audience instanceof Player)) return TagResolver.empty();</pre>
|
||||
* @param clazz the class to filter
|
||||
* @return the {@link Builder} itself
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Contract("_ -> this")
|
||||
@NotNull Builder filter(final @Nullable Class<? extends Audience> clazz);
|
||||
|
||||
/**
|
||||
* Filters the audiences that this expansion can receive through a Predicate
|
||||
* <p>Example:</p>
|
||||
* <pre>
|
||||
* Expansion.builder("example").filter(Player.class).filter(aud -> isInProtectedServer((Player)aud))
|
||||
* .audiencePlaceholder("hello", (aud, queue, ctx) -> Tag.selfInsertingClosing(Component.text("you are in protected server")))
|
||||
* .build();
|
||||
* </pre>
|
||||
* @param predicate the check to realize
|
||||
* @return the {@link Builder} itself
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Contract("_ -> this")
|
||||
@NotNull Builder filter(final @Nullable Predicate<Audience> predicate);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,202 @@
|
||||
package me.dreamerzero.miniplaceholders.api;
|
||||
|
||||
import java.util.Collection;
|
||||
import java.util.HashSet;
|
||||
import java.util.Locale;
|
||||
import java.util.Objects;
|
||||
import java.util.Set;
|
||||
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
import org.jetbrains.annotations.Nullable;
|
||||
|
||||
import java.util.function.BiFunction;
|
||||
import java.util.function.Predicate;
|
||||
|
||||
import me.dreamerzero.miniplaceholders.api.placeholder.AudiencePlaceholder;
|
||||
import me.dreamerzero.miniplaceholders.api.placeholder.RelationalPlaceholder;
|
||||
import me.dreamerzero.miniplaceholders.api.utils.Conditions;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.text.minimessage.Context;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
|
||||
final class ExpansionImpl implements Expansion {
|
||||
private final String name;
|
||||
private final Tags.Single[] audiencePlaceholders;
|
||||
private final Tags.Relational[] relationalPlaceholders;
|
||||
private final TagResolver globalPlaceholders;
|
||||
private final Class<? extends Audience> filterClass;
|
||||
private final Predicate<Audience> predicateFilter;
|
||||
|
||||
ExpansionImpl(
|
||||
@NotNull final String expansionName,
|
||||
@Nullable final Collection<Tags.Single> audiencePlaceholders,
|
||||
@Nullable final Collection<Tags.Relational> relationalPlaceholders,
|
||||
@Nullable final TagResolver globalPlaceholders,
|
||||
@Nullable final Class<? extends Audience> filterClass,
|
||||
@Nullable final Predicate<Audience> predicateFilter){
|
||||
this.name = expansionName+"-";
|
||||
this.audiencePlaceholders = audiencePlaceholders != null
|
||||
? audiencePlaceholders.toArray(Tags.Single[]::new)
|
||||
: new Tags.Single[0];
|
||||
this.relationalPlaceholders = relationalPlaceholders != null
|
||||
? relationalPlaceholders.toArray(Tags.Relational[]::new)
|
||||
: new Tags.Relational[0];
|
||||
this.globalPlaceholders = globalPlaceholders == null
|
||||
? TagResolver.empty()
|
||||
: globalPlaceholders;
|
||||
this.filterClass = filterClass;
|
||||
this.predicateFilter = predicateFilter;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String name(){
|
||||
return this.name;
|
||||
}
|
||||
|
||||
@Override
|
||||
public @NotNull TagResolver audiencePlaceholders(@NotNull final Audience audience){
|
||||
if(audiencePlaceholders.length == 0) return TagResolver.empty();
|
||||
|
||||
Objects.requireNonNull(audience, () -> "the audience cannot be null");
|
||||
|
||||
if(this.singleFilter(audience)) return TagResolver.empty();
|
||||
|
||||
final TagResolver.Builder placeholders = TagResolver.builder();
|
||||
for(final Tags.Single pl : this.audiencePlaceholders){
|
||||
placeholders.resolver(pl.of(audience));
|
||||
}
|
||||
return placeholders.build();
|
||||
}
|
||||
|
||||
private boolean singleFilter(final Audience audience){
|
||||
return filterClass != null && !filterClass.isInstance(audience)
|
||||
|| predicateFilter != null && predicateFilter.test(audience);
|
||||
}
|
||||
|
||||
@Override
|
||||
public @NotNull TagResolver relationalPlaceholders(@NotNull final Audience audience, @NotNull final Audience otherAudience){
|
||||
if(relationalPlaceholders.length == 0) return TagResolver.empty();
|
||||
|
||||
Objects.requireNonNull(audience, () -> "the audience cannot be null");
|
||||
Objects.requireNonNull(otherAudience, () -> "the other audience cannot be null");
|
||||
|
||||
if(this.relationalFilter(audience, otherAudience)) return TagResolver.empty();
|
||||
|
||||
final TagResolver.Builder placeholders = TagResolver.builder();
|
||||
for(final Tags.Relational pl : this.relationalPlaceholders){
|
||||
placeholders.resolver(pl.of(audience, otherAudience));
|
||||
}
|
||||
return placeholders.build();
|
||||
}
|
||||
|
||||
private boolean relationalFilter(final Audience audience, final Audience otherAudience){
|
||||
return filterClass != null && (!filterClass.isInstance(audience) || !filterClass.isInstance(otherAudience))
|
||||
|| predicateFilter != null && (!predicateFilter.test(audience) || !predicateFilter.test(otherAudience));
|
||||
}
|
||||
|
||||
@Override
|
||||
public @NotNull TagResolver globalPlaceholders(){
|
||||
return this.globalPlaceholders;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void register(){
|
||||
MiniPlaceholders.expansions.add(this);
|
||||
}
|
||||
|
||||
static final class Builder implements Expansion.Builder {
|
||||
private final String expansionName;
|
||||
private Set<Tags.Single> audiencePlaceholders;
|
||||
private Set<Tags.Relational> relationalPlaceholders;
|
||||
private TagResolver.Builder globalPlaceholders;
|
||||
private Class<? extends Audience> filterClass;
|
||||
private Predicate<Audience> predicateFilter;
|
||||
|
||||
Builder(@NotNull final String name){
|
||||
this.expansionName = Conditions.nonNullOrEmptyString(name, () -> "expansion name")
|
||||
.toLowerCase(Locale.ROOT).concat("_");
|
||||
}
|
||||
|
||||
@Override
|
||||
public Builder audiencePlaceholder(@NotNull final String key, @NotNull final AudiencePlaceholder audiencePlaceholder){
|
||||
Conditions.nonNullOrEmptyString(key, () -> "placeholder key");
|
||||
Objects.requireNonNull(audiencePlaceholder, () -> "the audience placeholder cannot be null");
|
||||
|
||||
if(this.audiencePlaceholders == null) this.audiencePlaceholders = new HashSet<>(5);
|
||||
|
||||
this.audiencePlaceholders.add(Tags.single(expansionName+key, audiencePlaceholder));
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Builder relationalPlaceholder(@NotNull final String key, @NotNull final RelationalPlaceholder relationalPlaceholder){
|
||||
Conditions.nonNullOrEmptyString(key, () -> "placeholder key");
|
||||
Objects.requireNonNull(relationalPlaceholder, () -> "the relational placeholder cannot be null");
|
||||
|
||||
if(this.relationalPlaceholders == null) this.relationalPlaceholders = new HashSet<>(4);
|
||||
|
||||
this.relationalPlaceholders.add(Tags.relational(expansionName+"rel_"+key, relationalPlaceholder));
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Builder globalPlaceholder(@NotNull final String key, @NotNull final BiFunction<ArgumentQueue, Context, Tag> function){
|
||||
Conditions.nonNullOrEmptyString(key, () -> "placeholder key");
|
||||
Objects.requireNonNull(function, () -> "the global placeholder cannot be null");
|
||||
|
||||
if(this.globalPlaceholders == null) this.globalPlaceholders = TagResolver.builder();
|
||||
|
||||
this.globalPlaceholders.tag(expansionName+key, function);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Builder globalPlaceholder(@NotNull final String key, @NotNull final Tag tag){
|
||||
Conditions.nonNullOrEmptyString(key, () -> "placeholder key");
|
||||
Objects.requireNonNull(tag, () -> "the tag cannot be null");
|
||||
|
||||
if(this.globalPlaceholders == null) this.globalPlaceholders = TagResolver.builder();
|
||||
|
||||
this.globalPlaceholders.tag(expansionName+key, tag);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Builder filter(@Nullable final Class<? extends Audience> clazz) {
|
||||
this.filterClass = clazz;
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Builder filter(@Nullable final Predicate<Audience> predicate){
|
||||
this.predicateFilter = predicate;
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public @NotNull Expansion build(){
|
||||
return new ExpansionImpl(
|
||||
this.expansionName,
|
||||
this.audiencePlaceholders,
|
||||
this.relationalPlaceholders,
|
||||
this.globalPlaceholders != null ? this.globalPlaceholders.build() : null,
|
||||
this.filterClass,
|
||||
this.predicateFilter
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(Object o){
|
||||
if(this==o) return true;
|
||||
if(o == null || o.getClass() != ExpansionImpl.class) return false;
|
||||
return ((ExpansionImpl)o).name.equals(this.name);
|
||||
}
|
||||
|
||||
@Override
|
||||
public int hashCode(){
|
||||
return Objects.hash(name.hashCode());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,201 @@
|
||||
package me.dreamerzero.miniplaceholders.api;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.HashSet;
|
||||
import java.util.Objects;
|
||||
import java.util.Set;
|
||||
|
||||
import org.jetbrains.annotations.Contract;
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
|
||||
import me.dreamerzero.miniplaceholders.api.enums.Platform;
|
||||
import me.dreamerzero.miniplaceholders.api.utils.Resolvers;
|
||||
import me.dreamerzero.miniplaceholders.connect.InternalPlatform;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
|
||||
/**
|
||||
* MiniPlaceholders
|
||||
*
|
||||
* <p>This class allows you to obtain the {@link TagResolver}
|
||||
* that other plugins provide based on single {@link Audience},
|
||||
* 2-audience or global placeholders</p>
|
||||
*
|
||||
* @author 4drian3d
|
||||
* @see TagResolver
|
||||
* @see Expansion
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public final class MiniPlaceholders {
|
||||
private MiniPlaceholders(){}
|
||||
static final Set<Expansion> expansions = Collections.synchronizedSet(new HashSet<>());
|
||||
|
||||
/**
|
||||
* Get the platform
|
||||
* @return the platform
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public static @NotNull Platform getPlatform() {
|
||||
return InternalPlatform.platform() == InternalPlatform.PAPER
|
||||
? Platform.PAPER
|
||||
: Platform.VELOCITY;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the global placeholders
|
||||
*
|
||||
* <pre>TagResolver resolver = MiniPlaceholders.getGlobalPlaceholders();
|
||||
* Component messageParsed = MiniMessage.miniMessage().deserialize({@link String}, resolver);</pre>
|
||||
*
|
||||
* @return global placeholders independient of any audience
|
||||
* @see TagResolver
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public static @NotNull TagResolver getGlobalPlaceholders() {
|
||||
final TagResolver.Builder builder = TagResolver.builder();
|
||||
for (final Expansion expansion : expansions) {
|
||||
final TagResolver resolver = expansion.globalPlaceholders();
|
||||
if (resolver != TagResolver.empty())
|
||||
builder.resolver(resolver);
|
||||
}
|
||||
return builder.build();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the TagResolver based on an Audience
|
||||
*
|
||||
* <pre>TagResolver resolver = MiniPlaceholders.getAudiencePlaceholders({@link Audience});
|
||||
* Component messageParsed = MiniMessage.miniMessage().deserialize({@link String}, resolver);</pre>
|
||||
*
|
||||
* @param audience the audience
|
||||
* @return {@link TagResolver} with placeholders based on an audience
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Contract("null -> fail, !null -> !null")
|
||||
public static @NotNull TagResolver getAudiencePlaceholders(final @NotNull Audience audience) {
|
||||
Objects.requireNonNull(audience, () -> "audience cannot be null");
|
||||
|
||||
final TagResolver.Builder resolvers = TagResolver.builder();
|
||||
for (Expansion expansion : expansions) {
|
||||
final TagResolver resolver = expansion.audiencePlaceholders(audience);
|
||||
if (resolver != TagResolver.empty())
|
||||
resolvers.resolver(resolver);
|
||||
}
|
||||
return resolvers.build();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the relationals placeholders based on two audiences
|
||||
*
|
||||
* <pre>TagResolver resolver = MiniPlaceholders.getRelationalPlaceholders({@link Audience}, {@link Audience});
|
||||
* Component messageParsed = MiniMessage.miniMessage().deserialize({@link String}, resolver);</pre>
|
||||
*
|
||||
* @param audience an audience
|
||||
* @param otherAudience another audience
|
||||
* @return placeholders based on two audiences
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Contract("_, null -> fail; null, _ -> fail; !null, !null -> !null")
|
||||
public static @NotNull TagResolver getRelationalPlaceholders(final @NotNull Audience audience, final @NotNull Audience otherAudience) {
|
||||
Objects.requireNonNull(audience, () -> "audience cannot be null");
|
||||
Objects.requireNonNull(otherAudience, () -> "otherAudience cannot be null");
|
||||
|
||||
final TagResolver.Builder builder = TagResolver.builder();
|
||||
for (final Expansion expansion : expansions) {
|
||||
Resolvers.applyIfNotEmpty(
|
||||
expansion.relationalPlaceholders(audience, otherAudience),
|
||||
builder
|
||||
);
|
||||
}
|
||||
|
||||
return builder.build();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the TagResolver based on an Audience and the global placeholders
|
||||
*
|
||||
* <pre>
|
||||
* TagResolver resolver = MiniPlaceholders.getAudienceGlobalPlaceholders({@link Audience});
|
||||
* TagResolver resolver2 = TagResolver.resolver(
|
||||
* MiniPlaceholders.getAudienceGlobalPlaceholders({@link Audience}),
|
||||
* MiniPlaceholders.getGlobalPlaceholders()
|
||||
* );
|
||||
* // This two resolvers returns the same TagResolver
|
||||
* assertEquals(resolver, resolver2);
|
||||
* Component messageParsed = MiniMessage.miniMessage().deserialize({@link String}, resolver);
|
||||
* </pre>
|
||||
*
|
||||
* @param audience the audience
|
||||
* @return {@link TagResolver} with placeholders based on an audience and the global placeholders
|
||||
* @since 1.1.0
|
||||
*/
|
||||
@Contract("_, null -> fail; null, _ -> fail; !null, !null -> !null")
|
||||
public static @NotNull TagResolver getAudienceGlobalPlaceholders(final @NotNull Audience audience) {
|
||||
Objects.requireNonNull(audience, () -> "audience cannot be null");
|
||||
final TagResolver.Builder builder = TagResolver.builder();
|
||||
|
||||
for (final Expansion expansion : expansions) {
|
||||
Resolvers.applyIfNotEmpty(expansion.audiencePlaceholders(audience), builder);
|
||||
Resolvers.applyIfNotEmpty(expansion.globalPlaceholders(), builder);
|
||||
}
|
||||
|
||||
return builder.build();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the relationals placeholders based on two audiences, based on the first audience,
|
||||
* and the global placeholders
|
||||
*
|
||||
* <pre>
|
||||
* TagResolver resolver = MiniPlaceholders.getRelationalGlobalPlaceholders({@link Audience}, {@link Audience});
|
||||
* TagResolver resolver2 = TagResolver.resolver(
|
||||
* MiniPlaceholders.getRelationalPlaceholders(audience1, audience2),
|
||||
* MiniPlaceholders.getAudiencePlaceholders(audience1),
|
||||
* MiniPlaceholders.getGlobalPlaceholders()
|
||||
* );
|
||||
* // This methods should return the same TagResolver
|
||||
* assertEquals(resolver, resolver2);
|
||||
* Component messageParsed = MiniMessage.miniMessage().deserialize({@link String}, resolver);
|
||||
* </pre>
|
||||
*
|
||||
* @param audience an audience
|
||||
* @param otherAudience another audience
|
||||
* @return the placeholders based on two audiences, placeholders based on the first audience and the global placeholders
|
||||
* @since 1.1.0
|
||||
*/
|
||||
@Contract("_, null -> fail; null, _ -> fail; !null, !null -> !null")
|
||||
public static @NotNull TagResolver getRelationalGlobalPlaceholders(final @NotNull Audience audience, final @NotNull Audience otherAudience) {
|
||||
Objects.requireNonNull(audience, () -> "audience cannot be null");
|
||||
Objects.requireNonNull(otherAudience, () -> "otherAudience cannot be null");
|
||||
|
||||
final TagResolver.Builder builder = TagResolver.builder();
|
||||
for (final Expansion expansion : expansions) {
|
||||
Resolvers.applyIfNotEmpty(expansion.audiencePlaceholders(audience), builder);
|
||||
Resolvers.applyIfNotEmpty(expansion.relationalPlaceholders(audience, otherAudience), builder);
|
||||
Resolvers.applyIfNotEmpty(expansion.globalPlaceholders(), builder);
|
||||
}
|
||||
|
||||
return builder.build();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the ammount of expansion registered
|
||||
* @return the ammount of expansions registered
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public static int getExpansionCount(){
|
||||
return expansions.size();
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the platform
|
||||
* @param platform the platform
|
||||
* @deprecated dont use this, INTERNAL
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Deprecated(forRemoval = true, since = "1.1.0")
|
||||
@org.jetbrains.annotations.ApiStatus.Internal
|
||||
public static void setPlatform(Platform platform){
|
||||
throw new UnsupportedOperationException("Cannot set platform twice");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,107 @@
|
||||
package me.dreamerzero.miniplaceholders.api;
|
||||
|
||||
import java.util.Objects;
|
||||
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
import org.jetbrains.annotations.Nullable;
|
||||
|
||||
import me.dreamerzero.miniplaceholders.api.placeholder.AudiencePlaceholder;
|
||||
import me.dreamerzero.miniplaceholders.api.placeholder.RelationalPlaceholder;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.text.minimessage.Context;
|
||||
import net.kyori.adventure.text.minimessage.ParsingException;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
|
||||
final class Tags {
|
||||
private Tags(){}
|
||||
|
||||
static Relational relational(@NotNull final String name, @NotNull final RelationalPlaceholder relationalPlaceholder){
|
||||
return new Tags.Relational(name, relationalPlaceholder);
|
||||
}
|
||||
|
||||
static Single single(@NotNull final String name, @NotNull final AudiencePlaceholder audiencePlaceholder){
|
||||
return new Single(name, audiencePlaceholder);
|
||||
}
|
||||
|
||||
static final class Relational {
|
||||
private final RelationalPlaceholder relationalPlaceholder;
|
||||
private final String key;
|
||||
|
||||
Relational(final String key, final RelationalPlaceholder relationalPlaceholder){
|
||||
this.relationalPlaceholder = relationalPlaceholder;
|
||||
this.key = key;
|
||||
}
|
||||
|
||||
TagResolver of(@NotNull final Audience audience, @NotNull final Audience otherAudience){
|
||||
return new TagResolver(){
|
||||
@Override
|
||||
public @Nullable Tag resolve(@NotNull String name, @NotNull ArgumentQueue arguments,
|
||||
@NotNull Context ctx) throws ParsingException {
|
||||
|
||||
return this.has(name)
|
||||
? relationalPlaceholder.tag(audience, otherAudience, arguments, ctx)
|
||||
: null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean has(@NotNull String name) {
|
||||
return key.equalsIgnoreCase(name);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(Object o){
|
||||
if(o == this) return true;
|
||||
if(!(o instanceof Relational)) return false;
|
||||
return ((Relational)o).key.equals(this.key);
|
||||
}
|
||||
|
||||
@Override
|
||||
public int hashCode(){
|
||||
return Objects.hash(key);
|
||||
}
|
||||
}
|
||||
|
||||
static final class Single {
|
||||
private final AudiencePlaceholder audiencePlaceholder;
|
||||
private final String key;
|
||||
|
||||
private Single(@NotNull final String key, @NotNull final AudiencePlaceholder audiencePlaceholder){
|
||||
this.key = key;
|
||||
this.audiencePlaceholder = audiencePlaceholder;
|
||||
}
|
||||
|
||||
TagResolver of(@NotNull final Audience audience){
|
||||
return new TagResolver() {
|
||||
|
||||
@Override
|
||||
public @Nullable Tag resolve(@NotNull String name, @NotNull ArgumentQueue arguments,
|
||||
@NotNull Context ctx) throws ParsingException {
|
||||
return this.has(name)
|
||||
? audiencePlaceholder.tag(audience, arguments, ctx)
|
||||
: null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean has(@NotNull String name) {
|
||||
return key.equalsIgnoreCase(name);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(Object o){
|
||||
if(o == this) return true;
|
||||
if(!(o instanceof Single)) return false;
|
||||
return ((Single)o).key.equals(this.key);
|
||||
}
|
||||
|
||||
@Override
|
||||
public int hashCode(){
|
||||
return Objects.hash(key);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
package me.dreamerzero.miniplaceholders.api.annotation;
|
||||
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
import me.dreamerzero.miniplaceholders.api.enums.Platform;
|
||||
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@Target(ElementType.TYPE)
|
||||
public @interface Extension {
|
||||
String name();
|
||||
|
||||
Platform[] platform();
|
||||
|
||||
String version() default "";
|
||||
}
|
||||
+63
@@ -0,0 +1,63 @@
|
||||
package me.dreamerzero.miniplaceholders.api.annotation.processor;
|
||||
|
||||
import com.google.gson.Gson;
|
||||
import javax.annotation.processing.AbstractProcessor;
|
||||
import javax.annotation.processing.ProcessingEnvironment;
|
||||
import javax.annotation.processing.RoundEnvironment;
|
||||
import javax.annotation.processing.SupportedAnnotationTypes;
|
||||
import javax.lang.model.element.Element;
|
||||
import javax.lang.model.element.ElementKind;
|
||||
import javax.lang.model.element.Name;
|
||||
import javax.lang.model.element.TypeElement;
|
||||
import javax.tools.Diagnostic;
|
||||
import javax.tools.FileObject;
|
||||
import javax.tools.StandardLocation;
|
||||
|
||||
import me.dreamerzero.miniplaceholders.api.annotation.Extension;
|
||||
|
||||
import java.io.BufferedWriter;
|
||||
import java.io.IOException;
|
||||
import java.io.Writer;
|
||||
import java.util.Set;
|
||||
|
||||
@SupportedAnnotationTypes({"me.dreamerzero.miniplaceholders.api.annotation.Extension"})
|
||||
public class ExtensionAnnotationProcessor extends AbstractProcessor {
|
||||
private ProcessingEnvironment environment;
|
||||
|
||||
@Override
|
||||
public synchronized void init(ProcessingEnvironment processingEnv) {
|
||||
this.environment = processingEnv;
|
||||
}
|
||||
|
||||
@Override
|
||||
public synchronized boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
|
||||
if (roundEnv.processingOver()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
for (Element element : roundEnv.getElementsAnnotatedWith(Extension.class)) {
|
||||
if (element.getKind() != ElementKind.CLASS) {
|
||||
return false;
|
||||
}
|
||||
|
||||
Extension extension = element.getAnnotation(Extension.class);
|
||||
Name name = ((TypeElement) element).getQualifiedName();
|
||||
|
||||
try {
|
||||
FileObject object = environment.getFiler()
|
||||
.createResource(StandardLocation.CLASS_OUTPUT, "", "miniplaceholders-extension.json");
|
||||
try (Writer writer = new BufferedWriter(object.openWriter())) {
|
||||
new Gson().toJson(new ProcessedExtension(
|
||||
extension.name(),
|
||||
extension.version(),
|
||||
name.toString(),
|
||||
extension.platform()),
|
||||
writer);
|
||||
}
|
||||
} catch (IOException e) {
|
||||
environment.getMessager().printMessage(Diagnostic.Kind.ERROR, "Cannot generate extension file");
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
}
|
||||
+30
@@ -0,0 +1,30 @@
|
||||
package me.dreamerzero.miniplaceholders.api.annotation.processor;
|
||||
|
||||
import me.dreamerzero.miniplaceholders.api.enums.Platform;
|
||||
|
||||
public final class ProcessedExtension {
|
||||
private final String name;
|
||||
private final String version;
|
||||
private final Platform[] platforms;
|
||||
private final String clazz;
|
||||
|
||||
ProcessedExtension(String name, String version, String clazz, Platform... platforms) {
|
||||
this.name = name;
|
||||
this.version = version;
|
||||
this.platforms = platforms;
|
||||
this.clazz = clazz;
|
||||
}
|
||||
|
||||
public String getName() {
|
||||
return name;
|
||||
}
|
||||
public String getVersion() {
|
||||
return version;
|
||||
}
|
||||
public Platform[] getPlatforms() {
|
||||
return platforms;
|
||||
}
|
||||
public String getClazz() {
|
||||
return this.clazz;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
package me.dreamerzero.miniplaceholders.api.enums;
|
||||
|
||||
/**Platforms on which MiniPlaceholders can be used */
|
||||
public enum Platform {
|
||||
/**Paper Platform */
|
||||
PAPER,
|
||||
/**Velocity Platform */
|
||||
VELOCITY
|
||||
}
|
||||
@@ -0,0 +1,2 @@
|
||||
/**Plugin enums */
|
||||
package me.dreamerzero.miniplaceholders.api.enums;
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
* MiniPlaceholders core package
|
||||
*/
|
||||
package me.dreamerzero.miniplaceholders.api;
|
||||
+12
-11
@@ -1,26 +1,27 @@
|
||||
package io.github.miniplaceholders.api.resolver;
|
||||
package me.dreamerzero.miniplaceholders.api.placeholder;
|
||||
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
import org.jetbrains.annotations.Nullable;
|
||||
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.text.minimessage.Context;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
/**
|
||||
* Audience Placeholder based on an Audience
|
||||
*
|
||||
* @param <A> the audience type
|
||||
*/
|
||||
/**Audience Placeholder based on an Audience */
|
||||
@FunctionalInterface
|
||||
public interface AudienceTagResolver<A extends Audience> {
|
||||
public interface AudiencePlaceholder {
|
||||
/**
|
||||
* A Tag based on an Audience
|
||||
* @param audience the audience
|
||||
* @param queue the argument queue
|
||||
* @param ctx the context
|
||||
* @return a Tag
|
||||
* @since 3.0.0
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Nullable
|
||||
Tag tag(final A audience, final ArgumentQueue queue, final Context ctx);
|
||||
@Nullable Tag tag(
|
||||
@NotNull final Audience audience,
|
||||
@NotNull final ArgumentQueue queue,
|
||||
@NotNull final Context ctx
|
||||
);
|
||||
}
|
||||
+29
@@ -0,0 +1,29 @@
|
||||
package me.dreamerzero.miniplaceholders.api.placeholder;
|
||||
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
import org.jetbrains.annotations.Nullable;
|
||||
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.text.minimessage.Context;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue;
|
||||
|
||||
/**Relational Placeholder based on two Audiences*/
|
||||
@FunctionalInterface
|
||||
public interface RelationalPlaceholder {
|
||||
/**
|
||||
* A Tag based on two audiences
|
||||
* @param audience the principal audience
|
||||
* @param otherAudience the another audience
|
||||
* @param queue the argument queue
|
||||
* @param ctx the context
|
||||
* @return a tag
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Nullable Tag tag(
|
||||
@NotNull final Audience audience,
|
||||
@NotNull final Audience otherAudience,
|
||||
@NotNull final ArgumentQueue queue,
|
||||
@NotNull final Context ctx
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
* Placeholders available based on information obtained from Audiences
|
||||
*/
|
||||
package me.dreamerzero.miniplaceholders.api.placeholder;
|
||||
+6
-12
@@ -1,36 +1,30 @@
|
||||
package io.github.miniplaceholders.api.utils;
|
||||
package me.dreamerzero.miniplaceholders.api.utils;
|
||||
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.TextComponent;
|
||||
import net.kyori.adventure.text.format.NamedTextColor;
|
||||
|
||||
/**
|
||||
* Common components used in expansions
|
||||
*/
|
||||
/**Common components used in expansions */
|
||||
public final class Components {
|
||||
private Components(){}
|
||||
/**
|
||||
* "True" Component.
|
||||
*
|
||||
* "True" Component
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public static final TextComponent TRUE_COMPONENT = Component.text("true", NamedTextColor.GREEN);
|
||||
/**
|
||||
* "False" Component.
|
||||
*
|
||||
* False Component
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public static final TextComponent FALSE_COMPONENT = Component.text("false", NamedTextColor.RED);
|
||||
|
||||
/**
|
||||
* "Yes" Component.
|
||||
*
|
||||
* "Yes" Component
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public static final TextComponent YES_COMPONENT = Component.text("yes", NamedTextColor.GREEN);
|
||||
/**
|
||||
* "No" Component.
|
||||
*
|
||||
* "No" Component
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public static final TextComponent NO_COMPONENT = Component.text("no", NamedTextColor.RED);
|
||||
@@ -0,0 +1,37 @@
|
||||
package me.dreamerzero.miniplaceholders.api.utils;
|
||||
|
||||
import java.util.function.Supplier;
|
||||
|
||||
/** Checks required for the correct operation of the expansions*/
|
||||
public final class Conditions {
|
||||
private Conditions(){}
|
||||
|
||||
/**
|
||||
* Checks if a string is null or empty or consists of whitespace characters only
|
||||
* @param string the string
|
||||
* @param name the name supplier
|
||||
* @return the string if it is not null or empty
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public static String nonNullOrEmptyString(String string, Supplier<String> name){
|
||||
if(string == null)
|
||||
throw new NullPointerException("the " + name.get() + " cannot be null");
|
||||
if(string.isBlank())
|
||||
throw new IllegalStateException("the " + name.get() + "cannot be an empty string");
|
||||
return string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a string is empty or consists of whitespace characters only
|
||||
* @param string the string
|
||||
* @param reason the reason supplier
|
||||
* @return the string if it not empty
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public static String nonEmptyString(String string, Supplier<String> reason){
|
||||
if(string.isBlank())
|
||||
throw new IllegalStateException(reason.get());
|
||||
return string;
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,44 @@
|
||||
package me.dreamerzero.miniplaceholders.api.utils;
|
||||
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
import org.jetbrains.annotations.Nullable;
|
||||
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer;
|
||||
|
||||
import static net.kyori.adventure.text.minimessage.MiniMessage.miniMessage;
|
||||
|
||||
/**
|
||||
* Legacy utils
|
||||
*/
|
||||
public final class LegacyUtils {
|
||||
private LegacyUtils(){}
|
||||
|
||||
/**
|
||||
* Legacy serializer with hex support
|
||||
*
|
||||
* Use this as the last available alternative,
|
||||
* it is recommended to use MiniMessage instead of this serializer
|
||||
*/
|
||||
public static final LegacyComponentSerializer LEGACY_HEX_SERIALIZER = LegacyComponentSerializer.builder()
|
||||
.character('&')
|
||||
.hexColors()
|
||||
.build();
|
||||
|
||||
/**
|
||||
* Parse a string with possible legacy symbols
|
||||
* @param string the string
|
||||
* @return a parsed string
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public static @NotNull Component parsePossibleLegacy(@Nullable String string) {
|
||||
if(string == null || string.isBlank()) return Component.empty();
|
||||
if(string.indexOf('&') != 0){
|
||||
return miniMessage().deserialize(
|
||||
miniMessage().serialize(LEGACY_HEX_SERIALIZER.deserialize(string))
|
||||
);
|
||||
} else {
|
||||
return miniMessage().deserialize(string);
|
||||
}
|
||||
}
|
||||
}
|
||||
+10
-12
@@ -1,10 +1,11 @@
|
||||
package io.github.miniplaceholders.api.utils;
|
||||
package me.dreamerzero.miniplaceholders.api.utils;
|
||||
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
|
||||
/**
|
||||
* Class of utilities to manage TagResolvers.
|
||||
*
|
||||
* Class of utilities to manage TagResolvers
|
||||
* @since 1.2.0
|
||||
*/
|
||||
public final class Resolvers {
|
||||
@@ -12,36 +13,33 @@ public final class Resolvers {
|
||||
|
||||
/**
|
||||
* Check if the TagResolver is an instance of TagResolver.empty(),
|
||||
* that is, it will always return null.
|
||||
*
|
||||
* that is, it will always return null
|
||||
* @param resolver the resolver to check
|
||||
* @return true if the TagResolver is the same as TagResolver.empty(), else false
|
||||
* @since 1.2.0
|
||||
*/
|
||||
public static boolean isEmpty(final TagResolver resolver) {
|
||||
public static boolean isEmpty(final @NotNull TagResolver resolver) {
|
||||
return resolver == TagResolver.empty();
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the TagResolver provided is not a TagResolver.empty().
|
||||
*
|
||||
* Checks if the TagResolver provided is not a TagResolver.empty()
|
||||
* @param resolver the resolver to check
|
||||
* @return false if the TagResolver is the same as TagResolver.empty(), else true
|
||||
* @since 1.2.0
|
||||
*
|
||||
*/
|
||||
public static boolean isNotEmpty(final TagResolver resolver) {
|
||||
public static boolean isNotEmpty(final @NotNull TagResolver resolver) {
|
||||
return resolver != TagResolver.empty();
|
||||
}
|
||||
|
||||
/**
|
||||
* Applies a TagResolver to a TagResolver.Builder in case it is not a TagResolver.empty().
|
||||
*
|
||||
* Applies a TagResolver to a TagResolver.Builder in case it is not a TagResolver.empty()
|
||||
* @param resolver the resolver to check
|
||||
* @param builder the resolver that can be added to the builder
|
||||
* @since 1.2.0
|
||||
*/
|
||||
public static void applyIfNotEmpty(final TagResolver resolver, final TagResolver.Builder builder) {
|
||||
public static void applyIfNotEmpty(final @NotNull TagResolver resolver, final @NotNull TagResolver.Builder builder) {
|
||||
if (isNotEmpty(resolver)) {
|
||||
builder.resolver(resolver);
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
package me.dreamerzero.miniplaceholders.api.utils;
|
||||
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
|
||||
import me.dreamerzero.miniplaceholders.api.placeholder.AudiencePlaceholder;
|
||||
import me.dreamerzero.miniplaceholders.api.placeholder.RelationalPlaceholder;
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
|
||||
/**Tags utils */
|
||||
public final class TagsUtils {
|
||||
private TagsUtils(){}
|
||||
|
||||
/**
|
||||
* Empty Tag
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public static final Tag EMPTY_TAG = Tag.selfClosingInserting(Component.empty());
|
||||
|
||||
/**
|
||||
* Null Tag
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public static final Tag NULL_TAG = null;
|
||||
|
||||
/**
|
||||
* An Audience placeholder that returns a null Tag
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public static final AudiencePlaceholder NULL_AUDIENCE_PLACEHOLDER = (aud, queue, ctx) -> NULL_TAG;
|
||||
|
||||
/**
|
||||
* A Relational placeholder that returns a null tag
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public static final RelationalPlaceholder NULL_RELATIONAL_PLACEHOLDER = (aud, otheraud, queue, ctx) -> NULL_TAG;
|
||||
|
||||
/**
|
||||
* Creates a new Tag based on a String
|
||||
* @param string the string
|
||||
* @return a new basic self closing Tag of a string
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public static @NotNull Tag staticTag(@NotNull String string) {
|
||||
return Tag.selfClosingInserting(Component.text(string));
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new basic Tag based on a Component
|
||||
* @param component the component
|
||||
* @return a new basic self closing Tag of a component
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public static @NotNull Tag staticTag(@NotNull Component component) {
|
||||
return Tag.selfClosingInserting(component);
|
||||
}
|
||||
|
||||
}
|
||||
+1
-1
@@ -2,4 +2,4 @@
|
||||
* General Utilities
|
||||
* Here you will find utilities that will help you in the development of expansions
|
||||
*/
|
||||
package io.github.miniplaceholders.api.utils;
|
||||
package me.dreamerzero.miniplaceholders.api.utils;
|
||||
@@ -1,24 +1,15 @@
|
||||
import org.jspecify.annotations.NullMarked;
|
||||
module me.dreamerzero.miniplaceholders.api {
|
||||
requires net.kyori.adventure;
|
||||
requires net.kyori.examination.api;
|
||||
requires net.kyori.adventure.text.minimessage;
|
||||
requires static org.jetbrains.annotations;
|
||||
requires me.dreamerzero.miniplaceholders.connect;
|
||||
requires java.base;
|
||||
requires java.compiler;
|
||||
requires com.google.gson;
|
||||
|
||||
/**
|
||||
* MiniPlaceholders API Module
|
||||
*/
|
||||
@NullMarked
|
||||
open module io.github.miniplaceholders.api {
|
||||
requires io.github.miniplaceholders.connect;
|
||||
|
||||
requires net.kyori.adventure.api;
|
||||
requires net.kyori.adventure.text.minimessage;
|
||||
requires net.kyori.adventure.text.serializer.legacy;
|
||||
|
||||
requires static org.jetbrains.annotations;
|
||||
requires static org.jspecify;
|
||||
requires static team.unnamed.inject;
|
||||
|
||||
exports io.github.miniplaceholders.api;
|
||||
exports io.github.miniplaceholders.api.types;
|
||||
exports io.github.miniplaceholders.api.utils;
|
||||
exports io.github.miniplaceholders.api.resolver;
|
||||
exports io.github.miniplaceholders.api.placeholder;
|
||||
exports io.github.miniplaceholders.api.provider;
|
||||
exports me.dreamerzero.miniplaceholders.api;
|
||||
exports me.dreamerzero.miniplaceholders.api.enums;
|
||||
exports me.dreamerzero.miniplaceholders.api.utils;
|
||||
exports me.dreamerzero.miniplaceholders.api.placeholder;
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
me.dreamerzero.miniplaceholders.api.annotation.processor.ExtensionAnnotationProcessor
|
||||
@@ -1,65 +0,0 @@
|
||||
package io.github.miniplaceholders.test;
|
||||
|
||||
import io.github.miniplaceholders.api.Expansion;
|
||||
import io.github.miniplaceholders.api.placeholder.GlobalPlaceholder;
|
||||
import io.github.miniplaceholders.api.types.PlaceholderType;
|
||||
import io.github.miniplaceholders.api.utils.Tags;
|
||||
import io.github.miniplaceholders.test.instances.TestAudience;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import org.junit.jupiter.api.DisplayName;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
class ExpansionsTest implements MiniTest {
|
||||
@Test
|
||||
@DisplayName("Expansion Equality")
|
||||
void equalsExpansions(){
|
||||
final Expansion firstExpansion = Expansion.builder("equals")
|
||||
.audiencePlaceholder("test", Tags.emptyAudienceResolver())
|
||||
.build();
|
||||
final Expansion secondExpansion = Expansion.builder("equals")
|
||||
.audiencePlaceholder("test", Tags.emptyAudienceResolver())
|
||||
.build();
|
||||
|
||||
assertEquals(firstExpansion, secondExpansion);
|
||||
}
|
||||
|
||||
@Test
|
||||
void placeholderRetrievalTest() {
|
||||
final Expansion expansion = Expansion.builder("test")
|
||||
.globalPlaceholder("some_placeholder", Tag.preProcessParsed("test"))
|
||||
.build();
|
||||
|
||||
assertTrue(expansion.hasGlobalPlaceholder("some_placeholder"));
|
||||
final GlobalPlaceholder somePlaceholder = expansion.globalPlaceholderByName("some_placeholder");
|
||||
assertNotNull(somePlaceholder);
|
||||
|
||||
final var expansionResult = parse("Result: <test_some_placeholder>", expansion.globalPlaceholders());
|
||||
final var placeholderResult = parse("Result: <test_some_placeholder>", somePlaceholder);
|
||||
assertSimilarity("Result: test", expansionResult);
|
||||
assertSimilarity("Result: test", placeholderResult);
|
||||
}
|
||||
|
||||
@Test
|
||||
void placeholdersByType() {
|
||||
final Expansion expansion = Expansion.builder("idk")
|
||||
.audiencePlaceholder(TestAudience.class, "test", Tags.emptyAudienceResolver())
|
||||
.build();
|
||||
|
||||
var placeholders = expansion.placeholdersByType(PlaceholderType.AUDIENCE);
|
||||
assertNotNull(placeholders);
|
||||
assertEquals(placeholders, expansion.audiencePlaceholders());
|
||||
}
|
||||
|
||||
@Test
|
||||
void placeholdersByName() {
|
||||
final Expansion expansion = Expansion.builder("test")
|
||||
.globalPlaceholder("someexpansion", Tags.emptyGlobalPlaceholder())
|
||||
.build();
|
||||
|
||||
final GlobalPlaceholder placeholder = expansion.globalPlaceholderByName("someexpansion");
|
||||
assertNotNull(placeholder);
|
||||
assertEquals("someexpansion", placeholder.name());
|
||||
}
|
||||
}
|
||||
@@ -1,42 +0,0 @@
|
||||
package io.github.miniplaceholders.test;
|
||||
|
||||
import io.github.miniplaceholders.api.utils.LegacyStrings;
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.minimessage.tag.Inserting;
|
||||
import net.kyori.adventure.text.minimessage.tag.PreProcess;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.serializer.plain.PlainTextComponentSerializer;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
class LegacyTest implements MiniTest {
|
||||
@Test
|
||||
void testLegacyParsing() {
|
||||
final String string = "<rainbow>hello... i &8hate legacy format §bso much";
|
||||
final Component parsed = LegacyStrings.parsePossibleLegacy(string);
|
||||
final String result = PlainTextComponentSerializer.plainText().serialize(parsed);
|
||||
final String expected = "hello... i hate legacy format so much";
|
||||
|
||||
assertEquals(expected, result);
|
||||
}
|
||||
|
||||
@Test
|
||||
void testMapLegacyOrElse() {
|
||||
final String legacyInput = "&fhi <red>aaaa";
|
||||
Tag legacyProcessedTag = LegacyStrings.mapLegacyOrElse(
|
||||
legacyInput,
|
||||
legacy -> Tag.inserting(LegacyStrings.parsePossibleLegacy(legacy)),
|
||||
Tag::preProcessParsed
|
||||
);
|
||||
assertInstanceOf(Inserting.class, legacyProcessedTag);
|
||||
|
||||
final String modernInput = "<rainbow>aaaaaaaaaaaaa";
|
||||
Tag modernProcessedTag = LegacyStrings.mapLegacyOrElse(
|
||||
modernInput,
|
||||
__ -> fail(),
|
||||
Tag::preProcessParsed
|
||||
);
|
||||
assertInstanceOf(PreProcess.class, modernProcessedTag);
|
||||
}
|
||||
}
|
||||
@@ -1,43 +0,0 @@
|
||||
package io.github.miniplaceholders.test;
|
||||
|
||||
import io.github.miniplaceholders.api.Expansion;
|
||||
import io.github.miniplaceholders.api.MiniPlaceholders;
|
||||
import io.github.miniplaceholders.api.utils.Tags;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
class MiniPlaceholdersTest implements MiniTest {
|
||||
@Test
|
||||
void methodEquality(){
|
||||
Expansion.builder("equality")
|
||||
.audiencePlaceholder("audience", Tags.emptyAudienceResolver())
|
||||
.globalPlaceholder("global", (_, _) -> Tags.EMPTY_TAG)
|
||||
.build()
|
||||
.register();
|
||||
|
||||
|
||||
assertEquals(
|
||||
MiniPlaceholders.audienceGlobalPlaceholders(),
|
||||
TagResolver.resolver(
|
||||
MiniPlaceholders.audiencePlaceholders(),
|
||||
MiniPlaceholders.globalPlaceholders()
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
@Test
|
||||
void registrationTest() {
|
||||
Expansion expansion = Expansion.builder("testregistration")
|
||||
.build();
|
||||
expansion.register();
|
||||
|
||||
assertNotNull(MiniPlaceholders.expansionByName("testregistration"));
|
||||
|
||||
assertTrue(expansion.registered());
|
||||
assertThrows(IllegalStateException.class, expansion::register);
|
||||
|
||||
assertDoesNotThrow(expansion::unregister);
|
||||
}
|
||||
}
|
||||
@@ -1,30 +0,0 @@
|
||||
package io.github.miniplaceholders.test;
|
||||
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.minimessage.MiniMessage;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
import net.kyori.adventure.text.serializer.plain.PlainTextComponentSerializer;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertNotNull;
|
||||
|
||||
public interface MiniTest {
|
||||
default void assertContentEquals(Component first, Component second) {
|
||||
String firstSerialized = PlainTextComponentSerializer.plainText().serialize(first);
|
||||
String secondSerialized = PlainTextComponentSerializer.plainText().serialize(second);
|
||||
|
||||
assertEquals(firstSerialized, secondSerialized);
|
||||
}
|
||||
|
||||
default void assertSimilarity(String string, Component component) {
|
||||
final String serialized = PlainTextComponentSerializer.plainText().serializeOrNull(component);
|
||||
|
||||
assertNotNull(serialized);
|
||||
|
||||
assertEquals(string, serialized);
|
||||
}
|
||||
|
||||
default Component parse(String string, TagResolver resolver) {
|
||||
return MiniMessage.miniMessage().deserialize(string, resolver);
|
||||
}
|
||||
}
|
||||
@@ -1,151 +0,0 @@
|
||||
package io.github.miniplaceholders.test;
|
||||
|
||||
import static net.kyori.adventure.text.minimessage.MiniMessage.miniMessage;
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
import io.github.miniplaceholders.api.types.RelationalAudience;
|
||||
import io.github.miniplaceholders.test.instances.TestAudience;
|
||||
import io.github.miniplaceholders.test.instances.TestAudienceHolder;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.api.DisplayName;
|
||||
|
||||
import io.github.miniplaceholders.api.Expansion;
|
||||
import io.github.miniplaceholders.api.MiniPlaceholders;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.format.NamedTextColor;
|
||||
import net.kyori.adventure.text.minimessage.MiniMessage;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
|
||||
class PlaceholderTest implements MiniTest {
|
||||
|
||||
@Test
|
||||
@DisplayName("Audience Placeholder Test")
|
||||
void audienceExpansionPlaceholdersTest() {
|
||||
TestAudience player = new TestAudience("4drian3d");
|
||||
|
||||
Expansion expansion = Expansion.builder("example")
|
||||
.audiencePlaceholder("name", (aud, queue, ctx) -> {
|
||||
TestAudience audience = (TestAudience) aud;
|
||||
return Tag.selfClosingInserting(Component.text(audience.name()));
|
||||
}).build();
|
||||
|
||||
final Component expected = Component.text("Player Name: 4drian3d");
|
||||
final Component result = miniMessage().deserialize("Player Name: <example_name>", player, expansion.audiencePlaceholders());
|
||||
|
||||
assertContentEquals(expected, result);
|
||||
}
|
||||
|
||||
@Test
|
||||
@DisplayName("Relational Placeholder Test")
|
||||
void relationalExpansionPlaceholdersTest() {
|
||||
Audience p1 = new TestAudience("PlayerOne");
|
||||
Audience p2 = new TestAudience("PlayerTwo");
|
||||
|
||||
Expansion expansion = Expansion.builder("relational")
|
||||
.relationalPlaceholder(TestAudience.class, "enemy",
|
||||
(aud, relational, queue, ctx) ->
|
||||
Tag.selfClosingInserting(this.isEnemy(aud, relational)
|
||||
? Component.text("Enemy", NamedTextColor.RED)
|
||||
: Component.text("Neutral", NamedTextColor.GREEN)
|
||||
))
|
||||
.build();
|
||||
|
||||
assertEquals(
|
||||
MiniMessage.miniMessage().deserialize("You are <red>Enemy"),
|
||||
MiniMessage.miniMessage().deserialize("You are <relational_rel_enemy>",
|
||||
RelationalAudience.from(p1, p2),
|
||||
expansion.relationalPlaceholders()));
|
||||
}
|
||||
|
||||
@Test
|
||||
@DisplayName("Global Placeholder Test")
|
||||
void globalExpansionPlaceholderTest() {
|
||||
Expansion expansion = Expansion.builder("global")
|
||||
.globalPlaceholder("players", (queue, ctx) -> Tag.selfClosingInserting(Component.text(1305)))
|
||||
.globalPlaceholder("servers", (queue, ctx) -> Tag.selfClosingInserting(Component.text(7)))
|
||||
.build();
|
||||
|
||||
final Component expected = Component.text("Online players: 1305 | Servers: 7");
|
||||
final Component actual = MiniMessage.miniMessage().deserialize("Online players: <global_players> | Servers: <global_servers>",
|
||||
expansion.globalPlaceholders());
|
||||
|
||||
assertContentEquals(expected, actual);
|
||||
}
|
||||
|
||||
@Test
|
||||
@DisplayName("Registered Placeholders")
|
||||
void instancePlaceholdersTest() {
|
||||
Expansion.builder("instance")
|
||||
.globalPlaceholder("hello", (queue, ctx) -> Tag.selfClosingInserting(Component.text("hello", NamedTextColor.RED)))
|
||||
.build()
|
||||
.register();
|
||||
|
||||
Component expected = Component.text("hello player", NamedTextColor.RED);
|
||||
Component actual = MiniMessage.miniMessage().deserialize("<instance_hello> player", MiniPlaceholders.globalPlaceholders());
|
||||
|
||||
assertContentEquals(expected, actual);
|
||||
}
|
||||
|
||||
@Test
|
||||
@DisplayName("Filtered Expansion")
|
||||
void filteredExpansion() {
|
||||
Expansion expansion = Expansion.builder("filter")
|
||||
.audiencePlaceholder(TestAudience.class, "name",
|
||||
(aud, queue, ctx) -> Tag.selfClosingInserting(Component.text(aud.name())))
|
||||
.build();
|
||||
|
||||
Audience player = new TestAudience("TestPlayer04");
|
||||
Audience emptyAudience = Audience.empty();
|
||||
|
||||
String string = "Player Name: <filter_name>";
|
||||
|
||||
Component playerExpected = Component.text("Player Name: TestPlayer04");
|
||||
Component emptyExpected = Component.text("Player Name: <filter_name>");
|
||||
|
||||
assertContentEquals(playerExpected, MiniMessage.miniMessage().deserialize(string, player, expansion.audiencePlaceholders()));
|
||||
assertContentEquals(emptyExpected, MiniMessage.miniMessage().deserialize(string, emptyAudience, expansion.audiencePlaceholders()));
|
||||
}
|
||||
|
||||
@Test
|
||||
@DisplayName("Empty Arguments")
|
||||
void testEmptyArguments() {
|
||||
final Expansion expansion = Expansion.builder("test")
|
||||
.globalPlaceholder("testing", (queue, ctx) -> {
|
||||
int arguments = 0;
|
||||
while (queue.hasNext()) {
|
||||
arguments++;
|
||||
Tag.Argument argument = queue.pop();
|
||||
assertTrue(argument.value().isBlank());
|
||||
}
|
||||
return Tag.selfClosingInserting(Component.text("Arguments: " + arguments));
|
||||
})
|
||||
.build();
|
||||
|
||||
Component parsed = miniMessage().deserialize("<test_testing::>", expansion.globalPlaceholders());
|
||||
|
||||
assertContentEquals(parsed, Component.text("Arguments: 2"));
|
||||
}
|
||||
|
||||
@Test
|
||||
@DisplayName("Forwarding Audience Parsing Test")
|
||||
void forwardingAudienceTest() {
|
||||
Expansion expansion = Expansion.builder("test")
|
||||
.audiencePlaceholder(TestAudience.class, "testing",
|
||||
(audience, queue, ctx) -> Tag.selfClosingInserting(Component.text("Name: " + audience.name())))
|
||||
.build();
|
||||
|
||||
TestAudience testAudience = new TestAudience("4drian3d");
|
||||
Audience forward = new TestAudienceHolder(testAudience);
|
||||
|
||||
Component parsed = miniMessage().deserialize("<test_testing>.", forward, expansion.audiencePlaceholders());
|
||||
Component expected = Component.text("Name: 4drian3d.");
|
||||
|
||||
assertContentEquals(parsed, expected);
|
||||
}
|
||||
|
||||
private boolean isEnemy(TestAudience a1, TestAudience a2) {
|
||||
return a1.name().equals("PlayerOne") && a2.name().equals("PlayerTwo");
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,48 +0,0 @@
|
||||
package io.github.miniplaceholders.test;
|
||||
|
||||
import io.github.miniplaceholders.api.Expansion;
|
||||
import io.github.miniplaceholders.api.MiniPlaceholders;
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.format.NamedTextColor;
|
||||
import net.kyori.adventure.text.minimessage.Context;
|
||||
import net.kyori.adventure.text.minimessage.tag.Modifying;
|
||||
import net.kyori.adventure.text.minimessage.tag.ParserDirective;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
import net.kyori.adventure.text.serializer.plain.PlainTextComponentSerializer;
|
||||
import org.jspecify.annotations.NonNull;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
|
||||
public class TagTest implements MiniTest {
|
||||
@Test
|
||||
void testTag() {
|
||||
Expansion.builder("tags")
|
||||
.globalPlaceholder("modifying", FilteringTag::new)
|
||||
.globalPlaceholder("parser_directive", ParserDirective.RESET)
|
||||
.build()
|
||||
.register();
|
||||
|
||||
final TagResolver globalResolver = MiniPlaceholders.globalPlaceholders();
|
||||
assertSimilarity("------ replacement ------", parse("------ <tags_modifying>test</tags_modifying> ------", globalResolver));
|
||||
assertEquals(Component.text()
|
||||
.append(Component.text("aaaaaa", NamedTextColor.RED), Component.text("aaaaaaa"))
|
||||
.build(),
|
||||
parse("<red>aaaaaa<tags_parser_directive>aaaaaaa", globalResolver));
|
||||
}
|
||||
|
||||
public record FilteringTag(ArgumentQueue queue, Context context) implements Modifying {
|
||||
@Override
|
||||
public Component apply(@NonNull Component current, int depth) {
|
||||
if (depth != 0) {
|
||||
return Component.empty();
|
||||
}
|
||||
final String serialized = PlainTextComponentSerializer.plainText().serialize(current);
|
||||
if (serialized.contains("test")) {
|
||||
return Component.text(serialized.replace("test", "replacement"));
|
||||
}
|
||||
return current;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,36 +0,0 @@
|
||||
package io.github.miniplaceholders.test;
|
||||
|
||||
import io.github.miniplaceholders.api.Expansion;
|
||||
import io.github.miniplaceholders.api.resolver.GlobalTagResolver;
|
||||
import io.github.miniplaceholders.api.utils.Tags;
|
||||
import org.junit.jupiter.api.DisplayName;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
|
||||
import static org.junit.jupiter.api.Assertions.assertThrows;
|
||||
|
||||
//yea... it is intended xd
|
||||
@SuppressWarnings("DataFlowIssue")
|
||||
class ThrowableTest implements MiniTest {
|
||||
@Test
|
||||
@DisplayName("Nullable Exception")
|
||||
void throwOnNull(){
|
||||
assertThrows(NullPointerException.class, () -> Expansion.builder(null));
|
||||
|
||||
Expansion.Builder expansionTest = assertDoesNotThrow(() -> Expansion.builder("throwable"));
|
||||
|
||||
assertThrows(NullPointerException.class, () -> expansionTest.audiencePlaceholder(null, (aud, queue, ctx) -> Tags.EMPTY_TAG));
|
||||
assertThrows(NullPointerException.class, () -> expansionTest.globalPlaceholder("test", (GlobalTagResolver) null));
|
||||
}
|
||||
|
||||
@Test
|
||||
@DisplayName("Empty Exception")
|
||||
void throwOnBlankString(){
|
||||
Expansion.Builder builder = assertDoesNotThrow(() -> Expansion.builder("hello"));
|
||||
|
||||
assertThrows(IllegalStateException.class, () -> builder.audiencePlaceholder("", (aud, queue, ctx) -> Tags.EMPTY_TAG));
|
||||
assertThrows(IllegalStateException.class, () -> builder.globalPlaceholder(" ", (queue, ctx) -> Tags.EMPTY_TAG));
|
||||
|
||||
assertDoesNotThrow(() -> builder.globalPlaceholder("hehe", (queue, ctx) -> Tags.EMPTY_TAG));
|
||||
}
|
||||
}
|
||||
@@ -1,7 +0,0 @@
|
||||
package io.github.miniplaceholders.test.instances;
|
||||
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import org.jspecify.annotations.NullMarked;
|
||||
|
||||
@NullMarked
|
||||
public record TestAudience(String name) implements Audience {}
|
||||
@@ -1,12 +0,0 @@
|
||||
package io.github.miniplaceholders.test.instances;
|
||||
|
||||
import net.kyori.adventure.audience.ForwardingAudience;
|
||||
import org.jspecify.annotations.NullMarked;
|
||||
|
||||
@NullMarked
|
||||
public record TestAudienceHolder(TestAudience audience) implements ForwardingAudience.Single {
|
||||
@Override
|
||||
public TestAudience audience() {
|
||||
return audience;
|
||||
}
|
||||
}
|
||||
@@ -1,21 +0,0 @@
|
||||
package io.github.miniplaceholders.test.loader;
|
||||
|
||||
import io.github.miniplaceholders.api.Expansion;
|
||||
import io.github.miniplaceholders.api.provider.ExpansionProvider;
|
||||
import io.github.miniplaceholders.api.provider.LoadRequirement;
|
||||
import io.github.miniplaceholders.api.types.Platform;
|
||||
|
||||
public class TestExpansionProvider implements ExpansionProvider {
|
||||
@Override
|
||||
public Expansion provideExpansion() {
|
||||
return Expansion.builder("provided").build();
|
||||
}
|
||||
|
||||
@Override
|
||||
public LoadRequirement loadRequirement() {
|
||||
return LoadRequirement.allOf(
|
||||
LoadRequirement.platform(Platform.FABRIC, Platform.PAPER),
|
||||
LoadRequirement.requiredComplement("luckperms", "LuckPerms")
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
package me.dreamerzero.miniplaceholders;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
|
||||
import org.junit.jupiter.api.DisplayName;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import me.dreamerzero.miniplaceholders.api.Expansion;
|
||||
import me.dreamerzero.miniplaceholders.api.utils.TagsUtils;
|
||||
|
||||
class ExpansionsTest {
|
||||
@Test
|
||||
@DisplayName("Expansion Equality")
|
||||
void equalsExpansions(){
|
||||
final Expansion firstExpansion = Expansion.builder("equals")
|
||||
.audiencePlaceholder("test", TagsUtils.NULL_AUDIENCE_PLACEHOLDER)
|
||||
.build();
|
||||
final Expansion secondExpansion = Expansion.builder("equals")
|
||||
.audiencePlaceholder("test", TagsUtils.NULL_AUDIENCE_PLACEHOLDER)
|
||||
.build();
|
||||
|
||||
assertEquals(firstExpansion, secondExpansion);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
package me.dreamerzero.miniplaceholders;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
|
||||
import org.junit.jupiter.api.Disabled;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import me.dreamerzero.miniplaceholders.api.Expansion;
|
||||
import me.dreamerzero.miniplaceholders.api.MiniPlaceholders;
|
||||
import me.dreamerzero.miniplaceholders.api.utils.TagsUtils;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
|
||||
class MiniPlaceholdersTest {
|
||||
@Test
|
||||
@Disabled("Cannot correctly calculate the equity of 2 TagResolvers obtained in different ways")
|
||||
void methodEquality(){
|
||||
Expansion.builder("equality")
|
||||
.audiencePlaceholder("audience", TagsUtils.NULL_AUDIENCE_PLACEHOLDER)
|
||||
.globalPlaceholder("global", TagsUtils.EMPTY_TAG)
|
||||
.build()
|
||||
.register();
|
||||
|
||||
|
||||
assertEquals(
|
||||
MiniPlaceholders.getAudienceGlobalPlaceholders(Audience.empty()),
|
||||
TagResolver.resolver(
|
||||
MiniPlaceholders.getAudiencePlaceholders(Audience.empty()),
|
||||
MiniPlaceholders.getGlobalPlaceholders()
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,112 @@
|
||||
package me.dreamerzero.miniplaceholders;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.api.DisplayName;
|
||||
|
||||
import me.dreamerzero.miniplaceholders.api.Expansion;
|
||||
import me.dreamerzero.miniplaceholders.api.MiniPlaceholders;
|
||||
import me.dreamerzero.miniplaceholders.testobjects.TestAudience;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.format.NamedTextColor;
|
||||
import net.kyori.adventure.text.minimessage.MiniMessage;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.serializer.plain.PlainTextComponentSerializer;
|
||||
|
||||
class PlaceholderTest {
|
||||
|
||||
@Test
|
||||
@DisplayName("Audience Placeholder Test")
|
||||
void audienceExpansionPlaceholdersTest(){
|
||||
TestAudience player = new TestAudience("4drian3d");
|
||||
|
||||
Expansion expansion = Expansion.builder("example")
|
||||
.audiencePlaceholder("name", (aud, queue, ctx) -> Tag.selfClosingInserting(Component.text(((TestAudience)aud).getName()))).build();
|
||||
|
||||
final Component expected = Component.text("Player Name: 4drian3d");
|
||||
final Component result = MiniMessage.miniMessage().deserialize("Player Name: <example_name>", expansion.audiencePlaceholders(player));
|
||||
|
||||
assertEquals(expected, result);
|
||||
}
|
||||
|
||||
@Test
|
||||
@DisplayName("Relational Placeholder Test")
|
||||
void relationalExpansionPlaceholdersTest(){
|
||||
Audience p1 = new TestAudience("PlayerOne");
|
||||
Audience p2 = new TestAudience("PlayerTwo");
|
||||
|
||||
Expansion expansion = Expansion.builder("relational")
|
||||
.relationalPlaceholder("enemy",
|
||||
(aud, otheraud, queue, ctx) -> Tag.selfClosingInserting(this.isEnemy(((TestAudience)aud),((TestAudience)otheraud))
|
||||
? Component.text("Enemy", NamedTextColor.RED)
|
||||
: Component.text("Neutral", NamedTextColor.GREEN)
|
||||
))
|
||||
.build();
|
||||
|
||||
assertEquals(MiniMessage.miniMessage().deserialize("You are <red>Enemy"), MiniMessage.miniMessage().deserialize("You are <relational_rel_enemy>", expansion.relationalPlaceholders(p1, p2)));
|
||||
}
|
||||
|
||||
@Test
|
||||
@DisplayName("Global Placeholder Test")
|
||||
void globalExpansionPlaceholderTest(){
|
||||
Expansion expansion = Expansion.builder("global")
|
||||
.globalPlaceholder("players", (queue, ctx) -> Tag.selfClosingInserting(Component.text(1305)))
|
||||
.globalPlaceholder("servers", (queue, ctx) -> Tag.selfClosingInserting(Component.text(7)))
|
||||
.build();
|
||||
|
||||
final Component expected = Component.text("Online players: 1305 | Servers: 7");
|
||||
final Component actual = MiniMessage.miniMessage().deserialize("Online players: <global_players> | Servers: <global_servers>", expansion.globalPlaceholders());
|
||||
|
||||
assertEquals(expected, actual);
|
||||
}
|
||||
|
||||
@Test
|
||||
@DisplayName("Registered Placeholders")
|
||||
void instancePlaceholdersTest(){
|
||||
Expansion.builder("instance")
|
||||
.globalPlaceholder("hello", (queue, ctx) -> Tag.selfClosingInserting(Component.text("hello", NamedTextColor.RED)))
|
||||
.build()
|
||||
.register();
|
||||
|
||||
Component expected = Component.text("hello player", NamedTextColor.RED);
|
||||
Component actual = MiniMessage.miniMessage().deserialize("<instance_hello> player", MiniPlaceholders.getGlobalPlaceholders());
|
||||
|
||||
assertContentEquals(expected, actual);
|
||||
}
|
||||
|
||||
@Test
|
||||
@DisplayName("Filtered Expansion")
|
||||
void filteredExpansion(){
|
||||
Expansion expansion = Expansion.builder("filter")
|
||||
.audiencePlaceholder("name", (aud, queue, ctx) -> Tag.selfClosingInserting(Component.text(((TestAudience)aud).getName())))
|
||||
.filter(TestAudience.class)
|
||||
.build();
|
||||
|
||||
Audience player = new TestAudience("TestPlayer04");
|
||||
Audience emptyAudience = Audience.empty();
|
||||
|
||||
String string = "Player Name: <filter_name>";
|
||||
|
||||
Component playerExpected = Component.text("Player Name: TestPlayer04");
|
||||
Component emptyExpected = Component.text("Player Name: <filter_name>");
|
||||
|
||||
assertEquals(playerExpected, MiniMessage.miniMessage().deserialize(string, expansion.audiencePlaceholders(player)));
|
||||
assertEquals(emptyExpected, MiniMessage.miniMessage().deserialize(string, expansion.audiencePlaceholders(emptyAudience)));
|
||||
|
||||
|
||||
}
|
||||
|
||||
void assertContentEquals(Component first, Component second){
|
||||
String firstSerialized = PlainTextComponentSerializer.plainText().serialize(first);
|
||||
String secondSerialized = PlainTextComponentSerializer.plainText().serialize(second);
|
||||
|
||||
assertEquals(firstSerialized, secondSerialized);
|
||||
}
|
||||
|
||||
private boolean isEnemy(TestAudience a1, TestAudience a2){
|
||||
return a1.getName().equals("PlayerOne") && a2.getName().equals("PlayerTwo");
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
package me.dreamerzero.miniplaceholders;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
|
||||
import static org.junit.jupiter.api.Assertions.assertThrows;
|
||||
|
||||
import java.util.function.BiFunction;
|
||||
|
||||
import org.junit.jupiter.api.DisplayName;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import me.dreamerzero.miniplaceholders.api.Expansion;
|
||||
import me.dreamerzero.miniplaceholders.api.MiniPlaceholders;
|
||||
import me.dreamerzero.miniplaceholders.api.utils.TagsUtils;
|
||||
import net.kyori.adventure.text.minimessage.Context;
|
||||
import net.kyori.adventure.text.minimessage.tag.Tag;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue;
|
||||
|
||||
class ThrowableTest {
|
||||
@Test
|
||||
@DisplayName("Nullable Exception")
|
||||
void throwOnNull(){
|
||||
assertThrows(NullPointerException.class, () -> Expansion.builder(null));
|
||||
|
||||
Expansion.Builder expansionTest = assertDoesNotThrow(() -> Expansion.builder("throwable"));
|
||||
|
||||
assertThrows(NullPointerException.class, () -> expansionTest.audiencePlaceholder(null, (aud, queue, ctx) -> TagsUtils.EMPTY_TAG));
|
||||
assertThrows(NullPointerException.class, () -> expansionTest.globalPlaceholder("test", (BiFunction<ArgumentQueue, Context, Tag>)null));
|
||||
|
||||
Expansion.builder("testThrows")
|
||||
.audiencePlaceholder("test", (aud, queue, ctx) -> TagsUtils.EMPTY_TAG)
|
||||
.relationalPlaceholder("test2", (aud, aud2, queue, ctx) -> TagsUtils.EMPTY_TAG)
|
||||
.build()
|
||||
.register();
|
||||
|
||||
assertThrows(NullPointerException.class, () -> MiniPlaceholders.getAudiencePlaceholders(null));
|
||||
assertThrows(NullPointerException.class, () -> MiniPlaceholders.getRelationalPlaceholders(null, null));
|
||||
}
|
||||
|
||||
@Test
|
||||
@DisplayName("Empty Exception")
|
||||
void throwOnBlankString(){
|
||||
Expansion.Builder builder = assertDoesNotThrow(() -> Expansion.builder("hello"));
|
||||
|
||||
assertThrows(IllegalStateException.class, () -> builder.audiencePlaceholder("", (aud, queue, ctx) -> TagsUtils.EMPTY_TAG));
|
||||
assertThrows(IllegalStateException.class, () -> builder.globalPlaceholder(" ", (queue, ctx) -> TagsUtils.EMPTY_TAG));
|
||||
|
||||
assertDoesNotThrow(() -> builder.globalPlaceholder("hehe", (queue, ctx) -> TagsUtils.EMPTY_TAG));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
package me.dreamerzero.miniplaceholders.testobjects;
|
||||
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
|
||||
public final class TestAudience implements Audience {
|
||||
private final String name;
|
||||
public TestAudience(String name) {
|
||||
this.name = name;
|
||||
}
|
||||
|
||||
public @NotNull String getName(){
|
||||
return this.name;
|
||||
}
|
||||
}
|
||||
@@ -1,19 +0,0 @@
|
||||
plugins {
|
||||
`kotlin-dsl`
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation(libs.plugin.shadow)
|
||||
implementation(libs.plugin.kotlin)
|
||||
implementation(libs.plugin.runtask)
|
||||
}
|
||||
|
||||
repositories {
|
||||
gradlePluginPortal()
|
||||
}
|
||||
|
||||
kotlin {
|
||||
jvmToolchain {
|
||||
languageVersion = JavaLanguageVersion.of(25)
|
||||
}
|
||||
}
|
||||
@@ -1,19 +0,0 @@
|
||||
rootProject.name = "build-logic"
|
||||
|
||||
dependencyResolutionManagement {
|
||||
@Suppress("UnstableApiUsage")
|
||||
repositories {
|
||||
gradlePluginPortal()
|
||||
mavenCentral()
|
||||
}
|
||||
|
||||
versionCatalogs {
|
||||
register("libs") {
|
||||
from(files("../gradle/libs.versions.toml"))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
plugins {
|
||||
id("org.gradle.toolchains.foojay-resolver-convention") version "1.0.0"
|
||||
}
|
||||
@@ -1,7 +0,0 @@
|
||||
import org.gradle.api.Project
|
||||
|
||||
val Project.capitalizeName: String
|
||||
get() = this.name.substring(17)
|
||||
.replaceFirstChar { if (it.isLowerCase()) it.titlecase() else it.toString() }
|
||||
|
||||
fun Project.simpleName(): String = this.name.substring(17)
|
||||
@@ -1,11 +0,0 @@
|
||||
plugins {
|
||||
id("miniplaceholders.base")
|
||||
}
|
||||
|
||||
tasks {
|
||||
jar {
|
||||
manifest {
|
||||
attributes("Automatic-Module-Name" to "io.github.miniplaceholders.${project.simpleName()}")
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,28 +0,0 @@
|
||||
import java.util.*
|
||||
|
||||
plugins {
|
||||
java
|
||||
}
|
||||
|
||||
tasks {
|
||||
compileJava {
|
||||
options.encoding = Charsets.UTF_8.name()
|
||||
options.release.set(25)
|
||||
}
|
||||
jar {
|
||||
manifest {
|
||||
attributes(
|
||||
"Specification-Version" to project.version,
|
||||
"Specification-Vendor" to "MiniPlaceholders",
|
||||
"Implementation-Build-Date" to Date()
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
java{
|
||||
toolchain{
|
||||
languageVersion.set(JavaLanguageVersion.of(25))
|
||||
vendor.set(JvmVendorSpec.AZUL)
|
||||
}
|
||||
}
|
||||
@@ -1,32 +0,0 @@
|
||||
import org.gradle.api.tasks.bundling.Jar
|
||||
import xyz.jpenilla.runtask.task.RunWithPlugins
|
||||
import java.nio.file.Files
|
||||
import java.nio.file.StandardCopyOption
|
||||
import kotlin.io.path.deleteIfExists
|
||||
|
||||
tasks {
|
||||
withType<RunWithPlugins> {
|
||||
val exampleExpansionProviderProject = project(":miniplaceholders-example-expansion-provider")
|
||||
val exampleExpansionJarTask = exampleExpansionProviderProject.tasks.named<Jar>("jar")
|
||||
dependsOn(exampleExpansionJarTask)
|
||||
doFirst {
|
||||
val folderName = if (project.name.contains("velocity")) "miniplaceholders" else "MiniPlaceholders"
|
||||
val expansionsDirectory = runDirectory.get().file("plugins/$folderName/expansions").asFile.toPath()
|
||||
if (Files.exists(expansionsDirectory)) {
|
||||
Files.newDirectoryStream(expansionsDirectory).use {
|
||||
it.forEach { file ->
|
||||
file.deleteIfExists()
|
||||
}
|
||||
}
|
||||
} else {
|
||||
Files.createDirectories(expansionsDirectory)
|
||||
}
|
||||
val exampleExpansionFile = exampleExpansionJarTask.get().archiveFile.get().asFile.toPath()
|
||||
Files.copy(
|
||||
exampleExpansionFile,
|
||||
expansionsDirectory.resolve(exampleExpansionFile.fileName),
|
||||
StandardCopyOption.REPLACE_EXISTING
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,19 +0,0 @@
|
||||
plugins {
|
||||
id("miniplaceholders.base")
|
||||
id("com.gradleup.shadow")
|
||||
}
|
||||
|
||||
tasks {
|
||||
shadowJar {
|
||||
archiveBaseName.set("MiniPlaceholders-${project.capitalizeName}")
|
||||
archiveClassifier.set("")
|
||||
duplicatesStrategy = DuplicatesStrategy.EXCLUDE
|
||||
relocate("net.william278.desertwell", "io.github.miniplaceholders.libs.desertwell")
|
||||
relocate("org.bstats", "io.github.miniplaceholders.libs.bstats")
|
||||
|
||||
destinationDirectory.set(file("${project.rootDir}/jar"))
|
||||
}
|
||||
build {
|
||||
dependsOn(shadowJar)
|
||||
}
|
||||
}
|
||||
+37
-3
@@ -1,9 +1,43 @@
|
||||
import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
|
||||
|
||||
plugins {
|
||||
kotlin("jvm") version "2.4.21" apply false
|
||||
java
|
||||
id("com.github.johnrengelman.shadow") version "7.1.2"
|
||||
}
|
||||
|
||||
allprojects {
|
||||
apply(plugin = "java")
|
||||
group = "me.dreamerzero.miniplaceholders"
|
||||
version = "1.2.0"
|
||||
description = "MiniPlaceholders"
|
||||
|
||||
repositories {
|
||||
mavenCentral()
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
shadow(project(":miniplaceholders-connect"))
|
||||
shadow(project(":miniplaceholders-api"))
|
||||
shadow(project(":miniplaceholders-common"))
|
||||
shadow(project(":miniplaceholders-velocity"))
|
||||
shadow(project(":miniplaceholders-paper", "reobf"))
|
||||
}
|
||||
|
||||
subprojects {
|
||||
repositories {
|
||||
maven("https://papermc.io/repo/repository/maven-public/")
|
||||
maven("https://repo.maven.apache.org/maven2/")
|
||||
}
|
||||
}
|
||||
|
||||
tasks {
|
||||
delete {
|
||||
delete("jar")
|
||||
shadowJar {
|
||||
archiveFileName.set("MiniPlaceholders.jar")
|
||||
duplicatesStrategy = DuplicatesStrategy.EXCLUDE
|
||||
configurations = listOf(project.configurations.shadow.get())
|
||||
}
|
||||
build {
|
||||
dependsOn(shadowJar)
|
||||
}
|
||||
}
|
||||
+20
-21
@@ -1,28 +1,27 @@
|
||||
plugins {
|
||||
id("miniplaceholders.auto.module")
|
||||
alias(libs.plugins.idea.ext)
|
||||
alias(libs.plugins.blossom)
|
||||
id("net.kyori.blossom") version "1.3.1"
|
||||
}
|
||||
|
||||
repositories {
|
||||
maven("https://libraries.minecraft.net");
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation(projects.miniplaceholdersApi)
|
||||
implementation(libs.desertwell) {
|
||||
exclude("org.json")
|
||||
}
|
||||
implementation(libs.unnamedinject)
|
||||
compileOnly(libs.adventure.api)
|
||||
compileOnly(libs.adventure.minimessage)
|
||||
compileOnly(libs.jspecify)
|
||||
compileOnly(libs.brigadier)
|
||||
compileOnly(libs.bstats.core)
|
||||
implementation(project(":miniplaceholders-api"))
|
||||
compileOnly("net.kyori:adventure-api:4.11.0")
|
||||
compileOnly("net.kyori:adventure-text-minimessage:4.11.0")
|
||||
compileOnly("com.mojang:brigadier:1.0.18")
|
||||
}
|
||||
|
||||
sourceSets {
|
||||
main {
|
||||
blossom {
|
||||
javaSources {
|
||||
property("version", project.version.toString())
|
||||
}
|
||||
}
|
||||
}
|
||||
blossom {
|
||||
replaceToken("{version}", version)
|
||||
replaceTokenIn("src/main/java/me/dreamerzero/miniplaceholders/common/PluginConstants.java")
|
||||
}
|
||||
|
||||
tasks {
|
||||
compileJava {
|
||||
options.encoding = Charsets.UTF_8.name()
|
||||
|
||||
options.release.set(17)
|
||||
}
|
||||
}
|
||||
-7
@@ -1,7 +0,0 @@
|
||||
package io.github.miniplaceholders.common;
|
||||
|
||||
public final class PluginConstants {
|
||||
public static final String VERSION = "{{ version }}";
|
||||
|
||||
private PluginConstants() {}
|
||||
}
|
||||
@@ -1,138 +0,0 @@
|
||||
package io.github.miniplaceholders.common;
|
||||
|
||||
import io.github.miniplaceholders.api.Expansion;
|
||||
import io.github.miniplaceholders.api.MiniPlaceholders;
|
||||
import io.github.miniplaceholders.api.provider.ExpansionProvider;
|
||||
import io.github.miniplaceholders.api.provider.LoadRequirement;
|
||||
import io.github.miniplaceholders.api.provider.PlatformData;
|
||||
import io.github.miniplaceholders.api.types.Platform;
|
||||
import io.github.miniplaceholders.common.loader.ExpansionProviderLoader;
|
||||
import io.github.miniplaceholders.common.loader.FailedToLoadExpansion;
|
||||
import io.github.miniplaceholders.common.loader.ProviderLoadResult;
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.ComponentLike;
|
||||
import net.kyori.adventure.text.TextComponent;
|
||||
import net.kyori.adventure.text.format.NamedTextColor;
|
||||
import net.kyori.adventure.text.format.TextColor;
|
||||
import team.unnamed.inject.Injector;
|
||||
|
||||
import java.nio.file.Path;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
public interface PlaceholdersPlugin {
|
||||
default void registerPlatformCommand() {
|
||||
}
|
||||
|
||||
default void loadProvidedExpansions(final Path providersFolderDirectory) throws Exception {
|
||||
final List<Expansion> loadedExpansions = new ArrayList<>();
|
||||
final PlatformData platformData = new PlatformData(this.platformServerInstance(), this);
|
||||
final Injector injector = Injector.create(binder -> binder.bind(PlatformData.class).toInstance(platformData));
|
||||
for (Class<?> providerClass : ExpansionProviderLoader.loadProvidersFromFolder(providersFolderDirectory)) {
|
||||
final ExpansionProvider provider = (ExpansionProvider) injector.getInstance(providerClass);
|
||||
final ProviderLoadResult loadResult = tryLoad(provider, provider.loadRequirement());
|
||||
final ExpansionProvider loadedProvider = loadResult.provider();
|
||||
if (loadedProvider != null) {
|
||||
final Expansion loadedExpansion = loadedProvider.provideExpansion();
|
||||
loadedExpansions.add(loadedExpansion);
|
||||
loadedExpansion.register();
|
||||
continue;
|
||||
}
|
||||
final FailedToLoadExpansion failedToLoad = loadResult.failed();
|
||||
logError(Component.text("The expansion "
|
||||
+ providerClass +
|
||||
" could not be loaded because the requirement " + failedToLoad.requirement() + " could not be resolved",
|
||||
NamedTextColor.RED));
|
||||
}
|
||||
|
||||
if (loadedExpansions.isEmpty()) {
|
||||
logInfo(Component.text("Not found expansions", NamedTextColor.GRAY));
|
||||
return;
|
||||
}
|
||||
|
||||
final Component expansionsInfo = loadedExpansions.stream()
|
||||
.map(this::expansionInfo)
|
||||
// Adventure 5.x/4.x support
|
||||
.map(ComponentLike::asComponent)
|
||||
.collect(Component.toComponent(Component.text(", ", NamedTextColor.WHITE)));
|
||||
logInfo(Component.text("Loaded expansions: ", NamedTextColor.GREEN).append(expansionsInfo));
|
||||
}
|
||||
|
||||
private ComponentLike expansionInfo(Expansion expansion) {
|
||||
final TextComponent.Builder builder = Component.text();
|
||||
builder.append(Component.text(expansion.name(), NamedTextColor.AQUA));
|
||||
final String author = expansion.author();
|
||||
final String version = expansion.version();
|
||||
if (author == null && version == null) {
|
||||
return builder.build();
|
||||
}
|
||||
builder.append(Component.text('[', NamedTextColor.DARK_GRAY));
|
||||
if (author != null) {
|
||||
builder.append(
|
||||
Component.text("Author", NamedTextColor.GRAY),
|
||||
Component.text(':', NamedTextColor.WHITE),
|
||||
Component.space(),
|
||||
Component.text(author, TextColor.color(0xd4ff54))
|
||||
);
|
||||
}
|
||||
if (version != null) {
|
||||
if (author != null) {
|
||||
builder.append(Component.text(", ", NamedTextColor.WHITE));
|
||||
}
|
||||
builder.append(
|
||||
Component.text("Version", NamedTextColor.GRAY),
|
||||
Component.text(':', NamedTextColor.WHITE),
|
||||
Component.space(),
|
||||
Component.text(version, TextColor.color(0xd4ff54))
|
||||
);
|
||||
}
|
||||
builder.append(Component.text(']', NamedTextColor.DARK_GRAY));
|
||||
return builder;
|
||||
}
|
||||
|
||||
default ProviderLoadResult tryLoad(final ExpansionProvider provider, final LoadRequirement loadRequirement) {
|
||||
return switch (loadRequirement) {
|
||||
case LoadRequirement.PlatformRequirement platformRequirement -> {
|
||||
for (final Platform supportedPlatform : platformRequirement.platforms()) {
|
||||
if (supportedPlatform == MiniPlaceholders.platform()) {
|
||||
yield ProviderLoadResult.ofLoaded(provider);
|
||||
}
|
||||
}
|
||||
yield ProviderLoadResult.ofFailed(platformRequirement);
|
||||
}
|
||||
case LoadRequirement.AvailableComplementRequirement complementRequirement ->
|
||||
complementRequirement.shouldLoad(this::platformHasComplementLoaded)
|
||||
? ProviderLoadResult.ofLoaded(provider)
|
||||
: ProviderLoadResult.ofFailed(complementRequirement);
|
||||
case LoadRequirement.MultiLoadRequirement multiLoadRequirement -> {
|
||||
ProviderLoadResult loadResult;
|
||||
for (final LoadRequirement requirement : multiLoadRequirement.requirements()) {
|
||||
if ((loadResult = this.tryLoad(provider, requirement)).failed() != null) {
|
||||
yield loadResult;
|
||||
}
|
||||
}
|
||||
yield ProviderLoadResult.ofLoaded(provider);
|
||||
}
|
||||
case LoadRequirement.ClassRequirement classRequirement -> classRequirement.shouldLoad()
|
||||
? ProviderLoadResult.ofLoaded(provider) : ProviderLoadResult.ofFailed(classRequirement);
|
||||
case LoadRequirement.AnyOfRequirement anyOfRequirement -> {
|
||||
ProviderLoadResult loadResult;
|
||||
for (final LoadRequirement requirement : anyOfRequirement.requirements()) {
|
||||
if ((loadResult = this.tryLoad(provider, requirement)).provider() != null) {
|
||||
yield loadResult;
|
||||
}
|
||||
}
|
||||
yield ProviderLoadResult.ofFailed(anyOfRequirement);
|
||||
}
|
||||
case LoadRequirement.NoneLoadRequirement ignored -> ProviderLoadResult.ofLoaded(provider);
|
||||
};
|
||||
}
|
||||
|
||||
boolean platformHasComplementLoaded(String complementName);
|
||||
|
||||
void logError(Component component);
|
||||
|
||||
void logInfo(Component component);
|
||||
|
||||
Object platformServerInstance();
|
||||
}
|
||||
@@ -1,10 +0,0 @@
|
||||
package io.github.miniplaceholders.common.command;
|
||||
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import org.jspecify.annotations.NonNull;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
@FunctionalInterface
|
||||
public interface AudienceConverter {
|
||||
@Nullable Audience convert(@NonNull String string);
|
||||
}
|
||||
@@ -1,10 +0,0 @@
|
||||
package io.github.miniplaceholders.common.command;
|
||||
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import org.jspecify.annotations.NullMarked;
|
||||
|
||||
@NullMarked
|
||||
@FunctionalInterface
|
||||
public interface AudienceExtractor<S> {
|
||||
Audience extract(S source);
|
||||
}
|
||||
@@ -1,104 +0,0 @@
|
||||
package io.github.miniplaceholders.common.command;
|
||||
|
||||
import com.google.common.base.Suppliers;
|
||||
import io.github.miniplaceholders.api.MiniPlaceholders;
|
||||
import io.github.miniplaceholders.api.types.Platform;
|
||||
import io.github.miniplaceholders.common.PluginConstants;
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.event.ClickEvent;
|
||||
import net.kyori.adventure.text.format.TextColor;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.Placeholder;
|
||||
import net.william278.desertwell.about.AboutMenu;
|
||||
import net.william278.desertwell.util.Version;
|
||||
|
||||
import java.util.function.Supplier;
|
||||
|
||||
import static net.kyori.adventure.text.Component.newline;
|
||||
import static net.kyori.adventure.text.Component.text;
|
||||
import static net.kyori.adventure.text.minimessage.MiniMessage.miniMessage;
|
||||
|
||||
public final class CommandConstants {
|
||||
// Global
|
||||
public static final Component TITLE = miniMessage().deserialize("<b><gradient:#4d8bff:#a4ff96>MiniPlaceholders</b>");
|
||||
public static final Component HEADER = miniMessage().deserialize(
|
||||
"""
|
||||
<gradient:aqua:white:aqua><st><b> </st> \
|
||||
<title> \
|
||||
<st><b> </st>""", Placeholder.component("title", TITLE));
|
||||
public static final Component FOOTER = miniMessage().deserialize(
|
||||
"<gradient:aqua:white:aqua><st><b> ");
|
||||
|
||||
// -- /miniplaceholders --
|
||||
public static final Component INFO = AboutMenu.builder()
|
||||
.title(TITLE)
|
||||
.description(text("MiniMessage Component-based Placeholders API"))
|
||||
.credits("Author", AboutMenu.Credit.of("4drian3d").url("https://github.com/4drian3d"))
|
||||
.credits("Contributors",
|
||||
AboutMenu.Credit.of("Sliman4"),
|
||||
AboutMenu.Credit.of("Stampede2011"),
|
||||
AboutMenu.Credit.of("powercasgamer"),
|
||||
AboutMenu.Credit.of("fabianmakila"),
|
||||
AboutMenu.Credit.of("Willsr71")
|
||||
)
|
||||
.buttons(
|
||||
AboutMenu.Link.of("https://miniplaceholders.github.io/docs/category/user-guide").text("Documentation").icon("⛏"),
|
||||
AboutMenu.Link.of("https://discord.gg/5NMMzK5mAn").text("Discord").color(TextColor.color(0x7289da)).icon("⭐"),
|
||||
AboutMenu.Link.of("https://modrinth.com/plugin/miniplaceholders").text("Downloads").color(TextColor.color(0xff496e)).icon("↓")
|
||||
).version(Version.fromString(PluginConstants.VERSION))
|
||||
.build()
|
||||
.toComponent();
|
||||
|
||||
// -- /miniplaceholders help --
|
||||
public static final Supplier<Component> HELP = Suppliers.memoize(() -> {
|
||||
final Platform platform = MiniPlaceholders.platform();
|
||||
final String command = platform == Platform.VELOCITY ? "/vminiplaceholders" : "/miniplaceholders";
|
||||
return text()
|
||||
.append(newline(), HEADER)
|
||||
.append(newline(), miniMessage().deserialize(
|
||||
"<gradient:#9694ff:#5269ff>Commands:</gradient>")
|
||||
)
|
||||
.append(newline(), miniMessage().deserialize(
|
||||
"<gradient:aqua:#94d1ff>" + command + "</gradient> <aqua>help</aqua>")
|
||||
.clickEvent(ClickEvent.runCommand(command + " help"))
|
||||
)
|
||||
.append(newline(), miniMessage().deserialize(
|
||||
"""
|
||||
<gradient:aqua:#94d1ff>%s</gradient> \
|
||||
<aqua>parse</aqua> \
|
||||
<#8fadff><player | me | --null></#8fadff> \
|
||||
<#99ffb6><message></#99ffb6>""".formatted(command))
|
||||
.clickEvent(ClickEvent.suggestCommand(command + " parse "))
|
||||
)
|
||||
.append(newline(), miniMessage().deserialize(
|
||||
"""
|
||||
<gradient:aqua:#94d1ff>%s</gradient> \
|
||||
<aqua>parserel</aqua> \
|
||||
<#8fadff><player | me></#8fadff> \
|
||||
<#8fadff><relational player | me></#8fadff> \
|
||||
<#99ffb6><message></#99ffb6>""".formatted(command))
|
||||
.clickEvent(ClickEvent.suggestCommand(command + " parserel "))
|
||||
)
|
||||
.append(newline(), miniMessage().deserialize(
|
||||
"<gradient:aqua:#94d1ff>" + command + "</gradient> <aqua>expansions</aqua>")
|
||||
.clickEvent(ClickEvent.runCommand(command + " expansions"))
|
||||
)
|
||||
.append(newline(), FOOTER)
|
||||
.build();
|
||||
});
|
||||
|
||||
// -- /miniplaceholders expansions --
|
||||
public static final Component EXPANSIONS_TITLE = miniMessage().deserialize(
|
||||
"""
|
||||
<br><gradient:aqua:white:aqua><st><b> </st> \
|
||||
<title> Expansions <st><b> \
|
||||
</gradient><br>""", Placeholder.component("title", TITLE)
|
||||
);
|
||||
|
||||
public static final Supplier<Component> NON_INSTALLED_EXPANSIONS = Suppliers.memoize(() -> miniMessage().deserialize(
|
||||
"""
|
||||
<aqua>It seems that you don't have any <#a1ff4a>Expansion</#a1ff4a> installed yet,
|
||||
You can find the <#a1ff4a>Expansion</#a1ff4a> you want here <br>\
|
||||
<blue><click:open_url:"https://miniplaceholders.github.io/docs/user-guide/Placeholders">\
|
||||
<hover:show_text:"<gold>Search Expansions">[MiniPlaceholders Expansions]</blue>""")
|
||||
);
|
||||
}
|
||||
@@ -1,13 +0,0 @@
|
||||
package io.github.miniplaceholders.common.command;
|
||||
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.util.TriState;
|
||||
import org.jspecify.annotations.NullMarked;
|
||||
|
||||
@NullMarked
|
||||
@FunctionalInterface
|
||||
public interface PermissionTester {
|
||||
TriState permissionValue(Audience audience, String permission);
|
||||
|
||||
PermissionTester NO_OP = (audience, permission) -> TriState.NOT_SET;
|
||||
}
|
||||
-9
@@ -1,9 +0,0 @@
|
||||
package io.github.miniplaceholders.common.command;
|
||||
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import org.jspecify.annotations.NonNull;
|
||||
|
||||
@FunctionalInterface
|
||||
public interface PlaceholderCommandExecutor {
|
||||
void execute(@NonNull Audience audience);
|
||||
}
|
||||
-10
@@ -1,10 +0,0 @@
|
||||
package io.github.miniplaceholders.common.command;
|
||||
|
||||
import org.jspecify.annotations.NonNull;
|
||||
|
||||
import java.util.ArrayList;
|
||||
|
||||
@FunctionalInterface
|
||||
public interface PlayersNameProvider {
|
||||
@NonNull ArrayList<String> provide();
|
||||
}
|
||||
-97
@@ -1,97 +0,0 @@
|
||||
package io.github.miniplaceholders.common.command.brigadier;
|
||||
|
||||
import com.mojang.brigadier.Command;
|
||||
import com.mojang.brigadier.arguments.StringArgumentType;
|
||||
import com.mojang.brigadier.builder.LiteralArgumentBuilder;
|
||||
import com.mojang.brigadier.builder.RequiredArgumentBuilder;
|
||||
import com.mojang.brigadier.context.CommandContext;
|
||||
import com.mojang.brigadier.tree.LiteralCommandNode;
|
||||
import io.github.miniplaceholders.common.command.*;
|
||||
import io.github.miniplaceholders.common.command.node.*;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import org.jspecify.annotations.NullMarked;
|
||||
|
||||
@NullMarked
|
||||
public final class BrigadierCommandProvider {
|
||||
public static <A> LiteralCommandNode<A> provideCommand(
|
||||
final String command,
|
||||
final PlayersNameProvider playersSuggestions,
|
||||
final AudienceConverter audienceConverter,
|
||||
final AudienceExtractor<A> audienceExtractor,
|
||||
final PermissionTester permissionChecker
|
||||
) {
|
||||
// Inspired by MiniMotd command implementation (MIT licenced)
|
||||
class WrappingExecutor implements Command<A> {
|
||||
private final PlaceholderCommandExecutor executor;
|
||||
|
||||
private WrappingExecutor(final PlaceholderCommandExecutor executor) {
|
||||
this.executor = executor;
|
||||
}
|
||||
|
||||
@Override
|
||||
public int run(final CommandContext<A> commandContext) {
|
||||
executor.execute(audienceExtractor.extract(commandContext.getSource()));
|
||||
return Command.SINGLE_SUCCESS;
|
||||
}
|
||||
}
|
||||
|
||||
// Command Nodes
|
||||
final RootNode rootNode = new RootNode(permissionChecker);
|
||||
final ExpansionsNode expansionsNode = new ExpansionsNode(permissionChecker);
|
||||
final HelpNode helpNode = new HelpNode(permissionChecker);
|
||||
final ParseNode parseNode = new ParseNode(playersSuggestions, audienceConverter, permissionChecker);
|
||||
final ParseRelNode parseRelNode = new ParseRelNode(playersSuggestions, audienceConverter, permissionChecker);
|
||||
|
||||
return LiteralArgumentBuilder.<A>literal(command)
|
||||
.requires(src -> rootNode.hasPermission(audienceExtractor.extract(src)))
|
||||
.executes(new WrappingExecutor(rootNode::execute))
|
||||
.then(LiteralArgumentBuilder.<A>literal("expansions")
|
||||
.requires(src -> expansionsNode.hasPermission(audienceExtractor.extract(src)))
|
||||
.executes(new WrappingExecutor(expansionsNode::showExpansions))
|
||||
.build()
|
||||
)
|
||||
.then(LiteralArgumentBuilder.<A>literal("help")
|
||||
.executes(new WrappingExecutor(helpNode::execute))
|
||||
.requires(src -> helpNode.hasPermission(audienceExtractor.extract(src)))
|
||||
)
|
||||
.then(LiteralArgumentBuilder.<A>literal("parse")
|
||||
.requires(src -> parseNode.hasPermission(audienceExtractor.extract(src)))
|
||||
.then(RequiredArgumentBuilder.<A, String>argument("source", StringArgumentType.word())
|
||||
.suggests(new BrigadierSuggestionProvider<>(parseNode))
|
||||
.then(RequiredArgumentBuilder.<A, String>argument("message", StringArgumentType.greedyString())
|
||||
.executes(ctx -> {
|
||||
final Audience audience = audienceExtractor.extract(ctx.getSource());
|
||||
final String source = StringArgumentType.getString(ctx, "source");
|
||||
final String message = StringArgumentType.getString(ctx, "message");
|
||||
|
||||
parseNode.parseString(audience, source, message);
|
||||
|
||||
return Command.SINGLE_SUCCESS;
|
||||
})
|
||||
)
|
||||
)
|
||||
)
|
||||
.then(LiteralArgumentBuilder.<A>literal("parserel")
|
||||
.requires(src -> parseRelNode.hasPermission(audienceExtractor.extract(src)))
|
||||
.then(RequiredArgumentBuilder.<A, String>argument("source", StringArgumentType.word())
|
||||
.suggests(new BrigadierSuggestionProvider<>(parseRelNode))
|
||||
.then(RequiredArgumentBuilder.<A, String>argument("relational", StringArgumentType.word())
|
||||
.suggests(new BrigadierSuggestionProvider<>(parseRelNode))
|
||||
.then(RequiredArgumentBuilder.<A, String>argument("message", StringArgumentType.greedyString())
|
||||
.executes(ctx -> {
|
||||
final Audience audience = audienceExtractor.extract(ctx.getSource());
|
||||
final String source = StringArgumentType.getString(ctx, "source");
|
||||
final String relational = StringArgumentType.getString(ctx, "source");
|
||||
final String message = StringArgumentType.getString(ctx, "message");
|
||||
|
||||
parseRelNode.parseString(audience, source, relational, message);
|
||||
|
||||
return Command.SINGLE_SUCCESS;
|
||||
})
|
||||
)
|
||||
)
|
||||
)
|
||||
)
|
||||
.build();
|
||||
}
|
||||
}
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
package io.github.miniplaceholders.common.command.brigadier;
|
||||
|
||||
import com.mojang.brigadier.context.CommandContext;
|
||||
import com.mojang.brigadier.suggestion.SuggestionProvider;
|
||||
import com.mojang.brigadier.suggestion.Suggestions;
|
||||
import com.mojang.brigadier.suggestion.SuggestionsBuilder;
|
||||
import io.github.miniplaceholders.common.command.node.PlayerCompleterNode;
|
||||
import org.jspecify.annotations.NullMarked;
|
||||
|
||||
import java.util.concurrent.CompletableFuture;
|
||||
|
||||
@NullMarked
|
||||
public record BrigadierSuggestionProvider<A>(PlayerCompleterNode playerSuggestions) implements SuggestionProvider<A> {
|
||||
@Override
|
||||
public CompletableFuture<Suggestions> getSuggestions(final CommandContext<A> context, final SuggestionsBuilder builder) {
|
||||
this.playerSuggestions.providePlayerSuggestions().forEach(builder::suggest);
|
||||
return builder.buildFuture();
|
||||
}
|
||||
}
|
||||
-65
@@ -1,65 +0,0 @@
|
||||
package io.github.miniplaceholders.common.command.node;
|
||||
|
||||
import io.github.miniplaceholders.api.Expansion;
|
||||
import io.github.miniplaceholders.api.MiniPlaceholders;
|
||||
import io.github.miniplaceholders.common.command.PermissionTester;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.TextComponent;
|
||||
import net.kyori.adventure.text.format.NamedTextColor;
|
||||
import net.kyori.adventure.text.format.TextColor;
|
||||
import org.jspecify.annotations.NullMarked;
|
||||
|
||||
import java.util.Collection;
|
||||
|
||||
import static io.github.miniplaceholders.common.command.CommandConstants.*;
|
||||
|
||||
@NullMarked
|
||||
public record ExpansionsNode(PermissionTester permissionTester) implements Node {
|
||||
public void showExpansions(final Audience audience) {
|
||||
final TextComponent.Builder builder = Component.text()
|
||||
.append(EXPANSIONS_TITLE);
|
||||
final Collection<Expansion> expansions = MiniPlaceholders.expansionsAvailable();
|
||||
if (expansions.isEmpty()) {
|
||||
// In virtually all installations, there will always be some expansion installed,
|
||||
// so there is no need to cache this component in that case
|
||||
builder.append(NON_INSTALLED_EXPANSIONS.get());
|
||||
} else {
|
||||
builder.append(expansions.stream()
|
||||
.map(expansion -> {
|
||||
final TextComponent.Builder expansionMetaBuilder = Component.text();
|
||||
final String expansionName = expansion.name();
|
||||
final String expansionAuthor = expansion.author();
|
||||
final String expansionVersion = expansion.version();
|
||||
|
||||
expansionMetaBuilder.append(Component.text(expansionName, NamedTextColor.GRAY));
|
||||
if (expansionAuthor != null) {
|
||||
expansionMetaBuilder.appendNewline()
|
||||
.append(Component.text("Author: ", TextColor.color(0x29fbff)))
|
||||
.append(Component.text(expansionAuthor, NamedTextColor.GRAY));
|
||||
}
|
||||
if (expansionVersion != null) {
|
||||
expansionMetaBuilder.appendNewline()
|
||||
.append(Component.text("Version: ", TextColor.color(0xff7b61)))
|
||||
.append(Component.text(expansionVersion, NamedTextColor.GRAY));
|
||||
}
|
||||
return Component.text()
|
||||
.content(expansion.name())
|
||||
.hoverEvent(expansionMetaBuilder.build())
|
||||
.build();
|
||||
}).collect(Component.toComponent(Component.text(" | ", NamedTextColor.DARK_GRAY))));
|
||||
}
|
||||
builder.appendNewline().append(FOOTER);
|
||||
audience.sendMessage(builder.build());
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean hasPermission(Audience audience) {
|
||||
return permissionTester.permissionValue(audience, permission()).toBooleanOrElse(false);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String permission() {
|
||||
return "miniplaceholders.command.expansions";
|
||||
}
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
package io.github.miniplaceholders.common.command.node;
|
||||
|
||||
import io.github.miniplaceholders.common.command.PermissionTester;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import org.jspecify.annotations.NullMarked;
|
||||
|
||||
import static io.github.miniplaceholders.common.command.CommandConstants.HELP;
|
||||
|
||||
@NullMarked
|
||||
public record HelpNode(PermissionTester permissionChecker) implements Node {
|
||||
public void execute(final Audience audience) {
|
||||
audience.sendMessage(HELP.get());
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean hasPermission(Audience audience) {
|
||||
return permissionChecker.permissionValue(audience, permission()).toBooleanOrElse(false);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String permission() {
|
||||
return "miniplaceholders.command.help";
|
||||
}
|
||||
}
|
||||
@@ -1,11 +0,0 @@
|
||||
package io.github.miniplaceholders.common.command.node;
|
||||
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import org.jspecify.annotations.NullMarked;
|
||||
|
||||
@NullMarked
|
||||
public sealed interface Node permits ExpansionsNode, HelpNode, ParseNode, ParseRelNode, RootNode {
|
||||
boolean hasPermission(Audience audience);
|
||||
|
||||
String permission();
|
||||
}
|
||||
@@ -1,59 +0,0 @@
|
||||
package io.github.miniplaceholders.common.command.node;
|
||||
|
||||
import io.github.miniplaceholders.api.MiniPlaceholders;
|
||||
import io.github.miniplaceholders.common.command.AudienceConverter;
|
||||
import io.github.miniplaceholders.common.command.PermissionTester;
|
||||
import io.github.miniplaceholders.common.command.PlayersNameProvider;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.text.Component;
|
||||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
|
||||
import org.jspecify.annotations.NullMarked;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import static net.kyori.adventure.text.Component.text;
|
||||
import static net.kyori.adventure.text.format.NamedTextColor.RED;
|
||||
import static net.kyori.adventure.text.minimessage.MiniMessage.miniMessage;
|
||||
|
||||
@NullMarked
|
||||
public record ParseNode(
|
||||
PlayersNameProvider playersNameProvider,
|
||||
AudienceConverter audienceConverter,
|
||||
PermissionTester permissionChecker
|
||||
) implements Node, PlayerCompleterNode {
|
||||
public void parseString(final Audience sender, final String providedSource, final String providedString) {
|
||||
final Audience source = switch (providedSource) {
|
||||
case "me" -> sender;
|
||||
case "--null" -> Audience.empty();
|
||||
default -> audienceConverter.convert(providedSource);
|
||||
};
|
||||
if (source == null) {
|
||||
sender.sendMessage(text("You must specify a valid player", RED));
|
||||
return;
|
||||
}
|
||||
|
||||
final TagResolver resolver = source == Audience.empty()
|
||||
? MiniPlaceholders.globalPlaceholders()
|
||||
: MiniPlaceholders.audienceGlobalPlaceholders();
|
||||
|
||||
final Component parsed = miniMessage().deserialize(providedString, source, resolver);
|
||||
sender.sendMessage(parsed);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean hasPermission(final Audience audience) {
|
||||
return permissionChecker.permissionValue(audience, permission()).toBooleanOrElse(false);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String permission() {
|
||||
return "miniplaceholders.command.parse";
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<String> providePlayerSuggestions() {
|
||||
final List<String> suggestions = PlayerCompleterNode.super.providePlayerSuggestions();
|
||||
suggestions.add("--null");
|
||||
return suggestions;
|
||||
}
|
||||
}
|
||||
@@ -1,59 +0,0 @@
|
||||
package io.github.miniplaceholders.common.command.node;
|
||||
|
||||
import io.github.miniplaceholders.api.MiniPlaceholders;
|
||||
import io.github.miniplaceholders.api.types.RelationalAudience;
|
||||
import io.github.miniplaceholders.common.command.AudienceConverter;
|
||||
import io.github.miniplaceholders.common.command.PermissionTester;
|
||||
import io.github.miniplaceholders.common.command.PlayersNameProvider;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.text.Component;
|
||||
import org.jspecify.annotations.NullMarked;
|
||||
|
||||
import static net.kyori.adventure.text.Component.text;
|
||||
import static net.kyori.adventure.text.format.NamedTextColor.RED;
|
||||
import static net.kyori.adventure.text.minimessage.MiniMessage.miniMessage;
|
||||
|
||||
@NullMarked
|
||||
public record ParseRelNode(
|
||||
PlayersNameProvider playersNameProvider,
|
||||
AudienceConverter audienceConverter,
|
||||
PermissionTester permissionChecker
|
||||
) implements Node, PlayerCompleterNode {
|
||||
|
||||
public void parseString(final Audience sender, final String source, final String relational, final String toParse) {
|
||||
final Audience senderTarget = "me".equals(source)
|
||||
? sender
|
||||
: audienceConverter.convert(source);
|
||||
if (senderTarget == null) {
|
||||
sender.sendMessage(text("You must specify a valid player", RED));
|
||||
return;
|
||||
}
|
||||
|
||||
final Audience relationalTarget = "me".equals(relational)
|
||||
? sender
|
||||
: audienceConverter.convert(relational);
|
||||
if (relationalTarget == null) {
|
||||
sender.sendMessage(text("You must specify a valid relational player", RED));
|
||||
return;
|
||||
}
|
||||
|
||||
final RelationalAudience<Audience> relationalAudience = RelationalAudience.from(senderTarget, relationalTarget);
|
||||
|
||||
final Component parsed = miniMessage().deserialize(
|
||||
toParse,
|
||||
relationalAudience,
|
||||
MiniPlaceholders.relationalGlobalPlaceholders()
|
||||
);
|
||||
sender.sendMessage(parsed);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean hasPermission(Audience audience) {
|
||||
return permissionChecker.permissionValue(audience, permission()).toBooleanOrElse(false);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String permission() {
|
||||
return "miniplaceholders.command.parse";
|
||||
}
|
||||
}
|
||||
-15
@@ -1,15 +0,0 @@
|
||||
package io.github.miniplaceholders.common.command.node;
|
||||
|
||||
import io.github.miniplaceholders.common.command.PlayersNameProvider;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
public interface PlayerCompleterNode {
|
||||
default List<String> providePlayerSuggestions() {
|
||||
final List<String> suggestions = playersNameProvider().provide();
|
||||
suggestions.add("me");
|
||||
return suggestions;
|
||||
}
|
||||
|
||||
PlayersNameProvider playersNameProvider();
|
||||
}
|
||||
@@ -1,26 +0,0 @@
|
||||
package io.github.miniplaceholders.common.command.node;
|
||||
|
||||
import io.github.miniplaceholders.common.command.PermissionTester;
|
||||
import net.kyori.adventure.audience.Audience;
|
||||
import net.kyori.adventure.util.TriState;
|
||||
import org.jspecify.annotations.NullMarked;
|
||||
|
||||
import static io.github.miniplaceholders.common.command.CommandConstants.INFO;
|
||||
|
||||
@NullMarked
|
||||
public record RootNode(PermissionTester permissionChecker) implements Node {
|
||||
|
||||
public void execute(Audience audience) {
|
||||
audience.sendMessage(INFO);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean hasPermission(Audience audience) {
|
||||
return permissionChecker.permissionValue(audience, permission()) != TriState.FALSE;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String permission() {
|
||||
return "miniplaceholders.command";
|
||||
}
|
||||
}
|
||||
-95
@@ -1,95 +0,0 @@
|
||||
package io.github.miniplaceholders.common.loader;
|
||||
|
||||
import io.github.miniplaceholders.api.provider.ExpansionProvider;
|
||||
import org.jspecify.annotations.NullMarked;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.InputStreamReader;
|
||||
import java.io.Reader;
|
||||
import java.net.URL;
|
||||
import java.net.URLClassLoader;
|
||||
import java.nio.file.DirectoryStream;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Path;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.Objects;
|
||||
import java.util.Properties;
|
||||
import java.util.jar.JarEntry;
|
||||
import java.util.jar.JarInputStream;
|
||||
|
||||
@NullMarked
|
||||
public final class ExpansionProviderLoader {
|
||||
|
||||
public static List<Class<?>> loadProvidersFromFolder(final Path folferPath) throws Exception {
|
||||
if (Files.notExists(folferPath)) {
|
||||
try {
|
||||
Files.createDirectories(folferPath);
|
||||
} catch (IOException e) {
|
||||
throw new RuntimeException("Unable to create expansions directory", e);
|
||||
}
|
||||
return List.of();
|
||||
}
|
||||
try (final DirectoryStream<Path> stream = Files.newDirectoryStream(folferPath,
|
||||
filtered -> Files.isRegularFile(filtered) && filtered.toString().endsWith(".jar"))) {
|
||||
final List<Class<?>> providerList = new ArrayList<>();
|
||||
for (final Path possibleProviderPath : stream) {
|
||||
loadPossibleProviderFromPath(possibleProviderPath, providerList);
|
||||
}
|
||||
return providerList;
|
||||
}
|
||||
}
|
||||
|
||||
private static void loadPossibleProviderFromPath(
|
||||
final Path filePath,
|
||||
final List<Class<?>> providers
|
||||
) throws Exception {
|
||||
String mainClassName = null;
|
||||
try (final JarInputStream jarStream = new JarInputStream(Files.newInputStream(filePath))) {
|
||||
JarEntry actualEntry;
|
||||
while ((actualEntry = jarStream.getNextJarEntry()) != null) {
|
||||
final String entryName = actualEntry.getName();
|
||||
if (!Objects.equals(entryName, "expansion-provider.properties")) {
|
||||
continue;
|
||||
}
|
||||
try (final Reader reader = new InputStreamReader(jarStream)) {
|
||||
Properties properties = new Properties();
|
||||
properties.load(reader);
|
||||
mainClassName = properties.getProperty("provider-class");
|
||||
break;
|
||||
} catch (IOException e) {
|
||||
throw new IOException("Unable to read expansion_provider.properties from " + filePath + "file", e);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (mainClassName == null) {
|
||||
return;
|
||||
}
|
||||
|
||||
loadFoundProvider(mainClassName, providers, filePath);
|
||||
}
|
||||
|
||||
private static void loadFoundProvider(
|
||||
final String providerClass,
|
||||
final List<Class<?>> providers,
|
||||
final Path providerPath
|
||||
) throws Exception {
|
||||
//noinspection resource
|
||||
final URLClassLoader classLoader = new URLClassLoader(
|
||||
"MiniPlaceholders ClassLoader",
|
||||
new URL[] { providerPath.toUri().toURL() },
|
||||
ExpansionProviderLoader.class.getClassLoader()
|
||||
);
|
||||
Class<?> mainClass;
|
||||
try {
|
||||
mainClass = classLoader.loadClass(providerClass);
|
||||
} catch (ClassNotFoundException e) {
|
||||
throw new ClassNotFoundException("Unable to load main class from file " + providerPath, e);
|
||||
}
|
||||
if (!ExpansionProvider.class.isAssignableFrom(mainClass) || mainClass.isInterface()) {
|
||||
return;
|
||||
}
|
||||
providers.add(mainClass);
|
||||
}
|
||||
}
|
||||
-7
@@ -1,7 +0,0 @@
|
||||
package io.github.miniplaceholders.common.loader;
|
||||
|
||||
import io.github.miniplaceholders.api.provider.LoadRequirement;
|
||||
import org.jspecify.annotations.NonNull;
|
||||
|
||||
public record FailedToLoadExpansion(@NonNull LoadRequirement requirement) {
|
||||
}
|
||||
@@ -1,14 +0,0 @@
|
||||
package io.github.miniplaceholders.common.loader;
|
||||
|
||||
import io.github.miniplaceholders.api.provider.ExpansionProvider;
|
||||
import io.github.miniplaceholders.api.provider.LoadRequirement;
|
||||
|
||||
public record ProviderLoadResult(ExpansionProvider provider, FailedToLoadExpansion failed) {
|
||||
public static ProviderLoadResult ofLoaded(ExpansionProvider provider) {
|
||||
return new ProviderLoadResult(provider, null);
|
||||
}
|
||||
|
||||
public static ProviderLoadResult ofFailed(LoadRequirement requirement) {
|
||||
return new ProviderLoadResult(null, new FailedToLoadExpansion(requirement));
|
||||
}
|
||||
}
|
||||
Loaded 100 of 151 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user