Merge pull request #18 from ChillyCheesy/dev

Dev

Author: AymericHenouille

.github/workflows/app-build.yml

@@ -1,4 +1,4 @@
-name: 🌶 App build
+name: App build 🌶
 
 on:
   push:
@@ -8,14 +8,14 @@ on:
 
 jobs:
   build_app:
-    name: Build app and deploy 🪶
+    name: 🪶 Build app and deploy
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-java@v2
         with:
           distribution: 'zulu'
-          java-version: '11'
+          java-version: '16'
       - name: Setup properties SNAPSHOT
         if: github.ref == 'refs/heads/dev'
         run: |
@@ -62,15 +62,19 @@ jobs:
 
   deploy_javadoc:
     if: github.ref == 'refs/heads/dev'
-    name: Deploy javadoc 📄
+    name: 📄 Deploy javadoc
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: actions/setup-java@v2
+        with:
+          distribution: 'zulu'
+          java-version: '16'
       - name: Build javadoc
         run: |
           chmod +x gradlew
           ./gradlew clean :modulo-api:javadoc
-      - name: Deploy Javadoc 🚀
+      - name: 🚀 Deploy Javadoc
         uses: JamesIves/github-pages-deploy-action@v4.3.3
         with:
           branch: gh-pages

README.md

@@ -1,7 +1,7 @@
 <div align="center">
 
 # Modulo
-[![Build App](https://github.com/ChillyCheesy/Modulo/actions/workflows/app-build.yml/badge.svg?branch=master)]()
+[![Build App](https://github.com/ChillyCheesy/Modulo/actions/workflows/app-build.yml/badge.svg?branch=master)](https://github.com/ChillyCheesy/Modulo/actions)
 [![maven-central](https://maven-badges.herokuapp.com/maven-central/com.chillycheesy/modulo-api/badge.svg?style=flat)](https://search.maven.org/artifact/com.chillycheesy/modulo-api)
 [![Release](https://img.shields.io/github/v/release/ChillyCheesy/modulo.svg)](https://github.com/ChillyCheesy/Modulo/releases)
 
@@ -10,9 +10,9 @@
 
 <div align="center">
 
-![License](https://img.shields.io/github/license/ChillyCheesy/Modulo.svg)
-![Stars](https://img.shields.io/github/stars/ChillyCheesy/modulo.svg)
-![Forks](https://img.shields.io/github/forks/chillycheesy/modulo.svg)
+[![License](https://img.shields.io/github/license/ChillyCheesy/Modulo.svg)](https://github.com/ChillyCheesy/Modulo/blob/master/LICENSE.md)
+[![Stars](https://img.shields.io/github/stars/ChillyCheesy/modulo.svg)](https://github.com/ChillyCheesy/Modulo/stargazers)
+[![Forks](https://img.shields.io/github/forks/chillycheesy/modulo.svg)](https://github.com/ChillyCheesy/Modulo/network/members)
 
 </div>
 
@@ -21,27 +21,120 @@
 ## Table of contents
 * [Description](#Description)
 * [Getting started](#GettingStarted)
+  * [Step 1](#GettingStarted-1)
+  * [Step 2](#GettingStarted-2)
+  * [Step 3](#GettingStarted-3)
+  * [Step 4](#GettingStarted-4)
+  * [Step 5](#GettingStarted-5)
 * [How to use it](#HowToUseIt)
 * [See also](#SeeAlso)
 * [Cute cats](https://www.youtube.com/watch?v=VZrDxD0Za9I)
 
-## Description 🐭 <a id="Description"></a>
+## 🐭 Description <a id="Description"></a>
 What is modulo...
+## 🚀 Getting started <a id="GettingStarted"></a>
+**How to use Modulo ?**
+### Step 1:<a id="GettingStarted-1"></a>
+* Create a new java project in your favorite IDE.  
+* Add the modulo-api dependency to your project.
+  * Manually with your IDE.
+  * With Maven add the following dependency to your pom.xml:
+    ```xml
+    <dependency>
+      <groupId>com.chillycheesy</groupId>
+      <artifactId>modulo-api</artifactId>
+      <version>0.1.2</version>
+    </dependency>
+    ```
+  * With Gradle add the following dependency to your build.gradle: *(recommended)*
+    ```gradle
+    dependencies {
+      implementation 'com.chillycheesy:modulo-api:0.1.2'
+    }
+    ```
+### Step 2:<a id="GettingStarted-2"></a>
+* Create a new java class in your project. The class must inherit from the Module class. This will become your main class.
+* Implement the needed methods.
+  ```java
+  package com.chillycheesy.modulo;
+  
+  import com.chillycheesy.modulo.modules.Module;
+  
+  public class HelloModule extends Module {
+      
+      @Override
+      protected void onLoad() {
+          info("HelloModule is loaded");
+      }
+  
+      @Override
+      protected void onStart() {
+          info("HelloModule is started");
+      }
+      
+      @Override
+      protected void onStop() {
+          info("HelloModule is stopped");
+      }
+  
+  }
+  ```
+### Step 3:<a id="GettingStarted-3"></a>
+* Create the module.yml file in your project resources folder.
+  * The module.yml file must contain the following information:
+    ```yml
+    name: HelloModule
+    description: This is a hello module
+    version: 1.0.0
+    main: com.chillycheesy.modulo.HelloModule # The main class of the module
+    authors:
+      - ChillyCheesy
+    dependencies: [] # Optional
+    softDependencies: [] # Optional
+    ```
+### Step 4:<a id="GettingStarted-4"></a>
+* Download the [modulo-server jar file](https://github.com/ChillyCheesy/Modulo/releases).
+* Build your project and drop it in the ```modules``` folder inside your server folder. 
+* run the server with the following command:
+  ```bash
+  $> java -jar modulo-server.jar
+  ```
 
-## Getting started 🚀 <a id="GettingStarted"></a>
-How to begin...
+### Step 5:<a id="GettingStarted-5"></a>
+**Enjoy 🌶 🧀 !**
 
-## How to use it 📕 <a id="HowToUseIt"></a>
-See the documentation page [here](https://chillycheesy.github.io/Modulo/).  
+*If you use gradle, you can use the [ModuloGradleApplication](https://github.com/ChillyCheesy/ModuloGradleApplication).*
+
+## 📕 How to use it <a id="HowToUseIt"></a>
+See the Java documentation page [here](https://chillycheesy.github.io/Modulo/).  
 You can also check the [wiki](https://github.com/ChillyCheesy/Modulo/wiki).
 
-## See also 🧀🌶 <a id="SeeAlso"></a>
+## 🌶 🧀 See also <a id="SeeAlso"></a>
 * [ModuloGradleApplication](https://github.com/ChillyCheesy/ModuloGradleApplication)
 
 <pre>
               ..----.._    _
             .' .--.    "-.(O)_
-<font color="red">'-.__.-'"'=:</font>|  ,  _)_ \__ . c\'-..
+'-.__.-'"'=:|  ,  _)_ \__ . c\'-..
             ''------'---''---'-"
             Despelette was here !
-</pre>
+</pre>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

build.gradle

@@ -9,8 +9,10 @@ allprojects {
     }
 }
 
-task clean {
+tasks.register('clean') {
     subprojects.forEach { project ->
         finalizedBy ":$project.name:clean"
     }
 }
+
+tasks.findByPath(':modulo-server:compileJava').dependsOn ':sand-box:deployToTestServer'

gradle.properties

@@ -1,2 +1,2 @@
 modulo_modulename=ModuloServer
-modulo_version=BINKS-0.1.2
+modulo_version=BINKS-0.3.0

modulo-api/.gitignore

@@ -1,3 +1,2 @@
-src/main/resources/hometracker-ui
-src/main/resources/module.yml
+build
 gradle.properties

modulo-api/build.gradle

@@ -4,7 +4,9 @@ plugins {
 }
 
 archivesBaseName = 'modulo-api'
-sourceCompatibility = 11
+
+sourceCompatibility = 16
+targetCompatibility = JavaVersion.VERSION_16
 
 dependencies {
     implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:2.13.3'
@@ -21,6 +23,10 @@ java {
     withJavadocJar()
 }
 
+compileJava {
+    options.compilerArgs << '-parameters'
+}
+
 test {
     useJUnitPlatform()
 }

modulo-api/src/main/java/com/chillycheesy/modulo/ModuloAPI.java

@@ -1,11 +1,10 @@
 package com.chillycheesy.modulo;
 
-import com.chillycheesy.modulo.commands.CommandContainer;
 import com.chillycheesy.modulo.events.EventContainer;
 import com.chillycheesy.modulo.modules.ModuleContainer;
 import com.chillycheesy.modulo.pages.PageContainer;
 import com.chillycheesy.modulo.signals.SignalContainer;
-import com.chillycheesy.modulo.utils.Log;
+import com.chillycheesy.modulo.utils.Logger;
 
 /**
  * ModuloAPI was the Central Class of the API.
@@ -32,14 +31,9 @@ public class ModuloAPI {
      */
     private static PageContainer page;
     /**
-     * Log section.
+     * Logger section.
      */
-    private static Log logger;
-
-    /**
-     * Command Section
-     */
-    private static CommandContainer command;
+    private static Logger logger;
 
     /**
      * Getter for Module logic section.
@@ -82,17 +76,8 @@ public static PageContainer getPage() {
      *
      * @return The Logger section.
      */
-    public static Log getLogger() {
-        return logger = logger == null ? new Log(getEvent()) : logger;
-    }
-
-    /**
-     * Getter for Command logic section.
-     *
-     * @return The Command section.
-     */
-    public static CommandContainer getCommand() {
-        return command = command == null ? new CommandContainer() : command;
+    public static Logger getLogger() {
+        return logger = logger == null ? new Logger(getEvent()) : logger;
     }
 
 }