bdashore3 / Tsuchi

Push notifications for manga updates from various sources
Apache License 2.0
11 stars 0 forks source link

Tsūchi

An easy and reliable way to get notifications for updated manga.

Why did we create this?

Getting manga updates in general is a huge pain since manga is spread out on different websites with different update times. The only current way to solve this problem is using a reader app which clusters all of a user's manga in one spot.

However, some readers are reliable and deliver updates on a schedule while others... are not due to limitations by the OS, mainly iOS.

Manga readers tend to fetch background updates from the client side. While this works fine in Android, iOS handles client background processes in small windows and can cause inaccurate or nonexistent notifications.

In comes Tsūchi. This service runs from a server which sends out push notification requests. Since this is a direct push notification and not one from a client background service, the notifications are accurate.

Does this depend on a reader?

The short answer, No.

Since Tsūchi is a server-side service, it is 100% independent from reader apps. We use a special JSON format to check for new updates and provide ways to convert your reader backups into these JSON files.

Supported Devices

As long as you read manga from a supported source, it doesn't matter what device you use. You can read manga on a reader, websites, or even have a notepad list for tracking.

tldr; Tsūchi is supported on any computer/mobile device.

Initial Configuration/setup

To get on the official server, please read the setup wizard docs.

Setup wizard documentation

Individual server setup documentation

How often are notifications sent?

Notifications are sent IF a new update is present. However, this check is preformed every 30 minutes to save resource usage. This number can change on user demand. Notifications can be sent through a phone's push notification service or through a web browser depending on the service you use.

Planned features

Here are features that are planned for future updates:

Contribution

There are many ways users can contribute since each piece of Tsūchi is dynamic in nature:

For sources, please reference the sources guide For notification services, please reference the notification services guide

In other cases, please make a new issue in Github issues.

If you don't have a github account, please take a look at other contact options and we'll add your issue for you.

Developers and Permissions

We try to make comments/commits as detailed as possible, but if you don't understand something, please contact either of the developers down below. The best avenue for help is the support discord

Creators/Developers: Brian Dashore, pandeynmn

Join the support discord here (get the king-updates role to access the channel): https://discord.gg/pswt7by

Developer Discords: kingbri#6666, nmn#7029

Kingbri's contact page: https://kingbri.me/socials