mirror of
https://github.com/CarmJos/EasyPlugin.git
synced 2024-09-19 19:25:45 +00:00
132 lines
4.8 KiB
Markdown
132 lines
4.8 KiB
Markdown
|
```text
|
|||
|
______ ____ __ _
|
|||
|
/ ____/___ ________ __ / __ \/ /_ ______ _(_)___
|
|||
|
/ __/ / __ `/ ___/ / / / / /_/ / / / / / __ `/ / __ \
|
|||
|
/ /___/ /_/ (__ ) /_/ / / ____/ / /_/ / /_/ / / / / /
|
|||
|
/_____/\__,_/____/\__, / /_/ /_/\__,_/\__, /_/_/ /_/
|
|||
|
/____/ /____/
|
|||
|
```
|
|||
|
|
|||
|
# EasyPlugin
|
|||
|
|
|||
|
[![version](https://img.shields.io/github/v/release/CarmJos/EasyPlugin)](https://github.com/CarmJos/EasyPlugin/releases)
|
|||
|
[![License](https://img.shields.io/github/license/CarmJos/EasyPlugin)](https://opensource.org/licenses/GPL-3.0)
|
|||
|
[![workflow](https://github.com/CarmJos/EasyPlugin/actions/workflows/maven.yml/badge.svg?branch=master)](https://github.com/CarmJos/EasyPlugin/actions/workflows/maven.yml)
|
|||
|
[![CodeFactor](https://www.codefactor.io/repository/github/carmjos/EasyPlugin/badge)](https://www.codefactor.io/repository/github/carmjos/EasyPlugin)
|
|||
|
![CodeSize](https://img.shields.io/github/languages/code-size/CarmJos/EasyPlugin)
|
|||
|
![](https://visitor-badge.glitch.me/badge?page_id=EasyPlugin.readme)
|
|||
|
|
|||
|
轻松(做)插件,旨在于方便快捷的使用Bukkit实现MC中的一些功能。
|
|||
|
|
|||
|
## 优势
|
|||
|
|
|||
|
- 轻便独立的功能模块,按需使用,避免大量打包!
|
|||
|
- 详细的Javadoc与使用文档,轻松上手,方便使用!
|
|||
|
- 持续的更新与优化,需求不止,更新不止!
|
|||
|
- 如需新功能支持,请 [点击这里](https://github.com/CarmJos/EasyPlugin/issues/new?assignees=&labels=enhancement&template=feature_issues.md&title=) 提交功能需求。
|
|||
|
|
|||
|
## 内容
|
|||
|
|
|||
|
### 集合部分
|
|||
|
- All [`easyplugin-all`](easyplugin-all)
|
|||
|
- Common [`easyplugin-common`](easyplugin-common)
|
|||
|
|
|||
|
### 主要部分
|
|||
|
|
|||
|
- Main [`easyplugin-main`](easyplugin-main)
|
|||
|
- Command [`easyplugin-command`](easyplugin-command)
|
|||
|
- Configuration [`easyplugin-configuration`](easyplugin-configuration)
|
|||
|
- Database [`easyplugin-database`](easyplugin-database)
|
|||
|
- GUI [`easyplugin-gui`](easyplugin-gui)
|
|||
|
|
|||
|
### 附属部分
|
|||
|
- [PlaceholderAPI](https://www.spigotmc.org/resources/6245/) [`easyplugin-placeholderapi`](easyplugin-placeholderapi)
|
|||
|
- [Vault](https://github.com/MilkBowl/VaultAPI) [`easyplugin-vault`](easyplugin-vault)
|
|||
|
- [LuckPerms](https://www.spigotmc.org/resources/luckperms.28140/) [`easyplugin-lp`](easyplugin-lp)
|
|||
|
|
|||
|
## 开发
|
|||
|
|
|||
|
详细开发介绍请 [点击这里](.documentation/README.md) , JavaDoc(最新Release) 请 [点击这里](https://carmjos.github.io/EasyPlugin) 。
|
|||
|
|
|||
|
### 示例代码
|
|||
|
|
|||
|
您可以 [点击这里](https://github.com/CarmJos/UltraDepository) 查看实例项目演示,更多演示详见 [开发介绍](.documentation/README.md) 。
|
|||
|
|
|||
|
### 依赖方式
|
|||
|
|
|||
|
#### Maven 依赖
|
|||
|
|
|||
|
<details>
|
|||
|
<summary>远程库配置</summary>
|
|||
|
|
|||
|
```xml
|
|||
|
|
|||
|
<project>
|
|||
|
<repositories>
|
|||
|
<repository>
|
|||
|
<id>EasyPlugin</id>
|
|||
|
<name>GitHub Packages</name>
|
|||
|
<url>https://maven.pkg.github.com/CarmJos/EasyPlugin</url>
|
|||
|
</repository>
|
|||
|
</repositories>
|
|||
|
</project>
|
|||
|
```
|
|||
|
|
|||
|
</details>
|
|||
|
|
|||
|
<details>
|
|||
|
<summary>原生依赖</summary>
|
|||
|
|
|||
|
```xml
|
|||
|
|
|||
|
<project>
|
|||
|
<dependencies>
|
|||
|
<!--大全集版本,包含项目内所有模块-->
|
|||
|
<dependency>
|
|||
|
<groupId>cc.carm.lib</groupId>
|
|||
|
<artifactId>easyplugin-all</artifactId>
|
|||
|
<version>[LATEST RELEASE]</version>
|
|||
|
<scope>compile</scope>
|
|||
|
</dependency>
|
|||
|
|
|||
|
<!--轻松插件主要接口集,包含方便的插件入口类与相关工具类。-->
|
|||
|
<dependency>
|
|||
|
<groupId>cc.carm.lib</groupId>
|
|||
|
<artifactId>easyplugin-main</artifactId>
|
|||
|
<version>[LATEST RELEASE]</version>
|
|||
|
<scope>compile</scope>
|
|||
|
</dependency>
|
|||
|
|
|||
|
</dependencies>
|
|||
|
</project>
|
|||
|
```
|
|||
|
|
|||
|
</details>
|
|||
|
|
|||
|
## 支持与捐赠
|
|||
|
|
|||
|
若您觉得本插件做的不错,您可以通过捐赠支持我!
|
|||
|
|
|||
|
感谢您对开源项目的支持!
|
|||
|
|
|||
|
<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>
|