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

Commit 4455994

Browse files
committed
Update LiteCommands logo. Update minecraft version. Add fabric and sponge to platforms section. Update IntelliJ-IDEA-Plugin.md
1 parent 15f7319 commit 4455994

File tree

6 files changed

+32
-86
lines changed

6 files changed

+32
-86
lines changed

Writerside/images/litecommands.png

12.8 KB
Loading

Writerside/topics/Adventure-Kyori.md

Lines changed: 9 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@ Adventure Kyori is a library that provides a set of utilities for the [Adventure
44

55
If you want to use the Adventure Kyori features in your project, you need to add the following dependency, depending on the platform you are using:
66

7-
| Platform Artifact | Extension Artifact | Compatible Platforms | Compatible Versions |
8-
|---------------------------|-----------------------------------|-----------------------|---------------------|
9-
| `litecommands-bukkit` | `litecommands-adventure-platform` | Bukkit, Spigot | 1.8.8 - 1.20.2 |
10-
| `litecommands-bukkit` | `litecommands-adventure` | Paper, Purpur | 1.16 - 1.20.2 |
11-
| `litecommands-bungeecord` | `litecommands-adventure-platform` | BungeeCord, Waterfall | 1.20-R0.1 |
12-
| `litecommands-velocity` | build-in | Velocity | 3.2.0 |
13-
| `litecommands-minestom` | build-in | Minestom | 1.20.2 |
7+
| Platform Artifact | Extension Artifact | Compatible Platforms | Compatible Versions |
8+
|---------------------------|-----------------------------------|-----------------------|------------------------------------------------------------------------------------------------------------------|
9+
| `litecommands-bukkit` | `litecommands-adventure-platform` | Bukkit, Spigot | 1.8.8 - 1.20.6 |
10+
| `litecommands-bukkit` | `litecommands-adventure` | Paper, Purpur | 1.16 - 1.20.6 |
11+
| `litecommands-bungeecord` | `litecommands-adventure-platform` | BungeeCord, Waterfall | 1.20-R0.1 |
12+
| `litecommands-velocity` | build-in | Velocity | 3.2.0 |
13+
| `litecommands-minestom` | build-in | Minestom | 1.20.6 |
14+
| `litecommands-sponge` | build-in | Sponge | 8.2.0 |
15+
| `litecommands-fabric` | `litecommands-adventure-platform` | Fabric | [See current version](https://github.com/Rollczi/LiteCommands/blob/master/litecommands-fabric/gradle.properties) |
1416

1517
<tip>
1618

@@ -21,29 +23,3 @@ Depending on the platform you are using, see the following pages for more inform
2123
- `build-in` means that you don't need to add any additional artifacts to your project.
2224

2325
</tip>
24-
25-
```mermaid
26-
graph LR
27-
ADVENTURE_PLATFORM[litecommands-adventure-platform]
28-
ADVENTURE[litecommands-adventure]
29-
30-
BUKKIT[Bukkit / Spigot]
31-
BUNGEE[BungeeCord / Waterfall]
32-
PAPER[Paper / Purpur]
33-
VELOCITY[Velocity]
34-
MINESTOM[MineStom]
35-
36-
LC_BUKKIT[litecommands-bukkit]
37-
LC_BUNGEE[litecommands-bungeecord]
38-
LC_VELOCITY[litecommands-velocity]
39-
LC_MINESTOM[litecommands-minestom]
40-
41-
BUKKIT --> LC_BUKKIT
42-
BUKKIT --> ADVENTURE_PLATFORM
43-
PAPER --> ADVENTURE
44-
PAPER --> LC_BUKKIT
45-
BUNGEE --> ADVENTURE_PLATFORM
46-
BUNGEE --> LC_BUNGEE
47-
VELOCITY --> LC_VELOCITY
48-
MINESTOM --> LC_MINESTOM
49-
```

Writerside/topics/Arguments.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
Arguments are used to parse the command sender's input and complete the command.
44

5-
6-
7-
8-
9-
## Full Example
10-
115
```java
126
@Command(name = "ban")
137
public class BanCommand {
148
@Execute
15-
public void ban(@Arg Player player, @Flag("-s") boolean isSilent, @Join String reason) {
16-
// ...
9+
public void ban(
10+
@Arg Player player,
11+
@Flag("-s") boolean isSilent,
12+
@Join String reason
13+
) {
14+
// Command implementation ...
1715
}
1816
}
1917
```
18+
19+
See subtopics for more information about arguments.
Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,7 @@
11
# IntelliJ IDEA Plugin
22

3-
The LiteCommands **IntelliJ IDEA** Plugin enhances the development experience for LiteCommands framework users by providing a set of powerful features aimed at improving command and argument validation, offering helpful suggestions, and facilitating seamless migration. Below are the key features of the plugin:
3+
With LiteCommands plugin, you can easily develop your commands within the **IntelliJ IDEA** environment.
4+
The plugin provides **annotation inspections**, **tools** for creating new command classes, **syntax highlighting**, **code completion**,
5+
and other useful features to make your development experience smoother and more efficient. How to [install](https://github.com/LiteDevelopers/LiteCommands-IntelliJPlugin?tab=readme-ov-file#installation)?
46

5-
## Command Viewer
6-
7-
The Command Viewer is a tool that allows you to view current commands in your command class. It provides a convenient way to navigate through your commands and view their structure with their properties.
8-
9-
![intellij-command-viewer.png](intellij-command-viewer.png) { width="350" }
10-
11-
## Command Validation
12-
13-
The Command Validation highlights any errors in your command methods and arguments and provides helpful suggestions to fix them.
14-
15-
### Missing Annotation
16-
17-
![intellij-command-validation-no-annotation.png](intellij-command-validation-no-annotation.png)
18-
19-
20-
### Primitive cannot be nullable
21-
22-
// TODO image
23-
24-
### Invalid route command
25-
26-
// TODO Image
27-
28-
## Legacy Annotations Migration
29-
30-
### 2.x -> 3.x
31-
- `@Permission`
32-
- `@Route` -> `@Command`
33-
- `@Section` -> `@Command`
34-
- `@Execute`
35-
- `@Arg`
36-
- `@Flag`
37-
- `@Joiner` -> `@Join`
38-
39-
// TODO Image
7+
<img alt="litecommandsbanner-intellij" src="https://github.com/Rollczi/LiteCommands/assets/49173834/fea96613-af58-42bb-b32d-ffd6946ba4cc"/>

Writerside/topics/Introdution.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# What is LiteCommands?
22

3-
<img alt="litecommands.png" src="litecommands.png" width="480"/>
3+
<img alt="litecommands.png" src="litecommands.png" width="520"/>
44

55
LiteCommands is a versatile and feature-rich command framework
66
designed to simplify command handling for a wide range of platforms and implementations.
@@ -25,7 +25,7 @@ compared to the traditional methods.
2525

2626
```java
2727

28-
@[[[Command|Platforms.md]]](name = "chat")
28+
@Command(name = "chat")
2929
@Permission("command.chat")
3030
public class ChatCommand {
3131

Writerside/topics/Platforms.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22

33
LiteCommands supports multiple platforms and extensions for them. You can find all of them in the table below.
44

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 |
5+
| Artifacts | Compatible Platforms | Compatible Versions |
6+
|---------------------------|-------------------------------|------------------------------------------------------------------------------------------------------------------|
7+
| `litecommands-bukkit` | Bukkit, Spigot, Paper, Purpur | 1.8.8 - 1.20.6 |
8+
| `litecommands-velocity` | Velocity | 3.2.0 |
9+
| `litecommands-bungeecord` | BungeeCord, Waterfall | 1.20-R0.1 |
10+
| `litecommands-minestom` | Minestom | 1.20.6 |
11+
| `litecommands-sponge` | Sponge | 8.2.0 |
12+
| `litecommands-fabric` | Fabric | [See current version](https://github.com/Rollczi/LiteCommands/blob/master/litecommands-fabric/gradle.properties) |
13+
| `litecommands-jda` | JDA | 5.0.0-beta.17 |

0 commit comments

Comments
 (0)