add readme

README.md

@@ -0,0 +1,78 @@
+# EssentialsD
+
+## 说明
+
+主要是实现对 EssentialsX 的平替，同时用来实现一些玩家想要的千奇百怪的功能。由于 EssentialsX 持续不对Folia进行更新支持，因此使用此插件代替 EssentialsX，其中D代表Deer。
+
+## 支持版本
+
+- 1.20.1+ (Paper、Folia)
+
+## 安装方法
+
+1. 将插件放入服务器的 `plugins` 目录下
+2. 重启服务器
+3. 在 `plugins/EssentialsD/config.yml` 中配置
+4. 重启服务器
+
+## 玩家使用方法
+
+### 1. 隐形（发光）展示框
+
+可以通过`八个木棍`+`一个玻璃板`合成隐形展示框![](https://ssl.lunadeer.cn:14437/i/2024/01/16/65a62829e167b.png)
+
+或者`八个烈焰棒`+`一个玻璃板`合成隐形发光展示框![](https://ssl.lunadeer.cn:14437/i/2024/01/16/65a628356722d.png)
+
+当隐形展示框中没有东西时和普通展示框没有区别，**只有在将要展示的物品放置在隐形展示框中时展示框才会自动隐形**。取下展示框中的物品后展示框会自动恢复到现形状态，避免找不到隐形的空展示框。
+
+### 2. 带手的盔甲架
+
+使用 `木棍` 对着普通盔甲架单击 `鼠标左键`，即可给盔甲架装上手臂。
+
+![](https://ssl.lunadeer.cn:14437/i/2024/01/16/65a62d9d94d8f.gif)
+
+> 由于游戏特性，盔甲架被打掉后手臂会自动消失，因此每次防止盔甲架都需要重新安装手臂。
+
+### 3. 自杀指令
+
+使用 `/suicide` 即可自杀，避免因为特殊情况被卡在门中或误入禁区无法动弹。
+
+### 4. 帽子
+
+使用 `/hat` 可将主手持（一般为右手）的任意物品放到头上，如果头上有东西
+
+### 5. 展示物品
+
+使用 `/showItem` 可以向服务器内的所有玩家展示你主手持（一般为右手）的物品。
+
+### 6. 头颅
+
+使用 `/skull` 可将背包中的一个头颅交换为自己的头颅，注意：需要你的背包中有任意一个除玩家之外生物的头颅（苦力怕、凋零、小白等都可以）。
+
+## 管理员指南
+
+暂无
+
+## 指令
+
+### 玩家指令
+
+`/suicide` 自杀
+
+`/hat` 将主手持的物品放在头部
+
+`/showItem` 展示主手持的物品
+
+`/skull` 使用任意头颅交换获得一个自己的头颅
+
+### 管理员指令
+
+暂无
+
+## 配置文件参考
+
+```yaml
+Debug: false
+```
+
+## TODO

pom.xml

@@ -6,7 +6,7 @@
 
   <groupId>cn.lunadeer</groupId>
   <artifactId>EssentialsD</artifactId>
-  <version>0.6</version>
+  <version>0.7</version>
   <packaging>jar</packaging>
 
   <name>EssentialsD</name>

src/main/resources/plugin.yml

@@ -13,7 +13,7 @@ commands:
     description: 将主手持的物品放在头部
     usage: /hat
   showItem:
-    description: 展示右手的物品
+    description: 展示主手持的物品
     usage: /showItem
   skull:
     description: 使用任意头颅交换获得一个自己的头颅