Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/EruEri/oyomu

A command line comic reader and collection manager
https://github.com/EruEri/oyomu

cli comics-collection comics-reader ocaml terminal

Last synced: about 2 months ago
JSON representation

A command line comic reader and collection manager

Host: GitHub
URL: https://github.com/EruEri/oyomu
Owner: EruEri
License: gpl-3.0
Created: 2023-07-13T10:48:51.000Z (12 months ago)
Default Branch: main
Last Pushed: 2024-04-06T12:28:07.000Z (3 months ago)
Last Synced: 2024-04-06T13:26:57.558Z (3 months ago)
Topics: cli, comics-collection, comics-reader, ocaml, terminal
Language: OCaml
Homepage:
Size: 8.98 MB
Stars: 12
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Lists

cli-apps - Oyomu - A command line comic reader and collection manager. (<a name="viewers"></a>Viewers)
awesome-cli-apps - Oyomu - A command line comic reader and collection manager. (<a name="viewers"></a>Viewers)

README

# Oyomu

Oyomu is a command line comic collection manager and also a comic reader

Your terminal should at least support one of this format for the page to be somewhat readable:
- Sixels
- Iterm
- Kitty

Currently only the zip archive are handle properly

## How to use

### Read

To read comics, use the ```read``` subcommand

By default, it uses the "h" for left and the "l" for right and 'q' for quit
```
$ oyomu read --help
NAME
oyomu-read - Read comics

SYNOPSIS
oyomu read [--pixel=PIXEL_MODE] [OPTION]… …

DESCRIPTION
Read commic

ARGUMENTS
(required)
Archive of the comic. The archives must be zip archive

OPTIONS
-p PIXEL_MODE, --pixel=PIXEL_MODE (absent=symbols)
pixel mode to use to render the images one of 'symbols', 'sixels',
'kitty' or 'iterm'
```

[Demonstration: MacOS iTerm](https://imgur.com/a/7pRl4j1)

### Collection

The ```collection``` subcommand allows you to handle your collection

````
$ oyomu collection --help
NAME
oyomu-collection - Manage Oyomu collection

SYNOPSIS
oyomu collection COMMAND …

DESCRIPTION
oyomu collection allows you to manager and read your comic collection

COMMANDS
add [OPTION]… …
Add comics to the collection

delete [--all=COMIC] [--encrypt] [OPTION]… []…
Delete comics from collection

init [--encryption] [--force] [OPTION]…
Initialise the comics collection

list [--encrypt] [--name-only] [OPTION]… [SERIE]…
List series in collection

read [--all=COMIC] [--encrypt] [--pixel=PIXEL_MODE] [OPTION]…
[]…
Read comics from collection
````

#### Init

To Initialize the collection use ```ìnit``` subcommand

Oyomu has 2 strategies to store your comic:
- Normal:
- Your comics are stored in your **$XDG_DATA_HOME/yomu/comics** directory where each folder holds the volumes of the serie
- Encrypted:
- Your comics are stored in your **$XDG_DATA_HOME/yomu/.scomics** directory and are encrypted with a password that the ```ìnit```
wizard will ask you to set if the option **--encryption** is set

#### Add / Delete / List

- Those subcommands do are respectively add, delete and list comics

#### Read
- You can also read comics within your collection with the ```read``` subcommand of ```oyomu collection```

## How to build
- First you will need to install those opam packages.
```sh
$ opam install dune xdg camlzip cmdliner dune-configurator cryptokit yojson ppx_deriving_yojson
```

- You will also need to install those C libraries:
- [Chafa](https://github.com/hpjansson/chafa)
- Chafa >= 1.12.4
- [ImageMagick](https://github.com/imagemagick/imagemagick)
- ImageMagick >= 7.0.0

The C libraries must be found by **pkg-config**

- And finally:
```sh
git clone https://github.com/EruEri/oyomu
cd oyomu
dune build
dune install
```