Instructions for patching firmware 4.10.11591

[JIPG-reader]

Originally Posted by jackie_w

In the spirit of trying to be helpful rather than confrontational...

If/when you're ready to move forward let me offer you an open personal invitation to help you create your new set of .yaml patch files. You can do it via PM or in open forum in a new thread, your choice.

All I would need to start with is:

• a list of which patch names you normally enable
• an indication which of those you manually edit to change the default settings (details can follow later)

You are very kind!.

I will try to make a summary with my concerns and this perhaps can help to other "reluctants"

[geek1011]

Originally Posted by JIPG-reader

In theory, should they produce the same final koboroot file or not?

Yes, and in reality too. I tested this for 2 months with over 8 different patch sets. It's been stable for quite a while.

[geek1011]

Originally Posted by jackie_w

If/when you're ready to move forward let me offer you an open personal invitation to help you create your new set of .yaml patch files. You can do it via PM or in open forum in a new thread, your choice.

You're so kind! Thanks for helping people with the transition!

Also, mainly to help GeoffR update the zlib patches, I've created (and released) a tool to convert any kobopatch patch into an old-style patch using only the ReplaceBytes instruction. Note that unlike kobopatch itself, the generated patches will only work on the version it is created for. The code is here, and the binaries are here. Here is an example:

Spoiler:

$ kobopatch-mkzlib -i nickel -p nickel.yaml -n "Custom menubar - reduce height by 33%"
APPLYING PATCH TO FIND CHANGES:
  [1/21] Skipping disabled patch `Show all games`
  [2/21] Skipping disabled patch `Custom synopsis/details line spacing`
  [3/21] Skipping disabled patch `Custom synopsis/font size`
  [4/21] Skipping disabled patch `Dictionary pop-up - increase available text area`
  [5/21] Skipping disabled patch `Increase the view details container size`
  [6/21] Skipping disabled patch `Custom font to collection and author titles`
  [7/21] Skipping disabled patch `New home screen subtitle custom font`
  [8/21] Skipping disabled patch `Remove forgot pin button from lock screen`
  [9/21] Skipping disabled patch `New home screen increasing cover size`
  [10/21] Skipping disabled patch `Fix reading stats/author name cut off when series is showing`
  [11/21] Skipping disabled patch `Custom menubar - reduce height by 50%`
  [12/21] Skipping disabled patch `Remove footer (row3) and increase cover size on new home screen`
  [13/21] Skipping disabled patch `Remove recommendations (row1col2) from home screen`
  [14/21] Skipping disabled patch `Disable reading footer`
  [15/21] Skipping disabled patch `Custom reading footer style`
  [16/21] Skipping disabled patch `Remove footer (row3) on new home screen`
  [17/21] Skipping disabled patch `Increase headlines font`
  [18/21] Applying patch `Custom menubar - reduce height by 33%`
  [19/21] Skipping disabled patch `Changing the info panel in full size screensaver- beta 1`
  [20/21] Skipping disabled patch `Increase the cover size in library`
  [21/21] Skipping disabled patch `Increase size of kepub chapter progress chart`
--> SUCCESS

GENERATING NEW PATCH:
--> SUCCESS

TESTING GENERATED PATCH:
  [1/1] Applying patch `Custom menubar - reduce height by 33%`
--> SUCCESS

CONVERTED PATCH:
<Patch>
patch_name = `Custom menubar - reduce height by 33%`
patch_enable = `no`
#
# patch_generator = `kobopatch-mkzlib`
# patch_group = `Custom menubar`
#
## Adjusts the height of the top menubar.
#
base_address = 0
replace_bytes = 046F70F, 53 DB, 73 9B
replace_bytes = 046F715, FC 0A 0D 39 70 69 66 12 07 27, FE 15 4C 7C C8 A5 9E C1 1F F8
replace_bytes = 046F71F, 71 3A 1C 28 BD D0, 2B E3 83 9B 5E DC
replace_bytes = 046F726, 19 66 E8 70 E9 74 18 C5 11 B6, 33 99 49 27 97 4E 27 23 63 19
replace_bytes = 046F730, 5A 47 32 92 42 48 4B FF 7B 65, D4 82 44 24 D9 8E DB F4 BF 57
replace_bytes = 046F73A, C7 C1 1F 92 D7 22 81 5B 22 7B, C6 76 00 21 16 85 26 37 2C B1
replace_bytes = 046F744, 9F 77 BD FB 7A 25 F7 6E 14 56, CF BB EC BE 2C 72 FB 4E 22 B9
replace_bytes = 046F74E, 2B F9 09 8B 5B 4A D6 3F 1E CE, 11 1F 11 BF 27 78 F7 FD 71 9E
replace_bytes = 046F758, D3 F4 6E 41 1E 69 48 2E E5 77, 24 0F 2B BC 25 3E 5E 88 6F 9C
replace_bytes = 046F762, 41 13 1E 6D CE 94 58 91 9F E8, 44 2C D8 CF 24 DF E0 1F CE 9F
replace_bytes = 046F76C, EF 11 42 4B FC D4 8F 09 8D 62, 56 8C 9E 3A 21 26 41 28 A7 CE
replace_bytes = 046F776, 35 43 93 61 FA F4 31 5B A3 AC, 60 94 3C 5D B5 62 42 B5 95 BF
replace_bytes = 046F780, B1 F6 EF A8 07 50 AF 63 4E 18, AD 36 40 BC 0D 19 A6 E4 C9 48
replace_bytes = 046F78A, 7D 6A A1 06 16 6A E0 40 FD 2C, 1C BA 3A F1 B8 02 13 3F 71 14
replace_bytes = 046F794, 70 C4 59 0B 74 E8 59 A8 C5 62, 30 6A 04 8E 4B C0 B1 0D 10 ED
replace_bytes = 046F79E, 07 16 6F 92 EC F6 36 B0 3F B1, A3 C3 DD 46 64 D7 F5 74 E6 69
replace_bytes = 046F7A8, 80 B7 8B 06 58 C6 7C 7D C9 16, A9 04 15 21 DB 2D E8 8A F8 48
replace_bytes = 046F7B2, 34 C4 8A 0B 79 76 8F 13 59 20, 32 2E 66 6B 14 89 14 B7 44 FE
replace_bytes = 046F7BC, E7 38 FC 1D 09 BE 62 8B 7E C8, AF 80 B3 0D 5D 75 7C 16 31 3E
replace_bytes = 046F7C6, 13 2E 66 48 09 CC 64 8A 05 61, 75 24 47 54 24 88 63 2A EB 39
replace_bytes = 046F7D0, AA 9B 54 E6 66 82 D6 31 55 24, E7 AC CA 98 5D 48 24 4E 01 31
replace_bytes = 046F7DA, 47 2C 89 94 38 22 2E 82 08 A5, 16 02 05 B8 5E 2C 41 AB 15 A1
replace_bytes = 046F7E4, 78 B1 A0 2C 9A A1 C1 F6 F9 1E, C1 D4 49 EB F2 98 70 96 60 2E
replace_bytes = 046F7EE, 52 C1 53 22 D4 A6 8F 75 3D D8, F7 1D A4 2A 40 63 75 CB D4 B9
replace_bytes = 046F7F8, 52 DF 36 43 27 E7 D9 EF AF E4, 9C 1F AE BF E0 B5 74 9E 9D F4
replace_bytes = 046F802, 5E A1 67 94 FF BE BD D0 17 88, FA FE 5A 6D 60 7E 79 D5 5A 33
replace_bytes = 046F80C, 38 C9, 2A 3B
replace_bytes = 046F810, 39 53 7D A9 36 09 99 21 AA 74, 23 3C 75 88 54 41 7E 5E 1E F6
replace_bytes = 046F81A, 58 58 4D A3 CB 69 DB 68 FA 47, D2 31 96 FC 56 A1 DD C9 A9 80
replace_bytes = 046F824, 07 0F 83 A2 9C D6 50 D3 4E 95, C6 40 DD 32 B9 C0 5E 1F 0A D4
replace_bytes = 046F82E, 50 6F 04 85 1A 9E A9 44 8E 3C, 9C 91 8B EB F7 C0 38 DD 00 B9
replace_bytes = 046F838, 30 D2 B4 45 25 F6 D4 1A 9B F0, C8 81 31 32 62 3E 8A F0 0D 8A
replace_bytes = 046F842, 10 27 E4 0A 2F C9 D9 F1 2F 7C, F1 EC E2 27 7A F8 7C 7B 91 85
replace_bytes = 046F84C, F7 E5 FA B8 1A B8 AD 13 E3 62, 1D AB 43 19 8F 51 54 88 AC F2
replace_bytes = 046F856, 89 93 5A 6C BB 6B 80 9E B4 B4, 07 D0 05 63 E1 6D D1 CD DB 61
replace_bytes = 046F860, C1 15 7F 48 73 1C 80 AF 6B 99, 81 7B 4D 93 2C 70 D5 AD EB 35
replace_bytes = 046F86A, 03 10 6A A4 B7 47 82 E7 C9 46, 48 6E 1E ED 85 D8 C4 56 4E B0
replace_bytes = 046F874, CA D5 D2 D1 19 0E C0 2B FE 88, C0 DD B0 2D 7A 2B 16 E4 B5 FE
replace_bytes = 046F87E, DF 8E 06 BB 6F 34 A9 13 6F 52, A8 C8 BB 4B 90 8F 79 CD 84 56
replace_bytes = 046F888, 1C 12 D1 39 D9 F5 00 5B D3 85, 83 69 47 56 32 54 56 1D A6 93
replace_bytes = 046F892, 8A B5 7D C7 C5 4C D3 83 AE B6, 4A 0D AF C2 02 CC 2B CD E7 8C
replace_bytes = 046F89C, 04 33 2D 73 BD 64 FA 26 D3 77, E7 E9 3C CF 82 A7 4F E7 0C 37
replace_bytes = 046F8A6, 60 9A 53 BD 44 4E 06 06 72 BB, 72 35 DC C8 B5 C0 95 66 73 06
replace_bytes = 046F8B0, D4 81 B4 4C F4 12 1A 98 D0 C0, 9C E8 C0 89 19 58 31 4F B3 D7
replace_bytes = 046F8BA, 0E 6D 9D C1 E5 6B F9 48 25 9D, 6E 4B 04 59 1E DE AC C3 56 3D
replace_bytes = 046F8C4, 67 EF 5D 76 B1 1B 61 7D B5 5F, C0 F0 E2 BE 10 D2 BD 13 82 6E
replace_bytes = 046F8CE, 18 F9 D5 02 C2 56 40 3B 3F 1C, 80 D6 7D 68 B5 05 46 DC 0F 17
replace_bytes = 046F8D8, F5 24 C1 22 8C 2F 43 CE DE AC, 3E A3 6F D2 62 5D AE D0 59 40
replace_bytes = 046F8E2, ED 4D C9 5A B7 01 C9 03 5C D1, AE A1 03 74 B9 7C E3 01 B5 66
replace_bytes = 046F8EC, 94 AC 9A 01 50 DC DF 33 86 60, FE 28 89 15 6C 01 C9 35 F4 0F
replace_bytes = 046F8F6, CD 2A 90 E4 01 9E 02 7B 99 A3, D8 3B 85 39 7D 47 3B 91 FA 4C
replace_bytes = 046F900, 8A BD B8 9F E8 8D 56 CF B3 82, AA 19 95 06 9E D7 F8 E9 74 64
replace_bytes = 046F90A, B6 5B 15 DB 43 C7 A9 5B A7 2C, D7 99 12 AC 6F 82 79 56 75 2F
replace_bytes = 046F914, C0 91 1D E8 3B F5 C1 C2 3B 7D, B1 06 AF 64 E9 D5 2A D2 BC 1E
replace_bytes = 046F91E, 35 CF AC 5E 9D E8 7B 20 D1 DD, 40 B3 75 B3 16 DE 73 6B E2 AB
replace_bytes = 046F928, ED 0D 80 37 E8 20 B4 97 AE 20, 8A 75 8A EF D7 C5 57 D4 E7 DC
replace_bytes = 046F932, 8C BA 08 AD B5 DA B5 AD 13 D0, A4 DA F0 AA 92 9C 1F FF FC 0D
replace_bytes = 046F93C, 5E 9C 5D 19 76 3B 88 CC CF, 10 E9 19 6E 89 F8 B5 1A E8
replace_bytes = 046F946, 73 2C 2E F4 66 80 29 23 42 5B, 50 CC 95 2D 89 E2 BD FC B6 3A
replace_bytes = 046F950, 96 6A E2 CB 7F C7 C3 A6 09 82, 0A 96 31 F0 10 29 28 C0 95 CF
replace_bytes = 046F95A, C7 4D 4D A3 AB 07 E5 68 D3 92, C6 95 12 F4 D3 53 E0 B8 32 79
replace_bytes = 046F964, 61 7E C6 9C B6 3E 00 3C 73 00, 78 96 00 AA 7A BF 0C AA 5D D7
replace_bytes = 046F96E, 5D B3 73 16 DD E1 C0 51 B8 31, 52 56 9B 29 80 AA D6 65 93 A8
replace_bytes = 046F978, 79 00 5D A3 DF 36 59 DF 55 B6, 67 2B AA CF 16 48 56 77 87 41
replace_bytes = 046F982, 39 7F 20 61 D3 27 16 69 0F, B8 07 3C 6D 83 73 5B A6 70
replace_bytes = 046F98C, E2 BD 4E 82 A5 46 F6 AA 7E C3, 29 BF 22 1E 10 AA FE 38 79 C5
replace_bytes = 046F996, 22 A2 6C 86 C6 7E F3 AB 21 F7, F3 7C EA CE E2 66 E3 0C AA 3B
replace_bytes = 046F9A0, 6A FD F2 DE 59 40 BD AD 66 31, 9A CF 60 DC 05 32 38 6E 36 CE
replace_bytes = 046F9AA, 1D 82 59 4C 87 07 65 01 74 BA, A0 B2 BB 85 04 86 50 02 C3 FF
replace_bytes = 046F9B4, 96 C4 18 4E 62 7C 58 12 50 D7, 4B A0 BA CF F9 14 26 50 0D 26
replace_bytes = 046F9BE, AB 69 04 70 2D 02 F7 5A E4 4A, F6 35 48 55 9A D8 C0 05 F4 ED
replace_bytes = 046F9C8, FB D9 C2 F8 96 AC E5 E0 6E 4D, 6D 68 90 B7 F3 C0 BB C9 5B 19
replace_bytes = 046F9D2, 4B 0A AE 9E 78 C7 14 1C 0D F1, E0 FD D4 ED BA 6F A1 FF 0F 7A
replace_bytes = 046F9DC, 9E 19 B8 BA C1 29 87, 6D 65 8F C9 89 65 FA
</Patch>

[Terisa de morgan]

Thank you for your patchs, geoffr and jackie, and geek101 for tool and patch. As soon as I'm near my desktop again, I intend to use the new method, as I hope to keep the same configuration file.

[geek1011]

Originally Posted by Terisa de morgan

Thank you for your patchs, geoffr and jackie, and geek1011 for tool and patch. As soon as I'm near my desktop again, I intend to use the new method, as I hope to keep the same configuration file.

No problem! You will be able to use the same configuration file, all you need to do is update the version and firmware path.

[jackie_w]

Originally Posted by JIPG-reader

OK. I will try with both methods and will compare them until I feel comfortable changing the files.

In theory, should they produce the same final koboroot file or not?

Originally Posted by geek1011

Yes, and in reality too. I tested this for 2 months with over 8 different patch sets. It's been stable for quite a while.

Can I add something here? Hopefully it might save someone else some wasted time and energy.

I have had no success whatsoever trying to compare 2 different copies of KoboRoot.tgz using a checksum utility. Even if I run kobopatch twice with identical settings the 2 KoboRoot.tgz files will give different checksums.

To do a useful comparison I have always needed to unpack the contents of KoboRoot.tgz before running the checksum utility on each of the constituent files:
- nickel
- libnickel.so.1.0.0
- librmsdk.so.1.0.0
- libadobe.so

I don't know why the above is true. I always assumed it must be something to do with slight variations during the zipping-up process.

[JIPG-reader]

Deleted. - False problem when opening Koboroot.tgz with Winrar. Opening it with 7-zip is OK.

Just a question: Why all files that can be patched are written to koboRoot.tgz although they are not patched? With previous patching system only the patched files were included.

And another "windows user" question: Why in kobopatch is created a folder called "." before the "usr" folder?. It was not in previous patching system.

[jackie_w]

Originally Posted by JIPG-reader

Just a question: Why all files that can be patched are written to koboRoot.tgz although they are not patched? With previous patching system only the patched files were included.

If you prefer, you can exclude the files which are not needed by commenting them out (or deleting the whole line) in the patches section, e.g.

## This section lists the patch files and the corresponding binary in the tgz.
patches:
  src/libnickel.so.1.0.0.yaml: usr/local/Kobo/libnickel.so.1.0.0
  #src/librmsdk.so.1.0.0.yaml: usr/local/Kobo/librmsdk.so.1.0.0
  src/nickel.yaml: usr/local/Kobo/nickel
  #src/libadobe.so.yaml: usr/local/Kobo/libadobe.so

Originally Posted by JIPG-reader

And another "windows user" question: Why in kobopatch is created a folder called "." before the "usr" folder?. It was not in previous patching system.

Short answer: Don't worry about it
Long answer: I remember going through this as well. There is some discussion about it a couple of weeks (months???) ago, but I can't find it right now. ETA: It was 4 months ago! Post #40 onwards in this old thread

[geek1011]

Why the different checksums: file modification times.
Why are all files written: to allow people to disable all patches and get a unpatched KoboRoot.tgz
Why is there a . folder: it doesn't make any difference; some tools do it, others don't.
Why doesn't it work with WinRAR: WinRAR has a bug (with many tar.gz files)

[jackie_w]

Originally Posted by geek1011

Why the different checksums: file modification times.

But if I extract nickel from 2 versions of KoboRoot.tgz they also have different modification times but I do get matching checksums

[geek1011]

Originally Posted by jackie_w

But if I extract nickel from 2 versions of KoboRoot.tgz they also have different modification times but I do get matching checksums

That's because the checksum only includes the file content. When a file is in an archive, the metadata is part of the content, so it is included in the checksum.

[jackie_w]

Originally Posted by geek1011

That's because the checksum only includes the file content. When a file is in an archive, the metadata is part of the content, so it is included in the checksum.

OK, I didn't know that. Thanks for explaining

[jiminrussell]

I like the new method, edit the kobopatch.yaml file by adding overrides for the patches I want for the 4 yaml files in the src folder. I assume I will be able to use the same override lines again for future updates which should make future updates much easier to patch.

Thank you to geek1011 for the new tool and to Jackie_W and GeoffR.

One thing I did find a bit odd, not with this new method for patching but with the firmware download page, is that my Aura One (not LE) updated OTA to 4.10.11591 yet the firmware download page lists 4.9.11311 as the latest FW available for the Aura One, I downloaded the Mark 6 v of 4.10.11591 and it worked fine.

[geek1011]

Yep. You will be able to use the same overrides in all patch versions.

As for the OTA update, if you got it about a week ago, it was temporarily released, but it got taken down. If you got it within the last few days, I'd like to know your affiliate (.kobo/affiliate.conf).

[jiminrussell]

Originally Posted by geek1011

Yep. You will be able to use the same overrides in all patch versions.

As for the OTA update, if you got it about a week ago, it was temporarily released, but it got taken down. If you got it within the last few days, I'd like to know your affiliate (.kobo/affiliate.conf).

Got it today using BestBuyCA as affiliate.