tachiyomi/README.md

101 lines
5.5 KiB
Markdown
Raw Normal View History

# ![app icon](./.github/readme-images/app-icon.png)Tachiyomi
2016-01-17 22:11:53 +01:00
Tachiyomi is a free and open source manga reader for Android.
2015-09-24 17:27:43 +02:00
2019-11-22 06:19:08 +01:00
![screenshots of app](./.github/readme-images/theming-screenshots.gif)
2016-01-16 21:30:44 +01:00
2019-11-25 07:08:28 +01:00
## Newest Release
[v0.9.41](https://github.com/Jays2Kings/tachiyomi/releases)
2019-11-25 07:08:28 +01:00
## Features
2016-01-16 21:30:44 +01:00
2019-11-22 06:19:08 +01:00
Features of Tachiyomi include:
* Online reading from sources such as KissManga, MangaDex, [and more](https://github.com/inorichi/tachiyomi-extensions)
* Local reading of downloaded manga
* A configurable reader with multiple viewers, reading directions and other settings.
* [MyAnimeList](https://myanimelist.net/), [AniList](https://anilist.co/), [Kitsu](https://kitsu.io/explore/anime), and [Shikimori](https://shikimori.one) support
2016-01-16 21:30:44 +01:00
* 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
2019-11-22 06:19:08 +01:00
Plus some new features in this fork such as:
2019-11-22 07:42:21 +01:00
* Android 10 Dark Theme support: You can have Tachiyomi follow the system theme as well as customize which dark theme to use for dark mode
2019-11-22 06:19:08 +01:00
* Android 10 edge to edge support (and a translucent nav bar for older versions): no more small ugly bar for the gesture navigation
* Automatic background based on manga page: For those that like having a white background to match the content, this will automatically set the background to match for moments such as a flashback section of a manga
* [Richer New chapters notifications](https://raw.githubusercontent.com/Jays2Kings/tachiyomi/master/.github/readme-images/new%20notifcations%20collasped.png): Now as a group of notifications, [expanding out to show more information](https://raw.githubusercontent.com/Jays2Kings/tachiyomi/master/.github/readme-images/new%20notifcations.png) about the new chapters (like chapter name and manga cover). Tapping on it will bring you right into the chapter or expand it to mark it as read or view all chapters
* [New material snackbar](https://raw.githubusercontent.com/Jays2Kings/tachiyomi/master/.github/readme-images/material%20snackbar.png): Removing manga now auto deletes chapters and has an undo button in case you change your mind
* Multi Source Migration from library
* Notification separation of updating library and new chapters
* [Share sheets upgrade for Android 10](https://raw.githubusercontent.com/Jays2Kings/tachiyomi/master/.github/readme-images/share%20menu.png)
* Reader seekbar overrides switch app gesture in Android 10, so no more accidents for that
* Option to hide manga titles in grid view
2020-01-03 22:28:03 +01:00
* Filter out your library by searching for tags (ex. "Comedy" or "Slice of Life") or exclude mangas by a tag (ex. "-Shounen" or "-Romance"). Tapping on these tags also performs a local search. You can also search multiple tags (ex. "Romance, -Harem, Comedy")
2019-12-21 21:56:44 +01:00
* Android X Support (**Becasue of this change needed for Android 10 features, extension preferences are currently disabled for all extensions except Mangadex**)
2019-12-21 18:40:37 +01:00
* Tri-State Filters on library
* Filter extensions based on your locale
* Webview Navigation
* Fingerprint/Biometrics lock
* Range Select for Library and Chapters: long Press on an item then long press on another to select everything in between
2019-12-23 01:49:38 +01:00
* Automatically checks for extension updates
2019-11-22 06:19:08 +01:00
## Issues, Feature Requests and Contributing
2018-03-11 12:10:56 +01:00
Please make sure to read the full guidelines. Your issue may be closed without warning if you do not.
<details><summary>Issues</summary>
1. **Before reporting a new issue, take a look at the [FAQ](https://github.com/inorichi/tachiyomi/wiki/FAQ), the [changelog](https://github.com/inorichi/tachiyomi/releases) and the already opened [issues](https://github.com/inorichi/tachiyomi/issues).**
2. If you are unsure, ask here: [![Discord](https://img.shields.io/discord/349436576037732353.svg)](https://discord.gg/tachiyomi)
</details>
<details><summary>Bugs</summary>
* Include version (Setting > About > Version)
* If not latest, try updating, it may have already been solved
* Dev version is equal to the number of commits as seen in 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)
* For large logs use http://pastebin.com/ (or similar)
* Don't group unrelated requests into one issue
DO: https://github.com/inorichi/tachiyomi/issues/24 https://github.com/inorichi/tachiyomi/issues/71
DON'T: https://github.com/inorichi/tachiyomi/issues/75
</details>
<details><summary>Feature Requests</summary>
* Write a detailed issue, explaning what it should do or how. Avoid writing just "like X app does"
* Include screenshot (if needed)
Catalogue requests should be created at https://github.com/inorichi/tachiyomi-extensions, they do not belong in this repository.
</details>
## FAQ
[See our website.](https://tachiyomi.org/)
You can also reach out to us on [Discord](https://discord.gg/tachiyomi).
2016-01-04 02:08:56 +01:00
2015-09-24 17:27:43 +02:00
## License
2016-01-16 21:30:44 +01:00
Copyright 2015 Javier Tomás
2015-09-24 17:27:43 +02:00
2016-01-16 21:30:44 +01:00
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
2015-09-24 17:27:43 +02:00
2016-01-16 21:30:44 +01:00
http://www.apache.org/licenses/LICENSE-2.0
2015-09-24 17:27:43 +02:00
2016-01-16 21:30:44 +01:00
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.
2015-09-24 17:27:43 +02:00
## Disclaimer
2016-01-04 02:08:56 +01:00
The developer of this application does not have any affiliation with the content providers available.