__  ____          _____          ____                    __  _
  /  |/  (_)__  ___ / ___/__  ___  / _(_)__ ___ _________ _/ /_(_)__  ___
 / /|_/ / / _ \/ -_) /__/ _ \/ _ \/ _/ / _ `/ // / __/ _ `/ __/ / _ \/ _ \
/_/  /_/_/_//_/\__/\___/\___/_//_/_//_/\_, /\_,_/_/  \_,_/\__/_/\___/_//_/
                                      /___/

MineConfiguration

EasyConfiguration for MineCraft!

开始在 MineCraft 相关服务器平台上轻松(做)配置吧！

项目结构

MineConfiguration-Common common

全部版本的共用部分(均已被打包至下行包中)，包括

• ConfigMessage (实现类为 ConfiguredMessage<M>)
• ConfigMessageList (实现类为 ConfiguredMessageList<M>)

如要使用，请访问对应实现类的builder() 方法来快速创建。

MineConfiguration-Bukkit platform/bukkit

适用于Bukkit的版本，同时支持其他以Bukkit为基础的服务端 (如Spigot、Paper、CatServer) 。

相较于基础版本，额外提供了以下功能：

• ConfiguredSerializable<T extends ConfigurationSerializable>
• ConfiguredItem (快捷读\写\使用简单的物品配置文件)
• ConfiguredSound (快捷读\写\使用音效配置文件)
• ConfiguredTitle (快速读\写\使用标题文字配置文件)

以上类型可以通过 CraftConfigValue.builder() 来创建，部分类型提供了 of(...); 方法来快速创建。

MineConfiguration-Bungee platform/bungee

适用于BungeeCord的版本，可用JSON与YAML格式。其中JSON格式不支持配置文件注释。

开发

其他功能请详见 EasyConfiguration 的 开发介绍 。

依赖方式

Maven 依赖

<details> <summary>远程库配置</summary>

<project>
    <repositories>

        <repository>
            <!--采用Maven中心库，安全稳定，但版本更新需要等待同步-->
            <id>maven</id>
            <name>Maven Central</name>
            <url>https://repo1.maven.org/maven2</url>
        </repository>

        <repository>
            <!--采用github依赖库，实时更新，但需要配置 (推荐) -->
            <id>EasyConfiguration</id>
            <name>GitHub Packages</name>
            <url>https://maven.pkg.github.com/CarmJos/MineConfiguration</url>
        </repository>

        <repository>
            <!--采用我的私人依赖库，简单方便，但可能因为变故而无法使用-->
            <id>carm-repo</id>
            <name>Carm's Repo</name>
            <url>https://repo.carm.cc/repository/maven-public/</url>
        </repository>

    </repositories>
</project>

</details> <details> <summary>通用原生依赖</summary>

<project>
    <dependencies>

        <dependency>
            <groupId>cc.carm.lib</groupId>
            <artifactId>mineconfiguration-bukkit</artifactId>
            <version>[LATEST RELEASE]</version>
            <scope>compile</scope>
        </dependency>

        <dependency>
            <groupId>cc.carm.lib</groupId>
            <artifactId>mineconfiguration-spigot</artifactId>
            <version>[LATEST RELEASE]</version>
            <scope>compile</scope>
        </dependency>

        <dependency>
            <groupId>cc.carm.lib</groupId>
            <artifactId>mineconfiguration-bungee</artifactId>
            <version>[LATEST RELEASE]</version>
            <scope>compile</scope>
        </dependency>

    </dependencies>
</project>

</details>

Gradle 依赖

<details> <summary>远程库配置</summary>

repositories {

    // 采用Maven中心库，安全稳定，但版本更新需要等待同步
    mavenCentral()

    // 采用github依赖库，实时更新，但需要配置 (推荐)
    maven { url 'https://maven.pkg.github.com/CarmJos/MineConfiguration' }

    // 采用我的私人依赖库，简单方便，但可能因为变故而无法使用
    maven { url 'https://repo.carm.cc/repository/maven-public/' }
}

</details> <details> <summary>通用原生依赖</summary>

dependencies {

    api "cc.carm.lib:mineconfiguration-bukkit:[LATEST RELEASE]"

    api "cc.carm.lib:mineconfiguration-spigot:[LATEST RELEASE]"

    api "cc.carm.lib:mineconfiguration-bungee:[LATEST RELEASE]"

}

</details>

支持与捐赠

若您觉得本插件做的不错，您可以通过捐赠支持我！

感谢您对开源项目的支持！

<img height=25% width=25% src="https://raw.githubusercontent.com/CarmJos/CarmJos/main/img/donate-code.jpg" alt=""/>

开源协议

本项目源码采用 GNU LESSER GENERAL PUBLIC LICENSE 开源协议。