跳转到内容
扉阅Feyxo

给扩展包作者

扉阅不帮读者读,也不替他翻译,而是训练他拆解英文长难句的思维方式:读者在网页上选中一句、按 ⌘C,扉阅先让他看到主干,再按句子里的语法点一道一道出题,他动手拖一拖、点一点,自己拆开以后回到原句。

扩展包(英文 Pack)是你给扉阅做的东西:教它多认一种语法、多出一种题,或者换一套外观、讲法、界面语言。它就是一个文件夹,里面全是 JSON 和 Markdown,没有代码。

文档里写“扩展包”,扉阅界面、命令和文件名里有的地方还叫 plugin,是同一个东西,对照见叫法对照。

  • 写一个扩展包(一个文件夹)。
  • 用 feyxo check 在自己电脑上查一遍,用 feyxo pack 打成一个 名字.feyxo.json。
  • 用 feyxo try 拿你自己配的模型跑扩展包带的评测句,看找得对不对、题出得对不对(不用先装进浏览器)。
  • 把这个文件发给别人,他在扉阅 设置 → 扩展包 → 装一个扩展包 里装上:语法下一次按 ⌘C 就有你的题;外观、讲法、界面语言、节奏、导出模板、提示词装上就换上,设置页里随时能换回自带的。
  • 写代码的扩展包。 新题型(practice)、记录看板(panel)要写代码,要走以后的外接协议,这一版装不了,检查器会直接拒绝。
  • 社区。 逛、搜、一键装、自动更新、作者账号、上传审核,都没有。分享只能靠导出文件,见怎么分享。
  • 联网。 扩展包里哪里都不许写网址(清单里的 homepage、updateUrl 除外),也不能从网上加载任何东西。
  • 替模型判断。 扩展包不能自带词表、规则表替模型判断,只能写“教模型怎么判断”的说明。

一共 11 类能做(写代码的 2 类不在内):语法、外观、讲法、界面语言、节奏、提示词、评测句集、导出模板、组合、网站适配、欢迎页。每一类能做到什么程度、一个真实的成品长什么样,见扩展包能做什么内容;清单里 type 怎么写、文件夹里放哪几个文件,见文件夹和清单。

我们计划只开源自己写的默认扩展包。扉阅本体不开源,这套 SDK 也不开源。

公开仓库还没有建好:下表“计划开”的部分,现在还没有可以下载的地址,建好以后在这里放出来。

部分 开不开 许可证、条款 说明
默认扩展包(30 个,各扩展包文件夹:17 章语法、四套组合、外观、讲法、节奏、界面语言、导出模板,连同每个语法点自带的评测句) 计划开 AGPL-3.0-only 作用是范例:教你怎么写扩展包,照着看、照着改
SDK(检查、打包、本机跑评测的命令,格式的类型) 不开 使用条款:免费使用,用来给扉阅做扩展包,不得拿去做别的产品 只作为能用的工具发出去,看不到源码
SDK 样例(examples/,示例扩展包) 计划开 AGPL-3.0-only 跟默认扩展包一样
扉阅本体 不开 找句子、整句怎么走、题型的实现、扩展包的装卸、设置页,以及本体里别的提示词
我们内部的评测集、真实网页快照、内部文档 不开 默认扩展包里每个语法点自带的评测句是开的,不在这一行

不是 MIT,也不是 Apache,用的是“别人改了就必须开源”的那一类许可证:

  • 可以看、可以用、可以改,也可以拿去做你自己的扩展包。
  • 改过以后再发给别人,就得用同样的许可证(AGPL-3.0-only)公开改过的全部内容,包括里面教模型的提示词、规则卡、评测句。不能改一改、藏起来当成自己的闭源东西。
  • 不改的话,原样使用是允许的(装上用、放在自己的服务器上用),只要保留版权和许可证。这一点许可证拦不住。
  • AGPL 比 GPL 多一条:改过的程序放在服务器上、让用户通过网络用,也要把改过的源码给那些用户。我们的提示词和规则卡是数据,不是程序,这一条管不管得到数据,目前没有定论,我们不作保证。
  • 只是自己在电脑上用、不发给别人,不用公开。

每个默认扩展包的清单里 license 都写 AGPL-3.0-only,作者写扉阅,版权行是 Copyright (C) 2026 扉阅(Feyxo);许可证全文和版权行跟着默认扩展包一起放。

以上不是法律意见;用在商业场合、拿不准的地方,请问懂的人。

SDK:只给使用权,不给源码

小节标题“SDK:只给使用权,不给源码”
  • 可以:免费使用,用来给扉阅写、查、试、打包、发布扩展包。
  • 不可以:拿去做扉阅以外的产品或服务;复制、修改、再发布 SDK 本身。
  • 你看不到 SDK 的源码,但它认什么、怎么查,这个站上都写明白了:文件夹和清单、检查规则。
  • 你自己写的扩展包,许可证自己选。 feyxo check 只要求清单里写了 license,不限定哪一种。

为了让人信得过:发到商店的扩展代码不做混淆,谁都能解包来看;默认扩展包公开,你能看到语法点那部分是怎么教模型的(每个语法点的 detect.md、practice.md),本体里别的提示词不在公开范围;你选中的句子只发给你自己配的模型,扩展不把句子发给扉阅(见隐私)。

默认扩展包的公开地址和 SDK 的获取方式现在还没有,等发布了会写在这里。

“扉阅 / Feyxo”的名字和图标只给我们用。你的扩展包的 id、名字、作者里不能含 feyxo 或“扉阅”(不分大小写),检查器会拒绝。

  1. 先看能自己定义什么:每一种扩展包能改什么、改了什么样、改不了什么,用平常话写;下面几条是格式参考。
  2. 扩展包能做什么内容:每一类能做到什么程度,附真实的成品。
  3. 做第一个扩展包:从样例改起,十分钟走一遍。
  4. 命令:check、pack、try。
  5. 文件夹和清单、语法点:格式。
  6. 别的类型:外观、讲法、语言、节奏、提示词、评测句、导出、组合、网站适配。
  7. 样例、检查规则、怎么分享、版本号。