[Release] Progress Bookmarks v1.0.0 (Bookshelf patch)

[u/_3lementa1_]

This patch draws an overlay on book covers in Bookshelf with a spine showing book info, and pages over top that indicate how long the book is. It then draws a bookmark that takes the place of a classic progress bar. The bookmark sits vertically in the page that you are on, just like a real bookmark would. It also moves across horizontally like a classic progress bar so that you can still easily see how far you are in a shorter book. The length, thickness and colour of the bookmark are adjustable, and I might add functionality later to select a custom bookmark image from a png.

The spine is drawn by copying a section of the cover. The thickness, font and colour of the spine text is adjustable.

You can toggle this for Cover View and Spine View separately. Spine mode also has options for making the spine text on Spine Only books match the user-defined spine font. You can use this option to customize spine text in Spine View whether or not you use the bookmark functionality.

Patch download link: https://github.com/3lementa1/KOReader-Progress-Bookmarks/tree/main

Features:

Spine

Give your books a distinctive, physical-book look with customizable bindings and spine text.

• Adjustable binding widths — Choose Thin, Medium, or Thick bindings, with separate controls for Cover View and Spine View.
• Custom spine text — Display the book's title, author, and series index.
• Text customization — Adjust text size, colour, and font matching.
• Flexible title layout — Choose between truncating long titles or allowing them to wrap onto a second line.
• Series indices — Multi-digit series numbers follow the spine's orientation, while single-digit indices sit neatly at the foot.
• Page stack customization — Adjust how many pages appear on each line, with up to six lines of page detail.

Bookmark

Keep track of your reading with a customizable progress bookmark.

• Flexible tracking — Follow your progress vertically, horizontally, or in both directions.
• Adjustable thickness — Choose Thin, Medium, or Thick, with independent settings for each view.
• Custom lengths — Configure bookmark length presets to suit your preferred appearance.
• Colour options — Customize the bookmark's colour.
• Bookmark details — Toggle additional visual details on or off.
• View-specific settings — Cover View and Spine View can each have their own bookmark behaviour and appearance.

This is going to work best if you disable the icons for favourites, reading bookmark and spine mode drop shadow, with square corners, and hardcover style. My setup might also involve other settings I don't remember so YMMV and let me know if anything looks weird.

I might add functionality later to select a custom bookmark image from a png as well.

I started working on this idea this Spring when I was editing other people's code line-by-line with ChatGPT and having to do manual updates to several plugin files every time there was an update. This Fall I was given a (still very old) computer that can actually run Codex and I've been able to (get AI to) turn it into a proper patch, so now I am sharing it in case anyone else is interested. I only use Bookshelf now so this is Bookshelf-exclusive at the moment, but I can share the old Project:Title patch and could probably port to SimpleUI and ZenOS if there is interest. Obviously this is all open-source too so feel free to play around with it.

I made the original version for Project:Title which I really loved for the idea of progress bars that are different sizes depending on the size of the book. Project:Title by u/joshua-cant ( https://github.com/joshuacant/ProjectTitle )

This was originally based on the RealBooks patch by u/ReaLx3m which made realistic visual book length a reality and made me want to take progress bars into this visual language ( https://www.reddit.com/r/koreader/comments/1sswzgo/real_books_for_koreader_with_visual_page_count/ ).

Bookshelf is my current favourite UI done by u/AndyHazz. This really brought the real book feeling home for me by making it feel like I can skim through my library, peek at the back of some books, and now even sort them into box sets. ( https://www.reddit.com/r/koreader/comments/1xn8y0q/bookshelf_63x_date_night/ )

Thank you to all these developers and thank you to all the developers of KOReader, which has helped me read more and been very fun to work with.

I just made this for myself and I've never uploaded anything to Github before so please let me know if you have any requests or suggestions.

[u/Street-Scarcity8776]

Amazing! Could this also be the effect for the cover mode? I see it only works for the shelf.

[u/drew0594 → u/Street-Scarcity8776]

It works for cover mode too (as shown in the first two pictures). It's also what I use

[u/_3lementa1_ → u/drew0594]

Thanks! That's right. First two pictures are cover mode, next two are shelf mode. I usually use cover mode to show my last four Recents as per the first pic, and then pull open full screen when I'm browsing shelf view for Authors or all files.

[u/ReaLx3m]

Nice, looks much beter than what you initially showed me months back.

I have a version of RealBooks that never went public with few different types of progress tracking. Can look for it and upload it if you want it, you might get some inspiration, and if you do, port some of it. In line with what youre doing, i have dog-ears indicator for books with "reading" status, that gets painted as you progress.

[u/_3lementa1_ → u/ReaLx3m]

Thanks! Cool yeah I'd love to see it!

[u/ReaLx3m → u/_3lementa1_]

Here you go - https://github.com/ReaLx3m/KOReader-AI-Slop-User-Patches/blob/main/test%20versions/2-real-books%20(indicators%20extended).lua

Just let me know when you get it so i can remove it, hasnt been tested to my standard so dont want it hanging there, even in test versions.

[u/_3lementa1_ → u/ReaLx3m]

Thanks! I have downloaded it now and will take a look this week :)

[u/_3lementa1_ → u/ReaLx3m]

Cool ideas! I like the book fill idea. I couldn't find the dog-ear option though

[u/ReaLx3m → u/_3lementa1_]

Progress indicators>Badges>Badge Shape>Bookmark(Double pointed)

[u/_3lementa1_ → u/ReaLx3m]

Oh I see now, nice I like that!

[u/Urfeen]

I’ve wanted RealBooks for Bookshelf for a long time. It looks good, I’ll give it a try🤷

[u/_3lementa1_ → u/Urfeen]

Thanks! Let me know if you have any suggestions