Sorted up the project

Tianscar · Jan 9, 2023 · 50d390f · 50d390f
1 parent 3138ef8
commit 50d390f
Show file tree

Hide file tree

Showing 44 changed files with 131 additions and 91 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,63 @@
 # jME3-ImGui
-A simple helper library for use the Dear ImGui with jMonkeyEngine. Currently supports LWJGL3 platform only.
+A simple helper library for use the Dear ImGui with jMonkeyEngine. Currently supports LWJGL3 platform only.  
+Supported jMonkeyEngine version: v3.5.2 or later
+
+## Add the library to your project (gradle)
+1. Add the Maven Central repository (if not exist) to your build file:
+```groovy
+repositories {
+    mavenCentral()
+}
+```
+
+2. Add the dependency:
+```groovy
+dependencies {
+    implementation 'com.tianscar:jme3-imgui:1.0.0'
+}
+```
 
 ## Usage
-docs: https://jme3-imgui.tianscar.com  
-examples: https://github.com/Tianscar/jme3-imgui/tree/main/lwjgl3/src/test/java/com/tianscar/jme3/imgui/test
+```java
+public class Usage extends SimpleApplication {
+
+    @Override
+    public void simpleInitApp() {
+        // Initialize the ImGui
+        JmeImGui.init(getContext());
+    }
+
+    @Override
+    public void simpleRender(RenderManager rm) {
+        // Start the ImGui frame
+        JmeImGui.startFrame();
+        // ----------- ImGui logic here ---------------
+        if (!JmeImGui.isDisposed()) {
+            // Draw widgets here
+        }
+        // --------------------------------------------
+        // End the ImGui frame
+        JmeImGui.endFrame();
+    }
+
+    @Override
+    public void requestClose(boolean esc) {
+        // Dispose the ImGui
+        JmeImGui.dispose();
+        super.requestClose(esc);
+    }
+
+}
+```
+[JavaDocs](https://jme3-imgui.tianscar.com)  
+[Examples](lwjgl3/src/test)
 
 ## License
-imgui-java - [Apache-2.0](https://github.com/SpaiR/imgui-java/blob/main/LICENSE) (c) SpaiR  
-jME3-ImGui - [Apache-2.0](https://github.com/Tianscar/jme3-imgui/blob/main/LICENSE) (c) Tianscar
+[Apache-2.0](https://github.com/Tianscar/jme3-imgui/blob/main/LICENSE) (c) Tianscar
+
+### Dependencies
+imgui-java - [Apache-2.0](https://github.com/SpaiR/imgui-java/blob/main/LICENSE)  
+jMonkeyEngine - [BSD-3-Clause](https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/LICENSE.md)
+
+### Resources be used for test
+[Droid Sans Fallback](/lwjgl3/src/test/resources/droid_sans.ttf) - Apache-2.0
diff --git a/build.gradle b/build.gradle
@@ -9,8 +9,8 @@ subprojects {
         libGroupName = 'com.tianscar'
         libVendorName = 'Tianscar'
 
-        libVersionCode = 1
-        libVersionName = '0.0.1'
+        libVersionCode = 2
+        libVersionName = '1.0.0'
 
         libSourceCompatibility = JavaVersion.VERSION_1_8
         libTargetCompatibility = JavaVersion.VERSION_1_8

diff --git a/core/build.gradle b/core/build.gradle
@@ -3,5 +3,5 @@ dependencies {
 
     implementation "io.github.spair:imgui-java-binding:$imguiVersion"
 
-    apiElements "io.github.spair:imgui-java-binding:$imguiVersion"
+    api "io.github.spair:imgui-java-binding:$imguiVersion"
 }
diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html
@@ -1,18 +1,18 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jul 03 16:38:08 CST 2022 -->
+<!-- Generated by javadoc (17) on Tue Jan 10 07:20:57 CST 2023 -->
 <title>All Classes and Interfaces</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2022-07-03">
+<meta name="dc.created" content="2023-01-10">
 <meta name="description" content="class index">
 <meta name="generator" content="javadoc/AllClassesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
-<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="all-classes-index-page">

diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html
@@ -1,18 +1,18 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jul 03 16:38:08 CST 2022 -->
+<!-- Generated by javadoc (17) on Tue Jan 10 07:20:57 CST 2023 -->
 <title>All Packages</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2022-07-03">
+<meta name="dc.created" content="2023-01-10">
 <meta name="description" content="package index">
 <meta name="generator" content="javadoc/AllPackagesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
-<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="all-packages-index-page">

diff --git a/docs/com/tianscar/jme3/imgui/JmeGlfwImGui.html b/docs/com/tianscar/jme3/imgui/JmeGlfwImGui.html
@@ -1,18 +1,18 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jul 03 16:38:08 CST 2022 -->
+<!-- Generated by javadoc (17) on Tue Jan 10 07:20:57 CST 2023 -->
 <title>JmeGlfwImGui</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2022-07-03">
+<meta name="dc.created" content="2023-01-10">
 <meta name="description" content="declaration: package: com.tianscar.jme3.imgui, class: JmeGlfwImGui">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
-<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">

diff --git a/docs/com/tianscar/jme3/imgui/JmeImGui.html b/docs/com/tianscar/jme3/imgui/JmeImGui.html
@@ -1,18 +1,18 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jul 03 16:38:08 CST 2022 -->
+<!-- Generated by javadoc (17) on Tue Jan 10 07:20:57 CST 2023 -->
 <title>JmeImGui</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2022-07-03">
+<meta name="dc.created" content="2023-01-10">
 <meta name="description" content="declaration: package: com.tianscar.jme3.imgui, class: JmeImGui">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
-<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">

diff --git a/docs/com/tianscar/jme3/imgui/JmeImGuiDelegate.html b/docs/com/tianscar/jme3/imgui/JmeImGuiDelegate.html
@@ -1,18 +1,18 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jul 03 16:38:08 CST 2022 -->
+<!-- Generated by javadoc (17) on Tue Jan 10 07:20:57 CST 2023 -->
 <title>JmeImGuiDelegate</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2022-07-03">
+<meta name="dc.created" content="2023-01-10">
 <meta name="description" content="declaration: package: com.tianscar.jme3.imgui, class: JmeImGuiDelegate">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
-<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">

diff --git a/docs/com/tianscar/jme3/imgui/package-summary.html b/docs/com/tianscar/jme3/imgui/package-summary.html
@@ -1,18 +1,18 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jul 03 16:38:08 CST 2022 -->
+<!-- Generated by javadoc (17) on Tue Jan 10 07:20:57 CST 2023 -->
 <title>com.tianscar.jme3.imgui</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2022-07-03">
+<meta name="dc.created" content="2023-01-10">
 <meta name="description" content="declaration: package: com.tianscar.jme3.imgui">
 <meta name="generator" content="javadoc/PackageWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
-<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="package-declaration-page">

diff --git a/docs/com/tianscar/jme3/imgui/package-tree.html b/docs/com/tianscar/jme3/imgui/package-tree.html
@@ -1,18 +1,18 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jul 03 16:38:08 CST 2022 -->
+<!-- Generated by javadoc (17) on Tue Jan 10 07:20:57 CST 2023 -->
 <title>com.tianscar.jme3.imgui Class Hierarchy</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2022-07-03">
+<meta name="dc.created" content="2023-01-10">
 <meta name="description" content="tree: package: com.tianscar.jme3.imgui">
 <meta name="generator" content="javadoc/PackageTreeWriter">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
-<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="package-tree-page">

diff --git a/docs/help-doc.html b/docs/help-doc.html
@@ -1,18 +1,18 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jul 03 16:38:08 CST 2022 -->
+<!-- Generated by javadoc (17) on Tue Jan 10 07:20:57 CST 2023 -->
 <title>API Help</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2022-07-03">
+<meta name="dc.created" content="2023-01-10">
 <meta name="description" content="help">
 <meta name="generator" content="javadoc/HelpWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
-<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="help-page">

diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html
@@ -1,18 +1,18 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jul 03 16:38:08 CST 2022 -->
+<!-- Generated by javadoc (17) on Tue Jan 10 07:20:57 CST 2023 -->
 <title>C-Index</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2022-07-03">
+<meta name="dc.created" content="2023-01-10">
 <meta name="description" content="index: C">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../script.js"></script>
-<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="../script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="index-page">

diff --git a/docs/index-files/index-2.html b/docs/index-files/index-2.html
@@ -1,18 +1,18 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jul 03 16:38:08 CST 2022 -->
+<!-- Generated by javadoc (17) on Tue Jan 10 07:20:57 CST 2023 -->
 <title>D-Index</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2022-07-03">
+<meta name="dc.created" content="2023-01-10">
 <meta name="description" content="index: D">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../script.js"></script>
-<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="../script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="index-page">

diff --git a/docs/index-files/index-3.html b/docs/index-files/index-3.html
@@ -1,18 +1,18 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jul 03 16:38:08 CST 2022 -->
+<!-- Generated by javadoc (17) on Tue Jan 10 07:20:57 CST 2023 -->
 <title>E-Index</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2022-07-03">
+<meta name="dc.created" content="2023-01-10">
 <meta name="description" content="index: E">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../script.js"></script>
-<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="../script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="index-page">

diff --git a/docs/index-files/index-4.html b/docs/index-files/index-4.html
@@ -1,18 +1,18 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jul 03 16:38:08 CST 2022 -->
+<!-- Generated by javadoc (17) on Tue Jan 10 07:20:57 CST 2023 -->
 <title>G-Index</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2022-07-03">
+<meta name="dc.created" content="2023-01-10">
 <meta name="description" content="index: G">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../script.js"></script>
-<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="../script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="index-page">

diff --git a/docs/index-files/index-5.html b/docs/index-files/index-5.html
@@ -1,18 +1,18 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jul 03 16:38:08 CST 2022 -->
+<!-- Generated by javadoc (17) on Tue Jan 10 07:20:57 CST 2023 -->
 <title>I-Index</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2022-07-03">
+<meta name="dc.created" content="2023-01-10">
 <meta name="description" content="index: I">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../script.js"></script>
-<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="../script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="index-page">

diff --git a/docs/index-files/index-6.html b/docs/index-files/index-6.html
@@ -1,18 +1,18 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jul 03 16:38:08 CST 2022 -->
+<!-- Generated by javadoc (17) on Tue Jan 10 07:20:57 CST 2023 -->
 <title>J-Index</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2022-07-03">
+<meta name="dc.created" content="2023-01-10">
 <meta name="description" content="index: J">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../script.js"></script>
-<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="../script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="index-page">