🚀 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.
- Stable Version Operation Process:
- Ensure that the sync folders exist on both computers and that there are no files within these folders.
- On one computer, import the books, navigate to settings to change the data storage location to the sync folder, and click the sync button.
- On the other computer, wait for the sync data to finish downloading, open Koodo Reader, go to Settings → General, change the data storage location to the sync folder, then exit and reopen Koodo Reader.
- The data is now synchronized to the other computer. In the future, any modifications made on either computer can be synchronized by clicking the sync button on one computer, then opening Koodo Reader on the other computer and clicking the sync button.
- Latest Development Version - Free Edition Operation Process:
- On one computer, import the books, navigate to settings to change the data storage location to the sync folder, click the sync button, and then close the software.
- On the other computer, wait for the sync data to finish downloading, open Koodo Reader, go to Settings → General, select 'Switch Library', change to the sync folder, click the sync button, then exit and reopen Koodo Reader.
- The data is now synchronized to the other computer. In the future, any modifications made on either computer can be synchronized by clicking the sync button and closing the software on one computer, then opening Koodo Reader on the other computer and clicking the sync button.
- Latest Development Version - Pro Edition Operation Process:
- On the two devices that need to synchronize data, bind the same data source. The synchronization methods are as follows: on the desktop and web versions, click the sync button at the top; on the mobile version, pull down on the homepage. During synchronization, we compare the data differences between the local and cloud, upload the locally changed content to the cloud, and download the data that is missing or needs updating from the cloud to the local device.
- On any device participating in synchronization, the local and cloud data will be automatically merged, so you don't need to worry about data being overwritten and lost.
- During the synchronization process, ensure that you do not operate the synchronization on multiple devices simultaneously. Wait until one device has successfully synchronized before operating another.
- Following the above principles, whenever local data changes in the future and you need to retrieve the updated data on other devices, simply perform the synchronization operation on both devices sequentially.
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.
TXT format books appear garbled
- Koodo Reader already supports most text encodings for txt files. If you still encounter garbled text issues, please refer to the following steps
- First, please verify if the ebook displays garbled text in other text editors
- If there is no garbled text, please save the file as UTF-8 encoded, then import it into Koodo Reader
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
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.
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 Reader is a local reader that can be used without registration. We do not collect or upload your reading data and private information.
- Starting from version 1.5.2, Koodo Reader no longer includes any analysis services like Google Analytics
- Please note that when the software starts, it will send an update check request to our remote server, which includes your system language information, used to return update logs in the corresponding language. You can disable update checks in settings
We hope you could continue to enjoy your experience of using Koodo Reader as we are actively improving and building new features!