re621 / zestyapi Goto Github PK

RE621 is a comprehensive project created to improve the basic user experience while browsing e621.net. It consists of several different modules that enhance the entire site, top to bottom - literally.

For a complete feature overview, visit the project site.

The project is delivered via a userscript. This means that you need a script manager, such as Tampermonkey.
With a script manager installed, click on this link and follow the instructions on the new page:

IMPORTANT

This is an ALPHA build of re621 2.0.
It is not compatible with the settings format from version 1.5.*, and should only be installed for testing purposes. A tool for converting the settings to a new format is coming later.

Older versions of the script are available on the Legacy page.
It lacks some features, and will not receive updates besides critical bug fixes.

Contributions are always welcome.
For bug reports, suggestions, and feature requests, head on over to the issue tracker.

The script is built with webpack.

• Start by cloning the repo as normal
• Run npm i to install dependencies
• Run npm run build to start the build process

That will create a production build of the script.
Artifacts are placed in the dist folder, which should now contain script.user.js and script.meta.js.

In order to build a dev version, set NODE_ENV environment variable to development.
The easiest way to do so is to create a .env file containing NODE_ENV="development".
In the development mode, the script.meta.js file will not be produced. Instead, an injector script will be generated.

An injector script loads the main script by referencing a local file.
This works fine in Chrome; however, in Firefox you will have to run a TamperDAV server.

By default, the Chrome version of the script is produced. In order to switch to building a Firefox version, set the INJ_TARGET environment variable to firefox.