houdoku-extensions v1.0.0

houdoku-extensions

This repository contains extensions for Houdoku, a manga reader for the desktop. Houdoku users can install and load extensions at runtime separate from the application itself.

Extensions are published as separate npm packages. For a list of published extensions, check the @houdoku scope on the npm registry:

• https://www.npmjs.com/search?q=scope%3Ahoudoku

Development

API

Definitions for functions that extensions should implement are in the houdoku-extension-lib repo.

In particular, see the interface source, which has full method documentation.

Building

Utility scripts are provided in /scripts:

# Clean build artifacts
./scripts/clean-all.sh

# Build all extensions (may take a while)
./scripts/build-all.sh

# Build a specific extension
./scripts/build-one.sh guya

# Manually install extensions into Houdoku for testing
#  - unbuilt extensions are automatically skipped
#  - INSTALL_DIR is Houdoku's userData directory,
#    e.g. C:/Users/user/AppData/Roaming/Electron
./scripts/manual-install-all.sh INSTALL_DIR

Dependencies

Because of the way that extensions are loaded while Houdoku is running, dependency management is rather complex. Each extension must include dependencies (not devDependencies) for any imports they do. In practice, in order to reduce the size of each extension, we mostly only include type definitions for packages, and have the actual functions be passed in from the Houdoku client (like the fetch function from node-fetch).

Additions to dependencies are possible, but would require updates at every layer of the application.

Related Projects

• houdoku - the application itself
• houdoku-extension-lib - interface library for extensions, used by extensions and the client
• aki-plugin-manager - the utility used by Houdoku to find/install/load extensions, independent of Houdoku's functionality