介绍
此内容还没有支持您的语言版本.
欢迎参与 Miru Alpha 的扩展开发,本文档将帮助你快速了解 Miru Alpha 的扩展开发方法和注意事项,让你能够轻松地为 Miru Alpha 添加新扩展源。
Miru Alpha 的扩展同时支持两种语言运行时:JavaScript(goja) 与 Go(Scriggo)。你可以根据需求选择——JS 适合快速编写、门槛低;Go 适合复杂解析与复用 Go 生态库。两种扩展使用同一套元数据与数据返回结构,前端对两者一视同仁。
本文档的目标受众是想要参与 Miru 扩展开发的贡献者,你需要具备一定 JavaScript 或 Go 的基础知识,以及对 Miru 的基本了解。本文档按照开发流程来划分,每个部分包含以下内容:
- 开发环境:介绍如何搭建 Miru 的扩展开发环境,包括克隆源码、运行服务,以及 JS / Go 各自的推荐工具链。
- 开发方法:介绍如何使用 Miru 的接口来实现扩展开发(JavaScript 与 Go 两套写法),包括添加新扩展源。
- 开发示例:给出一些扩展开发的代码示例和注释,帮助你更直观地理解。
- 开发注意事项:提供一些扩展开发的注意事项和建议,帮助你避免一些常见的错误和问题。
本文档使用正式的语言和图文并茂的方式,以便于你快速、准确、清晰地掌握 Miru 的扩展开发方法。本文档使用线性的顺序,你需要按照顺序阅读每个部分。
-
环境搭建:搭建本地开发环境、运行服务。
-
开始开发:填写扩展元数据,并选择你使用的语言(JavaScript 或 Go)。
-
语言开发指南:进入对应语言的页面——
- JavaScript 扩展:快速开始(V2)(推荐)/ 旧版 V1(兼容)/ 数据格式(V2 / V1 旧版)。
- Go 扩展:快速开始 → 详细用法 → 原生 Go 运行 / Scriggo 运行 → 数据格式。
这些页面包含该语言的入口函数、请求/缓存 API、内置模块(
require/sdk)与可运行示例,是你编写扩展时主要参考的页面。 -
数据格式(数据格式(V2 / V1 旧版)):所有入口方法的入参与返回结构参考;V2 为当前标准,V1 旧版仅作兼容保留,二者按类型播放结构一致。