🚀 Getting Started
What is Koodo Reader?
- Koodo Reader is an all-in-one eBook reader that can help you better manage and study your eBooks. It's free and open-source.
How sync works?
- You need to change the storage location to the same sync folder on all your computers from the Setting. The sync folder should be located in your OneDrive, Dropbox, Mega, Google Drive, Yandex Disk et al. These cloud drives will handle all the data transferring. When you click the sync button, Koodo Reader will automatically upload or download your data from this folder and keep data synchronized across all you computers.
- Step by step tutorial:
- clear everything located in your sync folder on both of your computers
- Import books in one computer, change the storage location to your sync folder and press sync button. You can change storage location in the Setting
- change storage location to your sync folder on the other computer, exit and reopen Koodo Reader.
- now you should see all your books being synced, you're ready to use the sync function
- from now on, all you need to do is to make some change on one computers, press sync button, and reopen Koodo Reader on the other computer
- you should see the sync button turns blue, press the sync button
- you should see all the change is being synced
Where does Koodo Reader store all my data?
- Desktop Version: You can find this path in Setting → Change storage location, the koodo-reader folder is where Koodo Reader stores all your data.
- Web Version: All your data is stored locally in your browser cache. Other than you, nobody can access these data. when you visit web version on a different computer or browser, you need to reimport your book in order to read it.
How to reach out to the developer?
- Please visit the following link to contact us
What's the future plan for Koodo Reader?
Check our Koodo Reader's Roadmap through the following link: https://koodoreader.com/en/roadmap
What's the difference between developer version and stable version?
- You can found two download options in the Github Repo: stable version and developer version. These two version are differentiated for development purpose. So we can have more flexibility on releasing and testing. Developer version will eventually become the stable version following tons of updates and fix. It will not be pushed to general users, and can only be downloaded from Github Release. If you want to enjoy the latest features and bug fix, and don't care about occasional encounter with some bugs, you can try the developer version. Otherwise, we suggest that you should stay at the stable version and wait for update notification.
The difference of installation packages on Windows
- Installer: You can choose the installation path and permission, create shortcut while installing
- Portable: Run Koodo simply by double click on the package, takes longer to boost
- Binary: Uncompress the zip file to wherever you want, Run Koodo by clicking the exe file from the uncompressed folder
Keyboard shortcut
- Next page: Down key, Right key or Space key
- Prev page: Up key or Left key
- Hide reader: Tab key
- Hide window frame and background: F12
- Enter or exit fullscreen: F11
🗂 Troubleshooting
TTS not working on Linux
- Check out this link for reason and solution：https://askubuntu.com/questions/761975/chromium-is-not-generating-voice
macOS users get “Koodo Reader” is damaged and can’t be opened. You should move it to the Bin.
- This has something to do with macOS's security mechanism, you can follow the steps in this article to solve it.
Some azw3 and mobi books have garble characters
This is because compression algorithm (Huff/cdic algorithm) in this book is not supported by Koodo Reader yet. You can convert this book to azw3 or epub with Calibre before you import it.
Images are not showing or shows red error message in some epub books
- This is because this books is not packaged with industry standard (Use relative path as image path, or contains unsupported entities). To solve this problem, convert this book to epub with Calibre
Reader doesn’t show any content or respond to your operations
- There is something wrong with the book you’re opening. See if you can open it with some other readers
- The book you’re opening is too large and your computer doesn’t have enough memory or CPU capacity to process it.
After using Google Drive to synchronize data, some PDF books show an error that the book does not exist
- Google Drive automatically identifies PDF files and adds a file extension, causing Koodo Reader to be unable to find the original file. Manually removing the extension can fix this issue
🤝 More
How to deploy web version of Koodo Reader?
- Deploy with web server like Nginx and Apache
First download the repo to your computer and set up your node and yarn environment, node version should be larger than 14. Open your command line tool in the root folder, enter 'yarn' to install all the dependencies, and enter 'yarn build' to complier the source code. After that, you'll found a 'build' folder in the root folder containing all the files needed for deployment.
- Deploy with Vercel and Netlify
Fork this repo to your Github account, and import the repo in your Vercel or Netlify Dashboard
Koodo Reader’s function limitation
- Koodo Reader can’t extract the cover and ISBN from mobi and azw3 files.
- Some azw3 files can’t be imported due to the inability to analyze their compression algorithm.
- Web version of Koodo Reader doesn’t support Webdav protocol.
- We won’t accept feature requests to modify the layout of pdf readers. We don’t maintain this part of code. Any features should be requested in
User guide for web version of Koodo Reader?
- Your books will be cleaned up if you clear browser cache
- We recommend visiting web version with Chrome/Edge/Yandex Browser. Firefox/Safari/IE haven't be properly tested.
When will Koodo Reader connect to the internet?
- Google Analytics is turned on by default in Koodo Reader. Koodo Reader will send Startup event to Google at first launch. We won't record your usage or send your data from then on. The purpose is to know the number of Koodo's daily and monthly active users and their geographical distribution. You can turn it off in the Setting→Disable analytics service
- When backing up or restoring your data with Dropbox or Webdav. We will access your files located in the /Apps/KoodoReader from Dropbox and /KoodoReader from Webdav
- Koodo Reader will send a request to https://koodo.960960.xyz/api/update to search for available update
- Koodo’s translation functions rely on Bing and Google
License statement
- This project is licensed under AGPL-v3.0. According to this license, your project must be open sourced with the same license if you use any part of our code. In addition, you must also clearly indicate in a prominent location during distribution and within the software that your project is based on Koodo Reader and provide a link to our GitHub repository.
- The majority of open-source libraries that this project depends on are licensed under MIT, Apache 2.0, BSD, ISC, and CC0-1.0. Only 7zz-wasm are licensed under LGPL, and no libraries licensed under GPL and AGPL are used. The full list is as below:
Privacy statement
- Koodo use Google Analytics to collect anonymous data. The purpose is to know the number of Koodo's daily and monthly active users and their geographical distribution. You can turn it off in the Setting→Disable analytics service
- Nearly all of Koodo’s online functions relies on third party free service. It is just not financially possible for us to host your books or build an account system.
We hope you could continue to enjoy your experience of using Koodo Reader as we are actively improving and building new features!