> listenerListMap = new HashMap<>();
+ public void register(UltiToolsPlugin plugin, Class listenerClass) {
+ Listener listener = plugin.getContext().getBean(listenerClass);
+ register(plugin, listener);
+ }
+
+ @Deprecated
public void register(UltiToolsPlugin plugin, Listener listener) {
listenerListMap.computeIfAbsent(plugin, k -> new ArrayList<>());
Bukkit.getServer().getPluginManager().registerEvents(listener, UltiTools.getInstance());
@@ -42,6 +48,14 @@ public class ListenerManager {
}
}
+ public void registerAll(UltiToolsPlugin plugin) {
+ for (String listenerBean : plugin.getContext().getBeanNamesForType(Listener.class)) {
+ Listener listener = plugin.getContext().getBean(listenerBean, Listener.class);
+ if (listener.getClass().getAnnotation(EventListener.class).manualRegister()) continue;
+ register(plugin, listener);
+ }
+ }
+
public void unregister(Listener listener) {
HandlerList.unregisterAll(listener);
}
diff --git a/UltiTools-API/src/main/java/com/ultikits/ultitools/manager/PluginManager.java b/UltiTools-API/src/main/java/com/ultikits/ultitools/manager/PluginManager.java
index 1e53725..98e0952 100755
--- a/UltiTools-API/src/main/java/com/ultikits/ultitools/manager/PluginManager.java
+++ b/UltiTools-API/src/main/java/com/ultikits/ultitools/manager/PluginManager.java
@@ -9,11 +9,15 @@ import com.ultikits.ultitools.utils.CommonUtils;
import lombok.Getter;
import org.bukkit.Bukkit;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.core.annotation.AnnotationUtils;
import java.io.File;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
-import java.net.*;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.net.URLDecoder;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
@@ -29,7 +33,7 @@ public class PluginManager {
public void init() throws IOException {
String currentPath = System.getProperty("user.dir");
- String path = currentPath+ File.separator + "plugins" + File.separator + "UltiTools" + File.separator + "plugins";
+ String path = currentPath + File.separator + "plugins" + File.separator + "UltiTools" + File.separator + "plugins";
File pluginFolder = new File(path);
File[] plugins = pluginFolder.listFiles((file) -> file.getName().endsWith(".jar"));
@@ -80,7 +84,7 @@ public class PluginManager {
}
boolean result = invokeRegisterSelf(plugin);
if (result) {
- registerBukkit(plugin);
+ registerBukkit(plugin, true);
}
return result;
}
@@ -108,7 +112,7 @@ public class PluginManager {
}
boolean result = invokeRegisterSelf(plugin);
if (result) {
- registerBukkit(plugin);
+ registerBukkit(plugin, false);
}
return result;
}
@@ -138,7 +142,7 @@ public class PluginManager {
}
boolean result = invokeRegisterSelf(plugin);
if (result) {
- registerBukkit(plugin);
+ registerBukkit(plugin, false);
}
return result;
}
@@ -174,7 +178,10 @@ public class PluginManager {
try {
@SuppressWarnings("resource")
URLClassLoader classLoader = new URLClassLoader(
- new URL[]{new URL(URLDecoder.decode(pluginJar.toURI().toASCIIString(), "UTF-8"))},
+ new URL[]{
+ new URL(URLDecoder.decode(pluginJar.toURI().toASCIIString(), "UTF-8")),
+ CommonUtils.getServerJar()
+ },
UltiTools.getInstance().getPluginClassLoader()
);
try (JarFile jarFile = new JarFile(pluginJar)) {
@@ -211,6 +218,21 @@ public class PluginManager {
private boolean invokeRegisterSelf(UltiToolsPlugin plugin) {
+ for (UltiToolsPlugin plugin1 : pluginList) {
+ if (!plugin1.getMainClass().equals(plugin.getMainClass())) {
+ continue;
+ }
+ if (plugin1.isNewerVersionThan(plugin)) {
+ Bukkit.getLogger().log(
+ Level.WARNING,
+ String.format("[UltiTools-API] %s load failed！There is already a new version！", plugin.getPluginName())
+ );
+ plugin.getContext().close();
+ return false;
+ } else if (plugin.isNewerVersionThan(plugin1)) {
+ plugin1.unregisterSelf();
+ }
+ }
if (plugin.getMinUltiToolsVersion() > UltiTools.getPluginVersion()) {
Bukkit.getLogger().log(
Level.WARNING,
@@ -221,7 +243,6 @@ public class PluginManager {
}
try {
boolean registerSelf = plugin.registerSelf();
- registerBukkit(plugin);
if (registerSelf) {
pluginList.add(plugin);
Bukkit.getLogger().log(
@@ -244,10 +265,14 @@ public class PluginManager {
}
private UltiToolsPlugin initializePlugin(Class pluginClass, Object... constructorArgs) {
+ URLClassLoader urlClassLoader = new URLClassLoader(
+ new URL[]{CommonUtils.getServerJar()},
+ pluginClass.getClassLoader()
+ );
AnnotationConfigApplicationContext pluginContext = new AnnotationConfigApplicationContext();
pluginContext.setParent(UltiTools.getInstance().getContext());
pluginContext.registerShutdownHook();
- pluginContext.setClassLoader(pluginClass.getClassLoader());
+ pluginContext.setClassLoader(urlClassLoader);
pluginContext.registerBean(pluginClass, constructorArgs);
pluginContext.refresh();
UltiToolsPlugin plugin = pluginContext.getBean(pluginClass);
@@ -257,18 +282,26 @@ public class PluginManager {
return plugin;
}
- private void registerBukkit(UltiToolsPlugin plugin) {
- if (!plugin.getClass().isAnnotationPresent(EnableAutoRegister.class)) {
+ private void registerBukkit(UltiToolsPlugin plugin, boolean flag) {
+ EnableAutoRegister annotation = AnnotationUtils.findAnnotation(plugin.getClass(), EnableAutoRegister.class);
+ if (annotation == null) {
return;
}
- EnableAutoRegister annotation = plugin.getClass().getAnnotation(EnableAutoRegister.class);
String[] packages = CommonUtils.getPluginPackages(plugin);
for (String packageName : packages) {
if (annotation.cmdExecutor()) {
- UltiTools.getInstance().getCommandManager().registerAll(plugin, packageName);
+ if (flag) {
+ UltiTools.getInstance().getCommandManager().registerAll(plugin);
+ } else {
+ UltiTools.getInstance().getCommandManager().registerAll(plugin, packageName);
+ }
}
if (annotation.eventListener()) {
- UltiTools.getInstance().getListenerManager().registerAll(plugin, packageName);
+ if (flag) {
+ UltiTools.getInstance().getListenerManager().registerAll(plugin);
+ } else {
+ UltiTools.getInstance().getListenerManager().registerAll(plugin, packageName);
+ }
}
}
}
diff --git a/UltiTools-API/src/main/java/com/ultikits/ultitools/utils/CommonUtils.java b/UltiTools-API/src/main/java/com/ultikits/ultitools/utils/CommonUtils.java
index 68c6685..199e48e 100644
--- a/UltiTools-API/src/main/java/com/ultikits/ultitools/utils/CommonUtils.java
+++ b/UltiTools-API/src/main/java/com/ultikits/ultitools/utils/CommonUtils.java
@@ -6,12 +6,16 @@ import cn.hutool.json.JSONUtil;
import com.ultikits.ultitools.UltiTools;
import com.ultikits.ultitools.abstracts.UltiToolsPlugin;
import com.ultikits.ultitools.annotations.EnableAutoRegister;
+import org.bukkit.Bukkit;
import org.springframework.context.annotation.ComponentScan;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
+import java.net.URL;
import java.nio.charset.StandardCharsets;
+import java.security.CodeSource;
+import java.security.ProtectionDomain;
public class CommonUtils {
@@ -54,4 +58,12 @@ public class CommonUtils {
return packages;
}
+ public static URL getServerJar() {
+ ProtectionDomain protectionDomain = Bukkit.class.getProtectionDomain();
+ CodeSource codeSource = protectionDomain.getCodeSource();
+ if (codeSource == null) {
+ return null;
+ }
+ return codeSource.getLocation();
+ }
}
diff --git a/UltiTools-API/src/main/java/com/ultikits/ultitools/utils/Metrics.java b/UltiTools-API/src/main/java/com/ultikits/ultitools/utils/Metrics.java
new file mode 100644
index 0000000..f26f011
--- /dev/null
+++ b/UltiTools-API/src/main/java/com/ultikits/ultitools/utils/Metrics.java
@@ -0,0 +1,713 @@
+package com.ultikits.ultitools.utils;
+
+import com.google.gson.JsonArray;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonParser;
+import com.google.gson.JsonPrimitive;
+import org.bukkit.Bukkit;
+import org.bukkit.configuration.file.YamlConfiguration;
+import org.bukkit.entity.Player;
+import org.bukkit.plugin.Plugin;
+import org.bukkit.plugin.RegisteredServiceProvider;
+import org.bukkit.plugin.ServicePriority;
+
+import javax.net.ssl.HttpsURLConnection;
+import java.io.*;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.net.URL;
+import java.nio.charset.StandardCharsets;
+import java.util.*;
+import java.util.concurrent.Callable;
+import java.util.logging.Level;
+import java.util.zip.GZIPOutputStream;
+
+/**
+ * bStats collects some data for plugin authors.
+ *
+ * Check out https://bStats.org/ to learn more about bStats!
+ */
+@SuppressWarnings({"WeakerAccess", "unused"})
+public class Metrics {
+
+ // The version of this bStats class
+ public static final int B_STATS_VERSION = 1;
+ // The url to which the data is sent
+ private static final String URL = "https://bStats.org/submitData/bukkit";
+ // Should failed requests be logged?
+ private static boolean logFailedRequests;
+ // Should the sent data be logged?
+ private static boolean logSentData;
+ // Should the response text be logged?
+ private static boolean logResponseStatusText;
+ // The uuid of the server
+ private static String serverUUID;
+
+ static {
+ // You can use the property to disable the check in your test environment
+ if (System.getProperty("bstats.relocatecheck") == null || !System.getProperty("bstats.relocatecheck").equals("false")) {
+ // Maven's Relocate is clever and changes strings, too. So we have to use this little "trick" ... :D
+ final String defaultPackage = new String(
+ new byte[]{'o', 'r', 'g', '.', 'b', 's', 't', 'a', 't', 's', '.', 'b', 'u', 'k', 'k', 'i', 't'});
+ final String examplePackage = new String(new byte[]{'y', 'o', 'u', 'r', '.', 'p', 'a', 'c', 'k', 'a', 'g', 'e'});
+ }
+ }
+
+ // The plugin
+ private final Plugin plugin;
+ // The plugin id
+ private final int pluginId;
+ // A list with all custom charts
+ private final List charts = new ArrayList<>();
+ // Is bStats enabled on this server?
+ private boolean enabled;
+
+ /**
+ * Class constructor.
+ *
+ * @param plugin The plugin which stats should be submitted.
+ * @param pluginId The id of the plugin.
+ * It can be found at What is my plugin id?
+ */
+ public Metrics(Plugin plugin, int pluginId) {
+ if (plugin == null) {
+ throw new IllegalArgumentException("Plugin cannot be null!");
+ }
+ this.plugin = plugin;
+ this.pluginId = pluginId;
+
+ // Get the config file
+ File bStatsFolder = new File(plugin.getDataFolder().getParentFile(), "bStats");
+ File configFile = new File(bStatsFolder, "config.yml");
+ YamlConfiguration config = YamlConfiguration.loadConfiguration(configFile);
+
+ // Check if the config file exists
+ if (!config.isSet("serverUuid")) {
+
+ // Add default values
+ config.addDefault("enabled", true);
+ // Every server gets it's unique random id.
+ config.addDefault("serverUuid", UUID.randomUUID().toString());
+ // Should failed request be logged?
+ config.addDefault("logFailedRequests", false);
+ // Should the sent data be logged?
+ config.addDefault("logSentData", false);
+ // Should the response text be logged?
+ config.addDefault("logResponseStatusText", false);
+
+ // Inform the server owners about bStats
+ config.options().header(
+ "bStats collects some data for plugin authors like how many servers are using their plugins.\n" +
+ "To honor their work, you should not disable it.\n" +
+ "This has nearly no effect on the server performance!\n" +
+ "Check out https://bStats.org/ to learn more :)"
+ ).copyDefaults(true);
+ try {
+ config.save(configFile);
+ } catch (IOException ignored) {
+ }
+ }
+
+ // Load the data
+ enabled = config.getBoolean("enabled", true);
+ serverUUID = config.getString("serverUuid");
+ logFailedRequests = config.getBoolean("logFailedRequests", false);
+ logSentData = config.getBoolean("logSentData", false);
+ logResponseStatusText = config.getBoolean("logResponseStatusText", false);
+
+ if (enabled) {
+ boolean found = false;
+ // Search for all other bStats Metrics classes to see if we are the first one
+ for (Class service : Bukkit.getServicesManager().getKnownServices()) {
+ try {
+ service.getField("B_STATS_VERSION"); // Our identifier :)
+ found = true; // We aren't the first
+ break;
+ } catch (NoSuchFieldException ignored) {
+ }
+ }
+ // Register our service
+ Bukkit.getServicesManager().register(Metrics.class, this, plugin, ServicePriority.Normal);
+ if (!found) {
+ // We are the first!
+ startSubmitting();
+ }
+ }
+ }
+
+ /**
+ * Sends the data to the bStats server.
+ *
+ * @param plugin Any plugin. It's just used to get a logger instance.
+ * @param data The data to send.
+ * @throws Exception If the request failed.
+ */
+ private static void sendData(Plugin plugin, JsonObject data) throws Exception {
+ if (data == null) {
+ throw new IllegalArgumentException("Data cannot be null!");
+ }
+ if (Bukkit.isPrimaryThread()) {
+ throw new IllegalAccessException("This method must not be called from the main thread!");
+ }
+ if (logSentData) {
+ plugin.getLogger().info("Sending data to bStats: " + data);
+ }
+ HttpsURLConnection connection = (HttpsURLConnection) new URL(URL).openConnection();
+
+ // Compress the data to save bandwidth
+ byte[] compressedData = compress(data.toString());
+
+ // Add headers
+ connection.setRequestMethod("POST");
+ connection.addRequestProperty("Accept", "application/json");
+ connection.addRequestProperty("Connection", "close");
+ connection.addRequestProperty("Content-Encoding", "gzip"); // We gzip our request
+ connection.addRequestProperty("Content-Length", String.valueOf(compressedData.length));
+ connection.setRequestProperty("Content-Type", "application/json"); // We send our data in JSON format
+ connection.setRequestProperty("User-Agent", "MC-Server/" + B_STATS_VERSION);
+
+ // Send data
+ connection.setDoOutput(true);
+ try (DataOutputStream outputStream = new DataOutputStream(connection.getOutputStream())) {
+ outputStream.write(compressedData);
+ }
+
+ StringBuilder builder = new StringBuilder();
+ try (BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
+ String line;
+ while ((line = bufferedReader.readLine()) != null) {
+ builder.append(line);
+ }
+ }
+
+ if (logResponseStatusText) {
+ plugin.getLogger().info("Sent data to bStats and received response: " + builder);
+ }
+ }
+
+ /**
+ * Gzips the given String.
+ *
+ * @param str The string to gzip.
+ * @return The gzipped String.
+ * @throws IOException If the compression failed.
+ */
+ private static byte[] compress(final String str) throws IOException {
+ if (str == null) {
+ return null;
+ }
+ ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
+ try (GZIPOutputStream gzip = new GZIPOutputStream(outputStream)) {
+ gzip.write(str.getBytes(StandardCharsets.UTF_8));
+ }
+ return outputStream.toByteArray();
+ }
+
+ /**
+ * Checks if bStats is enabled.
+ *
+ * @return Whether bStats is enabled or not.
+ */
+ public boolean isEnabled() {
+ return enabled;
+ }
+
+ /**
+ * Adds a custom chart.
+ *
+ * @param chart The chart to add.
+ */
+ public void addCustomChart(CustomChart chart) {
+ if (chart == null) {
+ throw new IllegalArgumentException("Chart cannot be null!");
+ }
+ charts.add(chart);
+ }
+
+ /**
+ * Starts the Scheduler which submits our data every 30 minutes.
+ */
+ private void startSubmitting() {
+ final Timer timer = new Timer(true); // We use a timer cause the Bukkit scheduler is affected by server lags
+ timer.scheduleAtFixedRate(new TimerTask() {
+ @Override
+ public void run() {
+ if (!plugin.isEnabled()) { // Plugin was disabled
+ timer.cancel();
+ return;
+ }
+ // Nevertheless we want our code to run in the Bukkit main thread, so we have to use the Bukkit scheduler
+ // Don't be afraid! The connection to the bStats server is still async, only the stats collection is sync ;)
+ Bukkit.getScheduler().runTask(plugin, () -> submitData());
+ }
+ }, 1000 * 60 * 5, 1000 * 60 * 30);
+ // Submit the data every 30 minutes, first time after 5 minutes to give other plugins enough time to start
+ // WARNING: Changing the frequency has no effect but your plugin WILL be blocked/deleted!
+ // WARNING: Just don't do it!
+ }
+
+ /**
+ * Gets the plugin specific data.
+ * This method is called using Reflection.
+ *
+ * @return The plugin specific data.
+ */
+ public JsonObject getPluginData() {
+ JsonObject data = new JsonObject();
+
+ String pluginName = plugin.getDescription().getName();
+ String pluginVersion = plugin.getDescription().getVersion();
+
+ data.addProperty("pluginName", pluginName); // Append the name of the plugin
+ data.addProperty("id", pluginId); // Append the id of the plugin
+ data.addProperty("pluginVersion", pluginVersion); // Append the version of the plugin
+ JsonArray customCharts = new JsonArray();
+ for (CustomChart customChart : charts) {
+ // Add the data of the custom charts
+ JsonObject chart = customChart.getRequestJsonObject();
+ if (chart == null) { // If the chart is null, we skip it
+ continue;
+ }
+ customCharts.add(chart);
+ }
+ data.add("customCharts", customCharts);
+
+ return data;
+ }
+
+ /**
+ * Gets the server specific data.
+ *
+ * @return The server specific data.
+ */
+ private JsonObject getServerData() {
+ // Minecraft specific data
+ int playerAmount;
+ try {
+ // Around MC 1.8 the return type was changed to a collection from an array,
+ // This fixes java.lang.NoSuchMethodError: org.bukkit.Bukkit.getOnlinePlayers()Ljava/util/Collection;
+ Method onlinePlayersMethod = Class.forName("org.bukkit.Server").getMethod("getOnlinePlayers");
+ playerAmount = onlinePlayersMethod.getReturnType().equals(Collection.class)
+ ? ((Collection) onlinePlayersMethod.invoke(Bukkit.getServer())).size()
+ : ((Player[]) onlinePlayersMethod.invoke(Bukkit.getServer())).length;
+ } catch (Exception e) {
+ playerAmount = Bukkit.getOnlinePlayers().size(); // Just use the new method if the Reflection failed
+ }
+ int onlineMode = Bukkit.getOnlineMode() ? 1 : 0;
+ String bukkitVersion = Bukkit.getVersion();
+ String bukkitName = Bukkit.getName();
+
+ // OS/Java specific data
+ String javaVersion = System.getProperty("java.version");
+ String osName = System.getProperty("os.name");
+ String osArch = System.getProperty("os.arch");
+ String osVersion = System.getProperty("os.version");
+ int coreCount = Runtime.getRuntime().availableProcessors();
+
+ JsonObject data = new JsonObject();
+
+ data.addProperty("serverUUID", serverUUID);
+
+ data.addProperty("playerAmount", playerAmount);
+ data.addProperty("onlineMode", onlineMode);
+ data.addProperty("bukkitVersion", bukkitVersion);
+ data.addProperty("bukkitName", bukkitName);
+
+ data.addProperty("javaVersion", javaVersion);
+ data.addProperty("osName", osName);
+ data.addProperty("osArch", osArch);
+ data.addProperty("osVersion", osVersion);
+ data.addProperty("coreCount", coreCount);
+
+ return data;
+ }
+
+ /**
+ * Collects the data and sends it afterwards.
+ */
+ private void submitData() {
+ final JsonObject data = getServerData();
+
+ JsonArray pluginData = new JsonArray();
+ // Search for all other bStats Metrics classes to get their plugin data
+ for (Class service : Bukkit.getServicesManager().getKnownServices()) {
+ try {
+ service.getField("B_STATS_VERSION"); // Our identifier :)
+
+ for (RegisteredServiceProvider provider : Bukkit.getServicesManager().getRegistrations(service)) {
+ try {
+ Object plugin = provider.getService().getMethod("getPluginData").invoke(provider.getProvider());
+ if (plugin instanceof JsonObject) {
+ pluginData.add((JsonObject) plugin);
+ } else { // old bstats version compatibility
+ try {
+ Class jsonObjectJsonSimple = Class.forName("org.json.simple.JSONObject");
+ if (plugin.getClass().isAssignableFrom(jsonObjectJsonSimple)) {
+ Method jsonStringGetter = jsonObjectJsonSimple.getDeclaredMethod("toJSONString");
+ jsonStringGetter.setAccessible(true);
+ String jsonString = (String) jsonStringGetter.invoke(plugin);
+ JsonObject object = new JsonParser().parse(jsonString).getAsJsonObject();
+ pluginData.add(object);
+ }
+ } catch (ClassNotFoundException e) {
+ // minecraft version 1.14+
+ if (logFailedRequests) {
+ this.plugin.getLogger().log(Level.SEVERE, "Encountered unexpected exception", e);
+ }
+ }
+ }
+ } catch (NullPointerException | NoSuchMethodException | IllegalAccessException |
+ InvocationTargetException ignored) {
+ }
+ }
+ } catch (NoSuchFieldException ignored) {
+ }
+ }
+
+ data.add("plugins", pluginData);
+
+ // Create a new thread for the connection to the bStats server
+ new Thread(() -> {
+ try {
+ // Send the data
+ sendData(plugin, data);
+ } catch (Exception e) {
+ // Something went wrong! :(
+ if (logFailedRequests) {
+ plugin.getLogger().log(Level.WARNING, "Could not submit plugin stats of " + plugin.getName(), e);
+ }
+ }
+ }).start();
+ }
+
+ /**
+ * Represents a custom chart.
+ */
+ public static abstract class CustomChart {
+
+ // The id of the chart
+ final String chartId;
+
+ /**
+ * Class constructor.
+ *
+ * @param chartId The id of the chart.
+ */
+ CustomChart(String chartId) {
+ if (chartId == null || chartId.isEmpty()) {
+ throw new IllegalArgumentException("ChartId cannot be null or empty!");
+ }
+ this.chartId = chartId;
+ }
+
+ private JsonObject getRequestJsonObject() {
+ JsonObject chart = new JsonObject();
+ chart.addProperty("chartId", chartId);
+ try {
+ JsonObject data = getChartData();
+ if (data == null) {
+ // If the data is null we don't send the chart.
+ return null;
+ }
+ chart.add("data", data);
+ } catch (Throwable t) {
+ if (logFailedRequests) {
+ Bukkit.getLogger().log(Level.WARNING, "Failed to get data for custom chart with id " + chartId, t);
+ }
+ return null;
+ }
+ return chart;
+ }
+
+ protected abstract JsonObject getChartData() throws Exception;
+
+ }
+
+ /**
+ * Represents a custom simple pie.
+ */
+ public static class SimplePie extends CustomChart {
+
+ private final Callable callable;
+
+ /**
+ * Class constructor.
+ *
+ * @param chartId The id of the chart.
+ * @param callable The callable which is used to request the chart data.
+ */
+ public SimplePie(String chartId, Callable callable) {
+ super(chartId);
+ this.callable = callable;
+ }
+
+ @Override
+ protected JsonObject getChartData() throws Exception {
+ JsonObject data = new JsonObject();
+ String value = callable.call();
+ if (value == null || value.isEmpty()) {
+ // Null = skip the chart
+ return null;
+ }
+ data.addProperty("value", value);
+ return data;
+ }
+ }
+
+ /**
+ * Represents a custom advanced pie.
+ */
+ public static class AdvancedPie extends CustomChart {
+
+ private final Callable> callable;
+
+ /**
+ * Class constructor.
+ *
+ * @param chartId The id of the chart.
+ * @param callable The callable which is used to request the chart data.
+ */
+ public AdvancedPie(String chartId, Callable> callable) {
+ super(chartId);
+ this.callable = callable;
+ }
+
+ @Override
+ protected JsonObject getChartData() throws Exception {
+ JsonObject data = new JsonObject();
+ JsonObject values = new JsonObject();
+ Map map = callable.call();
+ if (map == null || map.isEmpty()) {
+ // Null = skip the chart
+ return null;
+ }
+ boolean allSkipped = true;
+ for (Map.Entry entry : map.entrySet()) {
+ if (entry.getValue() == 0) {
+ continue; // Skip this invalid
+ }
+ allSkipped = false;
+ values.addProperty(entry.getKey(), entry.getValue());
+ }
+ if (allSkipped) {
+ // Null = skip the chart
+ return null;
+ }
+ data.add("values", values);
+ return data;
+ }
+ }
+
+ /**
+ * Represents a custom drilldown pie.
+ */
+ public static class DrilldownPie extends CustomChart {
+
+ private final Callable>> callable;
+
+ /**
+ * Class constructor.
+ *
+ * @param chartId The id of the chart.
+ * @param callable The callable which is used to request the chart data.
+ */
+ public DrilldownPie(String chartId, Callable>> callable) {
+ super(chartId);
+ this.callable = callable;
+ }
+
+ @Override
+ public JsonObject getChartData() throws Exception {
+ JsonObject data = new JsonObject();
+ JsonObject values = new JsonObject();
+ Map> map = callable.call();
+ if (map == null || map.isEmpty()) {
+ // Null = skip the chart
+ return null;
+ }
+ boolean reallyAllSkipped = true;
+ for (Map.Entry> entryValues : map.entrySet()) {
+ JsonObject value = new JsonObject();
+ boolean allSkipped = true;
+ for (Map.Entry valueEntry : map.get(entryValues.getKey()).entrySet()) {
+ value.addProperty(valueEntry.getKey(), valueEntry.getValue());
+ allSkipped = false;
+ }
+ if (!allSkipped) {
+ reallyAllSkipped = false;
+ values.add(entryValues.getKey(), value);
+ }
+ }
+ if (reallyAllSkipped) {
+ // Null = skip the chart
+ return null;
+ }
+ data.add("values", values);
+ return data;
+ }
+ }
+
+ /**
+ * Represents a custom single line chart.
+ */
+ public static class SingleLineChart extends CustomChart {
+
+ private final Callable callable;
+
+ /**
+ * Class constructor.
+ *
+ * @param chartId The id of the chart.
+ * @param callable The callable which is used to request the chart data.
+ */
+ public SingleLineChart(String chartId, Callable callable) {
+ super(chartId);
+ this.callable = callable;
+ }
+
+ @Override
+ protected JsonObject getChartData() throws Exception {
+ JsonObject data = new JsonObject();
+ int value = callable.call();
+ if (value == 0) {
+ // Null = skip the chart
+ return null;
+ }
+ data.addProperty("value", value);
+ return data;
+ }
+
+ }
+
+ /**
+ * Represents a custom multi line chart.
+ */
+ public static class MultiLineChart extends CustomChart {
+
+ private final Callable> callable;
+
+ /**
+ * Class constructor.
+ *
+ * @param chartId The id of the chart.
+ * @param callable The callable which is used to request the chart data.
+ */
+ public MultiLineChart(String chartId, Callable> callable) {
+ super(chartId);
+ this.callable = callable;
+ }
+
+ @Override
+ protected JsonObject getChartData() throws Exception {
+ JsonObject data = new JsonObject();
+ JsonObject values = new JsonObject();
+ Map map = callable.call();
+ if (map == null || map.isEmpty()) {
+ // Null = skip the chart
+ return null;
+ }
+ boolean allSkipped = true;
+ for (Map.Entry entry : map.entrySet()) {
+ if (entry.getValue() == 0) {
+ continue; // Skip this invalid
+ }
+ allSkipped = false;
+ values.addProperty(entry.getKey(), entry.getValue());
+ }
+ if (allSkipped) {
+ // Null = skip the chart
+ return null;
+ }
+ data.add("values", values);
+ return data;
+ }
+
+ }
+
+ /**
+ * Represents a custom simple bar chart.
+ */
+ public static class SimpleBarChart extends CustomChart {
+
+ private final Callable> callable;
+
+ /**
+ * Class constructor.
+ *
+ * @param chartId The id of the chart.
+ * @param callable The callable which is used to request the chart data.
+ */
+ public SimpleBarChart(String chartId, Callable> callable) {
+ super(chartId);
+ this.callable = callable;
+ }
+
+ @Override
+ protected JsonObject getChartData() throws Exception {
+ JsonObject data = new JsonObject();
+ JsonObject values = new JsonObject();
+ Map map = callable.call();
+ if (map == null || map.isEmpty()) {
+ // Null = skip the chart
+ return null;
+ }
+ for (Map.Entry entry : map.entrySet()) {
+ JsonArray categoryValues = new JsonArray();
+ categoryValues.add(new JsonPrimitive(entry.getValue()));
+ values.add(entry.getKey(), categoryValues);
+ }
+ data.add("values", values);
+ return data;
+ }
+
+ }
+
+ /**
+ * Represents a custom advanced bar chart.
+ */
+ public static class AdvancedBarChart extends CustomChart {
+
+ private final Callable> callable;
+
+ /**
+ * Class constructor.
+ *
+ * @param chartId The id of the chart.
+ * @param callable The callable which is used to request the chart data.
+ */
+ public AdvancedBarChart(String chartId, Callable> callable) {
+ super(chartId);
+ this.callable = callable;
+ }
+
+ @Override
+ protected JsonObject getChartData() throws Exception {
+ JsonObject data = new JsonObject();
+ JsonObject values = new JsonObject();
+ Map map = callable.call();
+ if (map == null || map.isEmpty()) {
+ // Null = skip the chart
+ return null;
+ }
+ boolean allSkipped = true;
+ for (Map.Entry entry : map.entrySet()) {
+ if (entry.getValue().length == 0) {
+ continue; // Skip this invalid
+ }
+ allSkipped = false;
+ JsonArray categoryValues = new JsonArray();
+ for (int categoryValue : entry.getValue()) {
+ categoryValues.add(new JsonPrimitive(categoryValue));
+ }
+ values.add(entry.getKey(), categoryValues);
+ }
+ if (allSkipped) {
+ // Null = skip the chart
+ return null;
+ }
+ data.add("values", values);
+ return data;
+ }
+ }
+
+}
diff --git a/UltiTools-API/src/main/resources/env.yml b/UltiTools-API/src/main/resources/env.yml
index 902c489..3b17b89 100644
--- a/UltiTools-API/src/main/resources/env.yml
+++ b/UltiTools-API/src/main/resources/env.yml
@@ -1,38 +1,36 @@
# This file is used to store environment variables
-
+version: ${project.version}
api-url: "https://api.v2.ultikits.com"
oss-url: "https://ultitools.oss-cn-shanghai.aliyuncs.com"
lib-path: "/lib/"
libraries:
- - "advancedslot-4.1.13.jar"
- - "adventure-api-4.13.0.jar"
- - "adventure-key-4.13.0.jar"
- - "adventure-nbt-4.13.0.jar"
- - "adventure-platform-api-4.3.0.jar"
- - "adventure-platform-bukkit-4.3.0.jar"
- - "adventure-platform-facet-4.3.0.jar"
- - "adventure-platform-viaversion-4.3.0.jar"
- - "adventure-text-serializer-bungeecord-4.3.0.jar"
- - "adventure-text-serializer-gson-4.13.0.jar"
- - "adventure-text-serializer-gson-legacy-impl-4.13.0.jar"
- - "adventure-text-serializer-legacy-4.13.0.jar"
- - "annotations-24.0.1.jar"
- - "bukkit-1.13.1-R0.1-SNAPSHOT.jar"
- - "bungeecord-chat-1.16-R0.4.jar"
- - "checker-qual-3.12.0.jar"
- - "commons-lang-2.6.jar"
- - "configurablegui-4.1.13.jar"
- - "core-4.1.13.jar"
- - "error_prone_annotations-2.11.0.jar"
+ - "advancedslot-4.3.0.jar"
+ - "adventure-api-4.13.1.jar"
+ - "adventure-key-4.13.1.jar"
+ - "adventure-nbt-4.13.1.jar"
+ - "adventure-platform-api-4.3.2.jar"
+ - "adventure-platform-bukkit-4.3.2.jar"
+ - "adventure-platform-facet-4.3.2.jar"
+ - "adventure-platform-viaversion-4.3.2.jar"
+ - "adventure-text-serializer-bungeecord-4.3.2.jar"
+ - "adventure-text-serializer-gson-4.13.1.jar"
+ - "adventure-text-serializer-gson-legacy-impl-4.13.1.jar"
+ - "adventure-text-serializer-legacy-4.13.1.jar"
+ - "annotations-23.0.0.jar"
+ - "configurablegui-4.3.0.jar"
+ - "core-4.3.0.jar"
- "examination-api-1.3.0.jar"
- "examination-string-1.3.0.jar"
- - "failureaccess-1.0.1.jar"
- "fastjson-1.2.83.jar"
- - "gson-2.10.jar"
- - "guava-31.1-jre.jar"
- - "hamcrest-core-1.1.jar"
- - "hutool-all-5.8.20.jar"
- - "j2objc-annotations-1.3.jar"
+ - "hutool-cache-5.8.25.jar"
+ - "hutool-core-5.8.25.jar"
+ - "hutool-cron-5.8.25.jar"
+ - "hutool-crypto-5.8.25.jar"
+ - "hutool-db-5.8.25.jar"
+ - "hutool-http-5.8.25.jar"
+ - "hutool-json-5.8.25.jar"
+ - "hutool-log-5.8.25.jar"
+ - "hutool-setting-5.8.25.jar"
- "javax.servlet-api-3.1.0.jar"
- "jetty-client-9.4.48.v20220622.jar"
- "jetty-http-9.4.48.v20220622.jar"
@@ -44,21 +42,12 @@ libraries:
- "jetty-util-ajax-9.4.48.v20220622.jar"
- "jetty-webapp-9.4.48.v20220622.jar"
- "jetty-xml-9.4.48.v20220622.jar"
- - "json-simple-1.1.1.jar"
- - "jsr305-3.0.2.jar"
- - "junit-4.10.jar"
- - "listenablefuture-9999.0-empty-to-avoid-conflict-with-guava.jar"
- - "lombok-1.18.24.jar"
- - "mysql-connector-j-8.0.33.jar"
- - "obliviate-invs-4.1.13.jar"
+ - "obliviate-invs-4.3.0.jar"
- "obliviate-utils-2.0.5.jar"
- - "pagination-4.1.13.jar"
+ - "pagination-4.3.0.jar"
- "placeholder-2.0.5.jar"
- - "protobuf-java-3.21.9.jar"
- "slf4j-api-1.7.25.jar"
- - "snakeyaml-1.33.jar"
- "spark-core-2.9.4.jar"
- - "spigot-api-1.19.3-R0.1-SNAPSHOT.jar"
- "spring-aop-5.3.31.jar"
- "spring-beans-5.3.31.jar"
- "spring-context-5.3.31.jar"
@@ -66,10 +55,10 @@ libraries:
- "spring-expression-5.3.31.jar"
- "spring-jcl-5.3.31.jar"
- "string-2.0.5.jar"
- - "VaultAPI-1.7.jar"
+ - "UniversalScheduler-0.1.6.jar"
- "version-detection-2.0.5.jar"
- "websocket-api-9.4.48.v20220622.jar"
- "websocket-client-9.4.48.v20220622.jar"
- "websocket-common-9.4.48.v20220622.jar"
- "websocket-server-9.4.48.v20220622.jar"
- - "websocket-servlet-9.4.48.v20220622.jar"
\ No newline at end of file
+ - "websocket-servlet-9.4.48.v20220622.jar"
diff --git a/UltiTools-API/src/main/resources/lang/en.json b/UltiTools-API/src/main/resources/lang/en.json
index 5a195eb..ba07e2a 100644
--- a/UltiTools-API/src/main/resources/lang/en.json
+++ b/UltiTools-API/src/main/resources/lang/en.json
@@ -28,7 +28,7 @@
" 简介：": " Intro:",
"======== 第%d页 ========": "======== Page %d ========",
"安装失败！": "Install Failed!",
- "安装成功！请重启服务器！": "Installed! Please restart the server!",
+ "安装成功！请重启服务器！请务必删除旧版本模块！": "Installed! Please restart the server! Please be sure to delete the old version module!",
"========|插件安装帮助|========": "========|Plugin Install Help|========",
"/upm list [页数] - 查看可用插件列表": "/upm list [page] - View available plugin list",
"/upm install [插件] - 安装最新插件": "/upm install [plugin] - Install latest plugin",
diff --git a/UltiTools-API/src/main/resources/plugin.yml b/UltiTools-API/src/main/resources/plugin.yml
index 225f2ec..03990ae 100755
--- a/UltiTools-API/src/main/resources/plugin.yml
+++ b/UltiTools-API/src/main/resources/plugin.yml
@@ -4,5 +4,8 @@ main: com.ultikits.ultitools.UltiTools
api-version: 1.13
prefix: UltiTools
authors: [ wisdomme ]
-load: STARTUP
+load: POSTWORLD
depend: [ Vault, PlaceholderAPI ]
+softdepend:
+ - Vault
+ - PlaceholderAPI
From 1cdee5c18d3cd73f1dfa5de12f06cd1e82cd5265 Mon Sep 17 00:00:00 2001
From: wisdommen <41609381+wisdommen@users.noreply.github.com>
Date: Tue, 16 Jan 2024 20:07:52 +1100
Subject: [PATCH 29/33] Update maven-ci.yml
---
.github/workflows/maven-ci.yml | 46 +++++++++++-----------------------
1 file changed, 14 insertions(+), 32 deletions(-)
diff --git a/.github/workflows/maven-ci.yml b/.github/workflows/maven-ci.yml
index ad377e3..f358cb7 100644
--- a/.github/workflows/maven-ci.yml
+++ b/.github/workflows/maven-ci.yml
@@ -27,7 +27,7 @@ jobs:
id: version
uses: avides/actions-project-version-check@v1.4.0
with:
- token: ${{ secrets.RELEASE_TOKEN }}
+ token: ${{ secrets.GITHUB_TOKEN }}
file-to-check: UltiTools-API/pom.xml
only-return-version: true
@@ -44,11 +44,15 @@ jobs:
steps:
- uses: actions/checkout@v3
+ - name: Get latest commit message
+ id: commit
+ run: echo "::set-output name=message::$(git log --format=%B -n 1 ${{ github.sha }})"
+
- name: Get Project Version from pom.xml
id: version
uses: avides/actions-project-version-check@v1.4.0
with:
- token: ${{ secrets.RELEASE_TOKEN }}
+ token: ${{ secrets.GITHUB_TOKEN }}
file-to-check: UltiTools-API/pom.xml
only-return-version: true
@@ -57,47 +61,25 @@ jobs:
with:
name: ultitools-artifact
- - name: Get Latest Merged PR
- id: get-pr
- uses: actions/github-script@v5
- with:
- script: |
- const { data: pullRequests } = await github.rest.pulls.list({
- owner: context.repo.owner,
- repo: context.repo.repo,
- state: 'closed',
- sort: 'updated',
- direction: 'desc',
- per_page: 1
- });
- const mergedPR = pullRequests.find(pr => pr.merged_at);
- return {
- title: mergedPR.title,
- body: mergedPR.body
- };
- result-encoding: json
-
- name: Create Release
id: create_release
uses: actions/create-release@v1
env:
- GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN }}
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: v${{ steps.version.outputs.version }}
- release_name: Release ${{ steps.version.outputs.version }}
- body: |
- # ${{ steps.get-pr.outputs.title }}
- ${{ steps.get-pr.outputs.body }}
+ release_name: Release v${{ steps.version.outputs.version }}
+ body: ${{ steps.commit.outputs.message }}
draft: false
prerelease: false
-
+
- name: Upload Release Asset
+ id: upload-release-asset
uses: actions/upload-release-asset@v1
env:
- GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN }}
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ steps.create_release.outputs.upload_url }}
- asset_path: ./UltiTools-API/target/UltiTools-API-${{ steps.version.outputs.version }}.jar
- asset_name: UltiTools-API-${{ steps.version.outputs.version }}.jar
+ asset_path: UltiTools-API-${{ steps.version.outputs.version }}.jar
+ asset_name: UltiTools-API.jar
asset_content_type: application/java-archive
-
From 1282dfaeefdf7b660275a5d428f28c6f3bb7a296 Mon Sep 17 00:00:00 2001
From: Ling Bao <41609381+wisdommen@users.noreply.github.com>
Date: Sun, 21 Jan 2024 01:32:57 +1100
Subject: [PATCH 30/33] Update maven-ci.yml
---
.github/workflows/maven-ci.yml | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/.github/workflows/maven-ci.yml b/.github/workflows/maven-ci.yml
index f358cb7..4054488 100644
--- a/.github/workflows/maven-ci.yml
+++ b/.github/workflows/maven-ci.yml
@@ -37,6 +37,14 @@ jobs:
name: ultitools-artifact
path: UltiTools-API/target/UltiTools-API-${{ steps.version.outputs.version }}.jar
+ - name: Deploy Java DOC
+ uses: SamKirkland/FTP-Deploy-Action@v4.3.4
+ with:
+ server: ${{ secrets.FTP_HOST }}
+ username: ${{ secrets.FTP_USERNAME }}
+ password: ${{ secrets.FTP_PASSWORD }}
+ local-dir: "./UltiTools-API/target/apidocs/"
+
release:
needs: build
runs-on: ubuntu-latest
From c7974efe79feb45ce2b91da2d6fab3ffc452e4b5 Mon Sep 17 00:00:00 2001
From: Ling Bao <41609381+wisdommen@users.noreply.github.com>
Date: Wed, 24 Jan 2024 11:11:48 +1100
Subject: [PATCH 31/33] Update README.md
---
README.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/README.md b/README.md
index 46be571..b513150 100644
--- a/README.md
+++ b/README.md
@@ -56,6 +56,8 @@ UltiTools是一个高层的基础插件，包含了很多GUI和高级的玩法
希望我的插件能够帮到你的插件开发！
+[详细开发文档](https://dev.ultikits.com/zh/)
+
### 注解驱动的
UltiTools-API改变了插件开发的方式，通过引入注解等高级语法，让你的插件开发更加高效。
From a65e916f26948437ffdb5ec9247708edbaa1e48a Mon Sep 17 00:00:00 2001
From: Ling Bao <41609381+wisdommen@users.noreply.github.com>
Date: Wed, 24 Jan 2024 11:19:12 +1100
Subject: [PATCH 32/33] Update README.md
---
README.md | 25 +++++--------------------
1 file changed, 5 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
index b513150..3a4e7a3 100644
--- a/README.md
+++ b/README.md
@@ -35,29 +35,19 @@
-
-
-## 给各位服主的介绍
+## UltiTools-API 简介
+
+希望我的插件能够帮到你的插件开发！
-UltiTools是一个高层的基础插件，包含了很多GUI和高级的玩法，而非仅仅所谓的“基础”。
+[详细开发文档](https://dev.ultikits.com/zh/)
插件本身的详细介绍，请看mcbbs的帖子。
[\[综合\]UltiTools —— 远程背包\|GUI登陆\|GUI邮箱\|礼包\|头显\|侧边栏~\[1.8.x-1.20.x\]](https://www.mcbbs.net/thread-1062730-1-1.html)
-用户使用文档
-
-[UltiTools 文档](https://doc.ultitools.ultikits.com/)
-
-## 给开发者的介绍
-
-希望我的插件能够帮到你的插件开发！
-
-[详细开发文档](https://dev.ultikits.com/zh/)
-
### 注解驱动的
UltiTools-API改变了插件开发的方式，通过引入注解等高级语法，让你的插件开发更加高效。
@@ -225,10 +215,7 @@ UltiTools也提供了Adventure的API。
以下是简单的快速开始
-
-快速开始
-
-### 快速开始
+### 安装依赖
首先将UltiTools-API依赖加入到你的项目
@@ -331,8 +318,6 @@ public List getAllConfigs() {
}
```
-
-
From 18c9eed81fe60e8e996a572fcf5e73e6b0dc2565 Mon Sep 17 00:00:00 2001
From: Ling Bao <41609381+wisdommen@users.noreply.github.com>
Date: Wed, 24 Jan 2024 11:41:46 +1100
Subject: [PATCH 33/33] Update README.md
---
README.md | 190 +++++++++++++++++++++++++++---------------------------
1 file changed, 95 insertions(+), 95 deletions(-)
diff --git a/README.md b/README.md
index 3a4e7a3..cc365a7 100644
--- a/README.md
+++ b/README.md
@@ -30,7 +30,7 @@
-| [](https://discord.gg/6TVRRF47) | 👈 点击左侧按钮加入官方 Discord 服务器！ | 点击右侧按钮加入官方 QQ 群！ 👉 | [](https://qm.qq.com/cgi-bin/qm/qr?k=UNq3LPCmpfH2aLum7V0GmMRFBusNxqxn&jump_from=webapi) |
+| [](https://discord.gg/6TVRRF47) | 👈 Click to join Discord server! | 点击右侧按钮加入官方 QQ 群！ 👉 | [](https://qm.qq.com/cgi-bin/qm/qr?k=UNq3LPCmpfH2aLum7V0GmMRFBusNxqxn&jump_from=webapi) |
|-----------------------------------------------------------------------------------------------------------------------------------------|----------------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -38,27 +38,26 @@
-## UltiTools-API 简介
+## UltiTools-API Introduction
-希望我的插件能够帮到你的插件开发！
+[中文文档](https://github.com/UltiKits/UltiTools-Reborn/wiki/%E4%B8%AD%E6%96%87%E4%BB%8B%E7%BB%8D)
-[详细开发文档](https://dev.ultikits.com/zh/)
+I hope my plugin can help with your plugin development! XD
-插件本身的详细介绍，请看mcbbs的帖子。
+[Detailed Dev Documents](https://dev.ultikits.com/en/)
-[\[综合\]UltiTools —— 远程背包\|GUI登陆\|GUI邮箱\|礼包\|头显\|侧边栏~\[1.8.x-1.20.x\]](https://www.mcbbs.net/thread-1062730-1-1.html)
-### 注解驱动的
+### Annotation-driven
-UltiTools-API改变了插件开发的方式，通过引入注解等高级语法，让你的插件开发更加高效。
+UltiTools-API has changed the way plugin development is done. By introducing advanced syntax like annotations, it makes your plugin development much more efficient.
-通过使用UltiTools-API，你再也无需手动注册指令和监听器，只需要在你的指令类和监听器类上添加注解，UltiTools-API会自动帮你注册。
+With UltiTools-API, you no longer need to manually register commands and listeners. Simply add annotations to your command classes and listener classes, and UltiTools-API will automatically register them for you.
-你也可以像写一个控制器一样，再也不需要为一个命令做繁琐的判断，只需要在你的指令方法上添加注解，UltiTools-API会自动帮你将指令匹配到对应的方法上。
+You can also write your commands like a controller. You no longer need to make tedious judgments for a command. Just add annotations to your command methods, and UltiTools-API will automatically match the commands to the corresponding methods.
```java
@CmdTarget(CmdTarget.CmdTargetType.PLAYER)
-@CmdExecutor(alias = {"lore"}, manualRegister = true, permission = "ultikits.tools.command.lore", description = "物品Lore编辑功能")
+@CmdExecutor(alias = {"lore"}, manualRegister = true, permission = "ultikits.tools.command.lore", description = "Lore edit function")
public class LoreCommands extends AbstractCommendExecutor {
@CmdMapping(format = "add ")
@@ -78,16 +77,17 @@ public class LoreCommands extends AbstractCommendExecutor {
@Override
protected void handleHelp(CommandSender sender) {
- sender.sendMessage(ChatColor.RED + "lore add <内容>" + ChatColor.GRAY + " - " + BasicFunctions.getInstance().i18n("添加Lore"));
- sender.sendMessage(ChatColor.RED + "lore delete <行数>" + ChatColor.GRAY + " - " + BasicFunctions.getInstance().i18n("删除Lore"));
- sender.sendMessage(ChatColor.RED + "lore edit <行数> <内容>" + ChatColor.GRAY + " - " + BasicFunctions.getInstance().i18n("编辑Lore"));
+ sender.sendMessage(ChatColor.RED + "lore add " + ChatColor.GRAY + " - " + BasicFunctions.getInstance().i18n("Add Lore"));
+ sender.sendMessage(ChatColor.RED + "lore delete " + ChatColor.GRAY + " - " + BasicFunctions.getInstance().i18n("Delete Lore"));
+ sender.sendMessage(ChatColor.RED + "lore edit " + ChatColor.GRAY + " - " + BasicFunctions.getInstance().i18n("Edit Lore"));
}
}
```
-数据存储方面，UltiTools提供了Mysql和Json的封装API，让你无需考虑用户会使用哪种数据存储方式。
+In terms of data storage, UltiTools provides wrapped APIs for both MySQL and JSON, allowing you not to worry about which data storage method the users will choose.
+
+For example
-例如
```java
@Data
@Builder
@@ -106,7 +106,7 @@ public class AccountEntity extends AbstractDataEntity {
```
```java
-//检查玩家账户是否存在
+// check if the player account exists
public boolean playerHasAccount(UUID player, String name) {
DataOperator dataOperator = UltiEconomy.getInstance().getDataOperator(AccountEntity.class);
return dataOperator.exist(
@@ -116,29 +116,30 @@ public boolean playerHasAccount(UUID player, String name) {
}
```
-配置文件方面，UltiTools让你可以像操作对象一样读取配置文件。
+Regarding configuration files, UltiTools allows you to read the configuration files as if you were manipulating objects.
+
+For example
-例如
```java
@Getter
@Setter
@ConfigEntity(path = "config/config.yml")
public class EcoConfig extends AbstractConfigEntity {
- @ConfigEntry(path = "useThirdPartEconomy", comment = "是否使用其他的经济插件作为基础（即仅使用本插件的银行功能）")
+ @ConfigEntry(path = "useThirdPartEconomy", comment = "Whether to use another economy plugin as a base (i.e., only use the bank function of this plugin)")
private boolean useThirdPartEconomy = false;
- @ConfigEntry(path = "enableInterest", comment = "是否开启利息")
+ @ConfigEntry(path = "enableInterest", comment = "Whether to enable interest")
private boolean enableInterest = true;
- @ConfigEntry(path = "interestRate", comment = "利率，利息 = 利率 × 本金")
+ @ConfigEntry(path = "interestRate", comment = "Interest rate, interest = interest rate × principal")
private double interestRate = 0.0003;
- @ConfigEntry(path = "interestTime", comment = "利息发放间隔（分钟）")
+ @ConfigEntry(path = "interestTime", comment = "Interval for interest distribution (minutes)")
private int interestTime = 30;
- @ConfigEntry(path = "initial_money", comment = "玩家初始货币数量")
+ @ConfigEntry(path = "initial_money", comment = "Initial amount of currency for players")
private double initMoney = 1000;
- @ConfigEntry(path = "op_operate_money", comment = "服务器管理员是否能够增减玩家货币")
+ @ConfigEntry(path = "op_operate_money", comment = "Whether the server administrator can increase or decrease player currency")
private boolean opOperateMoney = false;
- @ConfigEntry(path = "currency_name", comment = "货币名称")
- private String currencyName = "金币";
- @ConfigEntry(path = "server_trade_log", comment = "是否开启服务器交易记录")
+ @ConfigEntry(path = "currency_name", comment = "Name of the currency")
+ private String currencyName = "Gold Coin";
+ @ConfigEntry(path = "server_trade_log", comment = "Whether to enable server trade log")
private boolean enableTradeLog = false;
public EcoConfig(String configFilePath) {
super(configFilePath);
@@ -146,17 +147,17 @@ public class EcoConfig extends AbstractConfigEntity {
}
```
```java
-// 获取经济插件的配置文件，并且读取利息率
+// Get the configuration file of the economy plugin and read the interest rate
EcoConfig config = UltiEconomy.getInstance().getConfig(EcoConfig.class);
-double intrestRate = config.getInterestRate();
+double interestRate = config.getInterestRate();
```
-### IOC容器管理
+### IOC Container
-UltiTools-API提供了一个Spring IOC容器，它可以帮你管理你的插件中的所有Bean，并且自动注入依赖。
+UltiTools-API provides a Spring IOC container, which can manage all the Beans in your plugin and automatically inject dependencies.
```java
-// @Service将类型标记为一个Bean，UltiTools-API会自动扫描并注册
+// @Service marks the type as a Bean, and UltiTools-API will automatically scan and register it
@Service
public class BanPlayerService {
@@ -171,55 +172,55 @@ public class BanPlayerService {
```java
@CmdTarget(CmdTarget.CmdTargetType.BOTH)
-@CmdExecutor(permission = "ultikits.ban.command.all", description = "封禁功能", alias = {"uban"}, manualRegister = true)
+@CmdExecutor(permission = "ultikits.ban.command.all", description = "Ban function", alias = {"uban"}, manualRegister = true)
public class BanCommands extends AbstractCommendExecutor {
- // 使用@Autowired注解，UltiTools-API会自动注入依赖
+ // Using the @Autowired annotation, UltiTools-API will automatically inject the dependency
@Autowired
private BanPlayerService banPlayerService;
@CmdMapping(format = "unban ")
public void unBanPlayer(@CmdSender CommandSender sender, @CmdParam("player") String player) {
banPlayerService.unBanPlayer(Bukkit.getOfflinePlayer(player));
- sender.sendMessage(BasicFunctions.getInstance().i18n("§a解封成功"));
+ sender.sendMessage(BasicFunctions.getInstance().i18n("§aUnban successful"));
}
...
}
```
-如果你不喜欢自动注入，或者无法使用自动注入，你也可以手动获取Bean。
+If you don't like automatic injection, or can't use automatic injection, you can also manually obtain the Bean.
```java
BanPlayerService banPlayerService = getContext().getBean(BanPlayerService.class);
```
-### 提供超多的现代化依赖库
+### Providing Numerous Modern Dependency Libraries
-UltiTools-API提供了Hutool的部分功能，包括了大量的工具类。
+UltiTools-API offers some functionalities of Hutool, including a large number of utility classes.
-[Hutool 文档](https://hutool.cn/docs/#/)
+[Hutool Documentation](ttps://hutoolkit.com/docs/)
-GUI界面方面，UltiTools提供了obliviate-invs的API，方便你快速的开发GUI界面。
+In terms of GUI interfaces, UltiTools provides the obliviate-invs API, facilitating rapid GUI development.
[ObliviateInvs — Highly efficient modular GUI library](https://www.spigotmc.org/resources/obliviateinvs-%E2%80%94-highly-efficient-modular-gui-library.103572/)
-UltiTools也提供了Adventure的API。
+UltiTools also offers the Adventure API.
-[Adventure 文档](https://docs.adventure.kyori.net/)
+[Adventure Documentation](https://docs.adventure.kyori.net/)
-## 快速开始
+## Quick Start
-更多详细文档请查看 [UltiTools API 文档](https://doc.dev.ultikits.com/)
+For more detailed documentation, please refer to [UltiTools API Documentation ](https://dev.ultikits.com/en/)
-以下是简单的快速开始
+Below is a simple quick start guide.
-### 安装依赖
+### Installing Dependencies
-首先将UltiTools-API依赖加入到你的项目
+First, add the UltiTools-API dependency to your project.
-使用Maven
+Using Maven
```xml
@@ -229,85 +230,84 @@ UltiTools也提供了Adventure的API。
```
-使用Gradle
+Using Gradle
```groovy
implementation 'com.ultikits:UltiTools-API:{VERSION}'
```
-开始之前请在resources文件夹下新建一个plugin.yml文件，内容如下
+Before starting, please create a plugin.yml file in the resources folder with the following content:
```yaml
-# 插件名称
+# Plugin name
name: TestPlugin
-# 插件版本
+# Plugin version
version: '${project.version}'
-# 插件主类
+# Plugin main class
main: com.test.plugin.MyPlugin
-# 插件用到的UltiTools-API版本，例如6.0.0就是600
+# UltiTools-API version used by the plugin, for example, 6.0.0 is 600
api-version: 600
-# 插件作者
+# Plugin authors
authors: [ wisdomme ]
```
-新建一个config文件夹，里面可以按照你的需求放入你的插件配置文件。这些配置文件会被原封不动的放入UltiTools插件的集体配置文件夹中展示给用户。
+Create a config folder, where you can put your plugin configuration files according to your needs. These configuration files will be placed unmodified in the collective configuration folder of the UltiTools plugin for display to users.
-### 简单开发
+### Simple Guide
-新建一个主类继承UltiToolsPlugin，类似传统的Spigot插件，UltiTools插件也需要重写启动和关闭方法。
-但是UltiToolsPlugin增加了一个可选的```UltiToolsPlugin#reloadSelf()```方法，用于插件重载时执行。
+Create a main class extending `UltiToolsPlugin`. Similar to traditional Spigot plugins, UltiTools plugins also need to override the start and stop methods. However, `UltiToolsPlugin` adds an optional `UltiToolsPlugin#reloadSelf()` method for use during plugin reload.
```java
public class MyPlugin extends UltiToolsPlugin {
@Override
public boolean registerSelf() {
- // 插件启动时执行
+ // Executes when the plugin starts
return true;
}
@Override
public void unregisterSelf() {
- // 插件关闭时执行
+ // Executes when the plugin shuts down
}
@Override
public void reloadSelf() {
- // 插件重载时执行
+ // Executes when the plugin is reloaded
}
}
```
-这样就已经完成了一个什么功能都没有的UltiTools插件。然后你可以在```UltiToolsPlugin#registerSelf()```方法中注册你的监听器和指令。
+With this, you've completed an UltiTools plugin that does nothing. Then, you can register your listeners and commands in the `UltiToolsPlugin#registerSelf()` method.
```java
public class MyPlugin extends UltiToolsPlugin {
@Override
public boolean registerSelf() {
- // 注册一个Test指令，权限为permission.test，指令为test
- // 无需在Plugin.yml中注册指令
- getCommandManager().register(new TestCommands(), "permission.test", "示例功能", "test");
- // 注册监听器
+ // Register a Test command, with permission 'permission.test', and command 'test'
+ // No need to register the command in Plugin.yml
+ getCommandManager().register(new TestCommands(), "permission.test", "Sample Function", "test");
+ // Register listeners
getListenerManager().register(this, new TestListener());
return true;
}
}
```
-然后你可以在主类中添加你的配置文件，UltiTools会自动加载配置文件。
+Then, you can add your configuration file in the main class, and UltiTools will automatically load the configuration file.
```java
public class MyPlugin extends UltiToolsPlugin {
@Override
public boolean registerSelf() {
- // 注册一个Test指令，权限为permission.test，指令为test
- // 无需在Plugin.yml中注册指令
- getCommandManager().register(new TestCommands(), "permission.test", "示例功能", "test");
- // 注册监听器
+ // Register a Test command, with permission 'permission.test', and command 'test'
+ // No need to register the command in Plugin.yml
+ getCommandManager().register(new TestCommands(), "permission.test", "Sample Function", "test");
+ // Register listeners
getListenerManager().register(this, new TestListener());
- // 注册配置文件
+ // Register configuration file
getConfigManager().register(this, new TestConfig("config/config.yml"));
return true;
}
}
```
-或者你可以重写```UltiToolsPlugin#getAllConfigs()```方法，将所有的配置文件注册放在这里。
+Alternatively, you can override the `UltiToolsPlugin#getAllConfigs()` method to register all configuration files here.
```java
@Override
@@ -321,40 +321,40 @@ public List getAllConfigs() {
-## WakaTime 统计
+## WakaTime Statistics
-开发时间线统计
-点击查看统计数据
+Development Timeline Statistics
+Click to view statistics
-
-## 主要贡献者
-| 贡献者 | 描述 |
+
+## Main Contributors
+| Contributor | Description |
|--------------------------------------------------|-----------------------------------------|
-| [@wisdommen](https://github.com/wisdommen) | 创始人，UltiKits套件作者 |
-| [@qianmo2233](https://github.com/qianmo2233) | UltiTools&UltiCore开发者，UltiKits开发文档主要维护者 |
-| [@Shpries](https://github.com/Shpries) | UltiTools开发者，UltiTools使用文档主要维护者 |
-| [@DevilJueChen](https://github.com/DevilJueChen) | UltiKits问题&漏洞&建议反馈 |
-| 拾柒 | 美工 |
+| [@wisdommen](https://github.com/wisdommen) | Founder, UltiKits Author |
+| [@qianmo2233](https://github.com/qianmo2233) | UltiTools & UltiCore Developer, Main Maintainer of UltiKits Development Documentation |
+| [@Shpries](https://github.com/Shpries) | UltiTools Developer, Main Maintainer of UltiKits Development Documentation |
+| [@DevilJueChen](https://github.com/DevilJueChen) | Feedback on UltiKits Issues, Bugs & Suggestions |
+| 拾柒 | Graphic Designer |
-## 发现问题？想提建议？
-[点击这里提交开启一个Issue！](https://github.com/wisdommen/UltiTools/issues/new/choose)
+## Found an Issue? Want to Make a Suggestion?
+[Click here to submit an Issue!](https://github.com/UltiKits/UltiTools-Reborn/issues/new/choose)
-## 鸣谢
+## Acknowledgments
| | |
|---------------------------------------------------------------------------------------------------------------------------|------------------------|
-|  | 记录了我们开发途中的每一刻 |
-|  | 地表最强 Java IDE 助力愉悦开发体验 |
-|  | 帮助解决了许多重复且枯燥的工作 |
-|  | 为插件带来了许多黑科技 |
-|  | 官方构建工具 |
-|  | 官方内置 HTTP 服务端 |
+|  | Recorded every moment of our development journey |
+|  | The strongest Java IDE for a pleasant development experience |
+|  | Helped solve many repetitive and tedious tasks |
+|  | Brought many high-tech features to the plugin |
+|  | Official build tool |
+|  | Official built-in HTTP server |