commit a53b2fe7b3949a943a67cf6cda283c94cde7edb4 Author: William Date: Wed Aug 24 13:09:16 2022 +0100 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b63da45 --- /dev/null +++ b/.gitignore @@ -0,0 +1,42 @@ +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### IntelliJ IDEA ### +.idea/modules.xml +.idea/jarRepositories.xml +.idea/compiler.xml +.idea/libraries/ +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### Eclipse ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ + +### Mac OS ### +.DS_Store \ No newline at end of file diff --git a/.idea/gradle.xml b/.idea/gradle.xml new file mode 100644 index 0000000..7b7dd5a --- /dev/null +++ b/.idea/gradle.xml @@ -0,0 +1,17 @@ + + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..b9d0bed --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/.idea/uiDesigner.xml b/.idea/uiDesigner.xml new file mode 100644 index 0000000..2b63946 --- /dev/null +++ b/.idea/uiDesigner.xml @@ -0,0 +1,124 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..94a25f7 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.idea/workspace.xml b/.idea/workspace.xml new file mode 100644 index 0000000..0294233 --- /dev/null +++ b/.idea/workspace.xml @@ -0,0 +1,196 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + false + true + false + + + + + + + + false + true + false + + + + + + + + false + true + false + + + + + + + + + + + + + + + + + + + + 1661334712505 + + + + + + + + + \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..db6f777 --- /dev/null +++ b/README.md @@ -0,0 +1,99 @@ +# DesertWell +[![Discord](https://img.shields.io/discord/818135932103557162?color=7289da&logo=discord)](https://discord.gg/tVYhJfyDWG) +[![](https://jitpack.io/v/net.william278/DesertWell.svg)](https://jitpack.io/#net.william278/DesertWell) + +DesertWell is a simple library providing various utilities to aid Minecraft plugin development. Requires Java 11+. + +![Example of an about menu](images/about-menu-screenshot.png) + +## Features +### About menus +`AboutMenu.class` allows for the generation of plugin about menus, as seen above. + +To create an about menu, use `AboutMenu#create(title)` with the resource name, then use the various builder methods to +build out the menu. + +```java +public class ExamplePlugin extends JavaPlugin { + + // Displays the about menu to the player and logs it to console + public void showAboutMenu(Player player) { + final AboutMenu menu = AboutMenu.create("Example") + .withDescription("A powerful, intuitive and flexible teleportation suite") + .withVersion(Version.fromString(plugin.getDescription().getVersion())) + .addAttribution("Author", + AboutMenu.Credit.of("William278").withDescription("Click to visit website").withUrl("https://william278.net")) + .addAttribution("Contributors", + AboutMenu.Credit.of("Contributor 1").withDescription("Code, refactoring") + .addAttribution("Translators", + AboutMenu.Credit.of("Translator 1").withDescription("Spanish (es-es)"), + AboutMenu.Credit.of("Translator 1").withDescription("Italian (it-it)") + .addButtons( + AboutMenu.Link.of("https://william278.net/").withText("Wesbite").withIcon("⛏"), + AboutMenu.Link.of("https://discord.gg/tVYhJfyDWG").withText("Discord").withIcon("⭐").withColor("#6773f5")))); + + // Display the menu to the player + player.spigot().sendMessage(menu.toMineDown().toComponents()); + + // Use #toString to get a console-friendly version of the menu + getLogger().info(AboutMenu.toString()); + } + +} +``` + +### Version +`Version.class` provides a simple way to compare semantic plugin and Minecraft versions. `VersionChecker.class` provides +a utility for querying Spigot resources for the latest version of a plugin and comparing with the current version in +order to check for updates. + +```java +public class ExamplePlugin extends JavaPlugin { + + // Checks for updates and logs to console + public void checkForUpdates() { + final int spigotResourceId = 97144; + final UpdateChecker updateChecker = UpdateChecker.create(Version.fromString("1.0.0"), spigotResourceId); + updateChecker.isUpToDate().thenAccept(upToDate -> { + if (upToDate) { + getLogger().info("Running the latest version (" + updateChecker.getCurrentVersion() + ")."); + } else { + getLogger().info("An update is available! Download from: https://www.spigotmc.org/resources/" + spigotResourceId); + } + }); + } + +} +``` + +## Installation +DesertWell is available on JitPack. You can browse the Javadocs [here](https://javadoc.jitpack.io/net/william278/DesertWell/latest/javadoc/). + +Note that your plugin will also need to shade (or shade a library that includes) [MineDown](https://github.com/Phoenix616/MineDown). + +### Maven +To include the library with Maven, in your `pom.xml` file, first add the JitPack repository: +```xml + + + jitpack.io + https://jitpack.io + + +``` + +Then, add the dependency in your `` section. Remember to replace `Tag` with the current DesertWell version. +```xml + + net.william278 + DesertWell + Tag + compile + +``` + +### Gradle & others +JitPack has a [handy guide](https://jitpack.io/#net.william278/DesertWell/#How_to) for how to use the dependency with other build platforms. + +## License +DesertWell is licensed under Apache-2.0. \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..25fb95e --- /dev/null +++ b/build.gradle @@ -0,0 +1,53 @@ +plugins { + id 'java' + id 'maven-publish' +} + +group 'net.william278' +version '1.0' + +repositories { + mavenCentral() + maven { url 'https://repo.minebench.de/' } +} + +dependencies { + compileOnly 'de.themoep:minedown:1.7.1-SNAPSHOT' + compileOnly 'org.jetbrains:annotations:23.0.0' + + testImplementation 'de.themoep:minedown:1.7.1-SNAPSHOT' + testImplementation 'net.md-5:bungeecord-chat:1.16-R0.4' + testImplementation 'org.junit.jupiter:junit-jupiter-api:5.9.0' + testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.9.0' +} + +compileJava.options.encoding = 'UTF-8' + +tasks.withType(JavaCompile) { + options.encoding = 'UTF-8' +} + +java { + withSourcesJar() + withJavadocJar() +} + +javadoc { + options.encoding = 'UTF-8' + options.addStringOption('Xdoclint:none', '-quiet') +} + +publishing { + publications { + shadow(MavenPublication) { publication -> + from components.java + } + } + repositories { + mavenLocal() + } +} + +test { + useJUnitPlatform() +} \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..41d9927 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..41dfb87 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/images/about-menu-screenshot.png b/images/about-menu-screenshot.png new file mode 100644 index 0000000..adff05a Binary files /dev/null and b/images/about-menu-screenshot.png differ diff --git a/jitpack.yml b/jitpack.yml new file mode 100644 index 0000000..47af859 --- /dev/null +++ b/jitpack.yml @@ -0,0 +1,5 @@ +# This file ensures jitpack builds DesertWell with Java 11 +jdk: + - 'openjdk11' +install: + - './gradlew clean publish' \ No newline at end of file diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..34e675b --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'DesertWell' \ No newline at end of file diff --git a/src/main/java/net/william278/desertwell/AboutMenu.java b/src/main/java/net/william278/desertwell/AboutMenu.java new file mode 100644 index 0000000..7bd0e48 --- /dev/null +++ b/src/main/java/net/william278/desertwell/AboutMenu.java @@ -0,0 +1,333 @@ +package net.william278.desertwell; + +import de.themoep.minedown.MineDown; +import de.themoep.minedown.Util; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import java.util.*; + +/** + * Utility for displaying a menu of information about a plugin + */ +@SuppressWarnings("unused") +public class AboutMenu { + @NotNull + private final String title; + @Nullable + private Version version; + @Nullable + private String description; + @NotNull + private final Map> attributions; + @NotNull + private final List buttons; + + private AboutMenu() { + this.title = ""; + this.buttons = new ArrayList<>(); + this.attributions = new LinkedHashMap<>(); + } + + private AboutMenu(@NotNull String title) { + this.title = title; + this.buttons = new ArrayList<>(); + this.attributions = new LinkedHashMap<>(); + } + + /** + * Create an about menu + * + * @param title The title of the menu (resource title) + * @return The {@link AboutMenu} + */ + @NotNull + public static AboutMenu create(@NotNull String title) { + return new AboutMenu(title); + } + + /** + * Set the description of the resource to display on the menu + * + * @param description The resource description + * @return The {@link AboutMenu} + */ + @NotNull + public AboutMenu withDescription(@Nullable String description) { + this.description = description; + return this; + } + + /** + * Set the {@link Version} of the resource to display on the menu + * + * @param version The resource version + * @return The {@link AboutMenu} + */ + @NotNull + public AboutMenu withVersion(@NotNull Version version) { + this.version = version; + return this; + } + + /** + * Add an attribution to the menu + * + * @param category The attribution category (e.g. {@code "Author"}) + * @param credits {@link Credit}s to add + * @return The {@link AboutMenu} + */ + @NotNull + public AboutMenu addAttribution(@NotNull String category, @NotNull Credit... credits) { + final List creditList = new ArrayList<>(Arrays.asList(credits)); + attributions.putIfAbsent(category, new ArrayList<>()); + attributions.get(category).addAll(creditList); + return this; + } + + /** + * Add linked buttons to the menu + * + * @param links {@link Link}s to add + * @return The {@link AboutMenu} + */ + @NotNull + public AboutMenu addButtons(@NotNull Link... links) { + buttons.addAll(Arrays.asList(links)); + return this; + } + + /** + * Return the formatted {@link MineDown} menu + * + * @return The {@link MineDown} menu + */ + @NotNull + public MineDown toMineDown() { + final StringJoiner menu = new StringJoiner("\n") + .add("[" + escapeMineDown(title) + "](#00fb9a bold)" + + (version != null ? " [| v" + escapeMineDown(version.toString()) + "](#00fb9a)" : "")); + if (description != null) { + menu.add("[" + escapeMineDown(description) + "](gray)"); + } + + if (!attributions.isEmpty()) { + menu.add(""); + } + for (Map.Entry> entry : attributions.entrySet()) { + final StringJoiner creditJoiner = new StringJoiner(", "); + for (final Credit credit : entry.getValue()) { + creditJoiner.add("[" + credit.name + "](" + credit.color + + (credit.description != null ? " show_text=&7" + escapeMineDown(credit.description) : "") + + (credit.url != null ? " open_url=" + escapeMineDown(credit.url) : "") + + ")"); + } + + if (!creditJoiner.toString().isBlank()) { + menu.add("[• " + entry.getKey() + ":](white) " + creditJoiner); + } + } + + if (!buttons.isEmpty()) { + final StringJoiner buttonsJoiner = new StringJoiner(" "); + for (final Link link : buttons) { + buttonsJoiner.add("[[" + (link.icon != null ? link.icon + " " : "") + + escapeMineDown(link.text) + "…]](" + link.color + " " + + "show_text=&7Click to open link open_url=" + escapeMineDown(link.url) + ")"); + } + menu.add("").add("[Links:](gray) " + buttonsJoiner); + } + + return new MineDown(menu.toString()).replace(); + } + + /** + * Return the plaintext string formatted menu. Use this for displaying to console + * + * @return The plaintext menu as a string + */ + @Override + @NotNull + public String toString() { + final StringJoiner menu = new StringJoiner("\n") + .add(title + (version != null ? " | Version " + version : "")); + if (description != null) { + menu.add(description); + } + + if (!attributions.entrySet().isEmpty()) { + menu.add("━━━━━━━━━━━━━━━━━━━━━━━━"); + } + for (final Map.Entry> entry : attributions.entrySet()) { + final StringJoiner creditJoiner = new StringJoiner(", "); + for (final Credit credit : entry.getValue()) { + creditJoiner.add(credit.name + (credit.description != null ? " (" + credit.description + ")" : "")); + } + + if (!creditJoiner.toString().isBlank()) { + menu.add("- " + entry.getKey() + ": " + creditJoiner); + } + } + + if (!buttons.isEmpty()) { + menu.add("━━━━━━━━━━━━━━━━━━━━━━━━"); + for (final Link link : buttons) { + menu.add("- " + link.text + ": " + link.url); + } + } + + return menu.toString(); + } + + /** + * Represents a link related to the resource + */ + public static class Link { + @NotNull + private String text = "Link"; + @NotNull + private String color = "#00fb9a"; + @Nullable + private String icon; + @NotNull + private final String url; + + private Link(@NotNull String url) { + this.url = url; + } + + /** + * Create a link from a URL + * + * @param url The URL + * @return The {@link Link} + */ + public static Link of(@NotNull String url) { + return new Link(url); + } + + /** + * Set the text describing the link + * + * @param text The text + * @return The {@link Link} + */ + public Link withText(@NotNull String text) { + this.text = text; + return this; + } + + /** + * Set the link button icon. Note this will not affect the string representation of the menu + * + * @param icon The icon character + * @return The {@link Link} + */ + public Link withIcon(@NotNull String icon) { + this.icon = icon; + return this; + } + + /** + * Set the link button color. Note this will not affect the string representation of the menu + * + * @param color The color + * @return The {@link Link} + */ + public Link withColor(@NotNull String color) { + this.color = color; + return this; + } + + } + + /** + * Represents information about someone who worked on the resource + */ + public static class Credit { + @NotNull + private final String name; + @Nullable + private String description; + @Nullable + private String url; + @NotNull + private String color = "gray"; + + private Credit(@NotNull String name) { + this.name = name; + } + + /** + * Create a credit from someone's name + * + * @param name The name of the person to credit + * @return The {@link Credit} + */ + public static Credit of(@NotNull String name) { + return new Credit(name); + } + + /** + * Set the description of the credit; i.e. what they did + * + * @param description The description of the credit (what they did) + * @return The {@link Credit} + */ + public Credit withDescription(@Nullable String description) { + this.description = description; + return this; + } + + /** + * Set the URL of the credit; i.e. their website. Note this has no effect on the string representation of the menu + * + * @param url The URL of the credit (i.e. their website) + * @return The {@link Credit} + */ + public Credit withUrl(@Nullable String url) { + this.url = url; + return this; + } + + /** + * Set the color of the credit. Note this has no effect on the string representation of the menu + * + * @param color The color of the credit + * @return The {@link Credit} + */ + public Credit withColor(@NotNull String color) { + this.color = color; + return this; + } + + } + + /** + * Escape a string from {@link MineDown} formatting for use in a MineDown-formatted locale + *

+ * Although MineDown provides {@link MineDown#escape(String)}, that method fails to escape events + * properly when using the escaped string in a replacement, so this is used instead + * + * @param string The string to escape + * @return The escaped string + */ + @NotNull + private static String escapeMineDown(@NotNull String string) { + final StringBuilder value = new StringBuilder(); + for (int i = 0; i < string.length(); ++i) { + char c = string.charAt(i); + boolean isEscape = c == '\\'; + boolean isColorCode = i + 1 < string.length() && (c == 167 || c == '&'); + boolean isEvent = c == '[' || c == ']' || c == '(' || c == ')'; + boolean isFormatting = (c == '_' || c == '*' || c == '~' || c == '?' || c == '#') && Util.isDouble(string, i); + if (isEscape || isColorCode || isEvent || isFormatting) { + value.append('\\'); + } + + value.append(c); + } + return value.toString(); + } + +} diff --git a/src/main/java/net/william278/desertwell/UpdateChecker.java b/src/main/java/net/william278/desertwell/UpdateChecker.java new file mode 100644 index 0000000..deb429d --- /dev/null +++ b/src/main/java/net/william278/desertwell/UpdateChecker.java @@ -0,0 +1,80 @@ +package net.william278.desertwell; + +import org.jetbrains.annotations.NotNull; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStreamReader; +import java.net.URL; +import java.util.concurrent.CompletableFuture; + +/** + * Utility for comparing a {@link Version} against the latest version on SpigotMC + */ +@SuppressWarnings("unused") +public class UpdateChecker { + // The SpigotMC.org website API endpoint + private static final String SPIGOT_API_ENDPOINT = "https://api.spigotmc.org/legacy/update.php?resource="; + @NotNull + private final Version currentVersion; + private int resourceId; + + private UpdateChecker() { + this.currentVersion = new Version(); + } + + private UpdateChecker(@NotNull Version currentVersion, final int resourceId) { + this.currentVersion = currentVersion; + this.resourceId = resourceId; + } + + /** + * Create a new UpdateChecker for a plugin + * + * @param currentVersion The current version of the plugin + * @param resourceId The resource ID of the plugin on SpigotMC + * @return The {@link UpdateChecker} + */ + public static UpdateChecker create(@NotNull Version currentVersion, final int resourceId) { + return new UpdateChecker(currentVersion, resourceId); + } + + /** + * Return the current plugin {@link Version} + * + * @return The current plugin {@link Version} + */ + @NotNull + public Version getCurrentVersion() { + return currentVersion; + } + + /** + * Query SpigotMC for the latest {@link Version} of the plugin + * + * @return A {@link CompletableFuture} containing the latest {@link Version} of the plugin + */ + public CompletableFuture getLatestVersion() { + return CompletableFuture.supplyAsync(() -> { + try (final InputStreamReader inputStreamReader = new InputStreamReader( + new URL(SPIGOT_API_ENDPOINT + resourceId).openConnection().getInputStream())) { + return Version.fromString(new BufferedReader(inputStreamReader).readLine()); + } catch (IOException e) { + throw new IllegalStateException("Unable to fetch latest version", e); + } + }).exceptionally(throwable -> { + throwable.printStackTrace(); + return new Version(); + }); + } + + /** + * Check if the current plugin {@link Version} is outdated compared to {@link #getLatestVersion()} + * + * @return A {@link CompletableFuture} containing true if the current plugin {@link Version} is outdated + */ + public CompletableFuture isUpToDate() { + return getLatestVersion().thenApply(latestVersion -> currentVersion.compareTo(latestVersion) > 0); + } + +} \ No newline at end of file diff --git a/src/main/java/net/william278/desertwell/Version.java b/src/main/java/net/william278/desertwell/Version.java new file mode 100644 index 0000000..d607b1c --- /dev/null +++ b/src/main/java/net/william278/desertwell/Version.java @@ -0,0 +1,171 @@ +package net.william278.desertwell; + +import org.jetbrains.annotations.NotNull; + +import java.util.Arrays; +import java.util.StringJoiner; +import java.util.regex.Pattern; + +/** + * Utility for parsing and then comparing a semantic version string + */ +@SuppressWarnings("unused") +public class Version implements Comparable { + private final String VERSION_DELIMITER = "."; + private static final String MINECRAFT_META_DELIMITER = "-"; + private static final String PLUGIN_META_DELIMITER = "+"; + // Major, minor and patch version numbers + private int[] versions = new int[]{}; + @NotNull + private String metadata = ""; + @NotNull + private String metaSeparator = ""; + + protected Version() { + } + + private Version(@NotNull String version, @NotNull String metaDelimiter) { + this.parse(version, metaDelimiter); + this.metaSeparator = metaDelimiter; + } + + /** + * Create a new {@link Version} by parsing a string + * + * @param version The version string to parse + * @param metaDelimiter The delimiter separating version numbers from metadata to use + * @return The {@link Version} + */ + @NotNull + public static Version fromString(@NotNull String version, @NotNull String metaDelimiter) { + return new Version(version, metaDelimiter); + } + + /** + * Create a new {@link Version} by parsing a string + * + * @param versionString The version string to parse + * @return The {@link Version} + * @implNote The default meta delimiter that will be used is {@link #PLUGIN_META_DELIMITER} + */ + @NotNull + public static Version fromString(@NotNull String versionString) { + return new Version(versionString, PLUGIN_META_DELIMITER); + } + + /** + * Create a new {@link Version} by parsing a Minecraft string + * + * @param versionString The Minecraft version string to parse + * @return The {@link Version} + * @implNote The meta delimiter that will be used is {@link #MINECRAFT_META_DELIMITER} + */ + @NotNull + public static Version fromMinecraftVersionString(@NotNull String versionString) { + return new Version(versionString, MINECRAFT_META_DELIMITER); + } + + /** + * Parses a version string, including metadata, with the specified delimiter + * + * @param version The version string to parse + * @param metaDelimiter The metadata delimiter + */ + private void parse(@NotNull String version, @NotNull String metaDelimiter) { + int metaIndex = version.indexOf(metaDelimiter); + if (metaIndex > 0) { + this.metadata = version.substring(metaIndex + 1); + version = version.substring(0, metaIndex); + } + String[] versions = version.split(Pattern.quote(VERSION_DELIMITER)); + this.versions = Arrays.stream(versions).mapToInt(Integer::parseInt).toArray(); + } + + /** + * Compare this {@link Version} to another {@link Version} + * + * @param other the object to be compared. + * @return a negative integer, zero, or a positive integer as this version is less than, equal to, or greater + * than the other version in terms of the semantic major, minor and patch versioning standard. + */ + @Override + public int compareTo(@NotNull Version other) { + int length = Math.max(this.versions.length, other.versions.length); + for (int i = 0; i < length; i++) { + int a = i < this.versions.length ? this.versions[i] : 0; + int b = i < other.versions.length ? other.versions[i] : 0; + + if (a < b) return -1; + if (a > b) return 1; + } + + return 0; + } + + /** + * Get the string representation of this {@link Version} + * + * @return The string representation of this {@link Version} + */ + @Override + @NotNull + public String toString() { + final StringJoiner joiner = new StringJoiner(VERSION_DELIMITER); + for (int version : this.versions) { + joiner.add(String.valueOf(version)); + } + return joiner + ((!this.metadata.isEmpty()) ? (this.metaSeparator + this.metadata) : ""); + } + + /** + * Get the string representation of this {@link Version}, without metadata + * + * @return The string representation of this {@link Version} without metadata + */ + @NotNull + public String toStringWithoutMetadata() { + final StringJoiner joiner = new StringJoiner(VERSION_DELIMITER); + for (int version : this.versions) { + joiner.add(String.valueOf(version)); + } + return joiner.toString(); + } + + /** + * Get the major version number. + * + * @return The major version number. + */ + public int getMajor() { + return this.versions[0]; + } + + /** + * Get the minor version number. + * + * @return The minor version number. + */ + public int getMinor() { + return this.versions[1]; + } + + /** + * Get the patch version number. + * + * @return The patch version number. + */ + public int getPatch() { + return this.versions[2]; + } + + /** + * Get the version metadata. + * + * @return The metadata. + */ + @NotNull + public String getMetadata() { + return this.metadata; + } + +} diff --git a/src/test/java/net/william278/desertwell/UpdateCheckerTests.java b/src/test/java/net/william278/desertwell/UpdateCheckerTests.java new file mode 100644 index 0000000..5efa054 --- /dev/null +++ b/src/test/java/net/william278/desertwell/UpdateCheckerTests.java @@ -0,0 +1,15 @@ +package net.william278.desertwell; + +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; + +public class UpdateCheckerTests { + + @Test + public void testUpdateChecker() { + // Tests against the HuskSync resource ID + final UpdateChecker updateChecker = UpdateChecker.create(Version.fromString("1.0.0"), 97144); + Assertions.assertFalse(updateChecker.isUpToDate().join()); + } + +} diff --git a/src/test/java/net/william278/desertwell/VersionTests.java b/src/test/java/net/william278/desertwell/VersionTests.java new file mode 100644 index 0000000..0324544 --- /dev/null +++ b/src/test/java/net/william278/desertwell/VersionTests.java @@ -0,0 +1,41 @@ +package net.william278.desertwell; + +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; + +// Tests for the Version class +public class VersionTests { + + @Test + public void testVersionParsing() { + final Version version = Version.fromString("1.2.3"); + Assertions.assertEquals(1, version.getMajor()); + Assertions.assertEquals(2, version.getMinor()); + Assertions.assertEquals(3, version.getPatch()); + Assertions.assertEquals("", version.getMetadata()); + } + + @Test + public void testVersionComparing() { + final Version oldVersion = Version.fromString("1.0.0"); + final Version newVersion = Version.fromString("1.0.1"); + Assertions.assertTrue(oldVersion.compareTo(newVersion) < 0); + } + + @Test + public void testVersionComparingWithMetadata() { + final Version oldVersion = Version.fromString("1.0.0+dev"); + final Version newVersion = Version.fromString("1.0.1+snapshot-123"); + Assertions.assertTrue(oldVersion.compareTo(newVersion) < 0); + } + + @Test + public void testParsingMinecraftVersion() { + final Version version = Version.fromMinecraftVersionString("1.2.3-SNAPSHOT"); + Assertions.assertEquals(1, version.getMajor()); + Assertions.assertEquals(2, version.getMinor()); + Assertions.assertEquals(3, version.getPatch()); + Assertions.assertEquals("SNAPSHOT", version.getMetadata()); + } + +}