Compare commits

...
210 Commits
Author SHA1 Message Date
Adrian Gonzales 3a2ba24f3d release: Version 3.2.0 2026-03-27 13:03:56 -05:00
Adrian Gonzales 38592abaa3 misc: Updated to Velocity 3.5.0 and reorganized versions catalog 2026-03-26 15:48:36 -05:00
Adrian 2628ef6279 Merge pull request #359 from MiniPlaceholders/renovate/dokka
chore(deps): update dependency org.jetbrains.dokka to v2.2.0
2026-03-26 10:46:43 -05:00
renovate[bot] 6bf9c23e09 chore(deps): update dependency org.jetbrains.dokka to v2.2.0 2026-03-26 14:08:26 +00:00
Adrian e99ae1a6fd Merge pull request #325 from MiniPlaceholders/renovate/fabric.api
fix(deps): update dependency net.fabricmc.fabric-api:fabric-api to v0.144.3+26.1
2026-03-25 14:47:50 -05:00
renovate[bot] e552a0e90d fix(deps): update dependency net.fabricmc.fabric-api:fabric-api to v0.144.3+26.1 2026-03-25 19:39:58 +00:00
Adrian 7146b1d348 Merge pull request #354 from Leon-JavaScript/feat/minestom
Add support for Minestom platform
2026-03-25 14:39:31 -05:00
Adrian Gonzales e91b6796cb Merge remote-tracking branch 'minestom/feat/minestom' into feat/minestom 2026-03-25 14:33:12 -05:00
Adrian Gonzales 6e528c5d6b test(minestom): Improved Minestom testing instance 2026-03-25 14:32:48 -05:00
Adrian 9c029ab519 Merge branch 'main' into feat/minestom 2026-03-25 12:49:43 -05:00
Adrian Gonzales 114b38ba5b feat(minestom): Use static methods to initialize MiniPlaceholders Minestom 2026-03-25 12:47:22 -05:00
Adrian Gonzales 288a5ae5e0 fix(ci): Fixed jenkins javadoc generation 2026-03-25 12:05:02 -05:00
Adrian ae720f3dce Merge pull request #356 from MiniPlaceholders/renovate/fabric.loader
fix(deps): update dependency net.fabricmc:fabric-loader to v0.18.5
2026-03-25 11:50:18 -05:00
Leon Marschke 57df8615dc Merge branch 'main' into feat/minestom 2026-03-25 17:47:06 +01:00
renovate[bot] b00e37131d fix(deps): update dependency net.fabricmc:fabric-loader to v0.18.5 2026-03-25 16:36:46 +00:00
Adrian 34c2330af8 Added support for Fabric 26.1 (#357)
* feat: Initial 26.1 progress

* feat: Working Fabric 26.1 support

* misc: Removed unused references
2026-03-25 11:35:59 -05:00
Leon-JavaScript 6bc35b3e16 docs(README): update compatibility section for Minestom 1.21.11 2026-03-25 17:29:15 +01:00
Leon-JavaScript 1eea547f7a feat(example): add audience and relational placeholders 2026-03-25 17:28:29 +01:00
Leon-JavaScript 68f8ce504c feat(build): add Maven publishing configuration for Minestom 2026-03-24 20:04:43 +01:00
Leon-JavaScript 007b10e0c3 fix(commands): message argument to support multiple strings 2026-03-24 17:08:50 +01:00
Leon-JavaScript 4c556c4925 fix(commands): suggestion filtering for command arguments 2026-03-24 17:08:02 +01:00
Leon-JavaScript 39b20b1827 fix(tests): disable failOnNoDiscoveredTests in test task 2026-03-24 15:56:45 +01:00
Leon-JavaScript 8206b99d00 fix(review): Apply suggestions from PR review
- Update version to documentation to 3.2.0
- Change method platformHasComplementLoaded to always return `false` because Minestom doesn't support plugins
2026-03-24 15:56:26 +01:00
Adrian 35b3c31341 Merge pull request #353 from SmiteMCde/fix/help-command-expansions-click
Fix expansions command click in help message
2026-03-23 17:17:42 -05:00
Leon-JavaScript 075cca14b0 feat(minestom): add support for Minestom platform and related commands 2026-03-23 20:10:48 +01:00
Leon Marschke 4fb84b3ddc Update command click events in CommandConstants.java
Signed-off-by: Leon Marschke <70959426+Leon-JavaScript@users.noreply.github.com>
2026-03-23 19:53:41 +01:00
Adrian f9df6ddd1a Merge pull request #352 from MiniPlaceholders/renovate/nick-invision-retry-4.x
chore(deps): update nick-invision/retry action to v4
2026-03-20 00:20:08 -05:00
renovate[bot] 6557d0c99d chore(deps): update nick-invision/retry action to v4 2026-03-20 04:35:30 +00:00
Adrian fbaada216a Merge pull request #351 from MiniPlaceholders/renovate/gradle-9.x
chore(deps): update gradle to v9.4.1
2026-03-19 09:56:58 -05:00
renovate[bot] c97f2c2dc5 chore(deps): update gradle to v9.4.1 2026-03-19 09:29:20 +00:00
Adrian 97f6561724 Merge pull request #350 from MiniPlaceholders/renovate/kotlin-monorepo
fix(deps): update kotlin monorepo to v2.3.20
2026-03-18 22:39:24 -05:00
renovate[bot] 98835a90b2 fix(deps): update kotlin monorepo to v2.3.20 2026-03-16 09:54:10 +00:00
Adrian a03ee83d54 Merge pull request #349 from MiniPlaceholders/renovate/shadow
fix(deps): update shadow to v9.4.0
2026-03-15 10:06:18 -05:00
renovate[bot] 7433aa0394 fix(deps): update shadow to v9.4.0 2026-03-15 05:06:35 +00:00
Adrian Gonzales c392a112e5 feat: Added support to Fabric 1.21.11+ 2026-03-14 12:10:06 -05:00
Adrian 4d8673aeeb Merge pull request #348 from MiniPlaceholders/renovate/gradle-9.x
chore(deps): update gradle to v9.4.0
2026-03-06 23:22:18 -05:00
renovate[bot] b60ea1a9a9 chore(deps): update gradle to v9.4.0 2026-03-04 12:45:06 +00:00
Adrian ecfee088cd Merge pull request #340 from MiniPlaceholders/renovate/quiet-fabric-loom-1.x
chore(deps): update plugin quiet-fabric-loom to v1.15.332
2026-02-27 22:48:13 -05:00
Adrian 39b0e12c49 Merge pull request #341 from MiniPlaceholders/renovate/kotlin-monorepo
fix(deps): update kotlin monorepo to v2.3.10
2026-02-27 22:47:41 -05:00
Adrian 8c4158eee8 Merge pull request #346 from MiniPlaceholders/renovate/major-github-artifact-actions
chore(deps): update actions/upload-artifact action to v7
2026-02-27 22:47:24 -05:00
Adrian f425afc2bb Merge pull request #345 from MiniPlaceholders/renovate/bstats
fix(deps): update bstats to v3.2.1
2026-02-27 22:47:14 -05:00
Adrian 373fc7f757 Merge pull request #347 from MiniPlaceholders/renovate/shadow
fix(deps): update shadow to v9.3.2
2026-02-27 22:44:11 -05:00
renovate[bot] 05619a4939 fix(deps): update shadow to v9.3.2 2026-02-27 13:01:49 +00:00
renovate[bot] 968c930060 fix(deps): update kotlin monorepo to v2.3.10 2026-02-27 13:01:44 +00:00
renovate[bot] b1bc70bba7 chore(deps): update plugin quiet-fabric-loom to v1.15.332 2026-02-27 13:01:37 +00:00
renovate[bot] 5c412ba2ff chore(deps): update actions/upload-artifact action to v7 2026-02-26 22:33:39 +00:00
renovate[bot] 366f9b43a6 fix(deps): update bstats to v3.2.1 2026-02-24 23:08:20 +00:00
Adrian e699e48ae3 Merge pull request #344 from MiniPlaceholders/renovate/bstats
fix(deps): update bstats to v3.2.0
2026-02-24 01:16:46 -05:00
renovate[bot] bc018cfb2d fix(deps): update bstats to v3.2.0 2026-02-23 22:14:10 +00:00
Adrian 1c299e6595 Merge pull request #343 from MiniPlaceholders/renovate/org.jetbrains.gradle.plugin.idea-ext-1.x
chore(deps): update plugin idea-ext to v1.4.1
2026-02-18 12:42:59 -05:00
renovate[bot] 510ca51111 chore(deps): update plugin idea-ext to v1.4.1 2026-02-18 11:14:25 +00:00
Adrian a466dbd378 Merge pull request #342 from MiniPlaceholders/renovate/junit-framework-monorepo
fix(deps): update dependency org.junit:junit-bom to v6.0.3
2026-02-15 14:05:56 -05:00
renovate[bot] 029b528669 fix(deps): update dependency org.junit:junit-bom to v6.0.3 2026-02-15 17:36:53 +00:00
Adrian a3f371105e Merge pull request #339 from MiniPlaceholders/renovate/gradle-9.x
chore(deps): update gradle to v9.3.1
2026-01-31 01:21:04 -05:00
renovate[bot] f6fae9b54b chore(deps): update gradle to v9.3.1 2026-01-29 17:13:18 +00:00
Adrian 5828f8d1ff Merge pull request #335 from MiniPlaceholders/renovate/quiet-fabric-loom-1.x
chore(deps): update plugin quiet-fabric-loom to v1.15.331
2026-01-26 23:42:25 -05:00
renovate[bot] 88a27c40e6 chore(deps): update plugin quiet-fabric-loom to v1.15.331 2026-01-26 16:04:42 +00:00
Adrian 34a33a0f44 Merge pull request #338 from MiniPlaceholders/renovate/org.jetbrains.gradle.plugin.idea-ext-1.x
chore(deps): update plugin idea-ext to v1.4
2026-01-26 10:54:42 -05:00
renovate[bot] c27bf3a907 chore(deps): update plugin idea-ext to v1.4 2026-01-26 11:11:38 +00:00
Adrian 7b332154bc Merge pull request #337 from MiniPlaceholders/renovate/velocity
fix(deps): update dependency com.velocitypowered:velocity-api to v3.4.0
2026-01-25 22:27:30 -05:00
renovate[bot] 132c1f8fac fix(deps): update dependency com.velocitypowered:velocity-api to v3.4.0 2026-01-25 22:13:00 +00:00
Adrian 009873b5e9 Merge pull request #334 from MiniPlaceholders/renovate/com.vanniktech.maven.publish-0.x
chore(deps): update plugin com.vanniktech.maven.publish to v0.36.0
2026-01-19 15:03:58 -05:00
renovate[bot] 0d27f10575 chore(deps): update plugin com.vanniktech.maven.publish to v0.36.0 2026-01-18 18:41:45 +00:00
Adrian 519d131a16 Merge pull request #333 from MiniPlaceholders/renovate/gradle-9.x
chore(deps): update gradle to v9.3.0
2026-01-16 12:32:50 -05:00
renovate[bot] 5e9da46f8c chore(deps): update gradle to v9.3.0 2026-01-16 15:16:21 +00:00
Adrian 207a4e8db3 Merge pull request #329 from MiniPlaceholders/renovate/fabric.loader
fix(deps): update dependency net.fabricmc:fabric-loader to v0.18.4
2026-01-12 13:03:49 -05:00
Adrian ad17ce84bd Merge pull request #332 from MiniPlaceholders/renovate/quiet-fabric-loom-1.x
chore(deps): update plugin quiet-fabric-loom to v1.14.330
2026-01-12 13:03:38 -05:00
renovate[bot] 4aa9524cfd chore(deps): update plugin quiet-fabric-loom to v1.14.330 2026-01-11 04:51:20 +00:00
Adrian 097203729f Merge pull request #331 from MiniPlaceholders/renovate/junit-framework-monorepo
fix(deps): update dependency org.junit:junit-bom to v6.0.2
2026-01-06 23:45:37 -05:00
renovate[bot] 13cc13539d fix(deps): update dependency org.junit:junit-bom to v6.0.2 2026-01-06 17:55:42 +00:00
Adrian 53bc542588 Merge pull request #330 from MiniPlaceholders/renovate/shadow
fix(deps): update shadow to v9.3.1
2026-01-06 12:54:59 -05:00
renovate[bot] 5f20e679c6 fix(deps): update dependency com.gradleup.shadow:shadow-gradle-plugin to v9.3.1 2026-01-06 05:58:51 +00:00
renovate[bot] 7fe01d729c fix(deps): update dependency net.fabricmc:fabric-loader to v0.18.4 2025-12-24 20:43:32 +00:00
Adrian 42976b576a Merge pull request #327 from MiniPlaceholders/renovate/kotlin-monorepo
fix(deps): update kotlin monorepo to v2.3.0
2025-12-17 13:08:15 -05:00
Adrian f50d95aa07 Merge pull request #328 from MiniPlaceholders/renovate/adventure
fix(deps): update adventure to v4.26.1
2025-12-17 13:07:15 -05:00
Adrian 961f8d33ff Merge pull request #322 from MiniPlaceholders/renovate/fabric.loader
fix(deps): update dependency net.fabricmc:fabric-loader to v0.18.3
2025-12-17 12:49:43 -05:00
Adrian 2c1b24c586 Merge pull request #326 from MiniPlaceholders/renovate/major-github-artifact-actions
chore(deps): update actions/upload-artifact action to v6
2025-12-17 12:45:05 -05:00
renovate[bot] c29774fb78 fix(deps): update kotlin monorepo to v2.3.0 2025-12-17 17:43:48 +00:00
renovate[bot] 6524d599f2 fix(deps): update adventure to v4.26.1 2025-12-17 17:43:43 +00:00
Adrian dab817a653 Merge pull request #324 from MiniPlaceholders/renovate/adventuremodded
fix(deps): update dependency net.kyori:adventure-platform-fabric to v6.8.0
2025-12-17 12:42:27 -05:00
Adrian 06c908a2cc Merge pull request #323 from MiniPlaceholders/renovate/me.lucko-fabric-permissions-api-0.x
fix(deps): update dependency me.lucko:fabric-permissions-api to v0.6.1
2025-12-17 12:40:45 -05:00
renovate[bot] 21a67c2d85 fix(deps): update dependency net.fabricmc:fabric-loader to v0.18.3 2025-12-17 02:39:20 +00:00
renovate[bot] e7974dfbca chore(deps): update actions/upload-artifact action to v6 2025-12-12 21:09:23 +00:00
Adrian bd80c435c0 Merge pull request #300 from MiniPlaceholders/renovate/fabric.api
fix(deps): update dependency net.fabricmc.fabric-api:fabric-api to v0.139.4+1.21.11
2025-12-11 12:50:49 -05:00
renovate[bot] c85e2cd1ac fix(deps): update dependency net.fabricmc.fabric-api:fabric-api to v0.139.4+1.21.11 2025-12-10 12:42:08 +00:00
renovate[bot] dbf167412d fix(deps): update dependency net.kyori:adventure-platform-fabric to v6.8.0 2025-12-10 06:01:14 +00:00
renovate[bot] d17883962e fix(deps): update dependency me.lucko:fabric-permissions-api to v0.6.1 2025-12-10 03:46:56 +00:00
Adrian f41e1e672a Merge pull request #321 from MiniPlaceholders/renovate/shadow
fix(deps): update shadow to v9.3.0
2025-12-05 12:50:47 -05:00
renovate[bot] 31355fa183 fix(deps): update shadow to v9.3.0 2025-12-05 17:13:13 +00:00
Adrian 30ce81cf67 Merge pull request #320 from MiniPlaceholders/renovate/quiet-fabric-loom-1.x
chore(deps): update plugin quiet-fabric-loom to v1.13.328
2025-11-23 10:13:15 -05:00
renovate[bot] aeaa712d8c chore(deps): update plugin quiet-fabric-loom to v1.13.328 2025-11-21 22:53:02 +00:00
Adrian 061d483f20 Merge pull request #318 from MiniPlaceholders/renovate/fabric.loader
fix(deps): update dependency net.fabricmc:fabric-loader to v0.18.1
2025-11-21 11:00:09 -05:00
Adrian 408c225b5d Merge pull request #319 from MiniPlaceholders/renovate/actions-checkout-6.x
chore(deps): update actions/checkout action to v6
2025-11-21 10:19:11 -05:00
renovate[bot] 562e42c220 chore(deps): update actions/checkout action to v6 2025-11-20 17:36:49 +00:00
renovate[bot] 2e36e96d7f fix(deps): update dependency net.fabricmc:fabric-loader to v0.18.1 2025-11-20 17:36:45 +00:00
Adrian 98ee83e714 Merge pull request #317 from MiniPlaceholders/renovate/gradle-9.x
chore(deps): update gradle to v9.2.1
2025-11-19 14:58:16 -05:00
renovate[bot] 34d33b2b81 chore(deps): update gradle to v9.2.1 2025-11-18 02:29:17 +00:00
Adrian 882723c155 Merge pull request #316 from MiniPlaceholders/renovate/com.vanniktech.maven.publish-0.x
chore(deps): update plugin com.vanniktech.maven.publish to v0.35.0
2025-11-12 01:10:55 -05:00
renovate[bot] 80fa0c07d0 chore(deps): update plugin com.vanniktech.maven.publish to v0.35.0 2025-11-11 20:42:36 +00:00
Adrian fbc48c4c5c Merge pull request #315 from MiniPlaceholders/renovate/fabric.loader
fix(deps): update dependency net.fabricmc:fabric-loader to v0.18.0
2025-11-09 11:41:03 -05:00
renovate[bot] 095228cce8 fix(deps): update dependency net.fabricmc:fabric-loader to v0.18.0 2025-11-09 01:15:12 +00:00
Adrian 775d62233c Merge pull request #313 from MiniPlaceholders/renovate/quiet-fabric-loom-1.x
chore(deps): update plugin quiet-fabric-loom to v1.12.326
2025-11-07 22:23:52 -05:00
renovate[bot] 67cb025d0f chore(deps): update plugin quiet-fabric-loom to v1.12.326 2025-11-08 02:33:57 +00:00
Adrian e296bf8a90 Merge pull request #314 from MiniPlaceholders/renovate/junit-framework-monorepo
fix(deps): update dependency org.junit:junit-bom to v6.0.1
2025-11-07 16:56:00 -05:00
Adrian 9f9950de70 Merge pull request #312 from MiniPlaceholders/renovate/gradle-9.x
chore(deps): update gradle to v9.2.0
2025-11-07 16:55:07 -05:00
Adrian ffe0e0f5d8 Merge pull request #311 from MiniPlaceholders/renovate/major-github-artifact-actions
chore(deps): update actions/upload-artifact action to v5
2025-11-07 16:52:21 -05:00
renovate[bot] b5063d9a02 fix(deps): update dependency org.junit:junit-bom to v6.0.1 2025-10-31 19:49:04 +00:00
renovate[bot] e0e0b4fe3e chore(deps): update gradle to v9.2.0 2025-10-29 23:17:04 +00:00
renovate[bot] eeb756d1fc chore(deps): update actions/upload-artifact action to v5 2025-10-24 23:02:20 +00:00
Adrian 4c173ae8ee Merge pull request #310 from MiniPlaceholders/renovate/kotlin-monorepo
fix(deps): update kotlin monorepo to v2.2.21
2025-10-23 11:19:23 -05:00
renovate[bot] 0dc6d85cdb fix(deps): update kotlin monorepo to v2.2.21 2025-10-23 14:28:44 +00:00
Adrian 944fef34f6 Merge pull request #308 from MiniPlaceholders/renovate/dokka
fix(deps): update dokka to v2.1.0
2025-10-15 10:49:53 -05:00
Adrian 0c7e327323 Merge pull request #309 from MiniPlaceholders/renovate/org.jetbrains.dokka-2.x
chore(deps): update plugin org.jetbrains.dokka to v2.1.0
2025-10-15 10:49:44 -05:00
renovate[bot] 17aef8b922 chore(deps): update plugin org.jetbrains.dokka to v2.1.0 2025-10-15 10:32:07 +00:00
renovate[bot] 94baa536a4 chore(deps): update dependency org.jetbrains.dokka to v2.1.0 2025-10-15 10:32:03 +00:00
Adrian f7a59f1279 Merge pull request #307 from MiniPlaceholders/renovate/blossom
chore(deps): update dependency net.kyori.blossom to v2.2.0
2025-10-12 00:54:33 -05:00
renovate[bot] 9b314854a2 chore(deps): update dependency net.kyori.blossom to v2.2.0 2025-10-12 05:03:43 +00:00
Adrian 1579b264a8 Merge pull request #306 from MiniPlaceholders/renovate/runtask
fix(deps): update runtask to v3.0.2
2025-10-11 13:24:16 -05:00
renovate[bot] 17cc2016fe fix(deps): update runtask to v3.0.2 2025-10-11 05:11:30 +00:00
Adrian Gonzales ea3a80a0bd feat: Added support to Fabric 1.21.9+ 2025-10-10 03:27:30 -05:00
Adrian 2dee5f0d66 Merge pull request #303 from MiniPlaceholders/renovate/adventure
fix(deps): update adventure to v4.25.0
2025-10-10 03:25:10 -05:00
renovate[bot] 4efed28253 fix(deps): update adventure to v4.25.0 2025-10-10 08:09:11 +00:00
Adrian 45b1a0da5d Merge pull request #298 from MiniPlaceholders/renovate/me.lucko-fabric-permissions-api-0.x
fix(deps): update dependency me.lucko:fabric-permissions-api to v0.5.0
2025-10-10 03:08:08 -05:00
Adrian c4002e0a3d Merge pull request #304 from MiniPlaceholders/renovate/adventuremodded
fix(deps): update dependency net.kyori:adventure-platform-fabric to v6.7.0
2025-10-10 03:07:47 -05:00
Adrian Gonzales eb4fba66eb misc: 3.1.1-SNAPSHOT 2025-10-10 03:05:27 -05:00
Adrian Gonzales 6a084a6d2e release: Version 3.1.0 2025-10-10 02:35:19 -05:00
Adrian Gonzales d02ac7abc1 [ci skip] Created CHANGELOG.md 2025-10-09 18:59:53 -05:00
Adrian 9bcefee265 Merge pull request #305 from MiniPlaceholders/renovate/fabric.loader
fix(deps): update dependency net.fabricmc:fabric-loader to v0.17.3
2025-10-09 18:42:13 -05:00
Adrian 47dd5a96e9 Merge pull request #302 from MiniPlaceholders/renovate/runtask
fix(deps): update runtask to v3.0.1
2025-10-09 18:42:02 -05:00
renovate[bot] 36dbeed21d fix(deps): update dependency net.fabricmc:fabric-loader to v0.17.3 2025-10-09 17:07:35 +00:00
renovate[bot] 9dd473092a fix(deps): update dependency net.kyori:adventure-platform-fabric to v6.7.0 2025-10-09 12:44:50 +00:00
renovate[bot] 9139d2260f fix(deps): update dependency me.lucko:fabric-permissions-api to v0.5.0 2025-10-09 12:44:42 +00:00
renovate[bot] e19527a9d6 fix(deps): update runtask to v3.0.1 2025-10-09 12:44:34 +00:00
Adrian Gonzales f648dd8f83 misc: Added bstats metrics 2025-10-09 00:31:50 -05:00
Adrian Gonzales 079b88d99f docs: Use the NullMarked annotation throughout the module instead of in each file 2025-10-08 23:12:44 -05:00
Adrian Gonzales 0f48a4baed docs: Replaced some uses of JetBrains annotations with jspecify
This fixes a duplication of annotations in the generation of javadocs
2025-10-08 12:43:32 -05:00
Adrian Gonzales 2608e81fae fix: Enable expansion providers after the server initializes.
This allows all other plugins to initialize, and if any depend on MiniPlaceholders, they can register their expansions. After the server initializes, expansion providers will be enabled, and if anyone wants to remove an expansion or iterate between them, they can simply use a higher priority for late server initialization events
2025-10-08 12:04:18 -05:00
Adrian Gonzales afb4a4451d build: Added testing support for fabric and sponge modules 2025-10-05 01:27:09 -05:00
Adrian Gonzales df53a0a2fa build: Simplify example expansion loading 2025-10-05 00:52:33 -05:00
Adrian Gonzales 591df2e6df feat(build): Added the capability to test the example expansion using runtask 2025-10-05 00:33:35 -05:00
Adrian Gonzales bf995b7103 feat: Allow the use of injected constructors when creating an ExpansionProvider 2025-10-05 00:32:22 -05:00
Adrian Gonzales 02f30ead85 misc: Added deprecation message 2025-10-04 23:11:09 -05:00
Adrian f522456b76 Merge pull request #301 from MiniPlaceholders/feat/newparsesubcommands
Implement new parserel subcommand
2025-10-03 01:16:17 -05:00
Adrian Gonzales de7d14d55d fix: Fixed command formatting 2025-10-02 23:19:00 -05:00
Adrian Gonzales c0230efb3b misc: Some component creation cleanup 2025-10-02 22:41:53 -05:00
Adrian Gonzales 3cdb7de9f2 feat: Add --null argument to parse node 2025-10-02 19:41:57 -05:00
Adrian Gonzales 9c954834cb misc: Simplify brigadier suggestions 2025-10-02 16:18:18 -05:00
Adrian Gonzales 55e493c013 feat: Implement parseglobal subcommand 2025-10-02 16:08:52 -05:00
Adrian Gonzales ea725a8121 feat: Implement parserel subcommand 2025-10-02 15:48:22 -05:00
Adrian Gonzales d138d00b26 misc: Renamed #presentClass to #requiredClass 2025-10-02 14:54:17 -05:00
Adrian d63397fc96 Merge pull request #299 from MiniPlaceholders/fix/sponge/commands
Implement Sponge commands
2025-10-02 14:50:02 -05:00
Adrian Gonzales fe6ea73bb0 misc: Some cleanup 2025-10-02 13:20:58 -05:00
Adrian Gonzales be368a7690 feat: Allow operator execution 2025-10-02 12:38:52 -05:00
Adrian Gonzales b31b91e9b8 fix: Fixed Fabric permissions check 2025-10-02 12:28:31 -05:00
Adrian Gonzales 7d8243711a fix(sponge): Fixed console command execution 2025-10-01 21:11:09 -05:00
Adrian Gonzales 7633ada70e feat: Initial Sponge commands implementation 2025-10-01 19:58:08 -05:00
Adrian 6d8267684a Merge pull request #296 from MiniPlaceholders/renovate/major-junit-framework-monorepo
fix(deps): update dependency org.junit:junit-bom to v6
2025-09-30 13:05:44 -05:00
renovate[bot] a1d5bb7eed fix(deps): update dependency org.junit:junit-bom to v6 2025-09-30 09:53:12 +00:00
Adrian 161a254613 Merge pull request #294 from MiniPlaceholders/renovate/fabric.api
fix(deps): update dependency net.fabricmc.fabric-api:fabric-api to v0.133.14+1.21.9
2025-09-29 18:16:30 -05:00
renovate[bot] d957269743 fix(deps): update dependency net.fabricmc.fabric-api:fabric-api to v0.133.14+1.21.9 2025-09-29 21:10:18 +00:00
Adrian 7ac5aec82d Merge pull request #292 from MiniPlaceholders/renovate/shadow
fix(deps): update shadow to v9.2.2
2025-09-27 23:28:40 -05:00
Adrian 9713704352 Merge pull request #293 from MiniPlaceholders/renovate/fabric.api
fix(deps): update dependency net.fabricmc.fabric-api:fabric-api to v0.133.13+1.21.9
2025-09-27 23:28:19 -05:00
renovate[bot] 4240fb556c fix(deps): update dependency net.fabricmc.fabric-api:fabric-api to v0.133.13+1.21.9 2025-09-26 21:53:12 +00:00
renovate[bot] 5a9ac8af87 fix(deps): update shadow to v9.2.2 2025-09-26 10:00:24 +00:00
Adrian 97b68a3616 Merge pull request #290 from MiniPlaceholders/renovate/fabric.api
fix(deps): update dependency net.fabricmc.fabric-api:fabric-api to v0.133.12+1.21.9
2025-09-25 16:08:43 -05:00
renovate[bot] afde5e6e2c fix(deps): update dependency net.fabricmc.fabric-api:fabric-api to v0.133.12+1.21.9 2025-09-25 20:50:11 +00:00
Adrian 8a37136565 Merge pull request #291 from MiniPlaceholders/renovate/shadow
fix(deps): update shadow to v9.2.1
2025-09-24 11:46:24 -05:00
renovate[bot] 8d5378ff3e fix(deps): update shadow to v9.2.1 2025-09-24 10:30:48 +00:00
Adrian Gonzales 31ee16e412 feat: Added LoadRequirement#presentClass and LoadRequirement#anyOf 2025-09-23 12:48:57 -05:00
Adrian Gonzales 8aec3e592f fix: Added nullability checks to RelationalAudience 2025-09-23 12:05:45 -05:00
Adrian 88c26dee51 Merge pull request #281 from MiniPlaceholders/renovate/fabric.api
fix(deps): update dependency net.fabricmc.fabric-api:fabric-api to v0.133.10+1.21.9
2025-09-22 12:49:22 -05:00
renovate[bot] 659be54911 fix(deps): update dependency net.fabricmc.fabric-api:fabric-api to v0.133.10+1.21.9 2025-09-20 21:08:10 +00:00
Adrian 3808d660d9 Merge pull request #289 from MiniPlaceholders/renovate/gradle-9.x
chore(deps): update gradle to v9.1.0
2025-09-18 12:09:59 -05:00
renovate[bot] c6ecdacdbc chore(deps): update gradle to v9.1.0 2025-09-18 13:53:15 +00:00
Adrian 25a9b435ff Update outdated README 2025-09-15 22:03:51 -05:00
Adrian d95b9fddac Merge pull request #287 from MiniPlaceholders/renovate/kotlin-monorepo
fix(deps): update kotlin monorepo to v2.2.20
2025-09-10 23:52:26 -05:00
renovate[bot] 78d1b83513 fix(deps): update kotlin monorepo to v2.2.20 2025-09-10 09:43:54 +00:00
Adrian 56a1e9afca Merge pull request #288 from MiniPlaceholders/renovate/major-runtask
chore(deps): update runtask to v3 (major)
2025-09-09 12:27:22 -05:00
Adrian ba1438457b Merge pull request #286 from MiniPlaceholders/renovate/quiet-fabric-loom-1.x
chore(deps): update plugin quiet-fabric-loom to v1.11.325
2025-09-09 01:09:53 -05:00
renovate[bot] ad36fab536 chore(deps): update runtask to v3 2025-09-08 01:08:10 +00:00
renovate[bot] f2ff2c0bf3 chore(deps): update plugin quiet-fabric-loom to v1.11.325 2025-09-07 23:34:41 +00:00
renovate[bot] 6e28786b09 fix(deps): update shadow to v9.1.0 (#283)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-30 16:14:56 -05:00
Adrian Gonzales f67690f413 fix: Fixed multiple loading expansions 2025-08-30 11:18:49 -05:00
Adrian cc8646cb4e [ci skip] Fix link formatting in README.md 2025-08-24 16:45:14 -05:00
Adrian 4db80d7583 [ci skip] Updated README
Updated compatibility section and command examples in README.md.
2025-08-24 16:44:20 -05:00
renovate[bot] 67d480c969 chore(deps): update plugin idea-ext to v1.3 (#280)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-23 00:39:51 -05:00
Adrian Gonzales 8593beccbd release: Version 3.0.1 2025-08-22 20:01:43 -05:00
Adrian Gonzales 5d92446a6b Merge remote-tracking branch 'origin/main' 2025-08-22 19:15:54 -05:00
Adrian Gonzales edc82b2bc9 fix: Fixed Fabric Initialization 2025-08-22 19:15:24 -05:00
Adrian Gonzales 70bd4fee88 fix: Fixed maven publication 2025-08-22 19:02:06 -05:00
renovate[bot] dbf440b4b3 chore(deps): update actions/setup-java action to v5 (#278)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-21 14:59:27 -05:00
Adrian Gonzales 0ffc47a889 feat: Added some kotlin-ext API 2025-08-20 14:05:35 -05:00
FabianAdrian 3f3c3f9ec5 fix:remove sponge plugin from the root project (#277) 2025-08-20 12:19:24 -05:00
renovate[bot] bfc05edb26 fix(deps): update kotlin monorepo to v2.2.20-rc (#259)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-19 22:58:26 -05:00
renovate[bot] c7c1576fe1 fix(deps): update dependency org.junit:junit-bom to v5.13.4 (#274)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-19 21:09:05 -05:00
renovate[bot] e84a484fcd chore(deps): update actions/checkout action to v5 (#275)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-19 21:08:56 -05:00
renovate[bot] 6743e35109 chore(deps): update plugin org.gradle.toolchains.foojay-resolver-convention to v1 (#276)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-19 21:08:47 -05:00
renovate[bot] fe2bdd8165 fix(deps): update dependency me.lucko:fabric-permissions-api to v0.4.1 (#273)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-19 20:59:49 -05:00
renovate[bot] 8ce7846aa1 fix(deps): update cloud.minecraft to v2.0.0-snapshot (#271)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-19 20:59:28 -05:00
renovate[bot] 7c415f19ac chore(deps): update plugin quiet-fabric-loom to v1.11.324 (#261)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-19 20:59:15 -05:00
renovate[bot] 771cf33788 chore(deps): update plugin idea-ext to v1.2 (#272)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-19 20:32:25 -05:00
renovate[bot] 4edf4180cd fix(deps): update dependency net.kyori:adventure-platform-fabric to v6.6.0 (#264)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-19 20:32:03 -05:00
renovate[bot] bb6f2d67c3 fix(deps): update dependency net.fabricmc.fabric-api:fabric-api to v0.132.1+1.21.9 (#247)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-19 20:31:26 -05:00
renovate[bot] 0c51aeb82d fix(deps): update dependency org.incendo:cloud-fabric to v2.0.0-snapshot (#244)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-19 20:31:12 -05:00
renovate[bot] c2771a42e2 fix(deps): update shadow to v9.0.2 (#243)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-19 20:30:27 -05:00
Adrian 431270e8b5 MiniPlaceholders V3: Placeholders Refactor (#256)
* refactor: Changed the way of processing and creating placeholders, now based on the MiniMessage parsing context

* fix: Fixed version string

* feat: Added ability to obtain placeholders directly

resolves #174

* feat: Implement GlobalPlaceholder instance

* feat: Reimplemented support for ForwardingAudiences

* test: Fixed resolver equality tests

* test: Implemented some test based on recent API changes

* docs: Added some documentation

* docs: Added some placeholders documentation

* test: Added complex tag tests

* fix: Fixed javadoc generation

* feat: Implement Expansion Providers

resolves #9

* fix: Apply changes from #265

* feat: Removed default expansions

This allows more control by server admins to be able to control which Expansions are used on a server. The default expansions will be included in external expansions.

* docs: A few advances in documentation

This commit took over three months to publish...

* feat: Added error messages to expansion providers loading process

* build: Updated to Gradle 9.0.0

* docs: Finished javadocs documentation

build: Use gradle configuration cache

* fix: Fixed dynamic expansions loading

* feat: Added basic dependency injection for ExpansionProvider

This allows certain expansions to obtain data from the platform on which they are running where there is no static context for their platform or plugin/mod instances.
This feature will be used by a minority of expansions, but it eliminates the need to create expansions that load as plugins, as in MiniPlaceholders v1 and v2.

* fix: Expansions initialization on Paper
2025-08-19 17:21:42 -05:00
FabianAdrian a87226d33b update cloud snapshot repository (#268) 2025-06-29 12:00:37 -05:00
Willsr71 98d27e40a1 Fix expansion author and version being built backwards (#265) 2025-04-12 20:50:13 -05:00
renovate[bot] 59de135b95 chore(deps): update dependency gradle to v8.13 (#249)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-02-25 13:00:37 -05:00
Adrian f939fac882 build: Back to snapshots 2025-02-23 15:08:26 -05:00
117 changed files with 4091 additions and 2128 deletions

No files matched your search

+7 -7
View File
@@ -8,24 +8,24 @@ jobs:
steps:
- name: Checkout Repository
uses: actions/checkout@v4
uses: actions/checkout@v6
- name: Set up JDK 21
uses: actions/setup-java@v4
- name: Set up JDK 25
uses: actions/setup-java@v5
with:
java-version: 21
distribution: 'temurin'
java-version: 25
distribution: 'zulu'
cache: 'gradle'
- name: Build with Gradle
uses: nick-invision/retry@v3
uses: nick-invision/retry@v4
with:
timeout_minutes: 10
max_attempts: 2
command: gradle build
- name: Upload Artifacts
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: MiniPlaceholders
path: jar/MiniPlaceholders-*.jar
+1 -1
View File
@@ -1,3 +1,3 @@
FROM gitpod/workspace-full
RUN bash -c ". /home/gitpod/.sdkman/bin/sdkman-init.sh && sdk install java 17.0.1.fx-zulu"
RUN bash -c ". /home/gitpod/.sdkman/bin/sdkman-init.sh && sdk install java 21.0.6.fx-zulu"
+42
View File
@@ -0,0 +1,42 @@
<!--
MiniPlaceholders Changelog
-->
## 3.2.0 (unreleased)
### Features
- Added support to Fabric 26.1+
- Added Minestom support
### Fixes
### API Additions
## 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)
+19 -35
View File
@@ -1,45 +1,31 @@
# MiniPlaceholders
[![WorkFlow](https://img.shields.io/github/actions/workflow/status/MiniPlaceholders/MiniPlaceholders/build.yml?style=flat-square)](https://github.com/MiniPlaceholders/MiniPlaceholders/actions)
[![GitHub WorkFlow](https://img.shields.io/github/actions/workflow/status/MiniPlaceholders/MiniPlaceholders/build.yml?logo=GitHub&style=flat-square)](https://github.com/MiniPlaceholders/MiniPlaceholders/actions)
[![Jenkins Build](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.codemc.io%2Fjob%2FMiniPlaceholders%2Fjob%2FMiniPlaceholders%2F&style=flat-square&logo=jenkins)](https://ci.codemc.io/job/MiniPlaceholders/job/MiniPlaceholders/)
![Latest Version](https://img.shields.io/github/v/release/MiniPlaceholders/MiniPlaceholders?style=flat-square)
[![Discord](https://img.shields.io/discord/899740810956910683?color=7289da&logo=Discord&label=Discord&style=flat-square)](https://discord.gg/5NMMzK5mAn)
![Modrinth Downloads](https://img.shields.io/modrinth/dt/HQyibRsN?logo=Modrinth&style=flat-square)
![GitHub Downloads](https://img.shields.io/github/downloads/MiniPlaceholders/MiniPlaceholders/total?logo=GitHub&style=flat-square)
MiniMessage Component-based Placeholders for Paper, Fabric, Sponge, Folia and Velocity platforms
MiniMessage Component-based Placeholders API for Minecraft Platforms.
## Compatibility
- Paper 1.19.3, 1.19.4+
- Folia 1.19.4+
- Velocity 3.1.2+
- Fabric 1.19.4+
- Sponge API 8+
## Commands
### Velocity
- `/vminiplaceholders parse me "[message with placeholders]"`
- `/vminiplaceholders parse player [some-player] "[message with placeholders]"`
### Paper | Folia | Fabric
- `/miniplaceholders <parse|help> player [some-player] "[message with placeholders]`
- `/miniplaceholders parse player [some-player] "[message with placeholders]"`
#### Example:
- `/miniplaceholders parse me "<player_xp>"`
- `/vminiplaceholders parse player 4drian3d "<player_name>"`
- 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://github.com/MiniPlaceholders/MiniPlaceholders/wiki/User-Getting-Started)
Check our user usage wiki [here](https://miniplaceholders.github.io/docs/user-guide/User-Getting-Started)
## API
Check the available [Javadocs](https://javadoc.io/doc/io.github.miniplaceholders/miniplaceholders-api)
Or check the [Developer Wiki](https://github.com/MiniPlaceholders/MiniPlaceholders/wiki/Developer-Getting-Started)
Or check the [Developer Wiki](https://miniplaceholders.github.io/docs/developer-guide/Developer-Getting-Started)
### Java
```java
@@ -47,9 +33,7 @@ Or check the [Developer Wiki](https://github.com/MiniPlaceholders/MiniPlaceholde
class Main {
public static void registerExpansion() {
final Expansion expansion = Expansion.builder("my-expansion")
.filter(Player.class)
.audiencePlaceholder("name", (audience, ctx, queue) -> {
final Player player = (player) audience;
.audiencePlaceholder(Player.class, "name", (player, ctx, queue) -> {
return Tag.selfClosingInserting(player.getName());
})
.globalPlaceholder("tps", (ctx, queue) ->
@@ -59,8 +43,8 @@ class Main {
expansion.register();
Player player;
final TagResolver playerResolver = MiniPlaceholders.getAudiencePlaceholders(player);
player.sendMessage(miniMessage().deserialize("Player Name: <my-expansion_name>", playerResolver));
final TagResolver playerResolver = MiniPlaceholders.audiencePlaceholders();
player.sendMessage(miniMessage().deserialize("Player Name: <my-expansion_name>", player, playerResolver));
}
}
@@ -70,10 +54,10 @@ class Main {
```kotlin
fun register() {
val expansion = expansion("my-expansion") {
audiencePlaceholder("name") { aud, _, _ ->
audience<Player>("name") { player, _, _ ->
aud.getName().asClosingTag()
}
globalPlaceholder("tps") { _, _ ->
global("tps") { _, _ ->
Component.text(Bukkit.getTps()[0]).asInsertingTag()
}
}
@@ -81,7 +65,7 @@ fun register() {
expansion.register()
val player: Player
val playerResolver = MiniPlaceholders.getAudiencePlaceholders(player)
player.sendMessage(miniMessage().deserialize("Player Name: <my-expansion_name>", playerResolver))
val playerResolver = MiniPlaceholders.audiencePlaceholders()
player.sendMessage(miniMessage().deserialize("Player Name: <my-expansion_name>", player, playerResolver))
}
```
+58 -8
View File
@@ -1,7 +1,10 @@
import java.time.LocalDate
plugins {
id("miniplaceholders.base")
alias(libs.plugins.jmh)
id("miniplaceholders.publish")
`java-library`
id("com.vanniktech.maven.publish")
}
dependencies {
@@ -9,6 +12,7 @@ dependencies {
compileOnly(libs.adventure.minimessage)
compileOnly(libs.adventure.serializer.legacy)
compileOnly(projects.miniplaceholdersConnect)
compileOnlyApi(libs.unnamedinject)
testImplementation(platform(libs.junit.bom))
testImplementation("org.junit.jupiter:junit-jupiter")
@@ -17,6 +21,8 @@ dependencies {
testImplementation(libs.adventure.minimessage)
testImplementation(libs.adventure.serializer.plain)
testImplementation(libs.adventure.serializer.legacy)
compileOnly(libs.jspecify)
}
jmh {
@@ -25,19 +31,23 @@ jmh {
fork.set(2)
}
java {
withJavadocJar()
}
tasks {
processResources {
filteringCharset = Charsets.UTF_8.name()
}
javadoc {
options.encoding = Charsets.UTF_8.name()
(options as StandardJavadocDocletOptions).links(
val o = options as StandardJavadocDocletOptions
o.encoding = Charsets.UTF_8.name()
o.links(
"https://jd.advntr.dev/api/${libs.versions.adventure.get()}/",
"https://jd.advntr.dev/text-minimessage/${libs.versions.adventure.get()}/"
"https://jd.advntr.dev/text-minimessage/${libs.versions.adventure.get()}/",
"https://javadoc.io/doc/org.jspecify/jspecify/latest/"
)
o.tags(
"apiNote:a:API Note:",
"implSpec:a:Implementation Requirements:",
"implNote:a:Implementation Note:",
"sinceMinecraft:a:Since Minecraft:"
)
}
compileTestJava {
@@ -50,3 +60,43 @@ tasks {
}
}
}
mavenPublishing {
publishToMavenCentral()
signAllPublications()
coordinates(project.group as String, "miniplaceholders-api", project.version as String)
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")
}
}
}
@@ -12,39 +12,46 @@ 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")
@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()))
BenchAudience.class,
"name",
(aud, queue, ctx) -> Tag.selfClosingInserting(Component.text(aud.getName()))
)
.audiencePlaceholder(
"uuid", (aud, queue, ctx) -> Tag.selfClosingInserting(Component.text(((BenchAudience)aud).getUUID().toString()))
BenchAudience.class,
"uuid",
(aud, queue, ctx) -> Tag.selfClosingInserting(Component.text(aud.getUUID().toString()))
)
.audiencePlaceholder(
"tablistfooter", (aud, queue, ctx) ->Tag.selfClosingInserting(Component.text("footer"))
"tablistfooter",
(aud, queue, ctx) -> Tag.selfClosingInserting(Component.text("footer"))
);
Expansion expansionBuilded = expansion.build();
expansionBuilded.audiencePlaceholders(player);
final TagResolver resolvers = MiniPlaceholders.getAudiencePlaceholders(player);
Expansion expansionBuilded = expansion.build();
expansionBuilded.register();
final TagResolver resolvers = MiniPlaceholders.audiencePlaceholders();
MiniMessage.miniMessage().deserialize("Player Name: <benchmark-name>", resolvers);
}
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")))
@Benchmark
public void singleBench() {
Expansion.builder("single")
.globalPlaceholder("servername",
(queue, ctx) -> Tag.selfClosingInserting(Component.text("Peruviankkit")))
.build()
.register();
TagResolver resolvers = MiniPlaceholders.getGlobalPlaceholders();
TagResolver resolvers = MiniPlaceholders.globalPlaceholders();
MiniMessage.miniMessage().deserialize("Server name: <single-servername>", resolvers);
}
MiniMessage.miniMessage().deserialize("Server name: <single_servername>", resolvers);
}
}
@@ -1,20 +1,22 @@
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 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 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.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;
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
@@ -23,14 +25,14 @@ import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
* <pre>
* Player player = event.getPlayer();
* Expansion.Builder builder = Expansion.builder("player")
* .audiencePlaceholder("name", (p, queue, ctx) -> Tag.selfClosingInserting(Component.text(((Player)p).getUsername()))
* .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#getAudiencePlaceholders(Audience)} e.g.
* TagResolver resolver = expansion.audiencePlaceholder(player);
* player.sendMessage(MiniMessage.miniMessage().deserialize("Hello {@literal <luckperms_prefix> <player_name>}", resolver));
* // 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
@@ -38,13 +40,15 @@ import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
public sealed interface Expansion permits ExpansionImpl {
/**
* Get the expansion name
*
* @return the expansion name
* @since 1.0.0
*/
@NotNull String name();
String name();
/**
* Get the author of this expansion
*
* @return the author or null
* @since 2.3.0
*/
@@ -52,18 +56,18 @@ public sealed interface Expansion permits ExpansionImpl {
/**
* Get the version of this expansion
*
* @return the version or null
* @since 2.3.0
*/
@Nullable String version();
/**
* Get the {@link TagResolver} of the desired {@link Audience}
* @param audience the audience
* Get the {@link TagResolver} of an {@link Audience}
* @return A TagResolver with variable placeholders of an Audience
* @since 1.0.0
*/
@NotNull TagResolver audiencePlaceholders(final @NotNull Audience audience);
TagResolver audiencePlaceholders();
/**
* Get the relational placeholders based on two audiences
@@ -71,19 +75,17 @@ public sealed interface Expansion permits ExpansionImpl {
* <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
*/
@NotNull TagResolver relationalPlaceholders(final @NotNull Audience audience, final @NotNull Audience otherAudience);
TagResolver relationalPlaceholders();
/**
* Get global placeholders
* @return the global placeholders
* @since 1.0.0
*/
@NotNull TagResolver globalPlaceholders();
TagResolver globalPlaceholders();
/**
* Register this expansion
@@ -108,16 +110,129 @@ public sealed interface Expansion permits ExpansionImpl {
*/
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 @NotNull Expansion.Builder builder(final @NotNull String name){
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>
@@ -126,7 +241,7 @@ public sealed interface Expansion permits ExpansionImpl {
* 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())));
* .resolver("name", (audience, queue, ctx) -> Tag.selfClosingInserting(Component.text(((Player)audience).getUsername())));
* Expansion expansion = builder.build();
* </pre>
*
@@ -134,13 +249,36 @@ public sealed interface Expansion permits ExpansionImpl {
*
* <pre>
* Player player = event.getPlayer();
* TagResolver resolver = expansion.audiencePlaceholder(player);
* 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
*
@@ -152,9 +290,36 @@ public sealed interface Expansion permits ExpansionImpl {
* @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
* @since 3.0.0
*/
@NotNull Builder audiencePlaceholder(final @NotNull String key, final @NotNull AudiencePlaceholder audiencePlaceholder);
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
@@ -169,11 +334,16 @@ public sealed interface Expansion permits ExpansionImpl {
* 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
* @param relationalResolver the relational placeholder
* @return the {@link Builder} itself
* @since 1.0.0
* @since 3.0.0
*/
@NotNull Builder relationalPlaceholder(final @NotNull String key, final @NotNull RelationalPlaceholder relationalPlaceholder);
default Builder relationalPlaceholder(
final String key,
final RelationalTagResolver<Audience> relationalResolver
) {
return this.relationalPlaceholder(null, key, relationalResolver);
}
/**
* Adds a global placeholder
@@ -181,11 +351,11 @@ public sealed interface Expansion permits ExpansionImpl {
* <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
* @param resolver the function
* @return the {@link Builder} itself
* @since 1.0.0
* @since 3.0.0
*/
@NotNull Builder globalPlaceholder(final @NotNull String key, final @NotNull BiFunction<@NotNull ArgumentQueue, @NotNull Context, @Nullable Tag> function);
Builder globalPlaceholder(final String key, final GlobalTagResolver resolver);
/**
* Adds a global placeholder
@@ -196,41 +366,9 @@ public sealed interface Expansion permits ExpansionImpl {
* @return the {@link Builder} itself
* @since 1.1.0
*/
@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(aud -> aud instanceof Player player{@literal &&} isInProtectedServer(player)
* .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<@NotNull Audience> predicate);
default Builder globalPlaceholder(final String key, final Tag tag) {
return this.globalPlaceholder(key, (queue, context) -> tag);
}
/**
* Sets the author of this expansion
@@ -240,7 +378,7 @@ public sealed interface Expansion permits ExpansionImpl {
* @since 2.3.0
*/
@Contract("_ -> this")
@NotNull Builder author(final @Nullable String author);
Builder author(final @Nullable String author);
/**
* Sets the version of this expansion
@@ -250,6 +388,6 @@ public sealed interface Expansion permits ExpansionImpl {
* @since 2.3.0
*/
@Contract("_ -> this")
@NotNull Builder version(final @Nullable String version);
Builder version(final @Nullable String version);
}
}
@@ -1,262 +1,275 @@
package io.github.miniplaceholders.api;
import io.github.miniplaceholders.api.placeholder.AudiencePlaceholder;
import io.github.miniplaceholders.api.placeholder.RelationalPlaceholder;
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.audience.ForwardingAudience;
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;
import org.intellij.lang.annotations.Subst;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
import org.jspecify.annotations.NullUnmarked;
import java.util.*;
import java.util.function.BiFunction;
import java.util.function.Predicate;
import static io.github.miniplaceholders.api.utils.Conditions.nonNullOrEmptyString;
import static java.util.Objects.requireNonNull;
final class ExpansionImpl implements Expansion {
private static final Tags.Single[] EMPTY_SINGLE_AUDIENCE = new Tags.Single[0];
private static final Tags.Relational[] EMPTY_RELATIONAL_AUDIENCE = new Tags.Relational[0];
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;
private final String author;
private final String version;
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];
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,
@Nullable final String author,
@Nullable final String version
) {
this.name = expansionName;
this.audiencePlaceholders = audiencePlaceholders != null
? audiencePlaceholders.toArray(EMPTY_SINGLE_AUDIENCE)
: EMPTY_SINGLE_AUDIENCE;
this.relationalPlaceholders = relationalPlaceholders != null
? relationalPlaceholders.toArray(EMPTY_RELATIONAL_AUDIENCE)
: EMPTY_RELATIONAL_AUDIENCE;
this.globalPlaceholders = globalPlaceholders;
this.filterClass = filterClass;
this.predicateFilter = predicateFilter;
this.author = author;
this.version = version;
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 @NotNull String name(){
return this.name;
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 @Nullable String author(){
return this.author;
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 @Nullable String version(){
return this.version;
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 @NotNull TagResolver audiencePlaceholders(@NotNull Audience audience) {
if (audiencePlaceholders.length == 0) return TagResolver.empty();
requireNonNull(audience, "the audience cannot be null");
if ((audience = expansionFilter(audience)) == null) return TagResolver.empty();
final TagResolver.Builder placeholders = TagResolver.builder();
for (final Tags.Single pl : this.audiencePlaceholders) {
placeholders.resolver(pl.of(audience));
}
return placeholders.build();
}
@SuppressWarnings("OverrideOnly")
private Audience expansionFilter(final Audience audience) {
if (audience == null || filterClass == null && predicateFilter == null) {
return audience;
}
final boolean eligible = filterClass != null && filterClass.isInstance(audience)
|| predicateFilter != null && predicateFilter.test(audience);
if (eligible) {
return audience;
}
if (audience instanceof final ForwardingAudience.Single forward) {
return expansionFilter(forward.audience());
}
return null;
public @NonNull Builder author(final @Nullable String author) {
this.author = author;
return this;
}
@Override
public @NotNull TagResolver relationalPlaceholders(@NotNull Audience audience, @NotNull Audience otherAudience){
if (relationalPlaceholders.length == 0) return TagResolver.empty();
requireNonNull(audience, "the audience cannot be null");
requireNonNull(otherAudience, "the other audience cannot be null");
audience = expansionFilter(audience);
otherAudience = expansionFilter(otherAudience);
if (audience == null || otherAudience == null) {
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();
public @NonNull Builder version(final @Nullable String version) {
this.version = version;
return this;
}
@Override
public @NotNull TagResolver globalPlaceholders(){
return this.globalPlaceholders;
public @NonNull Expansion build() {
return new ExpansionImpl(
this.expansionName,
this.audiencePlaceholders,
this.relationalPlaceholders,
this.globalPlaceholders,
this.author,
this.version
);
}
}
@Override
public void register() {
if (this.registered()) {
throw new IllegalStateException("Expansion" + this.name + "is already registered");
}
MiniPlaceholders.expansions.add(this);
}
@Override
public boolean equals(final Object o) {
if (this == o) return true;
if (!(o instanceof Expansion that)) return false;
@Override
public void unregister() {
if (!this.registered()) {
throw new IllegalStateException("Expansion " + this.name + " is not registered");
}
MiniPlaceholders.expansions.remove(this);
}
return that.name().equalsIgnoreCase(this.name());
}
@Override
public boolean registered() {
return MiniPlaceholders.expansions.contains(this);
}
@Override
public int hashCode() {
return Objects.hash(name.hashCode());
}
static final class Builder implements Expansion.Builder {
private final String expansionName;
@Subst("server")
private final String expansionPrefix;
private Set<Tags.Single> audiencePlaceholders;
private Set<Tags.Relational> relationalPlaceholders;
private TagResolver.Builder globalPlaceholders;
private Class<? extends Audience> filterClass;
private Predicate<Audience> predicateFilter;
private String author;
private String version;
Builder(@NotNull final String name){
this.expansionName = nonNullOrEmptyString(name, "Expansion name");
this.expansionPrefix = name.toLowerCase(Locale.ROOT).concat("_");
}
@Override
public @NotNull Builder audiencePlaceholder(@NotNull final String key, @NotNull final AudiencePlaceholder audiencePlaceholder){
nonNullOrEmptyString(key, "Placeholder key");
requireNonNull(audiencePlaceholder, "the audience placeholder cannot be null");
if (this.audiencePlaceholders == null) this.audiencePlaceholders = new HashSet<>();
this.audiencePlaceholders.add(Tags.single(expansionPrefix+key, audiencePlaceholder));
return this;
}
@Override
public @NotNull Builder relationalPlaceholder(@NotNull final String key, @NotNull final RelationalPlaceholder relationalPlaceholder){
nonNullOrEmptyString(key, "Placeholder key");
requireNonNull(relationalPlaceholder, "the relational placeholder cannot be null");
if (this.relationalPlaceholders == null) this.relationalPlaceholders = new HashSet<>();
this.relationalPlaceholders.add(Tags.relational(expansionPrefix+"rel_"+key, relationalPlaceholder));
return this;
}
@Override
public @NotNull Builder globalPlaceholder(@NotNull final String key, @NotNull final BiFunction<ArgumentQueue, Context, Tag> function){
nonNullOrEmptyString(key, "Placeholder key");
requireNonNull(function, "the global placeholder cannot be null");
if (this.globalPlaceholders == null) this.globalPlaceholders = TagResolver.builder();
this.globalPlaceholders.tag(expansionPrefix+key, function);
return this;
}
@Override
public @NotNull Builder globalPlaceholder(@NotNull final String key, @NotNull final Tag tag){
nonNullOrEmptyString(key, "Placeholder key");
requireNonNull(tag, "the tag cannot be null");
if (this.globalPlaceholders == null) this.globalPlaceholders = TagResolver.builder();
this.globalPlaceholders.tag(expansionPrefix+key, tag);
return this;
}
@Override
public @NotNull Builder filter(@Nullable final Class<? extends Audience> clazz) {
this.filterClass = clazz;
return this;
}
@Override
public @NotNull Builder filter(@Nullable final Predicate<Audience> predicate){
this.predicateFilter = predicate;
return this;
}
@Override
public Expansion.@NotNull Builder author(@Nullable final String author) {
this.author = author;
return this;
}
@Override
public Expansion.@NotNull Builder version(@Nullable final String version) {
this.version = version;
return this;
}
@Override
public @NotNull Expansion build(){
return new ExpansionImpl(
this.expansionName,
this.audiencePlaceholders,
this.relationalPlaceholders,
this.globalPlaceholders != null ? this.globalPlaceholders.build() : TagResolver.empty(),
this.filterClass,
this.predicateFilter,
this.version,
this.author
);
}
}
@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,23 +1,24 @@
package io.github.miniplaceholders.api;
import io.github.miniplaceholders.api.enums.Platform;
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.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
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 java.util.stream.Stream;
import static io.github.miniplaceholders.api.utils.Resolvers.applyIfNotEmpty;
import static java.util.Objects.requireNonNull;
/**
* MiniPlaceholders
* 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},
@@ -33,57 +34,56 @@ public final class MiniPlaceholders {
static final Set<Expansion> expansions = ConcurrentHashMap.newKeySet();
/**
* Get the platform
* Get the platform on which MiniPlaceholders is running.
*
* @return the platform
* @since 1.0.0
* @since 3.0.0
*/
@SuppressWarnings("removal")
public static @NotNull Platform getPlatform() {
public static Platform platform() {
return switch (InternalPlatform.platform()) {
case PAPER -> Platform.PAPER;
case VELOCITY -> Platform.VELOCITY;
case KRYPTON -> Platform.KRYPTON;
case FABRIC -> Platform.FABRIC;
case SPONGE -> Platform.SPONGE;
case MINESTOM -> Platform.MINESTOM;
};
}
/**
* Get the global placeholders
*
* <pre>TagResolver resolver = MiniPlaceholders.getGlobalPlaceholders();
* <pre>TagResolver resolver = MiniPlaceholders.globalPlaceholders();
* Component messageParsed = MiniMessage.miniMessage().deserialize({@link String}, resolver);</pre>
*
* @return global placeholders independent of any audience
* @see TagResolver
* @since 1.0.0
* @since 3.0.0
*/
public static @NotNull TagResolver getGlobalPlaceholders() {
public static TagResolver globalPlaceholders() {
final TagResolver.Builder builder = TagResolver.builder();
for (final Expansion expansion : expansions) {
final TagResolver resolver = expansion.globalPlaceholders();
if (resolver != TagResolver.empty())
builder.resolver(resolver);
applyIfNotEmpty(resolver, builder);
}
return builder.build();
}
/**
* Get the TagResolver based on an Audience
* 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.getAudiencePlaceholders({@link Audience});
* Component messageParsed = MiniMessage.miniMessage().deserialize({@link String}, resolver);</pre>
* <pre>TagResolver resolver = MiniPlaceholders.audiencePlaceholders();
* Component messageParsed = MiniMessage.miniMessage().deserialize({@link String}, {@link Audience}, resolver);
* </pre>
*
* @param audience the audience
* @return {@link TagResolver} with placeholders based on an audience
* @since 1.0.0
* @since 3.0.0
*/
public static @NotNull TagResolver getAudiencePlaceholders(final @NotNull Audience audience) {
requireNonNull(audience, "audience cannot be null");
public static TagResolver audiencePlaceholders() {
final TagResolver.Builder resolvers = TagResolver.builder();
for (Expansion expansion : expansions) {
final TagResolver resolver = expansion.audiencePlaceholders(audience);
for (final Expansion expansion : expansions) {
final TagResolver resolver = expansion.audiencePlaceholders();
applyIfNotEmpty(resolver, resolvers);
}
return resolvers.build();
@@ -91,54 +91,53 @@ public final class MiniPlaceholders {
/**
* 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>TagResolver resolver = MiniPlaceholders.getRelationalPlaceholders({@link Audience}, {@link Audience});
* Component messageParsed = MiniMessage.miniMessage().deserialize({@link String}, resolver);</pre>
* <pre>{@code
* TagResolver resolver = MiniPlaceholders.relationalPlaceholders();
* Component parsed = MiniMessage.miniMessage().deserialize(@link String, {@link RelationalAudience}, resolver);
* }</pre>
*
* @param audience an audience
* @param otherAudience another audience
* @return placeholders based on two audiences
* @since 1.0.0
* @since 3.0.0
* @see RelationalAudience
*/
public static @NotNull TagResolver getRelationalPlaceholders(final @NotNull Audience audience, final @NotNull Audience otherAudience) {
requireNonNull(audience, "audience cannot be null");
requireNonNull(otherAudience, "otherAudience cannot be null");
public static TagResolver relationalPlaceholders() {
final TagResolver.Builder builder = TagResolver.builder();
for (final Expansion expansion : expansions) {
applyIfNotEmpty(
expansion.relationalPlaceholders(audience, otherAudience),
builder
);
applyIfNotEmpty(expansion.relationalPlaceholders(), builder);
}
return builder.build();
}
/**
* Get the TagResolver based on an Audience and the global placeholders
* 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.getAudienceGlobalPlaceholders({@link Audience});
* TagResolver resolver = MiniPlaceholders.audienceGlobalPlaceholders();
* TagResolver resolver2 = TagResolver.resolver(
* MiniPlaceholders.getAudienceGlobalPlaceholders({@link Audience}),
* MiniPlaceholders.getGlobalPlaceholders()
* MiniPlaceholders.audienceGlobalPlaceholders(),
* MiniPlaceholders.globalPlaceholders()
* );
* // This two resolvers returns the same TagResolver
* assertEquals(resolver, resolver2);
* Component messageParsed = MiniMessage.miniMessage().deserialize({@link String}, resolver);
* Component parsed = MiniMessage.miniMessage().deserialize({@link String}, {@link Audience}, resolver);
* </pre>
*
* @param audience the audience
* @return {@link TagResolver} with placeholders based on an audience and the global placeholders
* @since 1.1.0
*/
public static @NotNull TagResolver getAudienceGlobalPlaceholders(final @NotNull Audience audience) {
requireNonNull(audience, "audience cannot be null");
public static TagResolver audienceGlobalPlaceholders() {
final TagResolver.Builder builder = TagResolver.builder();
for (final Expansion expansion : expansions) {
applyIfNotEmpty(expansion.audiencePlaceholders(audience), builder);
applyIfNotEmpty(expansion.audiencePlaceholders(), builder);
applyIfNotEmpty(expansion.globalPlaceholders(), builder);
}
@@ -150,30 +149,27 @@ public final class MiniPlaceholders {
* and the global placeholders
*
* <pre>
* TagResolver resolver = MiniPlaceholders.getRelationalGlobalPlaceholders({@link Audience}, {@link Audience});
* TagResolver resolver = MiniPlaceholders.relationalGlobalPlaceholders();
* TagResolver resolver2 = TagResolver.resolver(
* MiniPlaceholders.getRelationalPlaceholders(audience1, audience2),
* MiniPlaceholders.getAudiencePlaceholders(audience1),
* MiniPlaceholders.getGlobalPlaceholders()
* MiniPlaceholders.relationalPlaceholders(),
* MiniPlaceholders.audiencePlaceholders(),
* MiniPlaceholders.globalPlaceholders()
* );
* // This methods should return the same TagResolver
* assertEquals(resolver, resolver2);
* Component messageParsed = MiniMessage.miniMessage().deserialize({@link String}, resolver);
* Component messageParsed = MiniMessage.miniMessage().deserialize({@link String}, {@link RelationalAudience}, 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
* @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 @NotNull TagResolver getRelationalGlobalPlaceholders(final @NotNull Audience audience, final @NotNull Audience otherAudience) {
requireNonNull(audience, "audience cannot be null");
requireNonNull(otherAudience, "otherAudience cannot be null");
public static TagResolver relationalGlobalPlaceholders() {
final TagResolver.Builder builder = TagResolver.builder();
for (final Expansion expansion : expansions) {
applyIfNotEmpty(expansion.audiencePlaceholders(audience), builder);
applyIfNotEmpty(expansion.relationalPlaceholders(audience, otherAudience), builder);
applyIfNotEmpty(expansion.audiencePlaceholders(), builder);
applyIfNotEmpty(expansion.relationalPlaceholders(), builder);
applyIfNotEmpty(expansion.globalPlaceholders(), builder);
}
@@ -181,11 +177,33 @@ public final class MiniPlaceholders {
}
/**
* Get the amount of expansion registered
* @return the amount of expansions registered
* @since 1.0.0
* 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 int getExpansionCount(){
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();
}
@@ -196,14 +214,15 @@ public final class MiniPlaceholders {
* Expansion expansion = Expansion.builder("example").build();
* expansion.register();
*
* assertThat(MiniPlaceholders.getExpansionByName("example")).isNotNull();
* 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 2.1.0
* @since 3.0.0
*/
public static @Nullable Expansion getExpansionByName(final @NotNull String name) {
public static @Nullable Expansion expansionByName(final String name) {
for (final Expansion expansion : expansions) {
if (Objects.equals(expansion.name(), name)) {
return expansion;
@@ -216,10 +235,10 @@ public final class MiniPlaceholders {
* Obtain all available registered expansions
*
* @return all available registered expansions
* @since 2.3.0
* @since 3.0.0
*/
@ApiStatus.Experimental
public static Stream<Expansion> getExpansionsAvailable() {
return expansions.stream();
@Unmodifiable
public static Collection<Expansion> expansionsAvailable() {
return Collections.unmodifiableSet(expansions);
}
}
@@ -1,107 +0,0 @@
package io.github.miniplaceholders.api;
import java.util.Objects;
import io.github.miniplaceholders.api.placeholder.AudiencePlaceholder;
import io.github.miniplaceholders.api.placeholder.RelationalPlaceholder;
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.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(final Object o) {
if (o == this) return true;
if (!(o instanceof final Relational that)) return false;
return that.key.equalsIgnoreCase(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(final Object o) {
if (o == this) return true;
if (!(o instanceof final Single that)) return false;
return that.key.equalsIgnoreCase(this.key);
}
@Override
public int hashCode(){
return Objects.hash(key);
}
}
}
@@ -1,16 +0,0 @@
package io.github.miniplaceholders.api.enums;
/**Platforms on which MiniPlaceholders can be used */
public enum Platform {
/**Paper Platform */
PAPER,
/**Velocity Platform */
VELOCITY,
/**Krypton Platform */
@Deprecated(forRemoval = true, since = "2.3.0")
KRYPTON,
/**Fabric Platform */
FABRIC,
/**Sponge Platform */
SPONGE
}
@@ -1,2 +0,0 @@
/**Plugin enums */
package io.github.miniplaceholders.api.enums;
@@ -1,27 +1,110 @@
package io.github.miniplaceholders.api.placeholder;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
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;
/**Audience Placeholder based on an Audience */
@FunctionalInterface
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 1.0.0
*/
@Nullable Tag tag(
@NotNull final Audience audience,
@NotNull final ArgumentQueue queue,
@NotNull final Context ctx
);
}
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;
}
@SuppressWarnings("OverrideOnly")
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 + '\'' +
'}';
}
}
@@ -0,0 +1,49 @@
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 + '\'' +
'}';
}
}
@@ -0,0 +1,26 @@
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();
}
@@ -0,0 +1,38 @@
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;
}
}
@@ -1,29 +1,134 @@
package io.github.miniplaceholders.api.placeholder;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
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;
/**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
);
}
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;
}
@SuppressWarnings("OverrideOnly")
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,4 +1,6 @@
/**
* Placeholders available based on information obtained from Audiences
* Placeholders Package.
*
* @since 3.0.0
*/
package io.github.miniplaceholders.api.placeholder;
package io.github.miniplaceholders.api.placeholder;
@@ -0,0 +1,27 @@
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();
}
@@ -0,0 +1,223 @@
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) +
'}';
}
}
}
@@ -0,0 +1,21 @@
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) {
}
@@ -0,0 +1,6 @@
/**
* Package responsible for providing tools to load expansions provided through installable files
*
* @since 3.0.0
*/
package io.github.miniplaceholders.api.provider;
@@ -0,0 +1,26 @@
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;
/**
* Audience Placeholder based on an Audience
*
* @param <A> the audience type
*/
@FunctionalInterface
public interface AudienceTagResolver<A extends Audience> {
/**
* 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
*/
@Nullable
Tag tag(final A audience, final ArgumentQueue queue, final Context ctx);
}
@@ -0,0 +1,23 @@
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);
}
@@ -0,0 +1,30 @@
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);
}
@@ -0,0 +1,4 @@
/**
* Resolvers available based on information obtained from Audiences
*/
package io.github.miniplaceholders.api.resolver;
@@ -0,0 +1,27 @@
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
}
@@ -0,0 +1,39 @@
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,
}
@@ -0,0 +1,34 @@
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);
}
}
@@ -0,0 +1,4 @@
/**
* Plugin types
*/
package io.github.miniplaceholders.api.types;
@@ -4,27 +4,33 @@ 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);
@@ -1,74 +1,78 @@
package io.github.miniplaceholders.api.utils;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jspecify.annotations.Nullable;
import java.util.function.Supplier;
/** Checks required for the correct operation of the expansions*/
/**
* Checks required for the correct operation of the expansions
*
* @since 1.0.0
*/
public final class Conditions {
private 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
* @throws IllegalStateException if the provided string is empty
*/
public static String nonNullOrEmptyString(@Nullable String string, @NotNull Supplier<@NotNull 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 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
* @since 2.2.0
* @throws IllegalStateException if the provided string is empty
*/
public static String nonNullOrEmptyString(@Nullable String string, @NotNull 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;
}
/**
* 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
* @since 1.0.0
* @throws IllegalStateException if the provided string is empty
*/
public static String nonEmptyString(@NotNull String string, @NotNull Supplier<@NotNull 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 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;
}
/**
* 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
* @since 2.2.0
* @throws IllegalStateException if the provided string is empty
*/
public static String nonEmptyString(@NotNull String string, @NotNull String reason){
if (string.isBlank()) throw new IllegalStateException(reason);
return string;
}
}
@@ -0,0 +1,165 @@
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,167 +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.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.function.Function;
import static java.util.Objects.requireNonNull;
import static net.kyori.adventure.text.minimessage.MiniMessage.miniMessage;
/**
* Legacy utils
*/
public final class LegacyUtils {
private LegacyUtils() {
}
/**
* Legacy serializer with hex support
* <p>Use this as the last available alternative,
* it is recommended to use MiniMessage instead of this serializer</p>
*/
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 @NotNull 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 @NotNull Component parsePossibleLegacy(
@Nullable String string,
final @NotNull 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 @NotNull Component parsePossibleLegacy(
@Nullable String string,
final @NotNull 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
* @return the mapped result
* @param <R> the result type
* @see LegacyComponentSerializer#AMPERSAND_CHAR
* @see LegacyComponentSerializer#SECTION_CHAR
* @see #hasLegacyFormat(String)
* @since 2.3.0
*/
public static <R> R mapLegacyOrElse(
final @NotNull String string,
final @NotNull Function<String, R> legacyMapping,
final @NotNull Function<String, R> modernMapping
) {
requireNonNull(legacyMapping, "legacyMapping");
requireNonNull(modernMapping, "modernInput");
if (hasLegacyFormat(string)) {
return legacyMapping.apply(string);
} else {
return modernMapping.apply(string);
}
}
}
@@ -1,11 +1,10 @@
package io.github.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 {
@@ -13,33 +12,36 @@ 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 @NotNull TagResolver resolver) {
public static boolean isEmpty(final 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 @NotNull TagResolver resolver) {
public static boolean isNotEmpty(final 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 @NotNull TagResolver resolver, final @NotNull TagResolver.Builder builder) {
public static void applyIfNotEmpty(final TagResolver resolver, final TagResolver.Builder builder) {
if (isNotEmpty(resolver)) {
builder.resolver(resolver);
}
@@ -0,0 +1,66 @@
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;
}
}
@@ -1,60 +0,0 @@
package io.github.miniplaceholders.api.utils;
import io.github.miniplaceholders.api.placeholder.AudiencePlaceholder;
import io.github.miniplaceholders.api.placeholder.RelationalPlaceholder;
import org.jetbrains.annotations.NotNull;
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
*/
@Deprecated
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
*/
@Deprecated
public static @NotNull Tag staticTag(@NotNull Component component) {
return Tag.selfClosingInserting(component);
}
}
+19 -11
View File
@@ -1,16 +1,24 @@
/** MiniPlaceholders API Module */
import org.jspecify.annotations.NullMarked;
/**
* MiniPlaceholders API Module
*/
@NullMarked
open module io.github.miniplaceholders.api {
requires io.github.miniplaceholders.connect;
requires io.github.miniplaceholders.connect;
requires net.kyori.adventure;
requires net.kyori.adventure.text.minimessage;
requires net.kyori.adventure.text.serializer.legacy;
requires net.kyori.examination.api;
requires net.kyori.adventure;
requires net.kyori.adventure.text.minimessage;
requires net.kyori.adventure.text.serializer.legacy;
requires net.kyori.examination.api;
requires static org.jetbrains.annotations;
requires static org.jetbrains.annotations;
requires static org.jspecify;
exports io.github.miniplaceholders.api;
exports io.github.miniplaceholders.api.enums;
exports io.github.miniplaceholders.api.utils;
exports io.github.miniplaceholders.api.placeholder;
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;
}
@@ -1,45 +1,65 @@
package io.github.miniplaceholders.test;
import io.github.miniplaceholders.api.Expansion;
import io.github.miniplaceholders.api.utils.TagsUtils;
import io.github.miniplaceholders.test.testobjects.TestAudienceHolder;
import net.kyori.adventure.text.Component;
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 io.github.miniplaceholders.test.PlaceholderTest.assertContentEquals;
import static net.kyori.adventure.text.minimessage.MiniMessage.miniMessage;
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.*;
class ExpansionsTest {
class ExpansionsTest implements MiniTest {
@Test
@DisplayName("Expansion Equality")
void equalsExpansions(){
final Expansion firstExpansion = Expansion.builder("equals")
.audiencePlaceholder("test", TagsUtils.NULL_AUDIENCE_PLACEHOLDER)
.audiencePlaceholder("test", Tags.emptyAudienceResolver())
.build();
final Expansion secondExpansion = Expansion.builder("equals")
.audiencePlaceholder("test", TagsUtils.NULL_AUDIENCE_PLACEHOLDER)
.audiencePlaceholder("test", Tags.emptyAudienceResolver())
.build();
assertEquals(firstExpansion, secondExpansion);
}
@Test
void nullForwardedAudience() {
TestAudienceHolder audience = new TestAudienceHolder(null);
void placeholderRetrievalTest() {
final Expansion expansion = Expansion.builder("test")
.filter(aud -> aud.toString().isBlank())
.audiencePlaceholder("testing", (aud, queue, ctx) -> Tag.selfClosingInserting(Component.text(aud.toString())))
.globalPlaceholder("some_placeholder", Tag.preProcessParsed("test"))
.build();
Component result = assertDoesNotThrow(
() -> miniMessage().deserialize("<test_testing>", expansion.audiencePlaceholders(audience))
);
assertTrue(expansion.hasGlobalPlaceholder("some_placeholder"));
final GlobalPlaceholder somePlaceholder = expansion.globalPlaceholderByName("some_placeholder");
assertNotNull(somePlaceholder);
assertContentEquals(result, Component.text("<test_testing>"));
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,6 +1,6 @@
package io.github.miniplaceholders.test;
import io.github.miniplaceholders.api.utils.LegacyUtils;
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;
@@ -10,11 +10,11 @@ import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.*;
class LegacyTest {
class LegacyTest implements MiniTest {
@Test
void testLegacyParsing() {
final String string = "<rainbow>hello... i &8hate legacy format §bso much";
final Component parsed = LegacyUtils.parsePossibleLegacy(string);
final Component parsed = LegacyStrings.parsePossibleLegacy(string);
final String result = PlainTextComponentSerializer.plainText().serialize(parsed);
final String expected = "hello... i hate legacy format so much";
@@ -24,15 +24,15 @@ class LegacyTest {
@Test
void testMapLegacyOrElse() {
final String legacyInput = "&fhi <red>aaaa";
Tag legacyProcessedTag = LegacyUtils.mapLegacyOrElse(
Tag legacyProcessedTag = LegacyStrings.mapLegacyOrElse(
legacyInput,
legacy -> Tag.inserting(LegacyUtils.parsePossibleLegacy(legacy)),
legacy -> Tag.inserting(LegacyStrings.parsePossibleLegacy(legacy)),
Tag::preProcessParsed
);
assertInstanceOf(Inserting.class, legacyProcessedTag);
final String modernInput = "<rainbow>aaaaaaaaaaaaa";
Tag modernProcessedTag = LegacyUtils.mapLegacyOrElse(
Tag modernProcessedTag = LegacyStrings.mapLegacyOrElse(
modernInput,
__ -> fail(),
Tag::preProcessParsed
@@ -1,32 +1,28 @@
package io.github.miniplaceholders.test;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import io.github.miniplaceholders.api.Expansion;
import io.github.miniplaceholders.api.MiniPlaceholders;
import io.github.miniplaceholders.api.utils.TagsUtils;
import net.kyori.adventure.audience.Audience;
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 {
class MiniPlaceholdersTest implements MiniTest {
@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)
.audiencePlaceholder("audience", Tags.emptyAudienceResolver())
.globalPlaceholder("global", (queue, ctx) -> Tags.EMPTY_TAG)
.build()
.register();
assertEquals(
MiniPlaceholders.getAudienceGlobalPlaceholders(Audience.empty()),
MiniPlaceholders.audienceGlobalPlaceholders(),
TagResolver.resolver(
MiniPlaceholders.getAudiencePlaceholders(Audience.empty()),
MiniPlaceholders.getGlobalPlaceholders()
MiniPlaceholders.audiencePlaceholders(),
MiniPlaceholders.globalPlaceholders()
)
);
}
@@ -37,7 +33,7 @@ class MiniPlaceholdersTest {
.build();
expansion.register();
assertNotNull(MiniPlaceholders.getExpansionByName("testregistration"));
assertNotNull(MiniPlaceholders.expansionByName("testregistration"));
assertTrue(expansion.registered());
assertThrows(IllegalStateException.class, expansion::register);
@@ -0,0 +1,30 @@
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);
}
}
@@ -3,8 +3,9 @@ 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.test.testobjects.TestAudience;
import io.github.miniplaceholders.test.testobjects.TestAudienceHolder;
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;
@@ -15,140 +16,136 @@ 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 {
class PlaceholderTest implements MiniTest {
@Test
@DisplayName("Audience Placeholder Test")
void audienceExpansionPlaceholdersTest(){
TestAudience player = new TestAudience("4drian3d");
@Test
@DisplayName("Audience Placeholder Test")
void audienceExpansionPlaceholdersTest() {
TestAudience player = new TestAudience("4drian3d");
Expansion expansion = Expansion.builder("example")
Expansion expansion = Expansion.builder("example")
.audiencePlaceholder("name", (aud, queue, ctx) -> {
TestAudience audience = (TestAudience) aud;
return Tag.selfClosingInserting(Component.text(audience.name()));
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>", expansion.audiencePlaceholders(player));
final Component expected = Component.text("Player Name: 4drian3d");
final Component result = miniMessage().deserialize("Player Name: <example_name>", player, expansion.audiencePlaceholders());
assertContentEquals(expected, result);
}
assertContentEquals(expected, result);
}
@Test
@DisplayName("Relational Placeholder Test")
void relationalExpansionPlaceholdersTest(){
Audience p1 = new TestAudience("PlayerOne");
Audience p2 = new TestAudience("PlayerTwo");
@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)
))
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>", expansion.relationalPlaceholders(p1, p2)));
}
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")
@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());
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);
}
assertContentEquals(expected, actual);
}
@Test
@DisplayName("Registered Placeholders")
void instancePlaceholdersTest(){
Expansion.builder("instance")
@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());
Component expected = Component.text("hello player", NamedTextColor.RED);
Component actual = MiniMessage.miniMessage().deserialize("<instance_hello> player", MiniPlaceholders.globalPlaceholders());
assertContentEquals(expected, actual);
}
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).name())))
.filter(TestAudience.class)
@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();
Audience player = new TestAudience("TestPlayer04");
Audience emptyAudience = Audience.empty();
String string = "Player Name: <filter_name>";
String string = "Player Name: <filter_name>";
Component playerExpected = Component.text("Player Name: TestPlayer04");
Component emptyExpected = Component.text("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, expansion.audiencePlaceholders(player)));
assertContentEquals(emptyExpected, MiniMessage.miniMessage().deserialize(string, expansion.audiencePlaceholders(emptyAudience)));
}
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();
@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());
Component parsed = miniMessage().deserialize("<test_testing::>", expansion.globalPlaceholders());
assertContentEquals(parsed, Component.text("Arguments: 2"));
}
assertContentEquals(parsed, Component.text("Arguments: 2"));
}
@Test
@DisplayName("Forwarding Audience Parsing Test")
void forwardingAudienceTest() {
Expansion expansion = Expansion.builder("test")
.filter(TestAudience.class)
.audiencePlaceholder("testing", (audience, queue, ctx) -> {
TestAudience testAudience = (TestAudience) audience;
return Tag.selfClosingInserting(Component.text("Name: "+testAudience.name()));
}).build();
@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);
TestAudience testAudience = new TestAudience("4drian3d");
Audience forward = new TestAudienceHolder(testAudience);
Component parsed = miniMessage().deserialize("<test_testing>.", expansion.audiencePlaceholders(forward));
Component expected = Component.text("Name: 4drian3d.");
Component parsed = miniMessage().deserialize("<test_testing>.", forward, expansion.audiencePlaceholders());
Component expected = Component.text("Name: 4drian3d.");
assertContentEquals(parsed, expected);
}
assertContentEquals(parsed, expected);
}
static 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.name().equals("PlayerOne") && a2.name().equals("PlayerTwo");
}
private boolean isEnemy(TestAudience a1, TestAudience a2) {
return a1.name().equals("PlayerOne") && a2.name().equals("PlayerTwo");
}
}
@@ -0,0 +1,48 @@
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,23 +1,17 @@
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;
import java.util.function.BiFunction;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import io.github.miniplaceholders.api.Expansion;
import io.github.miniplaceholders.api.MiniPlaceholders;
import io.github.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;
//yea... it is intended xd
@SuppressWarnings("DataFlowIssue")
class ThrowableTest {
class ThrowableTest implements MiniTest {
@Test
@DisplayName("Nullable Exception")
void throwOnNull(){
@@ -25,17 +19,8 @@ class ThrowableTest {
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));
assertThrows(NullPointerException.class, () -> expansionTest.audiencePlaceholder(null, (aud, queue, ctx) -> Tags.EMPTY_TAG));
assertThrows(NullPointerException.class, () -> expansionTest.globalPlaceholder("test", (GlobalTagResolver) null));
}
@Test
@@ -43,9 +28,9 @@ class ThrowableTest {
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));
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) -> TagsUtils.EMPTY_TAG));
assertDoesNotThrow(() -> builder.globalPlaceholder("hehe", (queue, ctx) -> Tags.EMPTY_TAG));
}
}
@@ -0,0 +1,7 @@
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,11 +1,12 @@
package io.github.miniplaceholders.test.testobjects;
package io.github.miniplaceholders.test.instances;
import net.kyori.adventure.audience.ForwardingAudience;
import org.jetbrains.annotations.NotNull;
import org.jspecify.annotations.NullMarked;
@NullMarked
public record TestAudienceHolder(TestAudience audience) implements ForwardingAudience.Single {
@Override
public @NotNull TestAudience audience() {
public TestAudience audience() {
return audience;
}
}
@@ -0,0 +1,21 @@
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")
);
}
}
@@ -1,7 +0,0 @@
package io.github.miniplaceholders.test.testobjects;
import org.jetbrains.annotations.NotNull;
import net.kyori.adventure.audience.Audience;
public record TestAudience(@NotNull String name) implements Audience {}
+2 -2
View File
@@ -5,7 +5,7 @@ plugins {
dependencies {
implementation(libs.plugin.shadow)
implementation(libs.plugin.kotlin)
implementation(libs.plugin.dokka)
implementation(libs.plugin.runtask)
}
repositories {
@@ -14,6 +14,6 @@ repositories {
kotlin {
jvmToolchain {
languageVersion = JavaLanguageVersion.of(21)
languageVersion = JavaLanguageVersion.of(25)
}
}
+1 -1
View File
@@ -15,5 +15,5 @@ dependencyResolutionManagement {
}
plugins {
id("org.gradle.toolchains.foojay-resolver-convention") version "0.9.0"
id("org.gradle.toolchains.foojay-resolver-convention") version "1.0.0"
}
+1 -1
View File
@@ -4,4 +4,4 @@ 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)
fun Project.simpleName(): String = this.name.substring(17)
@@ -1,4 +1,4 @@
import java.util.Date
import java.util.*
plugins {
java
@@ -7,7 +7,7 @@ plugins {
tasks {
compileJava {
options.encoding = Charsets.UTF_8.name()
options.release.set(21)
options.release.set(25)
}
jar {
manifest {
@@ -22,7 +22,7 @@ tasks {
java{
toolchain{
languageVersion.set(JavaLanguageVersion.of(21))
vendor.set(JvmVendorSpec.ADOPTIUM)
languageVersion.set(JavaLanguageVersion.of(25))
vendor.set(JvmVendorSpec.AZUL)
}
}
@@ -1,100 +0,0 @@
plugins {
kotlin("jvm")
`java-library`
`maven-publish`
signing
id("org.jetbrains.dokka")
}
//val dokkaHtmlJar by tasks.registering(Jar::class) {
// description = "A HTML Documentation JAR containing Dokka HTML"
// from(tasks.dokkaGeneratePublicationHtml.flatMap { it.outputDirectory })
// archiveClassifier.set("javadoc")
//}
//
//dokka {
// dokkaSourceSets.main {
// includes.from("README.md")
// sourceLink {
// localDirectory.set(rootDir)
// remoteUrl("https://github.com/MiniPlaceholders/MiniPlaceholders/tree/main")
// remoteLineSuffix.set("#L")
// }
// }
// pluginsConfiguration.html {
// footerMessage.set("(c) MiniPlaceholders | 4drian3d")
// }
//}
//
//publishing {
// publications {
// register<MavenPublication>("maven") {
// artifact(dokkaHtmlJar)
// repositories {
// maven {
// credentials {
// username = property("sonatypeTokenUsername")?.toString() ?: ""
// password = property("sonatypeTokenPassword")?.toString() ?: ""
// }
// val central = "https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/"
// val snapshots = "https://s01.oss.sonatype.org/content/repositories/snapshots/"
//
// if (project.version.toString().endsWith("SNAPSHOT")) {
// name = "SonatypeSnapshots"
// setUrl(snapshots)
// } else {
// name = "OSSRH"
// setUrl(central)
// }
// }
// maven(file("build/dev-maven")) {
// name = "DevMaven"
// }
// }
// from(components["java"])
// pom {
// url.set("https://github.com/MiniPlaceholders/MiniPlaceholders")
// licenses {
// license {
// name.set("Apache License 2.0")
// url.set("https://opensource.org/license/apache-2-0/")
// }
// }
// 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")
// }
// developers {
// developer {
// id.set("4drian3d")
// name.set("Adrian Gonzales")
// email.set("adriangonzalesval@gmail.com")
// }
// }
// issueManagement {
// name.set("GitHub")
// url.set("https://github.com/MiniPlaceholders/MiniPlaceholders/issues")
// }
// ciManagement {
// name.set("GitHub Actions")
// url.set("https://github.com/MiniPlaceholders/MiniPlaceholders/actions")
// }
// name.set(project.name)
// description.set(project.description)
// url.set("https://github.com/MiniPlaceholders/MiniPlaceholders")
// }
// }
// }
//}
//
//signing {
// useGpgCmd()
// sign(configurations.archives.get())
// sign(publishing.publications["maven"])
// sign(dokkaHtmlJar.get())
//}
//
//java {
// withSourcesJar()
//}
@@ -1,74 +0,0 @@
plugins {
`java-library`
`maven-publish`
signing
}
/*
publishing {
publications {
create<MavenPublication>("maven") {
repositories {
maven {
credentials {
username = property("sonatypeTokenUsername")?.toString() ?: ""
password = property("sonatypeTokenPassword")?.toString() ?: ""
}
val central = "https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/"
val snapshots = "https://s01.oss.sonatype.org/content/repositories/snapshots/"
if (project.version.toString().endsWith("SNAPSHOT")) {
name = "SonatypeSnapshots"
setUrl(snapshots)
} else {
name = "OSSRH"
setUrl(central)
}
}
}
from(components["java"])
pom {
url.set("https://github.com/MiniPlaceholders/MiniPlaceholders")
licenses {
license {
name.set("Apache License 2.0")
url.set("https://opensource.org/license/apache-2-0/")
}
}
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")
}
developers {
developer {
id.set("4drian3d")
name.set("Adrian Gonzales")
email.set("adriangonzalesval@gmail.com")
}
}
issueManagement {
name.set("GitHub")
url.set("https://github.com/MiniPlaceholders/MiniPlaceholders/issues")
}
ciManagement {
name.set("GitHub Actions")
url.set("https://github.com/MiniPlaceholders/MiniPlaceholders/actions")
}
name.set(project.name)
description.set(project.description)
url.set("https://github.com/MiniPlaceholders/MiniPlaceholders")
}
}
}
}
signing {
useGpgCmd()
sign(configurations.archives.get())
sign(publishing.publications["maven"])
}*/
java {
withSourcesJar()
}
@@ -0,0 +1,32 @@
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
)
}
}
}
@@ -9,10 +9,8 @@ tasks {
archiveClassifier.set("")
duplicatesStrategy = DuplicatesStrategy.EXCLUDE
relocate("net.william278.desertwell", "io.github.miniplaceholders.libs.desertwell")
relocate("org.incendo.cloud", "io.github.miniplaceholders.libs.cloud")
// if (project.simpleName() != "sponge") {
// relocate("io.leangen.geantyref", "io.github.miniplaceholders.libs.geantyref")
// }
relocate("org.bstats", "io.github.miniplaceholders.libs.bstats")
destinationDirectory.set(file("${project.rootDir}/jar"))
}
build {
+1 -1
View File
@@ -1,5 +1,5 @@
plugins {
kotlin("jvm") version "2.1.10" apply false
kotlin("jvm") version "2.3.20" apply false
}
tasks {
+4 -4
View File
@@ -9,12 +9,12 @@ dependencies {
implementation(libs.desertwell) {
exclude("org.json")
}
implementation(libs.cloud.core)
implementation(libs.cloud.extras) {
isTransitive = false
}
implementation(libs.unnamedinject)
compileOnly(libs.adventure.api)
compileOnly(libs.adventure.minimessage)
compileOnly(libs.jspecify)
compileOnly(libs.brigadier)
compileOnly(libs.bstats.core)
}
sourceSets {
@@ -1,7 +1,135 @@
package io.github.miniplaceholders.common;
public interface PlaceholdersPlugin {
void loadDefaultExpansions();
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.TextComponent;
import net.kyori.adventure.text.format.NamedTextColor;
import net.kyori.adventure.text.format.TextColor;
import team.unnamed.inject.Injector;
void registerPlatformCommand();
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)
.collect(Component.toComponent(Component.text(", ", NamedTextColor.WHITE)));
logInfo(Component.text("Loaded expansions: ", NamedTextColor.GREEN).append(expansionsInfo));
}
private Component 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.build();
}
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 +1,10 @@
package io.github.miniplaceholders.common.command;
import net.kyori.adventure.audience.Audience;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
@FunctionalInterface
public interface AudienceConverter {
@Nullable Audience convert(@NotNull String string);
@Nullable Audience convert(@NonNull String string);
}
@@ -0,0 +1,10 @@
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);
}
@@ -0,0 +1,104 @@
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,9 +1,13 @@
package io.github.miniplaceholders.common.command;
import net.kyori.adventure.audience.Audience;
import org.jetbrains.annotations.NotNull;
import net.kyori.adventure.util.TriState;
import org.jspecify.annotations.NullMarked;
@NullMarked
@FunctionalInterface
public interface PermissionTester<S extends Audience> {
boolean hasPermission(@NotNull S source, @NotNull String permission);
public interface PermissionTester {
TriState permissionValue(Audience audience, String permission);
PermissionTester NO_OP = (audience, permission) -> TriState.NOT_SET;
}
@@ -0,0 +1,9 @@
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);
}
@@ -1,98 +0,0 @@
package io.github.miniplaceholders.common.command;
import io.github.miniplaceholders.common.command.node.ExpansionsNode;
import io.github.miniplaceholders.common.command.node.HelpNode;
import io.github.miniplaceholders.common.command.node.ParseNode;
import io.github.miniplaceholders.common.command.node.RootNode;
import net.kyori.adventure.audience.Audience;
import net.kyori.adventure.builder.AbstractBuilder;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.minimessage.tag.resolver.Placeholder;
import org.incendo.cloud.CommandManager;
import org.incendo.cloud.minecraft.extras.AudienceProvider;
import org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.stream.Stream;
import static java.util.Objects.requireNonNull;
import static net.kyori.adventure.text.minimessage.MiniMessage.miniMessage;
public record PlaceholdersCommand<A extends Audience>(
PlayerSuggestions playersSuggestions,
AudienceConverter audienceConverter,
PermissionTester<A> hasPermission,
String command,
CommandManager<A> commandManager
) {
public static final Component TITLE = miniMessage().deserialize("<gradient:#4d8bff:#a4ff96>MiniPlaceholders</gradient>");
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> ");
public void register() {
//noinspection unchecked
MinecraftExceptionHandler.create(AudienceProvider.nativeAudience())
.defaultHandlers()
.decorator(component -> Component.text().append(TITLE).appendSpace().append(component))
.registerTo((CommandManager<Audience>) commandManager);
// Nodes
Stream.of(new RootNode<>(hasPermission), new HelpNode<A>(), new ParseNode<A>(playersSuggestions, audienceConverter), new ExpansionsNode<A>())
.map(handler -> handler.apply(commandManager.commandBuilder(command)))
.forEach(commandManager::command);
}
public static <A extends Audience> Builder<A> builder() {
return new Builder<>();
}
public final static class Builder<A extends Audience> implements AbstractBuilder<PlaceholdersCommand<A>> {
private PlayerSuggestions playersSuggestions;
private AudienceConverter audienceConverter;
private PermissionTester<A> hasPermission;
private String command;
private CommandManager<A> commandManager;
private Builder() {}
public Builder<A> playerSuggestions(final @NotNull PlayerSuggestions playersSuggestions) {
this.playersSuggestions = playersSuggestions;
return this;
}
public Builder<A> toAudience(final @NotNull AudienceConverter audienceConverter) {
this.audienceConverter = audienceConverter;
return this;
}
public Builder<A> hasPermissionCheck(final @Nullable PermissionTester<A> hasPermission) {
this.hasPermission = hasPermission;
return this;
}
public Builder<A> command(final @NotNull String command) {
this.command = command;
return this;
}
public Builder<A> manager(final @NotNull CommandManager<A> commandManager) {
this.commandManager = commandManager;
return this;
}
@Override
public @NotNull PlaceholdersCommand<A> build() {
return new PlaceholdersCommand<>(
requireNonNull(playersSuggestions),
requireNonNull(audienceConverter),
hasPermission,
requireNonNull(command),
requireNonNull(commandManager)
);
}
}
}
@@ -1,10 +0,0 @@
package io.github.miniplaceholders.common.command;
import org.jetbrains.annotations.NotNull;
import java.util.ArrayList;
@FunctionalInterface
public interface PlayerSuggestions {
@NotNull ArrayList<String> suggest();
}
@@ -0,0 +1,10 @@
package io.github.miniplaceholders.common.command;
import org.jspecify.annotations.NonNull;
import java.util.ArrayList;
@FunctionalInterface
public interface PlayersNameProvider {
@NonNull ArrayList<String> provide();
}
@@ -0,0 +1,97 @@
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();
}
}
@@ -0,0 +1,19 @@
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();
}
}
@@ -1,54 +1,65 @@
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.incendo.cloud.Command;
import org.jspecify.annotations.NullMarked;
import static io.github.miniplaceholders.common.command.PlaceholdersCommand.FOOTER;
import static net.kyori.adventure.text.minimessage.MiniMessage.miniMessage;
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());
}
public final class ExpansionsNode<S extends Audience> implements Node<S> {
@Override
public Command.Builder<S> apply(Command.Builder<S> rootBuilder) {
return rootBuilder.literal("expansions")
.permission("miniplaceholders.command.expansions")
.handler(handler -> {
TextComponent.Builder builder = Component.text()
.appendNewline()
.append(miniMessage().deserialize(
"<gradient:aqua:white:aqua><st><b> </st> <gradient:#4d8bff:#a4ff96>MiniPlaceholders</gradient> Expansions <st><b> </gradient>"
))
.appendNewline()
.append(MiniPlaceholders.getExpansionsAvailable()
.map(expansion -> {
final TextComponent.Builder expansionMetaBuilder = Component.text();
final String expansionName = expansion.name();
final String expansionAuthor = expansion.author();
final String expansionVersion = expansion.version();
public boolean hasPermission(Audience audience) {
return permissionTester.permissionValue(audience, permission()).toBooleanOrElse(false);
}
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(" | "))))
.appendNewline()
.append(FOOTER);
handler.sender().sendMessage(builder.build());
});
@Override
public String permission() {
return "miniplaceholders.command.expansions";
}
}
@@ -1,33 +1,24 @@
package io.github.miniplaceholders.common.command.node;
import io.github.miniplaceholders.common.command.PermissionTester;
import net.kyori.adventure.audience.Audience;
import net.kyori.adventure.text.Component;
import org.incendo.cloud.Command;
import org.jspecify.annotations.NullMarked;
import static io.github.miniplaceholders.common.command.PlaceholdersCommand.FOOTER;
import static io.github.miniplaceholders.common.command.PlaceholdersCommand.HEADER;
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;
import static io.github.miniplaceholders.common.command.CommandConstants.HELP;
public final class HelpNode<S extends Audience> implements Node<S> {
private static final Component HELP = text()
.append(newline(), HEADER)
.append(newline(), miniMessage().deserialize(
"<gradient:#9694ff:#5269ff>Commands:</gradient>"))
.append(newline(), miniMessage().deserialize(
"<gradient:aqua:#94d1ff>/miniplaceholders</gradient> <aqua>help</aqua>"))
.append(newline(), miniMessage().deserialize(
"<gradient:aqua:#94d1ff>/miniplaceholders</gradient> <aqua>parse</aqua> <#8fadff><player | me></#8fadff> <#99ffb6><player></#99ffb6>"))
.append(newline(), miniMessage().deserialize(
"<gradient:aqua:#94d1ff>/miniplaceholders</gradient> <aqua>expansions</aqua>"))
.append(newline(), FOOTER)
.build();
@NullMarked
public record HelpNode(PermissionTester permissionChecker) implements Node {
public void execute(final Audience audience) {
audience.sendMessage(HELP.get());
}
@Override
public Command.Builder<S> apply(Command.Builder<S> rootBuilder) {
return rootBuilder.literal("help")
.permission("miniplaceholders.command.help")
.handler(handler -> handler.sender().sendMessage(HELP));
public boolean hasPermission(Audience audience) {
return permissionChecker.permissionValue(audience, permission()).toBooleanOrElse(false);
}
@Override
public String permission() {
return "miniplaceholders.command.help";
}
}
@@ -1,8 +1,11 @@
package io.github.miniplaceholders.common.command.node;
import net.kyori.adventure.audience.Audience;
import org.incendo.cloud.Command;
import org.jspecify.annotations.NullMarked;
public sealed interface Node<S extends Audience> permits ExpansionsNode, HelpNode, ParseNode, RootNode {
Command.Builder<S> apply(Command.Builder<S> rootBuilder);
@NullMarked
public sealed interface Node permits ExpansionsNode, HelpNode, ParseNode, ParseRelNode, RootNode {
boolean hasPermission(Audience audience);
String permission();
}
@@ -2,15 +2,12 @@ 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.PlayerSuggestions;
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.incendo.cloud.Command;
import org.incendo.cloud.component.CommandComponent;
import org.incendo.cloud.component.TypedCommandComponent;
import org.incendo.cloud.description.Description;
import org.incendo.cloud.parser.standard.StringParser;
import org.incendo.cloud.suggestion.SuggestionProvider;
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
import org.jspecify.annotations.NullMarked;
import java.util.List;
@@ -18,47 +15,45 @@ 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;
public record ParseNode<S extends Audience>(
PlayerSuggestions playerSuggestions,
AudienceConverter audienceConverter
) implements Node<S> {
@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 Command.Builder<S> apply(Command.Builder<S> rootBuilder) {
final TypedCommandComponent<S, String> sourceArgument = CommandComponent.<S, String>ofType(String.class, "source")
.parser(StringParser.stringParser(StringParser.StringMode.SINGLE))
.description(Description.of("The source from which the message will be parsed"))
.suggestionProvider(SuggestionProvider.blockingStrings((ctx, st) -> {
final List<String> suggestions = playerSuggestions.suggest();
suggestions.add("me");
return suggestions;
}))
.build();
final TypedCommandComponent<S, String> stringArgument = CommandComponent.<S, String>ofType(String.class, "message")
.parser(StringParser.greedyStringParser())
.description(Description.of("Message to be parsed"))
.build();
public boolean hasPermission(final Audience audience) {
return permissionChecker.permissionValue(audience, permission()).toBooleanOrElse(false);
}
return rootBuilder.literal("parse")
.argument(sourceArgument)
.argument(stringArgument)
.permission("miniplaceholders.command.parse")
.handler(handler -> {
final String source = handler.get(sourceArgument);
@Override
public String permission() {
return "miniplaceholders.command.parse";
}
final Audience objective = "me".equals(source)
? handler.sender()
: audienceConverter.convert(source);
if (objective == null){
handler.sender().sendMessage(text("You must specify a valid player", RED));
return;
}
final String toParse = handler.get(stringArgument);
final Component parsed = miniMessage().deserialize(
toParse,
MiniPlaceholders.getAudienceGlobalPlaceholders(objective)
);
handler.sender().sendMessage(parsed);
});
@Override
public List<String> providePlayerSuggestions() {
final List<String> suggestions = PlayerCompleterNode.super.providePlayerSuggestions();
suggestions.add("--null");
return suggestions;
}
}
@@ -0,0 +1,59 @@
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";
}
}
@@ -0,0 +1,15 @@
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,52 +1,26 @@
package io.github.miniplaceholders.common.command.node;
import io.github.miniplaceholders.common.PluginConstants;
import io.github.miniplaceholders.common.command.PermissionTester;
import net.kyori.adventure.audience.Audience;
import net.kyori.adventure.permission.PermissionChecker;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.format.TextColor;
import net.kyori.adventure.util.TriState;
import net.william278.desertwell.about.AboutMenu;
import net.william278.desertwell.util.Version;
import org.incendo.cloud.Command;
import org.incendo.cloud.permission.Permission;
import org.incendo.cloud.permission.PermissionResult;
import org.jspecify.annotations.NullMarked;
import static io.github.miniplaceholders.common.command.PlaceholdersCommand.TITLE;
import static net.kyori.adventure.text.Component.text;
import static io.github.miniplaceholders.common.command.CommandConstants.INFO;
public record RootNode<S extends Audience>(PermissionTester<S> hasPermission) implements Node<S> {
private static final Component INFO = AboutMenu.builder()
.title(TITLE)
.description(text("MiniMessage Component-based Placeholders for Paper, Folia, Fabric, Velocity and Sponge platforms"))
.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")
)
.buttons(
AboutMenu.Link.of("https://github.com/MiniPlaceholders/MiniPlaceholders/wiki/User-Getting-Started").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();
@NullMarked
public record RootNode(PermissionTester permissionChecker) implements Node {
public void execute(Audience audience) {
audience.sendMessage(INFO);
}
@Override
public Command.Builder<S> apply(Command.Builder<S> rootBuilder) {
return rootBuilder
.permission(src -> {
if (hasPermission != null) {
return PermissionResult.of(hasPermission.hasPermission(src, "miniplaceholders.command"), Permission.permission("miniplaceholders.command"));
}
return PermissionResult.of(src.get(PermissionChecker.POINTER)
.map(checker -> checker.value("miniplaceholders.command"))
.orElse(TriState.FALSE) != TriState.FALSE,
Permission.permission("miniplaceholders.command")
);
})
.handler(handler -> handler.sender().sendMessage(INFO));
public boolean hasPermission(Audience audience) {
return permissionChecker.permissionValue(audience, permission()) != TriState.FALSE;
}
@Override
public String permission() {
return "miniplaceholders.command";
}
}
@@ -0,0 +1,95 @@
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);
}
}
@@ -0,0 +1,7 @@
package io.github.miniplaceholders.common.loader;
import io.github.miniplaceholders.api.provider.LoadRequirement;
import org.jspecify.annotations.NonNull;
public record FailedToLoadExpansion(@NonNull LoadRequirement requirement) {
}
@@ -0,0 +1,14 @@
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));
}
}
@@ -0,0 +1,12 @@
package io.github.miniplaceholders.common.metrics;
import io.github.miniplaceholders.api.MiniPlaceholders;
import java.util.concurrent.Callable;
public final class LoadedExpansionsMetric implements Callable<Integer> {
@Override
public Integer call() {
return MiniPlaceholders.expansionsAvailable().size();
}
}
@@ -3,9 +3,7 @@ package io.github.miniplaceholders.connect;
public enum InternalPlatform {
PAPER, VELOCITY,
@Deprecated(forRemoval = true, since = "2.3.0")
KRYPTON,
FABRIC, SPONGE;
FABRIC, SPONGE, MINESTOM;
private static InternalPlatform actualPlatform;
@@ -0,0 +1,23 @@
plugins {
id("miniplaceholders.auto.module")
alias(libs.plugins.idea.ext)
alias(libs.plugins.blossom)
}
version = "1.4.0"
dependencies {
compileOnly(projects.miniplaceholdersApi)
compileOnly(libs.adventure.api)
compileOnly(libs.adventure.minimessage)
}
sourceSets {
main {
blossom {
javaSources {
property("version", project.version.toString())
}
}
}
}
@@ -0,0 +1,7 @@
package io.github.miniplaceholders.provider.example;
public final class ExpansionConstants {
public static final String VERSION = "{{ version }}";
private ExpansionConstants() {}
}
@@ -0,0 +1,64 @@
package io.miniplaceholders.provider.example;
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.provider.PlatformData;
import io.github.miniplaceholders.api.types.Platform;
import io.github.miniplaceholders.provider.example.ExpansionConstants;
import net.kyori.adventure.text.minimessage.tag.Tag;
import team.unnamed.inject.Inject;
public record ExampleProvider(PlatformData platformData) implements ExpansionProvider {
@Inject
public ExampleProvider {}
@Override
public Expansion provideExpansion() {
return Expansion.builder("example")
.author("MiniPlaceholders Contributors")
.globalPlaceholder("test", (queue, context) ->
Tag.preProcessParsed("""
Platform Instance Class: %s
MiniPlaceholders Instance Class: %s
""".formatted(
platformData.serverInstance(),
platformData.complementInstance()
)))
.audiencePlaceholder("audience", (audience, queue, ctx) -> Tag.preProcessParsed("""
Audience Instance Class: %s
MiniPlaceholders Instance Class: %s
""".formatted(
audience,
platformData.complementInstance()
)))
.relationalPlaceholder("test", (audience, relational, queue, ctx) -> Tag.preProcessParsed("""
Audience Instance Class: %s
Relational Instance Class: %s
Is Audience equals Relational? %s
MiniPlaceholders Instance Class: %s
""".formatted(
audience,
relational,
audience.equals(relational),
platformData.complementInstance()
)))
.version(ExpansionConstants.VERSION)
.build();
}
@Override
public LoadRequirement loadRequirement() {
return LoadRequirement.anyOf(
LoadRequirement.platform(Platform.SPONGE),
LoadRequirement.allOf(
LoadRequirement.requiredComplement(
"MiniPlaceholders",
"miniplaceholders"
),
LoadRequirement.platform(Platform.PAPER)
),
LoadRequirement.requiredClass("io.github.miniplaceholders.common.command.node.PlayerCompleterNode")
);
}
}
@@ -0,0 +1 @@
provider-class=io.miniplaceholders.provider.example.ExampleProvider
+54 -18
View File
@@ -1,24 +1,34 @@
import java.nio.file.Files
import java.nio.file.StandardCopyOption
import kotlin.io.path.deleteIfExists
plugins {
alias(libs.plugins.fabric.loom)
id("miniplaceholders.auto.module")
id("quiet-fabric-loom")
alias(libs.plugins.shadow)
}
repositories {
maven("https://central.sonatype.com/repository/maven-snapshots/") {
name = "sonatype-snapshots"
mavenContent {
snapshotsOnly()
}
}
maven("https://jitpack.io")
}
val shade: Configuration by configurations.creating
dependencies {
minecraft(libs.minecraft)
mappings(loom.officialMojangMappings())
modImplementation(libs.fabric.loader)
modImplementation(libs.fabric.api)
compileOnly(libs.fabric.loader)
compileOnly(libs.fabric.api)
includeDependency(libs.adventure.platform.fabric)
includeDependency(libs.adventure.serializer.legacy)
includeDependency(libs.adventure.minimessage)
includeDependency(libs.luckopermissionsapi)
includeDependency(libs.cloud.fabric)
includeDependency(libs.cloud.core)
includeDependency(libs.cloud.extras)
includeDependency(libs.unnamedinject)
includeDependency(libs.desertwell)
shadeModule(projects.miniplaceholdersApi)
@@ -27,33 +37,59 @@ dependencies {
}
fun DependencyHandlerScope.shadeModule(module: ProjectDependency) {
shade(module) {
implementation(module) {
isTransitive = false
}
implementation(module) {
include(module) {
isTransitive = false
}
}
fun DependencyHandlerScope.includeDependency(dependency: Any) {
modImplementation(dependency)
implementation(dependency)
include(dependency)
}
tasks {
val projectVersion = project.version
val rootDir = project.rootDir
processResources {
filteringCharset = Charsets.UTF_8.name()
filesMatching("fabric.mod.json") {
expand("version" to project.version)
expand("version" to projectVersion)
}
}
remapJar {
inputFile.set(shadowJar.get().archiveFile)
archiveFileName.set("MiniPlaceholders-Fabric-${project.version}.jar")
destinationDirectory.set(file("${project.rootDir}/jar"))
jar {
archiveFileName.set("MiniPlaceholders-Fabric-${projectVersion}.jar")
destinationDirectory.set(file("${rootDir}/jar"))
}
shadowJar {
configurations = listOf(shade)
// I know it's exactly the same logic for all modules,
// but for some reason in this module it only works
// if it's declared in the same project configuration
// and not with a plugin like with all other projects...
// ¯\_(ツ)_/¯
runServer {
val exampleExpansionProviderProject = project(":miniplaceholders-example-expansion-provider")
val exampleExpansionJarTask = exampleExpansionProviderProject.tasks.named<Jar>("jar")
dependsOn(exampleExpansionJarTask)
doFirst {
val expansionsDirectory = projectDir.resolve("run/config/miniplaceholders/expansions").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,121 +1,88 @@
package io.github.miniplaceholders.fabric;
import io.github.miniplaceholders.api.Expansion;
import io.github.miniplaceholders.common.PluginConstants;
import io.github.miniplaceholders.common.command.PlaceholdersCommand;
import com.mojang.brigadier.tree.LiteralCommandNode;
import io.github.miniplaceholders.common.PlaceholdersPlugin;
import io.github.miniplaceholders.common.command.brigadier.BrigadierCommandProvider;
import io.github.miniplaceholders.connect.InternalPlatform;
import me.lucko.fabric.api.permissions.v0.Permissions;
import net.fabricmc.api.ModInitializer;
import net.fabricmc.api.DedicatedServerModInitializer;
import net.fabricmc.fabric.api.command.v2.CommandRegistrationCallback;
import net.fabricmc.fabric.api.event.lifecycle.v1.ServerLifecycleEvents;
import net.fabricmc.loader.api.FabricLoader;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.minimessage.tag.Tag;
import net.kyori.adventure.text.logger.slf4j.ComponentLogger;
import net.kyori.adventure.util.TriState;
import net.minecraft.commands.CommandSourceStack;
import net.minecraft.server.MinecraftServer;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.server.packs.PackResources;
import net.minecraft.world.entity.Entity;
import org.incendo.cloud.SenderMapper;
import org.incendo.cloud.execution.ExecutionCoordinator;
import org.incendo.cloud.fabric.FabricServerCommandManager;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.text.DecimalFormat;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
public class FabricMod implements ModInitializer, PlaceholdersPlugin {
private final Logger logger = LoggerFactory.getLogger("miniplaceholders");
private static final DecimalFormat MSPT_FORMAT = new DecimalFormat("###.###");
public final class FabricMod implements DedicatedServerModInitializer, PlaceholdersPlugin {
private final ComponentLogger componentLogger = ComponentLogger.logger("miniplaceholders");
private MinecraftServer minecraftServer;
private final TickManager tickManager = new TickManager();
private MinecraftServer minecraftServer;
@Override
public void onInitializeServer() {
componentLogger.info("Starting MiniPlaceholders Fabric");
InternalPlatform.platform(InternalPlatform.FABRIC);
@Override
public void onInitialize() {
logger.info("Starting MiniPlaceholders Fabric");
InternalPlatform.platform(InternalPlatform.FABRIC);
ServerLifecycleEvents.SERVER_STARTING.register(minecraftServer -> {
this.minecraftServer = minecraftServer;
try {
final Path expansionsFolder = FabricLoader.getInstance().getConfigDir()
.resolve("miniplaceholders").resolve("expansions");
this.loadProvidedExpansions(expansionsFolder);
} catch (Throwable e) {
componentLogger.error("Unable to load expansion providers", e);
}
});
ServerLifecycleEvents.SERVER_STARTING.register(minecraftServer -> {
this.minecraftServer = minecraftServer;
this.loadDefaultExpansions();
});
this.registerPlatformCommand();
}
this.registerPlatformCommand();
}
@Override
public void registerPlatformCommand() {
final LiteralCommandNode<CommandSourceStack> node = BrigadierCommandProvider.provideCommand(
"miniplaceholders",
() -> new ArrayList<>(List.of(this.minecraftServer.getPlayerNames())),
string -> this.minecraftServer.getPlayerList().getPlayerByName(string),
aud -> aud,
(audience, permission) -> {
final CommandSourceStack commandSourceStack = (CommandSourceStack) audience;
return switch (Permissions.getPermissionValue(commandSourceStack, permission)) {
case TRUE -> TriState.TRUE;
case FALSE -> TriState.FALSE;
case DEFAULT -> commandSourceStack.permissions()
.hasPermission(net.minecraft.server.permissions.Permissions.COMMANDS_GAMEMASTER)
? TriState.TRUE : TriState.NOT_SET;
};
}
);
CommandRegistrationCallback.EVENT.register(
(dispatcher, ctx, selection) ->
dispatcher.getRoot().addChild(node)
);
}
@Override
public void loadDefaultExpansions() {
Expansion.builder("server")
.author("MiniPlaceholders Contributors")
.version(PluginConstants.VERSION)
.globalPlaceholder("name", Tag.preProcessParsed(this.minecraftServer.getServerModName()))
.globalPlaceholder("online", (queue, ctx) -> Tag.preProcessParsed(Integer.toString(this.minecraftServer.getPlayerCount())))
.globalPlaceholder("version", (ctx, queue) -> Tag.preProcessParsed(this.minecraftServer.getServerVersion()))
.globalPlaceholder("max_players", (ctx, queue) -> Tag.preProcessParsed(Integer.toString(this.minecraftServer.getMaxPlayers())))
.globalPlaceholder("unique_joins", (queue, ctx) -> {
final var profileCache = this.minecraftServer.getProfileCache();
if (profileCache == null) {
return Tag.preProcessParsed("0");
}
return Tag.preProcessParsed(Integer.toString(profileCache.load().size()));
})
.globalPlaceholder("tps_1m", (ctx, queue) -> Tag.preProcessParsed(tickManager.getTps1m().formattedAverage()))
.globalPlaceholder("tps_5m", (ctx, queue) -> Tag.preProcessParsed(tickManager.getTps5m().formattedAverage()))
//.globalPlaceholder("tps_15m", (ctx, queue) -> Tag.preProcessParsed(tickManager.getTps15m().formattedAverage()))
.globalPlaceholder("tick_count", (queue, ctx) -> Tag.preProcessParsed(Integer.toString(this.minecraftServer.getTickCount())))
.globalPlaceholder("has_whitelist", (queue, ctx) -> Tag.preProcessParsed(Boolean.toString(this.minecraftServer.getPlayerList().isUsingWhitelist())))
.globalPlaceholder("total_chunks", (queue, ctx) -> {
int chunks = 0;
for (final ServerLevel level : this.minecraftServer.getAllLevels()) {
chunks += level.getChunkSource().getLoadedChunksCount();
}
return Tag.preProcessParsed(Integer.toString(chunks));
})
.globalPlaceholder("total_entities", (queue, ctx) -> {
int entities = 0;
for (final ServerLevel level : this.minecraftServer.getAllLevels()) {
for (final Entity ignored : level.getAllEntities()) {
entities++;
}
}
return Tag.preProcessParsed(Integer.toString(entities));
})
.globalPlaceholder("mspt", (queue, ctx) -> Tag.preProcessParsed(MSPT_FORMAT.format(this.minecraftServer.getAverageTickTimeNanos())))
.globalPlaceholder("datapack_list", (queue, ctx) ->
Tag.selfClosingInserting(this.minecraftServer.getResourceManager()
.listPacks()
.map(PackResources::packId)
.map(id -> Component.text()
.content("[")
.append(Component.text(id))
.append(Component.text("]"))
.build())
.collect(Component.toComponent(Component.space())))
)
.globalPlaceholder("datapack_count", (queue, ctx) ->
Tag.preProcessParsed(Long.toString(this.minecraftServer.getResourceManager()
.listPacks()
.count()))
)
.build()
.register();
}
@Override
public boolean platformHasComplementLoaded(String complementName) {
return FabricLoader.getInstance().isModLoaded(complementName);
}
@Override
public void registerPlatformCommand() {
final FabricServerCommandManager<CommandSourceStack> commandManager = new FabricServerCommandManager<>(
ExecutionCoordinator.simpleCoordinator(),
SenderMapper.identity()
);
PlaceholdersCommand.<CommandSourceStack>builder()
.hasPermissionCheck((source, permission) -> Permissions.check(source, permission, 4))
.toAudience(string -> this.minecraftServer.getPlayerList().getPlayerByName(string))
.playerSuggestions(() -> new ArrayList<>(List.of(this.minecraftServer.getPlayerNames())))
.manager(commandManager)
.command("miniplaceholders")
.build()
.register();
}
@Override
public void logError(Component component) {
componentLogger.error(component);
}
@Override
public void logInfo(Component component) {
componentLogger.info(component);
}
@Override
public Object platformServerInstance() {
return this.minecraftServer;
}
}
@@ -1,59 +0,0 @@
package io.github.miniplaceholders.fabric;
import java.math.BigDecimal;
import java.math.RoundingMode;
import java.text.DecimalFormat;
/**
* Based on the MIT licensed Paper-Server patch "Further improve server tick loop".
*
* @author Daniel Ennis/Aikar
*/
final class RollingAverage {
private static final DecimalFormat TPS_FORMAT = new DecimalFormat("###.##");
static { TPS_FORMAT.setRoundingMode(RoundingMode.HALF_UP); }
private static final int TPS = 20;
private static final long SEC_IN_NANO = 1000000000;
private final int size;
private final BigDecimal[] samples;
private final long[] times;
private long time;
private BigDecimal total;
private int index = 0;
RollingAverage(final int size) {
this.size = size;
this.samples = new BigDecimal[size];
this.times = new long[size];
this.time = size * SEC_IN_NANO;
this.total = dec(TPS).multiply(dec(SEC_IN_NANO)).multiply(dec(size));
for (int i = 0; i < size; i++) {
this.samples[i] = dec(TPS);
this.times[i] = SEC_IN_NANO;
}
}
private static BigDecimal dec(final long t) {
return new BigDecimal(t);
}
void add(final BigDecimal x, final long t) {
this.time -= this.times[this.index];
this.total = this.total.subtract(this.samples[this.index].multiply(dec(this.times[this.index])));
this.samples[this.index] = x;
this.times[this.index] = t;
this.time += t;
this.total = this.total.add(x.multiply(dec(t)));
if (++this.index == this.size) {
this.index = 0;
}
}
double average() {
return this.total.divide(dec(this.time), 30, RoundingMode.HALF_UP).doubleValue();
}
String formattedAverage() {
return TPS_FORMAT.format(average());
}
}
@@ -1,45 +0,0 @@
package io.github.miniplaceholders.fabric;
import net.fabricmc.fabric.api.event.lifecycle.v1.ServerTickEvents;
import java.math.BigDecimal;
import java.math.RoundingMode;
final class TickManager {
private static final int TICK_DURATION = 20;
private static final BigDecimal TPS_BASE = new BigDecimal("1E9").multiply(new BigDecimal(TICK_DURATION));
private final RollingAverage tps1m = new RollingAverage(60);
private final RollingAverage tps5m = new RollingAverage(60 * 5);
private final RollingAverage tps15m = new RollingAverage(60 * 15);
private long lastStartTick = 0;
private long lastEndTick = 0;
TickManager() {
ServerTickEvents.START_SERVER_TICK.register(server -> this.lastStartTick = System.nanoTime());
ServerTickEvents.END_SERVER_TICK.register(server -> {
if (server.getTickCount() % TICK_DURATION == 0) {
final long diff = lastStartTick - lastEndTick;
final BigDecimal currentTps = TPS_BASE.divide(new BigDecimal(diff), 30, RoundingMode.HALF_UP);
this.tps1m.add(currentTps, diff);
this.tps5m.add(currentTps, diff);
this.tps15m.add(currentTps, diff);
this.lastEndTick = System.nanoTime();
}
});
}
public RollingAverage getTps1m() {
return tps1m;
}
public RollingAverage getTps5m() {
return tps5m;
}
public RollingAverage getTps15m() {
return tps15m;
}
}
+9 -10
View File
@@ -3,29 +3,28 @@
"id": "miniplaceholders",
"version": "${version}",
"name": "MiniPlaceholders",
"description": "MiniMessage Component-based Placeholders for Paper, Fabric, Sponge, Folia and Velocity platforms",
"description": "MiniMessage Component-based Placeholders API",
"authors": [
"4drian3d"
],
"contact": {
"homepage": "https://github.com/MiniPlaceholders/MiniPlaceholders",
"homepage": "https://miniplaceholders.github.io/",
"sources": "https://github.com/MiniPlaceholders/MiniPlaceholders",
"issues": "https://github.com/MiniPlaceholders/MiniPlaceholders/issues"
},
"license": "Apache-2",
"environment": "server",
"entrypoints": {
"main": [
"server": [
"io.github.miniplaceholders.fabric.FabricMod"
]
},
"depends": {
"fabricloader": ">=0.14.19",
"fabric": "*",
"java": ">=21",
"cloud": "*",
"adventure-platform-fabric": "*",
"minecraft": ">=1.21.4",
"fabric-permissions-api-v0": "*"
"fabricloader": ">=0.18.0",
"fabric-api": "*",
"java": ">=25",
"adventure-platform-fabric": ">6.8.0",
"minecraft": ">=26.1",
"fabric-permissions-api-v0": ">=0.7.0"
}
}
+4 -3
View File
@@ -1,7 +1,8 @@
group = io.github.miniplaceholders
version = 2.3.0
description = MiniMessage Component-based Placeholders for Paper, Fabric, Sponge, Folia and Velocity platforms
version = 3.2.0
description = MiniMessage Component-based Placeholders API
org.gradle.jvmargs=-Xmx2G
org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true
org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true
#org.gradle.configuration-cache=true
+47 -35
View File
@@ -2,63 +2,75 @@ metadata.format.version = "1.1"
[versions]
velocity = "3.4.0-SNAPSHOT"
paper = "1.21.4-R0.1-SNAPSHOT"
minecraft = "1.21.4"
runtask = "2.3.1"
blossom = "2.1.0"
shadow = "9.0.0-beta4"
jmh = "0.7.3"
dokka = "2.0.0"
cloud = "2.0.0"
cloud-minecraft = "2.0.0-SNAPSHOT"
cloud-minecraft-modded = "2.0.0-beta.10"
adventure = "4.19.0"
adventureModded = "6.2.0"
kotlin = "2.1.10"
fabric-api = "0.114.3+1.21.5"
fabric-loader = "0.16.10"
# Platform
minecraft = "26.1"
paper = "1.21.11-R0.1-SNAPSHOT"
velocity = "3.5.0-SNAPSHOT"
minestom = "2026.03.03-1.21.11"
fabric-loader = "0.18.5"
fabric-api = "0.144.3+26.1"
# Libraries
kotlin = "2.3.20"
adventure = "4.26.1"
adventureModded = "6.9.0-SNAPSHOT"
desertwell = "2.0.4"
bstats = "3.2.1"
jspecify = "1.0.0"
# Gradle Plugins
runtask = "3.0.2"
blossom = "2.2.0"
shadow = "9.4.0"
jmh = "0.7.3"
dokka = "2.2.0"
[libraries]
velocity = { group = "com.velocitypowered", name = "velocity-api", version.ref = "velocity" }
paper = { group = "io.papermc.paper", name = "paper-api", version.ref = "paper" }
# Platforms
minecraft = { group = "com.mojang", name = "minecraft", version.ref = "minecraft" }
fabric-api = { group = "net.fabricmc.fabric-api", name = "fabric-api", version.ref = "fabric-api" }
paper = { group = "io.papermc.paper", name = "paper-api", version.ref = "paper" }
velocity = { group = "com.velocitypowered", name = "velocity-api", version.ref = "velocity" }
minestom = { group = "net.minestom", name = "minestom", version.ref = "minestom" }
fabric-loader = { group = "net.fabricmc", name = "fabric-loader", version.ref = "fabric-loader" }
luckopermissionsapi = { group = "me.lucko", name = "fabric-permissions-api", version = "0.3.3" }
fabric-api = { group = "net.fabricmc.fabric-api", name = "fabric-api", version.ref = "fabric-api" }
# Adventure
adventure-api = { group = "net.kyori", name = "adventure-api", version.ref = "adventure" }
adventure-minimessage = { group = "net.kyori", name = "adventure-text-minimessage", version.ref = "adventure" }
adventure-platform-fabric = { group = "net.kyori", name = "adventure-platform-fabric", version.ref = "adventureModded" }
adventure-serializer-legacy = { group = "net.kyori", name = "adventure-text-serializer-legacy", version.ref = "adventure" }
adventure-serializer-plain = { group = "net.kyori", name = "adventure-text-serializer-plain", version.ref = "adventure" }
cloud-core = { group = "org.incendo", name = "cloud-core", version.ref = "cloud" }
cloud-velocity = { group = "org.incendo", name = "cloud-velocity", version.ref = "cloud-minecraft" }
cloud-paper = { group = "org.incendo", name = "cloud-paper", version.ref = "cloud-minecraft" }
cloud-fabric = { group = "org.incendo", name = "cloud-fabric", version.ref = "cloud-minecraft-modded" }
cloud-extras = { group = "org.incendo", name = "cloud-minecraft-extras", version.ref = "cloud-minecraft" }
# Build-Logic Gradle Plugins
plugin-shadow = { module = "com.gradleup.shadow:shadow-gradle-plugin", version.ref = "shadow" }
plugin-kotlin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
plugin-dokka = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "dokka" }
plugin-kotlin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
plugin-runtask = { module = "xyz.jpenilla.run-velocity:xyz.jpenilla.run-velocity.gradle.plugin", version.ref = "runtask" }
# Libraries
desertwell = { group = "net.william278", name = "DesertWell", version.ref = "desertwell" }
junit-bom = "org.junit:junit-bom:6.0.3"
jspecify = { module = "org.jspecify:jspecify", version.ref = "jspecify" }
luckopermissionsapi = { group = "me.lucko", name = "fabric-permissions-api", version = "0.7.0" }
unnamedinject = "team.unnamed:inject:2.0.1"
brigadier = "com.mojang:brigadier:1.0.500"
junit-bom = "org.junit:junit-bom:5.12.0"
# Bstats
bstats-core = { group = "org.bstats", name = "bstats-base", version.ref = "bstats" }
bstats-velocity = { group = "org.bstats", name = "bstats-velocity", version.ref = "bstats" }
bstats-sponge = { group = "org.bstats", name = "bstats-sponge", version.ref = "bstats" }
bstats-bukkit = { group = "org.bstats", name = "bstats-bukkit", version.ref = "bstats" }
[plugins]
# Platform Plugins
runpaper = { id = "xyz.jpenilla.run-paper", version.ref = "runtask" }
runvelocity = { id = "xyz.jpenilla.run-velocity", version.ref = "runtask" }
fabric-loom = { id = "net.fabricmc.fabric-loom", version = "1.15.5"}
spongegradle = { id = "org.spongepowered.gradle.plugin", version = "2.3.0" }
# General Plugins
blossom = { id = "net.kyori.blossom", version.ref = "blossom" }
shadow = { id = "com.gradleup.shadow", version.ref = "shadow" }
jmh = { id = "me.champeau.jmh", version.ref = "jmh" }
idea-ext = { id = "org.jetbrains.gradle.plugin.idea-ext", version = "1.1.10" }
dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
idea-ext = { id = "org.jetbrains.gradle.plugin.idea-ext", version = "1.4.1" }
Binary file not shown.
+1 -1
View File
@@ -1,6 +1,6 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.12.1-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-9.4.1-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
Vendored
+4 -7
View File
@@ -1,7 +1,7 @@
#!/bin/sh
#
# Copyright © 2015-2021 the original authors.
# Copyright © 2015 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -57,7 +57,7 @@
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# https://github.com/gradle/gradle/blob/2d6327017519d23b96af35865dc997fcb544fb40/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
@@ -114,7 +114,6 @@ case "$( uname )" in #(
NONSTOP* ) nonstop=true ;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
@@ -172,7 +171,6 @@ fi
# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
JAVACMD=$( cygpath --unix "$JAVACMD" )
@@ -205,15 +203,14 @@ fi
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Collect all arguments for the java command:
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
# and any embedded shellness will be escaped.
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
# treated as '${Hostname}' itself on the command line.
set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-classpath "$CLASSPATH" \
org.gradle.wrapper.GradleWrapperMain \
-jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
"$@"
# Stop when "xargs" is not available.
Vendored
+1 -2
View File
@@ -70,11 +70,10 @@ goto fail
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
:end
@rem End local scope for the variables with windows NT shell
+68 -3
View File
@@ -1,19 +1,84 @@
import com.vanniktech.maven.publish.KotlinJvm
import com.vanniktech.maven.publish.JavadocJar
import com.vanniktech.maven.publish.SourcesJar
import java.time.LocalDate
plugins {
kotlin("jvm")
id("miniplaceholders.kotlin.publish")
id("com.vanniktech.maven.publish")
alias(libs.plugins.dokka)
}
dependencies {
compileOnly(kotlin("stdlib"))
compileOnly(libs.adventure.api)
compileOnly(libs.adventure.minimessage)
compileOnlyApi(projects.miniplaceholdersApi)
compileOnly(projects.miniplaceholdersApi)
}
kotlin {
explicitApi()
jvmToolchain {
languageVersion.set(JavaLanguageVersion.of(21))
languageVersion.set(JavaLanguageVersion.of(25))
}
}
dokka {
dokkaSourceSets.main {
includes.from("README.md")
sourceLink {
localDirectory.set(rootDir)
remoteUrl("https://github.com/MiniPlaceholders/MiniPlaceholders/tree/main")
remoteLineSuffix.set("#L")
}
}
pluginsConfiguration.html {
footerMessage.set("(c) MiniPlaceholders | 4drian3d")
}
}
mavenPublishing {
publishToMavenCentral()
signAllPublications()
coordinates(project.group as String, "miniplaceholders-kotlin-ext", project.version as String)
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")
}
}
configure(KotlinJvm(
javadocJar = JavadocJar.Dokka("dokkaGeneratePublicationHtml"),
sourcesJar = SourcesJar.Sources(),
))
}
@@ -1,6 +1,11 @@
package io.github.miniplaceholders.kotlin
import io.github.miniplaceholders.api.Expansion
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.minimessage.tag.Tag
/**
* Create a new Expansion
@@ -12,5 +17,23 @@ import io.github.miniplaceholders.api.Expansion
* @see Expansion.builder
* @see Expansion.Builder.build
* */
public fun expansion(name: String, builder: Expansion.Builder.() -> Expansion.Builder): Expansion
= builder(Expansion.builder(name)).build()
public fun expansion(name: String, builder: Expansion.Builder.() -> Expansion.Builder): Expansion =
builder(Expansion.builder(name)).build()
public fun Expansion.Builder.global(placeholderName: String, resolver: GlobalTagResolver): Expansion.Builder =
this.globalPlaceholder(placeholderName, resolver)
public fun Expansion.Builder.global(placeholderName: String, tag: Tag): Expansion.Builder =
this.globalPlaceholder(placeholderName, tag)
public inline fun <reified A : Audience> Expansion.Builder.audience(
placeholderName: String,
resolver: AudienceTagResolver<A>
): Expansion.Builder =
this.audiencePlaceholder(A::class.java, placeholderName, resolver)
public inline fun <reified A : Audience> Expansion.Builder.relational(
placeholderName: String,
resolver: RelationalTagResolver<A>
): Expansion.Builder =
this.relationalPlaceholder(A::class.java, placeholderName, resolver)
@@ -0,0 +1,14 @@
package io.github.miniplaceholders.kotlin
import io.github.miniplaceholders.api.utils.LegacyStrings
import net.kyori.adventure.text.Component
import net.kyori.adventure.text.minimessage.Context
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver
public fun String.hasLegacyFormat() : Boolean = LegacyStrings.hasLegacyFormat(this)
public fun String.parsePossibleLegacy(resolver: TagResolver = TagResolver.empty()) : Component =
LegacyStrings.parsePossibleLegacy(this, resolver)
public fun String.parsePossibleLegacy(context: Context) : Component =
LegacyStrings.parsePossibleLegacy(this, context)
Loaded 100 of 117 files, more files were not shown because too many files have changed in this diff. Show more