Update LiteCommands logo. Update minecraft version. Add fabric and sp…

…onge to platforms section. Update IntelliJ-IDEA-Plugin.md
LiteDevelopers · May 20, 2024 · 4455994 · 4455994
1 parent 15f7319
commit 4455994
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 86 deletions.
diff --git a/Writerside/images/litecommands.png b/Writerside/images/litecommands.png
diff --git a/Writerside/topics/Adventure-Kyori.md b/Writerside/topics/Adventure-Kyori.md
@@ -4,13 +4,15 @@ Adventure Kyori is a library that provides a set of utilities for the [Adventure
 
 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:
 
-| Platform Artifact         | Extension Artifact                | Compatible Platforms  | Compatible Versions |
-|---------------------------|-----------------------------------|-----------------------|---------------------|
-| `litecommands-bukkit`     | `litecommands-adventure-platform` | Bukkit, Spigot        | 1.8.8 - 1.20.2      |
-| `litecommands-bukkit`     | `litecommands-adventure`          | Paper, Purpur         | 1.16 - 1.20.2       |
-| `litecommands-bungeecord` | `litecommands-adventure-platform` | BungeeCord, Waterfall | 1.20-R0.1           |
-| `litecommands-velocity`   | build-in                          | Velocity              | 3.2.0               |
-| `litecommands-minestom`   | build-in                          | Minestom              | 1.20.2              |
+| Platform Artifact         | Extension Artifact                | Compatible Platforms  | Compatible Versions                                                                                              |
+|---------------------------|-----------------------------------|-----------------------|------------------------------------------------------------------------------------------------------------------|
+| `litecommands-bukkit`     | `litecommands-adventure-platform` | Bukkit, Spigot        | 1.8.8 - 1.20.6                                                                                                   |
+| `litecommands-bukkit`     | `litecommands-adventure`          | Paper, Purpur         | 1.16 - 1.20.6                                                                                                    |
+| `litecommands-bungeecord` | `litecommands-adventure-platform` | BungeeCord, Waterfall | 1.20-R0.1                                                                                                        |
+| `litecommands-velocity`   | build-in                          | Velocity              | 3.2.0                                                                                                            |
+| `litecommands-minestom`   | build-in                          | Minestom              | 1.20.6                                                                                                           |
+| `litecommands-sponge`     | build-in                          | Sponge                | 8.2.0                                                                                                            |
+| `litecommands-fabric`     | `litecommands-adventure-platform` | Fabric                | [See current version](https://github.com/Rollczi/LiteCommands/blob/master/litecommands-fabric/gradle.properties) |
 
 <tip>
 
@@ -21,29 +23,3 @@ Depending on the platform you are using, see the following pages for more inform
 - `build-in` means that you don't need to add any additional artifacts to your project.
 
 </tip>
-
-```mermaid
-graph LR
-    ADVENTURE_PLATFORM[litecommands-adventure-platform]
-    ADVENTURE[litecommands-adventure]
-    
-    BUKKIT[Bukkit / Spigot]
-    BUNGEE[BungeeCord / Waterfall]
-    PAPER[Paper / Purpur]
-    VELOCITY[Velocity]
-    MINESTOM[MineStom]
-    
-    LC_BUKKIT[litecommands-bukkit]
-    LC_BUNGEE[litecommands-bungeecord]
-    LC_VELOCITY[litecommands-velocity]
-    LC_MINESTOM[litecommands-minestom]
-    
-    BUKKIT --> LC_BUKKIT
-    BUKKIT --> ADVENTURE_PLATFORM
-    PAPER --> ADVENTURE
-    PAPER --> LC_BUKKIT
-    BUNGEE --> ADVENTURE_PLATFORM
-    BUNGEE --> LC_BUNGEE
-    VELOCITY --> LC_VELOCITY
-    MINESTOM --> LC_MINESTOM
-```
diff --git a/Writerside/topics/Arguments.md b/Writerside/topics/Arguments.md
@@ -2,18 +2,18 @@
 
 Arguments are used to parse the command sender's input and complete the command.
 
-
-
-
-
-## Full Example
-
 ```java
 @Command(name = "ban")
 public class BanCommand {
     @Execute
-    public void ban(@Arg Player player, @Flag("-s") boolean isSilent, @Join String reason) {
-        // ...
+    public void ban(
+        @Arg Player player, 
+        @Flag("-s") boolean isSilent, 
+        @Join String reason
+    ) {
+        // Command implementation ...
     }
 }
 ```
+
+See subtopics for more information about arguments.
diff --git a/Writerside/topics/IntelliJ-IDEA-Plugin.md b/Writerside/topics/IntelliJ-IDEA-Plugin.md
@@ -1,39 +1,7 @@
 # IntelliJ IDEA Plugin
 
-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:
+With LiteCommands plugin, you can easily develop your commands within the **IntelliJ IDEA** environment.
+The plugin provides **annotation inspections**, **tools** for creating new command classes, **syntax highlighting**, **code completion**,
+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)?
 
-## Command Viewer
-
-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.
-
-![intellij-command-viewer.png](intellij-command-viewer.png) { width="350" }
-
-## Command Validation
-
-The Command Validation highlights any errors in your command methods and arguments and provides helpful suggestions to fix them. 
-
-### Missing Annotation
-
-![intellij-command-validation-no-annotation.png](intellij-command-validation-no-annotation.png)
-
-
-### Primitive cannot be nullable
-
-// TODO image
-
-### Invalid route command
-
-// TODO Image
-
-## Legacy Annotations Migration
-
-### 2.x -> 3.x
-- `@Permission`
-- `@Route` -> `@Command`
-- `@Section` -> `@Command`
-- `@Execute`
-- `@Arg`
-- `@Flag`
-- `@Joiner` -> `@Join`
-
-// TODO Image
+<img alt="litecommandsbanner-intellij" src="https://github.com/Rollczi/LiteCommands/assets/49173834/fea96613-af58-42bb-b32d-ffd6946ba4cc"/>
diff --git a/Writerside/topics/Introdution.md b/Writerside/topics/Introdution.md
@@ -1,6 +1,6 @@
 # What is LiteCommands?
 
-<img alt="litecommands.png" src="litecommands.png" width="480"/>
+<img alt="litecommands.png" src="litecommands.png" width="520"/>
 
 LiteCommands is a versatile and feature-rich command framework
 designed to simplify command handling for a wide range of platforms and implementations.
@@ -25,7 +25,7 @@ compared to the traditional methods.
 
 ```java
 
-@[[[Command|Platforms.md]]](name = "chat")
+@Command(name = "chat")
 @Permission("command.chat")
 public class ChatCommand {
 

diff --git a/Writerside/topics/Platforms.md b/Writerside/topics/Platforms.md
@@ -2,10 +2,12 @@
 
 LiteCommands supports multiple platforms and extensions for them. You can find all of them in the table below.
 
-| Artifacts                 | Compatible Platforms          | Compatible Versions |
-|---------------------------|-------------------------------|---------------------|
-| `litecommands-bukkit`     | Bukkit, Spigot, Paper, Purpur | 1.8.8 - 1.20.2      |
-| `litecommands-velocity`   | Velocity                      | 3.2.0               |
-| `litecommands-bungeecord` | BungeeCord, Waterfall         | 1.20-R0.1           |
-| `litecommands-minestom`   | Minestom                      | 1.20.2              |
-| `litecommands-jda`        | JDA                           | 5.0.0-beta.15       |
+| Artifacts                 | Compatible Platforms          | Compatible Versions                                                                                              |
+|---------------------------|-------------------------------|------------------------------------------------------------------------------------------------------------------|
+| `litecommands-bukkit`     | Bukkit, Spigot, Paper, Purpur | 1.8.8 - 1.20.6                                                                                                   |
+| `litecommands-velocity`   | Velocity                      | 3.2.0                                                                                                            |
+| `litecommands-bungeecord` | BungeeCord, Waterfall         | 1.20-R0.1                                                                                                        |
+| `litecommands-minestom`   | Minestom                      | 1.20.6                                                                                                           |
+| `litecommands-sponge`     | Sponge                        | 8.2.0                                                                                                            |
+| `litecommands-fabric`     | Fabric                        | [See current version](https://github.com/Rollczi/LiteCommands/blob/master/litecommands-fabric/gradle.properties) |
+| `litecommands-jda`        | JDA                           | 5.0.0-beta.17                                                                                                    |