How to use Kobopatch.yaml

[JSWolf]

Originally Posted by Wiggo

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

Patch updates come after firmware updates. So what I said is correct.

[JSWolf]

@Ned here is my kobopatch.yaml file. I have a custom patch in nickel_custom.yaml and I have comments to say what patches I need to edit. Also, at the end, I have it install the English hyphenation dicationary that I use.

## Works with kobopatch v0.15.0 and later.
## You can update kobopatch by downloading the latest release from https://github.com/pgaskin/kobopatch/releases. 
version: 4.35.20400
in: src/kobo-update-4.35.20400.zip
out: out/KoboRoot.tgz
log: out/log.txt

patchFormat: kobopatch

patches:
  src/nickel.yaml: usr/local/Kobo/nickel
  src/nickel_custom.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:
     My 10 line spacing values: no
## Customized
     My 24 line spacing values: yes
     Custom left & right margins: yes
     Custom font sizes: yes
     ePub fixed top/bottom margins: no
     ePub disable built-in body padding-bottom: yes
     Custom kepub default margins: yes
     Block WiFi firmware upgrade: no
     Custom Sleep/Power-off timeouts: yes
     Set KePub hyphenation: yes
     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: yes
     Un-Force user text-align in div,p tags in KePubs: no
     Un-Force user font-family in KePubs: yes
     Un-force link decoration in KePubs: no
## Customized
     Dictionary text font-family/font-size/line-height: yes
     Custom navigation menu page number text: yes
     KePub stylesheet additions - text justify: no
## Customized
     KePub stylesheet additions - word-spacing: yes
     Shorten dictionary entry not found message: yes
     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: yes
     Replace adobe page numbers toggle with invert screen: yes
     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: yes
     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: yes
     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: yes
     Swap reading header/footer: no
     Customize ComfortLight settings: no
     FeatureSettings - BookSpecificStats: yes
     FeatureSettings - ShowFacebookShare: yes
     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: yes
## Customized
     Custom synopsis details line spacing: yes
     Custom synopsis font size: yes
     Increase home screen cover size: no
     Dictionary pop-up - increase available text area: yes
     Increase Book Details synopsis area: yes
     Increase library cover size: yes
     Custom collection/author header title font: no
## Customized
     Reduce new header/footer height: yes
## Customized
     Custom header/footer captions: yes
## Customized
     Custom page navigation scrubber: yes
     Customise Header back button: no
     Series list increase cover thumbnails: yes
     Increase headlines font: no
     New home screen subtitle custom font: yes
     Remove footer (row3) and increase cover size on new home screen: yes
     Remove footer (row3) on new home screen: no
     Show all games: yes
     Remove forgot pin button from lock screen: no
     Increase size of kepub chapter progress chart: yes
     Change TOC level indentation: no
   src/nickel_custom.yaml:
     jackie_w Screensaver full: yes
     beta Increase width available for book Title in Booklists - Storm only: yes

## TRANSLATIONS ##
# Optional, use only if lrelease is not in PATH and if translations are needed
# lrelease: /path/to/lrelease

# Uncomment the following to add translations (replace lc with the language code)
# translations:
#   src/whatever.ts: usr/local/Kobo/translations/trans_lc.qm

## ADDITIONAL FILES ##
# Uncomment the following to add additional files to the tgz (like init scripts or hyphen dicts)
# The files will be root-owned, and world readable, writable, and executable (0777)
# files:
#   src/whatever.txt: usr/local/Kobo/whatever.txt
#   src/whateverToPutInMultiplePlaces.txt:
#     - usr/local/Kobo/location1.txt
#     - usr/local/Kobo/location2.txt
files:
  C:\Download\Kobo\Hyphenation/hyphenDicts/hyph_en.dic: usr/local/Kobo/hyphenDicts/hyph_en.dic

[Wiggo]

Originally Posted by JSWolf

Patch updates come after firmware updates. So what I said is correct.

You‘re right. I forgot that the FW update wipes out the patches

I‘m taking your hyphenation line - thx

[JSWolf]

Originally Posted by Wiggo

You‘re right. I forgot that the FW update wipes out the patches

I‘m taking your hyphenation line - thx

Take whatever you like. It's there to help anyone.

[Ned]

Just confirming I sorted out a kobopatch.yaml file now and it works

[Ned]

I'd like to increase the font size in my dictionary popup using kobopatch.yaml

I have included the line
Dictionary text font-family/font-size/line-height: yes

but do I then put the actual setting I want it changed to in libnickel.yaml and uncomment the line concerned?
as

# Un-comment and edit next line to change font-size
- ReplaceString: {Offset: 16, Find: "%1px", Replace: "45px", MustMatchLength: yes}

and I will then need to remember to change it in libnickel.yaml next time.

[jackie_w]

Originally Posted by Ned

I'd like to increase the font size in my dictionary popup using kobopatch.yaml

I have included the line
Dictionary text font-family/font-size/line-height: yes

but do I then put the actual setting I want it changed to in libnickel.yaml and uncomment the line concerned?
as

# Un-comment and edit next line to change font-size
- ReplaceString: {Offset: 16, Find: "%1px", Replace: "45px", MustMatchLength: yes}

and I will then need to remember to change it in libnickel.yaml next time.

That should work OK and is the method used by many kobopatch users. As you say you will need to remember to repeat the change for each new release.

There is another way where you wouldn't need to keep repeating the change. I documented it here. It will take a bit more effort the first time you set it up, but should save time and effort on subsequent uses.

[Ned]

Thank you Jackie
I think I'm getting nearer to understanding how it works.

Not sure which way would be easier for me, but in any case I'd better put a comment at the top of my kobopatch.yaml to remind me what to change!!

ps used the way I initially said and it worked fine once I'd put the - in the right place on the uncommented line!!!!
Will bear the other way in mind if I confuse myself on the next patch version

Edit: Just thought, all I need to do is copy over the amended libnickel.yaml to the new src folder

[DNSB]

Originally Posted by Ned

Edit: Just thought, all I need to do is copy over the amended libnickel.yaml to the new src folder

That would only work if there are no changes made to the libnickel.yaml file in the new patch version which would be destroyed by copying your modified version of an older libnickel.yaml.

[Ned]

Originally Posted by DNSB

That would only work if there are no changes made to the libnickel.yaml file in the new patch version which would be destroyed by copying your modified version of an older libnickel.yaml.

Thanks David - so that's another cunning plan scuppered

I was making the assumption that it wouldn't change often
And that if it did change, it would be mentioned in the notes; or at least the old file would still work to produce a patch of some kind.
Or if it failed to generate a patch, then I knew where to look and could then amend the new file.

[jackie_w]

Originally Posted by Ned

Edit: Just thought, all I need to do is copy over the amended libnickel.yaml to the new src folder

Yes, this will often work, but it's patch-dependent and therefore not guaranteed .

Anything containing a hard-coded hex location or offset *may* need to be updated every firmware. Also, sometimes Kobo make major changes to a particular feature, in which case a patch may need a major overhaul to continue working. For example, when Kobo updated their built-in dictionaries in Oct 2020 the particular dictionary patch you originally asked about needed reworking for several successive firmware updates until Kobo finally settled on their preferred code.

Originally Posted by Ned

I was making the assumption that it wouldn't change often And that if it did change, it would be mentioned in the notes; or at least the old file would still work to produce a patch of some kind.
Or if it failed to generate a patch, then I knew where to look and could then amend the new file.

Your assumption is correct. We would always try to mention this kind of change early on in the kobopatch thread dedicated to any new firmware update. If we fail to mention it assume c*ck-up rather than malice

[Ned]

Originally Posted by jackie_w

Your assumption is correct. We would always try to mention this kind of change early on in the kobopatch thread dedicated to any new firmware update. If we fail to mention it assume c*ck-up rather than malice

but of course
And if something doesn't work, I know where to look