Instructions for patching firmware 3.18.0

[GeoffR]

Originally Posted by mortimer7

i have enabled the "Custom page refresh options (1,2,4,8,16,32,64)" but it doesn't work on my Aura 3.18. it still has only "1,5,10,Chapter"

Thanks, I knew the Aura had a per-chapter option but I didn't realise the page count options were different. I'll have to look into how to change these options for the Aura.

[mortimer7]

Thanks to You.
Are you able to add "Never" to "Custom page refresh options"?

[JSWolf]

Originally Posted by mortimer7

Thanks to You.
Are you able to add "Never" to "Custom page refresh options"?

Nope. But without editing the patch settings, I'm able to go 32 or 64 pages. 32 is what I am not set for. I think that should be good enough.

[davidfor]

Originally Posted by JSWolf

Nope. But without editing the patch settings, I'm able to go 32 or 64 pages. 32 is what I am not set for. I think that should be good enough.

The more likely answer is a straight "NO". We can patch the values displayed in the list, but there is code elsewhere that does something like:

if (pages_turned_since_last_refresh > selected_refresh_count) {
    do_full_refresh();
}

Finding and changing that is different to finding the list of values. And personally, I don't think it would be a good idea. Just change it in the config file to 99. How likely is it that someone will read 99 pages without something else causing a refresh? Unless they are using a really big font.

[GeoffR]

Does anyone know what value is recorded for numPartialUpdatePageTurns in the Kobo eReader.conf file when the "Chapter" refresh option is selected on the Aura?

[mortimer7]

Originally Posted by GeoffR

Does anyone know what value is recorded for numPartialUpdatePageTurns in the Kobo eReader.conf file when the "Chapter" refresh option is selected on the Aura?

This is "Kobo eReader.conf" ([Reading]) of my Aura 6" with "Chapter" refresh option:

[Reading]
annotationsViewStyle=notebook
bookProgressType=5
fullScreenReading=true
libraryBuilderBlueprint=filterByMine()\nremoveReadingStatusFilter()\nviewBy5List()
libraryShowCovers=false
libraryShowOnlyDownloaded=false
numPartialUpdatePageTurns=4294967295
pageTurningOption=default
pinchToZoom=false
readingAdobeShowPageNumbers=false
readingAlignment=justify
readingFontFamily=Georgia
readingFontSize=26
readingLeftMargin=0
readingLineHeight=1
readingMenuState=
readingRightMargin=0

[GeoffR]

Here is a custom page refresh options patch that I think will work on the Aura, but as I don't have an Aura, someone else will have to be the first to test it.

It should be safe, even if it doesn't work properly I think the worst that could happen is that the device crashes when you try to select an option from the menu and you'd need to reboot and re-apply the patches with this one disabled.

Firmware 3.18.0; paste into libnickel.so.1.0.0.patch

Spoiler:

<Patch>
patch_name = `Custom page refresh options (Aura only)`
patch_enable = `yes`
#
#     1,5,10,Chapter
# --> 1,8,16,Chapter
#
replace_int = 763C82, 5, 8
replace_int = 763E6C, 5, 8
replace_int = 763EDA, 5, 8
replace_string = B8F850, `5 pages`, `8 pages`
#
replace_int = 763D1E, 10, 16
replace_int = 76400A, 10, 16
replace_int = 764066, 10, 16
replace_string = B8F858, `10 pages`, `16 pages`
</Patch>

[mortimer7]

It works perfectly on my Aura 6", but only with fullScreenReading=false (it's a bug of 3.18 firmware), thanks.

but IMHO It makes no sense replace 5 with 8 and 10 with 16. :-þ

[mortimer7]

i would like to set "1,32,99,Chapter"
How should i edit the patch?

maybe adding this?

replace_string = B8F850, `5 pages`, `32 pages`
replace_string = B8F858, `10 pages`, `99 pages`

[GeoffR]

Originally Posted by mortimer7

i would like to set "1,32,99,Chapter"
How should i edit the patch?

This should do it, but the "32 pages" menu option will be missing the space which might affect the translation if you don't have the device set to English. (Edit: You could set them to `32 page` and `99 page` instead if that seems better to you. It is okay if these replacement strings are shorter than the original, but they can't be longer.)

The values can go higher than 99 if you wish, the limit that can be set with the patch is 255. I have tested 128 on my Glo with firmware 3.18.0 and it works correctly.

Firmware 3.18.0; paste into libnickel.so.1.0.0.patch

Spoiler:

<Patch>
patch_name = `Custom page refresh options (Aura only)`
patch_enable = `yes`
#
#     1,5,10,Chapter
# --> 1,32,99,Chapter
#
replace_int = 763C82, 5, 32
replace_int = 763E6C, 5, 32
replace_int = 763EDA, 5, 32
replace_string = B8F850, `5 pages`, `32pages`
#
replace_int = 763D1E, 10, 99
replace_int = 76400A, 10, 99
replace_int = 764066, 10, 99
replace_string = B8F858, `10 pages`, `99 pages`
</Patch>

[mortimer7]

thx, I will wait the release of 3.19 to apply the patch (hoping they resolve the refresh bug)

[GeoffR]

This is a new patch to replace the three seperate patches (`KePub zero body margin/padding`, `Fix kepub side bearing font cut-off bug`, `Disable KePub FullSceenReading block img style`) for the three problems that affect KePubs in full-screen reading mode. (See this post)

I will be including this patch instead of the other three patches in future versions, and I intend to have it enabled by default, so I'm posting it here in case anyone wants to test it out.

It has the advantage that is is much simpler, and has no effect on normal reading mode at all.

Multi-version patch 3.3.0 - 3.18.0+, paste into libnickel.so.1.0.0.patch.

Spoiler:

<Patch>
patch_name = `Fix three KePub fullScreenReading bugs`
patch_enable = `yes`
# Multi-version patch: 3.3.0 - 3.18.0+
#
# (See https://www.mobileread.com/forums/showpost.php?p=3113460&postcount=16
# for screenshots and more information about the problems this patch fixes.)
#
# In full-screen reading mode (when the FullScreenReading feature setting is
# activated and the "Show header and footer" reading setting is unticked) the
# KePub reader has three problems:
#
# 1. If the book's stylesheet has non-zero body margin/padding, then the
#    text is shifted to the right and can be cut off at the right margin.
# 2. Characters with large side bearing values (such as italic f, J) can
#    be cut off if they appear at either end of a line.
# 3. Images which are supposed to be displayed inline (flowing with the text)
#    are instead displayed centred in a seperate block.
#
# This patch fixes those problems by replacing the following faulty style,
# which is the cause of problem 3.:
#
#   img {
#     display: block;
#     margin-left: auto !important;
#     margin-right: auto !important;
#     width: auto !important;
#     height: auto !important;
#   }
#
# with the following two styles, which work around problems 1. and 2.:
#
#   body {
#     margin: 0 !important;
#     padding: 0 !important;
#   }
#
#   body>div {
#     padding-left: 0.2em !important;
#     padding-right: 0.2em !important;
#   }
#
#
find_base_address = `\0i\0m\0g\0 \0{\0 \0d\0i\0s\0p\0l\0a\0y\0:\0 \0b\0l\0o\0c\0k\0;\0`
replace_string = 0001, `i\0m\0g\0 \0{\0 \0d\0i\0s\0p\0l\0a\0y\0:\0 \0b\0l\0o\0c\0k\0;\0 \0m\0a\0r\0g\0i\0n\0-\0l\0e\0f\0t\0:\0 \0a\0u\0t\0o\0 \0!\0i\0m\0p\0o\0r\0t\0a\0n\0t\0;\0 \0m\0a\0r\0g\0i\0n\0-\0r\0i\0g\0h\0t\0:\0 \0a\0u\0t\0o\0 \0!\0i\0m\0p\0o\0r\0t\0a\0n\0t\0;\0 \0w\0i\0d\0t\0h\0:\0 \0a\0u\0t\0o\0 \0!\0i\0m\0p\0o\0r\0t\0a\0n\0t\0;\0 \0h\0e\0i\0g\0h\0t\0:\0 \0a\0u\0t\0o\0 \0!\0i\0m\0p\0o\0r\0t\0a\0n\0t\0;\0 \0}\0`, `b\0o\0d\0y\0 \0{\0 \0m\0a\0r\0g\0i\0n\0:\0 \00\0 \0!\0i\0m\0p\0o\0r\0t\0a\0n\0t\0;\0 \0p\0a\0d\0d\0i\0n\0g\0:\0 \00\0 \0!\0i\0m\0p\0o\0r\0t\0a\0n\0t\0;\0 \0}\0 \0 \0b\0o\0d\0y\0>\0d\0i\0v\0 \0{\0 \0p\0a\0d\0d\0i\0n\0g\0-\0l\0e\0f\0t\0:\0 \00\0.\02\0e\0m\0 \0!\0i\0m\0p\0o\0r\0t\0a\0n\0t\0;\0 \0p\0a\0d\0d\0i\0n\0g\0-\0r\0i\0g\0h\0t\0:\0 \0 \00\0.\02\0e\0m\0 \0!\0i\0m\0p\0o\0r\0t\0a\0n\0t\0;\0 \0}\0`
#
#
# Optional replacement values below (all relate to the second problem above):
#
# Uncomment to set the amount of added padding: `1` = 0.1em, `2` = 0.2em, etc.
# 0.1em is enough for many fonts, but some (such as Georgia) need 0.2em.
#
#replace_string = 00A5, `2`, `1`
#replace_string = 00E9, `2`, `1`
#
# The default patch settings are suitable for horizontal languages only.
# Uncomment the following two replace_string lines for vertical languages only:
#
#replace_string = 0095, `l\0e\0f\0t\0:\0`, `t\0o\0p\0:\0 \0`
#replace_string = 00D5, `r\0i\0g\0h\0t\0:\0 \0`, `b\0o\0t\0t\0o\0m\0:\0`
#
# ... or the following two replace_string lines for both horizontal and vertical
# languages: (But note that this will cause the padding to be added at the
# beginning/end of each chapter too.)
#
#replace_string = 0093, `-\0l\0e\0f\0t\0:\0`, `:\0 \0 \0 \0 \0 \0`
#replace_string = 00AD, `!\0i\0m\0p\0o\0r\0t\0a\0n\0t\0;\0 \0p\0a\0d\0d\0i\0n\0g\0-\0r\0i\0g\0h\0t\0:\0`, `\x20\0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0`
#
# Sideloaded KePubs created with old versions of the KoboTouchExtended driver,
# and perhaps some other KePubs that haven't been through Kobo's EPUB2 to KEPUB
# conversion process, might not have a wrapper div to apply the padding styles
# to. Uncomment the following line to work around the second problem for these
# KePubs too. (But beware, this can have unwanted side effects such as extra
# space between paragraphs if the above option for both horizontal and vertical
# languages is uncommented too.)
#
#replace_string = 0079, `d\0i\0v\0`, `*\0 \0 \0`
</Patch>

[AMF]

Maybe I'm missing it, but a slider in the library would be great. Too often when I swipe to get to the next page I open a book...

[Nick_1964]

Originally Posted by GeoffR

This is a new patch to replace the three seperate patches (`KePub zero body margin/padding`, `Fix kepub side bearing font cut-off bug`, `Disable KePub FullSceenReading block img style`) for the three problems that affect KePubs in full-screen reading mode. (See this post)

I will be including this patch instead of the other three patches in future versions, and I intend to have it enabled by default, so I'm posting it here in case anyone wants to test it out.

It has the advantage that is is much simpler, and has no effect on normal reading mode at all.

I hope I can recognise all the patches, there are a lot new ones
For me it is always difficult to remember what patch does this or don't and what value must be there, or at least I forget some.
I hope someone will ever develope a GUI for it, but that would be a wet dream come true.. well at least I managed to patch the latest versions.
I am ever gratefull for your work,without it I doubt that I still had my 3 Kobo's.

[sherman]

I would probably be willing to come up with some sort of GUI, if Geoff would be willing to standardise on a way of being able to determine mutually exclusive options, and determine which help text belongs with which patch.

EDIT: Basically, the idea would be to read the patch file(s) and dynamically create a GUI based on the contents of said file(s). That way a new GUI version would not need to be created for every new patch release.

It probably won't be pretty to look at though