Instructions for patching firmware 3.12.0

[GeoffR]

Before starting:

1. Make sure your Kobo ereader is already running firmware version 3.12.0 (563a2baefd).

2. Check that your battery is well charged.

3. Note that in Windows 8 the instructions below might require the batch file to be run in admistrator mode.


Patching from Windows, Linux (i386/x86_64), or Mac (OS X 10.8-10.9, i386/x86_64):

1. Download and extract patch_kobo_3120.zip (attached). [WARNING: If using Windows, make sure the path to the extracted files does not contain any '&' characters.]

2. Download the Kobo firmware archive version 3.12.0 for your device (See this thread) into the 3.12.0_source subdirectory. (Don't extract.)

3. Read and edit all the *.patch files in the 3.12.0_source subdirectory in order to: choose which patches to enable (patch_enable=`yes`) or disable (patch_enable=`no`); and to change some of the replacement values to suit your device and preferences. (See the section below on customising the patches.)

4. In Windows double-click 3.12.0.bat; For Linux/Mac open a terminal, change to the patch_kobo_3120 directory, and run ./3.12.0.sh from the command line.

5. If there were no errors, copy the resulting KoboRoot.tgz from the 3.12.0_target subdirectory to the .kobo directory on your ereader.

6. Safely eject and unplug the device, which will then update and restart.


To return your ereader to its original unpatched state:

1. Edit all the 3.12.0_source/*.patch files to disable all patches (set patch_enable = `no` for every patch).

2. Repeat steps 4-6 of the procedure above.


Customising the patches to suit your preferences and device

Some patches require no customisation, you can choose simply to enable them or not. But the following patches allow more customisation and their initial values should be considered examples only.

1. Custom reading footer style: There are six example footer styles, comment out the styles you don't want by adding a "#" character at the beginning of the line beginning with replace_, and leave the style you want uncommented. Examples 1 or 4 are best if using the ePub adjustable top/bottom margin patches.

More complex customisation is possible, see this post for a guide on what all the options do.

2. My line spacing values: Change the lines of the enabled patch starting with replace_float: the middle number is the original spacing value, the number to change is on the right.

The values are the line spacings set by the adjustment slider. The actual spacing depends on the font used, but for most fonts a value of 0.7 gives very tight spacing with ascenders/descenders overlapping, a value of about 0.9 gives a spacing similar to that of a mass-market paperback. The smallest value available in the unpatched firmware is 1.0.

3. Custom font sizes: Change the lines starting with replace_int. The middle number is the original value, the number to change is on the right.

The values are the font sizes set by the adjustment slider, they are in pixels so the absolute size depends on the device: size 20 on the Glo is about the same as size 25 on the AuraHD. Some books change the base font size, so you may need font sizes that are larger or smaller than your normal reading size to allow for adjusting such books.

4. Custom left & right margins: Change the lines starting with replace_int. The middle number is the original value, the number to change is on the right.

The values are the margin widths (in units of about 1% screen width I think) set by the adjustment slider. The margin size is added to whatever margin is fixed in the book (if any) and in reading software (The kepub reader has a base margin of about 2 units, the epub reader has a base margin of zero).

5. Brightness fine control: Change the lines starting with replace_int. The middle number is the original value, the number to change is on the right.

The values are the percentage amounts that the brightness slider changes when the small or large sun symbols are tapped. (Both should probably be set to the same value).

6. ePub adjustable top/bottom margin (disabled by default): Comment out one of the replace_string lines (i.e. add a '#' character to the beginning of the line) and leave the other uncommented to select whether both top and bottom, or just the top margin, should be made adjustable. Change the right-most number of the replace_int line to set the size of the top/bottom margins relative to the left/right margins, depending on your device. (The suggested values should make the top/bottom margins roughly equal to the left/right margins).

7. ePub fixed top/bottom margin (disabled by default): Comment out one of the replace_string lines (i.e. add a '#' character to the beginning of the line) and leave the other uncommented to select whether to increase both top and bottom, or just the top margin. The replacement value is the size (in pixels) of the increased margin, seperated by \x00. For example, to fix the margin at 40 pixels instead of 25 pixels, change the replacement value from 2\x005 to 4\x000

[GeoffR]

Notes for firmware 3.12.0:

The number of different font sizes in the `Custom font sizes` patch has increased from 24 to 40 in this firmware version.

When reading kepubs with a low line spacing setting, a partial line of text can appear at the top or bottom of a page. To avoid this it is necessary to increase the line spacing a bit. See this screenshot for example, and see this post for what I think is causing the problem.


More patches for firmware 3.12.0:
If you know of any more patches for firmware 3.12.0 post them in this thread and I'll add them to this list:


The custom reading footer patch in the attachment to post #1 has a new layout: there are now three seperate patches for Touch/Mini, Glo/Aura, AuraHD/H2O; each patch has six example footer sizes.

Here is the old style patch (libnickel.so.1.0.0.patch):

Spoiler:

<Patch>
patch_name = `Custom reading footer style`
patch_enable = `yes`
replace_string = E359A4, `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 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.)
#
# Example for Touch/Mini:
#replace_string = E359B5, `min-height: 70px;`, `min-height: 32px;`
#replace_string = E359C8, `max-height: 70px;`, `max-height: 32px;`
#replace_string = E359E5, `footerMargin: 105;`, `footerMargin: 105;`
#replace_string = E35A00, `font-size: 16px;`, `font-size: 16px;`
#replace_string = E35A12, `padding-bottom: 0px;`, `padding-bottom: 4px;`
#replace_string = E35A28, `margin-top: 0px;`, `margin-top: 0px;`
#
# Example for Glo/Aura:
#replace_string = E359B5, `min-height: 70px;`, `min-height: 40px;`
#replace_string = E359C8, `max-height: 70px;`, `max-height: 40px;`
#replace_string = E359E5, `footerMargin: 105;`, `footerMargin: 105;`
#replace_string = E35A00, `font-size: 16px;`, `font-size: 20px;`
#replace_string = E35A12, `padding-bottom: 0px;`, `padding-bottom: 5px;`
#replace_string = E35A28, `margin-top: 0px;`, `margin-top: 0px;`
#
# Example for AuraHD/H2O:
#replace_string = E359B5, `min-height: 70px;`, `min-height: 50px;`
#replace_string = E359C8, `max-height: 70px;`, `max-height: 50px;`
#replace_string = E359E5, `footerMargin: 105;`, `footerMargin: 170;`
#replace_string = E35A00, `font-size: 16px;`, `font-size: 26px;`
#replace_string = E35A12, `padding-bottom: 0px;`, `padding-bottom: 8px;`
#replace_string = E35A28, `margin-top: 0px;`, `margin-top: 0px;`
#
# Uncomment one of the following if you wish the footer to use a fixed font.
# (And enable one of the Custom header style patches below with the same font.)
#
#replace_string = E35A3A, `/*font-family:none;*/`, `font-family:  Amasis;`
#replace_string = E35A3A, `/*font-family:none;*/`, `font-family:  Avenir;`
#replace_string = E35A3A, `/*font-family:none;*/`, `font-family: Georgia;`
#
</Patch>

A patch to display page numbers as 'x / y' instead of 'Page x of y' (libnickel.so.1.0.0.patch):

Spoiler:

<Patch>
patch_name = `Custom footer`
patch_enable = `yes`
#
# Changes the footer text with something shorter
# (not sure how it affects translations)
#
replace_string = D1BCE8, `Page %1 <i>of</i> %2`, `%1 / %2`
</Patch>

A patch to remove the white borders around book covers on the homescreen (libnickel.so.1.0.0.patch):

Spoiler:

<Patch>
patch_name = `Remove white borders from homescreen tile book covers`
patch_enable = `yes`
#PhoenixSmallRecentBookTile
replace_string = D59063, `coverBorder:4;`, `coverBorder:0;`
replace_string = D59134, `coverBorder:4;`, `coverBorder:0;`
#PocketRecentlyReadTile
replace_string = D5A02E, `coverBorder: 6;`, `coverBorder: 0;`
replace_string = D5A0F3, `coverBorder: 4;`, `coverBorder: 0;`
#RecentBookTile
replace_string = D5C4C8, `coverBorder:6;`, `coverBorder:0;`
replace_string = D5C580, `coverBorder:4;`, `coverBorder:0;`
replace_string = D5C667, `coverBorder:4;`, `coverBorder:0;`
#SmallRecentBookTile
replace_string = D5EDCE, `coverBorder:6;`, `coverBorder:0;`
</Patch>

A patch to squeeze a third row of book tiles onto the Glo/Aura homescreen, see this screenshot for example. (libnickel.so.1.0.0.patch):

Glo:

Spoiler:

<Patch>
patch_name = `Compact homepage layout (Glo)`
patch_enable = `yes`
#DragonHomePageView (Search bar height)
replace_string = D51AE8, `min-height:100px;`, `min-height:090px;`
replace_string = D51AFB, `max-height:100px;`, `max-height:090px;`
#QWidget (Space below search bar)
replace_string = D51C81, `min-height:40px;`, `min-height:08px;`
replace_string = D51C93, `max-height:40px;`, `max-height:08px;`
#MultiColumnTileView (Space between tiles)
replace_string = D51E31, `horizontalSpacing:10;`, `horizontalSpacing:04;`
replace_string = D51E52, `verticalSpacing:10;`, `verticalSpacing:04;`
#footer (Footer menu bar height)
replace_string = D5227E, `min-height:95px;`, `min-height:68px;`
replace_string = D52290, `max-height:95px;`, `max-height:68px;`
#PhoenixSmallRecentBookTile
replace_string = D59024, `percentFontSize:28;`, `percentFontSize:22;`
replace_string = D59043, `progressFontSize:22;`, `progressFontSize:22;`
#RecentBookTile
replace_string = D5C51B, `percentFontSize:28;`, `percentFontSize:22;`
replace_string = D5C540, `progressFontSize:22;`, `progressFontSize:22;`
</Patch>

Aura:

Spoiler:

<Patch>
patch_name = `Compact homepage layout (Aura)`
patch_enable = `yes`
#DragonHomePageView (Search bar height)
replace_string = D51AE8, `min-height:100px;`, `min-height:090px;`
replace_string = D51AFB, `max-height:100px;`, `max-height:090px;`
#QWidget (Space below search bar)
replace_string = D51C81, `min-height:40px;`, `min-height:02px;`
replace_string = D51C93, `max-height:40px;`, `max-height:02px;`
#MultiColumnTileView (Space between tiles)
replace_string = D51E31, `horizontalSpacing:10;`, `horizontalSpacing:02;`
replace_string = D51E52, `verticalSpacing:10;`, `verticalSpacing:02;`
#footer (Footer menu bar height)
replace_string = D5227E, `min-height:95px;`, `min-height:68px;`
replace_string = D52290, `max-height:95px;`, `max-height:68px;`
#PhoenixSmallRecentBookTile
replace_string = D59024, `percentFontSize:28;`, `percentFontSize:22;`
replace_string = D59043, `progressFontSize:22;`, `progressFontSize:22;`
#RecentBookTile
replace_string = D5C51B, `percentFontSize:28;`, `percentFontSize:22;`
replace_string = D5C540, `progressFontSize:22;`, `progressFontSize:22;`
</Patch>

A patch to customise the sleep and power-off timeout menus options (libnickel.so.1.0.0.patch):

Spoiler:

<Patch>
patch_name = `Custom Sleep/Power-off timeouts`
patch_enable = `yes`
# Values displayed on both menus
replace_string = DF5E0C, `5 mins\x00`, `10 mins`
replace_string = DF5E14, `10 mins`, `20 mins`
replace_string = DF5E1C, `15 mins`, `30 mins`
replace_string = DF5E24, `30 mins`, `1 hour`
replace_string = DF5E2C, `45 mins`, `2 hours`
replace_string = DF5E34, `60 mins`, `4 hours`
# Actual values used for sleep menu
replace_int = A6EF16, 5, 10
replace_int = A6EF60, 10, 20
replace_int = A6EFA4, 15, 30
replace_int = A6EFE8, 30, 60
replace_int = A6F02C, 45, 120
replace_int = A6F070, 60, 240
# Actual values used for power menu
replace_int = A6F124, 5, 10
replace_int = A6F168, 10, 20
replace_int = A6F1AA, 15, 30
replace_int = A6F1EA, 30, 60
replace_int = A6F22A, 45, 120
replace_int = A6F268, 60, 240
</Patch>

A patch to always (or never) turn on kepub hyphenation, regardless of justification setting. (libnickel.so.1.0.0.patch):

Spoiler:

<Patch>
patch_name = `Set kepub hyphenation`
patch_enable = `yes`
#
# The built-in kepub stylesheet has a line "* { -webkit-hyphenation: auto; }"
# to turn on hyphenation, but it is only used if the device's justification
# button is set to full justification. With this patch enabled hyphenation
# will always/never be turned on, regardless of justification button setting.
#
# (Note that if the publisher has set the hyphenation in the book's stylesheet
# then that will override the built-in stylesheet.)
#
# Alternative 1: Always turn kepub hyphenation on
replace_bytes = 9FE476, 5B F6 8C E1, 01 20 01 20
# Alternative 2: Never turn kepub hyphenation on
#replace_bytes = 9FE476, 5B F6 8C E1, 00 20 00 20
</Patch>

A patch to fix the kepub bug that cuts off letters with large side bearing (such as f) in full-screen mode. https://www.mobileread.com/forums/sho...&postcount=130


A patch to make the line spacing and justification settings selected from the reading settings (Aa) menu take effect on some epub books where they didn't before. https://www.mobileread.com/forums/sho...1&postcount=95


Patches to use a fixed font sharpness value in ePub / KePub books:
https://www.mobileread.com/forums/sho...4&postcount=96


An improved `ePub fixed/adjustable top/bottom margins` patch to replace the existing `ePub adjustable top/bottom margin` and `ePub fixed top/bottom margin` patches:
https://www.mobileread.com/forums/sho...&postcount=109

Attached are the main patches from post #1 for use with kpg.exe:

[JSWolf]

That was fast. Thank you!

[Ripplinger]

I'm getting a replace_string mismatched data error for the patch to display page numbers as 'x / y' instead of 'Page x of y' (libnickel.so.1.0.0.patch). I've tried adding enough spaces to match the original string but still getting the same error. I added it towards the bottom of the libnickel.so.1.0.0.patch file with the rest of the patches, which I've done in the past, and it's worked before, but I'm sure I'm doing something wrong.

<Patch>
patch_name = `Custom footer`
patch_enable = `yes`
#
# Changes the footer text with something shorter
# (not sure how it affects translations)
#
replace_string = D1BCE8, `Page %1 <i>of</i> %2`, `%1 / %2`
</Patch>

Edited: Edited the incorrect string here just to prevent anyone accidentally using it.

[jackie_w]

Originally Posted by Ripplinger

... I'm sure I'm doing something wrong

No, I don't think so, there's a typo. Try this instead.

<Patch>
patch_name = `Custom footer`
patch_enable = `yes`
#
# Changes the footer text with something shorter
# (not sure how it affects translations)
#
replace_string = D1BCE8, `Page %1 <i>of</i> %2`, `%1 / %2`
</Patch>

[Ripplinger]

Originally Posted by jackie_w

No, I don't think so, there's a typo. Try this instead.

<Patch>
patch_name = `Custom footer`
patch_enable = `yes`
#
# Changes the footer text with something shorter
# (not sure how it affects translations)
#
replace_string = D1BCE8, `Page %1 <i>of</i> %2`, `%1 / %2`
</Patch>

That worked great, thank you for the catch (and for once I DIDN'T SCREW UP! hehe).

[GeoffR]

Originally Posted by jackie_w

No, I don't think so, there's a typo. Try this instead.

<Patch>
patch_name = `Custom footer`
patch_enable = `yes`
#
# Changes the footer text with something shorter
# (not sure how it affects translations)
#
replace_string = D1BCE8, `Page %1 <i>of</i> %2`, `%1 / %2`
</Patch>

Thanks, I've edited post #2 to fix this patch.

[Martina Schein]

Thanks for the new Patcher, GeoffR.

[karamasova]

C:\Users\XXX\Desktop\patch_kobo_3120\patch_kobo_31 20\tools\pa32lsb.exe: line 490 in 'C:\Users\XXX\Desktop\patch_kobo_3120\patch_kobo_3 120\3.12.0_source\libnic
kel.so.1.0.0.patch': replace_string mismatched data.
ERROR processing C:\Users\XXX\Desktop\patch_kobo_3120\patch_kobo_31 20\3.12.0_so
urce\libnickel.so.1.0.0.patch

[GeoffR]

Originally Posted by karamasova

If enable 'ePub fixed top/bottom margin', Error line 490.

I can't find any problem, can you check that `ePub adjustable top/bottom margin` is not enabled as well? (These two patches are mutually exclusive, the margins can't be both fixed and adjustable.)

[erikssenmar867]

Thanks as usual GeoffR! Is it possible to create "Custom Sleep/Power-off time menu options" also for this fw?

[karamasova]

Originally Posted by GeoffR

I can't find any problem, can you check that `ePub adjustable top/bottom margin` is not enabled as well? (These two patches are mutually exclusive, the margins can't be both fixed and adjustable.)

It was enable both adjustable and fixed. I didn't check the other is enable. Thank you, GeoffR

[doubleshuffle]

Totally unbelievable - the patch is up before I even realise there's a new FW - how do you do that, Geoff?

[GeoffR]

Originally Posted by erikssenmar867

Thanks as usual GeoffR! Is it possible to create "Custom Sleep/Power-off time menu options" also for this fw?

I've added this patch to post #2.

[Ripplinger]

One thing I noticed different between 3.11.0 and 3.12.0 is that the patch for enabling the Advanced Settings for fonts works properly with all fonts for me on 3.12.0. In 3.11.0, it didn't always work for some reason... the Advanced Settings weren't there, or when it was, it didn't make any difference on the font even when setting to full right. The sample showed the change, but when you clicked ok and off that screen, the font was still normal and not any darker/thicker. Might have just been a quirk on my readers, but I did have 3.11.0 and the same patches installed on 2 Glos.