From af84f3001276b2f0a747747c3367220b651095bc Mon Sep 17 00:00:00 2001 From: pxav Date: Sat, 15 Aug 2020 11:58:25 +0200 Subject: [PATCH 1/7] Change version from SNAPSHOT to release --- core/pom.xml | 2 +- core/src/main/java/de/pxav/kelp/core/KelpPlugin.java | 2 +- pom.xml | 2 +- testing-module/pom.xml | 2 +- v1_8_implementation/pom.xml | 2 +- v_1_14_implementation/pom.xml | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/core/pom.xml b/core/pom.xml index 4fa0e916..7c0b3cc9 100644 --- a/core/pom.xml +++ b/core/pom.xml @@ -5,7 +5,7 @@ de.pxav.kelp parent - 0.0.3-SNAPSHOT + 0.0.3 4.0.0 diff --git a/core/src/main/java/de/pxav/kelp/core/KelpPlugin.java b/core/src/main/java/de/pxav/kelp/core/KelpPlugin.java index e51892fb..31a576fb 100644 --- a/core/src/main/java/de/pxav/kelp/core/KelpPlugin.java +++ b/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 diff --git a/pom.xml b/pom.xml index ffb87d25..444d4ece 100644 --- a/pom.xml +++ b/pom.xml @@ -7,7 +7,7 @@ de.pxav.kelp parent pom - 0.0.3-SNAPSHOT + 0.0.3 core diff --git a/testing-module/pom.xml b/testing-module/pom.xml index d9d69299..f65eb876 100644 --- a/testing-module/pom.xml +++ b/testing-module/pom.xml @@ -5,7 +5,7 @@ parent de.pxav.kelp - 0.0.3-SNAPSHOT + 0.0.3 4.0.0 diff --git a/v1_8_implementation/pom.xml b/v1_8_implementation/pom.xml index 89e2b6ce..c3d1aba0 100644 --- a/v1_8_implementation/pom.xml +++ b/v1_8_implementation/pom.xml @@ -5,7 +5,7 @@ de.pxav.kelp parent - 0.0.3-SNAPSHOT + 0.0.3 4.0.0 diff --git a/v_1_14_implementation/pom.xml b/v_1_14_implementation/pom.xml index df875f2b..a1544969 100644 --- a/v_1_14_implementation/pom.xml +++ b/v_1_14_implementation/pom.xml @@ -5,7 +5,7 @@ parent de.pxav.kelp - 0.0.3-SNAPSHOT + 0.0.3 4.0.0 From 4f631a33b3ae2e7e42c0561090b486618b63a5cc Mon Sep 17 00:00:00 2001 From: pxav Date: Sat, 12 Sep 2020 15:57:59 +0200 Subject: [PATCH 2/7] Fix bug that issues of finate-studio repository were displayed in the README file --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 90a40353..9f90d194 100644 --- a/README.md +++ b/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) From 4190b5460c87345d69ad0b5be23ceca88d01066d Mon Sep 17 00:00:00 2001 From: pxav Date: Sat, 12 Sep 2020 16:18:27 +0200 Subject: [PATCH 3/7] Maven repository is now written in the README file --- README.md | 38 ++++++++++++++++++++++++++------------ 1 file changed, 26 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 9f90d194..229050c2 100644 --- a/README.md +++ b/README.md @@ -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,24 @@ There are version implementations for the following version implementations avai | 1.14 | ❌ | Work in progress | | 1.15 | ❌ | Following soon | +## Downloading + +#### Maven +```xml + + com.github.pxav.kelp + core + 0.0.3 + +``` + +### Gradle +```shell script +implementation 'com.github.pxav.kelp:core:0.0.3' +``` +### 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 +154,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. From 79546123704a3ae767453ae411e38695cdc339bc Mon Sep 17 00:00:00 2001 From: pxav Date: Sat, 12 Sep 2020 16:19:05 +0200 Subject: [PATCH 4/7] Update POM files to match the requirements set by Sonatype OSSRH --- pom.xml | 122 +++++++++++++++++++++++++++++++++- testing-module/pom.xml | 19 +++++- v1_8_implementation/pom.xml | 19 +++++- v_1_14_implementation/pom.xml | 19 +++++- 4 files changed, 169 insertions(+), 10 deletions(-) diff --git a/pom.xml b/pom.xml index 444d4ece..6bd5affe 100644 --- a/pom.xml +++ b/pom.xml @@ -4,11 +4,51 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 4.0.0 - de.pxav.kelp + com.github.pxav.kelp parent pom 0.0.3 + Kelp + A cross-version spigot framework to avoid boilerplate code and make your plugin compatible with multiple spigot versions easily + https://www.github.com/PXAV/kelp + + + + MIT License + http://www.opensource.org/licenses/mit-license.php + + + + + + PXAV + com.github.pxav + https://www.github.com/PXAV + + + Etrayed + com.github.etrayed + https://www.github.com/Etrayed + + + Paul + com.github.paul2708 + https://www.github.com/Paul2708 + + + Shatuxy + com.github.shatuxy + https://www.github.com/Shatuxy + + + + + scm:git:git://github.com/PXAV/kelp.git + scm:git:ssh://github.com:PXAV/kelp.git + http://github.com/PXAV/kelp/tree/master + + core v1_8_implementation @@ -30,9 +70,31 @@ + + + ossrh + https://oss.sonatype.org/content/repositories/snapshots + + + ossrh + https://oss.sonatype.org/service/local/staging/deploy/maven2/ + + + + + org.sonatype.plugins + nexus-staging-maven-plugin + 1.6.7 + true + + ossrh + https://oss.sonatype.org/ + true + + org.apache.maven.plugins maven-shade-plugin @@ -63,13 +125,71 @@ org.apache.maven.plugins maven-compiler-plugin + 3.8.1 8 8 + + org.apache.maven.plugins + maven-source-plugin + 2.2.1 + + + attach-sources + + jar-no-fork + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 2.9.1 + + + attach-javadocs + + jar + + + + + + org.apache.maven.plugins + maven-gpg-plugin + 1.5 + + + sign-artifacts + install + + sign + + + + + + + org.apache.maven.plugins + maven-gpg-plugin + 1.5 + + + sign-artifacts + install + + sign + + + + false + + \ No newline at end of file diff --git a/testing-module/pom.xml b/testing-module/pom.xml index f65eb876..77190eea 100644 --- a/testing-module/pom.xml +++ b/testing-module/pom.xml @@ -4,7 +4,7 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> parent - de.pxav.kelp + com.github.pxav.kelp 0.0.3 4.0.0 @@ -16,6 +16,19 @@ org.apache.maven.plugins maven-compiler-plugin + 3.8.1 + + 8 + 8 + + + + org.apache.maven.plugins + maven-deploy-plugin + 2.8.2 + + true + @@ -27,9 +40,9 @@ - de.pxav.kelp + com.github.pxav.kelp core - 0.0.3-SNAPSHOT + 0.0.3 provided diff --git a/v1_8_implementation/pom.xml b/v1_8_implementation/pom.xml index c3d1aba0..dd276eb7 100644 --- a/v1_8_implementation/pom.xml +++ b/v1_8_implementation/pom.xml @@ -3,7 +3,7 @@ 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"> - de.pxav.kelp + com.github.pxav.kelp parent 0.0.3 @@ -23,11 +23,24 @@ org.apache.maven.plugins maven-compiler-plugin + 3.8.1 + + 8 + 8 + org.apache.maven.plugins maven-shade-plugin + + org.apache.maven.plugins + maven-deploy-plugin + 2.8.2 + + true + + @@ -72,9 +85,9 @@ - de.pxav.kelp + com.github.pxav.kelp core - 0.0.3-SNAPSHOT + 0.0.3 provided diff --git a/v_1_14_implementation/pom.xml b/v_1_14_implementation/pom.xml index a1544969..53eba5df 100644 --- a/v_1_14_implementation/pom.xml +++ b/v_1_14_implementation/pom.xml @@ -4,7 +4,7 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> parent - de.pxav.kelp + com.github.pxav.kelp 0.0.3 4.0.0 @@ -23,11 +23,24 @@ org.apache.maven.plugins maven-compiler-plugin + 3.8.1 + + 8 + 8 + org.apache.maven.plugins maven-shade-plugin + + org.apache.maven.plugins + maven-deploy-plugin + 2.8.2 + + true + + @@ -39,9 +52,9 @@ - de.pxav.kelp + com.github.pxav.kelp core - 0.0.3-SNAPSHOT + 0.0.3 org.spigotmc From 8f237ab040ba410974055d20d703fee585499036 Mon Sep 17 00:00:00 2001 From: pxav Date: Sat, 12 Sep 2020 16:21:44 +0200 Subject: [PATCH 5/7] Update CHANGELOG.md --- CHANGELOG.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 83754b40..979abb7c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -31,18 +31,13 @@ The headlines with `MR ` 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. - From 5a119774896b4ddaa91b98016846cc8629023924 Mon Sep 17 00:00:00 2001 From: pxav Date: Sat, 12 Sep 2020 16:23:03 +0200 Subject: [PATCH 6/7] Add Bazel dependency reference to README file --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 229050c2..47ddc482 100644 --- a/README.md +++ b/README.md @@ -131,6 +131,15 @@ There are version implementations for the following version implementations avai 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. From c5c341fb9ae0a4b966ff63938572eb5ef0678b83 Mon Sep 17 00:00:00 2001 From: pxav Date: Sat, 12 Sep 2020 16:47:48 +0200 Subject: [PATCH 7/7] Create separate profile for deployment to not always be forced to enter the GPG passphrase or wait for javadocs to generate --- core/pom.xml | 60 ++++++++++++++++++++++- pom.xml | 131 +++++++++++++++++++++++++++++++++++---------------- 2 files changed, 149 insertions(+), 42 deletions(-) diff --git a/core/pom.xml b/core/pom.xml index 7c0b3cc9..8793f4ca 100644 --- a/core/pom.xml +++ b/core/pom.xml @@ -3,7 +3,7 @@ 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"> - de.pxav.kelp + com.github.pxav.kelp parent 0.0.3 @@ -19,11 +19,69 @@ + + + central-deploy + + false + + + + + org.apache.maven.plugins + maven-source-plugin + 2.2.1 + + + attach-sources + + jar-no-fork + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 2.9.1 + + + attach-javadocs + + jar + + + + + + org.apache.maven.plugins + maven-gpg-plugin + 1.5 + + + sign-artifacts + verify + + sign + + + + + + + + + org.apache.maven.plugins maven-compiler-plugin + 3.8.1 + + 8 + 8 + org.apache.maven.plugins diff --git a/pom.xml b/pom.xml index 6bd5affe..8adf5a46 100644 --- a/pom.xml +++ b/pom.xml @@ -81,20 +81,98 @@ + + + + + central-deploy + + false + + + + + + org.sonatype.plugins + nexus-staging-maven-plugin + 1.6.7 + true + + ossrh + https://oss.sonatype.org/ + true + + + + org.apache.maven.plugins + maven-source-plugin + 2.2.1 + + + attach-sources + + jar-no-fork + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 2.9.1 + + + attach-javadocs + + jar + + + + + + org.apache.maven.plugins + maven-gpg-plugin + 1.5 + + + sign-artifacts + install + + sign + + + + + + + + + + org.apache.maven.plugins + maven-gpg-plugin + 1.5 + + + sign-artifacts + install + + sign + + + + false + + + + + + - - org.sonatype.plugins - nexus-staging-maven-plugin - 1.6.7 - true - - ossrh - https://oss.sonatype.org/ - true - - org.apache.maven.plugins maven-shade-plugin @@ -131,19 +209,6 @@ 8 - - org.apache.maven.plugins - maven-source-plugin - 2.2.1 - - - attach-sources - - jar-no-fork - - - - org.apache.maven.plugins maven-javadoc-plugin @@ -173,23 +238,7 @@ - - - org.apache.maven.plugins - maven-gpg-plugin - 1.5 - - - sign-artifacts - install - - sign - - - - false - - + \ No newline at end of file