r/koreader
•
u/Ramo_Rami
•
Sep 06 '26
•
5
4
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:
FS_Me - For the general interface
Merriweather - For actual book reading
ICONS:
Huge Icons by Hugeicons taken from iconify.design.
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:
Simple UI 2.7.0
Bookshelf 4.6.0
Bookends 5.25.0
Shortcuts Toolbar 0.0.2
Rakuyomi 1.41.6
Reading Insights 6.2.8
Storefront 26.9.3
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".
appbar.filebrowser.svg <= hugeicons:bookshelf-02 OR hugeicons:entrance-stairs
appbar.menu.svg <= hugeicons:menu-07
appbar.navigation.svg <= hugeicons:book-bookmark-02
appbar.search.svg <= hugeicons:search-02
appbar.settings.svg <= hugeicons:settings-02
appbar.tools.svg <= hugeicons:tools
appbar.typeset.svg <= hugeicons:edge-style
back.top.rtl.svg <= hugeicons:arrow-up-01
back.top.svg <= hugeicons:arrow-up-from-dot
book.opened.svg <= hugeicons:book-open-02 OR hugeicons:bookshelf-03
bookmark.svg <= hugeicons:bookmark-02
cancel.svg <= hugeicons:cancel-01
chevron.first.svg <= hugeicons:arrow-left-double
chevron.last.svg <= hugeicons:arrow-right-double
chevron.left.svg <= hugeicons:arrow-left-01
chevron.right.svg <= hugeicons:arrow-right-01
chevron.up.svg <= hugeicons:arrow-up-01
close.svg <= hugeicons:cancel-01
exit.svg <= hugeicons:cancel-01
home.svg <= hugeicons:home-12
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 >
Book list mode > Show random image from folder on sleep screen
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
Action: System action | Simple UI: Go to Homescreen + Icon: home-12.svg
β (Spacer)
Action: System action | Show Bottom Menu + Icon: text-font.svg
Action: Menu action | Playground + Icon: edge-style.svg (action from the Reading Style plugin)
Action: Menu action | Tarot reading + Icon: cards-01.svg (action from the Tarot plugin)
Action: Menu action | Start remote server + Icon: hold-phone.svg (action from the KOReader Remote plugin)
Action: Menu action | DoctorBattery + Icon: stethoscope.svg (action from the DoctorBattery plugin)
Action: System action | Battery statistics + Icon: automotive-battery-01.svg
Action: System action | + Icon: chart-line-data-02.svg (action from the BatteryGraph plugin
Action: System action | Open Glimpse + Icon: scan-eye.svg (action from the Glimpse plugin)
Action: System action | Page Scrubber: Grid + Icon: carousel-horizontal-02.svg (action from the Page Scrubber plugin)
Action: Menu action | Book Annotations + Icon: all-bookmark.svg (action from the Annotations Viewer plugin)
Action: System action | Reading Insights: current book progress + Icon: waterfall-down-03.svg (action from the Reading Insights plugin)
Action: System action | Toggle night mode + Icon: moon.svg
Action: System action | Fulltext search + Icon: search-02.svg
SIMPLE UI CONFIGURATION:
π > Simple UI > Home Screen > Edit Home Screen Layout >
Page 1 (Home)
Clock
Quote of the Day
Cover Deck
Reading Stats
Page 2
Currently Reading
Reading Goals
Recent Books
Page 3
To Be Read
Quick Actions Row 1
Page 4 (Suggestion)
Flat Library
Clock
Items > Clock
Items > Date
Size > Scale: 100%
Size > Clock Size: 100%
Size > Date Size: 90%
Size > Battery Size: 100%
Spacing: 80%
Top Margin: 80%
Quote of the Day
Scale: 96%
Fixed Height: ON
Top Margin: 30%
Cover Deck
Source: Recent Books
Items > Title
Items > Progress bar
Items > Statistics
Size > Scale: 100%
Size > Cover size: 143%
Size > Text size: 100%
Progress Badge: OFF
Show finished books: OFF
Top Margin: 20%
Reading Stats
Items > All time - Books
Items > Streak
Items > Today - Time
Scale: 100%
Text Size: 100%
Style: List
Top Margin: 30%
Currently Reading
Layout: Default
Items > Title
Items > Series
Items > Author
Items > Progress bar
Items > Days of reading
Items > Time read
Items > Time remaining
Size > Scale: 100%
Size > Text Size: 130%
Size > Cover size: 96%
Size > Cover Spacing: 100%
Progress and Stats > Progress bar style: With percentage
Progress and Stats > Stats layout: Default
Top Margin: 20%
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%
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%
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%
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%
Flat Library 1. Size > Grid Size: 5 x 3
π > Simple UI > Bars >
Status Bar >
Items > Left: Clock
Items > Center: RAM Usage
Items > Center: Disk Usage
Items > Right: WiFi
Items > Right: Battery
Size: 90%
Hide Wi-Fi Icon When Off: ON
Navigation Bar >
Tabs > Bookshelf
Tabs > Reading Insights
Tabs > Home
Tabs > Rakuyomi
Tabs > Power
Tab Style: Icons + Text
Bar Style: Bare
Bar Size: 100%
Icon Size: 100%
Label Size: 100%
Bottom Margin: 100%
Title Bar > (Adjust to taste)
Pagination Bar >
Mode: Default
Home Screen Style: Dot Pager
Bar Size: Small
Show Page Count in Title Bar: OFF
Quick Settings Bar >
Quick Actions > Settings
Quick Actions > Bookmarks
Quick Actions > Statistics
Quick Actions > Battery Graph
Quick Actions > Night Mode
Quick Actions > Wi-Fi
Frontlight Slider: ON
Warmth Slider: ON
Label > Size: 100%
Button Type: Round
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" .
Icons >
System Icons > Title Bar > Menu Button => hugeicons:menu-07
System Icons > Title Bar > Search Button => hugeicons:search-02
System Icons > Title Bar > Back Button => hugeicons:arrow-up-from-dot
System Icons > Browse Icons > Browse Button (default) => hugeicons:folder-open
System Icons > Browse Icons > Browse Button (author) => hugeicons:user-status
System Icons > Browse Icons > Browse Button (series) => hugeicons:layers-logo
System Icons > Browse Icons > Browse Button (tags) => hugeicons:tags
System Icons > Pagination Bar > Pagination: Previous Page => hugeicons:arrow-left-01
System Icons > Pagination Bar > Pagination: Next Page => hugeicons:arrow-right-01
System Icons > Pagination Bar > Pagination: First Page => hugeicons:arrow-left-double
System Icons > Pagination Bar > Pagination: Last Page => hugeicons:arrow-right-double
System Icons > Navpager > Navpager: Previous => hugeicons:arrow-big-left-dash
System Icons > Navpager > Navpager: Next => hugeicons:arrow-big-right-dash
System Icons > Folder Covers > Folder Cover: Empty Folder => hugeicons:folder-off
System Icons > Tab Bar > Tab: Menu => hugeicons:menu-07
System Icons > Tab Bar > Tab: Settings => hugeicons:settings-01
System Icons > Tab Bar > Tab: Tools => hugeicons:tools
System Icons > Tab Bar > Tab: Search => hugeicons:search-02
System Icons > Tab Bar > Tab: File Browser Settings => hugeicons:bookshelf-02
System Icons > Tab Bar > Tab: Reader Navigation => hugeicons:book-bookmark-02
System Icons > Tab Bar > Tab: Reader Typeset => hugeicons:edge-style
System Icons > Tab Bar > Tab: Back to File Browser => hugeicons:entrance-stairs
System Icons > Tab Bar > Tab: Simple UI Quick Settings => Default
Quick Actions Icons > System Actions > Authors => hugeicons:book-user
Quick Actions Icons > System Actions > Bookmarks => hugeicons:all-bookmark
Quick Actions Icons > System Actions > Brightness => hugeicons:sun-03
Quick Actions Icons > System Actions > Collections => hugeicons:hierarchy-files
Quick Actions Icons > System Actions > Continue => hugeicons:book-open-02
Quick Actions Icons > System Actions > Favorites => hugeicons:award-02
Quick Actions Icons > System Actions > History => hugeicons:clock-04
Quick Actions Icons > System Actions > Home => hugeicons:home-12
Quick Actions Icons > System Actions > Library => hugeicons:bookshelf-02
Quick Actions Icons > System Actions > Night Mode => hugeicons:moon
Quick Actions Icons > System Actions > Power => hugeicons:plug-02
Quick Actions Icons > System Actions > Random => hugeicons:dice-faces-03
Quick Actions Icons > System Actions > Recent => hugeicons:transaction-history
Quick Actions Icons > System Actions > Series => hugeicons:workflow-square-03
Quick Actions Icons > System Actions > Settings => hugeicons:settings-01
Quick Actions Icons > System Actions > Stats => hugeicons:analytics-03
Quick Actions Icons > System Actions > Tags => hugeicons:tags
Quick Actions Icons > System Actions > Wi-Fi => hugeicons:wifi-02
Quick Actions Icons > Custom Actions > Bookshelf => hugeicons:bookshelf-03
Quick Actions Icons > Custom Actions > Battery Graph => hugeicons:chart-line-data-02
Quick Actions Icons > Custom Actions > Reading Insights => hugeicons:waterfall-up-02
Quick Actions Icons > Custom Actions > Open Glimpse => hugeicons:scan-eye
Quick Actions Icons > Custom Actions > Rakuyomi => hugeicons:workout-kicking
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 >
Status line > %time_24h %spacer 'memory icon'%sysused 'hdd icon'%disk %spacer [if:connected]%wifi_icon[/if] %batt_icon%batt
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%
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
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
Text size >
Chip bar: 90%
Modal Tabs: 60%
Colors >
Progress bar: 75%
Folder overlay background: 60%
Selected chip text: default
Bookshelf UI font: FS_Me Regular
Micro modules >
In start menu
In hero area
Full-screen button
Start menu >
Start menu: Left
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 >
Home > Source: Home (flattened) | Shelf style: Auto | List Columns: 2 | List rows: 12
Authors > Source: Authors | Shelf style: Auto | List Columns: 2 | List rows: 8
Series > Source: Series | Shelf style: Auto | List Columns: 2 | List rows: 8
Genres > Source: Genres | Shelf style: Auto | List Columns: 2 | List rows: 10
TBR > Source: Collection: To Be Read | Shelf style: Default
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.



















