Skip to content

Commit d135251

Browse files
committed
Finished platforms
1 parent 2afd468 commit d135251

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

docs/Imperat/Supported-Platforms.md

+23-5
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,31 @@ Imperat is a generic command dispatching framework, It can work almost on every
1010
so to depend on any of the platforms you must first declare our repoistory in your build tool configuration file as follows:
1111
<Tabs>
1212
<TabItem value="maven" label="Maven pom.xml" default>
13-
MAVEN REPO
13+
Maven central (default)
1414
</TabItem>
1515

1616
<TabItem value="gradle" label="Gradle build.gradle">
17-
GRADLE REPO
17+
repositories {
18+
mavenCentral();
19+
}
1820
</TabItem>
1921
</Tabs>
2022

2123
In order to add the dependency of any platform, you should first add the dependency of the core module, then add the
2224
platform's dependency as below:
2325
<Tabs>
2426
<TabItem value="maven" label="Maven" default>
25-
MAVEN DEPENDENCIES
27+
28+
<dependency>
29+
<groupId>dev.velix</groupId>
30+
<artifactId>imperat-PLATFORM</artifactId>
31+
<version>VERSION</version>
32+
</dependency>
33+
2634
</TabItem>
2735

28-
<TabItem value="gradle" label="Gradle">
29-
GRADLE DEPENDENCIES
36+
<TabItem value="gradle" label="Gradle (short)">
37+
implementation "dev.velix:imperat-PLATFORM:VERSION"
3038
</TabItem>
3139
</Tabs>
3240

@@ -39,6 +47,15 @@ Imperat currently has implementations for the current minecraft-related platform
3947
- Bukkit/Spigot/Paper
4048
- Bungeecord
4149

50+
:::tip[Pro Tip]
51+
You can use and integrate Imperat with Mojang's Brigadier
52+
you can do the following after initializing Imperat and BEFORE registering any commands.
53+
```java
54+
imperat.applyBrigadier();
55+
```
56+
57+
:::
58+
4259
### Bukkit
4360
The `BukkitImperat` is the impl for Imperat on bukkit platform.
4461
The command source in bukkit is called `BukkitSource`.
@@ -50,6 +67,7 @@ You are free to make use of them.
5067
### Bungee
5168
SAME AS BUKKIT but the prefix is `Bungee`
5269

70+
5371
## Other platforms
5472
Coming soon...
5573

0 commit comments

Comments
 (0)