Instructions for patching firmware 3.19.5613

[drjd]

Thanks for the great work, GeoffR. Patches are working fine on my Glo.

[oren64]

Originally Posted by GeoffR

I think there is a problem with the patch: you are replacing substrings within a larger string, but your replacements are shorter than the originals. This means that the larger string will be truncated after the first substring.

Okay i edit the patch.
i didn't get an error in the old version.
can someone test it on Aura HD\H2O please.

[GeoffR]

I've included the `Freedom to advanced fonts control` patch in the zip attaced to post #1, and I've updated the zip again just now to make the `Custom page refresh options (1,2,3,...,12)` patch enabled by default instead of the `Custom page refresh options (1,2,4,8,16,32,64,128)` alternative.

Originally Posted by Nick_1964

Is it possible to make a patch that remove this 2 fonts ?? (or make them disappear from the font drop down list ??) So you can't choose them by accident ??

I think the only way would be to completely remove them from the device, but the problem is that they are used by the UI in some places so I don't know if it is a good idea to remove them.

I haven't seen anyone else report a problem with the new fonts though, and it is easy enough for me to avoid the problem just by not using them. (Edit: I see now a few others with Touch/Glo are reporting problems with the Kobo Tsukushi Mincho font.)

Originally Posted by JSWolf

Can we please get the patch to fix the bottom padding bug in ePub? Thanks.

The `ePub disable built-in body padding-bottom` patch is included in the zip attached to post #1, but not enabled by default.

Originally Posted by rudgas

One question though, in the libnickel.patch file, there are often different replacement strings for different readers. To me it's not completely clear if it's safe to leave those strings uncommented (thinking that if it's not my reader the string the patch is looking for isn't even there) or if I should comment all lines of code for the other readers.

If there are already multiple options uncommented then they can be left uncommented, but if there is only one alternative uncommented and the others are commented out then you need to comment out all except one alternative.

If you have two incompatible options uncommented then you should get an error about mismatched data when you try to build the patch.

[GeoffR]

I updated the zip in post #1 again, to add the new `ePub full justification default` patch, and to re-arrange the `ePub fixed/adjustable top/bottom margins` and `ePub disable built-in body padding-bottom` patches to make it clearer that they are mutually incompatible altrnatives.

Edit: Sorry, I realised that the `ePub full justification default` patch wasn't of any use because the justify button works differently for ePubs. Unlike in KePubs, there is no advantage to avoiding the use of the button in ePubs.

[outlandos]

So i just applied the patch, but something is wrong:

http://static.tweakers.net/ext/f/oxk...GrzwZ/full.jpg

As you see part of the first and last line is missing. Do you have any idea what in the patch could cause this? Ill also keep looking!

[GeoffR]

Originally Posted by outlandos

So i just applied the patch, but something is wrong:

http://static.tweakers.net/ext/f/oxk...GrzwZ/full.jpg

As you see part of the first and last line is missing. Do you have any idea what in the patch could cause this? Ill also keep looking!

It is probably because the KePub reader can't hande the low line spacing settings. Try increasing your line spacing a bit and see of that fixes it.

If you only read KePubs then you might want to edit the `My 15 line spacing values` patch to remove some of the low line spacing values and add some more high ones. There is a note at the end of the patch about this.

[outlandos]

Originally Posted by GeoffR

It is probably because the KePub reader can't hande the low line spacing settings. Try increasing your line spacing a bit and see of that fixes it.

If you only read KePubs then you might want to edit the `My 15 line spacing values` patch to remove some of the low line spacing values and add some more high ones. There is a note at the end of the patch about this.

Increasing the line spacing didn't help.

On 3.18 i did not have this problem, yet i used your 15 line patch without any changes:

<Patch>
patch_name = `My 15 line spacing values` 
patch_enable = `yes`
# load val1 from new table
replace_bytes = 5E80CC, 00 23 00 22 C3 F6 F0 73, 00 46 40 A3 D3 E9 00 23
# load val5 from new table
replace_bytes = 5E8124, 43 F2 33 33 4F F0 33 32, 2C A3 D3 E9 00 23 00 46
replace_bytes = 5E812C, C3 F6 F3 73, 00 46 00 46
# load val7 from new table
replace_bytes = 5E8152, 00 23 00 22 C3 F6 F8 73, 00 46 22 A3 D3 E9 00 23
# load val10 from new table
replace_bytes = 5E8190, 00 22 4F F0 80 43, 15 A3 D3 E9 00 23
# load val11-val14 from old table in a loop to make room for new table
replace_bytes = 5E81A4, 48 A3 D3 E9 00 23 07 F1, 48 A7 00 26 D7 E9 00 23
replace_bytes = 5E81AC, 80 01 20 46 61 E9 0A 23, 20 A9 31 44 61 E9 0A 23
replace_bytes = 5E81B4, 11 F6 5C EF 45 A3 D3 E9, 20 46 11 F6 5C EF 08 36
replace_bytes = 5E81BC, 00 23 07 F1 80 01 20 46, 08 37 20 2E F2 D1 00 AF
# load val15 from new table, jump over new table
replace_bytes = 5E81C4, 61 E9 08 23 11 F6 52 EF, 0A A3 D3 E9 00 23 17 E0
# new table, inial values 1.0, 1.2, 1.5, 2.0, 3.0
replace_bytes = 5E81D0, 00 23 07 F1 80 01 20 46, 00 00 00 00 00 00 F0 3F
replace_bytes = 5E81D8, 61 E9 06 23 11 F6 48 EF, 33 33 33 33 33 33 F3 3F
replace_bytes = 5E81E0, 3F A3 D3 E9 00 23 07 F1, 00 00 00 00 00 00 F8 3F
replace_bytes = 5E81E8, 80 01 20 46 61 E9 04 23, 00 00 00 00 00 00 00 40
replace_bytes = 5E81F0, 11 F6 3E EF 00 23 00 22, 00 00 00 00 00 00 08 40
#
# 15 values for replacement:
replace_float = 5E81D0, 1.0, 0.9
replace_float = 5E8298, 1.05, 0.95
replace_float = 5E82A0, 1.07, 1.0
replace_float = 5E82A8, 1.1, 1.05
replace_float = 5E81D8, 1.2, 1.1
replace_float = 5E82B0, 1.35, 1.05
replace_float = 5E81E0, 1.5, 1.1
replace_float = 5E82B8, 1.7, 1.15
replace_float = 5E82C0, 1.8, 1.2
replace_float = 5E81E8, 2.0, 1.25
replace_float = 5E82C8, 2.2, 1.30
replace_float = 5E82D0, 2.4, 1.35
replace_float = 5E82D8, 2.6, 1.4
replace_float = 5E82E0, 2.8, 1.45
replace_float = 5E81F0, 3.0, 1.5
#
# The 15 line spacing values above should allow the line spacing to be adjusted
# in increments of one pixel when using a medium sized font on a high resolution
# device. If you use a small font size and/or a lower resolution device you may
# find that increasing the slider one step at a time doesn't always result in a
# line spacing change at each step. In that case, you might want to use 15
# replacement values that are not quite so close together. For example:
# 0.7 0.75 0.8 0.825 0.85 0.875 0.9 0.925 0.95 0.975 1.0 1.05 1.1 1.15 1.2
#
</Patch>

On 3.19 the values are:

Patch>
patch_name = `My 15 line spacing values` 
patch_enable = `yes`
# load val1 from new table
replace_bytes = 616124, 00 23 00 22 C3 F6 F0 73, 00 46 40 A3 D3 E9 00 23
# load val5 from new table
replace_bytes = 61617C, 43 F2 33 33 4F F0 33 32, 2C A3 D3 E9 00 23 00 46
replace_bytes = 616184, C3 F6 F3 73, 00 46 00 46
# load val7 from new table
replace_bytes = 6161AA, 00 23 00 22 C3 F6 F8 73, 00 46 22 A3 D3 E9 00 23
# load val10 from new table
replace_bytes = 6161E8, 00 22 4F F0 80 43, 15 A3 D3 E9 00 23
# load val11-val14 from old table in a loop to make room for new table
replace_bytes = 6161FC, 48 A3 D3 E9 00 23 07 F1, 48 A7 00 26 D7 E9 00 23
replace_bytes = 616204, 80 01 20 46 61 E9 0A 23, 20 A9 31 44 61 E9 0A 23
replace_bytes = 61620C, FC F5 46 EC 45 A3 D3 E9, 20 46 FC F5 46 EC 08 36
replace_bytes = 616214, 00 23 07 F1 80 01 20 46, 08 37 20 2E F2 D1 00 AF
# load val15 from new table, jump over new table
replace_bytes = 61621C, 61 E9 08 23 FC F5 3C EC, 0A A3 D3 E9 00 23 17 E0
# new table, inial values 1.0, 1.2, 1.5, 2.0, 3.0
replace_bytes = 616228, 00 23 07 F1 80 01 20 46, 00 00 00 00 00 00 F0 3F
replace_bytes = 616230, 61 E9 06 23 FC F5 32 EC, 33 33 33 33 33 33 F3 3F
replace_bytes = 616238, 3F A3 D3 E9 00 23 07 F1, 00 00 00 00 00 00 F8 3F
replace_bytes = 616240, 80 01 20 46 61 E9 04 23, 00 00 00 00 00 00 00 40
replace_bytes = 616248, FC F5 28 EC 00 23 00 22, 00 00 00 00 00 00 08 40
#
# 15 values for replacement, change these to suit:
replace_float = 616228, 1.0, 0.7
replace_float = 6162F0, 1.05, 0.75
replace_float = 6162F8, 1.07, 0.8
replace_float = 616300, 1.1, 0.82
replace_float = 616230, 1.2, 0.84
replace_float = 616308, 1.35, 0.86
replace_float = 616238, 1.5, 0.88
replace_float = 616310, 1.7, 0.9
replace_float = 616318, 1.8, 0.92
replace_float = 616240, 2.0, 0.94
replace_float = 616320, 2.2, 0.96
replace_float = 616328, 2.4, 0.98
replace_float = 616330, 2.6, 1.0
replace_float = 616338, 2.8, 1.05
replace_float = 616248, 3.0, 1.1
#
# The 15 line spacing values above should allow the line spacing to be adjusted
# in increments of one pixel when using a medium sized font on a high resolution
# device. If you use a small font size and/or a lower resolution device you may
# find that increasing the slider one step at a time doesn't always result in a
# line spacing change at each step. In that case, you might want to use 15
# replacement values that are not quite so close together. For example:
#
#   0.7 0.75 0.8 0.825 0.85 0.875 0.9 0.925 0.95 0.975 1.0 1.05 1.1 1.15 1.2
#
# Also note that the KEPUB reader has problems when the line spacing value is
# set too low, depending on the font used. Most of the built-in fonts are okay
# down to about 0.9. If you only read KePub books then you might want to remove
# some of the lower values and add some more of the higher ones. For example:
#
#   0.9 0.925 0.95 0.975 1.0 1.025 1.05 1.075 1.1 1.15 1.2 1.25 1.3 1.35 1.4
#
</Patch>

Let me see if you changed anything in those value's from 3.18 to 3.19..

..apparently you did, ill change the values back as they were in your 3.18 patch and see if that fixes it.

/edit: now i think about it, i [s]might[/s] have changed those values myself in your 3.18 patch.

/edit 2: editting the values to slightly higher ones did fix the problem. Cheers!

[bluesorella]

Perfect! I use the patch without any changes. For me (and my H2O) just perfect. Thanks a lot GeoffR!

[GeoffR]

I think I have found a bug, but it seems only to affect KePubs in full-screen mode (i.e. using the unofficial FullScreenReading=true feature setting.) It happens with or without patches, and I tried a number of KePub books with the same result. Can someone else using full-screen mode feature reproduce this?

1. Untick the "Show header and footer" reading setting
2. Open a KePub book
3. Swipe or tap until you get to the next chapter
4. Try to change the margins from the Aa menu

I found that once I had read past a chapter break I could no longer change the margins at all. The problem remained until I closed and re-opened the book.

This didn't affect KePubs in normal reading mode, or ePubs in either reading mode.

[bluesorella]

Originally Posted by GeoffR

I think I have found a bug, but it seems only to affect KePubs in full-screen mode (i.e. using the unofficial FullScreenReading=true feature setting.) It happens with or without patches, and I tried a number of KePub books with the same result. Can someone else using full-screen mode feature reproduce this?

1. Untick the "Show header and footer" reading setting
2. Open a KePub book
3. Swipe or tap until you get to the next chapter
4. Try to change the margins from the Aa menu

I found that once I had read past a chapter break I could no longer change the margins at all. The problem remained until I closed and re-opened the book.

This didn't affect KePubs in normal reading mode, or ePubs in either reading mode.

Just have tried. Same here GeoffR (KePub on H2O). Bu not too serious I think .

[GeoffR]

Originally Posted by bluesorella

Just have tried. Same here GeoffR (KePub on H2O). Bu not too serious I think .

Thanks. I agree, not a big problem. I've put a note about it in post #2, I think it helps to know the cause if you are affected by it.

[murg]

I've updated the first post of the Direct Links to Kobo Firmware thread to include this thread.

[lkstrummer]

First of all, thanks for your hard work in providing these amazing patches for us, Geoff. However, I'm having trouble with the "custom reading footer style" patch in the latest release on my H2O. I would like the footer height to be what I was previously using on the 3.17.3 firmware, but setting those values creates an output error. In fact, uncommenting the default values for "# Example replacement footer height values: AuraHD/H2O/GloHD" in your patch and leaving everything else in all three patch files at default values causes an output error as well. So, this:

# Example replacement footer height values: AuraHD/H2O/GloHD
replace_string = 001A, `footerMargin: 105;`, `footerMargin: 170;`
replace_string = 002D, `min-height: 70px;`, `min-height: 52px;`
replace_string = 003F, `max-height: 70px;`, `max-height: 52px;`

causes an output error.

My H2O was previously on the 3.17.3 patched firmware and I was using this value for that patch without any errors:

# Replacement footer height values: AuraHD/H2O/GloHD
replace_string = 00DA, `min-height: 120px;`, `min-height: 036px;`
replace_string = 00EE, `max-height: 120px;`, `max-height: 036px;`

I've also left the font size untouched at 26px for the H2O in both patches and did not uncomment anything else in that particular patch.

Help to get the new patch to approximate my previous values would be greatly appreciated. Thanks, again

[GeoffR]

The patch has changed a bit, there is no way around that because the firmware changed and I had to adapt. But it should be possible to get the same result with the new patch I think.

The patch has some example values set for the Glo/Aura. When you uncomment the AuraHD/H2O/GloHD example then you need to comment out the Glo/Aura example.

i.e. change:

# Example replacement footer height values: Touch/Mini
#replace_string = 001A, `footerMargin: 105;`, `footerMargin: 105;`
#replace_string = 002D, `min-height: 70px;`, `min-height: 32px;`
#replace_string = 003F, `max-height: 70px;`, `max-height: 32px;`
# Example replacement footer height values: Glo/Aura
replace_string = 001A, `footerMargin: 105;`, `footerMargin: 105;`
replace_string = 002D, `min-height: 70px;`, `min-height: 40px;`
replace_string = 003F, `max-height: 70px;`, `max-height: 40px;`
# Example replacement footer height values: AuraHD/H2O/GloHD
#replace_string = 001A, `footerMargin: 105;`, `footerMargin: 170;`
#replace_string = 002D, `min-height: 70px;`, `min-height: 52px;`
#replace_string = 003F, `max-height: 70px;`, `max-height: 52px;`

to:

# Example replacement footer height values: Touch/Mini
#replace_string = 001A, `footerMargin: 105;`, `footerMargin: 105;`
#replace_string = 002D, `min-height: 70px;`, `min-height: 32px;`
#replace_string = 003F, `max-height: 70px;`, `max-height: 32px;`
# Example replacement footer height values: Glo/Aura
#replace_string = 001A, `footerMargin: 105;`, `footerMargin: 105;`
#replace_string = 002D, `min-height: 70px;`, `min-height: 40px;`
#replace_string = 003F, `max-height: 70px;`, `max-height: 40px;`
# Example replacement footer height values: AuraHD/H2O/GloHD
replace_string = 001A, `footerMargin: 105;`, `footerMargin: 170;`
replace_string = 002D, `min-height: 70px;`, `min-height: 52px;`
replace_string = 003F, `max-height: 70px;`, `max-height: 52px;`

If you change the replacement values, then you need to make sure the replacement is exactly the same length as the original. e.g. for a footer height of 36px, change:

replace_string = 002D, `min-height: 70px;`, `min-height: 52px;`
replace_string = 003F, `max-height: 70px;`, `max-height: 52px;

to:

replace_string = 002D, `min-height: 70px;`, `min-height: 36px;`
replace_string = 003F, `max-height: 70px;`, `max-height: 36px;

[GeoffR]

I see now that I did change the `Custom reading footer style` patch options for the margin-top and font-family, I didn't mean to do that I just forgot to change them back from when I was testing the patch.

At the end of the patch, the original options were set like this:

#
# Replacement caption top margin value for all devices:
# (A negative top margin moves the caption text upwards,
# further from the bezel and closer to the page content.)
replace_string = 001A, `margin-top: 00px;`, `margin-top:-10px;`
#
# Uncomment to use a fixed replacement caption font family, for all devices:
# (You can change Avenir to another font name of your choice, but Avenir or
# Georgia are recommended because other fonts may not be loaded when the book
# is first opened and so might cause problems. Unlike other strings it is OK
# if this replacement string is a bit longer or shorter than the original.)
#replace_string = 00D7, `#caption[qApp_localeName="ja_JP"] {font-family: Sans-SerifJP;}`, `#caption {font-family: Amasis;}

and in the new patch I had them set to

#
# Replacement caption top margin value for all devices:
# (A negative top margin moves the caption text upwards,
# further from the bezel and closer to the page content.)
#replace_string = 001A, `margin-top: 00px;`, `margin-top:-10px;`
#
# Uncomment to use a fixed replacement caption font family, for all devices:
# (You can change Avenir to another font name of your choice, but Avenir or
# Georgia are recommended because other fonts may not be loaded when the book
# is first opened and so might cause problems. Unlike other strings it is OK
# if this replacement string is a bit longer or shorter than the original.)
replace_string = 00D7, `#caption[qApp_localeName="ja_JP"] {font-family: Sans-SerifJP;}`, `#caption {font-family: Georgia;}

I'll change these back the way they were and update the archive in post #1. Edit: Done now.