书砚插件开发指南
书砚（ShuYan）提供了一套简单而强大的 Python 插件机制。任何一个 .py 文件，只要遵循约定，丢进 plugins/ 目录就能被自动加载。
插件在「编辑器页面」打开时激活——也就是你打开某个项目、看到侧边栏人物 / 地点 / 物品那排 tab 的时候。
插件约定
每个插件文件必须提供以下两个函数：
| 函数 | 必须 | 说明 |
|---|---|---|
get_info() | ✅ 必须 | 返回插件元数据字典 |
activate(api) | ✅ 必须 | 插件入口，往 UI 里挂自己的东西 |
deactivate(api) | ❌ 可选 | 卸载时的清理配置 |
最小骨架
"""我的第一个书砚扩展"""
def get_info():
return {
'name': 'my_first_extension',
'display_name': '✨ 我的第一个扩展',
'version': '1.0.0',
'author': '你的名字',
'description': '写一行简介告诉别人这个扩展做什么',
}
def activate(api):
# 在这里往 UI 里挂东西
pass
def deactivate(api):
# 可选：卸载/重启前清理
pass插件放到哪里
把 .py 文件放到书砚安装目录下的 plugins/ 文件夹：
书砚.exe
novels.db
plugins/
├── __init__.py ← 空文件，自动生成
├── audiobook_plugin.py ← 有声书扩展（内置示例）
└── my_first_extension.py ← 你的插件丢在这里