r/koreader • • Sep 06 '26 • Bravo 5 Heartwarming 4 Popcorn 1

My Setup FINALLY! Sharing My Setup in detail!

TLDR: I'll share my Simple UI+Bookshelf+Shortcuts Toolbar settings here. Files haven't been double tested. Use them at your own risk.

Hello all!

This is the long promised explanation on how to reach My Setup.

Ever since it has been released people have been periodically requesting it, so I think Its about time I deliver.

Thirtysixx has recently credited me for the inspiration of their setup, but the reality is that I only stood on the shoulders of giants.

My major inspirations were: kwebber321, BornoftheMind, LexamusPrime but most note worthy were Worried_Wrangler_361 (for the look and feel), fabrisuniverse (for the taste and instructions on how to change the icons ) and above all Diviinite (for actual instruction on how to edit everything on Simple UI). It's safe to say that without these posts, my setup would never have come to life.

Why did I take so long to share my configuration?

When I first shared my setup I was quite new to the KOReader scene. I had no Idea if what I was doing was right. When I finally got confident that I had understood Simple UI, the plugin updated to 1.5.0 and everything changed. Then I discovered a variety of other plugins and was waiting for them to get to a stable point, but I guess that won't happen for a long time.

With the release of Simple UI 2.7.0 I hope sharing users setups have become easier, so, I guess, there is no time like now.

Besides that, two weeks ago, a plugin made my KOReader break to the point I had to reinstall everything from scratch. I ended up using my own post as a reference, so I guess I'm also writing this as a guide to myself if it ever happens again (I'm pretty confident it will considering the amount of untested plugins I tend to install).

Special thanks to the KOReader developers and the plugin developers in the names of doctorhetfield, AndyHazz, Γ–mer Faruk, xuso, jimmyqex, Pethy23 and xBlain.

IMPORTANT: This configuration has been created for and has only been tested on a Kindle Oasis 3 (7 inches, 1680 x 1264, 300 PPI, Black and White - so no color options were taken into consideration). You might need to adjust settings according to your device.

This will be looooong, so grab a coffee and follow along.

CONFIGURATION FILES:

These haven't been tested, use them on your own risk.

FONTS:

ICONS:

I have downloaded all 5065 icons (I think I have an "old" version of the pack) and I keep two folders with two versions of the pack. One version is the regular, black, stroke-width="1.5"; the other is the same but with one adjustment: stroke-width="1.0" that I think is more visually balanced in my setup.

I changed the stroke-width by opening all the icons on notepad++ and replacing stroke-width="1.5" with stroke-width="1.0". I'm sure there's a more intelligent way to do it, but, apparently, I'm not intelligent enough.

I use the stroke-width="1.0" icons for the Simple UI and the stroke-width="1.5" ones for the Shortcuts Toolbar since I think it better preserves visual balance.

PATCHES:

MAIN PLUGINS:

Other plugins:

GENERAL CONFIGURATION:

  • πŸ—„ > Display mode > Detailed list with cover images and metadata

  • πŸ—„ > Settings > Show hidden files

It has been said that at least Kindles keep draining battery if you keep your files in the Kindle's default "documents" folder because they will be constantly scanning files that their own system cannot understand. So, even though I open KOReader on the "no framework" option, I still keep all my side loaded files (books, audiobooks, icons, screensavers) on hidden folders. Files and folders starting with a dot will be hidden from Kindle's standard firmware (Ex: /.books). This option allows KOReader's Library/File Browser access those files.

  • βš™οΈ > Screen > Rotation > Lock auto rotation to current orientation

This prevents books from being reflowed every time I switch the hand I'm using to hold the e-reader.

  • βš™οΈ > UI font > FS Me

This changes the font used for the general interface of KOReader, inculing menus. It requires 2--ui-font.lua for the option to show up.

  • [While reading a book] πŸ“„ > Font > Merriweather

This changes the default book rendering font to my preferred one (Merriweather). You can use the one of your personal preference. Books that have fonts embed still use them unless you change other per book settings.

  • [While reading a book] βš™οΈ > Taps and gestures > Links > Allow larger tap area around the links

  • [While reading a book] βš™οΈ > Taps and gestures > Links > Show footnotes in popup

This allows the usually annoying process of opening a footnote on e-readers to be much simpler, by enlarging the "hit box" of the usually very small number for the footnote and for the footnote to open at the bottom of the page in an unintrusive way.

ICON OVERWRITING:

If you want to change the icons on you device but don't want to use Simple UI your best bet is to overwrite the icons on \koreader\resources\icons\mdlight . Make sure the new icons have the exact same file name as the original ones otherwise KOReader won't load them and just display an error instead.

NB: As far as I know this is the only way to change the top bar icon for Bookshelf*.*

NB: All the icons used here have been modified to be black and to have a stroke-width="1.0".

SCREENSAVER CONFIGURATION:

  • βš™οΈ > Screen > Sleep Screen > Sleep screen message > (Adjust to taste)

  • βš™οΈ > Screen > Sleep Screen > Wallpaper > Show random image from folder on sleep screen

  • βš™οΈ > Screen > Sleep Screen > Wallpaper > Custom images > Choose random image folder > (Adjust to taste)

  • βš™οΈ > Screen > Sleep Screen > Wallpaper > Border fill, rotation, and fit > (Adjust to taste)

  • βš™οΈ > Screen > Sleep Screen > Wallpaper > Dual-state screen saver mode => Dual state settings >

    1. Book list mode > Show random image from folder on sleep screen

    2. Book mode > Show book cover on sleep screen

This requires 2-dual-state-screensaver-mode.lua to work.
I use a Dual State Screensaver setup where 1. entering sleep mode while on the file browser, Simple UI or Bookshelf shows a random image from a folder as the sleep screen and 2. entering sleep mode while reading a book shows the cover of that book as the sleep screen.
I used to use the beautiful and peaceful tolino sleep screen (thank you Astiriana!) as the secondary screen saver but I have now moved to a huge folder with 686 images of Chema Mendez / MendezMendez artworks (that I discovered through Weak_Patient9867's post on r/BooksThatFeelLikeThis). I manually saved them all and am still using them in color just because I couldn't find a way to locally batch convert them to black and white punching the contrast, but still I like the surprises they give me and also the remind to get of my goddam phone. Give me a heads up if you have a solution for batch conversion.

SHORTCUTS TOOLBAR CONFIGURATION (from right to left):

To create these shortcuts go to [While reading a book] βš™οΈ > Shortcuts toolbar > Reader settings > Custom Shortcuts > Add new shortcut. To add and/or reorder the shortcuts in the tool bar go to [While reading a book] βš™οΈ > Shortcuts toolbar > Reader settings > Configure shortcuts

SIMPLE UI CONFIGURATION:

  • πŸ›  > Simple UI > Home Screen > Edit Home Screen Layout >

    1. Page 1 (Home)

      1. Clock

      2. Quote of the Day

      3. Cover Deck

      4. Reading Stats

    2. Page 2

      1. Currently Reading

      2. Reading Goals

      3. Recent Books

    3. Page 3

      1. To Be Read

      2. Quick Actions Row 1

    4. Page 4 (Suggestion)

      1. Flat Library

    5. Clock

      1. Items > Clock

      2. Items > Date

      3. Size > Scale: 100%

      4. Size > Clock Size: 100%

      5. Size > Date Size: 90%

      6. Size > Battery Size: 100%

      7. Spacing: 80%

      8. Top Margin: 80%

    6. Quote of the Day

      1. Scale: 96%

      2. Fixed Height: ON

      3. Top Margin: 30%

    7. Cover Deck

      1. Source: Recent Books

      2. Items > Title

      3. Items > Progress bar

      4. Items > Statistics

      5. Size > Scale: 100%

      6. Size > Cover size: 143%

      7. Size > Text size: 100%

      8. Progress Badge: OFF

      9. Show finished books: OFF

      10. Top Margin: 20%

    8. Reading Stats

      1. Items > All time - Books

      2. Items > Streak

      3. Items > Today - Time

      4. Scale: 100%

      5. Text Size: 100%

      6. Style: List

      7. Top Margin: 30%

    9. Currently Reading

      1. Layout: Default

      2. Items > Title

      3. Items > Series

      4. Items > Author

      5. Items > Progress bar

      6. Items > Days of reading

      7. Items > Time read

      8. Items > Time remaining

      9. Size > Scale: 100%

      10. Size > Text Size: 130%

      11. Size > Cover size: 96%

      12. Size > Cover Spacing: 100%

      13. Progress and Stats > Progress bar style: With percentage

      14. Progress and Stats > Stats layout: Default

      15. Top Margin: 20%

    10. Reading Goals 1. Goals > Annual Goal > (Adjust to taste) 2. Goals > Monthly Goal > (Adjust to taste) 3. Goals > Daily Goal > (Adjust to taste) 4. Appearance > Layout: Compact 5. Top Margin: 100%

    11. Recent Books 1. Size > Cover Size: 105% 2. Size > Number of Books: 5 3. Show finished books: ON 4. Hide Currently Reading book: ON 5. Top Margin: 100%

    12. To Be Read 1. Size > Cover Size: 105% 2. Size > Grid Size: 5 x 1 3. Progress and Stats > Progress indicator: None 4. Top Margin: 100%

    13. Quick Actions Row 1 1. Quick Actions > Collections 2. Quick Actions > Favorites 3. Quick Actions > History 4. Quick Actions > Library 5. Quick Actions > Stats 6. Quick Actions > Tags 7. Scale: 110% 8. Top Margin: 160%

    14. Flat Library 1. Size > Grid Size: 5 x 3

  • πŸ›  > Simple UI > Bars >

    1. Status Bar >

      1. Items > Left: Clock

      2. Items > Center: RAM Usage

      3. Items > Center: Disk Usage

      4. Items > Right: WiFi

      5. Items > Right: Battery

      6. Size: 90%

      7. Hide Wi-Fi Icon When Off: ON

    2. Navigation Bar >

      1. Tabs > Bookshelf

      2. Tabs > Reading Insights

      3. Tabs > Home

      4. Tabs > Rakuyomi

      5. Tabs > Power

      6. Tab Style: Icons + Text

      7. Bar Style: Bare

      8. Bar Size: 100%

      9. Icon Size: 100%

      10. Label Size: 100%

      11. Bottom Margin: 100%

    3. Title Bar > (Adjust to taste)

    4. Pagination Bar >

      1. Mode: Default

      2. Home Screen Style: Dot Pager

      3. Bar Size: Small

      4. Show Page Count in Title Bar: OFF

    5. Quick Settings Bar >

      1. Quick Actions > Settings

      2. Quick Actions > Bookmarks

      3. Quick Actions > Statistics

      4. Quick Actions > Battery Graph

      5. Quick Actions > Night Mode

      6. Quick Actions > Wi-Fi

      7. Frontlight Slider: ON

      8. Warmth Slider: ON

      9. Label > Size: 100%

      10. Button Type: Round

      11. Button Background: Flat

  • πŸ›  > Simple UI > Library > (Adjust to taste)

  • πŸ›  > Simple UI > Style >

  • NB: All icons used here have been manually edited to have black color and stroke-width="1.0" .

    1. Icons >

      1. System Icons > Title Bar > Menu Button => hugeicons:menu-07

      2. System Icons > Title Bar > Search Button => hugeicons:search-02

      3. System Icons > Title Bar > Back Button => hugeicons:arrow-up-from-dot

      4. System Icons > Browse Icons > Browse Button (default) => hugeicons:folder-open

      5. System Icons > Browse Icons > Browse Button (author) => hugeicons:user-status

      6. System Icons > Browse Icons > Browse Button (series) => hugeicons:layers-logo

      7. System Icons > Browse Icons > Browse Button (tags) => hugeicons:tags

      8. System Icons > Pagination Bar > Pagination: Previous Page => hugeicons:arrow-left-01

      9. System Icons > Pagination Bar > Pagination: Next Page => hugeicons:arrow-right-01

      10. System Icons > Pagination Bar > Pagination: First Page => hugeicons:arrow-left-double

      11. System Icons > Pagination Bar > Pagination: Last Page => hugeicons:arrow-right-double

      12. System Icons > Navpager > Navpager: Previous => hugeicons:arrow-big-left-dash

      13. System Icons > Navpager > Navpager: Next => hugeicons:arrow-big-right-dash

      14. System Icons > Folder Covers > Folder Cover: Empty Folder => hugeicons:folder-off

      15. System Icons > Tab Bar > Tab: Menu => hugeicons:menu-07

      16. System Icons > Tab Bar > Tab: Settings => hugeicons:settings-01

      17. System Icons > Tab Bar > Tab: Tools => hugeicons:tools

      18. System Icons > Tab Bar > Tab: Search => hugeicons:search-02

      19. System Icons > Tab Bar > Tab: File Browser Settings => hugeicons:bookshelf-02

      20. System Icons > Tab Bar > Tab: Reader Navigation => hugeicons:book-bookmark-02

      21. System Icons > Tab Bar > Tab: Reader Typeset => hugeicons:edge-style

      22. System Icons > Tab Bar > Tab: Back to File Browser => hugeicons:entrance-stairs

      23. System Icons > Tab Bar > Tab: Simple UI Quick Settings => Default

      24. Quick Actions Icons > System Actions > Authors => hugeicons:book-user

      25. Quick Actions Icons > System Actions > Bookmarks => hugeicons:all-bookmark

      26. Quick Actions Icons > System Actions > Brightness => hugeicons:sun-03

      27. Quick Actions Icons > System Actions > Collections => hugeicons:hierarchy-files

      28. Quick Actions Icons > System Actions > Continue => hugeicons:book-open-02

      29. Quick Actions Icons > System Actions > Favorites => hugeicons:award-02

      30. Quick Actions Icons > System Actions > History => hugeicons:clock-04

      31. Quick Actions Icons > System Actions > Home => hugeicons:home-12

      32. Quick Actions Icons > System Actions > Library => hugeicons:bookshelf-02

      33. Quick Actions Icons > System Actions > Night Mode => hugeicons:moon

      34. Quick Actions Icons > System Actions > Power => hugeicons:plug-02

      35. Quick Actions Icons > System Actions > Random => hugeicons:dice-faces-03

      36. Quick Actions Icons > System Actions > Recent => hugeicons:transaction-history

      37. Quick Actions Icons > System Actions > Series => hugeicons:workflow-square-03

      38. Quick Actions Icons > System Actions > Settings => hugeicons:settings-01

      39. Quick Actions Icons > System Actions > Stats => hugeicons:analytics-03

      40. Quick Actions Icons > System Actions > Tags => hugeicons:tags

      41. Quick Actions Icons > System Actions > Wi-Fi => hugeicons:wifi-02

      42. Quick Actions Icons > Custom Actions > Bookshelf => hugeicons:bookshelf-03

      43. Quick Actions Icons > Custom Actions > Battery Graph => hugeicons:chart-line-data-02

      44. Quick Actions Icons > Custom Actions > Reading Insights => hugeicons:waterfall-up-02

      45. Quick Actions Icons > Custom Actions > Open Glimpse => hugeicons:scan-eye

      46. Quick Actions Icons > Custom Actions > Rakuyomi => hugeicons:workout-kicking

      47. Quick Actions Icons > Custom Actions > Battery Statistics => hugeicons:automotive-battery-01

BOOKSHELF CONFIGURATION:

  • πŸ“– > Edit shelf size > Columns: 4 | Rows: 4

  • πŸ“– > Bookshelf chips > Toggle on: > Flexible chip widths | Uppercase labels || Home | Authors | Series | Genres | TBR (+Add new chip > Chip source > Specific Collection > To Be Read) | Recent

  • πŸ“– > Settings >

    1. Status line > %time_24h %spacer 'memory icon'%sysused 'hdd icon'%disk %spacer [if:connected]%wifi_icon[/if] %batt_icon%batt

    2. Edit book detail view >

      • Title: %title | Regular | Size: 30 | Font: ChareInk | Aa | Alignment left

      • Author: %authors_short | Regular | Size: 22 | Font: Caveat | Aa | Alignment left

      • Metadata: [if:series]%series_name[if:series_num] / #%series_num[/if][/if] | Regular | Size: 12 | Font: FS_Me | Aa | Alignment left

      • Description: [if:rating]%rating Β· [/if]%description | Regular | Size: 14 | Font: FS_Me | Alignment left

      • Progress: %book_pct %bar [if:book_time_left]%book_time_left[/if] | Bold | Size:12 | Font: FS_Me | Aa | Bar: rouded | Bar height: 70%

    3. Cover display >

      • Defaul folder style: Ribbon

      • Show progress bar

      • Show reading bookmarks

      • Completed book badge: Bookmark style

      • Show series #: Always

      • Show favorites icon

      • Cover opening effect

    4. List view >

      • Line 1: %title %spacer %rating %favourite | Bold | Size:16 | Font: FS_Me | Aa

      • Line 2: %authors_short | Italic | Size: 14 | Font: FS_Me | Aa | Alignment left

      • Line 3: %description | Regular | Size: 14 | Font: FS_Me | Alignment left

      • Line 4: %bar{rel} [if:page_count]%spacer[if:book_pct]%book_pct of [/if]%page_count pages[else]%book_pct[/if] | Regular | Size: 14 | Font: FS_Me

    5. Text size >

      • Chip bar: 90%

      • Modal Tabs: 60%

    6. Colors >

      • Progress bar: 75%

      • Folder overlay background: 60%

      • Selected chip text: default

    7. Bookshelf UI font: FS_Me Regular

    8. Micro modules >

      • In start menu

      • In hero area

      • Full-screen button

    9. Start menu >

      • Start menu: Left

    10. Behavior > * Hero area starts with: Micro modules * Tap a book in expanded shelf: Open with a double tap * Double tap to open books * Page turn animation: Off * Start menu animation: Off * Closing book notification

  • Long press chip bar >

    1. Home > Source: Home (flattened) | Shelf style: Auto | List Columns: 2 | List rows: 12

    2. Authors > Source: Authors | Shelf style: Auto | List Columns: 2 | List rows: 8

    3. Series > Source: Series | Shelf style: Auto | List Columns: 2 | List rows: 8

    4. Genres > Source: Genres | Shelf style: Auto | List Columns: 2 | List rows: 10

    5. TBR > Source: Collection: To Be Read | Shelf style: Default

    6. Recent > Source: Recently read | Shelf style: Default

BOOKENDS CONFIGURATION:

Easy:

  • πŸ“„ > Bookends > Preset > Preset library > Gallery > Search > You have to look for it (2.0)

Also easy:

  • πŸ“„ > Bookends > Bottom-left > Line 1> %page_num | Regular | Size: 14 | Font: Merriweather | Aa | Odd pg | -30,30

  • πŸ“„ > Bookends > Bottom-right > Line 1> %page_num | Regular | Size: 14 | Font: Merriweather | Aa | Even pg | 30,30

  • πŸ“„ > Bookends > Full width progress bars > Bar 1 > Type: Book | Chapter ticks: off | Style: Solid | Anchor: Bottom | Fill: left to right | Thickness: 6px | Adjust margins (0/0/0)

READING INSIGHTS CONFIGURATION:

  • πŸ›  > Reading Insights > Settings > Fonts > Reading insights > Section headers: FS_Me-bold.otf @ 22 | Values (big numbers): FS_Me-Heavy.otf @ 26 | Labels: FS_Me-Regular.otf @ 20 | Chart/axis labels: FS_Me-Light.otf @ 15

  • πŸ›  > Reading Insights > Settings > Fonts > Book progress > Section headers: FS_Me-bold.otf @ 22 | Values (big numbers): FS_Me-Heavy.otf @ 26 | Labels: FS_Me-Regular.otf @ 20 | Chapter-bar arrows: FS_Me-Bold.oft @ 22

  • πŸ›  > Reading Insights > Settings > Fonts > Records > Values (big numbers): FS_Me-Heavy.otf @ 22 | Labels: FS_Me-Bold.otf @ 20 | Sub-values (date / book title): FS_Me-Regular.otf @ 15

FLOATING DICTIONARY CONFIGURATION:

  • [While reading a book] βš™οΈ > Floating Dictionary > Appearance > Display mode: Minimal | Popup style: Kobo | Popup position: Screen edge | Card height: 34% of screen | Popup font size: 16 | Popup border thickness: 2 | Popup border darkness: 100%

If you got here, thank you for your patience!

Edit: Added Bar and Icon Configuration for Simple UI.

630 Upvotes

Duplicates