README and LICENSE

Author: Avanatiker

LICENSE.md

@@ -0,0 +1,56 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below.
+
+0. Additional Definitions.
+As used herein, “this License” refers to version 3 of the GNU Lesser General Public License, and the “GNU GPL” refers to version 3 of the GNU General Public License.
+
+“The Library” refers to a covered work governed by this License, other than an Application or a Combined Work as defined below.
+
+An “Application” is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library.
+
+A “Combined Work” is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the “Linked Version”.
+
+The “Minimal Corresponding Source” for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version.
+
+The “Corresponding Application Code” for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work.
+
+1. Exception to Section 3 of the GNU GPL.
+You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL.
+
+2. Conveying Modified Versions.
+If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version:
+
+a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or
+b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy.
+3. Object Code Incorporating Material from Library Header Files.
+The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following:
+
+a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License.
+b) Accompany the object code with a copy of the GNU GPL and this license document.
+4. Combined Works.
+You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following:
+
+a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License.
+b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
+c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document.
+d) Do one of the following:
+0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
+1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version.
+e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.)
+5. Combined Libraries.
+You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following:
+
+a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License.
+b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work.
+6. Revised Versions of the GNU Lesser General Public License.
+The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.

README.md

@@ -1,29 +1,84 @@
 # Lambda Plugin SDK
 
-This project in an example to show how a proper plugin is set up.
+This project in an example to show how a proper plugin for [Lambda Client](https://github.com/lambda-client/lambda) is set up.
+The advantage of plugins for a utility mod is that they allow the user to decide what features their personalized client will have. Plugins work in plug and play manner, and can be downloaded and activated inside the ingame menu without reloading the client as long as no mixins are used for the plugin.
+If you are scared about the Kotlin in this project be aware that Kotlin is a wrapper language for Java. That means that plugins can also be natively written in Java.
 
 ## Setup
 
-Follow these steps to build your own plugin for lambda.
+To achieve coding building and publishing your own plugin most of the following steps are required.
 
-### 1. Clone Repository
+### Fork
+This is a template repository and can be used as a base to create a custom plugin. Press the `Use as template` button on GitHub to automatically create a linked fork to this repository.
 
-### 2. Setup IDE
+### Clone Repository
 
-### 3. Configure Gradle
+Clone the repository to your local machine. Use the link of either your fork or the main repository.
+```
+git clone https://github.com/lambda-client/plugin-sdk
+```
 
-### 4. Plugin
+### Setup IDE
 
-### 6. PluginModule
+In this guide we will use [IntelliJ IDEA](https://www.jetbrains.com/idea/) as IDE.
+1. Open the project from `File > Open...`
+2. Let the IDE collect dependencies and index the code.
 
-### 7. ClientCommand
+### Configure Gradle
 
-### 8. PluginLabelHud
+Test if the environment is set up correctly by building the plugin jar using the Gradle tab on the left side of the IDE.
+1. Go to `PluginExample > Tasks > build > jar` in the Gradle tab and run the script
+2. IntelliJ will create a new directory called `build` the final built jar will be in `build/libs`
 
-### 9. Background Jobs
+### Config
 
-### 10. Config
+Configure the meta data of your plugin in `plugin_info.json` and `mcmod.info`
+The flag `main_class` must contain the target main class `Plugin` in this case it the `PluginExample.kt`
 
-### 11. Build
+### Plugin
 
-### 12. Publish
+The plugin main class will act as a register for the functions a plugin can provide.
+For example when a new module class is created you have to add this to the `onLoad()` function of the plugin class.
+```
+modules.add(ModuleExample)
+```
+Every service is required to be added to the main class in order to index the contents.
+
+### PluginModule
+
+A module represents a utility module inside the game.
+The `PluginModule` class acts as a wrapper for `Module` class. For many examples on how a module can work check out the [native modules](https://github.com/lambda-client/lambda/tree/master/src/main/kotlin/com/lambda/client/module/modules) of lambda, or the given example in this project.
+The difference to the native `Module` class is that a referral to the main plugin class is given in the object data.
+```
+pluginMain = PluginExample
+```
+
+### ClientCommand
+
+Plugins use the same class as the native client for registering commands. Feel free to check out the [commands of Lambda Client](https://github.com/lambda-client/lambda/tree/master/src/main/kotlin/com/lambda/client/command/commands) as reference. 
+
+### PluginLabelHud
+
+A LabelHud is used to display information in the player GUI.
+The `PluginLabelHud` class acts as a wrapper for `LabelHud` class. For many examples on how a hud can work check out the [native hud elements](https://github.com/lambda-client/lambda/tree/master/src/main/kotlin/com/lambda/client/gui/hudgui/elements) of lambda, or the given example in this project.
+The difference to the native `LabelHud` class is that a referral to the main plugin class is given in the object data.
+```
+pluginMain = PluginExample
+```
+
+### Background Jobs
+
+If coroutines are needed background jobs can be registered using
+```
+bgJobs.add(BackgroundJob)
+```
+
+### Build
+
+1. Go to `PluginExample > Tasks > build > jar` in the Gradle tab and run the script
+2. IntelliJ will create a new directory called `build` the final built jar will be in `build/libs`
+3. Put the `ExamplePlugin-1.0.jar` into your `./minecraft/lambda/plugins` folder and run the game.
+
+### Publish (coming soon)
+
+Insert the link of your created fork into the plugin manager to load the plugin.

build.gradle

@@ -1,8 +1,6 @@
 version project.modVersion
 group project.modGroup
 
-wrapper { gradleVersion = '6.8.3' }
-
 buildscript {
     repositories {
         maven { url = 'https://files.minecraftforge.net/maven' }
@@ -25,6 +23,7 @@ compileKotlin {
     kotlinOptions {
         jvmTarget = "1.8"
         useIR = true
+        freeCompilerArgs += '-Xlambdas=indy'
     }
 }