Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carmjos/mineconfiguration
EasyConfiguration for MineCraft! 开始在 MineCraft 相关服务器平台上轻松(做)配置吧！
https://github.com/carmjos/mineconfiguration
bukkit-plugin bungee-plugin configuration easy-to-use easyconfiguration fastdev spigot-plugin yaml
Last synced: about 2 months ago
JSON representation
EasyConfiguration for MineCraft! 开始在 MineCraft 相关服务器平台上轻松(做)配置吧！
- Host: GitHub
- URL: https://github.com/carmjos/mineconfiguration
- Owner: CarmJos
- License: lgpl-3.0
- Created: 2022-04-21T02:17:11.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-17T15:50:40.000Z (4 months ago)
- Last Synced: 2024-09-17T19:54:10.600Z (4 months ago)
- Topics: bukkit-plugin, bungee-plugin, configuration, easy-to-use, easyconfiguration, fastdev, spigot-plugin, yaml
- Language: Java
- Homepage: https://CarmJos.github.io/MineConfiguration/
- Size: 498 KB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
```text
__ ____ _____ ____ __ _
/ |/ (_)__ ___ / ___/__ ___ / _(_)__ ___ _________ _/ /_(_)__ ___
/ /|_/ / / _ \/ -_) /__/ _ \/ _ \/ _/ / _ `/ // / __/ _ `/ __/ / _ \/ _ \
/_/ /_/_/_//_/\__/\___/\___/_//_/_//_/\_, /\_,_/_/ \_,_/\__/_/\___/_//_/
/___/
```
# MineConfiguration
[](https://github.com/CarmJos/MineConfiguration/releases)
[](https://opensource.org/licenses/MIT)
[](https://github.com/CarmJos/MineConfiguration/actions/workflows/maven.yml)
EasyConfiguration for MineCraft!
开始在 MineCraft 相关服务器平台上**轻松(做)配置**吧！
## 项目结构
### **MineConfiguration-Common** [`common`](common)
全部版本的共用部分(均已被打包至下行包中)，包括
- `ConfigMessage` (实现类为 `ConfiguredMessage`)
- `ConfigMessageList` (实现类为 `ConfiguredMessageList`)
如要使用，请访问对应实现类的builder() 方法来快速创建。
### **MineConfiguration-Bukkit** [`platform/bukkit`](platform/bukkit)
适用于Bukkit的版本，同时支持其他以Bukkit为基础的服务端 *(如Spigot、Paper、CatServer)* 。
相较于基础版本，额外提供了以下功能：
- `ConfiguredSerializable`
- `ConfiguredItem` (快捷读\写\使用简单的物品配置文件)
- `ConfiguredSound` (快捷读\写\使用音效配置文件)
- `ConfiguredTitle` (快速读\写\使用标题文字配置文件)
以上类型可以通过 `CraftConfigValue.builder()` 来创建，部分类型提供了 `of(...);` 方法来快速创建。
### **MineConfiguration-Bungee** [`platform/bungee`](platform/bungee)
适用于BungeeCord的版本，可用JSON与YAML格式。其中JSON格式**不支持配置文件注释**。
## 开发
其他功能请详见 [EasyConfiguration](https://github.com/CarmJos/EasyConfiguration)
的 [开发介绍](https://github.com/CarmJos/EasyConfiguration/tree/master/.documentation) 。
### 依赖方式
#### Maven 依赖
远程库配置
```xml
maven
Maven Central
https://repo1.maven.org/maven2
EasyConfiguration
GitHub Packages
https://maven.pkg.github.com/CarmJos/MineConfiguration
carm-repo
Carm's Repo
https://repo.carm.cc/repository/maven-public/
```
通用原生依赖
```xml
cc.carm.lib
mineconfiguration-bukkit
[LATEST RELEASE]
compile
cc.carm.lib
mineconfiguration-spigot
[LATEST RELEASE]
compile
cc.carm.lib
mineconfiguration-bungee
[LATEST RELEASE]
compile
```
#### Gradle 依赖
远程库配置
```groovy
repositories {
// 采用Maven中心库，安全稳定，但版本更新需要等待同步
mavenCentral()
// 采用github依赖库，实时更新，但需要配置 (推荐)
maven { url 'https://maven.pkg.github.com/CarmJos/MineConfiguration' }
// 采用我的私人依赖库，简单方便，但可能因为变故而无法使用
maven { url 'https://repo.carm.cc/repository/maven-public/' }
}
```
通用原生依赖
```groovy
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](https://www.gnu.org/licenses/lgpl-3.0.html) 开源协议。