Merge pull request #23 from PXAV/development

Prepare repository for Maven Central deployment

CHANGELOG.md

@@ -31,18 +31,13 @@ The headlines with `MR <number>` stand for the major release. The following head
 * Fixed bug that CPU load was on 100% when `AnimatedInventory` was opened.
 * Fixed NPE when trying to get item tags of items with type `AIR`
 
-#### v0.0.3 (15.08.2020)
+#### v0.0.3 (12.09.2020)
 * **The particle engine update**
 
-**NEW:** 
+* Kelp can now be referenced through a build tool like Maven or Gradle as it is now part of the Maven Central Repository.
 * Create `ParticleType` class that maps particle type names across different versions.
 * Create version template `ParticleVersionTemplate` and a v1.8 implementation for version independent particle spawning
 * Create particle effect system to spawn complex particle effects.
-
-**FIXED:**
 * If you request a `ScheduledExecutorService` in a constructor annotated with `@Inject` by Guice, a new scheduled thread pool will be injected automatically.
 
-**NOTES**:
-This release only creates a basis of the particle system for kelp. More particle types and effects will follow in the next releases. If you have ideas for more particle effects, feel free to create an own particle effect class and open a PR for it.
-
 

README.md

@@ -2,7 +2,7 @@
 
 > Developed by pxav (c) 2019-2020
 
-![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/PXAV/kelp?include_prereleases&label=version) ![GitHub issues](https://img.shields.io/github/issues/PXAV/finate-studio-java) ![GitHub pull requests](https://img.shields.io/github/issues-pr/PXAV/kelp) ![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/PXAV/kelp) ![Development Indicator](https://img.shields.io/badge/development-active-brightgreen)
+![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/PXAV/kelp?include_prereleases&label=version) ![GitHub issues](https://img.shields.io/github/issues/PXAV/kelp) ![GitHub pull requests](https://img.shields.io/github/issues-pr/PXAV/kelp) ![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/PXAV/kelp) ![Development Indicator](https://img.shields.io/badge/development-active-brightgreen)
 
 
 
@@ -81,7 +81,7 @@ playerConnection.sendPacket(spawnPacket);
 
 
 
-### Feature overview
+## Feature overview
 
 - **Sidebar system:** Create sidebars - no matter if animated or just simple & casual. Use up to 32 chars per line and enjoy flicker-free updating
 - **Inventory system:** Create stunning GUIs with minimal effort, use an integrated listener system and meet helpful pre-defined or custom widgets. Never mess with changed material names anymore.
@@ -94,7 +94,12 @@ playerConnection.sendPacket(spawnPacket);
 
 
 
-### Support
+## Support & Requirements
+
+The following requirements are needed:
+* Java 8 or higher
+* A server with Linux/Windows (MacOS has not been tested sufficiently yet)
+* A spigot/paper server with one of the supported versions
 
 There are version implementations for the following version implementations available:
 
@@ -110,7 +115,33 @@ There are version implementations for the following version implementations avai
 | 1.14           | ❌         | Work in progress                                             |
 | 1.15           | ❌         | Following soon                                               |
 
+## Downloading
+
+#### Maven
+```xml
+<dependency>
+  <groupId>com.github.pxav.kelp</groupId>
+  <artifactId>core</artifactId>
+  <version>0.0.3</version>
+</dependency>
+```
+
+### Gradle
+```shell script
+implementation 'com.github.pxav.kelp:core:0.0.3'
+```
+
+### Bazel
+```shell script
+maven_jar(
+    name = "core",
+    artifact = "com.github.pxav.kelp:core:0.0.3",
+    sha1 = "4743f29c20f3b033de5fe8c1eddb374511fa31d8",
+)
+```
 
+### Pre-built files
+If you are a server owner who simply needs the jar files or a developer who does not use a built tool like Maven, you can simply download the pre-built jar files from the [Releaes page](https://github.com/PXAV/kelp/releases). There you can find all versions, but it's recommended to use the latest.
 
 ### Build from source
 
@@ -132,21 +163,13 @@ mvn install
 
 
 
-### How to use
-
-#### For server owners
-
-Put the jar file of the core module into the normal `plugins` folder of your server. Start the server and wait until Kelp has generated the required folders. Pick the right version module for your server and drag it into the `kelp_versions` folder. Reload/Restart the server and Kelp should be ready to use. **Note:** Plugins based on Kelp go into the `kelp_plugins` folder!
-
-
-
-#### For developers
+## How to use
 
 Check out the [KelpWiki](https://github.com/PXAV/kelp/wiki), where you can find tutorials about the different features of Kelp. It is not 100% complete but constantly updated. Furthermore most of the classes and methods have JavaDocs, so check them out. A separate JavaDoc page is following soon. 
 
 
 
-### Contributing
+## Contributing
 
 Currently Kelp is developed by a single developer and bug reports, feature suggestions and pull requests are very welcome. If you want to contribute to the code, have a look at our [contribution guidelines](CONTRIBUTING.md). If you have bug reports, ideas, or need support feel free to open a new issue here on GitHub. 
 

core/pom.xml

@@ -3,9 +3,9 @@
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <parent>
-    <groupId>de.pxav.kelp</groupId>
+    <groupId>com.github.pxav.kelp</groupId>
     <artifactId>parent</artifactId>
-    <version>0.0.3-SNAPSHOT</version>
+    <version>0.0.3</version>
   </parent>
 
   <modelVersion>4.0.0</modelVersion>
@@ -19,11 +19,69 @@
     </repository>
   </repositories>
 
+  <profiles>
+    <profile>
+      <id>central-deploy</id>
+      <activation>
+        <activeByDefault>false</activeByDefault>
+      </activation>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-source-plugin</artifactId>
+            <version>2.2.1</version>
+            <executions>
+              <execution>
+                <id>attach-sources</id>
+                <goals>
+                  <goal>jar-no-fork</goal>
+                </goals>
+              </execution>
+            </executions>
+          </plugin>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-javadoc-plugin</artifactId>
+            <version>2.9.1</version>
+            <executions>
+              <execution>
+                <id>attach-javadocs</id>
+                <goals>
+                  <goal>jar</goal>
+                </goals>
+              </execution>
+            </executions>
+          </plugin>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-gpg-plugin</artifactId>
+            <version>1.5</version>
+            <executions>
+              <execution>
+                <id>sign-artifacts</id>
+                <phase>verify</phase>
+                <goals>
+                  <goal>sign</goal>
+                </goals>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
+
   <build>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
+        <version>3.8.1</version>
+        <configuration>
+          <source>8</source>
+          <target>8</target>
+        </configuration>
       </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>

core/src/main/java/de/pxav/kelp/core/KelpPlugin.java

@@ -34,7 +34,7 @@
  *
  * @author pxav
  */
-@Plugin(name = "Kelp", version = "0.0.3-SNAPSHOT")
+@Plugin(name = "Kelp", version = "0.0.3")
 @Author("pxav")
 @Description("A cross version spigot framework.")
 @Singleton