## 1. Project Overview & Quickstart (mihonapp/mihon)

## Contributing

[Code of conduct](./CODE_OF_CONDUCT.md) · [Contributing guide](./CONTRIBUTING.md)

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Before reporting a new issue, take a look at the [FAQ](https://mihon.app/docs/faq/general), the [changelog](https://mihon.app/changelogs/) and the already opened [issues](https://github.com/mihonapp/mihon/issues); if you got any questions, join our [Discord server](https://discord.gg/mihon).


### Repositories

[](https://github.com/mihonapp/website/)
[](https://github.com/mihonapp/bitmap.kt/)

### Credits

Thank you to all the people who have contributed!

<a href="https://github.com/mihonapp/mihon/graphs/contributors">
    
</a>

### Disclaimer

The developer(s) of this application does not have any affiliation with the content providers available, and this application hosts zero content.

### License


Copyright © 2015 Javier Tomás
Copyright © 2024 Mihon Open Source Project

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.

## 2. Official Technical Reference & Guides (mihonapp/website)

## File: README.md



---

## File: website/src/docs/faq/browse/extensions.md

---
title: Extensions
titleTemplate: Browse - Frequently Asked Questions
---

# Extensions
Frequently Asked Questions about Extensions.

## Where can I find repositories/extensions for Mihon?
Mihon does not have, associate, or provide any repositories or extensions.

::: danger Caution
Beware that any third-party repositories or extensions will have full access to the app and may contain malware.
:::

## What are some recommended extensions and sources?
Mihon is bring-your-own-content and does not offer anything.

::: info Disclaimer
**Mihon** isn't responsible for slow, down, missing chapters, or subpar image quality of sources as it doesn't host the content.
:::

## Enabling third-party installations
::::tabs
== Android 8.0 and higher
When prompted while installing your first extension, allow unknown apps installation from that source. For newer Androids, enable per-app in **Install unknown apps**.

::: details Video guide - Recorded on Android 10
<video controls muted preload="metadata">
  
</video>
:::

::: tip Still got questions?
If you need more help regarding this, read [this post](https://nerdschalk.com/how-to-allow-apps-installation-from-unknown-sources-on-android-9-pie/ "nerdschalk.com | How to allow apps installation from unknown sources on Android 9 Pie").
:::
== Android 7.1 and lower
When prompted while installing your first extension, allow unknown apps installation from that source. For older Androids, enable globally in **Unknown sources**.

::: details Video guide - Recorded on Android 7
<video controls muted preload="metadata">
  
</video>
:::
::::

## How do I uninstall an extension?
Uninstall extensions like regular apps: through device settings or in **Mihon**.

::: tip Uninstalling an extension
In **Mihon**, uninstall an extension via <nav to="extensions">, then tap **Uninstall** on the chosen extension.
:::

---

## File: website/src/docs/faq/browse/index.md

---
title: Browse
titleTemplate: Frequently Asked Questions
---

# Browse
Frequently Asked Questions about Browse.

## Why can't I see installed sources?

### If the extension language differs from your device's primary language
Enable the source's language at <nav to="sources">, tap on **Filter**, then turn on the language of the desired source.

### If it's an NSFW extension
Navigate to <nav to="browse"> and check the **Show in sources and extensions list** option.

---

## File: website/src/docs/faq/browse/local-source.md

---
title: Local source
titleTemplate: Browse - Frequently Asked Questions
---

# Local source
Frequently Asked Questions about the Local source.

## How can I import my downloaded series?
For a step-by-step process, we recommend referring to [this guide](/docs/guides/local-source/).

## What should I do if I can't find the Mihon folder?
In case the **Mihon** folder is not visible, create one using a file manager.

## How can I resolve empty/blank covers?
Occasionally, cover images for local series might not appear.

1. Confirm that you've organized the folder structure correctly.
   * To verify, access the series with the missing cover and see if you can read chapters within the app.
   * If not, follow the [provided guide](/docs/guides/local-source/#folder-structure) first.
1. Capture a screenshot of the read chapters, then remove the series from your library.
1. Navigate to <nav to="advanced"> and tap **Clear database**.
   * This action will only affect series not in your library.
2. Return to <nav to="sources">, go to **Local source** and locate the series.
   * The cover issue should now be resolved.
   * Re-add the series to your library, mark your read chapters, and re-enable tracking if necessary.

Related GitHub Issue: [#932](https://git.mihon.tech/tachiyomi/tachiyomi/issues/932)

---

## File: website/src/docs/faq/updates/smart.md

---
title: Smart updates
titleTemplate: Updates - Frequently Asked Questions
---

# Smart updates

Mihon intelligently works to reduce the number of series in a global update to reduce the load on sources. To be updated, a series has to meet the following conditions:

1. **Series Progress**: The series must have been **started**, with at least **one chapter read**.
2. **Ongoing Status**: The series is **not marked Completed** by the source, there's an expectation of more chapters in the future.
3. **Chapter Completion**: The series has **no unread chapters**, you've read all the chapters you already have,
4. **Time Elapsed**: There's been enough time since the last update for the series that **the app predicts a new chapter is available**.

You can see how often the app predicts a new chapter for a series **by looking at the hourglass**.
After that many days, the app will allow that series to check for updates.

---

## File: website/src/docs/faq/updates/upcoming.md

---
title: Upcoming
titleTemplate: Frequently Asked Questions
---

# Upcoming
Frequently Asked Questions about Upcoming Updates

## What is this Calendar?
The Upcoming Updates page does *not* consult with external trackers, publishers, or otherwise claim that a chapter update will be released on a particular day.

What it does do is allow users of Mihon to visually plot their upcoming smart updates, as well as get a feel for when new chapters are *expected* to be released.

## What are Smart Updates?
In order to reduce strain on sources and save user bandwidth, Mihon tries to estimate when chapter updates will be available, and only once that time has passed, include that series in automatic updates.

## Why are my chapter updates on the wrong day?
Smart updates determine time of chapter updates based on the time between currently released chapters. Sources that provide incorrect update dates, periods of hiatus, or update in batches may result in the estimate seeming off. As more chapters are released, the schedule should become more accurate.

---

## File: website/src/docs/faq/downloads.md

---
title: Downloads
titleTemplate: Frequently Asked Questions
---

# Downloads
Frequently Asked Question about Downloads.

## How do I download multiple chapters or series at the same time?
The app does not support parallel downloads from a single source to prevent potential IP bans due to excessive requests.
While this might impact speed, it's preferable over rendering a source inaccessible.

Note that Mihon will download from up to five different sources in parallel.

## Why did my downloads stop midway?
Downloads stopping midway may be related to network connection issues or source problems.
**Mihon** will provide notifications regarding encountered errors during download attempts.

## Why can't I see my downloads?
Downloads might not be detected due to multiple factors:

* Inaccessibility of the download location.
  > Ensure the SD card is properly detected if in use.
* Source name changes.
  > Rename the source's folder to match the new name.
* Series title modified by the source.
  > Adjust the folder title to the updated name.

## How do I manage what's downloading?
Navigate to <nav to="download-queue"> to interact with queued downloads.

Cancel all items by clicking the **Overflow** button beside a series chapter or the top right corner.

To reorder the queue, long-press and drag the `=` icon next to a queue item.

## Can I use both internal storage and external SD card storage?
No, you must choose a single location. Internal storage performs better than external SD cards.

## Why does my device photo gallery contain series pages?
**Mihon** typically prevents series pages in downloads from appearing in your device's photo gallery by default through a `.nomedia` file.
However, in some cases, this might not function as intended.

A quick solution is to create the `.nomedia` file yourself, name it as such, and place it in your downloads folder. If the issue pertains to local source, put the `.nomedia` file in the respective local folder.

## How are downloads organized on the filesystem?
They are stored as `downloads/Source Name/Manga Name/Chapter Name (abcdef).cbz`.
The `abcdef` string is the first 6 hexadecimal digits of the MD5 hash of the URL of the chapter, so that if two chapters have the same name, they won't try to write to the same filename.
In the case of a scanlator, it is `Scanlator Name_Chapter Name` instead of just `Chapter Name`.

Because of the prevalence of operating systems like Windows which have arbitrary limitations on special characters in filenames, by default Mihon will avoid using certain characters in filenames, specifically: `"*:<>?\|`.
Of course, `/` is also banned.
All of these characters are replaced by underscores if they appear in source, manga, chapter, or scanlator names.

Some users have reported using exceptionally buggy operating systems which also have problems with other Unicode characters, such as (but not necessarily limited to) emojis.
If you must use Mihon with such an operating system, you can enable the option in the advanced settings for "Disallow non-English filenames", which will prevent any non-English (non-ASCII) characters from being used in filenames.
Such characters will be replaced with their hexadecimal representations instead.
The special characters mentioned above are still replaced with underscores, if present, rather than hexadecimal.

None of the above considerations affect the way series and chapters are displayed in Mihon, which is based on their metadata rather than filenames.
Because the local source reads comic metadata files, if present, its functioning is also not affected by filename changes if you convert an external source download directory into a local source directory.

If you need to change the "Disallow non-English filenames" option, you may need to do some manual work to ensure that Mihon can still find your existing downloads.
Chapter filenames do not need to be changed, as Mihon is able to check multiple options for a chapter filename, and will find the already-downloaded chapters.
Manga and source directory names, however, need to be updated manually if they contain non-ASCII characters.
Here is an example:

```text
./例 ソース (ALL)/最高のマンガ！/Scanlator Name_始まり_182cce.cbz
./e4be8b20e382bde383bce382b9 (ALL)/e69c80e9ab98e381aee3839ee383b3e382acefbc81/Scanlator Name_e5a78be381bee3828a_182cce.cbz
```

The inability for a device to handle Unicode characters in filenames is a bug.
Please consider contacting your device or operating system vendor to report this, or consider using a standards-compliant device in future, if possible.

---

## File: website/src/docs/faq/general.md

---
title: General
titleTemplate: Frequently Asked Questions
---

# General
Frequently Asked Questions

## Why isn't Mihon on the Google Play Store?
**Mihon** won't be on the **Google Play Store**.

APK-based extensions conflict with [Google Play's content policy](https://play.google.com/about/developer-content-policy/).
**Google** might take down the app due to certain content, which the developers wishes to avoid.

## Is Mihon available for iOS/iPadOS?
There is no iOS or iPadOS version and neither are there plans for one.
Porting is difficult due to the separate codebases of iOS and Android apps.

Any app proclaiming to be "**Mihon for iOS**" is not by us and should be treated as a scam.

## What is Mihon Nightly?
**Mihon Nightly** is the latest development version of the app.
It showcases potential upcoming features, but it's more prone to bugs and crashes.

::: warning CAUTION
While it's ideal for users seeking the latest **Mihon** experience, it's essential to keep [auto-backup](/docs/guides/backups#enabling-automatic-backups) enabled to prevent library loss due to issues.
:::

## Can I read light novels?
**Mihon** can't read light novels; it's an image parser, not a text parser.

## Can I stream anime?
**Mihon** isn't designed for anime streaming.

Projects using the **Mihon** name for anime streaming aren't affiliated with the main project.

## What's a fork?
Forks are alternate **Mihon** versions with distinct features.
Get more details [here on forks](/forks/).

---

## File: website/src/docs/faq/library.md

---
title: Library
titleTemplate: Frequently Asked Questions
---

# Library
Frequently Asked Questions about the Library.

## Why is my Global Update skipping entries?
The app's default behavior is to skip updates for entries that meet the following criteria:

1. Have unread chapters
1. Hasn't been started
1. Marked with a "**Completed**" status
1. Isn't predicted to receive new chapters yet

This strategy helps reduce unnecessary requests which may lead to sources implementing measures against **Mihon** or your extensions.
* We recommend to prioritize reading your unread chapters, and letting **Mihon** update the library by itself to better adapt & predict chapter releases over time.

:::tip
If an entry has infrequent updates or no updates:
* Manually update the individual entry if you know there's a new chapter for it.
* Move the entry into a separate category, and exclude the category from your Global Updates.
:::

For more information, check out the [Smart Updates](/docs/faq/updates/smart) and [Upcoming Calendar](/docs/faq/updates/upcoming) pages.

## Why am I being warned about bulk updates and downloads?
**Mihon** provides a reminder when updating multiple titles or bulk downloading chapters, since excessive requests may trigger a source's anti-bot measures.
This can lead to stalled updates and downloads, extending the time needed to complete your requests, which also impacts your device's battery life.
### To mitigate these concerns
* In <nav to="downloads">, enable "**Auto download while reading**" to download chapters while reading.
* If possible, download in small batches at a time to avoid excessive requests to avoid slow or incomplete downloads.

#### Splitting up your Library into categories
1. Go to <nav to="library">, and create categories to segment your library ("Reading", "Plan to Read", "Completed", etc.).
1. Under the **Global update** settings, tap on **Categories** and select individual categories such as "Reading" to be included.
1. If the warning persists, create another category for infrequently updated entries (such as monthly series, on hiatus), and only include the more frequently updated reading category.

## Why aren't library updates working in the background?
Some Android skins (e.g., **MIUI**) aggressively save battery & limit performance, potentially shutting down apps in the background.
* Whitelist **Mihon** from your battery saver by going to <nav to="advanced"> and tapping **Disable battery optimization**.
* If the issue still occurs, refer to [Don't Kill My App](https://dontkillmyapp.com/) for steps on disabling specific battery-saving options for your device's brand.

## How can I see the number of downloaded chapters?
Badges can be enabled by navigating to <nav to="main_library">, then going to **Filter** and clicking the **Display** tab.
Then, at the bottom, select **Download badges**.

## Can I sync between multiple devices?
**Mihon** can't sync between devices.
Use its [backup and restore](/docs/guides/backups) features, including [auto backups](/docs/guides/backups#enabling-automatic-backups), for series database and content migration to another device.

## How can I ignore duplicate chapters?
Dealing with series translated by multiple groups that result in duplicate chapter releases?

Bookmark or mark as read the undesired chapters, then open the **Filter** menu, ensure you're on the **Filter** tab, then double-tap **Bookmarked** or single-tap **Unread**.

This hides bookmarked or read chapters, enabling you to skip them as you read.
Ensure [Skip filtered chapters](/docs/guides/reader-settings#skip-filtered-chapters) is enabled at <nav to="reader"> under the section **Reading**.

Alternatively, migrate to a source without duplicates.
Refer to the [migration guide](/docs/guides/source-migration) for detailed instructions.

## Why are some cover thumbnails corrupted or blank?
If cover thumbnails appear corrupted, blank, or broken, it's likely due to an incomplete download. Fix this by refreshing the covers in settings.

Refresh your covers at <nav to="advanced"> then tap **Refresh library covers**.

## Why have some chapters been marked as unread?
If certain series chapters are marked as unread without your interaction, it could be due to changed URLs.
**Mihon** detects these changes and interprets the chapters as new.

## How do I pause reading history?
Disable **Incognito Mode** through <nav to="incognito-mode">.

## How do I only read downloaded chapters?
Enable **Download only** via <nav to="downloaded-only">.

## Why can't I disable the Downloaded filter?
Disable **Download only** via <nav to="downloaded-only">.

---

## File: website/src/docs/faq/reader.md

---
title: Reader
titleTemplate: Frequently Asked Questions
---

# Reader
Frequently Asked Questions about the Reader.

## Why didn't the page load?
Besides network-related problems, **Mihon** may occasionally fail to recognize certain images.
To address this, simply exit and re-enter the reader, often resolving the issue.

## Can I see two pages at once?
Not currently. Creating an effective dual-page reader that accommodates scanlator page inconsistencies and other complexities poses challenges. This feature may be added in the future.

## What do all the settings do?
For detailed instructions, please consult the guides section on the website [here on reader settings](/docs/guides/reader-settings).