Home

Awesome

Pot-App 文字识别插件模板仓库 (以 OCR Space 为例)

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

插件编写指南

1. 插件仓库创建

2. 插件信息配置

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

3. 插件编写/编译

编辑 main.js 实现 recognize 函数

Input parameters

// config: config map
// detect: detected source language
// setResult: function to set result text
// utils: some tools
//     http: tauri http module
//     readBinaryFile: function
//     readTextFile: function
//     Database: tauri Database class
//     CryptoJS: CryptoJS module
//     cacheDir: cache dir path
//     pluginDir: current plugin dir 
//     osType: "Windows_NT" | "Darwin" | "Linux"
async function recognize(base64, lang, options) {
  const { config, utils } = options;
  const { http, readBinaryFile, readTextFile, Database, CryptoJS, run, cacheDir, pluginDir, osType } = utils;
  const { fetch, Body } = http;
}

Return value

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 页面可以下载打包好的插件