Koodo Reader Logo

Document

🚀 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?
Where does Koodo Reader store all my data?
Koodo Reader is a local-first e-book reader, and all your data is saved locally on your device by default:
  • Desktop Version: You can go to Settings > General and find the option to change the storage location. Click the locate button next to the option, and it will navigate you to your book library location.
  • Web Version: If you access the web version using Chromium-based browsers like Chrome or Edge, you will see a dialog box prompting you to choose a data storage location upon your first visit. You can choose to save the data in a specified local folder or in the browser cache. If you are using other browsers, the data will only be saved in the browser cache by default. (Security Note: If your data is stored in the browser cache, the system may automatically clear the cache once it exceeds a certain size, which could result in data loss. It is recommended to back up your data regularly or upgrade to the Pro version to sync your data to cloud storage, WebDAV, object storage, Docker, etc.)
  • Mobile Version: Your data is stored in the application data folder allocated by the system for Koodo Reader. This folder is generally not directly accessible. If you need to clear the cache or delete all data, you can go to Settings and scroll to the very bottom to find the corresponding options.
How to reach out to the developer?
What's the future plan for Koodo Reader?
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.
How to Enable Bionic Reading?
Due to potential patent risks associated with bionic reading, we no longer include this feature by default. However, you can still enable bionic reading by installing a bionic reading font. You can download the font from Born2Root/Fast-Font: This font provides faster reading through facilitating the reading process by guiding the eyes through text with artificial fixation points., then install it on your system or import it into the app. After that, simply switch to this font from the font list to activate bionic reading.
How to Import External Fonts?
Koodo Reader uses only the fonts already installed on your operating system. You can double-click the font file to install it on your operating system, then restart Koodo Reader. After that, you will be able to see your font in the font list.
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
Importing books on Linux failed unexpectedly
Some third-party libraries depend on specific versions of glibc. If the required version of glibc is not installed on your device, this issue may occur. First, open the console and check the error message to identify the missing glibc version on your system. Then, refer to this answer to install the corresponding version of glibc: How can I get glibc 2.35 on Ubuntu 20.04? - Ask Ubuntu
App Flickering on Linux with Wayland
This is commonly on Linux with Nvidia GPU, You can attach this to the start command to solve this problem.
--enable-features=UseOzonePlatform --ozone-platform=wayland
Unable to run AppImage package on Linux
Please add --no-sandbox after the command.
macOS users get “Koodo Reader” is damaged and can’t be opened. You should move it to the Bin.
If you encounter this warning on macOS, this is due to security restrictions for unsigned applications. Follow these steps to resolve it:
  1. System Preferences Method
      • Open System Preferences > Security & Privacy > General tab.
      • Click the "Open Anyway" button (if available) next to the blocked application.
  1. Terminal Command Method
      2. If the above fails:
      • Open Terminal (via Spotlight or Applications/Utilities).
      • Run this command to clear security attributes:
          • sudo xattr -c /Applications/Koodo\\ Reader.app
      • Press Enter, then enter your administrator password when prompted.
      • Try opening the application again.
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
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.
  • Koodo Reader doesn’t use any analysis services like Google Analytics
  • 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!
Â