Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Pylogmon authored Jun 25, 2024
1 parent 962df47 commit 0fbf024
Showing 1 changed file with 1 addition and 58 deletions.
59 changes: 1 addition & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1 @@
# Pot-App 文字识别插件模板仓库 (以 [OCR Space](https://ocr.space/) 为例)

### 此仓库为模板仓库,编写插件时可以直接由此仓库创建插件仓库

## 插件编写指南

### 1. 插件仓库创建

- 以此仓库为模板创建一个新的仓库
- 仓库名为 `pot-app-recognize-plugin-<插件名>`,例如 `pot-app-recognize-plugin-ocrspace`

### 2. 插件信息配置

编辑 `info.json` 文件,修改以下字段:

- `id`:插件唯一 id,必须以`[plugin]`开头,例如 `[plugin].com.pot-app.ocrspace`
- `display`: 插件显示名称,例如 `OCR Space`
- `homepage`: 插件主页,填写你的仓库地址即可,例如 `https://github.com/pot-app/pot-app-recognize-plugin-template`
- `icon`: 插件图标,填写当前目录下的图标名称,例如 `icon.png`
- `needs`: 插件依赖,一个数组,每个依赖为一个对象,包含以下字段:
- `key`: 依赖 key,对应该项依赖在配置文件中的名称,例如 `apikey`
- `display`: 依赖显示名称,对应用户显示的名称,例如 `API Key`
- `type`: 组件类型 `input` | `select`
- `options`: 选项列表(仅 select 组件需要),例如 `{"engine_a":"Engina A","engine_b":"Engina B"}`
- `language`: 插件支持的语言映射,将 pot 的语言代码和插件发送请求时的语言代码一一对应

### 3. 插件编写/编译

编辑 `main.js` 实现 `recognize` 函数

#### Input parameters

```javascript
async function recognize(base64, lang, options) {
const { config, utils } = options;
const { tauriFetch } = utils;
}
```

#### Return value

```javascript
return "result";
```

### 4. 打包 pot 插件

1.`main.js`文件和`info.json`以及图标文件压缩为 zip 文件。

2. 将文件重命名为`<插件id>.potext`,例如`plugin.com.pot-app.ocrspace.potext`,即可得到 pot 需要的插件。

## 自动编译打包

本仓库配置了 Github Actions,可以实现推送后自动编译打包插件。

每次将仓库推送到 GitHub 之后 actions 会自动运行,将打包好的插件上传到 artifact,在 actions 页面可以下载

每次提交 Tag 之后,actions 会自动运行,将打包好的插件上传到 release,在 release 页面可以下载打包好的插件
# Pot-App OpenAI 文字识别插件

0 comments on commit 0fbf024

Please sign in to comment.