MobileRead Forums - View Single Post - Instructions for patching firmware 4.17.13694

geek1011 · 09-21-2019, 10:57 PM

For convenience, here are the release notes copied from GitHub (please do not quote this post):

v52
This is the initial release for 4.17.13694 (plus 4.17.13651 and 4.16.13337 which were released the same week). This is one of the largest releases of both the patches and the firmware (the new reader interface, and quite a bit of refactoring since 4.15.12920).

This release would not have been possible without the extensive work of:

jackie_w (@jackiew1), who did the majority of the testing, rewrote many CSS patches, worked on new patches, and helped find changes in the new firmware.
GeoffR (@geoffreynolds), who made many of the original patches, and who will probably update a few more patches for the next release.
NiLuJe (@NiLuJe), who provided help and code review where it was needed (and helped with another kobo-related project which will be made public soon).
davidfor (@davidfor), who provided some information about the new firmware features on MobileRead.
geek1011 (@geek1011), who updated the majority of the patches, worked on new patches, wrote the build script, and helped find changes in the new firmware.
Kobo, who created the new reader interface, and fixed many bugs over the last few firmware releases.

Patch changes (4.16.13162+)
The usual patch updates (i.e. not different than between other firmware versions) are not listed here.

New:

Allow showing info panel on random screensaver
Allows showing the info panel while using a random screensaver (see here for how to use it). By @geek1011.
Remove title from reading header/footer
Removes the title/chapter name from the new reader's header/footer. By @geek1011.
Reduce new header/footer height
Reduces the height of the new reader's header/footer. By @jackiew1.
Custom navigation menu page number text
Changes the page number text above the scrubber. By @jackiew1.
FeatureSettings/PowerSettings/DeveloperSettings patches
A few patches have been made by @geek1011 to allow setting certain commonly-used configuration file settings as a patch. This is mainly intended for those who have multiple readers and/or want to automate changing settings.

Renamed:

Increase the view details container size
Renamed to Increase Book Details synopsis area along with updates by @jackiew1.
Custom footer (page number text)
Rewritten by @jackiew1 as Custom header/footer page number text.
Dictionary text font-family/font-size/line-height - beta
Updated by @jackiew1 as Dictionary text font-family/font-size/line-height and taken out of beta.
Increase the cover size in library
Rewritten by @jackiew1 as Increase library cover size.
Custom font to collection and author titles
Rewritten by @jackiew1 as Custom collection/author header title font.
Enable rotation on all devices
Renamed by @geek1011 to DeveloperSettings - ForceAllowLandscape because all it does now (it used to be more complex) is change a setting.
Set slide to unlock
Renamed by @geek1011 to PowerSettings - UnlockEnabled because all it does now (it used to be more complex) is change a setting.
Wikipedia Search language
Renamed to Change Wikipedia search language.
Dictionary, remove long winded closest match notification
Renamed to Shorten dictionary entry not found message.
New home screen increasing cover size
Renamed to Increase home screen cover size.

Rewritten:

Increase size of kepub chapter progress chart
Rewritten by @geek1011 to work with new firmware and make easier to update.
Both buttons go next:
Simplified by @geek1011.
Increase Book Details synopsis area
Rewritten by @jackiew1 to work with new firmware, add Libra values, and make easier to update.
Increase library cover size
Rewritten by @jackiew1 to make easier to update.
Custom font for Collection/Author header titles
Rewritten by @jackiew1 to work with new firmware and make easier to update.
Many more patches have not been rewritten, but offsets have changed greatly compared to previous versions and needed to be found again by @geek1011.
Other CSS patches have also been simplified and updated for the Libra by @jackiew1.

Removed:

Clock display duration
Not needed anymore, as there is now a persistent clock in the top-right of the new status bar (thanks Kobo!).
Fix three KePub fullScreenReading bugs
These bugs have been fixed since 4.11.11911, and haven't been seen since then.
Always display chapter name on navigation menu
The new reader view does this by default (thanks Kobo!).
Fix reading stats/author name cut off when series is showing
Now fixed in the firmware (thanks Kobo!).
Remove extra space on selection menu
Doesn't make a difference anymore.
Set reading footer height
Only applies to the old reader, not needed for new reader anymore (see Reduce new header/footer height).
Rename settings
Was made just to test something, not really used by anyone.
Custom reading footer style
Doesn't apply properly to the new reader, and would need to be completely rewritten anyways if it's even needed.
Disable reading footer
No effect on new reader view.
Custom menubar - reduce height by 33/50%
Not needed anymore.

Other:

New cross-platform, reproducible, and fast build script
The build script for the patches has been rewritten by @geek1011 in Go (see #19), and reviewed by @NiLuJe. It now works on Windows, is up to 30% faster, and produces identical outputs on multiple runs.
Header/footer patch documentation
A new interactive demo page has been made by @geek1011 (see #21) to help show the behavior different header/footer patches.

There have also been various grammar, spelling, and formatting fixes and improvements to many patches. Comments have also been updated to match the changes in recent firmware versions. Also, values for the Libra H2O (Storm) have been added to a number of CSS patches.

Changelog
This changelog has been somewhat abbreviated due to the large volume of changes. See the commit log for more details. Also, the versions listed are the versions which the change was directly made to. Usually, unless stated otherwise, this means the newer versions also inherited the change too.

Patrick Gaskin (@geek1011):

4.17.13651 4.17.13694 Added upgrade confirmation and upgrade blocking patches to a PatchGroup.
4.17.13651 4.17.13694 Added header/footer patch interactive demo (fixes #21).
template Made patch template readme more consistent.
4.17.13651 4.17.13694 Updated description for "Reduce top/bottom page spacer".
4.17.13651 4.17.13694 Made patch arrangement more consistent.
4.17.13651 4.17.13694 Updated most patches for 4.17.13651.
4.17.13651 4.17.13694 Added testdata for 4.17.13651 (and it was released the day after we finally finished the previous version...).
4.17.13651 Added note about how to prevent Kobo from importing dotfiles/folders (and made a LD_PRELOAD mod for it).
scripts Fixes, improvements, and refactoring for new build script.
4.17.13651 New "Remove title from reading header/footer" patch.
4.17.13651 Removed some unnecessary zero offsets from ReplaceZlib instructions.
4.17.13651 Added documentation for build and test scripts.
4.17.13651 Removed 4.16.13337 (replaced by 4.17.13651, not on any released device anymore).
4.16.13337 4.17.13651 Tested 7 libnickel patches, offsets, and numbers.
4.16.13337 4.17.13651 Updated TODO list and notes for 4.17.13651.
4.16.13337 4.17.13651 Made spacing of patch files more consistent.
4.17.13651 Updated most of GeoffR's patches for 4.17.13651.
4.17.13651 Ported my patches to 4.17.13651.
4.17.13651 Started updating patches for 4.17.13651 based on work for 4.16.13337.
4.17.13651 Added testdata for 4.17.13651.
4.16.13337 Updated jcn363's patches for 4.16.13337.
4.16.13337 Updated jackie_w's libnickel patches for 4.16.13337.
build Updated Drone script for new build tool.
scripts Rewrote build script in Go.
template Make kobopatch.sh executable.
4.16.13337 Updated nickel patches for 4.16.13337.
4.16.13337 Updated libadobe and librmsdk patches for 4.16.13337.
4.16.13337 Added testdata for 4.16.13337.
4.16.13162 Added config file override patches (FeatureSettings, DeveloperSettings).
4.16.13162 New "Allow showing info panel on random screensaver" patch.
4.16.13162 Rewrote "Increase size of kepub chapter progress chart" patch.
build Set pipefail in Drone script.
4.16.13162 Updated more patches for 4.16.13162.
4.16.13162 Updated most patches for 4.16.13162.
4.16.13162 Added testdata for 4.16.13162.

NiLuJe (@NiLuJe):

4.16.13162 Improved "DeveloperSettings - AutoUsbGadget" patch description.

NiLuJe has also done quite a bit of code review and has been helpful in general with updating the patches.

Jackie (@jackiew1, jackie_w):

4.17.13651 4.17.13694 Added new "Reduce new header/footer height" patch.
4.17.13651 4.17.13694 Updated comments for "New home screen increasing cover size".
4.17.13651 4.17.13694 Updated "New home screen increasing cover size" for Libra H2O.
4.17.13651 4.17.13694 Updated "Custom synopsis font size" for Libra H2O.
4.17.13651 4.17.13694 Updated "Custom synopsis details line spacing" for Libra H2O.
4.17.13651 4.17.13694 Updated "Reduce top/bottom page spacer" for Libra H2O.
4.17.13651 4.17.13694 Rewrote oren64's "Custom font for Collection/Author header titles" patch.
4.17.13651 4.17.13694 Updated "Reduce top/bottom page spacer" for Libra H2O.
4.17.13651 4.17.13694 Cleaned up description and comments for "Dictionary text font-family/font-size/line-height".
4.17.13651 4.17.13694 Added new "Custom navigation menu page number text" patch.
4.17.13651 Tested "Both page turn sides go next".
4.17.13651 Updated and improved "Dictionary text font-family/font-size/line-height".
4.17.13651 Rewrote "Custom header/footer page number text".
4.17.13651 Checked rmsdk patches.
4.17.13651 Increased specificity of "Reduce top/bottom page spacer" selector.
4.17.13651 Rewrote "Increase library cover size"
4.17.13651 Rewrote a few of oren64's patches.

Jackie has also done a lot of testing and debugging over PMs on MobileRead.

Geoff Reynolds (@geoffreynolds, GeoffR):

Will probably be updating the 24 line spacing values and custom font sizes patches soon.

Simon (@snarkophilus):

template Added Cygwin support to kobopatch.sh.

09-21-2019, 10:57 PM	#4
geek1011 Wizard Posts: 2,736 Karma: 6990705 Join Date: May 2016 Location: Ontario, Canada Device: Kobo Mini, Aura Edition 2 v1, Clara HD	Release notes from GitHub For convenience, here are the release notes copied from GitHub (please do not quote this post): v52 This is the initial release for 4.17.13694 (plus 4.17.13651 and 4.16.13337 which were released the same week). This is one of the largest releases of both the patches and the firmware (the new reader interface, and quite a bit of refactoring since 4.15.12920). This release would not have been possible without the extensive work of: jackie_w (@jackiew1), who did the majority of the testing, rewrote many CSS patches, worked on new patches, and helped find changes in the new firmware. GeoffR (@geoffreynolds), who made many of the original patches, and who will probably update a few more patches for the next release. NiLuJe (@NiLuJe), who provided help and code review where it was needed (and helped with another kobo-related project which will be made public soon). davidfor (@davidfor), who provided some information about the new firmware features on MobileRead. geek1011 (@geek1011), who updated the majority of the patches, worked on new patches, wrote the build script, and helped find changes in the new firmware. Kobo, who created the new reader interface, and fixed many bugs over the last few firmware releases. Patch changes (4.16.13162+) The usual patch updates (i.e. not different than between other firmware versions) are not listed here. New: Allow showing info panel on random screensaver Allows showing the info panel while using a random screensaver (see here for how to use it). By @geek1011. Remove title from reading header/footer Removes the title/chapter name from the new reader's header/footer. By @geek1011. Reduce new header/footer height Reduces the height of the new reader's header/footer. By @jackiew1. Custom navigation menu page number text Changes the page number text above the scrubber. By @jackiew1. FeatureSettings/PowerSettings/DeveloperSettings patches A few patches have been made by @geek1011 to allow setting certain commonly-used configuration file settings as a patch. This is mainly intended for those who have multiple readers and/or want to automate changing settings. Renamed: Increase the view details container size Renamed to Increase Book Details synopsis area along with updates by @jackiew1. Custom footer (page number text) Rewritten by @jackiew1 as Custom header/footer page number text. Dictionary text font-family/font-size/line-height - beta Updated by @jackiew1 as Dictionary text font-family/font-size/line-height and taken out of beta. Increase the cover size in library Rewritten by @jackiew1 as Increase library cover size. Custom font to collection and author titles Rewritten by @jackiew1 as Custom collection/author header title font. Enable rotation on all devices Renamed by @geek1011 to DeveloperSettings - ForceAllowLandscape because all it does now (it used to be more complex) is change a setting. Set slide to unlock Renamed by @geek1011 to PowerSettings - UnlockEnabled because all it does now (it used to be more complex) is change a setting. Wikipedia Search language Renamed to Change Wikipedia search language. Dictionary, remove long winded closest match notification Renamed to Shorten dictionary entry not found message. New home screen increasing cover size Renamed to Increase home screen cover size. Rewritten: Increase size of kepub chapter progress chart Rewritten by @geek1011 to work with new firmware and make easier to update. Both buttons go next: Simplified by @geek1011. Increase Book Details synopsis area Rewritten by @jackiew1 to work with new firmware, add Libra values, and make easier to update. Increase library cover size Rewritten by @jackiew1 to make easier to update. Custom font for Collection/Author header titles Rewritten by @jackiew1 to work with new firmware and make easier to update. Many more patches have not been rewritten, but offsets have changed greatly compared to previous versions and needed to be found again by @geek1011. Other CSS patches have also been simplified and updated for the Libra by @jackiew1. Removed: Clock display duration Not needed anymore, as there is now a persistent clock in the top-right of the new status bar (thanks Kobo!). Fix three KePub fullScreenReading bugs These bugs have been fixed since 4.11.11911, and haven't been seen since then. Always display chapter name on navigation menu The new reader view does this by default (thanks Kobo!). Fix reading stats/author name cut off when series is showing Now fixed in the firmware (thanks Kobo!). Remove extra space on selection menu Doesn't make a difference anymore. Set reading footer height Only applies to the old reader, not needed for new reader anymore (see Reduce new header/footer height). Rename settings Was made just to test something, not really used by anyone. Custom reading footer style Doesn't apply properly to the new reader, and would need to be completely rewritten anyways if it's even needed. Disable reading footer No effect on new reader view. Custom menubar - reduce height by 33/50% Not needed anymore. Other: New cross-platform, reproducible, and fast build script The build script for the patches has been rewritten by @geek1011 in Go (see #19), and reviewed by @NiLuJe. It now works on Windows, is up to 30% faster, and produces identical outputs on multiple runs. Header/footer patch documentation A new interactive demo page has been made by @geek1011 (see #21) to help show the behavior different header/footer patches. There have also been various grammar, spelling, and formatting fixes and improvements to many patches. Comments have also been updated to match the changes in recent firmware versions. Also, values for the Libra H2O (Storm) have been added to a number of CSS patches. Changelog This changelog has been somewhat abbreviated due to the large volume of changes. See the commit log for more details. Also, the versions listed are the versions which the change was directly made to. Usually, unless stated otherwise, this means the newer versions also inherited the change too. Patrick Gaskin (@geek1011): 4.17.13651 4.17.13694 Added upgrade confirmation and upgrade blocking patches to a PatchGroup. 4.17.13651 4.17.13694 Added header/footer patch interactive demo (fixes #21). template Made patch template readme more consistent. 4.17.13651 4.17.13694 Updated description for "Reduce top/bottom page spacer". 4.17.13651 4.17.13694 Made patch arrangement more consistent. 4.17.13651 4.17.13694 Updated most patches for 4.17.13651. 4.17.13651 4.17.13694 Added testdata for 4.17.13651 (and it was released the day after we finally finished the previous version...). 4.17.13651 Added note about how to prevent Kobo from importing dotfiles/folders (and made a LD_PRELOAD mod for it). scripts Fixes, improvements, and refactoring for new build script. 4.17.13651 New "Remove title from reading header/footer" patch. 4.17.13651 Removed some unnecessary zero offsets from ReplaceZlib instructions. 4.17.13651 Added documentation for build and test scripts. 4.17.13651 Removed 4.16.13337 (replaced by 4.17.13651, not on any released device anymore). 4.16.13337 4.17.13651 Tested 7 libnickel patches, offsets, and numbers. 4.16.13337 4.17.13651 Updated TODO list and notes for 4.17.13651. 4.16.13337 4.17.13651 Made spacing of patch files more consistent. 4.17.13651 Updated most of GeoffR's patches for 4.17.13651. 4.17.13651 Ported my patches to 4.17.13651. 4.17.13651 Started updating patches for 4.17.13651 based on work for 4.16.13337. 4.17.13651 Added testdata for 4.17.13651. 4.16.13337 Updated jcn363's patches for 4.16.13337. 4.16.13337 Updated jackie_w's libnickel patches for 4.16.13337. build Updated Drone script for new build tool. scripts Rewrote build script in Go. template Make kobopatch.sh executable. 4.16.13337 Updated nickel patches for 4.16.13337. 4.16.13337 Updated libadobe and librmsdk patches for 4.16.13337. 4.16.13337 Added testdata for 4.16.13337. 4.16.13162 Added config file override patches (FeatureSettings, DeveloperSettings). 4.16.13162 New "Allow showing info panel on random screensaver" patch. 4.16.13162 Rewrote "Increase size of kepub chapter progress chart" patch. build Set pipefail in Drone script. 4.16.13162 Updated more patches for 4.16.13162. 4.16.13162 Updated most patches for 4.16.13162. 4.16.13162 Added testdata for 4.16.13162. NiLuJe (@NiLuJe): 4.16.13162 Improved "DeveloperSettings - AutoUsbGadget" patch description. NiLuJe has also done quite a bit of code review and has been helpful in general with updating the patches. Jackie (@jackiew1, jackie_w): 4.17.13651 4.17.13694 Added new "Reduce new header/footer height" patch. 4.17.13651 4.17.13694 Updated comments for "New home screen increasing cover size". 4.17.13651 4.17.13694 Updated "New home screen increasing cover size" for Libra H2O. 4.17.13651 4.17.13694 Updated "Custom synopsis font size" for Libra H2O. 4.17.13651 4.17.13694 Updated "Custom synopsis details line spacing" for Libra H2O. 4.17.13651 4.17.13694 Updated "Reduce top/bottom page spacer" for Libra H2O. 4.17.13651 4.17.13694 Rewrote oren64's "Custom font for Collection/Author header titles" patch. 4.17.13651 4.17.13694 Updated "Reduce top/bottom page spacer" for Libra H2O. 4.17.13651 4.17.13694 Cleaned up description and comments for "Dictionary text font-family/font-size/line-height". 4.17.13651 4.17.13694 Added new "Custom navigation menu page number text" patch. 4.17.13651 Tested "Both page turn sides go next". 4.17.13651 Updated and improved "Dictionary text font-family/font-size/line-height". 4.17.13651 Rewrote "Custom header/footer page number text". 4.17.13651 Checked rmsdk patches. 4.17.13651 Increased specificity of "Reduce top/bottom page spacer" selector. 4.17.13651 Rewrote "Increase library cover size" 4.17.13651 Rewrote a few of oren64's patches. Jackie has also done a lot of testing and debugging over PMs on MobileRead. Geoff Reynolds (@geoffreynolds, GeoffR): Will probably be updating the 24 line spacing values and custom font sizes patches soon. Simon (@snarkophilus): template Added Cygwin support to kobopatch.sh. Last edited by geek1011; 09-22-2019 at 12:54 PM. Reason: I wish forums supported Markdown...