Fork re-release with LGPLv3

This commit is contained in:
NotAlexNoyle committed 2023-01-08 14:48:39 -05:00
1 parent 7b37f908dc
commit 533ee95b4b
13 files changed
+698 -6

No files matched your search

+37 -6
View File
@@ -1,7 +1,38 @@
# PACFirstPlayed **FirstPlayed-OG**
A Minecraft plugin showing the date you joined the server
## Features *A modern alternative to JoinDate Forked from PACFirstPlayed by PeaceAndCubeMC*
- ``/firstplayed`` to see the date you joined the server.
- ``/firstplayed <player>`` to see the date a player joined the server. Will return an error if the player doesn't exist. ![Icon](https://github.com/NotAlexNoyle/FirstPlayed-OG/blob/main/assets/icon.png?raw=true)
- ``/fpdate <date>`` to see who joined the server on a date.
*A Spigot plugin that allows you to easily determine when exactly you or others first joined the server!*
![FirstPlayed OG](https://github.com/NotAlexNoyle/FirstPlayed-OG/blob/main/assets/example.png?raw=true)
SpigotMC Listing: https://www.spigotmc.org/resources/firstplayed-og.104595/
Works similar to JoinDate, but more compatible with newer versions of Minecraft.
Supports LuckPerms, Java 17, and Gradle. Built against Purpur 1.18.2, though it may support other versions as well.
FirstPlayed-OG and all other plugins in the "OG" suite are developed for [TrueOG](https://trueog.net), a 100% free and open source Minecraft Server. Need support? Join our [Discord](https://discord.gg/ma9pMYpBU6) and ask your question in #developer-chat.
Future Enhancements Planned:
- ability to set custom time zone.
- "at" before time
- PlaceholderAPI support
Changelog:
v1.0 Release:
- Forked from [PACFirstPlayed](https://github.com/PeaceAndCubeMC/PACFirstPlayed)
- Renamed project to FirstPlayed-OG
- Documented and refactored code
- Better adapted to english
- Converted project to gradle + restructured file layout
- Use Java 17 and Purpur 1.18.2 API
- Divorced from pAcPI dependency
- Made configuration strings more modular and added more of them
- Explicitly add GPLv3 (default license for open source Spigot plugins without a license specified)
Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

+75
View File
@@ -0,0 +1,75 @@
plugins {
id "java"
id "com.github.johnrengelman.shadow" version "7.1.2"
}
group = "net.trueog.firstplayed-og"
version = "1.0"
def apiVersion = "1.18.2"
def targetJavaVersion = 17
processResources {
def props = [
version: version,
apiVersion: apiVersion,
]
inputs.properties props // indicates to rerun if version changes
filesMatching("plugin.yml") {
expand props
}
}
repositories {
mavenCentral()
maven {
url "https://repo.purpurmc.org/snapshots"
}
}
dependencies {
compileOnly "org.purpurmc.purpur:purpur-api:1.18.2-R0.1-SNAPSHOT"
}
shadowJar {
minimize()
}
jar.dependsOn shadowJar
tasks.jar.configure {
classifier = "part"
}
tasks.shadowJar.configure {
classifier = null
}
compileJava {
options.compilerArgs += ["-parameters"]
options.fork = true
options.forkOptions.executable = 'javac'
}
Binary file not shown.
+5
View File
@@ -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
Vendored Executable
+234
View File
@@ -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" "$@"
Vendored
+89
View File
@@ -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
+1
View File
@@ -0,0 +1 @@
rootProject.name = "FirstPlayed-OG"
+174
View File
@@ -0,0 +1,174 @@
/*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, version 3.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package plugin;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import org.bukkit.Bukkit;
import org.bukkit.ChatColor;
import org.bukkit.OfflinePlayer;
import org.bukkit.command.Command;
import org.bukkit.command.CommandExecutor;
import org.bukkit.command.CommandSender;
import org.bukkit.command.TabExecutor;
import org.bukkit.configuration.file.FileConfiguration;
import org.bukkit.entity.Player;
// Extends bukkit classes to run commands with tab completion.
public class CommandManager implements CommandExecutor, TabExecutor {
// Enable the conversion of text from config.yml to objects.
public FileConfiguration config = Bukkit.getPluginManager().getPlugin("FirstPlayed-OG").getConfig();
// Command execution event handler extending bukkit's CommandManager.
@Override
public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
// If no username is specified after /firstplayed, do this.
if (args.length == 0 && sender instanceof Player) {
// Make sure the player has permission to fetch own join information first.
if (! sender.hasPermission("firstplayed.me")) {
// Without permission, stop here.
return false;
}
// Command sender has permission.
else {
// With no parameters, plugin will assume player wants information about themselves.
sendOwnInfo(sender);
// Healthy exit status.
return true;
}
}
// If a username is specified after /firstplayed, do this.
else if (args.length == 1) {
// Make sure the player has permission to fetch others' join information first.
if (! sender.hasPermission("firstplayed.other")) {
// Without permission, stop here.
return false;
}
// With permission, proceed.
else {
// Get the string that the user put in after /firstplayed.
String target = args[0];
// If online, do fast lookup and forward information to command runner.
sendOtherInfo(sender, target);
// Healthy exit status.
return true;
}
}
// If the player passed too many arguments.
else {
// Send error to command runner.
sender.sendMessage(ChatColor.translateAlternateColorCodes('&', config.getString("prefix") + config.getString("too_many_arguments_error")));
// Command Failed (will show /usage).
return false;
}
}
// Runs when player specifies no arguments.
public void sendOwnInfo(CommandSender sender) {
// Derive player object from the username of the person who ran the command.
Player playerToLookUp = (Player) sender;
// Get join data from world files.
long timestamp = playerToLookUp.getFirstPlayed();
// Convert timestamp to String.
String date = new SimpleDateFormat(config.getString("date_format")).format(new Date(timestamp));
// Feed color codes from config.yml into formatted message and send it to command runner (self).
sender.sendMessage(ChatColor.translateAlternateColorCodes('&', config.getString("prefix") + config.getString("message_me") + date));
}
// Runs when player specifies one argument.
public void sendOtherInfo(CommandSender sender, String target) {
// If offline, do slow lookup. Always returns an object, never null.
OfflinePlayer offlinePlayer = Bukkit.getOfflinePlayer(target);
// Manually check if player is real because offlinePlayer is always a valid Object.
if (offlinePlayer.hasPlayedBefore()) {
// Get join data from world files.
long timestamp = offlinePlayer.getFirstPlayed();
// Convert timestamp to String
String date = new SimpleDateFormat(config.getString("date_format")).format(new Date(timestamp));
// Feed color codes from config.yml into formatted message and send it to command runner.
sender.sendMessage(ChatColor.translateAlternateColorCodes('&', config.getString("prefix") + "&a" + target + " " + config.getString("message_other") + date));
}
else {
// Notify command sender that the player they specified does not exist.
sender.sendMessage(ChatColor.translateAlternateColorCodes('&', config.getString("prefix") + config.getString("invalid_player_error") + target));
}
}
// Tab completion (online players only for performance reasons).
@Override
public List<String> onTabComplete(CommandSender sender, Command command, String label, String[] args) {
// Check to make sure that tab completion should be operating.
if (args.length == 1 && sender.hasPermission("firstplayed.other")) {
// Make an empty list of strings to store potential players for tab completion.
List<String> players = new ArrayList<String>();
// Optimized java 5 style Collections loop, not list or array loop, for efficiency and compliance with bukkit API.
for (Player player : Bukkit.getOnlinePlayers()) {
// Case-agnosticism.
if (player.getName().toLowerCase().startsWith(args[0].toLowerCase())) {
// Feeds individual player to list on each run of loop.
players.add(player.getName());
}
}
// Completed list of online players to tab complete.
return players;
}
// Show all options.
return new ArrayList<>();
}
}
+48
View File
@@ -0,0 +1,48 @@
/*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, version 3.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package plugin;
import org.bukkit.configuration.file.FileConfiguration;
import org.bukkit.plugin.java.JavaPlugin;
import org.bukkit.scheduler.BukkitTask;
// Extending this class is standard bukkit boilerplate for any plugin, or else the server software won't load the classes.
public class FirstPlayed extends JavaPlugin {
// config.yml file to object initialization.
public FileConfiguration config = getConfig();
// What to do when the plugin is run by the server.
@Override
public void onEnable() {
// Run command when plugin event is triggered.
this.getCommand("firstplayed").setExecutor(new CommandManager());
// Save config.yml and reload settings.
saveDefaultConfig();
reloadConfig();
}
// Runs plugin asynchronously so multiple players can use it at once efficiently.
public BukkitTask runTaskAsynchronously(final Runnable run) {
// Schedule Processes.
return this.getServer().getScheduler().runTaskAsynchronously(this, run);
}
}
+12
View File
@@ -0,0 +1,12 @@
# This is the configuration file for the FirstPlayed-OG plugin.
# Date format - Uses Java's SimpleDateFormat class
# Formats are listed here: https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html
date_format: dd/MM/yyyy HH:mm z
# Custom Messages
prefix: "&8[&aFirstPlayed &4OG&8] "
message_me: "&aYou first joined &2True&4OG &aon: "
message_other: "&afirst joined &2True&4OG &aon: "
invalid_player_error: "&cERROR! Not a valid player: "
too_many_arguments_error: "&cERROR! Too many arguments."
+23
View File
@@ -0,0 +1,23 @@
name: FirstPlayed-OG
author: NotAlexNoyle
description: A Spigot plugin that allows you to easily determine when exactly you or others first joined the server!
website: https://github.com/NotAlexNoyle/FirstPlayed-OG
version: 1.0
api-version: 1.18
main: plugin.FirstPlayed
commands:
firstplayed:
description: Shows when you first joined the server
aliases: fp
permission: firstplayed.me
permission-message: "§cERROR: You do not have the permission to use this command."
usage: "§6Usage: §e/firstplayed username"
permissions:
firstplayed.me:
description: Allows you to get your own join date
default: op
firstplayed.other:
description: Allows you to get another players join date
default: op