Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Kartatz committed Nov 2, 2024
1 parent 7f24d3f commit 90905e2
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,37 @@ Prevent Tachiyomi and Mihon from throttling your requests by ignoring rate limit

## What is this?

Mihon and Tachiyomi have a rate limit system based on [OkHttp interceptors](https://square.github.io/okhttp/features/interceptors). This system is intended to prevent manga sources from being overloaded with too many requests and to avoid specific users from being blocked due to high network traffic (i.e. bulk downloads). This is achieved by deliberately waiting for a specific amount of seconds before sending HTTP requests.
Tachiyomi has a rate limit system. This system was designed to prevent manga sources from being overloaded with too many requests and to avoid specific users from being blocked by manga sources due to high network traffic (i.e. bulk downloads). This is achieved by deliberately waiting for a specific amount of seconds before sending networks requests.

This is a simple but efficient system that can prevent a lot of issues. However, the downside is that nowadays these rate limits are applied to every extension; even those that do not actually require any rate limit. "just in case".
The downside is that nowadays these rate limits are applied to every extension; even those that do not actually require any rate limit. "just in case".

Unfortunately, this results in browsing and downloading being slower than necessary.

Bellow is a video comparison:

![Video comparison](https://raw.githubusercontent.com/Kartatz/r/main/sunny.gif)

**On the left side**: Tachiyomi **with** the Sunny module enabled.
**On the right side**: Tachiyomi **without** the Sunny module.
**Left side**: Tachiyomi **with** the Sunny module enabled.
**Right side**: Tachiyomi **without** the Sunny module.

Note that it takes more than 30 seconds to completely load the page without the module.
## Usage

This module requires root and an API-compatible Xposed implementation to work.

Firstly, download and install the APK from the [releases](https://github.com/Xposed-Modules-Repo/com.amanoteam.sunny/releases/latest/download/app-release.apk) page.

- **LSposed**
- Go to the modules section, enable Sunny, and mark the Tachiyomi package in the list of apps. Then, kill/force-close the Tachiyomi process.

- **Legacy Xposed**
- Go to the modules section, enable Sunny, and reboot the device.

## Supported versions

The minimum supported version is Tachiyomi v0.12.0. It might be compatible with older releases, but that is not guaranteed to work.

This was tested up to Mihon v0.16.5.
This was tested up to Mihon v0.17.0.

## Non-root alternative

If you don't have root or are just looking for a more native alternative, try my [fork](https://github.com/AmanoTeam/mihon) of Mihon. It's the original Mihon app with my changes on top of it.

0 comments on commit 90905e2

Please sign in to comment.