a bunch of fixes

Author: Grabsky

commands.md

@@ -4,11 +4,13 @@ order: 98
 ---
 
 # Commands
-List of commands provided by LuaLink.
+List of all commands and permissions provided by LuaLink.
 
 | Command                    | Permission              | Description                  |
 | -------------------------- | ------------------------------------------------------ |
-| `/lualink load <script>`   | lualink.command.load   | Loads specified Lua script.   |
-| `/lualink unload <script>` | lualink.command.unload | Unloads specified Lua script. |
-| `/lualink reload <script>` | lualink.command.reload | Reloads specified Lua script. |
-| `/lualink list`            | lualink.command.list   | Lists all loaded Lua scripts. |
+| `/lualink load (script)`   | lualink.command.load   | Loads specified Lua script.   | 
+| `/lualink unload (script)` | lualink.command.unload | Unloads specified Lua script. | 
+| `/lualink reload (script)` | lualink.command.reload | Reloads specified Lua script. |
+| `/lualink list`            | lualink.command.list   | Lists all loaded Lua scripts. |
+
+Please be cautious and give access to these commands only to people you trust.

dependencies.md

@@ -1,6 +1,7 @@
 ---
 icon: package-dependencies
-order: 98
+order: 97
 ---
 
 # Dependencies
+TO-DO

getting-started.md

@@ -21,7 +21,7 @@ Basic **Lua** knowledge is an obvious prerequisite, but it should be relatively
 | ------------------------------------------------------------ |
 | [1. Creating Scripts](#creating-scripts)                     |
 | [2. Script Life-cycle](#script-life-cycle)                   |
-| [3. Importing](#importing)                                   |
+| [3. Importing and Requiring](#importing-and-requiring)       |
 | [4. Constructors and Instances](#constructors-and-instances) |
 | [5. Commands](#commands)                                     |
 | [6. Events](#events)                                         |
@@ -31,12 +31,12 @@ Basic **Lua** knowledge is an obvious prerequisite, but it should be relatively
 
 ### Creating Scripts
 There are a couple of things to keep in mind when using LuaLink.
-- Each script is stored in a separate folder inside the `plugins/LuaLink/scripts` directory, and libraries are stored in the `plugins/LuaLink/libs` directory.  
-  <sup>More about libraries can be found on the **[Libraries](libraries.md)** page.</sup>
-- Entry point of the script (or library) is a file named `main.lua` or `init.lua`.  
-  <sup>It doesn't matter which file you choose as the entry point, but you should be consistent with your naming convention.</sup>
 - Script life-cycle can be managed using `/lualink load`, `/lualink unload` and `/lualink reload` commands.  
   <sup>More on this can be found on the **[Commands](commands.md)** page.</sup>
+- Each script is stored in a separate folder inside the `plugins/LuaLink/scripts` directory, and libraries are stored in the `plugins/LuaLink/libs` directory.  
+  <sup>More about libraries can be found on the **[Libraries](libraries.md)** page.</sup>
+- Entry point of the script (or library) is a file named `main.lua`.  
+  <sup>More files can be created and loaded using the `require` keyword.</sup>
 
 <br />
 
@@ -45,12 +45,12 @@ Scripts are automatically loaded after server has been fully started. They can a
 ```lua
 -- Called after the script has been successfully loaded.
 script:onLoad(function()
-    script:logger:info("Script has been loaded.")
+    script.logger:info("Script has been loaded.")
 end)
 
 -- Called before the script is attempted to be unloaded.
 script:onUnload(function()
-    script:logger:info("Script is about to be unloaded.")
+    script.logger:info("Script is about to be unloaded.")
 end)
 ```
 
@@ -81,17 +81,18 @@ script:onLoad(function()
     counter:increment()
     counter:increment()
     -- Printing current value of the counter to the console.
-    script.logger.info(counter:get() ..
+    script.logger:info(counter:get() .. " is the current value of the counter.")
+end)
 ```
 
 <br />
 
 ### Constructors and Instances
 New instances of Java classes can be created as follows.
 ```lua
-local Bukkit = import "org.bukkit.Bukkit"
-local Keyed = import "net.kyori.adventure.key.Keyed"
-local NamespacedKey = import "org.bukkit.NamespacedKey"
+local Bukkit = import("org.bukkit.Bukkit")
+local Keyed = import("net.kyori.adventure.key.Keyed")
+local NamespacedKey = import("org.bukkit.NamespacedKey")
 
 script.onLoad(function()
     -- Creating new instance of NamespacedKey class.
@@ -101,7 +102,7 @@ script.onLoad(function()
     -- Checking if World is instance of Keyed. (SPOILER: IT IS)
     if (Keyed.class:isInstance(world) == true) then 
         -- Sending loaded chunks count to the console.
-        script.logger.info("World " .. world:key():asString() .. " has " .. world:getChunkCount() .. " chunks loaded.")
+        script.logger:info("World " .. world:key():asString() .. " has " .. world:getChunkCount() .. " chunks loaded.")
     end
 end)
 ```
@@ -111,7 +112,7 @@ end)
 ### Commands
 Non-complex commands can be created with little effort using built-in API.
 ```lua
-local Bukkit = import "org.bukkit.Bukkit"
+local Bukkit = import("org.bukkit.Bukkit")
 
 -- Function to handle command tab-completion.
 function onTabComplete(sender, alias, args)
@@ -157,28 +158,28 @@ end)
 ### Scheduler
 Scheduler can be used to register single-use, delayed or repeating tasks.
 ```lua
--- Schedules task to be run on the next tick.
-script.run(function()
+-- Schedules a task to be run on the next tick.
+scheduler:run(function()
     -- Whatever belongs to the task goes here.
 end)
 
--- Schedules task to be run after 20 ticks has passed. Task function parameter can be omitted if not used. 
-script.runDelayed(function(task)
+-- Schedules a task to be run after 20 ticks has passed. 
+scheduler:runLater(function()
     -- Whatever belongs to the task goes here.
 end, 20)
 
--- Schedules task to be run after 20 ticks has passed, and repeated every 160 ticks. Task function parameter can be omitted if not used. 
-script.runRepeating(function(task)
+-- Schedules a task to be run after 20 ticks has passed, and repeated every 160 ticks.
+scheduler:runRepeating(function()
     -- Whatever belongs to the task goes here.
 end, 20, 160)
 ```
 
 Tasks can also be run asynchronously, but please note that neither the Bukkit API nor the LuaLink API is guaranteed to be thread-safe.
 ```lua
 -- Schedules asynchronous task to be run on the next tick.
-script.runAsync(callback: () -> void): void
--- Schedules asynchronous task to be run after {delay} ticks has passed. Task function parameter can be omitted if not used. 
-script.runDelayedAsync(callback: (task: BukkitTask) -> void, delay: number): BukkitTask
--- Schedules task to be run after {delay} ticks has passed, and repeated every {period} ticks. Task function parameter can be omitted if not used. 
-script.runRepeatingAsync(callback: (task: BukkitTask) -> void, delay: number, period: number): BukkitTask
+scheduler:runAsync(handler: () -> void): BukkitTask
+-- Schedules asynchronous task to be run after {delay} ticks has passed.
+scheduler:runLaterAsync(handler: () -> void, delay: number): BukkitTask
+-- Schedules task to be run after {delay} ticks has passed, and repeated every {period} ticks.
+scheduler:runRepeatingAsync(handler: () -> void, delay: number, period: number): BukkitTask
 ```

index.md

@@ -8,9 +8,9 @@ This documentation page is still a work in progress and may contain outdated inf
 !!!
 
 # LuaLink v2
-LuaLink is an experimental plugin that provides a basic Lua scripting runtime for Paper-based Minecraft servers. It is designed for small and simple tasks and serves as an alternative to Skript and other scripting plugins. 
+**LuaLink** is an experimental plugin that provides a basic Lua scripting runtime for **Paper-based** Minecraft servers. It is designed for small and simple tasks and serves as a much more powerful alternative to **Skript** and other scripting plugins. 
 
-Scripting runtime is based on [LuaJava](https://github.com/gudzpoz/luajava) with [LuaJIT](https://github.com/LuaJIT/LuaJIT). For more details on implementation specifics or differences, please refer to their respective documentation.  
+Scripting runtime is based on **[LuaJava](https://github.com/gudzpoz/luajava)** with **[LuaJIT](https://github.com/LuaJIT/LuaJIT)**. For more details on implementation specifics or differences, please refer to their respective documentation.  
 
 <br />
 
@@ -41,26 +41,26 @@ Plugin can be downloaded from following sources:
 ## Quick Start
 After you have installed the plugin, you can start writing your first script.
 
-- Each script is stored in a separate folder inside the `plugins/LuaLink/scripts` directory. 
-- Entry point of the script is a file named `main.lua` or `init.lua`.
 - Script life-cycle can be managed using `/lualink load`, `/lualink unload` and `/lualink reload` commands.
+- Each script is stored in a separate folder inside the `plugins/LuaLink/scripts` directory.
+- Entry point of the script is a file named `main.lua`.
 
-```lua plugins/LuaLink/scripts/my_script/init.lua
-local Bukkit = import "org.bukkit.Bukkit"
+```lua plugins/LuaLink/scripts/my_script/main.lua
+local Bukkit = import("org.bukkit.Bukkit")
 
 -- Called after the script has been successfully loaded.
 script:onLoad(function()
     -- Logging message to the console.
-    script:logger:info("Hello, World!")
+    script.logger:info("Hello, World!")
 end)
 
 ```
 It's quite simple, isn't it? For this particular case, we can simplify it even further by extracting the logic away from the `onLoad` block.
 
-```lua plugins/LuaLink/scripts/my_script/init.lua
-local Bukkit = import "org.bukkit.Bukkit"
+```lua plugins/LuaLink/scripts/my_script/main.lua
+local Bukkit = import("org.bukkit.Bukkit")
 
 -- Logging message to the console.
-script:logger:info("Hello, World!")
+script.logger:info("Hello, World!")
 ```
 Want to do something more complex? More information on how to write scripts can be found on the **[Getting Started](getting-started.md)** page.

libraries.md

@@ -1,6 +1,6 @@
 ---
 icon: package-dependents
-order: 97
+order: 96
 ---
 
 # Libraries
@@ -9,10 +9,10 @@ LuaLink provides a way to load external **Java** libraries for use in your scrip
 <br />
 
 ## Lua Libraries
-External Lua libraries can be added by copying files to the `/plugins/LuaLink/libs/` folder.
+External Lua libraries can be added by creating or copying files to the `/plugins/LuaLink/libs/` folder.
 
 ==- Example Lua Library
-```lua **/plugins/LuaLink/libs/example_library/init.lua**
+```lua **/plugins/LuaLink/libs/example_library/main.lua**
 local Counter = {}
 Counter.__index = Counter
 
@@ -46,18 +46,18 @@ This is an example of a Counter class that allows you to increment, decrement, a
 
 Now, if you want to use this class in your script, you can import it using the `require` keyword.
 
-```lua /plugins/LuaLink/scripts/example_script/init.lua
+```lua /plugins/LuaLink/scripts/example_script/main.lua
 local Counter = require("example_library")
 
 script:onLoad(function()
     -- Creating a new instance of the Counter class.
-    local counter = Counter.new()
+    local counter = Counter()
     -- Incrementing the counter three times.
     counter:increment()
     counter:increment()
     counter:increment()
     -- Printing current value of the counter to the console.
-    script.logger.info(counter:get() .. " is the current value of the counter.")
+    script.logger:info(counter:get() .. " is the current value of the counter.")
 end)
 ```
 
@@ -88,7 +88,7 @@ External Java/Kotlin libraries can be added by configuring the `/plugins/LuaLink
 }
 ```
 
-In this example, we are adding stefvanschie's [IF](https://github.com/stefvanschie/IF) library of version `0.10.11` from [Maven Central](https://repo.maven.apache.org/maven2/) repository. You can also see how to add and authenticate with a private repository using credentials, which might be essential when working with closed-source projects or [GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry).
+In this example, we are adding stefvanschie's [IF](https://github.com/stefvanschie/IF) library of version `0.10.11` from [Maven Central](https://repo.maven.apache.org/maven2/) repository. You can also see how and authenticate with a private repository using credentials, which might be essential when working with closed-source projects or [GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry).
 
 After restarting the server, we should be able to import and access any class that belongs to specified library(-ies).
 

reference.md

@@ -1,6 +1,6 @@
 ---
 icon: code
-order: 96
+order: 95
 ---
 
 # Reference
@@ -10,32 +10,36 @@ Provides methods to schedule and manage tasks. It supports both synchronous and
 
 ```lua
 --- Schedules a task to run on the next tick.
---  @param callback The task function to execute
-scheduler:run(callback: () -> void): void
+--  @param handler The task function to execute
+scheduler:run(handler: () -> void): BukkitTask
 
 --- Schedules an asynchronous task to run on the next tick.
---  @param callback The task function to execute
-scheduler:runAsync(callback: () -> void): void
+--  @param handler The task function to execute
+scheduler:runAsync(handler: () -> void): BukkitTask
 
 --- Schedules a task to run after a delay (in ticks).
---  @param callback The task function to execute
+--  @param handler The task function to execute
 --  @param delay Delay in ticks before execution
-scheduler:runDelayed(callback: (task: BukkitTask) -> void, delay: number): BukkitTask
+scheduler:runLater(handler: () -> void, delay: number): BukkitTask
 
 --- Schedules an asynchronous task to run after a delay (in ticks).
---  @param callback The task function to execute
+--  @param handler The task function to execute
 --  @param delay Delay in ticks before execution
-scheduler:runDelayedAsync(callback: (task: BukkitTask) -> void, delay: number): BukkitTask
+scheduler:runLaterAsync(handler: () -> void, delay: number): BukkitTask
 
 --- Schedules a repeating task.
---  @param callback The task function to execute
+--  @param handler The task function to execute
 --  @param delay Delay in ticks before first execution
 --  @param period Interval in ticks between executions
-scheduler:runRepeating(callback: (task: BukkitTask) -> void, delay: number, period: number): BukkitTask
+scheduler:runRepeating(handler: () -> void, delay: number, period: number): BukkitTask
 
 --- Schedules an asynchronous repeating task.
---  @param callback The task function to execute
+--  @param handler The task function to execute
 --  @param delay Delay in ticks before first execution
 --  @param period Interval in ticks between executions
-scheduler:runRepeatingAsync(callback: (task: BukkitTask) -> void, delay: number, period: number): BukkitTask
+scheduler:runRepeatingAsync(handler: () -> void, delay: number, period: number): BukkitTask
+
+--- Cancels a task with the specified identifier.
+--  @param task The task to cancel
+scheduler:cancel(task: number): void
 ```