refactor(proj): 放弃spigot项目，将Bukkit子项目单独提出。

README.md

@@ -20,44 +20,35 @@ EasyConfiguration for MineCraft!
 
 ## 项目结构
 
-### **MineConfiguration-Common**
+### **MineConfiguration-Common** [`common`](common)
 
-全部版本的共用部分，包括
+全部版本的共用部分(均已被打包至下行包中)，包括
 
 - `ConfigMessage` (实现类为 `ConfiguredMessage<M>`)
 - `ConfigMessageList` (实现类为 `ConfiguredMessageList<M>`)
 
 如要使用，请访问对应实现类的builder() 方法来快速创建。
 
-### MineConfiguration-Bukkit
+### **MineConfiguration-Bukkit** [`platform/bukkit`](platform/bukkit)
 
-#### MineConfiguration-Bukkit-Base
-
-Bukkit系通用依赖，不包含实现部分，请使用 **MineConfiguration-Bukkit-General** 或 **MineConfiguration-Bukkit-Native** 。
+适用于Bukkit的版本，同时支持其他以Bukkit为基础的服务端 *(如Spigot、Paper、CatServer)* 。
 
 相较于基础版本，额外提供了以下功能：
 
 - `ConfiguredSerializable<T extends ConfigurationSerializable>`
-- `ConfiguredItem` (快捷读取简单的物品配置文件)
-- `ConfiguredSound` (快捷读取音效配置文件)
+- `ConfiguredItem` (快捷读\写\使用简单的物品配置文件)
+- `ConfiguredSound` (快捷读\写\使用音效配置文件)
+- `ConfiguredTitle` (快速读\写\使用标题文字配置文件)
 
 以上类型可以通过 `CraftConfigValue.builder()` 来创建，部分类型提供了 `of(...);` 方法来快速创建。
 
-#### **MineConfiguration-Bukkit** _(推荐)_
-
-适用于Bukkit的版本，包含以Bukkit为基础的其他服务端 *(如Spigot、Paper、CatServer)* 。
-
-#### **MineConfiguration-Spigot**
-
-适用于 Spigot(1.18+) 的版本，适配了1.18及以后版本Spigot原生自带的配置文件注释功能，随Spigot更新而优化，安全稳定。
-
-### **MineConfiguration-Bungee**
+### **MineConfiguration-Bungee** [`platform/bungee`](platform/bungee)
 
 适用于BungeeCord的版本，可用JSON与YAML格式。其中JSON格式**不支持配置文件注释**。
 
 ## 开发
 
-请详见 [EasyConfiguration](https://github.com/CarmJos/EasyConfiguration)
+其他功能请详见 [EasyConfiguration](https://github.com/CarmJos/EasyConfiguration)
 的 [开发介绍](https://github.com/CarmJos/EasyConfiguration/tree/master/.documentation) 。
 
 ### 依赖方式

common/pom.xml

@@ -5,15 +5,20 @@
     <parent>
         <artifactId>mineconfiguration-parent</artifactId>
         <groupId>cc.carm.lib</groupId>
-        <version>2.2.1</version>
+        <version>2.3.0</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <properties>
         <maven.compiler.source>${project.jdk.version}</maven.compiler.source>
         <maven.compiler.target>${project.jdk.version}</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <maven.compiler.encoding>UTF-8</maven.compiler.encoding>
     </properties>
     <artifactId>mineconfiguration-common</artifactId>
 
+    <name>MineConfiguration-Common</name>
+    <description>轻松(做)配置，全部版本的共用部分。</description>
+
     <dependencies>
 
         <dependency>

common/src/main/java/cc/carm/lib/mineconfiguration/common/value/BaseMessage.java

@@ -106,6 +106,26 @@ public interface BaseMessage<R, M> {
         }
     }
 
+
+    /**
+     * 广播此消息(包括后台)
+     *
+     * @param values 已定变量的对应参数(按定义顺序)
+     */
+    default void sendToAll(@Nullable Object... values) {
+        broadcast(values);
+    }
+
+    /**
+     * 广播此消息(包括后台)
+     *
+     * @param placeholders 消息中的变量与对应参数
+     */
+    default void sendToAll(@NotNull Map<String, Object> placeholders) {
+        broadcast(placeholders);
+    }
+
+
     /**
      * 广播此消息(包括后台)
      *

platform/bukkit/base/pom.xml

@@ -1,38 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-    <parent>
-        <artifactId>mineconfiguration-bukkit-parent</artifactId>
-        <groupId>cc.carm.lib</groupId>
-        <version>2.2.1</version>
-    </parent>
-    <modelVersion>4.0.0</modelVersion>
-    <properties>
-        <maven.compiler.source>${project.jdk.version}</maven.compiler.source>
-        <maven.compiler.target>${project.jdk.version}</maven.compiler.target>
-    </properties>
-    <artifactId>mineconfiguration-bukkit-base</artifactId>
-    <packaging>jar</packaging>
-
-    <dependencies>
-
-        <dependency>
-            <groupId>${project.parent.groupId}</groupId>
-            <artifactId>mineconfiguration-common</artifactId>
-            <version>${project.parent.version}</version>
-            <scope>compile</scope>
-        </dependency>
-
-    </dependencies>
-
-    <build>
-        <plugins>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-javadoc-plugin</artifactId>
-            </plugin>
-        </plugins>
-    </build>
-
-</project>

platform/bukkit/general/pom.xml

@@ -1,41 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-    <parent>
-        <artifactId>mineconfiguration-bukkit-parent</artifactId>
-        <groupId>cc.carm.lib</groupId>
-        <version>2.2.1</version>
-    </parent>
-    <modelVersion>4.0.0</modelVersion>
-    <properties>
-        <maven.compiler.source>${project.jdk.version}</maven.compiler.source>
-        <maven.compiler.target>${project.jdk.version}</maven.compiler.target>
-    </properties>
-
-    <artifactId>mineconfiguration-bukkit</artifactId>
-    <packaging>jar</packaging>
-
-    <name>MineConfiguration-Bukkit</name>
-
-    <dependencies>
-
-        <dependency>
-            <groupId>${project.parent.groupId}</groupId>
-            <artifactId>mineconfiguration-bukkit-base</artifactId>
-            <version>${project.parent.version}</version>
-            <scope>compile</scope>
-        </dependency>
-
-    </dependencies>
-
-    <build>
-        <plugins>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-javadoc-plugin</artifactId>
-            </plugin>
-        </plugins>
-    </build>
-
-</project>

platform/bukkit/pom.xml

@@ -5,25 +5,31 @@
     <parent>
         <artifactId>mineconfiguration-parent</artifactId>
         <groupId>cc.carm.lib</groupId>
-        <version>2.2.1</version>
+        <version>2.3.0</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <properties>
         <maven.compiler.source>${project.jdk.version}</maven.compiler.source>
         <maven.compiler.target>${project.jdk.version}</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <maven.compiler.encoding>UTF-8</maven.compiler.encoding>
     </properties>
-    <artifactId>mineconfiguration-bukkit-parent</artifactId>
-    <packaging>pom</packaging>
-    <modules>
-        <module>base</module>
-        <module>general</module>
-    </modules>
+    <artifactId>mineconfiguration-bukkit</artifactId>
+    <packaging>jar</packaging>
 
-    <name>MineConfiguration-Bukkit-Parent</name>
+    <name>MineConfiguration-Bukkit</name>
+    <description>轻松(做)配置，适用于Bukkit系服务端的版本。</description>
 
     <dependencies>
 
+        <dependency>
+            <groupId>${project.parent.groupId}</groupId>
+            <artifactId>mineconfiguration-common</artifactId>
+            <version>${project.parent.version}</version>
+            <scope>compile</scope>
+        </dependency>
+
         <!--suppress VulnerableLibrariesLocal -->
         <dependency>
             <groupId>org.bukkit</groupId>
@@ -50,4 +56,13 @@
 
     </dependencies>
 
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+
 </project>

platform/bukkit/src/main/java/cc/carm/lib/mineconfiguration/bukkit/CraftConfigValue.java

@@ -25,7 +25,7 @@ public abstract class CraftConfigValue<T> extends CachedConfigValue<T> {
     public CraftConfigProvider getBukkitProvider() {
         ConfigurationProvider<?> provider = getProvider();
         if (provider instanceof CraftConfigProvider) return (CraftConfigProvider) getProvider();
-        else throw new IllegalStateException("Provider is not a SpigotConfigProvider");
+        else throw new IllegalStateException("Provider is not a CraftConfigProvider");
     }
 
     public CraftSectionWrapper getBukkitConfig() {

platform/bukkit/src/main/java/cc/carm/lib/mineconfiguration/bukkit/MineConfiguration.java

@@ -38,4 +38,5 @@ public class MineConfiguration {
     public static BukkitConfigProvider from(Plugin plugin, String fileName, String source) {
         return from(new File(plugin.getDataFolder(), fileName), source);
     }
+
 }

platform/bukkit/src/main/java/cc/carm/lib/mineconfiguration/bukkit/value/ConfiguredTitle.java

@@ -87,15 +87,15 @@ public class ConfiguredTitle extends ConfiguredSection<TitleConfig> {
         }
     }
 
-    public void sendAll(Object... values) {
-        sendAll(this.params, values);
+    public void sendToAll(Object... values) {
+        sendToAll(this.params, values);
     }
 
-    public void sendAll(@NotNull String[] params, @NotNull Object[] values) {
-        sendAll(ParamsUtils.buildParams(params, values));
+    public void sendToAll(@NotNull String[] params, @NotNull Object[] values) {
+        sendToAll(ParamsUtils.buildParams(params, values));
     }
 
-    public void sendAll(@NotNull Map<String, Object> placeholders) {
+    public void sendToAll(@NotNull Map<String, Object> placeholders) {
         TitleConfig config = get();
         if (config == null) return;
 

platform/bungee/pom.xml

@@ -5,18 +5,21 @@
     <parent>
         <artifactId>mineconfiguration-parent</artifactId>
         <groupId>cc.carm.lib</groupId>
-        <version>2.2.1</version>
+        <version>2.3.0</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <properties>
         <maven.compiler.source>${project.jdk.version}</maven.compiler.source>
         <maven.compiler.target>${project.jdk.version}</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <maven.compiler.encoding>UTF-8</maven.compiler.encoding>
     </properties>
     <artifactId>mineconfiguration-bungee</artifactId>
     <packaging>jar</packaging>
 
     <name>MineConfiguration-Bungee</name>
+    <description>轻松(做)配置，适用于BungeeCord的版本，可用JSON与YAML格式。</description>
 
     <dependencies>
 

platform/spigot/pom.xml

@@ -1,67 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-    <parent>
-        <groupId>cc.carm.lib</groupId>
-        <artifactId>mineconfiguration-parent</artifactId>
-        <version>2.2.1</version>
-        <relativePath>../../pom.xml</relativePath>
-    </parent>
-    <modelVersion>4.0.0</modelVersion>
-    <properties>
-        <maven.compiler.source>${project.jdk.version}</maven.compiler.source>
-        <maven.compiler.target>${project.jdk.version}</maven.compiler.target>
-    </properties>
-
-    <artifactId>mineconfiguration-spigot</artifactId>
-    <packaging>jar</packaging>
-
-    <name>MineConfiguration-Spigot</name>
-
-    <dependencies>
-
-        <dependency>
-            <groupId>${project.parent.groupId}</groupId>
-            <artifactId>mineconfiguration-bukkit-base</artifactId>
-            <version>${project.parent.version}</version>
-            <scope>compile</scope>
-        </dependency>
-
-        <dependency>
-            <groupId>org.spigotmc</groupId>
-            <artifactId>spigot-api</artifactId>
-            <version>1.18.2-R0.1-SNAPSHOT</version>
-            <scope>provided</scope>
-        </dependency>
-
-
-        <!--PlaceholderAPI for general placeholder's support-->
-        <dependency>
-            <groupId>me.clip</groupId>
-            <artifactId>placeholderapi</artifactId>
-            <version>2.11.2</version>
-            <scope>provided</scope>
-        </dependency>
-
-        <!--ProtocolLib for general packet's function support-->
-        <dependency>
-            <groupId>com.comphenix.protocol</groupId>
-            <artifactId>ProtocolLib</artifactId>
-            <version>4.8.0</version>
-            <scope>provided</scope>
-        </dependency>
-
-    </dependencies>
-
-    <build>
-        <plugins>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-javadoc-plugin</artifactId>
-            </plugin>
-        </plugins>
-    </build>
-
-
-</project>

platform/spigot/src/main/java/cc/carm/lib/mineconfiguration/spigot/MineConfiguration.java

@@ -1,42 +0,0 @@
-package cc.carm.lib.mineconfiguration.spigot;
-
-import cc.carm.lib.mineconfiguration.spigot.source.SpigotConfigProvider;
-import org.bukkit.plugin.Plugin;
-
-import java.io.File;
-import java.io.IOException;
-
-public class MineConfiguration {
-
-    public static SpigotConfigProvider from(File file, String source) {
-        SpigotConfigProvider provider = new SpigotConfigProvider(file);
-        try {
-            provider.initializeFile(source);
-            provider.initializeConfig();
-        } catch (IOException e) {
-            e.printStackTrace();
-        }
-        return provider;
-    }
-
-    public static SpigotConfigProvider from(File file) {
-        return from(file, file.getName());
-    }
-
-    public static SpigotConfigProvider from(String fileName) {
-        return from(fileName, fileName);
-    }
-
-    public static SpigotConfigProvider from(String fileName, String source) {
-        return from(new File(fileName), source);
-    }
-
-    public static SpigotConfigProvider from(Plugin plugin, String fileName) {
-        return from(plugin, fileName, fileName);
-    }
-
-    public static SpigotConfigProvider from(Plugin plugin, String fileName, String source) {
-        return from(new File(plugin.getDataFolder(), fileName), source);
-    }
-
-}

platform/spigot/src/main/java/cc/carm/lib/mineconfiguration/spigot/source/SpigotConfigProvider.java

@@ -1,32 +0,0 @@
-package cc.carm.lib.mineconfiguration.spigot.source;
-
-import cc.carm.lib.configuration.core.ConfigInitializer;
-import cc.carm.lib.configuration.core.source.ConfigurationComments;
-import cc.carm.lib.mineconfiguration.bukkit.source.CraftConfigProvider;
-import org.bukkit.configuration.file.YamlConfiguration;
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
-
-import java.io.File;
-
-public class SpigotConfigProvider extends CraftConfigProvider {
-
-    public SpigotConfigProvider(@NotNull File file) {
-        super(file);
-    }
-
-    protected SpigotYAMLComments comments = null;
-
-    @Override
-    public void initializeConfig() {
-        this.configuration = YamlConfiguration.loadConfiguration(file);
-        this.comments = new SpigotYAMLComments(configuration);
-        this.initializer = new ConfigInitializer<>(this);
-    }
-
-    @Override
-    public @Nullable ConfigurationComments getComments() {
-        return this.comments;
-    }
-
-}

platform/spigot/src/main/java/cc/carm/lib/mineconfiguration/spigot/source/SpigotYAMLComments.java

@@ -1,48 +0,0 @@
-package cc.carm.lib.mineconfiguration.spigot.source;
-
-import cc.carm.lib.configuration.core.source.ConfigurationComments;
-import org.bukkit.configuration.file.YamlConfiguration;
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
-import org.jetbrains.annotations.Unmodifiable;
-
-import java.util.Collections;
-import java.util.List;
-
-public class SpigotYAMLComments extends ConfigurationComments {
-
-    protected final YamlConfiguration configuration;
-
-    public SpigotYAMLComments(YamlConfiguration configuration) {
-        this.configuration = configuration;
-    }
-
-    @Override
-    public void setHeaderComments(@Nullable String path, @Nullable List<String> comments) {
-        if (path == null) {
-            this.configuration.options().setHeader(comments);
-        } else {
-            this.configuration.setComments(path, comments);
-        }
-    }
-
-    @Override
-    public void setInlineComment(@NotNull String path, @Nullable String comment) {
-        if (comment == null) {
-            this.configuration.setInlineComments(path, null);
-        } else {
-            this.configuration.setComments(path, Collections.singletonList(comment));
-        }
-    }
-
-    @Override
-    public @Nullable @Unmodifiable List<String> getHeaderComment(@Nullable String path) {
-        if (path == null) return Collections.unmodifiableList(this.configuration.options().getHeader());
-        else return this.configuration.getComments(path);
-    }
-
-    @Override
-    public @Nullable String getInlineComment(@NotNull String path) {
-        return String.join(" ", this.configuration.getInlineComments(path));
-    }
-}

pom.xml

@@ -9,20 +9,17 @@
         <maven.compiler.target>${project.jdk.version}</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <maven.compiler.encoding>UTF-8</maven.compiler.encoding>
-
         <deps.easyconfifuration.version>3.3.1</deps.easyconfifuration.version>
     </properties>
 
     <groupId>cc.carm.lib</groupId>
     <artifactId>mineconfiguration-parent</artifactId>
-    <version>2.2.1</version>
+    <version>2.3.0</version>
     <packaging>pom</packaging>
     <modules>
         <module>common</module>
-
         <module>platform/bungee</module>
         <module>platform/bukkit</module>
-        <module>platform/spigot</module>
     </modules>
 
     <name>MineConfiguration</name>