One-Click Install Packages for KOReader & Plato

[DNSB]

For your Windows setup, did you follow the step where you unblocked the install.ps1 script?

As for Linux, did you prefix the script with ./ though that is likely old hat to you.

My personal preference is to open a PowerShell or command line window first and then run the script from there just to make any errors available to view.

[alaskazimm]

Oh good gravy, I can't believe that I forgot the ./ <insert embarrassed emoji>.

But for the Windows one I did unblock the script and it still didn't work.

[DNSB]

Originally Posted by alaskazimm

Oh good gravy, I can't believe that I forgot the ./ <insert embarrassed emoji>.

But for the Windows one I did unblock the script and it still didn't work.

When you tried running it in a Powershell window, what was the error message? And just to add more joy, to run a program from the local directory when using PowerShell, you will need to use the ./ prefix

[alaskazimm]

I tried to run both as per the directions in the second post of right clicking on the script and choosing to run in Powershell/Terminal. Then on Linux I tried to run from the terminal by cd'ing to the folder with the script and zip file, but then forgot about ./ to actually run the script. Incidentally I went back after your first reply and ran the script with the ./ and got a error message of No Kobo device detected, so I'm pretty confident that the Linux script would have worked.

On Windows the Powershell window flashed briefly on screen (less than 1 second) before closing, no error message that I saw. By that time I just gave up and did the install manually.

So it was user error as these things tend to be, anyway thank you for the help.

[theshtank]

I just got a Kobo Libra 2 and ran the script on my Mac. Followed the steps pretty precisely. Koreader is doing the bomb crash and rebooting every time I try to open it.

The only difference in the install process is that gatekeeper didn't try to block me from running the script.

The crashlog is super long but the one part I'm able to see as a potential culprit is here.

Wondering what to do to fix this.

05/07/25-16:13:01 INFO  ./cache/fontlist/fontinfo.dat fopen: No such file or directory -> initializing it 
05/07/25-16:13:02 INFO  Performing one-time migration for 20210306 (1/2) 
05/07/25-16:13:02 INFO  Performing one-time migration for 20210306 (2/2) 
05/07/25-16:13:02 INFO  Performing one-time migration for 20210330 
05/07/25-16:13:02 WARN  Error when loading plugins/statistics.koplugin/main.lua: frontend/ui/widget/filechooser.lua:6: module 'apps/filemanager/filemanagershortcuts' not found:
	no field package.preload['apps/filemanager/filemanagershortcuts']
	no file 'plugins/statistics.koplugin/apps/filemanager/filemanagershortcuts.lua'
	no file 'common/apps/filemanager/filemanagershortcuts.lua'
	no file 'frontend/apps/filemanager/filemanagershortcuts.lua'
	no file 'plugins/exporter.koplugin/apps/filemanager/filemanagershortcuts.lua'
	no file './apps/filemanager/filemanagershortcuts.lua'
	no file '/usr/local/share/luajit-2.1/apps/filemanager/filemanagershortcuts.lua'
	no file '/usr/local/share/lua/5.1/apps/filemanager/filemanagershortcuts.lua'
	no file '/usr/local/share/lua/5.1/apps/filemanager/filemanagershortcuts/init.lua'
	no file 'common/apps/filemanager/filemanagershortcuts.so'
	no file 'common/apps/filemanager/filemanagershortcuts.dll'
	no file '/usr/lib/lua/apps/filemanager/filemanagershortcuts.so'
	no file './apps/filemanager/filemanagershortcuts.so'
	no file '/usr/local/lib/lua/5.1/apps/filemanager/filemanagershortcuts.so'
	no file '/usr/local/lib/lua/5.1/loadall.so'

[DNSB]

Originally Posted by theshtank

I just got a Kobo Libra 2 and ran the script on my Mac. Followed the steps pretty precisely. Koreader is doing the bomb crash and rebooting every time I try to open it.

The only difference in the install process is that gatekeeper didn't try to block me from running the script.

The crashlog is super long but the one part I'm able to see as a potential culprit is here.

Wondering what to do to fix this.

05/07/25-16:13:01 INFO  ./cache/fontlist/fontinfo.dat fopen: No such file or directory -> initializing it 
05/07/25-16:13:02 WARN  Error when loading plugins/statistics.koplugin/main.lua: frontend/ui/widget/filechooser.lua:6: module 'apps/filemanager/filemanagershortcuts' not found:
	no field package.preload['apps/filemanager/filemanagershortcuts']
	no file 'plugins/statistics.koplugin/apps/filemanager/filemanagershortcuts.lua'
	no file 'common/apps/filemanager/filemanagershortcuts.lua'
	no file 'frontend/apps/filemanager/filemanagershortcuts.lua'
	no file 'plugins/exporter.koplugin/apps/filemanager/filemanagershortcuts.lua'
	no file './apps/filemanager/filemanagershortcuts.lua'
	no file '/usr/local/share/luajit-2.1/apps/filemanager/filemanagershortcuts.lua'
	no file '/usr/local/share/lua/5.1/apps/filemanager/filemanagershortcuts.lua'
	no file '/usr/local/share/lua/5.1/apps/filemanager/filemanagershortcuts/init.lua'
	no file 'common/apps/filemanager/filemanagershortcuts.so'
	no file 'common/apps/filemanager/filemanagershortcuts.dll'
	no file '/usr/lib/lua/apps/filemanager/filemanagershortcuts.so'
	no file './apps/filemanager/filemanagershortcuts.so'
	no file '/usr/local/lib/lua/5.1/apps/filemanager/filemanagershortcuts.so'
	no file '/usr/local/lib/lua/5.1/loadall.so'

So you downloaded the OCP-KOReader-v2025.04.zip from the first message and the kfm_mac_install.zip file from the second message. You placed the OCP-KOReader-v2025.04.zip file (do not unzip it) in a folder on your Mac and then unzipped the kfm_mac_install.zip file in the same directory? You connected your Kobo ereader and made sure that it was mounted. Then you ran install.command, told it to use file 0 and it went through the install?

Are you running KOReader by tapping on the KFMon icon or from a NickelMenu option?

If you look in the .adds/koreader folder on your Kobo, are the files actually installed in there? Basically, a lot of the file paths are not what I would expect to see in a KOReader package installed in the .adds folder. For instance, the filemanagershortcuts.lua file should be found in .adds/koreader\frontend/apps/filemanager/. Other files are not in the location that your log file shows or just do not exist ( filemanagershortcuts.dll for instance) nor do I see a usr directory on my KLC.

[theshtank]

Originally Posted by DNSB

You placed the OCP-KOReader-v2025.04.zip file (do not unzip it) in a folder on your Mac and then unzipped the kfm_mac_install.zip file in the same directory? You connected your Kobo ereader and made sure that it was mounted. Then you ran install.command, told it to use file 0 and it went through the install?

I placed both Zip files in the root of the Kobo, as mentioned here:

Directly extract the ZIP archive you've just downloaded to the root directory of your device (i.e., not under any subdirectory). (That's the "one click" bit ;p)

Originally Posted by DNSB

Are you running KOReader by tapping on the KFMon icon or from a NickelMenu option?

I have tried both. The KFMon book (is that what you mean by icon?) brings up a log and nothing else. The NickelMenu option causes a crash. The Koreader book causes a crash. Plato works.

Originally Posted by DNSB

If you look in the .adds/koreader folder on your Kobo, are the files actually installed in there? Basically, a lot of the file paths are not what I would expect to see in a KOReader package installed in the .adds folder. For instance, the filemanagershortcuts.lua file should be found in .adds/koreader\frontend/apps/filemanager/. Other files are not in the location that your log file shows or just do not exist ( filemanagershortcuts.dll for instance) nor do I see a usr directory on my KLC.

There is no usr directory on my Kobo.
There is a kfmon, koreader, nm and plato directory in .adds.

Many files and directories exist in koreader, but some seem to be missing. I cannot find any files which are listed as missing in the error log. .adds/koreader\frontend/apps/filemanager/ exists but I cannot find filemanagershortcuts.lua, tho there are many other files named filemanager.lua or filemanagerbookinfo.lua etc.

I do not see any .dll files in my Kobo.

[alaskazimm]

It looks like you are combining the instructions in the first post with the instructions in the second. You should be extracting the zip file to the root of your Kobo, and not drag and drop or copy which it seems you did as the file paths don't seem correct.

NOTE: Prefer the "Extract To" approach (and allow replacing existing content if it's asked of you) vs. manually copy/pasting or drag'n dropping bits of the ZIP content yourself, as preserving the integrity of the directory structure and its contents is of paramount importance!

If you try this way again, don't forget to modify the config file.

NOTE: Another thing that bears repeating is that on FW >= 4.17, you'll probably also want to prevent Nickel from scanning *nix hidden folders. And you'll want to tweak your config before unplugging your device (i.e., before installing this; or, if you've just upgraded your FW, during the first USB connection after the update). In order to alleviate potential interaction from USBMS gremlins, I would *also* recommend that you do all this right after a clean, full reboot of your device.

[DNSB]

Originally Posted by theshtank

I placed both Zip files in the root of the Kobo, as mentioned here:

That mention in the first message is the manual procedure using only the .zip file from the first message when you are not using the script to do the install, will need to manually modify the Kobo eReader.conf file, etc.

In the second message where you find the scripts, READ the MacOS section:

1. Check the previous message, and download the ZIP package that you're interested in, remembering the macOS/Safari quirks I mentioned above.
2. Download the macOS install script archive, and unzip it in the same folder.

Originally Posted by theshtank

I have tried both. The KFMon book (is that what you mean by icon?) brings up a log and nothing else. The NickelMenu option causes a crash. The Koreader book causes a crash. Plato works.



There is no usr directory on my Kobo.
There is a kfmon, koreader, nm and plato directory in .adds.

Many files and directories exist in koreader, but some seem to be missing. I cannot find any files which are listed as missing in the error log. .adds/koreader\frontend/apps/filemanager/ exists but I cannot find filemanagershortcuts.lua, tho there are many other files named filemanager.lua or filemanagerbookinfo.lua etc.

I do not see any .dll files in my Kobo.

filemanagershortcuts.lua is found in .adds/koreader/frontend/apps/filemanager/

I would suggest doing what the script method suggests. First delete the koreader directory from your Kobo. Place the zipped OCP install file and the install.command from the unzipped Mac script file into a directory on your Mac. Run the script file.

[theshtank]

Originally Posted by DNSB

I would suggest doing what the script method suggests. First delete the koreader directory from your Kobo. Place the zipped OCP install file and the install.command from the unzipped Mac script file into a directory on your Mac. Run the script file.

This worked, thank you. Now I just need to figure out how to organize my books in Koreader/ Calibre. And maybe see if there's anything I can clean up now.

[robmlr]

Sorry to be pedantic, but the first post says "these packages bundle KFMon & NickelMenu".

What happened to NickelMenu?

It doesn't seem to be in the list of packages in the first post, and is not in either of the two zip files I downloaded. Did it get absorbed into one of the other packages, or do I need to download it as well from somewhere else?

[DNSB]

Since those package for KOReader, Plato and the combined install do install NickelMenu, what did you expect to see?

If you look in the .zip file, inside the .kobo folder, you will see a file called KoboRoot.tgz which is the installer for NickelMenu and KFMon. If you look into the .adds folder, you will see a directory called nm which is where NickelMenu will store it's configuration files which has the options for koreader and/or plato preloaded.

Perhaps installing the package and seeing if NickelMenu was present after the install would have been the simpler choice?

[Benjamelon]

Just documenting this in-case anyone runs into this in future. For context, I recently updated my kobo libra 2 to the latest update from Kobo and updated kfmon + koreader + pluto via the packages and scripts in this thread (although, I think this would happen to anyone).

Everything went well, and the script returned a positive installation result, and when I booted the device, I had the expected kfmon loaded successfully message and nicklemenu was present. KOReader launched without ever; however, pluto failed to start whenever I selected it. Digging into the info log found under /.adds/plato/info.log, I found a few errors regarding parsing Settings.toml. See the following:

Error: can't build context

Caused by:
    0: can't load settings
    1: can't parse TOML content from Settings.toml
    2: TOML parse error at line 127, column 9
           |
       127 | color = 0
           |         ^
       wanted string or table

This error seems to be from a change in the way the sketch.pen settings are handled. The freshly generated Settings.toml has the following schema:

[sketch.pen]
size = 2
dynamic = true
amplitude = 4.0
min-speed = 0.0
max-speed = 3000.0

[sketch.pen.color]
gray = 0

The legacy Settings.toml has the following schema:

[sketch.pen]
size = 2
color = 0
dynamic = true
amplitude = 4.0
min-speed = 35.43307113647461
max-speed = 1800.0

Changing my legacy settings file to reflect the new schema allowed pluto to load properly. Deleting Settings.toml and allowing pluto to regenerate its settings will also work.

P.S. sorry if this is offtopic. I'm happy to move this to a more pluto specific thread if so.

[MartinNi]

Hi,

I signed up here just to show my appreciation for your work with the install packages, NiLuJe. I also did a small donation to KOReader over at GitHub. It is a fantastic piece of software and I use it daily for reading PDFs on my Kobo Elipsa. Thank you

[menneske]

Originally Posted by MartinNi

Hi,

I signed up here just to show my appreciation for your work with the install packages, NiLuJe. I also did a small donation to KOReader over at GitHub. It is a fantastic piece of software and I use it daily for reading PDFs on my Kobo Elipsa. Thank you

Thats great.
I checked for prices on the Kobo Elipsa (2E) and the prices varied 150€ as new?

Do you annotate the PDFs, you read - and export the notes?

best,
kk