Vimium C - All by Keyboard

Visit on Firefox Add-ons / Microsoft Edge Add-ons / Chrome Web Store

A Customized Vimium (to click web page content and manipulate browser windows using only keyboard) having contextual mapping, global shortcuts, command sequences, Chinese support and injection functionality, in C-style code for quicker action and less resource cost.

Vimium 的一款修改版（可以用键盘点击网页内容、操作浏览器窗口），添加了完整的中文支持、分场景映射、全局快捷键和命令序列功能，还能运行在某些接受 Vimium C 的扩展程序的私有页面里，并且对CPU和内存资源的消耗很低。

阅读中文介绍 (description in Chinese) 。

This project is mainly developed and maintained by gdh1995, and licensed under the MIT license.

本项目主要由 gdh1995 开发并维护，且以 MIT 许可协议开源。

It (the released version) supports the new Microsoft Edge, Google Chrome and other Chromium-based browsers whose core versions are >= 47, and has a prefect support for a recent Firefox (since version 63.0, desktop). It can even run on Microsoft Edge (EdgeHTML), though there're still some errors. If re-compiled from the source code, Vimium C is able to support Chromium 32~46.

它支持内核版本不低于 47 的新版 Microsoft Edge、Google Chrome 和其它以 Chromium 为内核的浏览器，同时也能完美运行在近些年发布的 Firefox 63（桌面版）和更高版本上，甚至在 Edge (EdgeHTML 内核) 上也能正常执行大部分命令。如果从源码重新编译，Vimum C 还可以支持 Chromium 32~46。

This project is hosted on https://github.com/gdh1995/vimium-c and https://gitee.com/gdh1995/vimium-c .

An old name of this project is "Vimium++", which has been given up on 2018-08-21.

Project Introduction

Vimium C:

中文介绍 (description in Chinese)
a web extension for Firefox, Microsoft Edge and Google Chrome that provides keyboard-based navigation and control of the web, in the spirit of the Vim editor.
add some powerful functions and provide more configurable details and convenience.
here is its license and privacy policy
the initial code is forked from philc/vimium:master on 2014.
customized after translating it from CoffeeScript into JavaScript and then TypeScript.

Other extensions supporting Vimium C:

PDF Viewer for Vimium C
- built from (modified) PDF.js, and is a replacement for the extension named PDF Viewer
- visit it on Chrome Web Store
- Project home: vimium-c-helpers/pdf-viewer
NewTab Adapter
- take over browser's new tab settings and open another configurable URL
- visit it on Firefox Add-ons / Chrome Web Store
- project home: vimium-c-helpers/newtab
Shortcut Forwarding Tool
- provide 32 configurable shortcuts and forward them to another extension like Vimium C
- visit it on Firefox Add-ons / Chrome Web Store
- project home: vimium-c-helpers/shortcuts
Modified Weidu New Tab (微度新标签页修改版)
- a modified and lite version of www.weidunewtab.com (or www.newtabplus.com ), with Chinese translation only
- it does not take over browser's new tab settings; if needed then NewTab Adapter is recommended
- visit it on Chrome Web Store

Release Notes

latest version

full-featured runKey

key mappings: runKey supports inline options which look like #a=b&c=d%20e (wiki added)
add openBookmark and vimium://run/<key-tree> to run long command sequences with complicated options
fix some compatibility bugs
URL matching: support new URLPattern in W3C spec.
Vomnibar: support mapKey from keys to <v-*> (trigger commands) or <enter>
dispatchEvent: add a new mode: key=Key,keyCode[,Code=Key]

Refer to RELEASE-NOTES.md.

Known Issues

There're some known issues on previous or latest versions of Chromium-based browsers, and please read https://github.com/gdh1995/vimium-c/wiki/Known-issues-on-various-versions-of-Chrome for more information.

Building

If you want to compile this project manually, then you need a Node.js 13+ and npm. Please run:

npm install typescript
npm install pngjs # only needed for Chromium-based browsers
node scripts/tsc
# ./scripts/make.sh vimium_c-debug.zip

gulp local can also compile files in place (using configurable build options), while gulp dist compiles and minimizes files into dist/.

The options including MinCVer and BTypes in gulp.tsconfig.json are used to control supported target browsers and set a minimum browser version.

Donating / 捐赠

Vimium C is an open-source browser extension, and everyone can install and use it free of charge. If you indeed want to give its author (gdh1995@qq.com) financial support, you may donate any small amount of money to him through Open Collective, PayPal, Alipay or WeChat. Thanks a lot!

Vimium C 是一款开源的浏览器扩展程序，任何人都可以安装使用它而无需支付任何费用。如果您确实想要资助它的开发者（gdh1995@qq.com），可以通过支付宝、微信、Open Collective 或 PayPal 无偿赠与他一小笔钱。谢谢您的支持！

A donation list is in / 捐赠列表详见: https://github.com/gdh1995/vimium-c/wiki/Donation-List .

Thanks & Licenses

Vimium C: Copyright (c) Dahan Gong, Phil Crosby, Ilya Sukhar. See the MIT license for details.

The translation files in _locales/ belong to CC-BY-SA-4.0, except some of those English sentences which are the same as philc/vimium's are under Vimium's MIT license.

Vimium: Copyright (c) 2010 Phil Crosby, Ilya Sukhar. Licensed under the MIT license.
TypeScript: and modified es.d.ts, es/*, dom.d.ts and chrome.d.ts in types/: Copyright (c) Microsoft Corporation (All rights reserved). Licensed under the Apache License 2.0. See more on www.typescriptlang.org.
Viewer.js (Modified): Copyright (c) 2015-present Chen Fengyuan. Licensed under the MIT license.
JavaScript Expression Evaluator (Modified): Copyright (c) 2015 Matthew Crumley. Licensed under the MIT license.
The orange picture in the icon is from https://pixabay.com/vectors/orange-fruit-mandarin-citrus-fruit-158258/
微度新标签页: (c) 2012 杭州佐拉网络有限公司保留所有权利.
PDF.js: Copyright (c) Mozilla and individual contributors. Licensed under the Apache License 2.0.

Declaration for Applicable Regions

The Vimium C and other extensions published by gdh1995 are available for all people in "all regions" of Microsoft Edge Add-ons, Chrome Web Store and some other markets. This behavior is only to make these extensions easier to use, but
DOES NOT EXPRESS OR IMPLIED the author (gdh1995) "agrees or has no objection to" that "Taiwan" can be parallel to "China", which was an inappropriate status quo in the stores' (developer) pages on 2021-06-03.

According to The Constitution of the People's Republic of China and international consensus, Taiwan is an inalienable part of the sacred territory of the People's Republic of China.

whcoding / vimium-c