Giter Club home page Giter Club logo

houdoku's Introduction

Houdoku Header

houdoku.org GitHub release GitHub Workflow Status

Houdoku is a free and open source manga reader for the desktop.


Features

  • Read manga from popular websites or import ones from your filesystem, all in one place.
  • Download chapters for offline reading.
  • Customizable reader interface with multiple layouts and settings.
  • Tagging and filtering support to easily browse and manage large libraries.
  • Cross-platform!

Screenshots1 Screenshots2


Download

Download Houdoku from the official website.

Alternatively, you can download manually from the GitHub releases page.

Documentation

User guides and documentation are available on houdoku.org.

Development

Install dependencies:

yarn

Start the app in the dev environment:

yarn dev

Stack

Application: This is an Electron application. The majority of the functionality is performed in the renderer thread. Exceptions are for cases like accessing the window class (i.e. to support minimizing the window), locating application directories, and for working with extensions. The renderer can invoke these functions through ipc.

UI: The interface uses React components. Most base components (text, buttons, links, etc.) come from Mantine.

State: Recoil is used for state management. Hooks are used for small non-shared behavior.

Storage: Library data and settings are saved with localStorage. Thumbnails are stored in the user-data path.

Plugins/Extensions: See the Tiyo repo. Dynamic loading is handled by aki-plugin-manager.

Content Sources

Houdoku allows users to import manga from their filesystem (e.g. as zip files or folders of images). To read manga from 3rd-party "content sources", the Tiyo plugin can be installed from the Plugins tab in the client.

To learn about Tiyo or request a new content source, please go to https://github.com/xgi/tiyo

License

MIT License

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.