-
Notifications
You must be signed in to change notification settings - Fork 209
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
172 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| --- | ||
| title: Local manga | ||
| description: All the information you would need to read your own local manga. | ||
| lang: en-US | ||
| --- | ||
|
|
||
| # Local manga | ||
|
|
||
| Follow the steps below to create local manga. | ||
|
|
||
| 1. Create a folder named `local` in the `/Aniyomi/` folder. | ||
| <ul> | ||
| <li> The `/Aniyomi/` folder is located in the root of phone's **internal storage** or **external SD card** and it's **not related** to the `xyz.jmir.Aniyomi.mi/` folder or the download location in the settings.</li> | ||
| <li> If you don't have a `/Aniyomi/` folder located in the folders mentioned above, you can simply create it.</li> | ||
| </ul> | ||
| 1. Place correctly structured manga inside `/Aniyomi/local/`. | ||
| <ul> | ||
| <li>Optional: If adding manga in folders, add a file named `.nomedia` to the local folder so images do not show up in the gallery</li> | ||
| </ul> | ||
| 1. You can then access the manga in <NavigationText item="browse"/> → **Local source**. | ||
|
|
||
| If you add more chapters then you'll have to manually refresh the chapter list (by pulling down the list). | ||
|
|
||
| Supported chapter formats are folder with pictures inside (such as `.jpg`, `.png`, etc), `ZIP`/`CBZ`, `RAR`/`CBR` and `EPUB`. But expect better performance with directories and `ZIP`/`CBZ`. | ||
|
|
||
| ::: c-warning | ||
| While Aniyomi does support chapters compressed as **RAR** or **CBR**, note that **RAR** or **CBR** files using the **RAR5** format are not supported yet. | ||
|
|
||
| If **CBR** or **RAR** files do not work, you may need to extract and re-compress them into one of the supported formats. | ||
| ::: | ||
|
|
||
| ::: c-warning | ||
| Remember to give the app storage permissions. | ||
| ::: | ||
|
|
||
| ## Folder Structure | ||
|
|
||
| Aniyomi requires a specific folder structure for local manga to be correctly processed. Local manga will be read from the `Aniyomi/local` folder. Each manga must have a `Manga` folder and a `Chapter` folder. Images will then go into the chapter folder. See below for more information on archive files. You can refer to the following example: | ||
|
|
||
| ::: guide Example (Folder) | ||
| <div class="side-by-side"> | ||
| <ul class="file-tree"> | ||
| <li> | ||
| /sdcard/Aniyomi/local | ||
| <ul> | ||
| <li> | ||
| <span class="ft-icon ft-folder">Manga title</span> | ||
| <ul> | ||
| <li> | ||
| <span class="ft-icon ft-folder">ch1</span> | ||
| <ul> | ||
| <span class="ft-icon ft-image">images</span> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| <span class="ft-icon ft-folder">ch2</span> | ||
| <ul> | ||
| <span class="ft-icon ft-image">images</span> | ||
| </ul> | ||
| </li> | ||
| <span class="ft-icon ft-image">cover.jpg</span> | ||
| </ul> | ||
| </li> | ||
| <li>...</li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| <ul class="file-tree"> | ||
| <li> | ||
| /storage/18F5-2C11/Aniyomi/local | ||
| <ul> | ||
| <li> | ||
| <span class="ft-icon ft-folder">Manga title</span> | ||
| <ul> | ||
| <li> | ||
| <span class="ft-icon ft-folder">ch3</span> | ||
| <ul> | ||
| <span class="ft-icon ft-image">images</span> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| <span class="ft-icon ft-folder">ch4</span> | ||
| <ul> | ||
| <span class="ft-icon ft-image">images</span> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li>...</li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| ::: | ||
|
|
||
| Aniyomi will see four chapters in a single manga. | ||
| The path to the folder with images must contain both the manga title and the chapter name (as seen above). | ||
|
|
||
| ::: guide-empty | ||
| <figure class="centered"> | ||
| <h4>Example structure using the file manager</h4> | ||
| <p>Here, the manga name is <strong>test</strong> so the file structure is <code>/Aniyomi/local/test/ch1/images</code>.</p> | ||
| <img class="zoomable" height="300" :src="$withBase('/assets/guides_local-manga.jpg')"> | ||
| </figure> | ||
| ::: | ||
|
|
||
| ## Archive Files | ||
| Archive files such as `ZIP`/`CBZ` are supported but the folder structure inside is not. Any folders inside the archive file are ignored. You must place the archive inside the `Manga` folder where the name will become the `Chapter` title. All images inside the archive regardless of folder structure will become pages for that chapter. | ||
|
|
||
| ::: guide Example (ZIP) | ||
| <ul class="file-tree"> | ||
| <li> | ||
| /sdcard/Aniyomi/local | ||
| <ul> | ||
| <li> | ||
| <span class="ft-icon ft-folder">Manga title</span> | ||
| <ul> | ||
| <li> | ||
| <span class="ft-icon ft-zip">ch1.zip</span> | ||
| <ul> | ||
| <span class="ft-icon ft-image">images</span> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| <span class="ft-icon ft-zip">ch2.zip</span> | ||
| <ul> | ||
| <li> | ||
| <span class="ft-icon ft-folder">ch2</span> | ||
| <ul> | ||
| <span class="ft-icon ft-image">images</span> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <span class="ft-icon ft-image">cover.jpg</span> | ||
| </ul> | ||
| </li> | ||
| <li>...</li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| ::: | ||
|
|
||
|
|
||
| ## Advanced | ||
|
|
||
| ### Editing local manga details | ||
|
|
||
| It is possible to add details to local manga. Like manga from other catalogs, you add information about the manga such as the author, artist, description, and genre tags. | ||
|
|
||
| To import details along with your local manga, you have to create a json file. It can be named anything but it must be placed within the **Manga** folder. A standard file name is `details.json`. This file will contain the extended details about the manga in the `JSON` format. You can see the example below on how to build the file. Once the file is there, the app should load the data when you first open the manga or you can pull down to refresh the details. | ||
|
|
||
| You can copy the following example and edit the details as needed: | ||
| ``` json | ||
| { | ||
| "title": "Example Title", | ||
| "author": "Example Author", | ||
| "artist": "Example Artist", | ||
| "description": "Example Description", | ||
| "genre": ["genre 1", "genre 2", "etc"], | ||
| "status": "0", | ||
| "_status values": ["0 = Unknown", "1 = Ongoing", "2 = Completed", "3 = Licensed"] | ||
| } | ||
| ``` | ||
|
|
||
| ### Using a custom cover image | ||
|
|
||
| It is also possible to use a custom image as a cover for each local manga. | ||
|
|
||
| To do this, you only need to place the image file, that needs to be named | ||
| `cover.jpg`, in the root of the manga folder. The app will then use your | ||
| custom image in the local source listing. |