Mayriad / Mayriads-EH-Master-Script

Adds dozens of features to E-Hentai.
GNU General Public License v3.0
98 stars 7 forks source link
downloader e-hentai exhentai gui sadpanda userscript

Mayriad's EH Master Script

GitHub Release Github Release Date Github License Code Style

Userscript Download | Userscript Wiki | Support Thread

Adds dozens of features to E-Hentai.

Table of contents

Features

This is just short list to quickly show its features before even the preface below. A longer list with explanations is provided in the wiki. You can selectively enable any of the features below, except for the GUI control panel, which is always on.

Site-wide features:

Gallery list features:

Gallery view features:

Image view features:

Upload management features:

Script features:

⇧ Back to table of contents

Preface

1) First of all, please ask me if you need help, but be sure to read this user manual first and also the wiki if needed. To keep this manual/readme easy to read, a lot of information is placed in the wiki. Most users who have problems with the automated gallery downloads feature simply did not complete the setup according to the instructions.

2) This is the public version of a private script I wrote for myself over the years. I did a lot of extra work and made this public version just to help others improve their experience on EH. I would be happy if you find my script useful, but otherwise I have nothing to gain from it.

3) Since this is just a private script I wrote for myself, it naturally does not collect any information from the user and does not do any fishy stuff. The code is self-contained, fully transparent, very readable and well documented, so it should be easy to inspect if you would like to have a look.

4) I am purely self-taught, so I am not a real programmer and may have limited ability to debug telepathically and fulfil feature requests. Real life constraints also make it difficult for me to work on this script. However, I am quite confident in its quality and readability, since I did spend several years and hundreds of hours on it.

5) Although I have been using this script for years, it is too big (5,000+ lines of code) for me to test all usage scenarios on all platforms, browsers, userscript engines and EH pages. I know there are a few errors that the script cannot handle, because I cannot even trigger and see them in the first place. Therefore, there might be bugs and you can always submit a report to me to solve any problem you find.

⇧ Back to table of contents

Installation

Firstly, regarding compatibility:

When your browser and userscript engine are ready, head to this userscript's page on OpenUserJS and install it. Please install it from OpenUserJS so that I can keep track of the downloads. You should be able to update this script directly from your userscript engine, although sometimes the engine can fail to detect updates from experience.

If you are going to use the automated gallery downloads feature, you may have to complete one or two additional simple steps to grant this script the permission it needs to download archives and/or torrents from EH. These steps are explained in the dedicated wiki page for this feature.

⇧ Back to table of contents

Usage

When you first activate this script, you should notice that there is a button that says "Configure Master Script" on all gallery lists. Clicking this button will open the GUI control panel and you can then enable the features and options you plan to use. You can read a bit more about the features in the wiki. Some recommend features and options are enabled by default, so you can see their effects immediately after this script is activated.

This control panel is built into all types of gallery lists on EH, and this should be the only thing you need to control this script. Your settings should persist between updates, so you should not need to touch the code at all. The control panel has explanations for all features and options, and notifications will tell you what to do, so in general this script should be very straightforward to use. You may want to read a bit more about the relatively complicated automated gallery downloads feature in the wiki, though.

After you have changed the settings, remember to click the save button in the top left corner and refresh the page like the notification will say. Then you can start enjoying a better EH with my script.

⇧ Back to table of contents

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

⇧ Back to table of contents