docs: 优化 README 结构和格式
This commit is contained in:
200
README.md
200
README.md
@@ -1,25 +1,31 @@
|
|||||||
# EssentialsC
|
# EssentialsC
|
||||||
|
|
||||||
一个轻量级的 Paper 服务器核心插件,灵感来自 CMI,但更加精简、易用且现代化。
|
> 一个轻量级的 Paper 服务器插件,灵感来自 CMI,但更加精简、易用且现代化。
|
||||||
|
|
||||||
## ✨ 功能特性
|
[](https://github.com/Coldsmiles/EssentialsC/releases)
|
||||||
|
[](LICENSE)
|
||||||
|
[](https://papermc.io/)
|
||||||
|
[](https://www.oracle.com/java/)
|
||||||
|
|
||||||
|
## ✨ 核心特性
|
||||||
|
|
||||||
### 🎯 随身功能方块
|
### 🎯 随身功能方块
|
||||||
随时随地打开各种功能性方块,无需放置实体方块:
|
随时随地打开各种功能性方块,无需放置实体方块:
|
||||||
- 工作台 (`/workbench`, `/wb`)
|
- **工作台** (`/workbench`, `/wb`)
|
||||||
- 铁砧 (`/anvil`)
|
- **铁砧** (`/anvil`)
|
||||||
- 制图台 (`/cartographytable`, `/ct`)
|
- **制图台** (`/cartographytable`, `/ct`)
|
||||||
- 砂轮 (`/grindstone`, `/gs`)
|
- **砂轮** (`/grindstone`, `/gs`)
|
||||||
- 织布机 (`/loom`)
|
- **织布机** (`/loom`)
|
||||||
- 锻造台 (`/smithingtable`, `/st`)
|
- **锻造台** (`/smithingtable`, `/st`)
|
||||||
- 切石机 (`/stonecutter`, `/sc`)
|
- **切石机** (`/stonecutter`, `/sc`)
|
||||||
|
|
||||||
### 📦 容器管理
|
### 📦 智能容器管理
|
||||||
- **末影箱** (`/enderchest`, `/ec`) - 随时访问末影箱(参考 EssentialsX 实现)
|
- **末影箱** (`/enderchest`, `/ec`) - 参考 EssentialsX 实现,100% 数据安全
|
||||||
- **潜影盒快捷打开** - 潜行+右键点击潜影盒直接打开内容(类似 CMI)
|
- **潜影盒快捷打开** - 潜行+右键直接打开(类似 CMI)
|
||||||
- 支持自定义标题
|
- ✅ 支持自定义标题(可配置)
|
||||||
- 防刷物品机制
|
- ✅ 防刷物品机制(快照验证 + 数量检查)
|
||||||
- 防止套娃(不能在潜影盒中放入另一个潜影盒)
|
- ✅ 防止套娃(不能放入另一个潜影盒)
|
||||||
|
- ✅ 异常恢复(物品丢失自动掉落)
|
||||||
|
|
||||||
### 🔧 实用工具
|
### 🔧 实用工具
|
||||||
- **帽子** (`/hat`) - 将手中物品戴在头上
|
- **帽子** (`/hat`) - 将手中物品戴在头上
|
||||||
@@ -37,89 +43,83 @@
|
|||||||
- **功能方块菜单** (`/essc blocks`) - GUI 方块集合面板
|
- **功能方块菜单** (`/essc blocks`) - GUI 方块集合面板
|
||||||
- **配置重载** (`/essc reload`) - 重新加载配置文件
|
- **配置重载** (`/essc reload`) - 重新加载配置文件
|
||||||
|
|
||||||
### 🌍 多语言支持
|
---
|
||||||
- 完整的中文和英文配置
|
|
||||||
- 方块标题自动跟随客户端语言
|
|
||||||
- 可自定义所有消息文本
|
|
||||||
|
|
||||||
### ⚡ 权限控制
|
## 🌍 多语言支持
|
||||||
- 精细的权限管理系统
|
|
||||||
- 帮助菜单智能显示(只显示有权限的命令)
|
|
||||||
- 默认仅 OP 可用,可通过权限插件授权
|
|
||||||
- CMI 风格的命令别名支持
|
|
||||||
|
|
||||||
## 📦 安装
|
- ✅ 完整的中文和英文配置
|
||||||
|
- ✅ 方块标题自动跟随客户端语言
|
||||||
|
- ✅ 可自定义所有消息文本
|
||||||
|
|
||||||
### 要求
|
## ⚡ 权限系统
|
||||||
- Paper 1.21+ 服务器
|
|
||||||
- Java 21+
|
|
||||||
|
|
||||||
### 步骤
|
- ✅ 精细的权限管理
|
||||||
|
- ✅ 帮助菜单智能显示(只显示有权限的命令)
|
||||||
|
- ✅ 默认仅 OP 可用,可通过权限插件授权
|
||||||
|
- ✅ CMI 风格的命令别名支持
|
||||||
|
|
||||||
|
## 📦 快速开始
|
||||||
|
|
||||||
|
### 系统要求
|
||||||
|
- **服务器**: Paper 1.21+
|
||||||
|
- **Java**: 21+
|
||||||
|
|
||||||
|
### 安装步骤
|
||||||
1. 下载最新版本的 [`essentialsc-*.jar`](https://github.com/Coldsmiles/EssentialsC/releases)
|
1. 下载最新版本的 [`essentialsc-*.jar`](https://github.com/Coldsmiles/EssentialsC/releases)
|
||||||
2. 将文件放入服务器的 `plugins` 文件夹
|
2. 将文件放入服务器的 `plugins` 文件夹
|
||||||
3. 重启服务器
|
3. 重启服务器
|
||||||
4. 编辑 `plugins/EssentialsC/config.yml` 配置语言
|
4. 编辑 `plugins/EssentialsC/config.yml` 配置语言
|
||||||
5. (可选)使用权限插件为玩家授予相应权限
|
5. (可选)使用权限插件为玩家授予相应权限
|
||||||
|
|
||||||
## 🎮 命令
|
## 🎮 命令列表
|
||||||
|
|
||||||
### 基础命令
|
### 基础命令
|
||||||
```
|
| 命令 | 说明 |
|
||||||
/essc help # 显示帮助菜单(根据权限动态显示)
|
|------|------|
|
||||||
/essc reload # 重载配置(管理员)
|
| `/essc help` | 显示帮助菜单(根据权限动态显示) |
|
||||||
/essc blocks # 打开功能方块菜单
|
| `/essc reload` | 重载配置(管理员) |
|
||||||
```
|
| `/essc blocks` | 打开功能方块菜单 |
|
||||||
|
|
||||||
### 功能方块命令
|
### 功能方块命令
|
||||||
```
|
| 命令 | 别名 | 说明 |
|
||||||
/workbench, /wb # 打开工作台
|
|------|------|------|
|
||||||
/anvil # 打开铁砧
|
| `/workbench` | `/wb` | 打开工作台 |
|
||||||
/cartographytable, /ct # 打开制图台
|
| `/anvil` | - | 打开铁砧 |
|
||||||
/grindstone, /gs # 打开砂轮
|
| `/cartographytable` | `/ct` | 打开制图台 |
|
||||||
/loom # 打开织布机
|
| `/grindstone` | `/gs` | 打开砂轮 |
|
||||||
/smithingtable, /st # 打开锻造台
|
| `/loom` | - | 打开织布机 |
|
||||||
/stonecutter, /sc # 打开切石机
|
| `/smithingtable` | `/st` | 打开锻造台 |
|
||||||
/enderchest, /ec # 打开末影箱
|
| `/stonecutter` | `/sc` | 打开切石机 |
|
||||||
```
|
| `/enderchest` | `/ec` | 打开末影箱 |
|
||||||
|
|
||||||
### 其他命令
|
### 其他命令
|
||||||
```
|
| 命令 | 别名 | 说明 |
|
||||||
/hat # 将手中物品戴在头上
|
|------|------|------|
|
||||||
/suicide, /die # 自杀
|
| `/hat` | - | 将手中物品戴在头上 |
|
||||||
/fly # 切换飞行模式
|
| `/suicide` | `/die` | 自杀 |
|
||||||
/heal # 恢复生命值和饱食度
|
| `/fly` | - | 切换飞行模式 |
|
||||||
/vanish, /v # 切换隐身模式(管理员)
|
| `/heal` | - | 恢复生命值和饱食度 |
|
||||||
/seen, /info <玩家> # 查看玩家信息(管理员)
|
| `/vanish` | `/v` | 切换隐身模式(管理员) |
|
||||||
/feed # 补满饱食度
|
| `/seen` | `/info` | 查看玩家信息(管理员) |
|
||||||
/repair, /rep # 修复手中或所有物品
|
| `/feed` | - | 补满饱食度 |
|
||||||
/repair all # 修复所有物品
|
| `/repair` | `/rep` | 修复手中或所有物品 |
|
||||||
```
|
|
||||||
|
|
||||||
### 命令别名
|
> 💡 **提示**: 使用 `/repair all` 可以修复背包中的所有物品
|
||||||
- `/essentialsc` = `/essc`
|
|
||||||
- `/workbench` = `/wb`
|
|
||||||
- `/cartographytable` = `/ct`
|
|
||||||
- `/grindstone` = `/gs`
|
|
||||||
- `/smithingtable` = `/st`
|
|
||||||
- `/stonecutter` = `/sc`
|
|
||||||
- `/enderchest` = `/ec`
|
|
||||||
- `/suicide` = `/die`
|
|
||||||
- `/vanish` = `/v`
|
|
||||||
- `/seen` = `/info`
|
|
||||||
- `/repair` = `/rep`
|
|
||||||
|
|
||||||
## ⚙️ 配置
|
## ⚙️ 配置说明
|
||||||
|
|
||||||
### config.yml
|
### config.yml
|
||||||
```yaml
|
```yaml
|
||||||
# 语言设置
|
# 语言设置 (en_US, zh_CN)
|
||||||
# 可用语言: en_US, zh_CN
|
|
||||||
language: "zh_CN"
|
language: "zh_CN"
|
||||||
|
|
||||||
# 通用设置
|
# 通用设置
|
||||||
settings:
|
settings:
|
||||||
# 启用或禁用命令反馈消息
|
enable-feedback: true # 启用命令反馈消息
|
||||||
enable-feedback: true
|
|
||||||
|
# 潜影盒设置
|
||||||
|
shulkerbox:
|
||||||
|
default-title: "&e潜影盒" # 默认标题(支持颜色代码)
|
||||||
```
|
```
|
||||||
|
|
||||||
### 自定义语言
|
### 自定义语言
|
||||||
@@ -129,6 +129,7 @@ settings:
|
|||||||
|
|
||||||
所有命令默认需要 OP 权限。使用权限插件(如 LuckPerms)授予权限:
|
所有命令默认需要 OP 权限。使用权限插件(如 LuckPerms)授予权限:
|
||||||
|
|
||||||
|
### 基础权限
|
||||||
```
|
```
|
||||||
essentialsc.command.workbench # 工作台
|
essentialsc.command.workbench # 工作台
|
||||||
essentialsc.command.anvil # 铁砧
|
essentialsc.command.anvil # 铁砧
|
||||||
@@ -146,14 +147,22 @@ essentialsc.command.vanish # 隐身
|
|||||||
essentialsc.command.seen # 玩家查询
|
essentialsc.command.seen # 玩家查询
|
||||||
essentialsc.command.feed # 饱食度
|
essentialsc.command.feed # 饱食度
|
||||||
essentialsc.command.repair # 修复
|
essentialsc.command.repair # 修复
|
||||||
|
essentialsc.shulkerbox.open # 潜行+右键潜影盒
|
||||||
|
```
|
||||||
|
|
||||||
|
### 管理权限
|
||||||
|
```
|
||||||
essentialsc.command.blocks # 功能方块菜单
|
essentialsc.command.blocks # 功能方块菜单
|
||||||
essentialsc.command.reload # 重载配置
|
essentialsc.command.reload # 重载配置
|
||||||
essentialsc.command.help # 帮助(默认开放)
|
essentialsc.command.help # 帮助(默认开放)
|
||||||
essentialsc.shulkerbox.open # 潜行+右键潜影盒直接打开
|
```
|
||||||
|
|
||||||
|
### 通配符
|
||||||
|
```
|
||||||
essentialsc.* # 所有权限
|
essentialsc.* # 所有权限
|
||||||
```
|
```
|
||||||
|
|
||||||
### 示例:使用 LuckPerms 授权
|
### 💡 LuckPerms 授权示例
|
||||||
```bash
|
```bash
|
||||||
# 给单个玩家授权
|
# 给单个玩家授权
|
||||||
/lp user <玩家名> permission set essentialsc.command.workbench true
|
/lp user <玩家名> permission set essentialsc.command.workbench true
|
||||||
@@ -165,9 +174,7 @@ essentialsc.* # 所有权限
|
|||||||
/lp group admin permission set essentialsc.* true
|
/lp group admin permission set essentialsc.* true
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🔨 构建
|
## 🔨 从源码构建
|
||||||
|
|
||||||
从源代码构建插件:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/Coldsmiles/EssentialsC.git
|
git clone https://github.com/Coldsmiles/EssentialsC.git
|
||||||
@@ -177,40 +184,33 @@ mvn clean package
|
|||||||
|
|
||||||
编译后的文件位于 `target/essentialsc-*.jar`
|
编译后的文件位于 `target/essentialsc-*.jar`
|
||||||
|
|
||||||
## 📝 特性
|
---
|
||||||
|
|
||||||
- ✅ CMI 风格的命令别名系统
|
|
||||||
- ✅ 智能权限过滤的帮助菜单
|
|
||||||
- ✅ 完整的多语言支持
|
|
||||||
- ✅ 功能方块权限菜单
|
|
||||||
- ✅ 潜行+右键潜影盒直接打开(防刷机制)
|
|
||||||
- ✅ 末影箱参考 EssentialsX 实现(100% 安全)
|
|
||||||
- ✅ 潜影盒自定义标题配置
|
|
||||||
- ✅ 轻量级无依赖设计
|
|
||||||
- ✅ 现代化的 Paper API 支持
|
|
||||||
|
|
||||||
## 🔄 更新日志
|
## 🔄 更新日志
|
||||||
|
|
||||||
### v1.2.0
|
### v1.2.0 (当前版本)
|
||||||
- ✨ 新增潜行+右键潜影盒直接打开功能(类似 CMI)
|
#### ✨ 新功能
|
||||||
|
- **潜影盒快捷打开** - 潜行+右键直接打开(类似 CMI)
|
||||||
- 支持自定义标题(config.yml 配置)
|
- 支持自定义标题(config.yml 配置)
|
||||||
- 防刷物品机制(快照验证 + 数量检查)
|
- 防刷物品机制(快照验证 + 数量检查)
|
||||||
- 防止套娃(不能放入另一个潜影盒)
|
- 防止套娃(不能放入另一个潜影盒)
|
||||||
- 异常恢复(物品丢失自动掉落)
|
- 异常恢复(物品丢失自动掉落)
|
||||||
- ✨ 末影箱改用 EssentialsX 实现方式(100% 安全)
|
- **末影箱优化** - 改用 EssentialsX 实现方式,100% 数据安全
|
||||||
- ✨ 功能方块菜单配置化(从 config.yml 读取)
|
|
||||||
- ✨ 功能方块菜单添加音效反馈
|
#### ⚡ 优化
|
||||||
- ✨ CMI 风格命令别名系统
|
- 功能方块菜单配置化(从 config.yml 读取)
|
||||||
- ⚡ 优化代码结构和性能
|
- 功能方块菜单添加音效反馈
|
||||||
- 📝 完善权限配置
|
- CMI 风格命令别名系统
|
||||||
- 🗑️ 移除管理员菜单
|
- 代码结构和性能优化
|
||||||
- 🗑️ 移除附魔台功能
|
|
||||||
|
#### 🗑️ 移除
|
||||||
|
- 管理员菜单
|
||||||
|
- 附魔台功能
|
||||||
|
|
||||||
### v1.1.0
|
### v1.1.0
|
||||||
- ✨ 新增功能方块菜单 (`/essc blocks`)
|
- ✨ 新增功能方块菜单 (`/essc blocks`)
|
||||||
- ✨ 添加命令别名系统
|
- ✨ 添加命令别名系统
|
||||||
- ⚡ 优化代码结构和性能
|
- ⚡ 优化代码结构和性能
|
||||||
- 📝 完善权限配置
|
|
||||||
|
|
||||||
### v1.0.0
|
### v1.0.0
|
||||||
- 🎉 首次发布
|
- 🎉 首次发布
|
||||||
|
|||||||
Reference in New Issue
Block a user