💡Class Widgets 指南: 制作你的第一个插件
本文将会带领你制作你的第一个Class Widgets插件,让你可以更好的使用Class Widgets的插件功能。
每当你看见👉️符号,就说明你应该做一些事情。而其余的只供您参考和更深入的理解。
本文预计阅读需要5分钟。
在开始之前
你需要准备以下程序及内容:
- Class Widgets(1.1.7+)
如果你已有现有的Class Widgets 程序,我们建议你下载一个新的Class Widgets 程序作为开发环境。
- 一个Github账号
- (可选)Vscode代码编辑器
1. 使用模板创建一个新的插件

👉️填写你的插件名称,描述等内容。

现在我们需要进入 GitHub Codespaces 来编辑仓库里的文件。
👉️在仓库界面按下键盘上的.(英文句号)进入 GitHub Codespaces。
2. 编写插件内容
👉️在 GitHub Codespaces 界面打开main.py,在初始化函数里面添加下面一行:
self.method.register_widget('widgets-test.ui', '测试小组件', 245) # 注册小组件到CW
👉️在自动更新函数里面添加下面一行:
if self.cw_contexts['State']: # 判断当前状态
self.method.change_widget_content(WIDGET_CODE, widget_title, '上课状态')
else:
self.method.change_widget_content(WIDGET_CODE, widget_title, '课间状态')
至此,我们添加了一个小组件,他可以判断Class Widgets是上课状态还是下课状态。
👉️打开plugin.json,根据参考填写相关内容:
{
"name": "Class Widgets 插件模板",
"description": "这里是简介,用简短的语言描述插件的功能。",
"version": "1.0.0",
"plugin_ver": 1,
"author": "你的名字",
"settings": true,
"url": "https://github.com/{repo-owner}/{repo}",
"branch": "main",
"update_date": "yyyy/mm/dd"
}
3. 保存并运行插件
👉️在编辑器【Git】工具窗口中提交更改。
接下来我们要回到本地,运行插件。
👉️在Class Widgets打开插件选项卡,点击使用"资源管理器"打开。
👉️在Github界面下载插件压缩包,把插件文件夹放在Class Widgets的插件文件夹里。
👉️重新启动你的Class Widgets程序,并在“自定义”里添加小组件。
🎉恭喜!您现在已经成功地完成了插件!
继续开发……
您可以继续根据 https://www.classwidgets.cn/docs-dev.html 来进一步了解如何开发插件,当然如果有什么不明白的也欢迎一起交流探讨。