Installation

Steps 1 through 4 are mandatory. Everything marked as "Optional" is optional.

Not all versions of KOReader are supported or will be supported. If you upgrade KOReader, you will need to upgrade Project: Title, and if there is no version of PT yet for that version, it will be blocked from loading. You would then have to choose between downgrading KOReader or waiting for an update from us. If you really like using this plugin, we strongly recommend waiting to upgrade KOReader once you've made sure there's a new version of PT out for it.

Step 1: Download the plugin and prepare your device

• Download Project Title from the releases page.
  • Project Title releases are for specific versions of KOReader. Make sure you are running the exact version listed for the release you downloaded.
• Before plugging your device in: DO NOT SKIP THIS STEP!!!
  • Show the top menu for KOReader.
  • Tap the wrench icon, "More tools", "Plugin management", and disable (uncheck) "Cover browser".
  • Tap "Restart Now."
• Plug in your device via USB to your computer.

Step 2: Locate the KOReader installation folder

• In the steps below, [koreader]/ means the folder that KOReader is installed to, on your device. This is different depending on what device you have:
  • On Kobo: /.adds/koreader/
  • On Kindle: /koreader
  • On Android: koreader at the root of your onboard storage
  • On Pocketbook: /applications/koreader
  • On Cervantes: /mnt/private/koreader

Step 3: Install the plugin

• Open the zip file and copy the folder projecttitle.koplugin to the [koreader]/plugins folder on your device.

Step 4: Finish by enabling the plugin

• Eject your device. Show the top menu for KOReader. Tap the wrench icon, "More tools", "Plugin management", and enable (check) "Project Title". Tap "Restart Now." and you should see the new interface.

A Note on book scanning

• Project: Title uses a separate cache from Cover Browser, so all of your books will have to be scanned again.
• Project: Title can seem really slow compared to Cover Browser at first because of this scanning. It will be much faster once your books are scanned. Cover Browser works the same way, but if you have been using it for a while, it may have been a long time since those initial scans.
• To make this better, I strongly recommend you tap the "menu" icon in the upper-right of the screen, and tap "Extract and cache book information" when in your home screen. This will scan in all of your books at once, while you go do something else. Leave your reader plugged in and charging! How long it takes depends on how old your device is and how many books you have. It could take 2 minutes or it could take 20. But I think getting it done and over with at once is better.

Optional: Gestures

Several new gestures are available under "File browser" marked with the plugin name.

• Increase Items Per Page: This fits more items on the screen which results in smaller covers. Suggestion: Map under Pinch
• Decrease Items Per Page: This fits fewer items on the screen which results in larger covers. Suggestion: Map under Spread
  • Note: In cover grid mode, the change only happens when you are using the same number for columns and rows. ie: 3x3 will change to 2x2 or 4x4, but an uneven 4x2 will never change in either direction.
• Cover Grid: Sets display mode to Cover Grid.
• Cover List: Sets display mode to Cover List.

Optional: Display settings and autoscan feature

New settings are available by going to the top menu in KOReader, tapping the filing cabinet, "Settings", and then the sub-menu for this plugin.

• The top items adjusting items per page should be self-explanatory. The options below adjust various features related to the display of folders, books, the footer, etc. Experiment to find your favorites.
• Under "Book covers and info cache" you will find actions that will prune or empty the cache, as well as the current size of the cache.
• The "scan home folder for new books automatically" option will (if any only if you have manually picked a home folder in KOreader) automatically scan for new books added to your device whenever KOReader restarts or is disconnected from a USB sharing session. You can stop the autoscan at any point by tapping the screen, so you're never stuck waiting for it to finish.

Optional: User Patches

Included are a couple KOReader user patches that I have included because they make other aspects of KOReader match the look of the plugin. There are also some not-included user patches I've written that you might be interested in as well. You can find them here: User Patches for Project Title

Uninstall

Thanks for giving it a try! If you didn't like how it looks, that's okay. But if you're uninstalling because you couldn't get it to work, or something was broken, please consider opening a bug report.

• To disable the plugin: re-enable "Cover Browser" from the plugins menu and restart KOReader.
• To completely remove the plugin: Delete the projecttitle.koplugin folder from your device. You may also delete the PT_bookinfo_cache.sqlite file from the KOreader settings folder, and the additional fonts and icons.

Old manual font and icon install steps

These steps are no longer needed with versions 3.5 and higher, but if you are installing an older version here's what you need to do during "Step 3" above

• Inside the [koreader]/plugins/projecttitle.koplugin folder, locate and copy the fonts folder to [koreader]/ Add the new fonts to the existing folder. Do not make a /fonts/fonts folder.
• Inside the projecttitle.koplugin folder, locate and copy the icons folder to [koreader]/ Add the new icons to the existing folder, if there is one. It is fine if there isn't. Do not make an /icons/icons folder.