Tampermonkey中文文档

最新推荐文章于 2025-03-06 15:28:29 发布
最新推荐文章于 2025-03-06 15:28:29 发布
阅读量773 收藏 2
点赞数
原文链接：https://my.oschina.net/u/2268567/blog/828528
版权

内容

Userscript Header

@name

@namespace

@version

@author

@description

@homepage, @homepageURL, @website and @source

@icon, @iconURL and @defaulticon

@icon64 and @icon64URL

@updateURL

@downloadURL

@supportURL

@include

@match

@exclude

@require

@resource

@connect

@run-at

@grant

@noframes

@unwrap

@nocompat

Application Programming Interface

unsafeWindow

Subresource Integrity

GM_addStyle(css)

GM_deleteValue(name)

GM_listValues()

GM_addValueChangeListener(name, function(name, old_value, new_value, remote) {})

GM_removeValueChangeListener(listener_id)

GM_setValue(name, value)

GM_getValue(name, defaultValue)

GM_log(message)

GM_getResourceText(name)

GM_getResourceURL(name)

GM_registerMenuCommand(name, fn, accessKey)

GM_unregisterMenuCommand(menuCmdId)

GM_openInTab(url, options), GM_openInTab(url, loadInBackground)

GM_xmlhttpRequest(details)

GM_download(details), GM_download(url, name)

GM_getTab(cb)

GM_saveTab(tab)

GM_getTabs(cb)

GM_notification(details, ondone), GM_notification(text, title, image, onclick)

GM_setClipboard(data, info)

GM_info

<><![CDATA[your_text_here]]></>

 

 

Userscript Header

@name

脚本的名称

@namespace

该脚本的命名空间

@version

版本号。当脚本未从 userscript.org安装时用于更新检查，或 Tampermonkey 有问题时检索脚本元数据的。

@author

作者

@description

简介

@homepage, @homepageURL, @website and @source

作者主页，用于在Tampermonkey选项页面上从脚本名称点击跳转。请注意，如果`@namespace`标记以"http：//"开头，此处也要一样。

@icon, @iconURL and @defaulticon

低分辨率图标

@icon64 and @icon64URL

此脚本图标的大小为64x64像素。即使使用这个标签，但`@icon`已经定义了，那么Tampermonkey选项页面的一些地方仍然使用`@icon`定义的图标。

@updateURL

检查更新的网址。注意：需要定义@version

@downloadURL

检测到更新时将下载脚本的网址

@supportURL

报告问题的网址

@include

脚本生效地址，每行一个。不支持URL hash（即网址中的#），详情点击https://forum.tampermonkey.net/viewtopic.php?p=3094

示例：

// @include http://tampermonkey.net/*
// @include http://*
// @include https://*
// @include *

@match

等于@include标签，详情点击http://code.google.com/chrome/extensions/match_patterns.html。

注意："<all_urls>"语句尚不支持，scheme部分也接受"http*://"。

@exclude

不生效页面，每行一个

@require

脚本本身开始运行之前加载并执行的JavaScript文件，每行一个。注意：通过@require加载的脚本如果是严格模式("use strict")的，可能会影响本脚本的严格模式！

Code:

// @require https://code.jquery.com/jquery-2.1.4.min.js
// @require https://code.jquery.com/jquery-2.1.3.min.js#sha256=23456...
// @require https://code.jquery.com/jquery-2.1.2.min.js#md5=34567...,sha256=6789...

请阅读本文sub-resource integrity一节，以获取有关如何确保完整性的更多信息。

@resource

预加载资源，可通过GM_getResourceURL和GM_getResourceText读取

Code:

// @resource icon1 http://tampermonkey.net/favicon.ico
// @resource icon2 /images/icon.png
// @resource html http://tampermonkey.net/index.html
// @resource xml http://tampermonkey.net/crx/tampermonkey.xml
// @resource SRIsecured1 http://tampermonkey.net/favicon.ico#md5=123434...
// @resource SRIsecured2 http://tampermonkey.net/favicon.ico#md5=123434...;sha256=234234...

请阅读本文sub-resource integrity一节，以获取有关如何确保完整性的更多信息。

@connect

此标记定义除顶级域以外的，允许被GM_xmlhttpRequest访问的域名。每行一个。

Code:

// @connect <value>

<value> 可以具有以下值

  • 域名，例如tampermonkey.net（这也将允许所有子域）
  • 子域名，即safari.tampermonkey.net
  • self，即脚本运行的网址
  • localhost
  • IP地址，例如1.2.3.4
  • *

如果无法全部声明脚本可能连接到的所有域，那么这是下面是推荐做法：

声明所有已知的可能由脚本连接的域名，另外添加"// @connect *"。这样，大多数用户可以避免确认对话框，对于没有显式标明的域名，Tampermonkey仍然会询问用户是否允许下一次的连接，而且还提供"始终允许所有域"按钮。如果用户点击此按钮，则将自动允许未来的所有请求。用户还可以通过在脚本设置选项卡中将"*"添加到用户域白名单来将所有请求列入白名单。

@run-at

定义脚本注入的时刻。与其他脚本处理程序不同，@ run-at定义了脚本想要运行的第一个可能的时刻。这意味着，通过@require引入的脚本如果在获取时耗费过多时间，那么脚本可能在网页加载后执行。无论如何，在给定注入时刻后发生的所有DOMNodeInserted和DOMContentLoaded事件都会在注入时缓存并传递到用户脚本。

Code:

// @run-at document-start

脚本将尽可能快地注入。

Code:

// @run-at document-body

如果body元素存在，则脚本将被注入。

Code:

// @run-at document-end

该脚本将在发生DOMContentLoaded事件时或之后注入。

Code:

// @run-at document-idle

在发生DOMContentLoaded事件后注入脚本。

Code:

// @run-at context-menu

如果在浏览器上下文菜单（仅限桌面Chrome浏览器）中点击该脚本，则会注入该脚本。注意：如果使用此值，则将忽略所有@include和@exclude语句，但这可能会在将来更改。

@grant

@grant 用于添加GM_ 函数到白名单，例如unsafeWindow对象和一些强大的window函数。如果没有给出@grant标签Tampermonkey会猜测脚本需要。

Code:

// @grant GM_setValue
// @grant GM_getValue
// @grant GM_setClipboard
// @grant unsafeWindow
// @grant window.close
// @grant window.focus

另外window.close和window.focus必须显式声明。

如果使用// @grant none，沙箱将被禁用，脚本将直接在页面上下文中运行。在此模式下，没有GM_ 函数，但GM_info属性仍然可用。

Code:

// @grant none

@noframes

此标记使脚本在主页面上运行，但不会在iframe上运行。

@unwrap

此标记会被忽略，因为Google Chrome / Chromium不需要此标记。

@nocompat

由于部分代码可能是专门为Firefox/Greasemonkey所写，通过此标记，Tampermonkey会禁用所有代码优化行为。

Code:

// @nocompat支持的浏览器
// @nocompat Chrome

 

Application Programming Interface

unsafeWindow

unsafeWindow对象提供对页面javascript函数和变量的完全访问。

Subresource Integrity

@resource和@require标记的URL的哈希部分可用于此目的。

Code:

// @resource SRIsecured1 http://tampermonkey.net/favicon1.ico#md5=ad34bb...
// @resource SRIsecured2 http://tampermonkey.net/favicon2.ico#md5=ac3434...,sha256=23fd34...
// @require https://code.jquery.com/jquery-2.1.1.min.js#md5=45eef...
// @require https://code.jquery.com/jquery-2.1.2.min.js#md5=ac56d...,sha256=6e789...

n case multiple hashes (separated by comma or semicolon) are given the last currently supported one is used by TM. If the content of the external resource doesn't match the selected hash, then the resource is not delivered to the userscript. Tampermonkey支持 MD5作为备用，其他（SHA-1，SHA-256，SHA-384和SHA-512）依赖于window.crypto。在多个hash（由逗号或分号分隔）的情况下，TM使用最后一个支持的hash。如果外部资源的内容不匹配所选的hash，则资源不会传递给userscript。

GM_addStyle(css)

将给定的CSS添加到文档。

GM_deleteValue(name)

从storage中删除"name"。

GM_listValues()

列出storage的所有name。

GM_addValueChangeListener(name, function(name, old_value, new_value, remote) {})

向storage添加一个change listener，并返回此监听器ID。

'name'是被观察变量的名称。

回调函数的'remote'参数表明此值的修改者是另一个网页(browser tabs)的实例（true），或是在此脚本实例（false）。

因此此function可通过脚本在不同的网页选项卡互相通信。

GM_removeValueChangeListener(listener_id)

通过ID删除change listener。

GM_setValue(name, value)

在storage中存储值。

GM_getValue(name, defaultValue)

在storage中取得name的值，取不到则使用defaultValue。

GM_log(message)

将消息记录到控制台。

GM_getResourceText(name)

从script header获取@resource标记定义的内容。

GM_getResourceURL(name)

从script header获取@resource标记定义的base64编码的URI。

GM_registerMenuCommand(name, fn, accessKey)

在要运行脚本的网页上，在Tampermonkey中注册一个menu，并返回menu的命令 id。

GM_unregisterMenuCommand(menuCmdId)

通过menu id反注册由GM_registerMenuCommand注册menu。

GM_openInTab(url, options), GM_openInTab(url, loadInBackground)

使用url打开新tab。options对象可以有两个属性：'active'决定新的选项卡是否在前台打开，'insert'决定是否在当前标签之后打开新标签页('insert' that inserts the new tab after the current one.)。否则情况都是仅仅添加新选项卡。'loadInBackground'与'active'相反，并且被添加以实现Greasemonkey兼容性。如果既没有"active"也没有"loadInBackground"，那么选项卡不会在前台打开。这个函数返回一个对象，该对象具有close方法，onclosed监听器，名为"closed"的标志。

GM_xmlhttpRequest(details)

创建一个xmlHttpRequest。

详细属性：

  • method - GET，HEAD，POST之一
  • url - 目标网址
  • headers - 即user-agent, referer, ... (Safari和Android浏览器不支持某些特殊headers
  • data - 通过 POST 请求发送的字符串
  • binary - 以二进制模式发送数据
  • timeout - 超时时间（单位ms）
  • context - 将添加到response对象的属性
  • responseType - arraybuffer，blob，json之一
  • overrideMimeType - request的MIME类型
  • anonymous - request将不发送cookies，参见fetch
  • fetch - (beta) 使用fetch而不是xhr，在Chrome这会导致xhr.abort，details.timeout和xhr.onprogress失效，并使xhr.onreadystatechange只接收readyState4事件。
  • username 用于认证的用户名
  • password 密码
  • <events> - onload, onerror, onreadystatechange, onprogress, onloadstart, ontimeout

注意：details不支持synchronous标志。

注意：如果你想使用这种方法，也请参阅@connect。

GM_download(details), GM_download(url, name)

从给定的 URL 下载。

details可以具有下列属性：

  • url - 下载数据的 url 路径
  • name - 文件名，因为安全原因，文件扩展名必须显式声明于Tampermonkey 白名单。
  • headers - 参见GM_xmlhttpRequest。
  • saveAs - 布尔值，是否显示保存对话框.
  • onload - function() {} - 下载完成后调用的函数
  • onerror - function(download) {} - 当出现错误时调用的函数

onerror参数可以具有以下属性：

  • error -错误原因
    • not_enabled -用户未启用下载功能
    • not_whitelisted -所请求的文件扩展名没有列入白名单
    • not_permitted - 用户启用了下载功能，但没有给予下载权限
    • not_supported - 浏览器不支持下载功能
    • not_succeeded -下载启动失败，details属性提供更多信息
  • details -关于该错误的详细信息

根据下载模式，GM_info提供了一个名为downloadMode的属性，该属性设置为以下值之一：native,，disabled，browser.

Advertisement

GM_getTab(cb)

获取一个tab的持久化对象，只要此选项卡是打开的。

GM_saveTab(tab)

保存tab对象以在页面unload后重新打开。

GM_getTabs(cb)

获取所有tab对象的hash，以便与其他脚本实例进行通信。

GM_notification(details, ondone), GM_notification(text, title, image, onclick)

显示一个 HTML5 桌面通知（Desktop notification）或高亮当前tab。

details可以具有以下属性：

  • text - 通知的文本，如果设置了highlight
  • title - 通知标题（可选）
  • image - 图像（可选）
  • highlight - 布尔值，发送通知时是否要高亮tab（可选）
  • timeout - 多久后通知将会隐藏 (可选，0 = 禁用)
  • ondone - 当关闭通知时调用（无论是由于超时或鼠标单击），或选项卡已经是高亮状态（可选）
  • onclick - 用户单击通知时调用（可选）

All parameters do exactly the same like their corresponding details property pendant.

GM_setClipboard(data, info)

将数据复制到剪贴板。参数 ' info ' 可以是对象,例如"{ type: 'text', mimetype: 'text/plain'}"或仅仅是一个字符串表达式（text或者html类型）。

GM_info

获取有关脚本和 TM 的一些信息。该对象可能如下所示︰

Code:

Object+
---> script: Object+
------> author: ""
------>copyright: "2012+, You"
------>description: "enter something useful"
------>excludes: Array[0]
------>homepage: null
------>icon: null
------>icon64: null
------>includes: Array[2]
------>lastUpdated: 1338465932430
------>matches: Array[2]
------>downloadMode: 'browser'
------>name: "Local File Test"
------>namespace: "http://use.i.E.your.homepage/"
------>options: Object+
--------->awareOfChrome: true
--------->compat_arrayleft: false
--------->compat_foreach: false
--------->compat_forvarin: false
--------->compat_metadata: false
--------->compat_prototypes: false
--------->compat_uW_gmonkey: false
--------->noframes: false
--------->override: Object+
------------>excludes: false
------------>includes: false
------------>orig_excludes: Array[0]
------------>orig_includes: Array[2]
------------>use_excludes: Array[0]
------------>use_includes: Array[0]
--------->run_at: "document-end"
------>position: 1
------>resources: Array[0]
------>run-at: "document-end"
------>system: false
------>unwrap: false
------>version: "0.1"
---> scriptMetaStr: undefined
---> scriptSource: "// ==UserScript==\n// @name       Local File Test\n ...."
---> scriptUpdateURL: undefined
---> scriptWillUpdate: false
---> scriptHandler: "Tampermonkey"
---> isIncognito: false
---> version: "4.0.25"

<><![CDATA[your_text_here]]></>

Tampermonkey支持这种写法，会尝试自动检测脚本是否需要启用此兼容性选项。

转载于:https://my.oschina.net/u/2268567/blog/828528

chengxun6634
关注
简单的Tampermonkey入门
云在青天水在瓶
07-10 3万+
Tampermonkey介绍Tampermonkey是浏览器的一个插件，能够以javascript脚本针对浏览器打开的特定网页进行修改，实现自定义功能——如：VIP解析视频网站，购物网站价格对比和历史价格走势等。 它是Monkey这一类用户脚本管理器中比较著名的一个，关于这类插件可以参见博客《不同浏览器下的Userscript的安装与使用》，Tampermonkey的官网为http://tampe
Tampermonkey油猴 加载本地文件
灵台方寸山斜月三星洞
03-29 1万+
引用本地 JS 有两条事要做，顺序不分前后，但都要做。请检查路径是否正确。
Tampermonkey.zip
08-22
支持网页汉化
油猴篡改猴Tampermonkey使用教程（轻松获取文档、小说、音乐、视频资源）
最新发布
funfan的博客
03-06 3077
分享通过油猴脚本实现诸如去除网页广告、自动填写表单、增强网页功能以及获取小说、音乐、视频等资源等各种实用功能
Tampermonkey中文文档（部分）
abc45628的专栏
12-29 2万+
内容 Userscript Header @name @namespace @version @author @description @homepage, @homepageURL, @website and @source @icon, @iconURL and @defaulticon @icon64 and @icon64URL @updateURL @downlo...
Tampermonkey油猴用户脚本API文档
小新的博客
02-17 4430
相信大家都了解浏览器插件，而在众多的扩展中，就不得不提到一个浏览器插件——Tampermonkey。中文俗称油猴。相信很多人也听说过，大家可以把他理解为一个用户脚本管理器。它本身是无法为我们发挥什么作用的，它主要依靠各大社区编写的扩展脚本（JavaScript代码）运行在浏览器上，来改变被访问网页的功能，提升我们的网页浏览体验。「油猴」，Greasemonkey，简称 GM，可以简单理解为脚本管理器。
Tampermonkey 资源文件下载
gitblog_09763的博客
09-06 453
Tampermonkey 资源文件下载 youhoujiaoben.rar项目地址:https://gitcode.com/open-source-toolkit/f5a8b 本仓库提供了一个名为 Tampermonkey 的资源文件下载。Tampermonkey 是一款非常流行的浏览器扩展，允许用户在网页上运行自定义脚本，从而实现各种功能增强和自动化操作。 资源文件内容 Tampermonk...
Tampermonkey
07-29
Tampermonkey 是第一个可以用来让 Chrome 支持更多 UserScript 的 Chrome 扩展，它可以加入更多的 Chrome 本身不支持的用户脚本功能，比如 GM_registerMenuCommand 和 GM_xmlhttpRequest 这两个函数。安装该扩展之后...
Tampermonkey扩展：浏览器用户的脚本管理神器
标签中提到的 "Tampermonkey 油猴" 是指 Tampermonkey 的中文昵称，"油猴" 是它在中文社区中的一个常见别称，这体现了它在中文互联网用户中的普及和受欢迎程度。 压缩包文件中的 "Tampermonkey_4.10_chrome.zzzmh....
Tampermonkey插件下载及使用指南
描述中的“油猴插件”是对Tampermonkey的中文翻译。Tampermonkey是一个在谷歌浏览器（Chrome）、火狐浏览器（Firefox）、以及微软的Edge浏览器中广泛使用的插件。它允许用户安装和运行用户脚本，这些脚本可以是功能...
wsmud-userscript：打造高效tampermonkey体验
这些脚本通常由JavaScript编写，并且可以被浏览器扩展如Tampermonkey运行。用户脚本可以改变网页的许多方面，从简单的样式更改到增加新的功能或自动化常见的网页任务。 ##### 1.2 wsmud与用户脚本 wsmud在中文中...
Tampermonkey的下载与基本使用(学习通/油猴)
zy_2428364651的博客
03-12 2万+
Tampermonkey 是一款开源的浏览器插件，它为用户提供了一种扩展和定制网页功能的方法。通过安装 Tampermonkey 插件，用户可以在支持的浏览器上运行用户脚本，从而改变网页的外观、增强网页的功能，并自动化执行一些任务。使用 Tampermonkey，用户可以轻松地编写和安装用户脚本。这些脚本是基于 JavaScript 编写的，用于修改网页代码、添加新的功能、自动填充表单等。用户可以通过浏览器拓展商店直接安装 Tampermonkey 插件。
Tampermonkey安装
Jeawil的博客
10-15 3274
Tampermonkey安装1.下载Tampermonkey2.安装Tampermonkey3.安装相关脚本 1.下载Tampermonkey 链接：[下载链接](https://pan.baidu.com/s/10EmQfwEH7v4q1ePFn4jZMQ) 提取码：1090 2.安装Tampermonkey 将下载的压缩包解压（放在一个找的到且不会被删除的地方 最好放在d盘） 点击谷歌浏览气右边的设置->更多工具->扩展程序 打开开发者模式->点击加载已解压的扩展程序 选中你
Tampermonkey 文档
Webben
01-16 1628
@doc https://www.tampermonkey.net/documentation.php 目录 @name @name 脚本的名字 @namespace @namespace 脚本的命名空间 @version 脚本的版本，用于检查更新。 @author 脚本的作者 @description 简短重要的描述 @homepage, @homepageURL, @we...
【自动化】初见 - 最强浏览器插件 《油猴Tampermonkey》 开发和发布
kinghzking的专栏
12-11 5012
油猴脚本（Tampermonkey）是一个非常流行的浏览器扩展，它可以运行由广大社区编写的扩展脚本，来实现各式各样的功能，常见的。当然为了运行油猴脚本，你应该在浏览器中安装油猴插件。不同的脚本使用都是不一样的，本脚本使用的是快捷键进行操作，可以打开快捷键菜单，查看对应的操作。作为一个程序猿，肯定不能放过这么个神器了，现在就尝个鲜：自定义baidu搜索框。不同平台，不同浏览器，都有不同的地址，我们使用的是 桌面端 > Chrome。打开任意带有h5播放器的页面，点击油猴插件，可以看到脚本加载运行了。
Tampermonkey(油猴)脚本编写快速入门
热门推荐
蚩尤后裔-汪茂雄
01-11 3万+
是一款免费的浏览器扩展和最为流行的用户脚本管理器，相当于一个管理插件的插件，它适用于ChromeSafariOpera Next, 和Firefox。虽然有些受支持的浏览器拥有原生的用户脚本支持，但 Tampermonkey 将在您的用户脚本管理方面提供更多的便利，它提供了诸如便捷脚本安装、自动更新检查、标签中的脚本运行状况速览、内置的编辑器等众多功能， 同时Tampermonkey还有可能正常运行原本并不兼容的脚本。，安装非常简单，与安装普通的插件无异。
浏览器多功能插件Tampermonkey（油猴）安装及使用教程
m0_62278919的博客
11-30 1万+
如果你还不知道油猴是干嘛的，先别管那么多，先下载再说（你肯定不会后悔）
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值