Instructions for patching firmware 4.5.9587

[GeoffR]

See the Firmware update - 4.5.9587 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. Check Settings > Device information to make sure your Kobo ereader is already running firmware version 4.5.9587 (c77383d7d1). 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_4059587.zip (attached).

2. Download the Kobo firmware archive version 4.5.9587 for your device (See this thread) and copy it into the 4.5.9587_source/ subdirectory that was created in step 1. (Don't unzip the firmware archive.)

3. Read and edit all the *.patch files in the 4.5.9587_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 run 4.5.9587.bat (double-click); For Linux/Mac run 4.5.9587.sh (double-click, or right-click + run, or execute 4.5.9587.sh from the command line, or drag 4.5.9587.sh into Terminal, depending on your particular OS/desktop.)

5. If there were no errors, a new 4.5.9587_target/ subdirectory will be created. Copy the KoboRoot.tgz from this 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.5.9587_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:

In librmsdk.so.1.0.0.patch:
`Fix page breaks bug`
`Default ePub monospace font (Courier)`

In libnickel.so.1.0.0.patch:
`Custom left & right margins`
`Custom page refresh options`
`Fix three KePub fullScreenReading bugs`

[GeoffR]

Notes:

The `Allow download all in Browser` patch is missing in this version.

The 4.5.9587.sh script failed with an error about stat/chmod on some OS X systems (see post #24 for report). I have updated the attachment in post #1 to include a new 4.5.9598.sh script that should solve the problem. (See post #27 for details of fix.)


Other patches:

`New home screen footer rename`
`Increase headlines font`
`New home screen subtitle custem font`

tshering's Bad Eyes adaptation

`sickel reboot timeout` patch to increase the time allowed for tasks to complete before the sickel watchdog assumes the task has hung and reboots the device.


If you know of any other patches for firmware 4.5.9587, post them in this thread and I'll add a link above.

[oren64]

Thanks Geoff!

`New home screen footer rename`
`Increase headlines font`
`New home screen subtitle custem font`

The patches above will work on firmware 4.5.9587.

[Terisa de morgan]

Thank you both of you! I've generated the firmware and I'll apply it when I 'm at home.

[Martina Schein]

Thank you both, @GeoffR and @oren64. The patcher works fine on my H2O.

[David0226]

Patches work well on my Aura One.

Thanks to all for the development work.

[Number9]

I patched my KA1 and all is well 👍

[jcn363]

Thanks Geoff!

tshering's Bad Eyes adaptation

nickel.patch

Spoiler:

<Patch>
patch_name = `tshering's BAD EYES unclassified, increased by 30% (ADAPTATION - nickel)`
patch_enable = `yes`
# Version patch: 4.5.9587
find_base_address = `#newLabel `
replace_string = 0000, `#newLabel {\n  font-family: Avenir;\n  color: #ffffff;\n  background-color: #808080;\n  padding-left: 5px;\n  padding-right: 5px;\n  padding-top: 2px;\n  font-size: 17px;\n}\n#newLabel[qApp_deviceIsDaylight=true] {\n  font-size: 22px;\n}\n#newLabel[qApp_deviceIsTrilogy=true] {\n  font-size: 16px;\n}\n`, `#newLabel {\n  font-family: Avenir;\n  color: #ffffff;\n  background-color: #808080;\n  padding-left: 5px;\n  padding-right: 5px;\n  padding-top: 2px;\n  font-size: 22px;\n}\n#newLabel[qApp_deviceIsDaylight=true] {\n  font-size: 38px;\n}\n#newLabel[qApp_deviceIsTrilogy=true] {\n  font-size: 19px;\n}\n`
find_base_address = `SearchBox {`
replace_string = 0000, `SearchBox {\n  border: %1px solid black;\n  background-color: white;\n  margin: %2px;\n}\nSearchBox[qApp_deviceIsTrilogy=true] {\n  font-size: 23px;\n}\nSearchBox[qApp_deviceIsTrilogy=true][qApp_localeName="tr_TR"] {\n  font-size: 20px;\n}\nSearchBox[qApp_deviceIsPhoenix=true] {\n  font-size: 28px;\n}\nSearchBox[qApp_deviceIsDragon=true] {\n  font-size: 36px;\n}\nSearchBox[qApp_deviceIsAlyssum=true] {\n  font-size: 39px;\n}\nSearchBox[qApp_deviceIsDaylight=true] {\n  font-size: 47px;\n}\n`. `\nSearchBox {\n  border: %1px solid black;\n  background-color: white;\n  margin: %2px;\n}\nSearchBox[qApp_deviceIsTrilogy=true] {\n  font-size: 29px;\n}\nSearchBox[qApp_deviceIsTrilogy=true][qApp_localeName="tr_TR"] {\n  font-size: 26px;\n}\nSearchBox[qApp_deviceIsPhoenix=true] {\n  font-size: 34px;\n}\nSearchBox[qApp_deviceIsDragon=true] {\n  font-size: 45px;\n}\nSearchBox[qApp_deviceIsAlyssum=true] {\n  font-size: 48px;\n}\nSearchBox[qApp_deviceIsDaylight=true] {\n  font-size: 60px;\n}`
find_base_address = `#label[qApp_deviceIsTrilogy`
replace_string = 0000, `#label[qApp_deviceIsTrilogy=true] {\n  font-size: 30px;\n  min-width: 264px;\n  max-width: 264px;\n  min-height: 60px;\n  max-height: 60px;\n}\n#label[qApp_deviceIsPhoenix=true] {\n  font-size: 36px;\n  min-width: 331px;\n  max-width: 331px;\n  min-height: 72px;\n  max-height: 72px;\n}\n#label[qApp_deviceIsDragon=true] {\n  font-size: 46px;\n  min-width: 480px;\n  max-width: 480px;\n  min-height: 110px;\n  max-height: 110px;\n}\n#label[qApp_deviceIsDaylight=true] {\n  font-size: 60px;\n  min-width: 624px;\n  max-width: 624px;\n  min-height: 140px;\n  max-height: 140px;\n}\n`, `\n#label[qApp_deviceIsTrilogy=true] {\n  font-size: 39px;\n  min-width: 264px;\n  max-width: 264px;\n  min-height: 60px;\n  max-height: 60px;\n}\n#label[qApp_deviceIsPhoenix=true] {\n  font-size: 45px;\n  min-width: 331px;\n  max-width: 331px;\n  min-height: 72px;\n  max-height: 72px;\n}\n#label[qApp_deviceIsDragon=true] {\n  font-size: 58px;\n  min-width: 480px;\n  max-width: 480px;\n  min-height: 110px;\n  max-height: 110px;\n}\n#label[qApp_deviceIsDaylight=true] {\n  font-size: 78px;\n  min-width: 624px;\n  max-width: 624px;\n  min-height: 140px;\n  max-height: 140px;\n}`
find_base_address = `#QFrame`
replace_string = 0000, `#QFrame {\n  color: #000000;\n}\n#container {\n  background-color: #D0D0D0;\n}\n#container[colorTheme="LightTheme"] {\n  background-color: white;\n}\n#textEdit {\n  font-size: 20px;\n  border: 0px;\n  color: #000000;\n  font-family: Georgia;\n}\n#textEdit[qApp_deviceIsPhoenix=true] {\n  font-size: 24px;\n}\n#textEdit[qApp_deviceIsDragon=true] {\n  font-size: 29px;\n}\n#textEdit[qApp_deviceIsAlyssum=true] {\n  font-size: 32px;\n}\n#textEdit[qApp_deviceIsDaylight=true] {\n  font-size: 38px;\n}\n#textEdit[qApp_localeName="ja_JP"] {\n  font-family: Sans-SerifJP, sans-serif;\n  font-style: normal;\n}\n#characterCount {\n  padding: 10px;\n  color: #4d4d4d;\n}\n`, `\n#QFrame {\n  color: #000000;\n}\n#container {\n  background-color: #D0D0D0;\n}\n#container[colorTheme="LightTheme"] {\n  background-color: white;\n}\n#textEdit {\n  font-size: 26px;\n  border: 0px;\n  color: #000000;\n  font-family: Georgia;\n}\n#textEdit[qApp_deviceIsPhoenix=true] {\n  font-size: 30px;\n}\n#textEdit[qApp_deviceIsDragon=true] {\n  font-size: 35px;\n}\n#textEdit[qApp_deviceIsAlyssum=true] {\n  font-size: 41px;\n}\n#textEdit[qApp_deviceIsDaylight=true] {\n  font-size: 48px;\n}\n#textEdit[qApp_localeName="ja_JP"] {\n  font-family: Sans-SerifJP, sans-serif;\n  font-style: normal;\n}\n#characterCount {\n  padding: 10px;\n  color: #4d4d4d;\n}`
find_base_address = `#titleContainer[qApp_deviceIsTrilogy=true]`
replace_string = 0000, `#titleContainer[qApp_deviceIsTrilogy=true] {\n  qproperty-spacing: 20;\n  min-height: 46px;\n  max-height: 46px;\n}\n#titleContainer[qApp_deviceIsPhoenix=true] {\n  qproperty-spacing: 26;\n  min-height: 56px;\n  max-height: 56px;\n}\n#titleContainer[qApp_deviceIsDragon=true] {\n  qproperty-spacing: 36;\n  min-height: 70px;\n  max-height: 70px;\n}\n#titleContainer[qApp_deviceIsDaylight=true] {\n  qproperty-spacing: 46;\n  min-height: 90px;\n  max-height: 90px;\n}\n#title {\n  font-family: Avenir;\n  text-transform: uppercase;\n}\n#title[qApp_localeName="ja_JP"] {\n  font-family: Sans-SerifJP, sans-serif;\n  font-style: normal;\n}\n#title[qApp_localeName="tr_TR"] {\n  font-family: Georgia;\n}\n#title[qApp_deviceIsTrilogy=true] {\n  font-size: 16px;\n}\n#title[qApp_deviceIsPhoenix=true] {\n  font-size: 20px;\n}\n#title[qApp_deviceIsDragon=true] {\n  font-size: 28px;\n}\n#title[qApp_deviceIsDaylight=true] {\n  font-size: 36px;\n}\n#title[qApp_localeName="ja_JP"] {\n  text-transform: none;\n}\n#link {\n  font-style: italic;\n}\n#link[qApp_localeName="ja_JP"] {\n  font-style: normal;\n}\n`, `#titleContainer[qApp_deviceIsTrilogy=true] {\n  qproperty-spacing: 20;\n  min-height: 46px;\n  max-height: 46px;\n}\n#titleContainer[qApp_deviceIsPhoenix=true] {\n  qproperty-spacing: 26;\n  min-height: 56px;\n  max-height: 56px;\n}\n#titleContainer[qApp_deviceIsDragon=true] {\n  qproperty-spacing: 36;\n  min-height: 70px;\n  max-height: 70px;\n}\n#titleContainer[qApp_deviceIsDaylight=true] {\n  qproperty-spacing: 46;\n  min-height: 90px;\n  max-height: 90px;\n}\n#title {\n  font-family: Avenir;\n  text-transform: uppercase;\n}\n#title[qApp_localeName="ja_JP"] {\n  font-family: Sans-SerifJP, sans-serif;\n  font-style: normal;\n}\n#title[qApp_localeName="tr_TR"] {\n  font-family: Georgia;\n}\n#title[qApp_deviceIsTrilogy=true] {\n  font-size: 21px;\n}\n#title[qApp_deviceIsPhoenix=true] {\n  font-size: 26px;\n}\n#title[qApp_deviceIsDragon=true] {\n  font-size: 34px;\n}\n#title[qApp_deviceIsDaylight=true] {\n  font-size: 45px;\n}\n#title[qApp_localeName="ja_JP"] {\n  text-transform: none;\n}\n#link {\n  font-style: italic;\n}\n#link[qApp_localeName="ja_JP"] {\n  font-style: normal;\n}\n`
find_base_address = `#container[qApp_deviceIsTrilogy=true]`
replace_string = 0000, `#container[qApp_deviceIsTrilogy=true] {\n  qproperty-spacing: 12px;\n}\n#container[qApp_deviceIsPhoenix=true] {\n  qproperty-spacing: 16px;\n}\n#container[qApp_deviceIsDragon=true] {\n  qproperty-spacing: 22px;\n}\n#container[qApp_deviceIsDaylight=true] {\n  qproperty-spacing: 28px;\n}\n#text {\n  font-family: Avenir;\n  text-transform: uppercase;\n}\n#text[qApp_deviceIsTrilogy=true] {\n  font-size: 13px;\n}\n#text[qApp_deviceIsPhoenix=true] {\n  font-size: 16px;\n}\n#text[qApp_deviceIsDragon=true] {\n  font-size: 21px;\n}\n#text[qApp_deviceIsAlyssum=true] {\n  font-size: 23px;\n}\n#text[qApp_deviceIsDaylight=true] {\n  font-size: 27px;\n}\n#text[qApp_localeName="ja_JP"] {\n  font-family: Sans-SerifJP, sans-serif;\n  font-style: normal;\n  text-transform: none;\n}\n#text[qApp_localeName="tr_TR"] {\n  font-family: Georgia;\n}\n`, `#container[qApp_deviceIsTrilogy=true] {\n  qproperty-spacing: 12px;\n}\n#container[qApp_deviceIsPhoenix=true] {\n  qproperty-spacing: 16px;\n}\n#container[qApp_deviceIsDragon=true] {\n  qproperty-spacing: 22px;\n}\n#container[qApp_deviceIsDaylight=true] {\n  qproperty-spacing: 36px;\n}\n#text {\n  font-family: Avenir;\n  text-transform: uppercase;\n}\n#text[qApp_deviceIsTrilogy=true] {\n  font-size: 16px;\n}\n#text[qApp_deviceIsPhoenix=true] {\n  font-size: 19px;\n}\n#text[qApp_deviceIsDragon=true] {\n  font-size: 27px;\n}\n#text[qApp_deviceIsAlyssum=true] {\n  font-size: 30px;\n}\n#text[qApp_deviceIsDaylight=true] {\n  font-size: 39px;\n}\n#text[qApp_localeName="ja_JP"] {\n  font-family: Sans-SerifJP, sans-serif;\n  font-style: normal;\n  text-transform: none;\n}\n#text[qApp_localeName="tr_TR"] {\n  font-family: Georgia;\n}\n`
find_base_address = `#N3ToastView`
replace_string = 0000, `#N3ToastView {\n  background-color: transparent;\n  border-width: 8px;\n  border-image: url(:/images/dialogs/toast_background_simple.png) 8 8 8 8;\n}\n#primaryText[qApp_deviceIsTrilogy=true] {\n  font-size: 19px;\n}\n#primaryText[qApp_deviceIsPhoenix=true] {\n  font-size: 23px;\n}\n#primaryText[qApp_deviceIsDragon=true] {\n  font-size: 29px;\n}\n#primaryText[qApp_deviceIsAlyssum=true] {\n  font-size: 32px;\n}\n#primaryText[qApp_deviceIsDaylight=true] {\n  font-size: 37px;\n}\n#primaryText[qApp_localeName="ja_JP"] {\n  qproperty-leading: 0;\n}\n`, `#N3ToastView {\n  background-color: transparent;\n  border-width: 8px;\n  border-image: url(:/images/dialogs/toast_background_simple.png) 8 8 8 8;\n}\n#primaryText[qApp_deviceIsTrilogy=true] {\n  font-size: 22px;\n}\n#primaryText[qApp_deviceIsPhoenix=true] {\n  font-size: 29px;\n}\n#primaryText[qApp_deviceIsDragon=true] {\n  font-size: 35px;\n}\n#primaryText[qApp_deviceIsAlyssum=true] {\n  font-size: 41px;\n}\n#primaryText[qApp_deviceIsDaylight=true] {\n  font-size: 48px;\n}\n#primaryText[qApp_localeName="ja_JP"] {\n  qproperty-leading: 0;\n}\n`
find_base_address = `* {\n  font-family: Georgia;\n}\n*[qApp_localeName="ja_JP"] {\n  font-family: Sans-SerifJP, sans-serif;\n  font-style: normal;\n}\nbody {\n  padding`
replace_string = 0000, `* {\n  font-family: Georgia;\n}\n*[qApp_localeName="ja_JP"] {\n  font-family: Sans-SerifJP, sans-serif;\n  font-style: normal;\n}\nbody {\n  padding: 0px;\n  margin: 0px;\n  line-height: 150%;\n  text-align: justify;\n}\nbody[qApp_deviceIsTrilogy=true] {\n  font-size: 20px;\n}\nbody[qApp_deviceIsPhoenix=true] {\n  font-size: 24px;\n}\nbody[qApp_deviceIsDragon=true] {\n  font-size: 29px;\n}\nbody[qApp_deviceIsDaylight=true] {\n  font-size: 38px;\n}`, `* {\n  font-family: Georgia;\n}\n*[qApp_localeName="ja_JP"] {\n  font-family: Sans-SerifJP, sans-serif;\n  font-style: normal;\n}\nbody {\n  padding: 0px;\n  margin: 0px;\n  line-height: 1.2em;\n text-align: justify;\n}\nbody[qApp_deviceIsTrilogy=true] {\n  font-size: 26px;\n}\nbody[qApp_deviceIsPhoenix=true] {\n  font-size: 30px;\n}\nbody[qApp_deviceIsDragon=true] {\n  font-size: 35px;\n}\nbody[qApp_deviceIsDaylight=true] {\n  font-size: 49px;\n}`
find_base_address = `YTouchLabel`
replace_string = 0000, `YTouchLabel {\n  border-top: 1px solid black;\n  qproperty-indent: 0;\n  qproperty-forceRepaintOnInvert: true;\n  qproperty-highQualityInvert: false;\n  font-family: Georgia;\n  font-style: italic;\n}\nTouchLabel[qApp_deviceIsTrilogy=true] {\n  font-size: 23px;\n}\nTouchLabel[qApp_deviceIsPhoenix=true] {\n  font-size: 26px;\n}\nTouchLabel[qApp_deviceIsDragon=true] {\n  font-size: 32px;\n}\nTouchLabel[qApp_deviceIsAlyssum=true] {\n  font-size: 35px;\n}\nTouchLabel[qApp_deviceIsDaylight=true] {\n  font-size: 42px;\n}\nTouchLabel[qApp_localeName="ja_JP"] {\n  font-family: Sans-SerifJP, sans-serif;\n  font-style: normal;\n}`, `YTouchLabel {\n  border-top: 1px solid black;\n  qproperty-indent: 0;\n  qproperty-forceRepaintOnInvert: true;\n  qproperty-highQualityInvert: true; \n  font-family: Georgia;\n  font-style: italic;\n}\nTouchLabel[qApp_deviceIsTrilogy=true] {\n  font-size: 29px;\n}\nTouchLabel[qApp_deviceIsPhoenix=true] {\n  font-size: 32px;\n}\nTouchLabel[qApp_deviceIsDragon=true] {\n  font-size: 41px;\n}\nTouchLabel[qApp_deviceIsAlyssum=true] {\n  font-size: 44px;\n}\nTouchLabel[qApp_deviceIsDaylight=true] {\n  font-size: 54px;\n}\nTouchLabel[qApp_localeName="ja_JP"] {\n  font-family: Sans-SerifJP, sans-serif;\n  font-style: normal;\n}`
</Patch>

libnickel.so.1.0.0.patch

Spoiler:

#__________________________ tshering's  BAD EYES __________________________


<Patch>
patch_name = `Dictionary, remove long winded closest match notification`
patch_enable = `yes`
# Version patch: 4.5.9587
#note=Idea by pakoe
#note=cf. https://www.mobileread.com/forums/showpost.php?p=3043631&postcount=111
find_base_address = `Your search`
replace_string = 0000, `Your search for &ldquo;%1&rdquo; did not match any words in the dictionary. The closest match was &ldquo;%2&rdquo;.`, `\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0`
</Patch>

<Patch>
patch_name = `tshering's BAD EYES unclassified, increased by 30% (ADAPTATION - libnickel)`
patch_enable = `yes`
# Version patch: 4.5.9587
find_base_address = `font-size: 20px;`
replace_string = 0000, `font-size: 20px;`, `font-size: 32px;`
find_base_address = `font-size: 48px;`
replace_string = 0000, `font-size: 48px;`, `font-size: 62px;`
find_base_address = `font-size: 26px;\nfont-family: Georgia;`
replace_string = 0000, `font-size: 26px;`, `font-size: 44px;`
find_base_address = `body {font`
replace_string = 0000, `body {font: %1px %3; line-height: 1.775em;}h1 {font: %2px %3; line-height: 1.775em; font-weight:bold;}h2 {font: %1px %3; line-height: 1.775em; font-weight:bold;}`, `body {font: 1em %3; line-height: 1.25em;}h1 {font: 1.6em %3; line-height: 1.750em; font-weight:bold;}h2 {font: 1.4em %3; line-height: 1.500em; font-weight:bold;}`
</Patch>

[JSWolf]

Originally Posted by oren64

Thanks Geoff!

`New home screen subtitle custom font`

I had a look at this patch and I don't see where to specify the custom font.

[oren64]

Originally Posted by JSWolf

I had a look at this patch and I don't see where to specify the custom font.

It change the font color from gray to black and increasing font size.
In the home screen the the text the secondary text that show in gray is "HOURS TO GO", "COLLECTIONS"...
I don't like the gray front it's not showing well on my Glo.

[mathil]

First of all, huge thanks to Geoff and oren64 for all you do! I can't imagine going back to using my reader unpatched

I asked this in the thread for the previous firmware, so I'll try again here: is there any way right now, or could a patch be written, to change the font used in footnote popups in the KEPUB renderer? With the newer interface they switched from Georgia to what I believe is Kobo Nickel (looks a lot like it anyway). With Georgia, it was possible to read medium-length notes easily inside the popup as the font itself and the line-height weresmall, but with Kobo Nickel not only is the font itself harder to read (IMO at least) but the line-height is huge, meaning that with any note longer than one sentence you get immediately redirected to the note's page. I *did* contact Kobo through the feedback section of their website but as it's not a bug I doubt it'll get much attention...

[oren64]

Can you post a picture.

[pickyaxe]

oren64, I can't get "New home screen footer rename" to work with version, the patcher fails with "find_base_address string not found" for the line "find_base_address = `Find your next great read`"

As always thanks for the patches oren64 and GeoffR.

[oren64]

Originally Posted by pickyaxe

oren64, I can't get "New home screen footer rename" to work with version, the patcher fails with "find_base_address string not found" for the line "find_base_address = `Find your next great read`"

As always thanks for the patches oren64 and GeoffR.

Did you copy the patch to file libnickel.so.1.0.0.patch?

[chrisridd]

As an aside, how do folks generally manage upgrading from a previous patched firmware? By that I mean: I'd enabled a bunch of patches on 4.4.9344 (say), and now I want "the same" things enabled on 4.5.9587.

It is currently quite fiddly to manually migrate things between releases, so any tips would be appreciated.