用于描述这个脚本和功能用处
数据的开头也结尾
// ==UserScript==
参数内容
// ==/UserScript==
数据格式
// @参数名 参数值
具体参数
参数名 | 参数值和含义 |
---|---|
name | 脚本名称,显示在列表中 |
namespace | 脚本的命名空间 |
version | 版本 |
date | 开发脚本的日期 |
author | 脚本作者 |
description | 脚本具体描述,体现在列表中悬浮在插件上显示的细节内容 |
homepage | 作者主页,用于在Tampermonkey选项页面上从脚本名称点击跳转。请注意,如果@namespace 标记以"http://"开头,此处也要一样。 |
homepageURL | 同上 |
website | 同上 |
source | 同上 |
icon | 低分辨率图标 |
iconURL | 同上 |
defaulticon | 同上 |
icon64 | 64x64的图标。如果同时定义@icon 和@icon64 ,Tampermonkey仍可能优先使用@icon 定义的图标。 |
icon64URL | 同上 |
updateURL | 检查更新的网址。注意:需要定义@version
|
downloadURL | 更新下载脚本的网址,如果定义成none 就不会检查更新。 |
supportURL | 报告问题的网址 |
include | 脚本生效地址,每行一个。不支持URL hash(即网址中的#), 支持*泛网址。 |
- | // @include http://tampermonkey.net/* 所有油猴子网页 |
- | // @include http://* 所有http网页 |
- | // @include https://* 所有https网页 |
- | // @include * 所有网页 |
match | 约等于@include标签 |
exclude | 不生效页面,每行一个。优先于@include 和@match
|
require | 脚本本身开始运行之前加载并执行的JavaScript文件,每行一个。通过@require加载的脚本如果是严格模式("use strict")的,可能会影响本脚本的严格模式! |
- | // @require https://code.jquery.com/jquery-2.1.4.min.js 需要jquery库 |
resource | 预加载资源,可通过GM_getResourceURL和GM_getResourceText读取, 有关如何确保完整性的内容可以阅读sub-resource integrity
|
- | // @resource icon1 http://tampermonkey.net/favicon.ico |
- | // @resource icon2 /images/icon.png |
- | // @resource xml http://tampermonkey.net/crx/tampermonkey.xml |
connect | 允许被GM_xmlhttpRequest访问的域名,不能是顶级域(.com 、.net 之类)。每行一个。 |
- | // @connect <value>。 <value> 可以具有以下值 |
- | 域名,例如tampermonkey.net(这也将允许所有子域), 子域名,即safari.tampermonkey.net, self,即脚本运行的网址, localhost, IP地址,例如1.2.3.4, * |
run-at | 定义脚本注入的时刻。与其他脚本处理程序不同,@run-at 定义了脚本可以运行的最初时刻。这意味着,通过@require 引入的脚本如果在获取时耗费过多时间,那么脚本可能在网页加载后执行。无论如何,在给定注入时刻后且脚本注入成功的情况下,发生的所有DOMNodeInserted 和DOMContentLoaded 事件都会传递到用户脚本。 |
run-at document-start | 脚本将尽可能快地注入。 |
run-at document-body | 如果body元素存在,则脚本将被注入。 |
run-at document-end | 该脚本将在发生DOMContentLoaded事件时或之后注入。 |
run-at document-idle | 在发生DOMContentLoaded事件后注入脚本。 |
run-at context-menu | 如果在浏览器上下文菜单(仅限桌面Chrome浏览器)中点击该脚本,则会注入该脚本。注意:如果使用此值,则将忽略所有@include和@exclude语句,但这可能会在将来更改。 |
grant | 用于添加GM_ 函数到白名单,例如unsafeWindow对象和一些强大的window函数。如果没有给出@grant标签Tampermonkey会猜测脚本需要。另外window.close和window.focus必须显式声明。如果使用// @grant none,沙箱将被禁用,脚本将直接在页面上下文中运行。在此模式下,没有GM_ 函数,但GM_info属性仍然可用。 |
noframes | 此标记使脚本在主页面上运行,但不会在iframe上运行。 |
unwrap | 此标记会被忽略,因为Google Chrome / Chromium不需要此标记。 |
nocompat | 由于部分代码可能是专门为专门的浏览器所写,通过此标记,Tampermonkey会知道脚本可以运行的浏览器。@nocompat Chrome |