mirror of
https://github.com/CarmJos/EasyConfiguration.git
synced 2024-09-19 20:25:51 +00:00
179 lines
5.7 KiB
Markdown
179 lines
5.7 KiB
Markdown
```text
|
||
____ _____ ____ __ _
|
||
/ __/__ ____ __ __ / ___/__ ___ / _(_)__ ___ _________ _/ /_(_)__ ___
|
||
/ _// _ `(_-</ // / / /__/ _ \/ _ \/ _/ / _ `/ // / __/ _ `/ __/ / _ \/ _ \
|
||
/___/\_,_/___/\_, / \___/\___/_//_/_//_/\_, /\_,_/_/ \_,_/\__/_/\___/_//_/
|
||
/___/ /___/
|
||
```
|
||
|
||
# EasyConfiguration
|
||
|
||
[](https://github.com/CarmJos/EasyConfiguration/releases)
|
||
[](https://opensource.org/licenses/MIT)
|
||
[](https://github.com/CarmJos/EasyConfiguration/actions/workflows/maven.yml)
|
||
[](https://www.codefactor.io/repository/github/carmjos/easyconfiguration)
|
||
|
||
|
||
|
||
轻松(做)配置，简单便捷的通用配置文件加载、读取与更新工具，可自定义配置格式。
|
||
|
||
## 优势
|
||
|
||
- 基于类的配置文件初始化、加载、获取与更新机制，方便快捷。
|
||
|
||
## 开发
|
||
|
||
详细开发介绍请 [点击这里](.documentation/README.md) , JavaDoc(最新Release) 请 [点击这里](https://carmjos.github.io/EasyConfiguration) 。
|
||
|
||
### 示例代码
|
||
|
||
您可以 [点击这里](impl/yaml/src/test/java/config/source/TestConfiguration.java) 查看部分代码演示，更多演示详见 [开发介绍](.documentation/README.md) 。
|
||
|
||
### 依赖方式
|
||
|
||
#### Maven 依赖
|
||
|
||
<details>
|
||
<summary>远程库配置</summary>
|
||
|
||
```xml
|
||
|
||
<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/EasyConfiguration</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>
|
||
|
||
```xml
|
||
|
||
<project>
|
||
<dependencies>
|
||
<!--基础实现部分，需要自行实现“Provider”与“Wrapper”。-->
|
||
<dependency>
|
||
<groupId>cc.carm.lib</groupId>
|
||
<artifactId>easyconfiguration-core</artifactId>
|
||
<version>[LATEST RELEASE]</version>
|
||
<scope>compile</scope>
|
||
</dependency>
|
||
|
||
<!--基于YAML文件的实现版本，可用于全部Java环境。-->
|
||
<dependency>
|
||
<groupId>cc.carm.lib</groupId>
|
||
<artifactId>easyconfiguration-yaml</artifactId>
|
||
<version>[LATEST RELEASE]</version>
|
||
<scope>compile</scope>
|
||
</dependency>
|
||
|
||
</dependencies>
|
||
</project>
|
||
```
|
||
|
||
</details>
|
||
|
||
#### Gradle 依赖
|
||
|
||
<details>
|
||
<summary>远程库配置</summary>
|
||
|
||
```groovy
|
||
repositories {
|
||
|
||
// 采用Maven中心库，安全稳定，但版本更新需要等待同步
|
||
mavenCentral()
|
||
|
||
// 采用github依赖库，实时更新，但需要配置 (推荐)
|
||
maven { url 'https://maven.pkg.github.com/CarmJos/EasyConfiguration' }
|
||
|
||
// 采用我的私人依赖库，简单方便，但可能因为变故而无法使用
|
||
maven { url 'https://repo.carm.cc/repository/maven-public/' }
|
||
}
|
||
```
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>通用原生依赖</summary>
|
||
|
||
```groovy
|
||
|
||
dependencies {
|
||
|
||
//基础实现部分，需要自行实现“Provider”与“Wrapper”。
|
||
api "cc.carm.lib:easyconfiguration-core:[LATEST RELEASE]"
|
||
|
||
//基于YAML文件的实现版本，可用于全部Java环境。
|
||
api "cc.carm.lib:easyconfiguration-yaml:[LATEST RELEASE]"
|
||
|
||
}
|
||
```
|
||
|
||
</details>
|
||
|
||
### 衍生项目
|
||
|
||
#### [**MineConfiguration**](https://github.com/CarmJos/MineConfiguration) (by @CarmJos)
|
||
|
||
EasyConfiguration for MineCraft!
|
||
开始在 MineCraft 相关服务器平台上轻松(做)配置吧！
|
||
|
||
目前支持 BungeeCord, Bukkit(Spigot) 服务端，后续将支持更多平台。
|
||
|
||
|
||
## 支持与捐赠
|
||
|
||
若您觉得本插件做的不错，您可以通过捐赠支持我！
|
||
|
||
感谢您对开源项目的支持！
|
||
|
||
<img height=25% width=25% src="https://raw.githubusercontent.com/CarmJos/CarmJos/main/img/donate-code.jpg" alt=""/>
|
||
|
||
## 开源协议
|
||
|
||
本项目源码采用 [The MIT License](https://opensource.org/licenses/MIT) 开源协议。
|
||
|
||
<details>
|
||
<summary>关于 MIT 协议</summary>
|
||
|
||
> MIT 协议可能是几大开源协议中最宽松的一个，核心条款是：
|
||
>
|
||
> 该软件及其相关文档对所有人免费，可以任意处置，包括使用，复制，修改，合并，发表，分发，再授权，或者销售。唯一的限制是，软件中必须包含上述版 权和许可提示。
|
||
>
|
||
> 这意味着：
|
||
>
|
||
> - 你可以自由使用，复制，修改，可以用于自己的项目。
|
||
> - 可以免费分发或用来盈利。
|
||
> - 唯一的限制是必须包含许可声明。
|
||
>
|
||
> MIT 协议是所有开源许可中最宽松的一个，除了必须包含许可声明外，再无任何限制。
|
||
>
|
||
> *以上文字来自 [五种开源协议GPL,LGPL,BSD,MIT,Apache](https://www.oschina.net/question/54100_9455) 。*
|
||
|
||
</details>
|