kobopatch - An improved patching system

[geek1011]

I have released kobopatch v0.10.3 with a new MustMatchLength option for FindReplaceString and ReplaceString. This option will make sure the replacement string is not shorter than the original (in addition to the default check to make sure it is not longer). This is useful for CSS string replacements. The behaviour of this option (and lack thereof) is fully backwards-compatible.

I have updated the patches for 4.11.11980 to use this new option.

[jcn363]

Originally Posted by geek1011

I have released kobopatch v0.10.3 with a new MustMatchLength option for FindReplaceString and ReplaceString. This option will make sure the replacement string is not shorter than the original (in addition to the default check to make sure it is not longer). This is useful for CSS string replacements. The behaviour of this option (and lack thereof) is fully backwards-compatible.

I have updated the patches for 4.11.11980 to use this new option.

geek1011 please,
could you add the error line number or the replace statement into log.txt when error trigger?

validating patch file
        --> length of strings must match (and not be shorter) in `PROGRESIVE`

And check the code. No bother if the lenght is longer o shorter the message is allways the same (and not be shorter).
Thanks in advance.

[geek1011]

Originally Posted by jcn363

geek1011 please,
could you add the error line number or the replace statement into log.txt when error trigger?

validating patch file
        --> length of strings must match (and not be shorter) in `PROGRESIVE`

And check the code. No bother if the lenght is longer o shorter the message is allways the same (and not be shorter).
Thanks in advance.

Ok, I'll work on line numbers either today or later this week.

As for the error message, I'll correct that in the next version (I put that check before the one for too long by accident).

[geek1011]

I have released kobopatch v0.10.4 with the changes requested by jcn363.

- Error message for MustMatchLength has been improved
- Instruction numbers (basically just count the dashes) have been added to error messages

[jcn363]

Originally Posted by geek1011

I have released kobopatch v0.10.4 with the changes requested by jcn363.

- Error message for MustMatchLength has been improved
- Instruction numbers (basically just count the dashes) have been added to error messages

EDIT:

validating patch file
        --> i256: length of strings must match (and not be shorter) in `PROGRESIVE`

I've add a extra-space in line 5341 (into replace 153) therefore it is longer (no shorter).
I need a translation/explanation.
In the previous log-system was clear where has raised error. Don't you can use it?
Good luck.

[geek1011]

Originally Posted by jcn363

EDIT:

validating patch file
        --> i256: length of strings must match (and not be shorter) in `PROGRESIVE`

I've add a extra-space in line 5341 (into replace 153) therefore it is longer (no shorter).
I need a translation/explanation.
In the previous log-system was clear where has raised error. Don't you can use it?
Good luck.

i256 is the 256th instruction (dash) in the PROGRESIVE patch. As for the previous log system I had, I personally found it way too verbose for debugging most common issues. I could add an option to be more verbose if you'd like.

[jcn363]

Originally Posted by geek1011

i256 is the 256th instruction (dash) in the PROGRESIVE patch. As for the previous log system I had, I personally found it way too verbose for debugging most common issues. I could add an option to be more verbose if you'd like.

I think the ideal will be to make verbose when error raising.
If you find easiest to implement the verbose option... go ahead!
Good luck.

[GeoffR]

I'm having a problem with FindBaseAddressString using kobopatch-apply (linux 64-bit), not sure if it is a problem with kobopatch-apply or a problem with my yaml.

I made `My 10 line spacing values` (libnickel.so.1.0.0) into a multi-version patch. Here is the patch32lsb version:

Spoiler:

<Patch>
patch_name = `My 10 line spacing values`
patch_enable = `yes`
# Multi-version patch: 4.6.9960 - 4.11.11980+
# patch_group = `Line spacing values alternatives`
#
## This patch changes the values on the line spacing adjustment slider,
## reducing the number of spacing options from 15 to 10, but allowing
## much narrower spacing values to be set.
#
# Bypass code-constructed values 1.0, 1.2, 1.5, 2.0, 3.0
find_base_address = "\x4F\xF0\x00\x09\x07\xF1\x80\x01\x4F\xF0\x00\x08\xC3\xF6\xF0\x79\x3C\x1D\xF3\x58\x20\x46\x61\xE9\x1E\x89\x7B\x60"
replace_bytes = 0014, 20 46 61 E9 1E 89, 7B 60 03 E0 00 BF
replace_bytes = 006C, 20 46, 03 E0
replace_bytes = 0096, 20 46, 03 E0
replace_bytes = 00D2, 20 46, 03 E0
replace_bytes = 0138, 20 46, 03 E0
#
# 10 values for replacement, change these replace_float values to suit:
find_base_address = "\xCD\xCC\xCC\xCC\xCC\xCC\xF0\x3F\x1F\x85\xEB\x51\xB8\x1E\xF1\x3F"
replace_float = 0000, 1.05, 0.8
replace_float = 0008, 1.07, 0.85
replace_float = 0010, 1.1, 0.875
replace_float = 0018, 1.35, 0.9
replace_float = 0020, 1.7, 0.925
replace_float = 0028, 1.8, 0.95
replace_float = 0030, 2.2, 0.975
replace_float = 0038, 2.4, 1.0
replace_float = 0040, 2.6, 1.05
replace_float = 0048, 2.8, 1.1
</Patch>

Here is the kobopatch yaml version:

Spoiler:

My 10 line spacing values:
  - Enabled: yes
  - PatchGroup: Line spacing values alternatives
  - Description: |
      This patch changes the values on the line spacing adjustment slider,
      reducing the number of spacing options from 15 to 10, but allowing
      much narrower spacing values to be set.
    # Bypass code-constructed values 1.0, 1.2, 1.5, 2.0, 3.0
  - FindBaseAddressString: "\x4F\xF0\x00\x09\x07\xF1\x80\x01\x4F\xF0\x00\x08\xC3\xF6\xF0\x79\x3C\x1D\xF3\x58\x20\x46\x61\xE9\x1E\x89\x7B\x60"
  - ReplaceBytes: {Offset: 0x14, FindH: 20 46 61 E9 1E 89, ReplaceH: 7B 60 03 E0 00 BF}
  - ReplaceBytes: {Offset: 0x6C, FindH: 20 46, ReplaceH: 03 E0}
  - ReplaceBytes: {Offset: 0x96, FindH: 20 46, ReplaceH: 03 E0}
  - ReplaceBytes: {Offset: 0xD2, FindH: 20 46, ReplaceH: 03 E0}
  - ReplaceBytes: {Offset: 0x138, FindH: 20 46, ReplaceH: 03 E0}
    # 10 values for replacement, change these replace_float values to suit:
  - FindBaseAddressString: "\xCD\xCC\xCC\xCC\xCC\xCC\xF0\x3F\x1F\x85\xEB\x51\xB8\x1E\xF1\x3F"
  - ReplaceFloat: {Offset: 0x00,  Find: 1.05, Replace: 0.8}
  - ReplaceFloat: {Offset: 0x08,  Find: 1.07, Replace: 0.85}
  - ReplaceFloat: {Offset: 0x10,  Find: 1.1,   Replace: 0.875}
  - ReplaceFloat: {Offset: 0x18,  Find: 1.35,  Replace: 0.9}
  - ReplaceFloat: {Offset: 0x20,  Find: 1.7,   Replace: 0.925}
  - ReplaceFloat: {Offset: 0x28,  Find: 1.8,   Replace: 0.95}
  - ReplaceFloat: {Offset: 0x30,  Find: 2.2,   Replace: 0.975}
  - ReplaceFloat: {Offset: 0x38,  Find: 2.4,   Replace: 1.0}
  - ReplaceFloat: {Offset: 0x40,  Find: 2.6,   Replace: 1.05}
  - ReplaceFloat: {Offset: 0x48,  Find: 2.8,   Replace: 1.1}

The patch32lsb version applies to libnickel.so.1.0. as expecued, but kobopatch-apply gives this error message for the yaml version:

Spoiler:

  APPLY `My 10 line spacing values`
    Error: i4: could not apply patch: FindBaseAddress: could not find bytes

[geek1011]

Originally Posted by GeoffR

I'm having a problem with FindBaseAddressString using kobopatch-apply (linux 64-bit), not sure if it is a problem with kobopatch-apply or a problem with my yaml.

The issue is with your yaml. When doing finds for bytes, you should use FindBaseAddressHex, so it doesn't get interpreted as a UTF-8 string and get all mangled. Also, it allows you to make the hex more readable.

Here is a fixed version:

Spoiler:

My 10 line spacing values:
  - Enabled: no
  - PatchGroup: Line spacing values alternatives
  - Description: |
      This patch changes the values on the line spacing adjustment slider,
      reducing the number of spacing options from 15 to 10, but allowing
      much narrower spacing values to be set.
    # Bypass code-constructed values 1.0, 1.2, 1.5, 2.0, 3.0
  - FindBaseAddressHex: 4F F0 00 09 07 F1 80 01 4F F0 00 08 C3 F6 F0 79 3C 1D F3 58 20 46 61 E9 1E 89 7B 60
  - ReplaceBytes: {Offset: 0x14, FindH: 20 46 61 E9 1E 89, ReplaceH: 7B 60 03 E0 00 BF}
  - ReplaceBytes: {Offset: 0x6C, FindH: 20 46, ReplaceH: 03 E0}
  - ReplaceBytes: {Offset: 0x96, FindH: 20 46, ReplaceH: 03 E0}
  - ReplaceBytes: {Offset: 0xD2, FindH: 20 46, ReplaceH: 03 E0}
  - ReplaceBytes: {Offset: 0x138, FindH: 20 46, ReplaceH: 03 E0}
    # 10 values for replacement, change these replace_float values to suit:
  - FindBaseAddressHex: CD CC CC CC CC CC F0 3F 1F 85 EB 51 B8 1E F1 3F
  - ReplaceFloat: {Offset: 0x00,  Find: 1.05, Replace: 0.8}
  - ReplaceFloat: {Offset: 0x08,  Find: 1.07, Replace: 0.85}
  - ReplaceFloat: {Offset: 0x10,  Find: 1.1,   Replace: 0.875}
  - ReplaceFloat: {Offset: 0x18,  Find: 1.35,  Replace: 0.9}
  - ReplaceFloat: {Offset: 0x20,  Find: 1.7,   Replace: 0.925}
  - ReplaceFloat: {Offset: 0x28,  Find: 1.8,   Replace: 0.95}
  - ReplaceFloat: {Offset: 0x30,  Find: 2.2,   Replace: 0.975}
  - ReplaceFloat: {Offset: 0x38,  Find: 2.4,   Replace: 1.0}
  - ReplaceFloat: {Offset: 0x40,  Find: 2.6,   Replace: 1.05}
  - ReplaceFloat: {Offset: 0x48,  Find: 2.8,   Replace: 1.1}

Another thing you might want to consider is using integers for the additional offsets (i.e. the ones which aren't absolute addresses), as it makes it more readable and consistent with the newer kobopatch patches.

Thanks for updating your line spacing patches (and for all the help during the early stages of kobopatch)! Also, I'm planning to make a proper site for kobopatch along with some proper documentation.

[ColFormi]

I am sorry but I don't understand the phrase "use the overrides in kobopatch.yaml to keep your options separate". What options? What exactly does it mean?

[DNSB]

Originally Posted by ColFormi

I am sorry but I don't understand the phrase "use the overrides in kobopatch.yaml to keep your options separate". What options? What exactly does it mean?

You can leave all patches disabled in their yaml files and use the overrides section in the kobopatch.yaml to enable/disable patches. I kep my current settings into a separate file called overrides.sav. That way when I get a new patch file, I can copy the overrides back into the new kobopatch.yaml and be back to my default set of patches and only have to add /remove new or modified patches. It beats the heck out of going through every patch file and enabling or disabling them.

The default from kobopatch.yaml:

## You can put lines in the following section to override the enabled state of patches.
## The indentation matters! Each override should be indented by 4 spaces. Add to the 
## section below. This section can be copy and pasted into newer patch versions to
## keep your selections.
##
## Example of how it should look:
## overrides:
##   src/nickel.yaml:
##     Custom synopsis/details line spacing: yes
##     Whatever the yaml is called: no
##   src/libadobe.so.yaml:
##     You get the idea: yes
overrides:
  src/nickel.yaml:
  src/libadobe.so.yaml:
  src/libnickel.so.1.0.0.yaml:
  src/libnickel-PROGRESIVE.yaml
  src/librmsdk.so.1.0.0.yaml:

and my modified version:

## You can put lines in the following section to override the enabled state of patches.
## The indentation matters! Each override should be indented by 4 spaces. Add to the 
## section below. This section can be copy and pasted into newer patch versions to
## keep your selections.
##
## Example of how it should look:
## overrides:
##   src/nickel.yaml:
##     Custom synopsis/details line spacing: yes
##     Whatever the yaml is called: no
##   src/libadobe.so.yaml:
##     You get the idea: yes
overrides: 
  src/nickel.yaml: 
    Show all games: no 
    Remove forgot pin button from lock screen: no 
    Remove recommendations (row1col2) from home screen: no 
    Change pop-up footnote font-family: no 
# PATCH GROUP - DON'T ENABLE MORE THAN 1 
    Disable reading footer: no 
    Custom reading footer style: yes 
# END GROUP 
    Custom synopsis/font size: no 
    Custom synopsis/details line spacing: no 
# PATCH GROUP - DON'T ENABLE MORE THAN 1 
    Custom menubar - reduce height by 33%: yes 
    Custom menubar - reduce height by 50%: no 
# END GROUP 
    Dictionary pop-up - increase available text area: no 
    Fix reading stats/author name cut off when series is showing: no 
    Changing the info panel in full size screensaver- beta 1: no 
    Increase the cover size in library: no 
    Increase the view details container size: no 
    Increase size of kepub chapter progress chart: no 
    Custom font to collection and author titles: no 
    Increase headlines font: no 
    New home screen subtitle custom font: no 
# PATCH GROUP - DON'T ENABLE MORE THAN 1 
    Remove footer (row3) and increase cover size on new home screen: no 
    Remove footer (row3) on new home screen: no 
    New home screen increasing cover size: no 
# END GROUP 
  src/libadobe.so.yaml: 
  src/libnickel-PROGRESIVE.yaml: 
    Dictionary, remove long winded closest match notification: no 
    unclassified (PROGRESIVE): no 
    MY ePub/Kepub fixed font sharpness: no 
    Wikipedia Search language: no 
    MY KePub stylesheet additions: no 
    My Dictionary text font-family/font-size/line-height: no 
  src/libnickel.so.1.0.0.yaml: 
    Rename new home screen footer: no 
    Set slide to unlock: no 
    Enable rotation on all devices: no 
    Both page turn buttons go next: no 
    Replace adobe page numbers toggle with invert screen: yes 
    Rename settings: no 
# PATCH GROUP - DON'T ENABLE MORE THAN 1 
    My 10 line spacing values: no 
    My 24 line spacing values: no 
# END GROUP 
    Custom left & right margins: yes 
    Custom font sizes: yes 
    Freedom to advanced fonts control: yes 
# PATCH GROUP - DON'T ENABLE MORE THAN 1 
    ePub fixed/adjustable top/bottom margins: no 
    ePub fixed top/bottom margins: no 
    ePub disable built-in body padding-bottom: no 
# END GROUP 
    Custom kepub default margins: no 
    Block WiFi firmware upgrade: no 
    Custom footer (page number text): no 
    Custom Sleep/Power-off timeouts: no 
    Set KePub hyphenation: no 
    Fix three KePub fullScreenReading bugs: no 
    Force user line spacing in KePubs: no 
    Force user line spacing in ePubs (part 1 of 2): no # PART 2 in librmsdk.so.1.0.0.yaml 
# PATCH GROUP - DON'T ENABLE MORE THAN 1 
    Un-force font-family override p tags (std epubs): no 
    Force user font-family in ePubs (Part 1 of 2): no # PART 2 in librmsdk.so.1.0.0.yaml 
# END GROUP 
    ePub constant font sharpness: no 
    KePub constant font sharpness: no 
    Un-Force user text-align in div,p tags in KePubs: no 
    Always display chapter name on navigation menu: no 
    Un-Force user font-family in KePubs: no 
    Un-force link decoration in KePubs: no 
    KePub stylesheet additions: no 
    Change dicthtml strings to micthtml: no 
    Allow searches on Extra dictionaries: no 
    Ignore .otf fonts: no 
    Brightness fine control: no 
    Clock display duration: no 
# PATCH GROUP - DON'T ENABLE MORE THAN 1 
    Keyboard template (Mini/Touch/Glo/Aura): no 
    Keyboard template (AuraHD/H2O): no 
    Keyboard template (GloHD/ClaraHD/AuraOne/H2O2): no 
    Cyrillic keyboard (Mini/Touch/Glo/Aura/AuraHD/H2O): no 
    Cyrillic Keyboard (GloHD/ClaraHD/AuraOne/H2O2): no 
    Arabic keyboard (Mini/Touch/Glo/Aura/AuraHD/H2O): no 
    Hebrew keyboard (Mini/Touch/Glo/Aura): no 
    Hebrew keyboard (AuraHD/H2O): no 
    Hebrew keyboard (GloHD/ClaraHD/AuraOne/H2O2): no 
    Greek Keyboard (GloHD/ClaraHD/AuraOne/H2O2): no 
# END GROUP 
    Dictionary text font-family/font-size/line-height - beta: no 
    Dictionary, remove long winded closest match notification: no 
    Wikipedia Search language: no 
  src/librmsdk.so.1.0.0.yaml: 
    Disable orphans/widows avoidance: yes 
    Default ePub monospace font (Courier): yes 
    Default ePub serif font (Amasis): no 
    Default ePub sans-serif font (Gill Sans): no 
    Default ePub symbol font (Symbol): no 
    Force user line spacing in ePubs (Part 2 of 2): no # PART 1 in libnickel.so.1.0.0.yaml 
    Force user font-family in ePubs (Part 2 of 2): no # PART 1 in libnickel.so.1.0.0.yaml 
    Ignore ePub book Adobe XPGT stylesheet (page-template.xpgt): no 
    Ignore ePub book CSS and Adobe XPGT stylesheets: no 
    Ignore ePub TOC navpoints: no

Note that I have included the libnickel-PROGRESSIVE patch file in the list.

[ColFormi]

Originally Posted by DNSB

You can leave all patches disabled in their yaml files and use the overrides section in the kobopatch.yaml to enable/disable patches. I kep my current settings into a separate file called overrides.sav. That way when I get a new patch file, I can copy the overrides back into the new kobopatch.yaml and be back to my default set of patches and only have to add /remove new or modified patches. It beats the heck out of going through every patch file and enabling or disabling them.

Thank you, David. I get the idea now.
The kobopatch.yaml looks so neat!
But one more question. Suppose I have edited my kobopatch.yaml, do I need to copy it to the src file to let it take effect?

[geek1011]

Originally Posted by ColFormi

Thank you, David. I get the idea now.
The kobopatch.yaml looks so neat!
But one more question. Suppose I have edited my kobopatch.yaml, do I need to copy it to the src file to let it take effect?

Nope. You can leave it where it is.

[ColFormi]

Originally Posted by geek1011

Nope. You can leave it where it is.

Thank you, Geek1011.
And thank you for putting effort to improve the patching software!

[geek1011]

Originally Posted by ColFormi

Thank you, Geek1011.
And thank you for putting effort to improve the patching software!

No problem!