commit 26d3e4eac583ac173421899ad5d9899e4fdf1044 Author: TheTrouper <93684527+thetrouper@users.noreply.github.com> Date: Thu Feb 16 21:33:59 2023 -0600 Initial commit diff --git a/ExamplePlugin.iml b/ExamplePlugin.iml new file mode 100644 index 0000000..18ec59d --- /dev/null +++ b/ExamplePlugin.iml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..bcd0e9f --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# ExamplePluginTemplate +An example plugin template for beginners! +----------------------------------------------------- + +Trying to create your first plugin? Use this template to get started easily! + +- Comments to guide you +- Made some example classes +- Added some useful utils + +----------------------------------------------------- + +## How to use + +Download this template -\> Load it into your IDE or development environment. [Check out IntelliJ](https://www.jetbrains.com/idea/download/?fromIDE=#section=windows) -\> Get Creative! + +- To build your jar file simply go into the terminal and run `./gradlew build` +- Your finished jar should appear in `build/libs`! + +----------------------------------------------------- + +Have a nice day, happy coding! diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..0dbd6d4 --- /dev/null +++ b/build.gradle @@ -0,0 +1,54 @@ +plugins { + id 'java' +} + +group = 'io.github.itzispyder' +version = '(YourPluginVersion)' + +repositories { + mavenCentral() + maven { + name = 'spigotmc-repo' + url = 'https://hub.spigotmc.org/nexus/content/repositories/snapshots/' + } + maven { + name = 'sonatype' + url = 'https://oss.sonatype.org/content/groups/public/' + } +} + +dependencies { + compileOnly 'org.spigotmc:spigot-api:1.17.1-R0.1-SNAPSHOT' +} + +def targetJavaVersion = 16 +java { + def javaVersion = JavaVersion.toVersion(targetJavaVersion) + sourceCompatibility = javaVersion + targetCompatibility = javaVersion + if (JavaVersion.current() < javaVersion) { + toolchain.languageVersion = JavaLanguageVersion.of(targetJavaVersion) + } +} + +tasks.withType(JavaCompile).configureEach { + if (targetJavaVersion >= 10 || JavaVersion.current().isJava10Compatible()) { + options.release = targetJavaVersion + } +} + +processResources { + def props = [version: version] + inputs.properties props + filteringCharset 'UTF-8' + filesMatching('plugin.yml') { + expand props + } +} + +compileJava.options.encoding("UTF-8") + +tasks.withType(JavaCompile) { + options.encoding = "UTF-8" +} + diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..e69de29 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..7454180 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..2e6e589 --- /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.3.3-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..c53aefa --- /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..ac1b06f --- /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/settings.gradle b/settings.gradle new file mode 100644 index 0000000..5d51a16 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'ExamplePlugin' diff --git a/src/main/java/io/github/itzispyder/exampleplugin/ExamplePlugin.java b/src/main/java/io/github/itzispyder/exampleplugin/ExamplePlugin.java new file mode 100644 index 0000000..0358267 --- /dev/null +++ b/src/main/java/io/github/itzispyder/exampleplugin/ExamplePlugin.java @@ -0,0 +1,66 @@ +/** + * This file is for tutorial purposes made by ImproperIssues. Distribute if you want :) + */ + +package io.github.itzispyder.exampleplugin; + +import io.github.itzispyder.exampleplugin.commands.CommandExample; +import io.github.itzispyder.exampleplugin.data.Config; +import io.github.itzispyder.exampleplugin.events.ExampleEvent; +import org.bukkit.Bukkit; +import org.bukkit.plugin.Plugin; +import org.bukkit.plugin.PluginManager; +import org.bukkit.plugin.java.JavaPlugin; + +import java.util.logging.Logger; + +/** + * This is your main class, you register everything important here. + * + * To build the jar, go to terminal and run "./gradlew build" + */ +public final class ExamplePlugin extends JavaPlugin { + + public static final PluginManager manager = Bukkit.getPluginManager(); + public static String starter = ""; + public static final Logger log = Bukkit.getLogger(); + + /** + * Plugin startup logic + */ + @Override + public void onEnable() { + // Plugin startup logic + log.info("Example plugin has loaded! (" + getDescription().getVersion() + ")"); + starter = Config.Plugin.getPrefix() + " "; + + // Files + getConfig().options().copyDefaults(); + saveDefaultConfig(); + + // Commands -> BE SURE TO REGISTER ANY NEW COMMANDS IN PLUGIN.YML (src/main/java/resources/plugin.yml)! + getCommand("example").setExecutor(new CommandExample()); + getCommand("example").setTabCompleter(new CommandExample.Tabs()); + + // Events + manager.registerEvents(new ExampleEvent(),this); + + } + + /** + * Plugin shutdown logic + */ + @Override + public void onDisable() { + // Plugin shutdown logic + log.info("Example plugin has disabled! (" + getDescription().getVersion() + ")"); + } + + /** + * Returns an instance of this plugin + * @return an instance of this plugin + */ + public static Plugin getInstance() { + return manager.getPlugin("ExamplePlugin"); + } +} diff --git a/src/main/java/io/github/itzispyder/exampleplugin/commands/CommandExample.java b/src/main/java/io/github/itzispyder/exampleplugin/commands/CommandExample.java new file mode 100644 index 0000000..87f0113 --- /dev/null +++ b/src/main/java/io/github/itzispyder/exampleplugin/commands/CommandExample.java @@ -0,0 +1,48 @@ +/** + * This file is for tutorial purposes made by ImproperIssues. Distribute if you want :) + */ + +package io.github.itzispyder.exampleplugin.commands; + +import io.github.itzispyder.exampleplugin.exceptions.CmdExHandler; +import org.bukkit.command.Command; +import org.bukkit.command.CommandExecutor; +import org.bukkit.command.CommandSender; +import org.bukkit.command.TabCompleter; + +import java.util.ArrayList; +import java.util.List; + +/** + * Example command + */ +public class CommandExample implements CommandExecutor { + + @Override + public boolean onCommand(CommandSender sender, Command command, String label, String[] args) { + try { + sender.sendMessage("You've execute an example command!"); + return true; + } catch (Exception ex) { + CmdExHandler handler = new CmdExHandler(ex,command); + sender.sendMessage(handler.getErrorMessage()); + return true; + } + } + + /** + * Example command's tab completer + */ + public static class Tabs implements TabCompleter { + + @Override + public List onTabComplete(CommandSender sender, Command command, String alias, String[] args) { + List list = new ArrayList<>(); + switch (args.length) { + case 1 -> list.add("test"); + } + list.removeIf(s -> !s.toLowerCase().contains(args[args.length - 1].toLowerCase())); + return list; + } + } +} diff --git a/src/main/java/io/github/itzispyder/exampleplugin/data/Config.java b/src/main/java/io/github/itzispyder/exampleplugin/data/Config.java new file mode 100644 index 0000000..c054433 --- /dev/null +++ b/src/main/java/io/github/itzispyder/exampleplugin/data/Config.java @@ -0,0 +1,25 @@ +/** + * This file is for tutorial purposes made by ImproperIssues. Distribute if you want :) + */ + +package io.github.itzispyder.exampleplugin.data; + +import io.github.itzispyder.exampleplugin.ExamplePlugin; +import org.bukkit.configuration.file.FileConfiguration; + +/** + * Config loader + */ +public abstract class Config { + + private static final FileConfiguration config = ExamplePlugin.getInstance().getConfig(); + + /** + * Config plugin section + */ + public class Plugin { + public static String getPrefix() { + return config.getString("config.plugin.prefix"); + } + } +} diff --git a/src/main/java/io/github/itzispyder/exampleplugin/events/ExampleEvent.java b/src/main/java/io/github/itzispyder/exampleplugin/events/ExampleEvent.java new file mode 100644 index 0000000..a9205c5 --- /dev/null +++ b/src/main/java/io/github/itzispyder/exampleplugin/events/ExampleEvent.java @@ -0,0 +1,27 @@ +/** + * This file is for tutorial purposes made by ImproperIssues. Distribute if you want :) + */ + +package io.github.itzispyder.exampleplugin.events; + +import org.bukkit.entity.Player; +import org.bukkit.event.EventHandler; +import org.bukkit.event.Listener; +import org.bukkit.event.player.PlayerJoinEvent; + +/** + * An example event listener + */ +public class ExampleEvent implements Listener { + + /** + * Listens for join event, set any event you want in the parameter type! + * Provided by Bukkit API + * @param e the event to listen for + */ + @EventHandler + public static void onJoin(PlayerJoinEvent e) { + Player p = e.getPlayer(); + p.sendMessage("Hello, welcome!"); + } +} diff --git a/src/main/java/io/github/itzispyder/exampleplugin/exceptions/CmdExHandler.java b/src/main/java/io/github/itzispyder/exampleplugin/exceptions/CmdExHandler.java new file mode 100644 index 0000000..520db70 --- /dev/null +++ b/src/main/java/io/github/itzispyder/exampleplugin/exceptions/CmdExHandler.java @@ -0,0 +1,46 @@ +/** + * This file is for tutorial purposes made by ImproperIssues. Distribute if you want :) + */ + +package io.github.itzispyder.exampleplugin.exceptions; + +import org.bukkit.command.Command; + +/** + * Handles a command exception + */ +public class CmdExHandler { + + private Exception exception; + private Command command; + + /** + * Constructs the command exception + * @param exception the exception caught + * @param command the command run + */ + public CmdExHandler(Exception exception, Command command) { + this.exception = exception; + this.command = command; + } + + /** + * Returns the error message + * @return the error message + */ + public String getErrorMessage() { + String msg = "§cCommand Error: "; + if (exception instanceof NullPointerException) msg += "Command contains a null value!"; + else if (exception instanceof IndexOutOfBoundsException) msg += "Unknown or incomplete command!"; + else msg += exception.getMessage(); + return msg + "\nc§cCorrect usage: §7" + command.getUsage(); + } + + public Exception getException() { + return exception; + } + + public Command getCommand() { + return command; + } +} diff --git a/src/main/java/io/github/itzispyder/exampleplugin/server/sound/SoundPlayer.java b/src/main/java/io/github/itzispyder/exampleplugin/server/sound/SoundPlayer.java new file mode 100644 index 0000000..f5772c9 --- /dev/null +++ b/src/main/java/io/github/itzispyder/exampleplugin/server/sound/SoundPlayer.java @@ -0,0 +1,263 @@ +/** + * This file is for tutorial purposes made by ImproperIssues. Distribute if you want :) + * + * I made this cuz Bukkit API sounds management is trash. + * by ImproperIssues + */ + + +package io.github.itzispyder.exampleplugin.server.sound; + +import io.github.itzispyder.exampleplugin.ExamplePlugin; +import org.bukkit.Bukkit; +import org.bukkit.Location; +import org.bukkit.Sound; +import org.bukkit.entity.Player; +import org.bukkit.scheduler.BukkitRunnable; + +public class SoundPlayer { + + private Location location; + private Sound sound; + private float volume; + private float pitch; + + /** + * Constructs a new sound, this aims to add more methods to + * the Bukkit APIs Sound class, as they don't have many + * methods to use. + * + * @param location Location + * @param sound Sound + * @param volume float + * @param pitch float + */ + public SoundPlayer(Location location, Sound sound, float volume, float pitch) { + this.location = location; + this.sound = sound; + this.pitch = pitch; + this.volume = volume; + } + + + /** + * Plays a sound to a player but at the store location + * + * @param player Player + */ + public void play(Player player) { + player.playSound(this.location,this.sound,this.volume,this.pitch); + } + + /** + * Plays a sound to a player but at the player's location + * + * @param player Player + */ + public void playAt(Player player) { + player.playSound(player.getLocation(),this.sound,this.volume,this.pitch); + } + + /** + * Plays the sound to all players within a distance, but at the stored location. + * + * @param distance double + */ + public void playWithin(double distance) { + for (Player p : Bukkit.getOnlinePlayers()) { + if (p != null && p.getWorld() == this.location.getWorld() && p.getLocation().distanceSquared(this.location) < distance) { + p.playSound(this.location,this.sound,this.volume,this.pitch); + } + } + } + + /** + * Plays the sound to all players within a distance, but at the players' location. + * + * @param distance double + */ + public void playWithinAt(double distance) { + for (Player p : Bukkit.getOnlinePlayers()) { + if (p != null && p.getWorld() == this.location.getWorld() && p.getLocation().distanceSquared(this.location) < distance) { + p.playSound(p.getLocation(),this.sound,this.volume,this.pitch); + } + } + } + + + /** + * Plays the sound to all players on the server, but at the stored location. + */ + public void playAll() { + for (Player p : Bukkit.getOnlinePlayers()) p.playSound(this.location,this.sound,this.volume,this.pitch); + } + + /** + * Plays the sound to all players on the server, but at the players' location. + */ + public void playAllAt() { + for (Player p : Bukkit.getOnlinePlayers()) p.playSound(p.getLocation(),this.sound,this.volume,this.pitch); + } + + /** + * Repeats a sound to a player, but at the stored location. + * + * @param player Player + * @param times int + * @param tickDelay int + */ + public void repeat(Player player, int times, int tickDelay) { + new BukkitRunnable() { + int i = 0; + @Override + public void run() { + if (i < times) { + play(player); + i ++; + } else { + this.cancel(); + } + } + }.runTaskTimer(ExamplePlugin.getInstance(),0,tickDelay); + } + + /** + * Repeats a sound to a player, but at the player's location. + * + * @param player Player + * @param times int + * @param tickDelay int + */ + public void repeatAt(Player player, int times, int tickDelay) { + new BukkitRunnable() { + int i = 0; + @Override + public void run() { + if (i < times) { + playAt(player); + i ++; + } else { + this.cancel(); + } + } + }.runTaskTimer(ExamplePlugin.getInstance(),0,tickDelay); + } + + /** + * Repeats a sound to all players on the server, but at the stored location. + * + * @param times int + * @param tickDelay int + */ + public void repeatAll(int times, int tickDelay) { + new BukkitRunnable() { + int i = 0; + @Override + public void run() { + if (i < times) { + playAll(); + i ++; + } else { + this.cancel(); + } + } + }.runTaskTimer(ExamplePlugin.getInstance(),0,tickDelay); + } + + /** + * Repeats a sound to all players on the server, but at the players' location. + * + * @param times int + * @param tickDelay int + */ + public void repeatAllAt(int times, int tickDelay) { + new BukkitRunnable() { + int i = 0; + @Override + public void run() { + if (i < times) { + playAllAt(); + i ++; + } else { + this.cancel(); + } + } + }.runTaskTimer(ExamplePlugin.getInstance(),0,tickDelay); + } + + /** + * Repeats a sound to all players within a radius, but at the stored location. + * + * @param radius double + * @param times int + * @param tickDelay int + */ + public void repeatAll(double radius,int times, int tickDelay) { + new BukkitRunnable() { + int i = 0; + @Override + public void run() { + if (i < times) { + playWithin(radius); + i ++; + } else { + this.cancel(); + } + } + }.runTaskTimer(ExamplePlugin.getInstance(),0,tickDelay); + } + + /** + * Repeats a sound to all players within a radius, but at the players' location. + * + * @param distance double + * @param times int + * @param tickDelay int + */ + public void repeatAllAt(double distance, int times, int tickDelay) { + new BukkitRunnable() { + int i = 0; + @Override + public void run() { + if (i < times) { + playWithinAt(distance); + i ++; + } else { + this.cancel(); + } + } + }.runTaskTimer(ExamplePlugin.getInstance(),0,tickDelay); + } + + public Sound getSound() { + return sound; + } + + public float getPitch() { + return pitch; + } + + public float getVolume() { + return volume; + } + + public Location getLocation() { + return location; + } + + public void setPitch(float pitch) { + this.pitch = pitch; + } + + public void setVolume(float volume) { + this.volume = volume; + } + + public void setSound(Sound sound) { + this.sound = sound; + } + + public void setLocation(Location location) { + this.location = location; + } +} diff --git a/src/main/java/io/github/itzispyder/exampleplugin/server/util/ArgBuilder.java b/src/main/java/io/github/itzispyder/exampleplugin/server/util/ArgBuilder.java new file mode 100644 index 0000000..fb31517 --- /dev/null +++ b/src/main/java/io/github/itzispyder/exampleplugin/server/util/ArgBuilder.java @@ -0,0 +1,90 @@ +/** + * This file is for tutorial purposes made by ImproperIssues. Distribute if you want :) + */ + +package io.github.itzispyder.exampleplugin.server.util; + +import java.util.List; +import java.util.Set; + +/** + * Represents Argument builder + */ +public class ArgBuilder { + + private String result; + + /** + * Constructs an argument builder. + */ + public ArgBuilder() { + this.result = " "; + } + + /** + * Constructs an argument builder with a string. + * @param begin the beginner string + */ + public ArgBuilder(String begin) { + this.result = begin + " "; + } + + /** + * Appends a string + * @param string string + * @return this class + */ + public ArgBuilder append(String string) { + this.result += string + " "; + return this; + } + + /** + * Appends a string array + * @param args string array + * @return this class + */ + public ArgBuilder append(String[] args) { + StringBuilder builder = new StringBuilder(); + for (String arg : args) builder.append(arg).append(" "); + this.result += builder.toString(); + return this; + } + + /** + * Appends a string list + * @param args string list + * @return this class + */ + public ArgBuilder append(List args) { + StringBuilder builder = new StringBuilder(); + for (String arg : args) builder.append(arg).append(" "); + this.result += builder.toString(); + return this; + } + + /** + * Appends a string set + * @param args string set + * @return this class + */ + public ArgBuilder append(Set args) { + StringBuilder builder = new StringBuilder(); + for (String arg : args) builder.append(arg).append(" "); + this.result += builder.toString(); + return this; + } + + /** + * Returns this class as a string + * @return this class as a string + */ + public String build() { + return this.toString().trim(); + } + + @Override + public String toString() { + return result; + } +} diff --git a/src/main/java/io/github/itzispyder/exampleplugin/server/util/ServerUtils.java b/src/main/java/io/github/itzispyder/exampleplugin/server/util/ServerUtils.java new file mode 100644 index 0000000..83463f1 --- /dev/null +++ b/src/main/java/io/github/itzispyder/exampleplugin/server/util/ServerUtils.java @@ -0,0 +1,53 @@ +/** + * This file is for tutorial purposes made by ImproperIssues. Distribute if you want :) + */ + +package io.github.itzispyder.exampleplugin.server.util; + +import org.bukkit.Bukkit; +import org.bukkit.entity.Player; + +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Set; + +/** + * Server utils + */ +public abstract class ServerUtils { + + /** + * List of names of online players + * @return list of names + */ + public static List listPlayers() { + List list =new ArrayList<>(); + Bukkit.getOnlinePlayers().forEach(p -> list.add(p.getName())); + return list; + } + + /** + * List of names of online staff + * @return list of names + */ + public static List listStaff() { + List list =new ArrayList<>(); + Bukkit.getOnlinePlayers().forEach(p -> { + if (p.isOp()) list.add(p.getName()); + }); + return list; + } + + /** + * List of names of online staff + * @return list of staff + */ + public static Set getStaff() { + Set list = new HashSet<>(); + Bukkit.getOnlinePlayers().forEach(p -> { + if (p.isOp()) list.add(p); + }); + return list; + } +} diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml new file mode 100644 index 0000000..3dde858 --- /dev/null +++ b/src/main/resources/config.yml @@ -0,0 +1,8 @@ +# +# +# This will be your plugin config! +# +# +config: + plugin: + prefix: "§7[§aExamplePlugin§7]" diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml new file mode 100644 index 0000000..0dee97f --- /dev/null +++ b/src/main/resources/plugin.yml @@ -0,0 +1,17 @@ +name: ExamplePlugin +version: '${version}' +main: io.github.itzispyder.exampleplugin.ExamplePlugin +api-version: 1.17 +authors: [ YourNameHere ] +description: An example plugin template for Spigot/Paper. +website: https://ItziSpyder.github.io/ +permissions: + example.commands: + description: An example permission + default: op +commands: + example: + description: An example command. + usage: /example + permission: example.commands + permission-message: You do not have permission! \ No newline at end of file