Kamishibai

pronounce ka-me-shi-bye

Remote manga reader. Read manga anywhere using a web browser.

Can read using iOS or Android tablet using swipe view. Can also read in desktop using keyboard shortcuts.

It remember where the manga is read upto, so you can resume reading with ease.

Support basic tagging in filenaming, please read file naming convention below.

Settings can change image quality to conserve bandwidth.

Zipped (CBZ) books are supported, please read file format below.

Has username and password authentication to protect login.

Primary focus on older hardware such as old tablet and PC.

Screenshots:

Directory view

Tablet Browse view

Reading

Settings

Installation:

gem install kamishibai

Development

# install brew
# install rvm

# install openssl 1.1 from other source so we can install ruby 2.7.2
brew install rbenv/tap/openssl@1.1
rvm install 2.7.2

# install the installer
gem install bundler -v '2.1.4'
# install all dependency
bundle _2.1.4_ install
# start server
bin/kamishibai --debug

Installation (extra info):

Mac OS X:

1. Install MacPorts
2. sudo port install ruby25 rb-rubygems gd2
3. sudo gem install kamishibai

Linux (Ubuntu/Debian):

1. sudo apt-get install ruby ruby-dev libgd-dev
2. sudo gem install kamishibai

Windows:

1. Install the Windows Subsystem for Linux
2. Choose Ubuntu install
3. Follow instruction for Linux above

Access:

1. Run program kamishibai
2. Open browser and type http://127.0.0.1:9999
3. Default username and password is admin/admin, please change it for security purpose.

Configuration:

Config file is written in JSON format. The config file will be located at ~/etc/kamishibai.conf. The config file can also manually selected by appending the config path after the program.

There is also web configuration panel, goto http://host_ip:host_port/config to configure.

Start:

kamishibai [config_file.conf]

File Format:

Only CBZ is supported and it should be zero compressed zip file. This will reduce the burden on the system when reading as well as making the experience more responsive. The file name will determind how it will be organized by the program.

File naming convention:

Ideally, the CBZ file name should be in such format.

(genre|meta data) [Author] Book Title Volume|chapter|v|ch 1.

For example
(Manga) [Yamada Taro] World of Sakura Volume 01.cbz
(一般コミック) [山田太郎] 桜の世界 第01巻.cbz

License:

BSD 3-clause Mac Ma gitmac at runbox.com (C) 2013-2024 Copyright