From d4605603b8b930a8d3cfbb9639c6465ab14a40f8 Mon Sep 17 00:00:00 2001 From: jmir1 Date: Thu, 6 Jan 2022 03:41:05 +0100 Subject: [PATCH] add back local manga guide --- src/help/guides/local-manga.md | 172 +++++++++++++++++++++++++++++++++ 1 file changed, 172 insertions(+) create mode 100644 src/help/guides/local-manga.md diff --git a/src/help/guides/local-manga.md b/src/help/guides/local-manga.md new file mode 100644 index 00000000..3f16b95e --- /dev/null +++ b/src/help/guides/local-manga.md @@ -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. + +1. Place correctly structured manga inside `/Aniyomi/local/`. + +1. You can then access the manga in → **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) +
+
    +
  • + /sdcard/Aniyomi/local +
      +
    • + Manga title +
        +
      • + ch1 +
          + images +
        +
        • +
      • + ch2 +
          + images +
        +
        • + cover.jpg +
      +
      • +
    • ...
      • +
    +
    • +
+
    +
  • + /storage/18F5-2C11/Aniyomi/local +
      +
    • + Manga title +
        +
      • + ch3 +
          + images +
        +
        • +
      • + ch4 +
          + images +
        +
        • +
      +
      • +
    • ...
      • +
    +
    • +
+
+::: + +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 +
+

Example structure using the file manager

+

Here, the manga name is test so the file structure is /Aniyomi/local/test/ch1/images.

+ +
+::: + +## 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) + +::: + + +## 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.