d69ce1c388
Add check-upstream.sh, generated status artifacts, merge guide, and a scheduled Forgejo job to refresh upstream sync visibility. Co-authored-by: Cursor <cursoragent@cursor.com>
212 lines
11 KiB
Markdown
Executable file
212 lines
11 KiB
Markdown
Executable file
<div align="center">
|
|
|
|
<a href="https://komikku-app.github.io">
|
|
<img width=200px height=200px src="./.github/readme-images/app-icon.png"/>
|
|
</a><br/>
|
|
<a href="https://trendshift.io/repositories/13696" target="_blank"><img src="https://trendshift.io/api/badge/repositories/13696" alt="komikku-app%2Fkomikku | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
|
<h1 align="center"> Komikku </h1>
|
|
|
|
| Releases | Preview |
|
|
|----------|---------|
|
|
| <div align="center"> [](https://github.com/komikku-app/komikku/releases/latest) [](https://github.com/komikku-app/komikku/releases) [](https://github.com/komikku-app/komikku/actions/workflows/build_release.yml) | <div align="center"> [](https://github.com/komikku-app/komikku-preview/releases/latest) [](https://github.com/komikku-app/komikku-preview/releases) [](https://github.com/komikku-app/komikku-preview/actions/workflows/build_app.yml) |
|
|
|
|
*Requires Android 8.0 or higher.*
|
|
|
|
[](https://discord.gg/85jB7V5AJR)
|
|
[](https://github.com/komikku-app/komikku/actions/workflows/build_push.yml)
|
|
[](/LICENSE)
|
|
[](https://hosted.weblate.org/engage/komikku-app/)
|
|
|
|
## Download
|
|
|
|
[](https://github.com/komikku-app/komikku/releases/latest)
|
|
[](https://github.com/komikku-app/komikku-preview/releases/latest)
|
|
|
|
*Requires Android 8.0 or higher.*
|
|
|
|
Self-hosted Forgejo releases (including [Obtainium](https://github.com/ImranR98/Obtainium) install) are documented in [docs/forgejo-release-runner.md](docs/forgejo-release-runner.md).
|
|
|
|
**Fork upstream status:** see [UPSTREAM_STATUS.md](UPSTREAM_STATUS.md) (updated weekly; manual check: `./scripts/check-upstream.sh`). Merge guide: [docs/upstream-sync.md](docs/upstream-sync.md).
|
|
|
|
[](https://github.com/sponsors/cuong-tran "Sponsor me on GitHub")
|
|
|
|
<div align="left">
|
|
A free and open source manga reader which is based off TachiyomiSY & Mihon/Tachiyomi. This fork is meant to provide new & useful features while regularly take features/updates from Mihon or other forks like SY, J2K and Neko...
|
|
|
|
|
|
|
|
<div align="left">
|
|
|
|
## Features
|
|
|
|
### Komikku's unique features:
|
|
- `Suggestions` automatically showing source-website's recommendations / suggestions / related to current entry for all sources.
|
|
- `Hidden categories` to hide yours things from *nosy* people.
|
|
- `Auto theme color` based on each entry's cover for entry View & Reader.
|
|
- `App custom theme` with `Color palettes` for endless color lover.
|
|
- `Bulk-favorite` multiple entries all at once.
|
|
- Source & Language icon on Library & various places. (Some language flags are not really accurate)
|
|
- `Feed` now supports **all** sources, with more items (20 for now).
|
|
- Fast browsing (for who with large library experiencing slow loading)
|
|
- Grouped entries in Update tab (inspired by J2K).
|
|
- Update notification with manga cover.
|
|
- Auto `2-way sync` progress with trackers.
|
|
- Chips for `Saved search` in source browse
|
|
- `Panorama cover` showing wide cover in full.
|
|
- `Merge multiple` library entries together at same time.
|
|
- `Range-selection` for Migration.
|
|
- Ability to `enable/disable repo`, with icon.
|
|
- `Update Error` screen & migrating them away.
|
|
- `to-be-updated` screen: which entries are going to be checked with smart-update?
|
|
- `Search for sources` & Quick NSFW sources filter in Extensions, Browse & Migration screen.
|
|
- `Feed` backup/restore/sync/re-order.
|
|
- Long-click to add/remove single entry to/from library, everywhere.
|
|
- Docking Read/Resume button to left/right.
|
|
- In-app progress banner shows Library syncing / Backup restoring / Library updating progress.
|
|
- `Series ETA` / reading time estimate in the reader, with optional persistence across sessions; library time-left badges use the same tuning. See [docs/reading-eta.md](docs/reading-eta.md).
|
|
- Auto-install app update.
|
|
- Configurable interval to refresh entries from downloaded storage.
|
|
- Forked from SY so everything from SY.
|
|
- Always up-to-date with Mihon & SY
|
|
- More app themes & better UI, improvements...
|
|
|
|
|
|
<details>
|
|
<summary>Features from Mihon / Tachiyomi</summary>
|
|
|
|
#### All up-to-date features from Mihon / Tachiyomi (original), include:
|
|
|
|
* Online reading from a variety of sources
|
|
* Local reading of downloaded content
|
|
* A configurable reader with multiple viewers, reading directions and other settings.
|
|
* Tracker support: [MyAnimeList](https://myanimelist.net/), [AniList](https://anilist.co/), [Kitsu](https://kitsu.app/), [MangaUpdates](https://mangaupdates.com), [Shikimori](https://shikimori.one), [Bangumi](https://bgm.tv/)
|
|
* Categories to organize your library
|
|
* Light and dark themes
|
|
* Schedule updating your library for new chapters
|
|
* Create backups locally to read offline or to your desired cloud service
|
|
* Continue reading button in library
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Features from Tachiyomi SY</summary>
|
|
|
|
#### All features from TachiyomiSY:
|
|
* Feed tab, where you can easily view the latest entries or saved search from multiple sources at same time.
|
|
* Automatic webtoon detection, allowing the reader to switch to webtoon mode automatically when viewing one
|
|
* Manga recommendations, uses MAL and Anilist, as well as Neko Similar Manga for Mangadex manga (Thanks to Az, She11Shocked, Carlos, and Goldbattle)
|
|
* Lewd filter, hide the lewd manga in your library when you want to
|
|
* Tracking filter, filter your tracked manga so you can see them or see non-tracked manga, made by She11Shocked
|
|
* Search tracking status in library, made by She11Shocked
|
|
* Custom categories for sources, liked the pinned sources, but you can make your own versions and put any sources in them
|
|
* Manga info edit
|
|
* Manga Cover view + share and save
|
|
* Dynamic Categories, view the library in multiple ways
|
|
* Smart background for reading modes like LTR or Vertical, changes the background based on the page color
|
|
* Force disable webtoon zoom
|
|
* Hentai features enable/disable, in advanced settings
|
|
* Quick clean titles
|
|
* Source migration, migrate all your manga from one source to another
|
|
* Saving searches
|
|
* Autoscroll
|
|
* Page preload customization
|
|
* Customize image cache size
|
|
* Batch import of custom sources and featured extensions
|
|
* Advanced source settings page, searching, enable/disable all
|
|
* Click tag for local search, long click tag for global search
|
|
* Merge multiple of the same manga from different sources
|
|
* Drag and drop library sorting
|
|
* Library search engine, includes exclude, quotes as absolute, and a bunch of other ways to search
|
|
* New E-Hentai/ExHentai features, such as language settings and watched list settings
|
|
* Enhanced views for internal and integrated sources
|
|
* Enhanced usability for internal and delegated sources
|
|
|
|
Custom sources:
|
|
* E-Hentai/ExHentai
|
|
|
|
Additional features for some extensions, features include custom description, opening in app, batch add to library, and a bunch of other things based on the source:
|
|
* 8Muses (EroMuse)
|
|
* HBrowse
|
|
* Mangadex
|
|
* NHentai
|
|
* Puruin
|
|
* LANraragi
|
|
|
|
</details>
|
|
|
|
## Issues, Feature Requests and Contributing
|
|
|
|
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
|
|
|
<details><summary>Issues</summary>
|
|
|
|
[Website](https://komikku-app.github.io/)
|
|
|
|
1. **Before reporting a new issue, take a look at the [FAQ](https://komikku-app.github.io/docs/faq/general), the [changelog](https://github.com/komikku-app/komikku/releases) and the already opened [issues](https://github.com/komikku-app/komikku/issues).**
|
|
2. If you are unsure, ask here: [](https://discord.gg/85jB7V5AJR)
|
|
|
|
</details>
|
|
|
|
<details><summary>Bugs</summary>
|
|
|
|
* Include version (More → About → Version)
|
|
* If not latest, try updating, it may have already been solved
|
|
* Preview version is equal to the number of commits as seen on the main page
|
|
* Include steps to reproduce (if not obvious from description)
|
|
* Include screenshot (if needed)
|
|
* If it could be device-dependent, try reproducing on another device (if possible)
|
|
* Don't group unrelated requests into one issue
|
|
|
|
Use the [issue forms](https://github.com/komikku-app/komikku/issues/new/choose) to submit a bug.
|
|
|
|
</details>
|
|
|
|
<details><summary>Feature Requests</summary>
|
|
|
|
* Write a detailed issue, explaining what it should do or how.
|
|
* Include screenshot (if needed).
|
|
</details>
|
|
|
|
<details><summary>Contributing</summary>
|
|
|
|
See [CONTRIBUTING.md](./CONTRIBUTING.md).
|
|
</details>
|
|
|
|
<details><summary>Code of Conduct</summary>
|
|
|
|
See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
|
|
</details>
|
|
|
|
<div align="center">
|
|
|
|
### Credits
|
|
|
|
Thank you to all the people who have contributed!
|
|
|
|
<a href="https://github.com/komikku-app/komikku/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=komikku-app/komikku" alt="Komikku app contributors" title="Komikku app contributors" width="800"/>
|
|
</a>
|
|
|
|
|
|
|
|
### Disclaimer
|
|
|
|
The developer(s) of this application does not have any affiliation with the content providers available, and this application hosts zero content.
|
|
|
|
<div align="left">
|
|
|
|
## License
|
|
|
|
Copyright 2015 Javier Tomás
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|