这是 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
- 在您的脚本中引用其他外部脚本。请参见 包含外部脚本的使用规定。
- §
@updateURL
,@installURL
,@downloadURL
- 告知用户脚本管理器应该在哪个地址获取脚本更新。Greasy Fork 将自动修改该属性使其永远通过 Greasy Fork 进行更新。
- §
@license
- 许可协议描述的是您是否允许别人以某些形式复制或修改您的脚本。建议从 SPDX 许可协议列表 中选择「Full name」或「Identifier」填至此处。若您不提供许可协议,则表示仅允许个人使用且不得二次分发。许可协议将在脚本的简介页面显示。
- §
@supportURL
- 该脚本的技术支持链接(如:错误反馈系统、论坛、电子邮件等),该链接将显示在脚本的反馈页面。
- §
@contributionURL
- 用于捐赠脚本作者的链接,该链接将显示在脚本的反馈页面。网址可以为 http、https 或比特币协议的网址。如果您需要链接到贝宝捐赠页面,请使用例如 https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=your.email.here@example.com&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 会解析这几种类型:ads
(该脚本会展示广告给脚本使用者)、tracking
(该脚本会追踪用户的活动)、miner
(该脚本含有虚拟货币挖矿代码)以及referral-link
(脚本会重写或重定向链接来添加推荐/返利代码),而其它类型的值将会被忽略。即便如此,脚本也必须遵守 Greasy Fork 的规则。描述段可以留空。 - §
@antifeature:XX-YY
- 你可以使用多种语言声明
@antifeature
属性,其中 XX 为 ISO 639-1 中定义的两个字符的代码,而 YY 则是一个可选的 ISO 3166 中定义的国家代码。在@antifeature
中制定的每一个类型都可以自定义其本地化的说明。