Skip to content
This repository was archived by the owner on Oct 2, 2024. It is now read-only.

Commit ce65329

Browse files
committed
WiP
1 parent eb194c9 commit ce65329

File tree

5 files changed

+82
-9
lines changed

5 files changed

+82
-9
lines changed

Writerside/litecommands.tree

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
<toc-element topic="Introdution.md">
1010
<toc-element topic="Why-use-LiteCommands.md"/>
11+
<toc-element topic="Getting-started.md"/>
1112
</toc-element>
1213
<toc-element topic="Platforms.md"/>
1314
</instance-profile>

Writerside/topics/Getting-started.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Getting started
2+
3+
This page will help you to get started with LiteCommands.
4+
5+
## Requirements
6+
7+
Please make sure that you have the following requirements before you start:
8+
9+
- Java 8 or higher
10+
- Dependency manager as [Gradle](https://gradle.org/) or [Maven](https://maven.apache.org/)
11+
12+
## Installation
13+
14+
Setup your project with one of the following artifacts:
15+
16+
<tabs>
17+
<tab title="Gradle KTS">
18+
19+
```kotlin
20+
implementation("dev.rollczi:[[[ARTIFACT_ID|Platforms.md]]]:3.0.1")
21+
```
22+
</tab>
23+
24+
<tab title="Maven">
25+
26+
```xml
27+
<dependency>
28+
<groupId>dev.rollczi</groupId>
29+
<artifactId>[[[ARTIFACT_ID|Platforms.md]]]</artifactId>
30+
<version>3.0.1</version>
31+
</dependency>
32+
```
33+
</tab>
34+
35+
</tabs>
36+
37+
Replace [ARTIFACT_ID](Platforms.md) with the artifact ID of the platform you want to use.
38+
You can find all of them in the [Platforms](Platforms.md) page.

Writerside/topics/Introdution.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
# Introduction
22

3-

Writerside/topics/Platforms.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,35 @@
11
# Platforms
22

3-
Start typing here...
3+
LiteCommands supports multiple platforms and extensions for them. You can find all of them in the table below.
4+
5+
| Artifacts | Compatible Platforms | Compatible Versions |
6+
|---------------------------|-------------------------------|---------------------|
7+
| `litecommands-bukkit` | Bukkit, Spigot, Paper, Purpur | 1.8.8 - 1.20.2 |
8+
| `litecommands-velocity` | Velocity | 3.2.0 |
9+
| `litecommands-bungeecord` | BungeeCord, Waterfall | 1.20-R0.1 |
10+
| `litecommands-minestom` | Minestom | 1.20.2 |
11+
| `litecommands-jda` | JDA | 5.0.0-beta.15 |
12+
13+
## Optional Adventure extension
14+
15+
| Platform Artifact | Extension Artifact | Compatible Platforms | Compatible Versions |
16+
|---------------------------|-----------------------------------|-------------------------------|---------------------|
17+
| `litecommands-bukkit` | `litecommands-adventure` | Paper, Purpur | 1.16 - 1.20.2 |
18+
| `litecommands-bukkit` | `litecommands-adventure-platform` | Bukkit, Spigot, Paper, Purpur | 1.8.8 - 1.20.2 |
19+
| `litecommands-bungeecord` | `litecommands-adventure-platform` | BungeeCord, Waterfall | 1.20-R0.1 |
20+
| `litecommands-velocity` | build-in | Velocity | 3.2.0 |
21+
| `litecommands-minestom` | build-in | Minestom | 1.20.2 |
22+
23+
Platforms:
24+
- [Bukkit](https://dev.bukkit.org/)
25+
- [Spigot](https://www.spigotmc.org/wiki/spigot-maven/)
26+
- [Paper](https://docs.papermc.io/paper/devi)
27+
- [Purpur](https://purpurmc.org/)
28+
- [BungeeCord](https://www.spigotmc.org/wiki/bungeecord-maven/)
29+
- [Waterfall](https://docs.papermc.io/waterfall/getting-started)
30+
- [Velocity](https://docs.papermc.io/velocity/dev/)
31+
- [Minestom](https://github.com/Minestom/Minestom)
32+
- [JDA](https://github.com/discord-jda/JDA)
33+
Extensions for platforms:
34+
- [Adventure](https://docs.advntr.dev/getting-started.html)
35+
- [Adventure Platform](https://docs.advntr.dev/platform/index.html)

Writerside/topics/Why-use-LiteCommands.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,16 @@ or any other platform, LiteCommands has you covered.
1414
See the [Platforms](Platforms.md) page for more information.
1515

1616
## More Clear Logic
17+
1718
LiteCommands offers a more intuitive and clear approach to handling commands when
18-
compared to the traditional methods.
19+
compared to the traditional methods.
1920

20-
For example, if you want to create a command that toggles chat, you would have to do
21-
something like this:
21+
<tabs>
22+
<tab title="LiteCommands">
2223

2324
```java
24-
@Command(name = "chat")
25+
26+
@[[[Command|Platforms.md]]](name = "chat")
2527
@Permission("command.chat")
2628
public class ChatCommand {
2729

@@ -46,7 +48,8 @@ public class ChatCommand {
4648
}
4749
```
4850

49-
Compared to the Bukkit way:
51+
</tab>
52+
<tab title="Traditional">
5053

5154
```Java
5255
public class BukkitWayCommand implements CommandExecutor {
@@ -104,5 +107,5 @@ public class BukkitWayCommand implements CommandExecutor {
104107

105108
}
106109
```
107-
108-
110+
</tab>
111+
</tabs>

0 commit comments

Comments
 (0)