Instructions for patching firmware 4.12.12111 - Page 13

geek1011 · 03-02-2019, 05:04 PM

I have released v42 with 4 new patches to change the behaviour of the SmartLink on the home screen (the changing link on the bottom-right) as well as a few bug fixes.

Set visible SmartLink (by @geek1011):
This patch allows you to force the SmartLink to show a specific link. See the list at the bottom of this post for the options.

Only show Pocket SmartLink (by @geek1011):
This patch makes the SmartLink only show Pocket. It also changes the text to be more fitting for being always displayed.

Only show stats SmartLink (by @geek1011):
This patch always shows the stats link.

Never show Kobo Plus, wishlist, and points SmartLinks (by @geek1011):
This patch removes the Kobo Plus, wishlist, and points links from the rotation, which cannot be made to disappear without taking the action (like signing up for Kobo Plus, spending your points, and adding something to your wishlist).

For reference, here are the patches:

Spoiler:

Code:

Set visible SmartLink:
  - Enabled: no
  - PatchGroup: SmartLink
  - Description: |
      Sets the currently visible smartlink (does not override priority messages).
  # SmartLinks: (name from SmartLinkWidget::getAnalyticsMessage)
  #  # - internal name   - default condition                                   - what                                                             - action
  # PRIORITY MESSAGES (shown first up to 3 times each): (SmartLinkWidget::showPriorityMessage, ActivityManager::smartLinkPriorityMessage, SmartLinkWidget::tapped)
  #  5 - ReleaseNotes    - whats new available from Activity                   - RELEASE NOTES: Find out what's new in this software update       - whats new (from Activity)
  #  6 - OverdriveFTE    - overdrive enabled && not signed in                  - OVERDRIVE: Learn how to borrow eBooks from your public library   - overdrive about
  #  7 - KoboPlusFTE     - kobo plus enabled && not subscribed                 - KOBO PLUS: Browse Kobo Plus books                                - kobo store -> kobo plus
  # ROTATION MESSAGES (randomly chosen): (SmartLinkWidget::showRotationMessage, ActivityManager::smartLinkGeneralMessage, SmartLinkWidget::tapped)
  #  1 - Pocket          - pocket not signed in                                - POCKET: Read articles from the web on your eReader               - pocket about
  #  2 - KoboPlus        - kobo plus enabled && not subscribed                 - KOBO PLUS: Get unlimited access to books in all genres           - kobo store -> kobo plus
  #  2 - KoboPlus        - kobo plus enabled && not subscribed                 - KOBO PLUS: Read as much as you want with our ebook subscription  - kobo store -> kobo plus
  #  3 - Overdrive       - overdrive enabled && not signed in                  - OVERDRIVE: Borrow eBooks from your public library                - overdrive about
  #  4 - Categories      - always                                              - CATEGORIES: Browse fiction, romance, biography and more          - kobo store -> categories
  #  8 - NaturalLight    - has light sensor && not viewed tutorial             - DEVICE NAME: Learn about the Natural Light feature               - rgb front light about
  #  9 - QuickTour       - quick tour not shown && quick turn tile not visible - GETTING STARTED: Get to know your %0                             - quick tour
  # 10 - ReadingTour     - read a book tour not showed                         - READING A BOOK: Get quick tips about reading on your eReader     - read a book tutorial
  # 11 - UserGuide       - user guide present && not opened                    - USER GUIDE: Read the user guide for your %0                      - read -> user guide
  # 12 - RelatedReads    - recent book available from Activity                 - RELATED READS: Discover books related to the ones you're reading - browse -> similar books
  # 13 - Wishlist        - no wishlist items || something else                 - WISHLIST: Create a Wishlist of books you're interested in        - browse -> wishlist
  # 14 - ReadingSettings - reading settings not changed                        - READING SETTINGS: Customize the way you read a book              - settings -> reading settings
  # 15 - ReadingStats    - books finished > 0 && hours read rounded to .5 > 0  - READING STATS: You've finished %n books and read for %n hours    - reading life -> stats
  # 16 - SuperPoints     - participating in super points && points > 2400      - KOBO SUPER POINTS: You have %0 Super Points to redeem            - kobo store
  # 17 - PocketUser      - unread pocket articles > 0                          - POCKET: Catch up on the %n article(s) you added recently         - library -> pocket
  #
  # in SmartLinkWidget::showRotationMessage, which is the only caller of ActivityManager::smartLinkGeneralMessage:
  # change the result of the call to ActivityManager::smartLinkGeneralMessage:
  - ReplaceBytes: {Offset: 0x8DBA68, FindBLX: 0x42744C, ReplaceH: 4F F0 04 00}
  # set the new SmartLink to show (you can set this to your preference based on the
  # previous list, but it MUST be one of the above options, or you may need to
  # factory reset):
  - ReplaceInt: {Offset: 0x8DBA6A, Find: 4, Replace: 4}

Only show Pocket SmartLink:
  - Enabled: no
  - PatchGroup: SmartLink
  - Description: |
      Only show the Pocket SmartLink on the home screen.
  # in SmartLinkWidget::showRotationMessage:
  # change the result of the call to ActivityManager::smartLinkGeneralMessage to 17 (0x11):
  - ReplaceBytes: {Offset: 0x8DBA68, FindBLX: 0x42744C, ReplaceH: 4F F0 11 00}
  # replace the text:
  - FindReplaceString: {Find: "Catch up on the %n article(s) you added recently", Replace: "My Articles"}
# - FindReplaceString: {Find: "Catch up on the %n article(s) you added recently", Replace: "My Articles (%n unread)"}

Only show stats SmartLink:
  - Enabled: no
  - PatchGroup: SmartLink
  - Description: |
      Only show the stats SmartLink on the home screen.
  # in SmartLinkWidget::showRotationMessage:
  # change the result of the call to ActivityManager::smartLinkGeneralMessage to 15 (0x0F):
  - ReplaceBytes: {Offset: 0x8DBA68, FindBLX: 0x42744C, ReplaceH: 4F F0 0F 00}

Never show Kobo Plus, wishlist, and points SmartLinks:
  - Enabled: no
  - PatchGroup: SmartLink
  - Description: |
      Removes Kobo Plus, wishlist, and points SmartLinks from the rotation.
  # in ActivityManager::smartLinkGeneralMessage(ActivityManager *this, const Device *a2):
  # NOP Kobo Plus (2):
  - ReplaceBytesNOP: {Offset: 0x5BACAA, FindBLX: 0x405110}
  # NOP wishlist (13):
  - ReplaceBytesNOP: {Offset: 0x5BABFC, FindBLX: 0x405110}
  # NOP super points (16):
  - ReplaceBytesNOP: {Offset: 0x5BAE34, FindBLX: 0x405110}

Here are the things I figured out about the SmartLinks while working on these patches:

Spoiler:

Code:

SmartLinks: (name from SmartLinkWidget::getAnalyticsMessage)
 # - internal name   - default condition                                   - what                                                             - action
PRIORITY MESSAGES (shown first up to 3 times each): (SmartLinkWidget::showPriorityMessage, ActivityManager::smartLinkPriorityMessage, SmartLinkWidget::tapped)
 5 - ReleaseNotes    - whats new available from Activity                   - RELEASE NOTES: Find out what's new in this software update       - whats new (from Activity)
 6 - OverdriveFTE    - overdrive enabled && not signed in                  - OVERDRIVE: Learn how to borrow eBooks from your public library   - overdrive about
 7 - KoboPlusFTE     - kobo plus enabled && not subscribed                 - KOBO PLUS: Browse Kobo Plus books                                - kobo store -> kobo plus
ROTATION MESSAGES (randomly chosen): (SmartLinkWidget::showRotationMessage, ActivityManager::smartLinkGeneralMessage, SmartLinkWidget::tapped)
 1 - Pocket          - pocket not signed in                                - POCKET: Read articles from the web on your eReader               - pocket about
 2 - KoboPlus        - kobo plus enabled && not subscribed                 - KOBO PLUS: Get unlimited access to books in all genres           - kobo store -> kobo plus
 2 - KoboPlus        - kobo plus enabled && not subscribed                 - KOBO PLUS: Read as much as you want with our ebook subscription  - kobo store -> kobo plus
 3 - Overdrive       - overdrive enabled && not signed in                  - OVERDRIVE: Borrow eBooks from your public library                - overdrive about
 4 - Categories      - always                                              - CATEGORIES: Browse fiction, romance, biography and more          - kobo store -> categories
 8 - NaturalLight    - has light sensor && not viewed tutorial             - DEVICE NAME: Learn about the Natural Light feature               - rgb front light about
 9 - QuickTour       - quick tour not shown && quick turn tile not visible - GETTING STARTED: Get to know your %0                             - quick tour
10 - ReadingTour     - read a book tour not showed                         - READING A BOOK: Get quick tips about reading on your eReader     - read a book tutorial
11 - UserGuide       - user guide present && not opened                    - USER GUIDE: Read the user guide for your %0                      - read -> user guide
12 - RelatedReads    - recent book available from Activity                 - RELATED READS: Discover books related to the ones you're reading - browse -> similar books
13 - Wishlist        - no wishlist items || something else                 - WISHLIST: Create a Wishlist of books you're interested in        - browse -> wishlist
14 - ReadingSettings - reading settings not changed                        - READING SETTINGS: Customize the way you read a book              - settings -> reading settings
15 - ReadingStats    - books finished > 0 && hours read rounded to .5 > 0  - READING STATS: You've finished %n books and read for %n hours    - reading life -> stats
16 - SuperPoints     - participating in super points && points > 2400      - KOBO SUPER POINTS: You have %0 Super Points to redeem            - kobo store
17 - PocketUser      - unread pocket articles > 0                          - POCKET: Catch up on the %n article(s) you added recently         - library -> pocket

GeoffR · 03-11-2019, 03:54 AM

This patch changes the default thresholds that the ePub reader uses to decide how many columns to display on a page. It doesn't affect the KePub reader.

Paste into librmsdk.so.1.0.0.yaml:

Spoiler:

If you reduce these threshold values then the reader should switch to multi-column mode at a larger font size setting.

If you Increase these threshold values then a smaller font size setting should be required before the number of columns increases. If the thresholds are made very large then only a single column should be used for all font size settings.

Note that the patch just sets the default thresholds, the publisher can still override them in the book's XPGT stylesheet. You might want to use the "Modify ePub" Calibre plugin to remove the xpgt stylesheets from books before sideloading them.

(Also note that the font-size threshold is based on the size set by the device font-size slider, which is not necessarily the font size used for paragraph text since the publisher might have changed the paragraph font-size in the book's CSS stylesheet.)

I haven't tested this much, just a little on my Glo with firmware 4.8.11073, but it should work the same on any firmware version.

GeoffR · 03-11-2019, 06:36 AM

Variations on the previous patch: instead of choosing the number of columns based on font size, these patches will use a fixed number of columns regardless of fonts size, depending only on whether the screen orientation is portrait or landscape.

1P/1L = single column in either orientation.
1P/2L = 1 column portrait, 2 columns landscape
2P/3L = 2 columns portrait, 3 columns landscape

I haven't tested these, maybe someone with a Forma or other landscape-enabled device could try them out. Paste the patch for your device into librmdsk.so.1.0.0.yaml, and test on an ePub book that doesn't have an embedded XPGT stylesheet.

1P/1L, All devices:

Spoiler:

1P/2L, 2P/3L, Daylight devices (Forma, AuraOne):

Spoiler:

1P/2L, 2P/3L, Dragon devices (Clara, H2O, GloHD, AuraHD)

Spoiler:

1P/2L, 2P/3L, Phoenix devices (Glo, Aura, Aura2)

Spoiler:

1P/2L, 2P/3L, Trilogy devices (Mini, Touch, Touch2)

Spoiler:

codychan · 03-11-2019, 11:10 AM

Quote:

Originally Posted by GeoffR

Variations on the previous patch: instead of choosing the number of columns based on font size, these patches will use a fixed number of columns regardless of fonts size, depending only on whether the screen orientation is portrait or landscape.

1P/1L = single column in either orientation.
1P/2L = 1 column portrait, 2 columns landscape
2P/3L = 2 columns portrait, 3 columns landscape

I haven't tested these, maybe someone with a Forma or other landscape-enabled device could try them out. Paste the patch for your device into librmdsk.so.1.0.0.yaml, and test on an ePub book that doesn't have an embedded XPGT stylesheet.

1P/1L, All devices:

Spoiler:

1P/2L, 2P/3L, Daylight devices (Forma, AuraOne):

Spoiler:

1P/2L, 2P/3L, Dragon devices (Clara, H2O, GloHD, AuraHD)

Spoiler:

1P/2L, 2P/3L, Phoenix devices (Glo, Aura, Aura2)

Spoiler:

1P/2L, 2P/3L, Trilogy devices (Mini, Touch, Touch2)

Spoiler:

I tried each patch on my kobo forma, neither of them works. The latest version of firmware here.

And I did try to search XPGT keyword in my epub file using Calibre's editing feature, and I'm sure the file contains no XPGT stylesheet.

jackie_w · 03-12-2019, 01:52 PM

Quote:

Originally Posted by GeoffR

1P/2L, 2P/3L, Daylight devices (Forma, AuraOne):

Spoiler:

I tested the above patch on my Forma with a standard epub. It works fine for me. Here's a screenshot in landscape.

GeoffR · 03-12-2019, 06:35 PM

Thanks codychan and jackie_w for trying it out.

Sorry codychan I don't know why it doesn't work for you, but one thing I thought of that might prevent it working is if you had the `Ignore ePub book Adobe XPGT stylesheet` patch enabled too?

From a PM request, I'll have a look a look for how to change the size of the column gap.

codychan · 03-12-2019, 09:13 PM

Quote:

Originally Posted by GeoffR

Thanks codychan and jackie_w for trying it out.

Sorry codychan I don't know why it doesn't work for you, but one thing I thought of that might prevent it working is if you had the `Ignore ePub book Adobe XPGT stylesheet` patch enabled too?

From a PM request, I'll have a look a look for how to change the size of the column gap.

No, I left that disabled, and I tried to enable it and tested it again, it still didn't work as expected.

GeoffR · 03-12-2019, 11:53 PM

I have located the string that sets the default size of the gap between columns to 1.5em, but unfortunately the same string is also used to set the default font size for <h2> headers, and maybe other things.

So I don't think it is a good idea to use this patch, but here it is if anyone wants to try it and doesn't mind the side-effects.

Paste into librmsdk.so.1.0.0.yaml:

Spoiler:

JohhnyMix · 03-23-2019, 02:57 PM

I would like to say thank you to all the people who put in their time and work to create these patches and making me love my kobo h2o even more so big big thumbs up!

Glukkkk · 03-29-2019, 05:29 PM

| applying patch `Only Reading and My Books`
| looping over instructions
| skipping non-instruction Enabled(), PatchGroup() or Description()
| skipping non-instruction Enabled(), PatchGroup() or Description()
| skipping non-instruction Enabled(), PatchGroup() or Description()
| FindZlib("#row1col2") | hex:23726f7731636f6c32
| ReplaceZlib(0, "[qApp_isFontScaleLarge=true] #row1col2 {\n qproperty-visible: false;\n}", "#row1col2,#row2col2,#row3{qproperty-visible:false;}")
| could not apply patch: i5: ReplaceZlib: find string not found in stream ([qApp_isFontScaleLarge=true] #row1col2{qproperty-visible:false;})
--> ReplaceZlib: find string not found in stream ([qApp_isFontScaleLarge=true] #row1col2{qproperty-visible:false;})

geek1011 · 03-30-2019, 03:58 PM

Quote:

Originally Posted by Glukkkk

| applying patch `Only Reading and My Books`
| looping over instructions
| skipping non-instruction Enabled(), PatchGroup() or Description()
| skipping non-instruction Enabled(), PatchGroup() or Description()
| skipping non-instruction Enabled(), PatchGroup() or Description()
| FindZlib("#row1col2") | hex:23726f7731636f6c32
| ReplaceZlib(0, "[qApp_isFontScaleLarge=true] #row1col2 {\n qproperty-visible: false;\n}", "#row1col2,#row2col2,#row3{qproperty-visible:false;}")
| could not apply patch: i5: ReplaceZlib: find string not found in stream ([qApp_isFontScaleLarge=true] #row1col2{qproperty-visible:false;})
--> ReplaceZlib: find string not found in stream ([qApp_isFontScaleLarge=true] #row1col2{qproperty-visible:false;})

What other patches are enabled? There's quite a few conflicts with the #row* patches.

Glukkkk · 03-31-2019, 10:23 AM

I found the answer to my question:
1. If you enable Remove footer (row3) and increase cover size on new home screen you need to have both of these conflicting patches disabled:
- New home screen increasing cover size
- Remove recommendations (row1col2) from home screen

This must be indicated in the description.

2. If you enable Remove recommendations (row1col2) from home screen you need to have conflicting patch disabled:
Only Reading and My Books

This must be indicated in the description.

jcn363 · 04-05-2019, 02:45 AM

Quote:

Originally Posted by Glukkkk

I found the answer to my question:
1. If you enable Remove footer (row3) and increase cover size on new home screen you need to have both of these conflicting patches disabled:
- New home screen increasing cover size
- Remove recommendations (row1col2) from home screen

This must be indicated in the description.

2. If you enable Remove recommendations (row1col2) from home screen you need to have conflicting patch disabled:
Only Reading and My Books

This must be indicated in the description.

Do you have

Code:

  - PatchGroup: Home screen tweaks

in all of these patches

Remove footer (row3) and increase cover size on new home screen
Remove footer (row3) on new home screen
New home screen increasing cover size
Only Reading and My Books
Remove Footer and Recommendations

?

03-11-2019, 03:54 AM	#182
GeoffR Wizard Posts: 3,821 Karma: 19162882 Join Date: Nov 2012 Location: Te Riu-a-Māui Device: Kobo Glo	ePub default multi-column thresholds (testing) This patch changes the default thresholds that the ePub reader uses to decide how many columns to display on a page. It doesn't affect the KePub reader. Paste into librmsdk.so.1.0.0.yaml: Spoiler: Code: ePub default multi-column thresholds: - Enabled: yes - PatchGroup: ePub multi-column alternatives - FindReplaceString: # Use 3 columns if page width above this size: Find: "93em\0" Replace: "123em" - FindReplaceString: # Use 2 columns if page width above this size: Find: "61.5em" Replace: "81.5em" If you reduce these threshold values then the reader should switch to multi-column mode at a larger font size setting. If you Increase these threshold values then a smaller font size setting should be required before the number of columns increases. If the thresholds are made very large then only a single column should be used for all font size settings. Note that the patch just sets the default thresholds, the publisher can still override them in the book's XPGT stylesheet. You might want to use the "Modify ePub" Calibre plugin to remove the xpgt stylesheets from books before sideloading them. (Also note that the font-size threshold is based on the size set by the device font-size slider, which is not necessarily the font size used for paragraph text since the publisher might have changed the paragraph font-size in the book's CSS stylesheet.) I haven't tested this much, just a little on my Glo with firmware 4.8.11073, but it should work the same on any firmware version. Last edited by GeoffR; 03-11-2019 at 06:38 AM. Reason: added PatchGroup line

03-12-2019, 11:53 PM	#188
GeoffR Wizard Posts: 3,821 Karma: 19162882 Join Date: Nov 2012 Location: Te Riu-a-Māui Device: Kobo Glo	I have located the string that sets the default size of the gap between columns to 1.5em, but unfortunately the same string is also used to set the default font size for <h2> headers, and maybe other things. So I don't think it is a good idea to use this patch, but here it is if anyone wants to try it and doesn't mind the side-effects. Paste into librmsdk.so.1.0.0.yaml: Spoiler: Code: ePub multi-column gap size: - Enabled: no - Description: \| Sets the default size of the gap between columns. BEWARE: Also sets the default size of <h2> headers, and maybe other things too. - FindBaseAddressString: "\01.5em\0" - ReplaceString: {Offset: 1, Find: "1.5em", Replace: "1.3em"}

03-31-2019, 10:23 AM	#192
Glukkkk Enthusiast Posts: 34 Karma: 10 Join Date: Jul 2015 Device: Forma _ KSM-9 _ vlasovsoft	I found the answer to my question: 1. If you enable Remove footer (row3) and increase cover size on new home screen you need to have both of these conflicting patches disabled: - New home screen increasing cover size - Remove recommendations (row1col2) from home screen This must be indicated in the description. 2. If you enable Remove recommendations (row1col2) from home screen you need to have conflicting patch disabled: Only Reading and My Books This must be indicated in the description. Last edited by Glukkkk; 03-31-2019 at 02:49 PM.

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
Instructions for patching firmware 3.13.1	GeoffR	Kobo Developer's Corner	56	07-01-2016 09:59 AM
Instructions for patching firmware 3.16.10	GeoffR	Kobo Developer's Corner	12	08-14-2015 03:40 AM
Instructions for patching firmware 3.16.0	GeoffR	Kobo Developer's Corner	74	08-12-2015 02:12 PM
Instructions for patching firmware 3.12.1	GeoffR	Kobo Developer's Corner	56	03-20-2015 05:14 AM
Instructions for patching firmware 3.12.0	GeoffR	Kobo Developer's Corner	165	02-07-2015 09:22 AM

03-12-2019, 06:35 PM	#186
GeoffR Wizard Posts: 3,821 Karma: 19162882 Join Date: Nov 2012 Location: Te Riu-a-Māui Device: Kobo Glo	Thanks codychan and jackie_w for trying it out. Sorry codychan I don't know why it doesn't work for you, but one thing I thought of that might prevent it working is if you had the `Ignore ePub book Adobe XPGT stylesheet` patch enabled too? From a PM request, I'll have a look a look for how to change the size of the column gap.

03-23-2019, 02:57 PM	#189
JohhnyMix Connoisseur Posts: 88 Karma: 10 Join Date: Mar 2018 Device: Kobo H2O V2	I would like to say thank you to all the people who put in their time and work to create these patches and making me love my kobo h2o even more so big big thumbs up!

03-29-2019, 05:29 PM	#190
Glukkkk Enthusiast Posts: 34 Karma: 10 Join Date: Jul 2015 Device: Forma _ KSM-9 _ vlasovsoft	\| applying patch `Only Reading and My Books` \| looping over instructions \| skipping non-instruction Enabled(), PatchGroup() or Description() \| skipping non-instruction Enabled(), PatchGroup() or Description() \| skipping non-instruction Enabled(), PatchGroup() or Description() \| FindZlib("#row1col2") \| hex:23726f7731636f6c32 \| ReplaceZlib(0, "[qApp_isFontScaleLarge=true] #row1col2 {\n qproperty-visible: false;\n}", "#row1col2,#row2col2,#row3{qproperty-visible:false;}") \| could not apply patch: i5: ReplaceZlib: find string not found in stream ([qApp_isFontScaleLarge=true] #row1col2{qproperty-visible:false;}) --> ReplaceZlib: find string not found in stream ([qApp_isFontScaleLarge=true] #row1col2{qproperty-visible:false;})

Advert

Advert