Instructions for patching firmware 3.11.0

[tshering]

@xtine
Could you investigate the KoboRoot.tgz that you created. If you extract the content you should find in usr\local\Kobo\ the files libadobe.so, libnickel.so.1.0.0, and librmsdk.so.1.0.0 (or maybe only one or two of them). Could you compare the (exact) size with those files of the same name in 3.11.0_source?

[xtine]

tshering, thanks for helping first of all attaching screen shots as I'm quite confused now -- there seem to be 2 files with the same file name (one with the patch extension, one without) in the 3.11.0_source subfolder while in the extracted tgz, there are only 3 files, all without the patch extension. File sizes are the same though.

[xtine]

I took a chance and redid everything on my sister's PC. I think there are no errors this time. Would it be safe to proceed?

[tshering]

Originally Posted by xtine

I took a chance and redid everything on my sister's PC. I think there are no errors this time. Would it be safe to proceed?

My guess is that the KoboRoot.tgz you created on your sister's PC is identical with the one you created previously. There must be a different problem.
The only thing I can think of is that your H2O was not on FW 3.11.0 when you copied the KoboRoot.tgz onto it. Are you really sure that is was? Did you check "settings" > "device information" on the reader?

As for the use of the *.patch files, please have a look at the first post.

[xtine]

I updated my H2O with the newly generated TGZ and everything is working properly now

One last question, if I want to edit/enable/disable some of the patches, would I have to do everything all over again? Or just extract the patch from the TGZ in the .kobo folder, make the changes, and compress everything?

BTW For some reason, using the same files to successfully create a TGZ on the PC still results in an error message on my Mac.

[tshering]

Originally Posted by xtine

I updated my H2O with the newly generated TGZ and everything is working properly now

One last question, if I want to edit/enable/disable some of the patches, would I have to do everything all over again? Or just extract the patch from the TGZ in the .kobo folder, make the changes, and compress everything?

After editing the *.patch files you have to run 3.11.0.bat. This is the only way (under windows).

Originally Posted by xtine

BTW For some reason, using the same files to successfully create a TGZ on the PC still results in an error message on my Mac.

I do not now anything about Mac.

[xtine]

Thank you for all your help, I appreciate it

[GeoffR]

Originally Posted by xtine

BTW For some reason, using the same files to successfully create a TGZ on the PC still results in an error message on my Mac.

Someone else had a similar problem on their Mac, I'm not certain of the cause but it might be that some Macs come with versions of the unzip or tar commands that are incompatible with the script.

[xtine]

I played around with it and finally got it to work on my Mac. I think what I did wrong earlier was right clicking the .sh file and selecting "open with Terminal". You really have to manually go to the patch_kobo_3110 folder through Terminal and from there, type "./3.11.0.sh". Playing around with the patches now. Thanks, GeoffR!

[GeoffR]

I am trying to make the `Custom footer style` patch a bit easier to customise. Instead of one patch with one example setup for each device, here are seperate patches for each device with six examples to choose from. (Replace the `Custom reading footer style` patch in libnickel.so.1.0.0 with one of these patches):

Touch/Mini:

Spoiler:

<Patch>
patch_name = `Custom reading footer style (Touch/Mini)`
patch_enable = `yes`
replace_string = DBDBFC, `ReadingFooter {\n\tmin-height: 70px;\n\tmax-height: 70px;\n\tqproperty-footerMargin: 105;\n}\n\nReadingFooter[qApp_deviceCodeName="phoenix"] {\n\tmin-height: 82px;\n\tmax-height: 82px;\n}\n\nReadingFooter[qApp_deviceCodeName="dragon"] {\n\tmin-height: 120px;\n\tmax-height: 120px;\n\tqproperty-footerMargin: 170;\n}\n\n* {\n\tfont-size: 16px;\n}\n\n[qApp_deviceCodeName="phoenix"] {\n\tfont-size: 20px;\n}\n\n[qApp_deviceCodeName="dragon"] {\n\tfont-size: 26px;\n}\n\n[qApp_localeName="ja_JP"] {\n\tfont-family: A-OTF Gothic MB101 Pr6N;\n}`, `ReadingFooter {\n\tmin-height: 70px;\n\tmax-height: 70px;\n\tqproperty-footerMargin: 105;\n}\n\n* {\n\tfont-size: 16px;\n\tpadding-bottom: 0px;\n\tmargin-top: 0px;\n\t/*font-family:none;*/\n}\n\n[qApp_localeName="ja_JP"] {\n\tfont-family: A-OTF Gothic MB101 Pr6N;\n}`
#
# Uncomment the three replace_string lines of one of the examples below,
# comment out the rest. If you choose to make further changes to the examples,
# BE CAREFUL NOT TO ALTER THE LENGTH OF THE REPLACEMENT STRINGS! (Add or remove
# spaces if necessary to keep the total length the same.)
#
# Examples 1 or 4 are recommended for use with the adjustable/fixed top/bottom
# margin patches when configured to set both top and bottom margins.
#
# Examples 4, 5 or 6 are recommended if you also read kepubs, because the space
# between bezel and footer matches the space between bezel and kepub header.
#
#
# Example 1: Small footer, close to bezel
#replace_string = DBDC0D, `min-height: 70px;`, `min-height: 24px;`
#replace_string = DBDC20, `max-height: 70px;`, `max-height: 24px;`
#replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom: 4px;`
#
# Example 2: Medium footer, close to bezel
replace_string = DBDC0D, `min-height: 70px;`, `min-height: 32px;`
replace_string = DBDC20, `max-height: 70px;`, `max-height: 32px;`
replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom: 4px;`
#
# Example 3: Large footer, close to bezel
#replace_string = DBDC0D, `min-height: 70px;`, `min-height: 48px;`
#replace_string = DBDC20, `max-height: 70px;`, `max-height: 48px;`
#replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom: 0px;`
#
# Example 4: Small footer, away from bezel
#replace_string = DBDC0D, `min-height: 70px;`, `min-height: 24px;`
#replace_string = DBDC20, `max-height: 70px;`, `max-height: 24px;`
#replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom:20px;`
#
# Example 5: Medium footer, away from bezel
#replace_string = DBDC0D, `min-height: 70px;`, `min-height: 32px;`
#replace_string = DBDC20, `max-height: 70px;`, `max-height: 32px;`
#replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom:16px;`
#
# Example 6: Large footer, away from bezel
#replace_string = DBDC0D, `min-height: 70px;`, `min-height: 48px;`
#replace_string = DBDC20, `max-height: 70px;`, `max-height: 48px;`
#replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom: 8px;`
#
#
# Uncomment the following line to reduce the footer font size:
#replace_string = DBDC58, `font-size: 16px;`, `font-size: 14px;`
#
# Uncomment the following line to further reduce the space above the footer:
#replace_string = DBDC80, `margin-top: 0px;`, `margin-top:-4px;`
#
# Uncomment one of the following lines to use a fixed font style. This is
# recommended if you have chosen examples 1 or 4 above, because some other
# fonts sit too low in the footer and get cut off at the bottom.
# Also enable one of the Custom header style patches below with the same font
# style if you read kepubs.
#
#replace_string = DBDC92, `/*font-family:none;*/`, `font-family:  Amasis;`
#replace_string = DBDC92, `/*font-family:none;*/`, `font-family:  Avenir;`
#replace_string = DBDC92, `/*font-family:none;*/`, `font-family: Georgia;`
#
</Patch>

Glo/Aura:

Spoiler:

<Patch>
patch_name = `Custom reading footer style (Glo/Aura)`
patch_enable = `yes`
replace_string = DBDBFC, `ReadingFooter {\n\tmin-height: 70px;\n\tmax-height: 70px;\n\tqproperty-footerMargin: 105;\n}\n\nReadingFooter[qApp_deviceCodeName="phoenix"] {\n\tmin-height: 82px;\n\tmax-height: 82px;\n}\n\nReadingFooter[qApp_deviceCodeName="dragon"] {\n\tmin-height: 120px;\n\tmax-height: 120px;\n\tqproperty-footerMargin: 170;\n}\n\n* {\n\tfont-size: 16px;\n}\n\n[qApp_deviceCodeName="phoenix"] {\n\tfont-size: 20px;\n}\n\n[qApp_deviceCodeName="dragon"] {\n\tfont-size: 26px;\n}\n\n[qApp_localeName="ja_JP"] {\n\tfont-family: A-OTF Gothic MB101 Pr6N;\n}`, `ReadingFooter {\n\tmin-height: 82px;\n\tmax-height: 82px;\n\tqproperty-footerMargin: 105;\n}\n\n* {\n\tfont-size: 20px;\n\tpadding-bottom: 0px;\n\tmargin-top: 0px;\n\t/*font-family:none;*/\n}\n\n[qApp_localeName="ja_JP"] {\n\tfont-family: A-OTF Gothic MB101 Pr6N;\n}`
#
# Uncomment the three replace_string lines of one of the examples below,
# comment out the rest. If you choose to make further changes to the examples,
# BE CAREFUL NOT TO ALTER THE LENGTH OF THE REPLACEMENT STRINGS! (Add or remove
# spaces if necessary to keep the total length the same.)
#
# Examples 1 or 4 are recommended for use with the adjustable/fixed top/bottom
# margin patches when configured to set both top and bottom margins.
#
# Examples 4, 5 or 6 are recommended if you also read kepubs, because the space
# between bezel and footer matches the space between bezel and kepub header.
#
#
# Example 1: Small footer, close to bezel
#replace_string = DBDC0D, `min-height: 82px;`, `min-height: 30px;`
#replace_string = DBDC20, `max-height: 82px;`, `max-height: 30px;`
#replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom: 5px;`
#
# Example 2: Medium footer, close to bezel
replace_string = DBDC0D, `min-height: 82px;`, `min-height: 40px;`
replace_string = DBDC20, `max-height: 82px;`, `max-height: 40px;`
replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom: 5px;`
#
# Example 3: large footer, close to bezel
#replace_string = DBDC0D, `min-height: 82px;`, `min-height: 60px;`
#replace_string = DBDC20, `max-height: 82px;`, `max-height: 60px;`
#replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom: 0px;`
#
# Example 4: Small footer, away from bezel
#replace_string = DBDC0D, `min-height: 82px;`, `min-height: 30px;`
#replace_string = DBDC20, `max-height: 82px;`, `max-height: 30px;`
#replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom:25px;`
#
# Example 5: Medium footer, away from bezel
#replace_string = DBDC0D, `min-height: 82px;`, `min-height: 40px;`
#replace_string = DBDC20, `max-height: 82px;`, `max-height: 40px;`
#replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom:20px;`
#
# Example 6: Large footer, away from bezel
#replace_string = DBDC0D, `min-height: 82px;`, `min-height: 60px;`
#replace_string = DBDC20, `max-height: 82px;`, `max-height: 60px;`
#replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom:10px;`
#
#
# Uncomment the following line to reduce the footer font size:
#replace_string = DBDC58, `font-size: 20px;`, `font-size: 18px;`
#
# Uncomment the following line to further reduce the space above the footer:
#replace_string = DBDC80, `margin-top: 0px;`, `margin-top:-5px;`
#
# Uncomment one of the following lines to use a fixed font style. This is
# recommended if you have chosen examples 1 or 4 above, because some other
# fonts sit too low in the footer and get cut off at the bottom.
# Also enable one of the Custom header style patches below with the same font
# style if you read kepubs.
#
#replace_string = DBDC92, `/*font-family:none;*/`, `font-family:  Amasis;`
#replace_string = DBDC92, `/*font-family:none;*/`, `font-family:  Avenir;`
#replace_string = DBDC92, `/*font-family:none;*/`, `font-family: Georgia;`
#
</Patch>

Aura HD/H2O:

Spoiler:

<Patch>
patch_name = `Custom reading footer style (Aura HD/H2O)`
patch_enable = `yes`
replace_string = DBDBFC, `ReadingFooter {\n\tmin-height: 70px;\n\tmax-height: 70px;\n\tqproperty-footerMargin: 105;\n}\n\nReadingFooter[qApp_deviceCodeName="phoenix"] {\n\tmin-height: 82px;\n\tmax-height: 82px;\n}\n\nReadingFooter[qApp_deviceCodeName="dragon"] {\n\tmin-height: 120px;\n\tmax-height: 120px;\n\tqproperty-footerMargin: 170;\n}\n\n* {\n\tfont-size: 16px;\n}\n\n[qApp_deviceCodeName="phoenix"] {\n\tfont-size: 20px;\n}\n\n[qApp_deviceCodeName="dragon"] {\n\tfont-size: 26px;\n}\n\n[qApp_localeName="ja_JP"] {\n\tfont-family: A-OTF Gothic MB101 Pr6N;\n}`, `ReadingFooter {\n\tmin-height:120px;\n\tmax-height:120px;\n\tqproperty-footerMargin: 170;\n}\n\n* {\n\tfont-size: 26px;\n\tpadding-bottom: 0px;\n\tmargin-top: 0px;\n\t/*font-family:none;*/\n}\n\n[qApp_localeName="ja_JP"] {\n\tfont-family: A-OTF Gothic MB101 Pr6N;\n}`
#
# Uncomment the three replace_string lines of one of the examples below,
# comment out the rest. If you choose to make further changes to the examples,
# BE CAREFUL NOT TO ALTER THE LENGTH OF THE REPLACEMENT STRINGS! (Add or remove
# spaces if necessary to keep the total length the same.)
#
# Examples 1 or 4 are recommended for use with the adjustable/fixed top/bottom
# margin patches when configured to set both top and bottom margins.
#
# Examples 4, 5 or 6 are recommended if you also read kepubs, because the space
# between bezel and footer matches the space between bezel and kepub header.
#
#
# Example 1: Small footer, close to bezel
#replace_string = DBDC0D, `min-height:120px;`, `min-height: 40px;`
#replace_string = DBDC20, `max-height:120px;`, `max-height: 40px;`
#replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom: 7px;`
#
# Example 2: Medium footer, close to bezel
replace_string = DBDC0D, `min-height:120px;`, `min-height: 52px;`
replace_string = DBDC20, `max-height:120px;`, `max-height: 52px;`
replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom: 7px;`
#
# Example 3: Large footer, close to bezel
#replace_string = DBDC0D, `min-height:120px;`, `min-height: 80px;`
#replace_string = DBDC20, `max-height:120px;`, `max-height: 80px;`
#replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom: 0px;`
#
# Example 4: Small footer, away from bezel
#replace_string = DBDC0D, `min-height:120px;`, `min-height: 40px;`
#replace_string = DBDC20, `max-height:120px;`, `max-height: 40px;`
#replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom:36px;`
#
# Example 5: Medium footer, away from bezel
#replace_string = DBDC0D, `min-height:120px;`, `min-height: 52px;`
#replace_string = DBDC20, `max-height:120px;`, `max-height: 52px;`
#replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom:30px;`
#
# Example 6: Large footer, away from bezel
#replace_string = DBDC0D, `min-height:120px;`, `min-height: 80px;`
#replace_string = DBDC20, `max-height:120px;`, `max-height: 80px;`
#replace_string = DBDC6A, `padding-bottom: 0px;`, `padding-bottom:16px;`
#
#
# Uncomment the following line to reduce the footer font size:
#replace_string = DBDC58, `font-size: 26px;`, `font-size: 23px;`
#
# Uncomment the following line to further reduce the space above the footer:
#replace_string = DBDC80, `margin-top: 0px;`, `margin-top:-7px;`
#
# Uncomment one of the following lines to use a fixed font style. This is
# recommended if you have chosen examples 1 or 4 above, because some other
# fonts sit too low in the footer and get cut off at the bottom.
# Also enable one of the Custom header style patches below with the same font
# style if you read kepubs.
#
#replace_string = DBDC92, `/*font-family:none;*/`, `font-family:  Amasis;`
#replace_string = DBDC92, `/*font-family:none;*/`, `font-family:  Avenir;`
#replace_string = DBDC92, `/*font-family:none;*/`, `font-family: Georgia;`
#
</Patch>

Example 1 (43%): Small footer, close to the bezel
Example 2 (55%): Medium footer, close to the bezel (same as the example in the original patch)
Example 3 (73%): Large footer, close to the bezel
Example 4 (67%): Small footer, away from the bezel
Example 5 (73%): Medium footer, away from the bezel
Example 6 (85%): Large footer, away from the bezel

The percentage is the total height of the footer compared to 100% in the unpatched firmware (Glo/Aura example).

Examples 1 or 4 are better if you use the `ePub adjustable top/bottom margin` patch, because it results in the total top and bottom margins being fairly even.

Examples 4, 5 or 6 are better if you read kepubs as well as epubs, because it makes the gap between the bezel and footer similar to the gap between the bezel and kepub header.

If you use one of the small footers (1 or 4) then it is best to also choose a fixed footer font style from one of the examples (I recommend Georgia or Avenir), otherwise some fonts (such as Gothic, which is used for document default) will not fit in the footer and will be cut off at the bottom.

(Example 4, with footer and header font fixed to Avenir, and the adjustable top/bottom margins patch is what I use on my Glo. This pic shows what it looks like with the sliders set to margin size 6, font size 35, line spacing 0.88)

Any suggestions for improvement welcome.

[Nick_1964]

Thank you GeoffR !

[giododa]

Great job!

[aceflor]

Super nice Geoff, thanks !!!

[Hypernova]

Originally Posted by GeoffR

Notes:
There is a new version of the `Freedom to advanced fonts control` patch: beware that it is not be safe to use this patch if you have your device language set to Japanese or are reading japanese books. If you try this patch, please let me know if you notice any problems.

I'd like to ask for clarification on this. My device is not set to Japanese but from time to time I do read a Japanese book. Is it ok to enable this patch as long as I avoid touching the advanced fonts control while reading Japanese book?

[GeoffR]

Originally Posted by Hypernova

I'd like to ask for clarification on this. My device is not set to Japanese but from time to time I do read a Japanese book. Is it ok to enable this patch as long as I avoid touching the advanced fonts control while reading Japanese book?

I think any problem will be triggered when the settings (Aa) menu is opened, or possibly when the dropdown menu for choosing the font family is opened.

I dont know what form the problem will take though, it might be something obvious like a crash, or something minor like not choosing the correct default font for a Japanese book, or it might corrupt some memory and cause a problam later on.