转到内容

开始开发

此内容还没有支持您的语言版本.

Miru Alpha 的扩展系统同时支持 JavaScriptGo 两种语言运行时:

  • JavaScript 运行时:基于 goja(纯 Go 实现的 ECMAScript 引擎),扩展文件后缀为 .js
  • Go 运行时:基于 Scriggo(Go 语言的模板/脚本引擎),扩展文件后缀为 .go

两种扩展使用同一套元数据与数据返回结构,前端对两者一视同仁。开发扩展需要一定的 JavaScript 或 Go 基础,以及正则表达式知识。如果还不熟悉正则表达式,可以先学习 《正则表达式和字符串的方法》 与 《正则表达式 30 分钟入门教程》。

本文档默认你已按 开发环境 配置好环境。

无论是 JS 还是 Go 扩展,文件顶部都必须用注释包裹一份元数据,格式为 // ==MiruExtension==// ==/MiruExtension==

// ==MiruExtension==
// @name My Extension
// @version v0.0.1
// @author YourName
// @license MIT
// @lang zh-cn
// @icon https://example.com/icon.png
// @package my.extension
// @type bangumi
// @webSite https://example.com/
// @apiVersion 2
// ==/MiruExtension==

元数据写好后,按你的语言选择对应的开发指南,其中包含完整的入口函数、请求/缓存 API 与可运行示例:

返回值结构(列表项、详情、按类型区分的播放结构等)统一在 数据格式 中定义。