plugin.yml

docs/扩展阅读/plugin.yml.md

@@ -0,0 +1,89 @@
+---
+sidebar_position: 6
+---
+
+# plugin.yml
+
+用解压缩软件打开插件的jar文件就可以看到 `plugin.yml`
+
+![](_images/plugin.yml/拆开jar.png)
+
+用文本编辑器可以打开它
+
+![](_images/plugin.yml/plugin.yml.png)
+
+其实只有name和main是必填的，其他可写可不写
+
+比如一个插件有提供命令，但他不在plugin.yml中写`commands`也是很常见的
+
+但是你的插件如果只有这两个......
+
+你在用啥邪门小插件
+
+## 常见的键
+
+:::tip
+
+其实这里头写什么都可以，但多数就那么几样
+
+下面是常见的一些键值
+
+:::
+
+## `name`
+
+插件的名字，也是会在`/pl`中输出的信息中显示的插件名
+
+## `main`
+
+插件主类，服主不用管
+
+## `authors`
+
+插件作者
+
+## `website`
+
+插件相关的网站
+
+## `softdepend`
+
+软依赖，即不必须装的依赖
+
+## `depend`
+
+硬依赖，必须安装
+
+## `api-version`
+
+插件编译时使用的api版本
+
+## `version`
+
+插件版本
+
+## `commands`
+
+插件提供的命令
+
+## `permissions`
+
+插件权限相关
+
+## `folia-supported`
+
+当此项为true时，folia端才会尝试加载此插件
+
+如果插件的plugin.yml里没有此项，你可以试着手动添加
+
+```
+folia-supported: true
+```
+
+:::danger
+
+folia端对BukkitAPI的修改是破坏性的，你手动添加而不是插件开发者去兼容，通常加载了也是不可用的
+
+这就是为什么要开启此项folia端才会加载插件
+
+:::

docs/扩展阅读/待办事项.md

@@ -58,7 +58,7 @@ sidebar_position: 100
 
 - [ ] 命名空间 命令 mod物品 材质包物品
 - [ ] MySQL 小皮 宝塔
-- [ ] plugin.yml讲解
+- [x] plugin.yml讲解
 - [ ] §和&和RGB颜色 格式化代码
 - [ ] 驿站的机器人的命令
 - [ ] docker开服?

docs/插件/概览.md

@@ -10,7 +10,10 @@ sidebar_position: 1
 
 ![](_images/概览/餐叉.jpg)
 
-建议阅读 [YAML语法](/docs/扩展阅读/YAML语法/概览.md) (当然，只是建议)
+建议阅读
+
+- [YAML语法](/docs/扩展阅读/YAML语法/概览.md)     - 了解你书写配置的语法
+- [plugin.yml](/docs/扩展阅读/plugin.yml.md)     - 了解插件的一些信息
 
 :::danger