Skip to content

Commit 9b111c0

Browse files
committed
feat: Reworked commands docs and added title to many pages
1 parent bf77013 commit 9b111c0

10 files changed

+99
-58
lines changed

docs/developer-guide/Developer-Fabric-Setup.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
title: Mod Development
23
sidebar_label: 'Mod Development'
34
sidebar_position: 6
45
---

docs/developer-guide/Developer-Getting-Started.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
title: Getting Started
23
sidebar_label: 'Getting Started'
34
sidebar_position: 1
45
---
@@ -56,7 +57,7 @@ If you want a template to create your next expansion, you can use our template h
5657

5758
Kotlin Extra is an API submodule that makes it easy to develop Expansions in Kotlin environments.
5859

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)
6061

6162

6263
<Tabs groupId="build-system">

docs/developer-guide/Expansion-Creation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
title: Expansion Creation
23
sidebar_label: 'Expansion Creation'
34
sidebar_position: 2
45
---

docs/developer-guide/Expansion-Providers.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
title: Expansion Provider
23
sidebar_label: 'Expansion Providers'
34
sidebar_position: 4
45
---

docs/developer-guide/Integration.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@ sidebar_label: 'Project Integration'
33
sidebar_position: 3
44
---
55

6+
This guide will teach you how to use the MiniPlaceholders API in your plugins or mods to parse placeholders from other projects.
7+
68
## Obtaining Placeholders
79

8-
You can get the required plugin placeholders whenever you want, from the methods located in the main `MiniPlaceholders` class
10+
You can get the required plugin/mod placeholders whenever you want, from the methods located in the main `MiniPlaceholders` class
911

1012
### Global
1113

@@ -15,7 +17,7 @@ TagResolver resolver = MiniPlaceholders.globalPlaceholders();
1517
Component parsedMessage = MiniMessage.miniMessage().deserialize("Online Players: <proxy_online_players>", resolver);
1618
```
1719

18-
::: note
20+
:::note
1921

2022
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.
2123

docs/developer-guide/MiniMessage-API-in-MiniPlaceholders.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
11
---
2+
title: MiniMessage API Usage
23
sidebar_label: 'MiniMessage Integration'
34
sidebar_position: 5
45
---
56

67
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.
78
Here I will try to explain you in the best way how these APIs are related.
89

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.
13+
1114
```java
1215
final TagResolver resolver = MiniPlaceholders.globalPlaceholders();
1316
```
1417

18+
It is recommended not to use TagResolver directly, but to delegate its use to MiniMessage parsing as appropriate.
19+
1520
```java
1621
final MiniMessage miniMessage = MiniMessage.miniMessage();
1722
final Component component = miniMessage.deserialize("some string with placeholders", resolver);
1823
```
1924

20-
# Creating an expansion
21-
2225
## Tags
2326

2427
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
5255
```java
5356
return Tag.inserting(Component.text("Hi", NamedTextColor.RED));
5457
```
55-
56-
#### Desired Usage
58+
:::note[Recommended Usage]
5759

5860
```java
5961
// In this example, the placeholder player_prefix would use an inserting tag,
6062
// which would inherit the formatting to the following characters until a <reset> is done or the </player_prefix> tag is closed
6163
String string = "<player_prefix><player_name><gray>:<reset> <message>"
6264
```
6365

66+
:::
67+
6468
### Styling
6569

6670
This tag applies formatting to the following characters until it is closed
@@ -69,12 +73,15 @@ This tag applies formatting to the following characters until it is closed
6973
return Tag.styling(NamedTextColor.AQUA);
7074
```
7175

72-
#### Desired Usage
76+
77+
:::note[Recommended Usage]
7378

7479
```java
7580
String string = "<player_prefix><player_name><gray>: <player_chat_color><message>";
7681
```
7782

83+
:::
84+
7885
## ArgumentQueue
7986

8087
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.

docs/user-guide/Commands.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,31 @@ sidebar_position: 3
55

66
In MiniPlaceholders you are provided with a command in each platform to get the plugin information and to be able to parse the placeholders directly
77

8-
In Paper, Folia, Fabric and Krypton the command is `/miniplaceholders` and in Velocity the command is `/vminiplaceholders`
8+
In Paper, Folia, Fabric and Sponge the command is `/miniplaceholders` and in Velocity the command is `/vminiplaceholders`
99

1010
## Commands
1111

12-
- `/miniplaceholders <parse|help> player [some-player] "[message with placeholders]`
13-
- `/miniplaceholders parse player [some-player] "[message with placeholders]"`
12+
### Main Command
1413

15-
#### Examples
14+
- `/miniplaceholders`
1615

17-
- `/miniplaceholders parse me "<player_xp>"`
18-
- `/vminiplaceholders parse player 4drian3d "<player_name>"`
16+
Displays plugin information, such as the version, contributors, and links of interest.
17+
18+
### Parse SubCommand
19+
20+
- `/miniplaceholders parse me [message]`
21+
- `/miniplaceholders parse [some player] [message]`
22+
23+
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.

docs/user-guide/Placeholders.md

Lines changed: 49 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -104,14 +104,14 @@ MiniPlaceholders v3 was recently released, and several of the expansions shown h
104104
:::note[Built-in expansion]
105105
:::
106106

107-
[Wiki](https://github.com/4drian3d/AuthmeVelocity)
108-
109107
```
110108
<authme_is_logged>
111109
<authme_is_player_logger:[player name]>
112110
```
113111

114-
## [AFKPlus](https://github.com/NotAlexNoyle/MiniPlaceholders-AFKPlus)
112+
## [AFKPlus](https://www.spigotmc.org/resources/afk.35065/)
113+
114+
[Expansion Download](https://github.com/NotAlexNoyle/MiniPlaceholders-AFKPlus)
115115

116116
```
117117
<afkplus_status>
@@ -172,19 +172,40 @@ MiniPlaceholders v3 was recently released, and several of the expansions shown h
172172
<chatregulator_infractions_count:[infraction type]>
173173
```
174174

175-
## Chunky
175+
## [Chunky](https://modrinth.com/plugin/chunky)
176176

177-
[Chunky Download](https://modrinth.com/plugin/chunky)
177+
[Expansion Download](https://github.com/MiniPlaceholders/Chunky-Expansion)
178178

179-
[Wiki](https://modrinth.com/plugin/miniplaceholders-chunky-expansion)
179+
```
180+
<chunky_task_pregen_exists:<world>>
181+
<chunky_task_pregen_running:<world>>
182+
<chunky_task_pregen_cancelled:<world>>
183+
<chunky_task_pregen_centerx:<world>>
184+
<chunky_task_pregen_centerz:<world>>
185+
<chunky_task_pregen_radiusz:<world>>
186+
<chunky_task_pregen_radiusx:<world>>
187+
<chunky_task_pregen_radius:<world>>
188+
<chunky_task_pregen_count:<world>>
189+
<chunky_task_pregen_pattern:<world>>
190+
<chunky_task_pregen_shape:<world>>
191+
<chunky_task_pregen_time:<world>>
192+
<chunky_task_pregen_world:<world>>
193+
<chunky_task_pregen_chunks:<world>>
194+
<chunky_task_pregen_complete:<world>>
195+
<chunky_task_pregen_percent:<world>>
196+
<chunky_task_pregen_hours:<world>>
197+
<chunky_task_pregen_minutes:<world>>
198+
<chunky_task_pregen_seconds:<world>>
199+
<chunky_task_pregen_rate:<world>>
200+
<chunky_task_pregen_x:<world>>
201+
<chunky_task_pregen_z:<world>>
202+
```
180203

181204
## [ClientCatcher](https://modrinth.com/plugin/clientcatcher)
182205

183206
:::note[Built-in expansion]
184207
:::
185208

186-
[Wiki](https://modrinth.com/plugin/clientcatcher)
187-
188209
```
189210
<clientcatcher_client>
190211
<clientcatcher_mods>
@@ -197,17 +218,13 @@ MiniPlaceholders v3 was recently released, and several of the expansions shown h
197218
:::note[Built-in expansion]
198219
:::
199220

200-
[Wiki](https://modrinth.com/plugin/creative-faces)
201-
202221
```
203222
<faces_player>
204223
```
205224

206-
## Cobblemon
207-
208-
[Cobblemon Download](https://modrinth.com/mod/cobblemon)
225+
## [Cobblemon](https://modrinth.com/mod/cobblemon)
209226

210-
[Cobblemon Expansion Download](https://modrinth.com/mod/cobblemonplaceholders)
227+
[Expansion Download](https://modrinth.com/mod/cobblemonplaceholders)
211228

212229
[Wiki](https://github.com/PokeSkies/CobblemonPlaceholders/wiki/Placeholders)
213230

@@ -235,9 +252,7 @@ MiniPlaceholders v3 was recently released, and several of the expansions shown h
235252
<epicguard_connections_per_second>
236253
```
237254

238-
## Floodgate
239-
240-
[Floodgate Download](https://geysermc.org/download)
255+
## [Floodgate](https://geysermc.org/wiki/floodgate/)
241256

242257
[Expansion Download](https://github.com/MiniPlaceholders/Floodgate-Expansion/releases)
243258

@@ -248,8 +263,6 @@ MiniPlaceholders v3 was recently released, and several of the expansions shown h
248263
:::note[STANDALONE EXPANSION]
249264
:::
250265

251-
[Expansion Download]
252-
253266
[Wiki](https://github.com/MiniPlaceholders/ItemDisplay)
254267

255268
<table>
@@ -267,17 +280,13 @@ MiniPlaceholders v3 was recently released, and several of the expansions shown h
267280
</tr>
268281
</table>
269282

270-
## Insights
271-
272-
[Insights Download](https://modrinth.com/plugin/insights)
283+
## [Insights](https://modrinth.com/plugin/insights)
273284

274285
[Expansion Download](https://github.com/MiniPlaceholders/Insights-Expansion/releases)
275286

276287
[Wiki](https://github.com/MiniPlaceholders/Insights-Expansion)
277288

278-
## Impactor
279-
280-
[Impactor Download](https://modrinth.com/mod/impactor)
289+
## [Impactor](https://modrinth.com/mod/impactor)
281290

282291
[ImpactorPlaceholders Download](https://github.com/PokeSkies/ImpactorPlaceholders)
283292

@@ -305,9 +314,7 @@ MiniPlaceholders v3 was recently released, and several of the expansions shown h
305314
<libsdisguises_player_disguise_name>
306315
```
307316

308-
## LuckPerms
309-
310-
[LuckPerms Download](https://luckperms.net/)
317+
## [LuckPerms](https://luckperms.net/)
311318

312319
[Expansion Download](https://github.com/MiniPlaceholders/LuckPerms-Expansion/releases)
313320

@@ -531,9 +538,7 @@ MiniPlaceholders v3 was recently released, and several of the expansions shown h
531538
<simplyrank_primary_rank>
532539
```
533540

534-
## Spark
535-
536-
[Spark Download](https://spark.lucko.me/)
541+
## [Spark](https://spark.lucko.me/)
537542

538543
[Expansion Download](https://github.com/MiniPlaceholders/Spark-Expansion/releases)
539544

@@ -626,17 +631,23 @@ MiniPlaceholders v3 was recently released, and several of the expansions shown h
626631
<unemoji_emoji:[id]>
627632
```
628633

629-
## Vault
630-
631-
[Vault Download](https://www.spigotmc.org/resources/vault.34315/)
634+
## [Vault](https://www.spigotmc.org/resources/vault.34315/)
632635

633636
[Expansion Download](https://github.com/MiniPlaceholders/Vault-Expansion)
634637

635-
[Wiki](https://github.com/MiniPlaceholders/Vault-Expansion)
636-
637-
## ViaVersion
638+
```
639+
<vault_prefix>
640+
<vault_suffix>
641+
<vault_has_permission:[permission]>
642+
<vault_group>
643+
<vault_groups>
644+
<vault_group_prefix>
645+
<vault_group_suffix>
646+
<vault_in_group:[group]>
647+
<vault_in_primary_group:[group]>
648+
```
638649

639-
[ViaVersion Download](https://modrinth.com/plugin/viaversion)
650+
## [ViaVersion](https://hangar.papermc.io/ViaVersion/ViaVersion)
640651

641652
[Expansion Download](https://github.com/MiniPlaceholders/ViaVersion-Expansion)
642653

docs/user-guide/Projects-using-MiniPlaceholders-API.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
sidebar_label: 'MiniPlaceholders Compatible Projects'
2+
title: Compatible Projects
3+
sidebar_label: 'Compatible Projects'
34
sidebar_position: 4
45
---
56

docs/user-guide/User-Getting-Started.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ title: Getting Started
66

77
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.
88

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+.
1210

11+
It also requires Java 21 or higher.

0 commit comments

Comments
 (0)