1
mirror of https://github.com/CarmJos/MineConfiguration.git synced 2024-09-16 18:35:49 +00:00
EasyConfiguration for MineCraft! 开始在 MineCraft 相关服务器平台上轻松(做)配置吧!
Go to file
dependabot[bot] 127183ec47 chore(deps): bump org.apache.maven.plugins:maven-gpg-plugin
Bumps [org.apache.maven.plugins:maven-gpg-plugin](https://github.com/apache/maven-gpg-plugin) from 3.2.4 to 3.2.5.
- [Release notes](https://github.com/apache/maven-gpg-plugin/releases)
- [Commits](https://github.com/apache/maven-gpg-plugin/compare/maven-gpg-plugin-3.2.4...maven-gpg-plugin-3.2.5)

---
updated-dependencies:
- dependency-name: org.apache.maven.plugins:maven-gpg-plugin
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-09-14 22:50:06 +08:00
.doc/javadoc feat(deps): 适配上游版本更新。 2022-12-12 22:36:20 +08:00
.github ci(cache): NO MORE GITHUB CACHE SERVICE! 2023-10-10 15:23:41 +08:00
common chore(deps): bump net.md-5:bungeecord-chat from 1.20-R0.1 to 1.20-R0.2 (#64) 2024-01-20 16:09:28 +08:00
platform chore(deps): bump com.github.cryptomorin:XSeries from 11.2.0.1 to 11.2.1 2024-09-14 22:49:59 +08:00
.gitignore 项目初始化 2022-04-21 10:32:45 +08:00
LICENSE [1.0.0] 初始版本完成 2022-04-23 23:20:50 +08:00
pom.xml chore(deps): bump org.apache.maven.plugins:maven-gpg-plugin 2024-09-14 22:50:06 +08:00
README.md refactor(proj): 放弃spigot项目,将Bukkit子项目单独提出。 2022-12-16 16:09:50 +08:00

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

MineConfiguration

version License workflow CodeSize

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 依赖

远程库配置

<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>
通用原生依赖

<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>

Gradle 依赖

远程库配置
repositories {

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

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

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

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]"

}

支持与捐赠

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

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

开源协议

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