README.md

mu-epub-reader

Epub viewer on Electron.

This application is forked of futurepress/epubjs-reader: Epub.js Reader.

Features

• Standalone Electron app
• Integrate with Google Translation
• Shortcuts:
  • ←: Prev Page
  • →: Next Page
  • j or Space: Scroll down
  • k or Shift+Space: Scroll up
  • Cmd+o: Open file
  • Cmd+^: Increase font size
  • Cmd+-: Decrease font size
  • Cmd+0: Reset font size
• One column mode: continuous scroll like PDF
• Open file with arguments

Quote from https://book.systemsapproach.org/

Usage

1. Click File > Open File
2. Select epub file
3. View epub

or

1. Open epub file with mu-epub-reader
2. View epub

Installation

Electron Version:

Download app and Install it.

• Download binary from Latest Release

⚠️ This app is not signed. So, it will appear warning about un-signed app.

Web Version:

• https://mu-epub-reader.netlify.com/?bookPath=https://mu-epub-reader.netlify.com/example/childrens-literature.epub
  • ⚠️ Require CORS setting for each epub files
  • 📝 Source: https://github.com/IDPF/epub3-samples/tree/master/30/childrens-literature/EPUB

Development

Build electron app

yarn install
yarn run dist
# output .app to dist/

Load reader/override.js or <AppData>/mu-epub-viewer/override.js if exists.

- macOS: ~/Library/Application Support/mu-epub-viewer/override.js

1. Put custom logic script to reader/override.js
2. Restart app
3. mu-epub-reader preload reader/override.js in renderer process.

override.js example: modify request url

const origOpen = XMLHttpRequest.prototype.open;
XMLHttpRequest.prototype.open = function (...args) {
    const originalURL = args[1];
    const url = new URL(originalURL);
    /// hack something...
    args[1] = url.toString();
    origOpen.apply(this, args);
};

Related

• azu/mu-pdf-viewer: PDF viewer on electron.
  • PDF Viewer
• Epub.js library

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

License

MIT