Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carmjos/easyplugin
轻松(做)插件，旨在于方便快捷的使用Bukkit实现MC中的一些功能。
https://github.com/carmjos/easyplugin
bukkit bukkit-library efficiency java java-library library spigot spigot-library
Last synced: 2 months ago
JSON representation
轻松(做)插件，旨在于方便快捷的使用Bukkit实现MC中的一些功能。
- Host: GitHub
- URL: https://github.com/carmjos/easyplugin
- Owner: CarmJos
- License: mit
- Created: 2022-01-04T12:07:20.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-02-07T18:18:34.000Z (11 months ago)
- Last Synced: 2024-09-28T12:03:39.767Z (3 months ago)
- Topics: bukkit, bukkit-library, efficiency, java, java-library, library, spigot, spigot-library
- Language: Java
- Homepage: https://carmjos.github.io/EasyPlugin/
- Size: 1.14 MB
- Stars: 23
- Watchers: 5
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
```text
______ ____ __ _
/ ____/___ ________ __ / __ \/ /_ ______ _(_)___
/ __/ / __ `/ ___/ / / / / /_/ / / / / / __ `/ / __ \
/ /___/ /_/ (__ ) /_/ / / ____/ / /_/ / /_/ / / / / /
/_____/\__,_/____/\__, / /_/ /_/\__,_/\__, /_/_/ /_/
/____/ /____/
```
# EasyPlugin
[](https://github.com/CarmJos/EasyPlugin/releases)
[](https://opensource.org/licenses/MIT)
[](https://github.com/CarmJos/EasyPlugin/actions/workflows/maven.yml)
[](https://www.codefactor.io/repository/github/carmjos/EasyPlugin)
轻松(做)插件，旨在于方便快捷的使用Bukkit实现MC中的一些功能。
## 优势
- 轻便独立的功能模块，按需使用，避免大量打包！
- 详细的Javadoc与使用文档，轻松上手，方便使用！
- 持续的更新与优化，需求不止，更新不止！
- 如需新功能支持，请通过 [Issues](https://github.com/CarmJos/EasyPlugin/issues) 提交功能需求。
## 内容
项目初创不久，加 * 的仍在开发更新中...欢迎各路大佬帮助提供本项目的开发文档~
### 集合部分 (`/collection`)
- All [`easyplugin-all`](collection/all)
- Common [`easyplugin-common`](collection/common)
### 主要部分 (`/base`)
- Color [`easyplugin-color`](base/color)
- 颜色工具类模块，提供功能全面的MC颜色解析转换工具。
- 支持 `&+颜色代码`(原版颜色)、`§(#XXXXXX)`(RGB颜色) 与 `&<#XXXXXX>`(前后标注RGB颜色渐变)。
- Utils [`easyplugin-utils`](base/utils)
- 通用工具类模块，该模块中的内容支持在Bungee、Bukkit使用。
- 本模块提供
- `ColorParser` 支持RGB颜色与RGB渐变色的颜色解析器。
- `EasyCooldown` 快速创造一个冷却时间的管理器。
- `JarResourceUtils` 快速读取Jar包内容的工具类。
- Main [`easyplugin-main`](base/main)
- 主要接口模块，提供了方便的插件入口类与相关工具类。
- Command [`easyplugin-command`](base/command)
- 指令接口模块，便于快速进行子指令的实现，并提供单独的TabComplete方法。
- 随本项目提供了 `SimpleCompleter` 类，用于快速创建补全的内容列表。
- GUI [`easyplugin-gui`](base/main)
- 简单便捷的箱子GUI接口，可以快速实现GUI中不同图标的点击功能。
- 随本项目提供了 `AutoPagedGUI` 等翻页GUI抽象类。
- Storage [`easyplugin-storage`](base/storage)
- 抽象存储管理器，便于实现不同的存储类型。
- 随本项目提供了 `FileBasedStorage`、`FolderBasedStorage` 等常用存储抽象方法。
- Messages [`easyplugin-message`](base/messages)
- 随本项目提供了基于 MineConfiguration 实现的 `EasyMessages` 类。
- 支持多种消息配置，包括文本消息、ActionBar消息、Title消息、声音、粒子效果播放等。
- 支持消息间的延迟发送。
### 独立项目部分
> 以下项目均已独立出单独项目,如需使用，**强烈建议自行引用对应的项目**，以支持完整的Javadoc并获取源码内容！
- _Listener_ -> [**EasyListener**](https://github.com/CarmJos/EasyListener)
- _Configuration_ -> [**MineConfiguration**](https://github.com/CarmJos/MineConfiguration)
- _Database_ -> [**EasySQL**](https://github.com/CarmJos/EasySQL)
### 附属部分 (`/extension`)
- [PlaceholderAPI](https://www.spigotmc.org/resources/6245/) [`easyplugin-placeholderapi`](extension/papi)
- PlaceholderAPI 扩展模块，提供了方便的 PlaceholderAPI 变量注册方法。
- [Vault](https://github.com/MilkBowl/VaultAPI)* [`easyplugin-vault`](extension/vault)
## 开发
详细开发介绍请 [点击这里](.documentation/README.md) , JavaDoc(最新Release)
请 [点击这里](https://carmjos.github.io/EasyPlugin) 。
### 示例代码
您可以 [点击这里](https://github.com/CarmJos/UltraDepository)
查看实例项目演示，更多演示详见 [开发介绍](.documentation/README.md) 。
### 依赖方式
展开查看 Maven 依赖方式
```xml
EasyPlugin
GitHub Packages
https://raw.githubusercontent.com/CarmJos/EasyPlugin/repo/
carm-repo
Carm's Repo
https://repo.carm.cc/repository/maven-public/
cc.carm.lib
easyplugin-all
[LATEST RELEASE]
compile
cc.carm.lib
easyplugin-common
[LATEST RELEASE]
compile
cc.carm.lib
easyplugin-main
[LATEST RELEASE]
compile
```
展开查看 Gradle 依赖方式
```groovy
repositories {
// 采用github依赖库，安全稳定，但需要配置 (推荐)
maven { url 'https://raw.githubusercontent.com/CarmJos/EasyPlugin/repo/' }
// 采用我的私人依赖库，简单方便，但可能因为变故而无法使用
maven { url 'https://repo.carm.cc/repository/maven-public/' }
}
dependencies {
//大全集版本，包含项目内所有模块
api "cc.carm.lib:easyplugin-all:[LATEST RELEASE]"
//常用接口集，包含除附属插件模块外的所有模块
api "cc.carm.lib:easyplugin-common:[LATEST RELEASE]"
//插件主要接口模块，包含方便的插件入口类与相关工具类
api "cc.carm.lib:easyplugin-main:[LATEST RELEASE]"
// 其他模块自行选择，详见 “内容”
}
```
## 支持与捐赠
若您觉得本插件做的不错，您可以通过捐赠支持我！
感谢您对开源项目的支持！
## 开源协议
本项目源码采用 [The MIT License](https://opensource.org/licenses/MIT) 开源协议。
关于 MIT 协议
> MIT 协议可能是几大开源协议中最宽松的一个，核心条款是：
>
> 该软件及其相关文档对所有人免费，可以任意处置，包括使用，复制，修改，合并，发表，分发，再授权，或者销售。唯一的限制是，软件中必须包含上述版
> 权和许可提示。
>
> 这意味着：
> - 你可以自由使用，复制，修改，可以用于自己的项目。
> - 可以免费分发或用来盈利。
> - 唯一的限制是必须包含许可声明。
>
> MIT 协议是所有开源许可中最宽松的一个，除了必须包含许可声明外，再无任何限制。
>
> *以上文字来自 [五种开源协议GPL,LGPL,BSD,MIT,Apache](https://www.oschina.net/question/54100_9455) 。*