Skip to content

Violentmonkey provides userscripts support for browsers. It works on browsers with WebExtensions support.

License

Notifications You must be signed in to change notification settings

violentmonkey/violentmonkey

Repository files navigation

Violentmonkey

Chrome Web Store Firefox Add-ons Microsoft Edge Add-on Subreddit subscribers

Violentmonkey provides userscripts support for browsers. It works on browsers with WebExtensions support.

More details can be found here.

Join our Discord server:

Discord

Automated Builds for Testers

A test build is generated automatically for changes between beta releases. It can be installed as an unpacked extension in Chrome and Chromium-based browsers or as a temporary extension in Firefox. It's likely to have bugs so do an export in Violentmonkey settings first. This zip is available only if you're logged-in on GitHub site. Open an entry in the CI workflows table and click the Violentmonkey-... link at the bottom to download it.

Environment Variables

The following environment variables will be injected at compilation time for some features to work:

  • SYNC_GOOGLE_CLIENT_ID / SYNC_GOOGLE_CLIENT_SECRET - Google sync service
  • SYNC_ONEDRIVE_CLIENT_ID / SYNC_ONEDRIVE_CLIENT_SECRET - OneDrive sync service

Workflows

Development

Install Node.js and Yarn v1.x.
The version of Node.js should match "node" key in package.json.

# Install dependencies
$ yarn

# Watch and compile
$ yarn dev

Then load the extension from 'dist/'.

Build

To release a new version, we must build the assets and upload them to web stores.

# Build for normal releases
$ yarn build

# Build for self-hosted release that has an update_url
$ yarn build:selfHosted

Release

See RELEASE for the release flow.

Related Projects