mirror of
https://github.com/venera-app/venera.git
synced 2025-09-27 07:47:24 +00:00
Add doc
This commit is contained in:
59
doc/import_comic.md
Normal file
59
doc/import_comic.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# Import Comic
|
||||
|
||||
## Introduction
|
||||
|
||||
Venera supports importing comics from local files.
|
||||
However, the comic files must be in a specific format.
|
||||
|
||||
## Comic Directory
|
||||
|
||||
A directory considered as a comic directory only if it follows the following two types of structure:
|
||||
|
||||
The file name can be anything, but the extension must be a valid image extension.
|
||||
|
||||
The page order is determined by the file name. App will sort the files by name and display them in that order.
|
||||
|
||||
Cover image is optional.
|
||||
If there is a file named `cover.[ext]` in the directory, it will be considered as the cover image.
|
||||
Otherwise, the first image will be considered as the cover image.
|
||||
|
||||
### Without Chapter
|
||||
|
||||
```
|
||||
comic_directory
|
||||
├── cover.[ext]
|
||||
├── img1.[ext]
|
||||
├── img2.[ext]
|
||||
├── img3.[ext]
|
||||
├── ...
|
||||
```
|
||||
|
||||
### With Chapter
|
||||
|
||||
```
|
||||
comic_directory
|
||||
├── cover.[ext]
|
||||
├── chapter1
|
||||
│ ├── img1.[ext]
|
||||
│ ├── img2.[ext]
|
||||
│ ├── img3.[ext]
|
||||
│ ├── ...
|
||||
├── chapter2
|
||||
│ ├── img1.[ext]
|
||||
│ ├── img2.[ext]
|
||||
│ ├── img3.[ext]
|
||||
│ ├── ...
|
||||
├── ...
|
||||
```
|
||||
|
||||
## Archive
|
||||
|
||||
Venera supports importing comics from archive files.
|
||||
|
||||
The archive file must follow [Comic Book Archive](https://en.wikipedia.org/wiki/Comic_book_archive_file) format.
|
||||
|
||||
Currently, Venera supports the following archive formats:
|
||||
- `.cbz`
|
||||
- `.cb7`
|
||||
- `.zip`
|
||||
- `.7z`
|
Reference in New Issue
Block a user