这是 Greasy Fork 将读取的 用户脚本元信息字段 列表。脚本中可包含列表之外的字段,这些字段会保留在安装后的脚本中,但不会影响 Greasy Fork 上的脚本页面内容。
- §
@name
- 脚本的名称。该项将显示在页面的标题以及链接内容,必填项。
- §
@name:XX-YY
- 脚本在特定语言区域的标题,其中 XX 为 ISO 639-1 中定义的两字母代码 ,而 YY 指可选的 ISO 3166 地区代码。该选项用于提供本地化的
@name
脚本名称。 - §
@description
- 脚本功能的描述。该项将显示在脚本标题下面,必填项。
- §
@description:XX-YY
- 用某语言写成的脚本描述。XX 指 ISO 639-1 国家代码 以及 YY 指可选的 ISO 3166 地区代码。该选项用于提供多语言的
@description
脚本介绍。 - §
@namespace
@namespace
与@name
这两个属性被作为脚本的唯一标识符,用户脚本管理器根据它们来判断某个脚本是否已安装。Greasy Fork 也需要这些属性,若用户在更新脚本时改变了两者中的任意一项,将发出警告。- §
@version
- 脚本特定版本的标识符以 Mozilla 版本格式 为准。版本号会显示在脚本的信息页面上。Greasy Fork 要求填写该属性,并会在版本号减少或脚本代码更改时未增加版本号时发出警告。
- §
@include
,@exclude
,@match
- 声明脚本会在哪些网站上运行。该列表会被解析和展示到脚本的简介页面,并用于脚本的分类。每个脚本须有至少一个
@match
或@include
。了解格式细则。 - §
@require
- 引入外部脚本到用户脚本。查看关于引入外部脚本到代码的规则。如果您使用子资源完整性哈希值(更多信息请参阅 TamerMonkey 文档 与 MDN 文档),您将在您的哈希值与您链接的内容不匹配时收到来自 Greasy Fork 的警告。
- §
@resource
- 引入外部资源(如 JavaScript、CSS、图像等)到脚本。查看关于引入外部脚本到代码的规则。如果您使用子资源完整性哈希值(更多信息请参阅 Tamermonkey 文档 与 MDN 文档),您将在您的哈希值与您链接的内容不匹配时收到来自 Greasy Fork 的警告。
- §
@updateURL
,@installURL
,@downloadURL
- 告知用户脚本管理器应该在哪个地址获取脚本更新。Greasy Fork 将自动修改该属性使其永远通过 Greasy Fork 进行更新。
- §
@license
- 通过在 Greasy Fork 上发布您的脚本,您赋予其他人安装和使用它的权利。许可证声明了人们是否以及如何被允许修改和分发您的脚本,展示在脚本的信息页面上。
@license
可以是:- 许可证的名称(例如,
@license GPL3
)。建议使用来自 the SPDX 许可证列表 的 “全名” 或 “标识符”。 - 您允许使用的条件(例如
@license 只要您给我署名就可以修改
,虽然建议使用已有的许可证。 - 版权声明 (例如
@license Copyright 我的名字
)如果您不想在有许可证下发布。 - 完全省略。这与具有版权声明相同,但对用户来说不够清晰。
- 许可证的名称(例如,
- §
@supportURL
- 用户获得脚本支持的链接(例如漏洞跟踪器、论坛或邮箱地址),该支持链接将显示于脚本的反馈页面。
- §
@contributionURL
- 用户用于捐赠脚本作者的链接,该捐赠链接将显示在脚本的反馈页面。网址可以为 http、https 或比特币协议的网址。如果您需要链接到 PayPal 捐赠页面,请使用例如 https://www.paypal.com/cgi-bin/[email protected]&item_name=Greasy+Fork+donation 这样的格式,替换其中的示例邮箱地址为您自己的邮箱地址即可。
- §
@contributionAmount
- 建议捐赠金额,配合
@contributionURL
使用。 - §
@compatible
- 标记此脚本与某个浏览器兼容,兼容性信息将显示在脚本的简介页面上。您也可以添加额外的兼容说明,如
@compatible firefox 火狐上必须关闭广告过滤器
这样的格式。目前能被网站识别的浏览器名称有:firefox
,chrome
,opera
,safari
,edge
。 - §
@incompatible
- 标记此脚本与某个浏览器不兼容,兼容性信息将显示在脚本的简介页面上。您也可以添加额外的兼容说明,如
@incompatible firefox 自火狐 23 开始不兼容
这样的写法。目前能被网站识别的浏览器名称有:firefox
,chrome
,opera
,safari
,edge
。 - §
@antifeature
- 披露会为脚本作者而非用户带来额外收益的功能。您可以通过在脚本的元数据中添加
@antifeature 类型 描述
值的方法披露。其中类型是必须填写的内容,而 描述则可以留空。点击此处了解 Greasy Fork 读取的 类型的相关信息。 - §
@antifeature:XX-YY
- 您可以使用多种语言声明
@antifeature
属性,其中 XX 为 ISO 639-1 中定义的两字母代码,而 YY 指可选的 ISO 3166 地区代码。@antifeature
会根据用户浏览的语言而覆盖。