Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/troyeguo/koodo-reader
A modern ebook manager and reader with sync and backup capacities for Windows, macOS, Linux and Web
https://github.com/troyeguo/koodo-reader
book cb7 cbr cbt cbz comic docx ebook epub fb2 html markdown mobi pdf reader rtf txt xml
Last synced: 3 months ago
JSON representation
A modern ebook manager and reader with sync and backup capacities for Windows, macOS, Linux and Web
- Host: GitHub
- URL: https://github.com/troyeguo/koodo-reader
- Owner: koodo-reader
- License: agpl-3.0
- Created: 2020-03-05T02:18:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-09T05:19:35.000Z (7 months ago)
- Last Synced: 2024-04-13T20:53:06.215Z (7 months ago)
- Topics: book, cb7, cbr, cbt, cbz, comic, docx, ebook, epub, fb2, html, markdown, mobi, pdf, reader, rtf, txt, xml
- Language: JavaScript
- Homepage: https://koodoreader.com
- Size: 63.7 MB
- Stars: 15,418
- Watchers: 103
- Forks: 1,191
- Open Issues: 378
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-web-cn - koodo-reader - 一个用来管理你的电子书的桌面端软件 (Uncategorized / Uncategorized)
- awesome-github - Koodo, a cross-platform ebook reader
- Awesome-Daily - Koodo Reader
README
[简体中文](https://github.com/koodo-reader/koodo-reader/blob/master/README_cn.md) | [हिंदी](https://github.com/koodo-reader/koodo-reader/blob/master/README_hi.md)
|[Português](https://github.com/koodo-reader/koodo-reader/blob/master/README_pt.md) | English
Koodo Reader
A cross-platform ebook reader
[Download](https://koodoreader.com/en) | [Preview](https://web.koodoreader.com) | [Roadmap](https://koodoreader.com/en/roadmap) | [Document](https://koodoreader.com/en/document) | [Plugins](https://koodoreader.com/en/plugin)
## Preview
## Feature
- Format support:
- EPUB (**.epub**)
- PDF (**.pdf**)
- DRM-free Mobipocket (**.mobi**) and Kindle (**.azw3**, **.azw**)
- Plain text (**.txt**)
- FictionBook (**.fb2**)
- Comic book archive (**.cbr**, **.cbz**, **.cbt**, **.cb7**)
- Rich text (**.md**, **.docx**)
- Hyper Text (**.html**, **.xml**, **.xhtml**, **.mhtml**, **.htm**, **.htm**)
- Platform support: **Windows**, **macOS**, **Linux** and **Web**
- Save your data to **OneDrive**, **Google Drive**, **Dropbox**, **FTP**, **SFTP**, **WebDAV**, **S3**, **S3 Compatible**
- Customize the source folder and synchronize among multiple devices using OneDrive, iCloud, Dropbox, etc.
- Single-column, two-column, or continuous scrolling layouts
- Text-to-speech, translation, dictionary, touch screen support, batch import
- Add bookmarks, notes, highlights to your books
- Adjust font size, font family, line-spacing, paragraph spacing, background color, text color, margins, and brightness
- Night mode and theme color
- Text highlight, underline, boldness, italics and shadow
## Installation
- Desktop Version:
- Stable Version (Recommended): [Download](https://koodoreader.com/en)
- Developer version: [Download](https://github.com/koodo-reader/koodo-reader/releases/latest) ( With new feature and bug fix, but may induce some unknown bugs)
- Web Version：[Preview](https://web.koodoreader.com)
- Install with Scoop:
```shell
scoop bucket add extras
scoop install extras/koodo-reader
```
- Install with Winget:
```shell
winget install -e AppbyTroye.KoodoReader
```
- Install with Homebrew:
```shell
brew install --cask koodo-reader
```
- Install with Docker:
```bash
docker-compose up -d
```
- Install with Flathub:
```shell
flatpak install flathub io.github.troyeguo.koodo-reader
flatpak run io.github.troyeguo.koodo-reader
```
## Screenshot
List mode
Cover mode
Reader menu
Dark mode
## Develop
Make sure that you have installed yarn and git
1. Download the repo
```
git clone https://github.com/koodo-reader/koodo-reader.git
```
2. Enter desktop mode
```
yarn
yarn dev
```
3. Enter web mode
```
yarn
yarn start
```
## Translation
### Edit current language
1. Select your target language from the following list.
2. Click the view button to examine the source file. The untranslated terms are listed at the bottom of each file.
3. Translate the terms to your target language based on the given English reference
4. Sumbit the translation file or just translation snippets based on the amount of your translation to [this link](https://github.com/koodo-reader/koodo-reader/issues/new?assignees=&labels=submit+translation&projects=&template=3_submit_translation.yml). Pull request is also welcomed.
| Language(A-Z) | Code | View |
| --------------- | ----- | --------------------------------------------------- |
| Arabic | ar | [View](./src/assets/locales/ar/translation.json) |
| Armenian | hy | [View](./src/assets/locales/hy/translation.json) |
| Bengali | bn | [View](./src/assets/locales/bn/translation.json) |
| Bulgarian | bg | [View](./src/assets/locales/bg/translation.json) |
| Chinese (CN) | zh-CN | [View](./src/assets/locales/zh-CN/translation.json) |
| Chinese (MO) | zh-MO | [View](./src/assets/locales/zh-MO/translation.json) |
| Chinese (TW) | zh-TW | [View](./src/assets/locales/zh-TW/translation.json) |
| Czech | cs | [View](./src/assets/locales/cs/translation.json) |
| Danish | da | [View](./src/assets/locales/da/translation.json) |
| Dutch | nl | [View](./src/assets/locales/nl/translation.json) |
| English | en | [View](./src/assets/locales/en/translation.json) |
| Esperanto | eo | [View](./src/assets/locales/eo/translation.json) |
| Finnish | fi | [View](./src/assets/locales/fi/translation.json) |
| French | fr | [View](./src/assets/locales/fr/translation.json) |
| German | de | [View](./src/assets/locales/de/translation.json) |
| Greek | el | [View](./src/assets/locales/el/translation.json) |
| Hindi | hi | [View](./src/assets/locales/hi/translation.json) |
| Indonesian | id | [View](./src/assets/locales/id/translation.json) |
| Interlingue | ie | [View](./src/assets/locales/ie/translation.json) |
| Italian | it | [View](./src/assets/locales/it/translation.json) |
| Japanese | ja | [View](./src/assets/locales/ja/translation.json) |
| Korean | ko | [View](./src/assets/locales/ko/translation.json) |
| Persian | fa | [View](./src/assets/locales/fa/translation.json) |
| Polish | pl | [View](./src/assets/locales/pl/translation.json) |
| Portuguese | pt | [View](./src/assets/locales/pt/translation.json) |
| Portuguese (BR) | pt-BR | [View](./src/assets/locales/pt-BR/translation.json) |
| Romanian | ro | [View](./src/assets/locales/ro/translation.json) |
| Russian | ru | [View](./src/assets/locales/ru/translation.json) |
| Slovenian | sl | [View](./src/assets/locales/sl/translation.json) |
| Spanish | es | [View](./src/assets/locales/es/translation.json) |
| Swedish | sv | [View](./src/assets/locales/sv/translation.json) |
| Tamil | ta | [View](./src/assets/locales/ta/translation.json) |
| Thai | th | [View](./src/assets/locales/th/translation.json) |
| Tibetan | bo | [View](./src/assets/locales/bo/translation.json) |
| Turkish | tr | [View](./src/assets/locales/tr/translation.json) |
| Ukrainian | uk | [View](./src/assets/locales/uk/translation.json) |
| Vietnamese | vi | [View](./src/assets/locales/vi/translation.json) |
### Add new language
1. If you can't find your target language from the above list, Download the Engish source file from [this link](./src/assets/locales/en/translation.json)
2. When you finish translation, submit the source file to [this link](https://github.com/koodo-reader/koodo-reader/issues/new?assignees=&labels=submit+translation&projects=&template=3_submit_translation.yml). Pull request is also welcomed.