You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/developer-guide/Developer-Getting-Started.mdx
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,5 @@
1
1
---
2
+
title: Getting Started
2
3
sidebar_label: 'Getting Started'
3
4
sidebar_position: 1
4
5
---
@@ -56,7 +57,7 @@ If you want a template to create your next expansion, you can use our template h
56
57
57
58
Kotlin Extra is an API submodule that makes it easy to develop Expansions in Kotlin environments.
58
59
59
-
It can only be used in environments that provide kotlin-stdlib, such as Krypton, Fabric with [Fabric Language Kotlin](https://modrinth.com/mod/fabric-language-kotlin), or with plugins that provide it, such as [MCKotlin](https://modrinth.com/plugin/mckotlin)
60
+
It can only be used in environments that provide kotlin-stdlib, such as Fabric with [Fabric Language Kotlin](https://modrinth.com/mod/fabric-language-kotlin), or with plugins that provide it, such as [MCKotlin](https://modrinth.com/plugin/mckotlin)
Starting with MiniPlaceholders v3, the returned TagResolvers do not depend on an Audience or a RelationalAudience. This was done to modernize the API, improve placeholder processing performance, and avoid potential issues when caching TagResolvers.
Copy file name to clipboardExpand all lines: docs/developer-guide/MiniMessage-API-in-MiniPlaceholders.md
+14-7Lines changed: 14 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,27 @@
1
1
---
2
+
title: MiniMessage API Usage
2
3
sidebar_label: 'MiniMessage Integration'
3
4
sidebar_position: 5
4
5
---
5
6
6
7
MiniPlaceholders is a plugin that is completely based on the MiniMessage API. Therefore, to get the placeholders and to create expansions you need to have a basic knowledge.
7
8
Here I will try to explain you in the best way how these APIs are related.
8
9
9
-
# Obtaining Placeholders
10
-
--- TODO ---
10
+
## TagResolver
11
+
12
+
When you obtain the placeholders of a respective type, you will get an object of the TagResolver type. This object is capable of providing a Tag from a text or null if it does not correspond.
finalComponent component = miniMessage.deserialize("some string with placeholders", resolver);
18
23
```
19
24
20
-
# Creating an expansion
21
-
22
25
## Tags
23
26
24
27
A Tag is an object to be inserted in the final component resulting from the parse of a TagResolver. This object determines how it will be inserted and how it will relate to other placeholders. There are several types of Tags that allow you to either directly insert a component without affecting other placeholders, or allow the result to be used as an argument in other placeholders.
@@ -52,15 +55,16 @@ This tag inserts a component and passes its attributes to the other characters u
The ArgumentQueue object allows you to get the arguments of the placeholder. The player can enter as many arguments as he wants, but you have the ability to specify whether a specific number of arguments is required.
Allows you to preview how text would be displayed to the player by applying global and audience placeholders, providing the specific audience. If the “me” argument is used, the audience provided will be the executor of the command, whether it is an OP player or the console, and if the name of a connected player is used, that player will be used in the context.
24
+
25
+
### Expansions SubCommand
26
+
27
+
-`/miniplaceholders expansions`
28
+
29
+
Allows you to review currently installed expansions and their information.
30
+
31
+
### Help SubCommand
32
+
33
+
-`/miniplaceholders expansions`
34
+
35
+
It shows you all the available subcommands and how to use them.
Copy file name to clipboardExpand all lines: docs/user-guide/User-Getting-Started.md
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,6 @@ title: Getting Started
6
6
7
7
MiniPlaceholders is a plugin and mod that will allow you to use placeholders that various plugins/mods provide in various plugins/mods. These placeholders can contain text and colors, as well as click events, hovers, translatable messages, formatted messages, gradients and many more options.
8
8
9
-
To use MiniPlaceholders, you need at least [Paper 1.21+](https://papermc.io/downloads/paper), Folia, [Velocity 3.3+](https://papermc.io/downloads/velocity), [Fabric 1.21.1+](https://fabricmc.net/) or [Sponge](https://spongepowered.org/) API 12+.
10
-
11
-
It also requires a Java 21 version.
9
+
To use MiniPlaceholders, you need at least [Paper 1.21+](https://papermc.io/downloads/paper), Folia, [Velocity 3.3+](https://papermc.io/downloads/velocity), [Fabric 1.21.6+](https://fabricmc.net/) or [Sponge](https://spongepowered.org/) API 12+.
0 commit comments