详细描述,遵从编写规范 - 1

This commit is contained in:
gyc123456-1 2024-05-19 22:53:10 +08:00 committed by GitHub
parent fb129ead6e
commit afb3652307
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -12,11 +12,11 @@ sidebar_position: 6
![](_images/plugin.yml/plugin.yml.png)
其实只有name和main是必填的其他可写可不写
其实只有 `name` `main` 是必填的,其他可写可不写
比如一个插件有提供命令,但他不在plugin.yml中写`commands`也是很常见的
比如一个插件有提供命令,但它不在 `plugin.yml` 中写 `commands` 也是很常见的
但是你的插件如果只有这两个......
但是你的插件如果只有这两个……
你在用啥邪门小插件
@ -24,7 +24,7 @@ sidebar_position: 6
:::tip
其实这里写什么都可以,但多数就那么几样
其实这里写什么都可以,但多数就那么几样
下面是常见的一些键值
@ -32,19 +32,19 @@ sidebar_position: 6
## `name`
插件的名字,也是会在`/pl`中输出的信息中显示的插件名
插件的名字,也是会在插件列表(`/pl`)和日志中输出的信息中显示的插件名
## `main`
插件主类,服主不用管
插件主类,加载插件时运行的类的名称,类似正常程序中的 main 函数,服主不用管
## `authors`
插件作者
插件作者,显示在 `/version 插件名`
## `website`
插件相关的网站
插件相关的网站,显示在 `/version 插件名`
## `softdepend`
@ -56,11 +56,11 @@ sidebar_position: 6
## `api-version`
插件编译时使用的api版本
插件编译时使用的 API 版本,影响着 Bukkit API 对插件提供的兼容性
## `version`
插件版本
插件版本,显示在 `/version 插件名`
## `commands`
@ -72,9 +72,9 @@ sidebar_position: 6
## `folia-supported`
当此项为true时folia端才会尝试加载此插件
当此项为 `true`Folia 端才会尝试加载此插件
如果插件的plugin.yml里没有此项你可以试着手动添加
如果插件的 `plugin.yml` 里没有此项,你可以试着手动添加
```
folia-supported: true
@ -82,8 +82,8 @@ folia-supported: true
:::danger
folia端对BukkitAPI的修改是破坏性的,你手动添加而不是插件开发者去兼容,通常加载了也是不可用的
Folia端对 Bukkit API 的修改是破坏性的,你手动添加而不是插件开发者去兼容,通常加载了也是不可用的
这就是为什么要开启此项folia端才会加载插件
这就是为什么要开启此项 Folia 端才会加载插件
:::