Skip to content

chytanka/chytanka.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

191 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Chytanka

Chytanka is a lightweight, privacy-friendly PWA for reading manga, comics, and visual stories โ€” from online sources, your own server, or local files.

No accounts. No tracking. Just reading.

๐Ÿš€ Get Started

๐Ÿ‘‰ https://chytanka.ink

โšก Why Chytanka?

  • ๐ŸŒ Open anything โ€” links, APIs, or local files
  • ๐Ÿ“‚ No uploads โ€” your files stay on your device
  • ๐Ÿง  Smart behavior โ€” auto-detect reading mode via tags
  • ๐ŸŽฎ Gamepad ready โ€” full control without mouse
  • ๐ŸŒ“ Comfort first โ€” night filter, fullscreen, responsive

๐Ÿ–ผ๏ธ Preview

Chytanka Screenshot

Features

๐Ÿ–ฅ๏ธ Read Episodes Online

Chytanka supports opening episodes from the following platforms:

๐ŸŒ Custom JSON API

Chytanka can open episodes from any custom JSON API returning the following format:

{
"title": "Title of the episode",
"nsfw": false,
"images": [
  {
    "src": "full-link-to-image-1"
  },
  {
    "src": "full-link-to-image-2"
  },
  {
    "src": "full-link-to-image-n"
  }
]
}

๐Ÿ“š Create and Share Readlists

Compile a readlist using Chytanka Readlist Creator:

  1. Paste supported links into the input field.
  2. Edit titles (optional; automatic retrieval supported).
  3. Generate and publish a JSON readlist on Rentry, Gist, or your server.
  4. Use the generated link to start reading with your custom readlist.

๐Ÿ“‚ Open Local Files

Chytanka supports opening the following file formats from your device:

  • ZIP/CBZ
  • PDF
  • MOBI
  • DJVU
  • RAR/CBR

๐Ÿ“– Three Reading Modes

  1. Vertical: Perfect for webtoons.
  2. Horizontal (RTL): Best for manga.
  3. Horizontal (LTR): Ideal for comics.

๐ŸŒ“ Blue Light Filter

Read comfortably at night with Chytanka's built-in blue light filter.

๐Ÿ“ฑ Responsive Viewing

  • In horizontal mode with landscape orientation: view two pages side by side.
  • In portrait orientation: view one page at a time.

๐Ÿ–ฅ๏ธ Fullscreen Mode

Immerse yourself in reading with a fullscreen option.

๐Ÿ•’ Viewing History

  • Tracks history of supported links.
  • File history support is planned.

โŒจ๏ธ Keyboard Shortcuts

On the Start Page

  • F1 โ€” Open FAQ
  • F2 โ€” Open Settings
  • Ctrl+H โ€” Open History
  • Ctrl+O โ€” Open File

While Reading

  • A, D, ArrowLeft, ArrowRight โ€” Navigate pages in horizontal mode
  • W, S, ArrowUp, ArrowDown โ€” Navigate pages in vertical mode
  • Ctrl+O โ€” Open File
  • Ctrl+E โ€” Share (copy link or embed code)
  • F โ€” Toggle Fullscreen

๐ŸŽฎ Gamepad Support

Chytanka includes built-in support for gamepads (tested with PlayStation-style controllers). This allows full navigation and interaction without a mouse or keyboard.

Navigation & Scrolling

  • โฌ…๏ธ L1 / D-Pad Left โ†’ Scroll left
  • โžก๏ธ R1 / D-Pad Right โ†’ Scroll right
  • โฌ†๏ธ D-Pad Up โ†’ Scroll up
  • โฌ‡๏ธ D-Pad Down โ†’ Scroll down

Cursor & Interaction

  • ๐Ÿ•น๏ธ Left Stick โ†’ Move cursor
  • ๐Ÿ•น๏ธ Right Stick โ†’ Scroll (both X and Y axes)
  • ๐Ÿ”˜ Cross (โœ•) โ†’ Click / Select
  • ๐Ÿ”˜ Circle (โ—‹) โ†’ Escape (Cancel / Close dialog)

Actions

  • ๐Ÿ”˜ Square (โ–ก) โ†’ Toggle fullscreen
  • ๐Ÿ”˜ Triangle (โ–ณ) โ†’ Toggle View Mode
  • โ˜ฐ Options โ†’ Toggle overlay
  • ๐Ÿ“ค Share โ†’ Share (copy link or embed code)

Notes

  • Gamepad support relies on the browser's Gamepad API.
  • Button mapping may vary slightly between browsers.

๐Ÿ”ž NSFW Content Warning

If supported by the API, Chytanka warns users about NSFW content.

๐Ÿท๏ธ Tags in Titles

Chytanka supports special tags inside file names or episode titles to automatically control viewer behavior.

Tags are parsed from the title and applied on load.

๐Ÿ“Œ Supported Tags

You can include any of the following words in the title:

rtl, ltr, ver, long, scroll, nsfw, sfw, color, bw, demo, extra

Example:

My Manga Vol.1 [rtl][nsfw]
Chapter 5 - [long][scroll]
Demo Episode [ltr]

๐ŸŽฏ What Tags Do

๐Ÿ“– View Mode

These tags control how pages are displayed:

Tag Description Mode
[rtl] Right-to-left reading 1
[ltr] Left-to-right reading 2
[ver] Vertical / webtoon mode 3
[long] Vertical / long strip 3
[scroll] Vertical scrolling 3

If multiple tags are present, the first matched tag wins.

๐Ÿ”ž Content Flags
Tag Effect
[nsfw] Marks episode as NSFW
[sfw] (Reserved / optional)
๐ŸŽจ Additional Tags (for future use)

These tags are parsed but may be used later:

  • [color] โ€“ colored pages
  • [bw] โ€“ black & white
  • [demo] โ€“ demo content
  • [extra] โ€“ bonus materials

โš™๏ธ How It Works

  • Tags are case-insensitive
  • Tags are detected as standalone words (e.g. rtl, not ultra)
  • Parsed automatically from:
    • file name
    • episode title

๐Ÿ’ก Example

Attack on Titan - Chapter 1 [rtl][nsfw].cbz

Result:

  • View mode โ†’ Right-to-left
  • NSFW flag โ†’ enabled

๐Ÿง  Notes

  • Tags are processed on episode load
  • They override default viewer settings
  • Designed for compatibility with local files (.cbz, .zip) and remote sources

๐Ÿ–‡๏ธ Embed Chytanka on Your Website

You can embed Chytanka into your website and control it via postMessage.

Perfect for:

  • manga sites
  • blogs
  • personal collections

Learn more in the Embedding Guide.


๐Ÿ› ๏ธ Development

Chytanka requires a proxy server for handling some external sources. Proxy repository: https://github.com/chytanka/proxy

โš ๏ธ Important: Both Chytanka and the proxy must run on the same host.

โ–ถ๏ธ Run locally on Windows

# Start proxy on the same host
set NODE_ENV=dev&& set HOST=192.168.0.0 && node index.js
# Start Chytanka app
ng serve --host 192.168.0.0

๐Ÿ’ก Notes

  • The proxy handles CORS and headers for external image sources.
  • Make sure both services use the same host IP (e.g., 192.168.0.0).
  • Adjust the host if your network requires a different local IP.

๐Ÿง  Why a Proxy?

  • Bypasses CORS restrictions from image hosts
  • Normalizes headers
  • Ensures safe and consistent fetching of external content

๐Ÿ”— Other Chytanka Projects

Chytanka is more than just a reader โ€” itโ€™s an ecosystem. Check out these companion projects:

Project What it does Repository
Meta Image Generator Generates social preview images (meta tags) for episodes chytanka-meta-image
Chytanka Helper Browser extension: adds a button to open supported site links directly in Chytanka chytanka-helper
Opera GX Theme Custom theme for Opera GX tailored to Chytanka chytanka-gx-mod
Chytanka Make Create and edit CBZ files from images, reorder pages, add metadata chytanka-make

About

A PWA for comfortable manga and comic reading with minimalist design and night mode, built with Angular.

Topics

Resources

Stars

Watchers

Forks

Sponsor this project

Contributors