Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/azu/mu-epub-reader
Epub viewer on Electron that support text translation.
https://github.com/azu/mu-epub-reader
app electron epub software translation viewer
Last synced: 3 months ago
JSON representation
Epub viewer on Electron that support text translation.
- Host: GitHub
- URL: https://github.com/azu/mu-epub-reader
- Owner: azu
- License: mit
- Created: 2019-09-14T00:20:10.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-09T07:17:33.000Z (over 1 year ago)
- Last Synced: 2024-10-23T13:35:00.770Z (3 months ago)
- Topics: app, electron, epub, software, translation, viewer
- Language: JavaScript
- Size: 4.31 MB
- Stars: 77
- Watchers: 7
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mu-epub-reader
Epub viewer on Electron.
This application is forked of [futurepress/epubjs-reader: Epub.js Reader](https://github.com/futurepress/epubjs-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
## 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](https://github.com/azu/mu-epub-reader/releases/latest)
:warning: This app is not signed. So, it will appear warning about un-signed app.
**Web Version**:
-
- :warning: Require CORS setting for each epub files
- :memo: 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 [`/mu-epub-viewer/override.js`](https://electronjs.org/docs/all#appgetpathname) 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
```js
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);
};
```
## Release
npm version patch
git push --tags && git push
## Related
- [azu/mu-pdf-viewer: PDF viewer on electron.](https://github.com/azu/mu-pdf-viewer)
- PDF Viewer
- [Epub.js](https://github.com/futurepress/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