Instructions for patching firmware 3.3.x, 3.4.x, 3.5.x

[GeoffR]

Before starting:

1. Make sure your Kobo ereader is already running one of the following firmware versions. Each patch works for only one of these specific firmware versions and no other, and so the patch you apply must exactly match the firmware version already on your device:
3.3.0 (8eb9c1f8b2)
3.3.1 (38384a81c1)
3.4.1 (d83b1b0e2a)
3.5.0 (1ad1188b51)

2. Check that your battery is well charged.

3. Note that the instructions below have changed significantly from previous firmware versions. This is because some files other than just libnickel.so.1.0.0 are patched.


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

1. Download and extract patch_kobo_35.zip attached.

2. Download the appropriate Kobo firmware archive version 3.3.0, 3.3.1, 3.4.1, or 3.5.0 to match the firmware version already on your device (See this thread) into the corresponding 3.x.x_source subdirectory. (Don't extract.) Throughout these instructions 3.x.x refers to the firmware version already on your device.

3. Read and edit all the *.patch files in the 3.x.x_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.x.x.bat; For Linux/mac run ./3.x.x.sh from the command line.

5. If there were no errors, copy the resulting KoboRoot.tgz from the 3.x.x_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.x.x_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 three example 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.

More complex customisation is possible by editing the replacement css text, see the Kobo Patcher thread for examples.

2. My line spacing values: There are two versions of this patch, resulting in a line spacing slider with 10 or 15 spacing values, so enable one and disable the other. 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).

[GeoffR]

If you have a new or improved patch that works with firmwares 3.3.x - 3.5.x, post in this thread and I'll add it to this post.


ePub adjustable top/bottom margins: I've now included this in with the other patches in post #1, but left it disabled by default. See this thread for discussion: Adjustable top/bottom margin patch testing


Block WiFi firmware upgrade (libnickel.so.1.0.0): This patch should prevent the firmware being upgraded during WiFi sync. You can still upgrade by sideloading the new firmware or by syncing via the Kobo desktop program. See this thread for discussion.

firmware 3.3.0:

Spoiler:

<Patch>
patch_name = `Block WiFi firmware upgrade`
patch_enable = `no`
# Use with patch32lsb
replace_string = C482E2, `%\x003\x00/\x00%\x004\x00/\x00%\x005\x00`, `k\x00/\x009\x009\x00.\x009\x00/\x005\x00`
# Use with kpg.exe
#replace_xor_00 = C482E2, `%\x003\x00/\x00%\x004\x00/\x00%\x005\x00`, `k\x00/\x009\x009\x00.\x009\x00/\x005\x00`
</Patch>

firmware 3.3.1:

Spoiler:

<Patch>
patch_name = `Block WiFi firmware upgrade`
patch_enable = `no`
# Use with patch32lsb
replace_string = C4B302, `%\x003\x00/\x00%\x004\x00/\x00%\x005\x00`, `k\x00/\x009\x009\x00.\x009\x00/\x005\x00`
# Use with kpg.exe
#replace_xor_00 = C4B302, `%\x003\x00/\x00%\x004\x00/\x00%\x005\x00`, `k\x00/\x009\x009\x00.\x009\x00/\x005\x00`
</Patch>

firmware 3.4.1:

Spoiler:

<Patch>
patch_name = `Block WiFi firmware upgrade`
patch_enable = `no`
# Use with patch32lsb
replace_string = C4B212, `%\x003\x00/\x00%\x004\x00/\x00%\x005\x00`, `k\x00/\x009\x009\x00.\x009\x00/\x005\x00`
# Use with kpg.exe
#replace_xor_00 = C4B212, `%\x003\x00/\x00%\x004\x00/\x00%\x005\x00`, `k\x00/\x009\x009\x00.\x009\x00/\x005\x00`
</Patch>

Custom page refresh options (libnickel.so.1.0.0): This patch changes the Reading Settings "Refresh the screen every:" menu options. Instead of only refreshing every 1,2,3,4,5, or 6 pages, you can add more options by changing the patch replacement values of Base, Increment, and Maximum. E.g. Base=2, Increment=2, Maximum=20 will give a menu with options to refesh every 2,4,6,8,10,12,14,16,18, or 20 pages.

This patch is now included in patch_kobo_35.zip attached to post #1.


Customise PinchGestureRecognizer (libnickel.so.1.0.0): Change some pinch/zoom settings. (Aura or other devices with Multi-touch kernel installed):

Firmware 3.5.0:

Spoiler:

<Patch>
patch_name = `Customise PinchGestureRecognizer`
patch_enable = `no`
# PinchGestureRecognizer::StationaryTolerance
replace_float = CA8570, 5.0, 5.0
# PinchGestureRecognizer::UpdateTolerance
replace_float = CA8578, 10.0, 10.0
# PinchGestureRecognizer::TriggerTolerance
replace_float = CA8580, 30.0, 30.0
</Patch>

Applying patches with kpg.exe: The attached files contain kpg.conf with all of the main patches from post #1 for use with kpg.exe. Note that some of the patches now need to be applied to librmsdk.1.0.0 or libadobe.so instead of libnickel.so.1.0.0, and so these ones have been commented out.

[erikssenmar867]

Thanks again for what you do!
One question: it's not possible to obtain the fix of redundant image cover?
Thanks in advance!

[GeoffR]

Originally Posted by erikssenmar867

Thanks again for what you do!
One question: it's not possible to obtain the fix of redundant image cover?
Thanks in advance!

Something has changed again with the way the cover images are generated, and the simple trick of changing the filename of the useless cover to match one of the existing covers doesn't seem to work anymore.

[booklover6]

Geoff, maybe it's just me, but the link on #1 is not working. http://rghost.net/53295702.

[SHunter101]

Originally Posted by GeoffR

the long paragraph bug fix patch has not been found yet. The function that the patch applied to no longer exists in libnickel or had been renamed

Thanks for you work!! I was hoping Kobo would have fixed long paragraph bug, nope it is still there. This bug is truly annoying and I hope Kobo solves the issue soon (closest thing I can find to a middle finger). Oh, the link above is working for me.

Best,
SHunter

[DNSB]

Originally Posted by booklover6

Geoff, maybe it's just me, but the link on #1 is not working. http://rghost.net/53295702.

I just tried the link and it worked for me.

I've copied the link from the download button on the page. You might give this a try.

http://rghost.net/download/53295702/...erpatch_12.exe

Regards,
David

[booklover6]

Thanks, still not working for me. I'll try another browser.

Still a no go. No biggie, I'm using the #11 version and it's fine, for the Glo I used it on.

[Danger]

No patch for the "Fix page breaks" bug? Would greatly appreciate this one.

[GeoffR]

Originally Posted by Danger

No patch for the "Fix page breaks" bug? Would greatly appreciate this one.

I just found it, but it has moved from libnickel to librmsdk, so now there are two files to patch.

I've added the patch to the .conf files attached to post #1, and I've updated the instructions for patching with patch32lsb.

But I don't know how to apply the patch with kpg.exe. Can anyone help?

[GeoffR]

Sorry, the link to the Kobo firmware in the Linux instructions was pointing to the 3.1.1 firmware. I've corrected it now. If you found you couldn't generate the patch because patch32lsb stopped with an error about mismatched data then that would probably be why.

[SHunter101]

Originally Posted by GeoffR

But I don't know how to apply the patch with kpg.exe. Can anyone help?

It seems kpg.exe likes only the kpg.conf file. Since the goal is to 'Fix page breaks bug' and the librmsdk.conf file has only two option, then the easiest solution is to create two files: one for the default and one for the alternative (see attached files). I have tested the default file on my Kobo Glo and it seems to work. I have not tested the other. If someone could test them to verify there are no side-effects.

I am not a programmer and I do not use Linux, so for Windows, I did it by renaming the files:

1) Edit the librmsdk.conf file to one of the two option. Rename the file to kpg.conf

2) find the librmsdk.so.1.0.0 file from the latest version of the Kobo firmware, place it in the same directory as your new renamed kpg.conf. Rename librmsdk.so.1.0.0 to libnickel.so.1.0.0

3) Add kpg.exe to the directory containing your two renamed files and double click.

The generated file, KoboRoot.tgz, contains a single file libnickel.so.1.0.0. Rename this file to librmsdk.so.1.0.0 and add the KoboRoot.tgz containing the renamed file to your .kobo directory on your ereader and follow the rest of the directions from GeoffR. I used 7zip to open the KoboRoot.tgz file, located the libnickel.so.1.0.0 file and renamed it to librmsdk.so.1.0.0 all from within 7zip with out extracting the file (easy way).

These are not detailed instruction, more of a summary of the main events. I recommend using one of the two attached files instead. Until the original programmer alters the kpg.exe to find the new librmsdk.conf file we are stuck with renaming files. Until/Unless some finds a better solution.

Shunter

[tshering]

Data and information in this post are out of date. Please see post #1 for information on how to apply the patches under Windows.

Originally Posted by GeoffR

I just found it, but it has moved from libnickel to librmsdk, so now there are two files to patch.

I've added the patch to the .conf files attached to post #1, and I've updated the instructions for patching with patch32lsb.

But I don't know how to apply the patch with kpg.exe. Can anyone help?

One could use the patcher of the Modifications for Bad Eyes package.

• extract the content of the archive to (for instance) C:\KBPatcher07_b\
• copy libnickel.so.1.0.0 and librmsdk.so.1.0.0 to C:\KBPatcher07_b\3.3.0_source\
• edit the configuration files in C:\KBPatcher07_b\3.3.0_source\ if you like
• double-click on C:\KBPatcher07_b\3.3.0.bat
• find KoboRoot.tgz in C:\KBPatcher07_b\3.3.0_target\

[SHunter101]

Originally Posted by tshering

One could use the patcher of the Modifications for Bad Eyes package.

• extract the content of the archive to (for instance) C:\KBPatcher07_b\
• copy libnickel.so.1.0.0 and librmsdk.so.1.0.0 to C:\KBPatcher07_b\3.3.0_source\
• edit the configuration files in C:\KBPatcher07_b\3.3.0_source\ if you like
• double-click on C:\KBPatcher07_b\3.3.0.bat
• find KoboRoot.tgz in C:\KBPatcher07_b\3.3.0_target\

Hi Tshering:

Your method is way easier than the one above (post 12). However, I get an error, see attached file. When I remove the 15 line spacing code and use the 10 line spacing code, I get a similar error.

SHunter

[tshering]

Originally Posted by SHunter101

Hi Tshering:

Your method is way easier than the one above (post 12). However, I get an error, see attached file. When I remove the 15 line spacing code and use the 10 line spacing code, I get a similar error.

SHunter

I tried again with both line spacing patches. And both run without error. Is it possible that something happened to your configuration file, or that you use a libnickel.so.1.0.0 that has already been modified?

Edit: Since the error is at 676F68, I wonder why GeoffR writes twice at this point:

replace_bytes = 676F68, 86 EE 1D A3 D3 E9 00 23, 00 00 00 00 00 00 F0 3F
...
replace_float = 676F68, 1.0,  0.7

But this does not explain, why it is working for me, and not for you. Or did you by chance change one of these two lines? Since this would result in an error.