How to use Kobopatch.yaml

[Ned]

Hello, I must have mental block with it, but I can't for the life of me work out how to use kobopatch.yaml to keep the same patch settings each time.

I've searched and tried to understand, but failed miserably.

Is there some step by step guidance please that I've missed?

[DNSB]

Originally Posted by Ned

Hello, I must have mental block with it, but I can't for the life of me work out how to use kobopatch.yaml to keep the same patch settings each time.

I've searched and tried to understand, but failed miserably.

Is there some step by step guidance please that I've missed?

Basically, in kobopatch.yaml, you need to insert the patches you want to use in the overrides section. I generally put all the patches in there and just enable the ones I want to use for that run. Every now and then, you need to go through that section and remove obsolete patches and add new patches. See the spoiler below for an example.

Spoiler:

patchFormat: kobopatch

patches:
  src/nickel.yaml: usr/local/Kobo/nickel
  src/libadobe.so.yaml: usr/local/Kobo/libadobe.so
  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

## 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/libadobe.so.yaml:
    Remove PDF map widget shown during panning: no 
    
  src/libnickel.so.1.0.0.yaml:
# 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: no 
    Custom font sizes: no 
    ePub fixed top/bottom margins: no 
    ePub disable built-in body padding-bottom: no 
    Custom kepub default margins: no 
    Block WiFi firmware upgrade: no 
    Custom Sleep/Power-off timeouts: no 
    Set KePub hyphenation: no 
    Force user line spacing in KePubs: no 
    Force user line spacing in ePubs (part 1 of 2): no 
    Un-force font-family override p tags (std epubs): no 
    Force user font-family in ePubs (Part 1 of 2): no 
    ePub constant font sharpness: no 
    Un-Force user text-align in div,p tags in KePubs: no 
    Un-force link decoration in KePubs: no 
    Dictionary text font-family/font-size/line-height: no 
# PATCH GROUP - DON'T ENABLE MORE THAN 1 
    KePub stylesheet additions - text justify: no 
    KePub stylesheet additions - optimizeSpeed: no 
    KePub stylesheet additions - optimizeLegibility: no 
# END GROUP 
    Shorten dictionary entry not found message: no 
    Change Wikipedia search language: no 
    Cyrillic Keyboard (GloHD/ClaraHD/AuraOne/H2O2): no 
    Greek Keyboard (GloHD/ClaraHD/AuraOne/H2O2): no 
    Bulgarian Phonetic Keyboard (GloHD/ClaraHD/AuraOne/H2O2/Forma/Libra): no 
    Don't grab exclusive access to event0: no 
    Both page turn buttons go next: no 
    Both page turn sides go next: no 
    Increase page navigation history: no 
    Replace adobe page numbers toggle with invert screen: no 
    Always show confirmation dialog before upgrading: no 
    Allow USB storage even when device locked: no 
    Hide browser from beta features: no 
    Remove beta features not supported text: no 
    Disable all tutorial dialogs: no 
    Remove recommendations (row1col2) from home screen: no 
    Rename new home screen footer: no 
    Remove line from bottom tab bar: no 
    Change Browse Kobo home screen link target - Activity: no 
    Set visible SmartLink: no 
    Only show Pocket SmartLink: no 
    Only show stats SmartLink: no 
    Never show Kobo Plus, wishlist, and points SmartLinks: no 
    Allow showing info panel on random screensaver: no 
    Remove title from reading header/footer: no 
    Larger Sleep/Power-off timeouts: no 
    Allow rotation on all devices: no 
    Don't uppercase header/footer text: no 
    Custom header/footer page number text: no 
    Don't uppercase header/footer text and change page number text: no 
    Swap reading header/footer: no 
    Customize ComfortLight settings: no 
    FeatureSettings - BookSpecificStats: no 
    FeatureSettings - ShowFacebookShare: no 
    FeatureSettings - FullScreenBrowser: no 
    FeatureSettings - MyWords: no 
    FeatureSettings - ExportHighlights: no 
    DeveloperSettings - AutoUsbGadget: no 
    PowerSettings - UnlockEnabled: no 
    Unify font sizes: yes 
    
  src/librmsdk.so.1.0.0.yaml: 
    Disable orphans/widows avoidance: 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 
    Force user font-family in ePubs (Part 2 of 2): no 
    Ignore ePub book Adobe XPGT stylesheet (page-template.xpgt): no 
    Ignore ePub book CSS and Adobe XPGT stylesheets: no 
    Ignore ePub TOC navpoints: no 
    Default ePub monospace font: no 
    
  src/nickel.yaml: 
    Reduce top/bottom page spacer: no 
    Custom synopsis details line spacing: no 
    Custom synopsis font size: no 
    Increase home screen cover size: no 
    Dictionary pop-up - increase available text area: no 
    Increase Book Details synopsis area: no 
    Increase library cover size: no 
    Custom collection/author header title font: no 
    Reduce new header/footer height: no 
    Custom header/footer captions: no 
    Custom page navigation scrubber: no 
    Customise Header back button: no 
    Series list increase cover thumbnails: no 
    Increase headlines font: no 
    New home screen subtitle custom font: no 
    Remove footer (row3) and increase cover size on new home screen: no 
    Remove footer (row3) on new home screen: no 
    Show all games: no 
    Remove forgot pin button from lock screen: no 
    Increase size of kepub chapter progress chart: no 
    Change TOC level indentation: no 
    
## TRANSLATIONS ##
# Optional, use only if lrelease is not in PATH and if translations are needed
# lrelease: /path/to/lrelease

[Wiggo]

You could enable the single patches also directly in the 4 yaml files.

[JSWolf]

Originally Posted by Wiggo

You could enable the single patches also directly in the 4 yaml files.

But then you have to do that for every firmware update. It's easir (IMHO) to use kobopatch.tyaml. Also, by using kobopatch.yaml, I'm able to also update the hyphenation dictionary.

[Ned]

Ah Thank you, I get it.
And do I then put kobopatch.yaml in the src folder or will running kobopatch.sh know where to look and to ignore the ones in the src folder?

[JSWolf]

Originally Posted by Ned

Ah Thank you, I get it.
And do I then put kobopatch.yaml in the src folder or will running kobopatch.sh know where to look and to ignore the ones in the src folder?

Here is the directory structure.

bin
out
src
kobopatch.bat
kobopatch.yaml

[DNSB]

Originally Posted by Ned

Ah Thank you, I get it.
And do I then put kobopatch.yaml in the src folder or will running kobopatch.sh know where to look and to ignore the ones in the src folder?

You will not have to move kobopatch.yaml. It must live in the root of the kobopatch directory along with the other kobopatch.<whatever> files.

One other item you might want to do is to copy the overrides section of kobopatch.yaml once you are happy with it and save it as a text file that you can copy/paste into kobopatch.yaml to make it easier to restore when the next patch update overwrites kobopatch.yaml. My backup copy is very boringly called overrides.txt.

[Ned]

Thank you very much, that's clear now.
I'll use it on the latest version and keep a backup as you suggest
For new releases of patches, is there normally some indication as to whether any changes mean that I can't use my copied overrides?

[JSWolf]

Originally Posted by Ned

Thank you very much, that's clear now.
I'll use it on the latest version and keep a backup as you suggest
For new releases of patches, is there normally some indication as to whether any changes mean that I can't use my copied overrides?

When a new set of patches is released, it will be posted if there are any patches that have changed or are no longer there. So you will know if any of the patches you use have changed or are not there.

[Wiggo]

Originally Posted by JSWolf

But then you have to do that for every firmware update. It's easir (IMHO) to use kobopatch.tyaml. Also, by using kobopatch.yaml, I'm able to also update the hyphenation dictionary.

Maybe you meant patch update instead of firmware update?
That’s a good point for switching to kobopatch.yaml - thx

[Ned]

Brilliant, thanks all for your very helpful comments.
For some reason I just couldn't get that one!!

[JSWolf]

Originally Posted by Wiggo

Maybe you meant patch update instead of firmware update?
That’s a good point for switching to kobopatch.yaml - thx

I did mean firmware update. If you change no to yes in the src patches, you have to redo it every time there is another firmware released because there will be another release of patches.

[Ned]

Just starting to create the .yaml file and I notice that there is an awful lot of code and I only enable very few features.

Is there any technical reason why I cannot simply delete the lines relating to features I don't want, thereby giving me a much more manageable file?

e.g. Custom Sleep/Power-off timeouts:
- Enabled: no

can I delete the whole section down to where the next one starts ?
Or if it is Enabled: no can I delete all the lines of code after no?

Using only the features I want will then give me a nice compact kobopatch.yaml

[Wiggo]

Originally Posted by JSWolf

I did mean firmware update. If you change no to yes in the src patches, you have to redo it every time there is another firmware released because there will be another release of patches.

So in the end it’s patch updates not firmware update.

[DNSB]

Originally Posted by Ned

Just starting to create the .yaml file and I notice that there is an awful lot of code and I only enable very few features.

Is there any technical reason why I cannot simply delete the lines relating to features I don't want, thereby giving me a much more manageable file?

e.g. Custom Sleep/Power-off timeouts:
- Enabled: no

can I delete the whole section down to where the next one starts ?
Or if it is Enabled: no can I delete all the lines of code after no?

Using only the features I want will then give me a nice compact kobopatch.yaml

No reason. If you want to do it a different way from me, well, I didn't get my way from a set of stone tablets, just a personal preference. You will need to retain the source file. Since I only use one option for libnickel.so.1.0.0.yaml, I could simplify that entry to:

  src/libnickel.so.1.0.0.yaml:
    Unify font sizes: yes

Please note the use of spaces is not flexible.