Instructions for patching firmware 4.2.8110

[GeoffR]

This firmware version has only been oficially released for the Aura One and Aura Edition 2, it should work on other Mk 6 devices (Glo HD, Touch 2.0) but don't try to install it on other devices unless you know what you are doing, installing the wrong firmware could potentailly result in an unbootable ereader.

See the FW 4.2.8110 discussion thread for information about what has changed in this firmware version.

See the Index to the Metazoa firmware patches thread for a description of what some of these patches do.


Before starting:

1. Make sure your Kobo ereader is already running firmware version 4.2.8110 (4f749ed9be). If not, then you need to upgrade before applying this patch.

2. Check that your battery is well charged.


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

1. Download and extract patch_kobo_4028110.zip (attached).

2. Download the Kobo firmware archive version 4.2.8110 for your device (See this thread) and copy it into the 4.2.8110_source/ subdirectory. (Don't unzip the firmware.)

3. Read and edit all the *.patch files in the 4.2.8110_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.

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

5. If there were no errors, copy the resulting KoboRoot.tgz from the 4.2.8110_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 4.2.8110_source/*.patch files to disable all patches (set patch_enable = `no` for every patch).

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


Note that the following patches are enabled by default:

`Fix page breaks bug`
`Default ePub monospace font (Courier)`
`Custom left & right margins`
`Search in Library by default`
`Custom page refresh options (1,2,3,...,12)`
`Fix three KePub fullScreenReading bugs`

[GeoffR]

The firmware link for this version (Mk6 devices only) is http://download.kobobooks.com/firmwa...e-4.2.8110.zip

All of the patches from firmware 4.1.7729 are complete. The following patches from firmare 3.19.5761 are still missing:

Spoiler:

libadobe.so.patch:
`Remove PDF page turn arrows at left and right edges of page`

libnickel.so.1.0.0.patch:
`Custom page refresh options (1,8,32,Chapter -- Aura only)`
`Custom page refresh options (1,32,99,Chapter -- Aura only)`
`Remove system fonts in Reader list`
`Remove non-system fonts in Reader list`
`Customise PinchGestureRecognizer`
`Margins fine tuning`

The `My 24 line spacing values` patch now has an option to exclude up to 13 initial values from the line spacing slider, resulting in a slider with 11 to 24 positions. E.g. setting the option to 9 without changing the default line spacing values will give a slider with 15 positions 0.94-1.5 instead of 24 positions 0.75-1.5.

It has been reported that the `Custom page refresh options (1,2,4,8,16,32,64,128)` patch is not working, and I would guess it hasn't worked in any firmwae version after 3.19.5761. The `Custom page refresh options (1,2,3,...,12)` patch still works.

It has been reported that the `Custom reading footer style` patch is not working properly for KePub books, the page number moves closer to the bottom of the screen but the space left does not get used by the book text and so the gap at the bottom of the page remains large.

I'm not going to include the keyboard patches in the zip file, bacuse they take up a lot of space and most people use none or only one of them. I'll include them below and you can copy and paste the one you want into libnickel.so.1.0.0.patch:

`Cyrillic keyboard` patch for Aura One, thanks AxaRu.

`Greek keyboard` patch for Aura One, thanks isaak.

Here is a `Keyboard template` patch (libnickel.so.1.0.0.patch) for the Aura One. (You'll need to fill in the replacement values with the keys you want according to the pattern in the comments.)

Spoiler:

<Patch>
patch_name = `Keyboard template (Aura One)`
patch_enable = `yes`
# patch_group = `Keyboard alternatives`
#
## Replaces keys on the Extended Latin keypad.
#
# Aura One keyboard layout:
#
# Row:  Position
# ---:-----------
# Top: 0123456789
# 2nd: 0123456789
# 3rd: 0123456789
# Bot:  12345678
#  
# Untested: Enable uppercase for `ß` key (Top row, pos 7)
#replace_bytes = 71163C, 00 26, 01 26
#
# Replace layout sign (Cyrillic example)
find_base_address = `ÉÀÇ`
replace_string = 0000, `ÉÀÇ`, `абв`
# Change keyboard layout
find_base_address = `š\0ž\0þ\0ŀ\0`
# Top row, pos 2-3
replace_string = 0000, `š`, `2`
replace_string = 0003, `ž`, `3`
# Top row, pos 6
replace_string = 0006, `þ`, `6`
# Top row, pos 9
replace_string = 0009, `ŀ`, `9`
#
find_base_address = `æ\0à\0è\0ì\0`
# Top row, pos 0-1
replace_string = 0021, `ý`, `0`
replace_string = 0045, `ÿ`, `1`
# Top row, pos 4-5
replace_string = 0000, `æ`, `4`
replace_string = 0024, `œ`, `5`
# Top row, pos 7-8
replace_string = 0054, `ß`, `7`
replace_string = 0060, `ij`, `8`
# Second row, left to right:
replace_string = 0003, `à`, `0`
replace_string = 0012, `á`, `1`
replace_string = 0027, `â`, `2`
replace_string = 0036, `ä`, `3`
replace_string = 0048, `ã`, `4`
replace_string = 0051, `å`, `5`
replace_string = 0006, `è`, `6`
replace_string = 0015, `é`, `7`
replace_string = 002A, `ê`, `8`
replace_string = 0039, `ë`, `9`
# Third row, left to right:
replace_string = 000C, `ò`, `0`
replace_string = 001B, `ó`, `1`
replace_string = 0030, `ô`, `2`
replace_string = 003F, `ö`, `3`
replace_string = 004E, `õ`, `4`
replace_string = 005D, `ø`, `5`
replace_string = 0009, `ì`, `6`
replace_string = 0018, `í`, `7`
replace_string = 002D, `î`, `8`
replace_string = 003C, `ï`, `9`
# Bottom row, left to right:
replace_string = 000F, `ù`, `1`
replace_string = 001E, `ú`, `2`
replace_string = 0033, `û`, `3`
replace_string = 0042, `ü`, `4`
replace_string = 004B, `ñ`, `5`
replace_string = 0057, `ç`, `6`
replace_string = 005A, `đ`, `7`
replace_string = 0063, `ł`, `8`
</Patch>

keyboard patches for devices other than the Aura One:

Spoiler:

<Patch>
patch_name = `Cyrillic keyboard`
patch_enable = `no`
# patch_group = `Keyboard alternatives`
#
## Replaces keys on the Extended Latin keypad with Cyrillic alternatives.
#  
# Enable uppercase for `ß` key
replace_bytes = 71163c, 00 26, 01 26
# Replace layout sign
find_base_address = `ÉÀÇ`
replace_string = 0000, `ÉÀÇ`, `абв`
# Change keyboard layout
find_base_address = `æ\0à\0è\0ì\0`
# Second row, left to right:
replace_string = 0000, `æ`, `й`
replace_string = 0003, `à`, `ц`
replace_string = 0006, `è`, `у`
replace_string = 0009, `ì`, `к`
replace_string = 000C, `ò`, `е`
replace_string = 000F, `ù`, `н`
replace_string = 0012, `á`, `г`
replace_string = 0015, `é`, `ш`
replace_string = 0018, `í`, `щ`
replace_string = 001B, `ó`, `з`
replace_string = 001E, `ú`, `х`
replace_string = 0021, `ý`, `ъ`
# Third row, left to right:
replace_string = 0024, `œ`, `ф`
replace_string = 0027, `â`, `ы`
replace_string = 002A, `ê`, `в`
replace_string = 002D, `î`, `а`
replace_string = 0030, `ô`, `п`
replace_string = 0033, `û`, `р`
replace_string = 0036, `ä`, `о`
replace_string = 0039, `ë`, `л`
replace_string = 003C, `ï`, `д`
replace_string = 003F, `ö`, `ж`
replace_string = 0042, `ü`, `э`
replace_string = 0045, `ÿ`, `ё`
# Bottom row, left to right:
replace_string = 0048, `ã`, `я`
replace_string = 004B, `ñ`, `ч`
replace_string = 004E, `õ`, `с`
replace_string = 0051, `å`, `м`
replace_string = 0054, `ß`, `и`
replace_string = 0057, `ç`, `т`
replace_string = 005A, `đ`, `ь`
replace_string = 005D, `ø`, `б`
replace_string = 0060, `ij`, `ю`
replace_string = 0063, `ł`, `.`
</Patch>


<Patch>
patch_name = `Arabic keyboard`
patch_enable = `no`
# Multi-version patch: 4.0.7523 - 4.1.7729+
# patch_group = `Keyboard alternatives`
#
## Replaces keys on the Extended Latin keypad with Arabic alternatives.
## Note that after the device boots, the keypad will just show blank squares
## until the first book has been opened.
#  
# Replace layout sign
find_base_address = `ÉÀÇ`
replace_string = 0000, `ÉÀÇ`, `ع`
# Change keyboard layout
find_base_address = `æ\0à\0è\0ì\0`
# Second row, left to right:
replace_string = 0000, `æ`, `ذ`
replace_string = 0003, `à`, `ص`
replace_string = 0006, `è`, `ث`
replace_string = 0009, `ì`, `ق`
replace_string = 000C, `ò`, `ف`
replace_string = 000F, `ù`, `غ`
replace_string = 0012, `á`, `ع`
replace_string = 0015, `é`, `ه`
replace_string = 0018, `í`, `خ`
replace_string = 001B, `ó`, `ح`
replace_string = 001E, `ú`, `ج`
replace_string = 0021, `ý`, `د`
# Third row, left to right:
replace_string = 0024, `œ`, `ض`
replace_string = 0027, `â`, `ش`
replace_string = 002A, `ê`, `س`
replace_string = 002D, `î`, `ي`
replace_string = 0030, `ô`, `ب`
replace_string = 0033, `û`, `ل`
replace_string = 0036, `ä`, `ا`
replace_string = 0039, `ë`, `ت`
replace_string = 003C, `ï`, `ن`
replace_string = 003F, `ö`, `م`
replace_string = 0042, `ü`, `ك`
replace_string = 0045, `ÿ`, `ط`
# Bottom row, left to right:
replace_string = 0048, `ã`, `ئ`
replace_string = 004B, `ñ`, `ء`
replace_string = 004E, `õ`, `ؤ`
replace_string = 0051, `å`, `ر`
replace_string = 0054, `ß`, `ى`
replace_string = 0057, `ç`, `ة`
replace_string = 005A, `đ`, `و`
replace_string = 005D, `ø`, `ز`
replace_string = 0060, `ij`, `ظ`
replace_string = 0063, `ł`, `.`
</Patch>


<Patch>
patch_name = `Hebrew keyboard`
patch_enable = `no`
# Multi-version patch: 4.0.7523 - 4.1.7729+
# patch_group = `Keyboard alternatives`
#
## Replaces keys on the Extended Latin keypad with Hebrew alternatives.
## Note that after the device boots, the keypad will just show blank squares
## until the first book has been opened.
#
# Replace layout sign
find_base_address = `ÉÀÇ`
replace_string = 0000, `ÉÀÇ`, `אב`
# Change keyboard layout
find_base_address = `æ\0à\0è\0ì\0`
# Second row, left to right:
replace_string = 0000, `æ`, `@`
replace_string = 0003, `à`, `'`
replace_string = 0006, `è`, `/`
replace_string = 0009, `ì`, `ק`
replace_string = 000C, `ò`, `ר`
replace_string = 000F, `ù`, `א`
replace_string = 0012, `á`, `ט`
replace_string = 0015, `é`, `ו`
replace_string = 0018, `í`, `ן`
replace_string = 001B, `ó`, `ם`
replace_string = 001E, `ú`, `פ`
replace_string = 0021, `ý`, `-`
# Third row, left to right:
replace_string = 0024, `œ`, `,`
replace_string = 0027, `â`, `ש`
replace_string = 002A, `ê`, `ד`
replace_string = 002D, `î`, `ג`
replace_string = 0030, `ô`, `כ`
replace_string = 0033, `û`, `ע`
replace_string = 0036, `ä`, `י`
replace_string = 0039, `ë`, `ח`
replace_string = 003C, `ï`, `ל`
replace_string = 003F, `ö`, `ך`
replace_string = 0042, `ü`, `ף`
replace_string = 0045, `ÿ`, `_`
# Bottom row, left to right:
replace_string = 0048, `ã`, `ז`
replace_string = 004B, `ñ`, `ס`
replace_string = 004E, `õ`, `ב`
replace_string = 0051, `å`, `ה`
replace_string = 0054, `ß`, `נ`
replace_string = 0057, `ç`, `מ`
replace_string = 005A, `đ`, `צ`
replace_string = 005D, `ø`, `ת`
replace_string = 0060, `ij`, `ץ`
replace_string = 0063, `ł`, `.`
</Patch>


<Patch>
patch_name = `Turkish keyboard`
patch_enable = `no`
# patch_group = `Keyboard alternatives`
#
## Replaces keys on the Extended Latin keypad with Turkish alternatives.
#
# Enable uppercase for `ß` key
replace_bytes = 71163c, 00 26, 01 26
# Replace layout sign
find_base_address = `ÉÀÇ`
replace_string = 0000, `ÉÀÇ`, `EN/TR`
# Change keyboard layout
find_base_address = `æ\0à\0è\0ì\0`
# Second row, left to right:
replace_string = 0000, `æ`, `!`
replace_string = 0003, `à`, `q`
replace_string = 0006, `è`, `w`
replace_string = 0009, `ì`, `e`
replace_string = 000C, `ò`, `r`
replace_string = 000F, `ù`, `t`
replace_string = 0012, `á`, `y`
replace_string = 0015, `é`, `u`
replace_string = 0018, `í`, `ı`
replace_string = 001B, `ó`, `o`
replace_string = 001E, `ú`, `p`
replace_string = 0021, `ý`, `ü`
# Third row, left to right:
#replace_string = 0024, `œ\0`, `’`
replace_string = 0027, `â`, `a`
replace_string = 002A, `ê`, `s`
replace_string = 002D, `î`, `d`
replace_string = 0030, `ô`, `f`
replace_string = 0033, `û`, `g`
replace_string = 0036, `ä`, `h`
replace_string = 0039, `ë`, `j`
replace_string = 003C, `ï`, `k`
replace_string = 003F, `ö`, `l`
replace_string = 0042, `ü`, `ş`
replace_string = 0045, `ÿ`, `ğ`
# Bottom row, left to right:
replace_string = 0048, `ã`, `z`
replace_string = 004B, `ñ`, `x`
replace_string = 004E, `õ`, `c`
replace_string = 0051, `å`, `v`
replace_string = 0054, `ß`, `b`
replace_string = 0057, `ç`, `n`
replace_string = 005A, `đ`, `m`
replace_string = 005D, `ø`, `ö`
replace_string = 0060, `ij`, `ç`
replace_string = 0063, `ł`, `i`
</Patch>


<Patch>
patch_name = `Bulgarian keyboard`
patch_enable = `no`
# patch_group = `Keyboard alternatives`
#
## Replaces keys on the Extended Latin keypad with Bulgarian alternatives.
#  
# Enable uppercase for `ß` key
replace_bytes = 71163c, 00 26, 01 26
# Replace layout sign
find_base_address = `ÉÀÇ`
replace_string = 0000, `ÉÀÇ`, `абв`
# Change keyboard layout
find_base_address = `æ\0à\0è\0ì\0`
# Second row, left to right:
replace_string = 0000, `æ`, `!`
replace_string = 0003, `à`, `я`
replace_string = 0006, `è`, `в`
replace_string = 0009, `ì`, `е`
replace_string = 000C, `ò`, `р`
replace_string = 000F, `ù`, `т`
replace_string = 0012, `á`, `ъ`
replace_string = 0015, `é`, `у`
replace_string = 0018, `í`, `и`
replace_string = 001B, `ó`, `о`
replace_string = 001E, `ú`, `п`
replace_string = 0021, `ý`, `ч`
# Third row, left to right:
replace_string = 0024, `œ`, `?`
replace_string = 0027, `â`, `а`
replace_string = 002A, `ê`, `с`
replace_string = 002D, `î`, `д`
replace_string = 0030, `ô`, `ф`
replace_string = 0033, `û`, `г`
replace_string = 0036, `ä`, `х`
replace_string = 0039, `ë`, `й`
replace_string = 003C, `ï`, `к`
replace_string = 003F, `ö`, `л`
replace_string = 0042, `ü`, `ш`
replace_string = 0045, `ÿ`, `щ`
# Bottom row, left to right:
replace_string = 0048, `ã`, `з`
replace_string = 004B, `ñ`, `ь`
replace_string = 004E, `õ`, `ц`
replace_string = 0051, `å`, `ж`
replace_string = 0054, `ß`, `б`
replace_string = 0057, `ç`, `н`
replace_string = 005A, `đ`, `м`
replace_string = 005D, `ø`, `ю`
replace_string = 0060, `ij`, `,`
replace_string = 0063, `ł`, `.`
</Patch>


<Patch>
patch_name = `Greek keyboard`
patch_enable = `no`
# patch_group = `Keyboard alternatives`
#
## Replaces keys on the Extended Latin keypad with Greek alternatives.
#
# Enable uppercase for `ß` key
replace_bytes = 71163c, 00 26, 01 26
# Replace layout sign
find_base_address = `ÉÀÇ`
replace_string = 0000, `ÉÀÇ`, `EN/GR`
# Change keyboard layout
find_base_address = `æ\0à\0è\0ì\0`
# Second row, left to right:
replace_string = 0000, `æ`, `!`
replace_string = 0003, `à`, `ά`
replace_string = 0006, `è`, `ς`
replace_string = 0009, `ì`, `ε`
replace_string = 000C, `ò`, `ρ`
replace_string = 000F, `ù`, `τ`
replace_string = 0012, `á`, `υ`
replace_string = 0015, `é`, `θ`
replace_string = 0018, `í`, `ι`
replace_string = 001B, `ó`, `ο`
replace_string = 001E, `ú`, `π`
replace_string = 0021, `ý`, `-`
# Third row, left to right:
replace_string = 0024, `œ`, `?`
replace_string = 0027, `â`, `α`
replace_string = 002A, `ê`, `σ`
replace_string = 002D, `î`, `δ`
replace_string = 0030, `ô`, `φ`
replace_string = 0033, `û`, `γ`
replace_string = 0036, `ä`, `η`
replace_string = 0039, `ë`, `ξ`
replace_string = 003C, `ï`, `κ`
replace_string = 003F, `ö`, `λ`
replace_string = 0042, `ü`, `ή`
replace_string = 0045, `ÿ`, `ώ`
# Bottom row, left to right:
replace_string = 0048, `ã`, `ζ`
replace_string = 004B, `ñ`, `χ`
replace_string = 004E, `õ`, `ψ`
replace_string = 0051, `å`, `ω`
replace_string = 0054, `ß`, `β`
replace_string = 0057, `ç`, `ν`
replace_string = 005A, `đ`, `μ`
replace_string = 005D, `ø`, `,`
replace_string = 0060, `ij`, `.`
replace_string = 0063, `ł`, `ύ`
</Patch>

`Brightness fine control`


If anyone else has patches for firmware 4.2.8110 post them in this thread and I'll include a link here.

[Terisa de morgan]

Thank you very much!, they are already installed in my device .

[Martina Schein]

Thank you very much, @GeoffR. The Patcher works fine on my »Aura H2O«. Also on the »GloHD« an the »Glo«.

[Desdinova]

Quite simply, a must have! Working a charm on my Kobo 1!!

[pickyaxe]

Thank you very much. These patches are a must for me and many others, your work is appreciated.

[LucyOne]

I've only patched my Kobo Glo HD once before. How can I take over all the changes I've made in the old patch files? Can I just copy the files into the new patcher folder?

[Terisa de morgan]

Originally Posted by GeoffR

If anyone else has patches for firmware 4.2.8110 post them in this thread and I'll include a link here.

@GeoffR, there's a patch for adding extra dictionaries that it is usually include with patches for bad eyes, but there was a previous version for metazoa patches that a I use as I don't use the other ones. It still works. Would you mind if I post it here so you can include it?

Thank you very much.

[GeoffR]

Originally Posted by LucyOne

I've only patched my Kobo Glo HD once before. How can I take over all the changes I've made in the old patch files? Can I just copy the files into the new patcher folder?

No, unfortunately it is not as simple as that. In general you will need to re-do your customisations for the new patches, i.e. make the same changes to the new version of the patch that you did for the old version.

It might help to record a comment in the patch file each time you make a change, tagged with something you'll recognise. Then when you come to update the firmware and patch you can search through the old patch files for your tag and find the changes you made.

[GeoffR]

Originally Posted by Terisa de morgan

@GeoffR, there's a patch for adding extra dictionaries that it is usually include with patches for bad eyes, but there was a previous version for metazoa patches that a I use as I don't use the other ones. It still works. Would you mind if I post it here so you can include it?

Yes, please post it in this thread.

[Terisa de morgan]

This is the patch I include in libnickel.so.1.0.0.patch so I can add extra dictionaries. If the dictionaries have been included in the previous release in the database, nothing else is needed.

Spoiler:

<Patch>
patch_name = `Allow searches on Extra dictionaries`
patch_enable = `yes`
#
# To allow searches on Extra dictionaries change space character at end of "Extra: " to another char (ex: "Extra:_")
# The space char causes a non-desired "English - English" when searching on Extra dictionary from main menu.
#
#replace_bytes = BA9478, 20, 5F
#
find_base_address = `\0E\0x\0t\0r\0a\0:\0\x20`
replace_string = 000d, `\x20`, `_`
</Patch>

Thank you very much.

[ratinox]

Originally Posted by GeoffR

It might help to record a comment in the patch file each time you make a change, tagged with something you'll recognise. Then when you come to update the firmware and patch you can search through the old patch files for your tag and find the changes you made.

I use a little text file with a list of which patches I've enabled. I keep it with the firmware and patch archive in case I have to do a factory reset.

[LucyOne]

Originally Posted by GeoffR

All of the patches from firmware 4.1.7729 are complete except for the `Increase The Cover Size In Library` patch.

Updating and patching worked fine on my Glo HD. I have created a note file with all the patches I've applied. I hope the Cover Size patch will be included in the new patcher soon.

[mohcinbamou]

thanks a lot for the excellent work.

[JSWolf]

Which patches are not present in this set of patches?