Skip to content

Commit 7ffc37c

Browse files
committed
Update 04-plugins.md
1 parent b7fb86f commit 7ffc37c

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

guide/04-plugins.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 插件系统
22

3-
插件系统有着非常的强大的功能,请不要安装来源不明、加密、代码复杂难以审计插件,它可能会损坏你的电脑。
3+
插件系统有着非常的强大的功能,请不要安装来源不明、加密、代码复杂难以审计的插件,它可能会损坏你的电脑。
44

55
![](/guide/resources/101_plugins.png)
66

@@ -28,11 +28,11 @@
2828

2929
- `关闭 APP 时`:关闭 APP 时会被触发,GUI 会执行源码中的 `onShutdown` 方法,没有传递参数,此方法无需返回任何值。
3030

31-
特别的,当插件开启了`需要安装`参数时,界面会多出`安装``卸载`按钮,点击后 GUI 会执行源码中的`onInstall``onUninstall` 方法。可用来做插件的初始化工作与善后工作,当`onInstall`方法执行没有出错,GUI 会认为插件执行安装成功,将插件标记为已安装,当`onUninstall`方法执行没有出错,GUI 会认为插件执行卸载成功,将插件标记为已卸载(即未安装)。
31+
插件开启了`需要安装`参数时,界面会多出`安装``卸载`按钮,点击后 GUI 会执行源码中的`onInstall``onUninstall` 方法。可用来做插件的初始化工作与善后工作,当`onInstall`方法执行没有出错,GUI 会认为插件执行安装成功,将插件标记为已安装,当`onUninstall`方法执行没有出错,GUI 会认为插件执行卸载成功,将插件标记为已卸载(即未安装)。
3232

33-
当插件配置了`菜单`时,右键插件卡片会出现对应的菜单项,点击后会执行相应的方法。
33+
插件配置了`菜单`时,右键插件卡片会出现对应的菜单项,点击后会执行相应的方法。
3434

35-
当插件配置了`配置`时,右键插件【配置插件】,可对插件进行配置。
35+
插件配置了`配置`时,右键插件【配置插件】,可对插件进行配置。
3636

3737
## 插件状态码
3838

@@ -234,10 +234,22 @@ scheduledTasksStore.editScheduledTask(id: string, s: ScheduledTaskType)
234234
scheduledTasksStore.addScheduledTask(s: ScheduledTaskType)
235235
```
236236

237-
## 插件中心
237+
## 插件中心、注意事项
238238

239-
插件中心是为了方便用户下载常用的插件而设立的仓库,[Plugin-Hub](https://github.com/GUI-for-Cores/Plugin-Hub)
239+
插件中心是为了方便用户下载常用的插件而设立的仓库,其源码可在此仓库查看:[Plugin-Hub](https://github.com/GUI-for-Cores/Plugin-Hub)
240240

241241
![](/guide/resources/105_plugin_hub.png)
242242

243-
欢迎各位为 GUI 编写插件,并提交你的插件到插件中心。
243+
从插件中心添加的插件不建议修改元数据,也就是插件卡片右上角的【编辑】按钮,因为发布到插件中心的插件都是调试好的,该有哪些触发器就有哪些触发器,该有哪些菜单以及配置项也都是设计好的,有些会用户随意编辑这些插件,比如添加了源码里没有实现的触发器,就会导致插件执行失败。
244+
245+
那么为什么不限制编辑按钮呢?因为我们想把最大的权限交给用户,毕竟有些有想法的用户想对已有插件进行扩展,增加自己想要的功能,GUI 不会限制这部分用户。
246+
247+
如果编辑了乱了插件元数据该怎么办?那就卸载、删除插件,然后来到插件中心重新添加、安装。
248+
249+
为什么有些插件有安装卸载按钮,有些插件没有?这个是根据每个插件的工作原理来的,例如 AdHuardHome 插件,它本身没有任何功能,依赖第三方程序,所以就需要安装与卸载按钮来下载程序与删除程序。再例如节点转换插件,它不依赖任何第三方程序,自然就不需要安装卸载了。
250+
251+
有些插件设计时会提供一些配置项供用户填写,右键插件卡片的第三个菜单项【配置插件】就能打开对应页面,有些插件没有这一项,说明插件不需要用户配置。
252+
253+
插件右上角的更新按钮仅用做更新插件源码,而不是更新插件元数据,所以如果插件更新了元数据,比如添加了一个菜单项或一个配置项,就需要删除插件重新添加。在此之前别忘记了先更新插件列表。
254+
255+
注意事项大概就这么多,最后欢迎各位为 GUI 编写插件,并提交你的插件到插件中心。

0 commit comments

Comments
 (0)