How to execute a .lua script in KOReader?

[beecom]

I’m testing how to run .lua scripts in KOReader. (installed on Paperwhite11)

I created a test file using:
echo 'local _ = require("logger").info("TEST OK"); os.exit()' > /mnt/us/koreader/scripts/test.lua

The file test.lua exists in /mnt/us/koreader/scripts/, but I can’t find any ‘Scripts’ menu in KOReader to execute it. How can I run this script?"

[pazos]

KOReader is in itself a big lua script.

It provides a way to execute your own on demand if you write a plugin.

It also provides hooks that get called automatically and are useful to write your own user patches.

Both patches and plugins are executed on the same vm as ko does, so issuing os.exit it isn't going to exit your script but the whole program.

[beecom]

Originally Posted by pazos

KOReader is in itself a big lua script.

It provides a way to execute your own on demand if you write a plugin.

It also provides hooks that get called automatically and are useful to write your own user patches.

Both patches and plugins are executed on the same vm as ko does, so issuing os.exit it isn't going to exit your script but the whole program.

Thanks for your reply.
I was wondering if there's a way to add a script (which is not directly related to KOReader) into KOReader's menu so that I can see and run it from there.

What I'm trying to do is have a script stored on the Kindle that detects when the file /tmp/pc.png is updated (which is periodically refreshed from my PC), and then re-renders the screen using that updated image. I'd like to be able to trigger this script from within KOReader.

[jonnyl]

KOReader ships with the hello.koplugin test-plugin in the plugins/ folder. You can use that as a template to make your own. Remove the first clode block in main.lua to activate it (you may then also need to check the box to activate it in the plugin-settings) and see how it works.

To create your own, copy the hello.koplugin folder to plugins/myscript.koplugin (or whatever), and rename the script's name and menu entry in the code. Of course also add your own code to execute on pressing the new menu entry.

[beecom]

Originally Posted by jonnyl

KOReader ships with the hello.koplugin test-plugin in the plugins/ folder. You can use that as a template to make your own. Remove the first clode block in main.lua to activate it (you may then also need to check the box to activate it in the plugin-settings) and see how it works.

To create your own, copy the hello.koplugin folder to plugins/myscript.koplugin (or whatever), and rename the script's name and menu entry in the code. Of course also add your own code to execute on pressing the new menu entry.

I think I’ve figured out how to run my code in KOReader. Thank you for your help, jonnyl.
I managed to get hello.koplugin to show up in the menu list, but I couldn't get my code to appear on the list despite trying several times.