Plugins for Viewer (to allow RSVP)

fructose · 10-29-2021, 11:58 PM

Is it possible to create plugins for the Viewer? I haven't found any such examples. If not, is that a capability I could help adding?

I'm interested in adding RSVP capability (a speed reading tool) to Calibre, similar to Stutter:
https://github.com/jamestomasino/stutter

I've seen some old posts about it, but not anywhere it's being worked on. If there's any such work underway, or any other relevant information, I'd appreciate knowing about it!

kovidgoyal · 10-30-2021, 02:02 AM

No, currently there is no viewer plugin capability. It's on my TODO list, however I havent got to it yet as its fairly painful, the viewer has independent processes that co-operate (it's essentially a browser) and different processes use different languages for their code, (rapydscript and python). So creating a plugin framework for it is not easy.

That said if you wish to help with such an endeavour, I can be persuaded to move it up my TODO list

fructose · 10-30-2021, 11:03 PM

Yes, I am interested in helping with that. Do you know of any small tasks in this direction, to help familiarize myself with things?

kovidgoyal · 10-30-2021, 11:11 PM

Well first start with setting up a calibre development environment https://manual.calibre-ebook.com/develop.html

Then understand the existing calibre plugin framework, maybe create a small plugin as feet wet exercise.

Then familiarise yourself with the viewer codebase (see in src/calibre/gui2/viewer and src/pyj/read_book). Then try to compe up with some set of integration points at which to call plugin code in the python part.

Then craeate a viewerplugin class in customize/__init__.py and some functions for loading and calling them in customize/ui.py and implement those integration points.

Once you get there we can talk about the best ways to enable loading of rapydscript in plugins and communication between the rapydscript and python parts of the plugin.

10-29-2021, 11:58 PM	#1
fructose Junior Member Posts: 2 Karma: 10 Join Date: Oct 2021 Device: PC	Plugins for Viewer (to allow RSVP) Is it possible to create plugins for the Viewer? I haven't found any such examples. If not, is that a capability I could help adding? I'm interested in adding RSVP capability (a speed reading tool) to Calibre, similar to Stutter: https://github.com/jamestomasino/stutter I've seen some old posts about it, but not anywhere it's being worked on. If there's any such work underway, or any other relevant information, I'd appreciate knowing about it!

Thread Tools	Search this Thread
Show Printable Version Email this Page	Search this Thread: Advanced Search

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
Systemwide installation of plugins / Discovery of installed plugins via pkg_resources	t-8ch	Development	8	11-14-2020 09:25 AM
[Kindle Touch] No Image viewer and pdf viewer with white margins	MaxPowerITA	Kindle Developer's Corner	7	04-24-2012 05:27 AM
[old-topic]ebook-viewer: Open source, crossplatform viewer for EPUB, LIT, MOBI, etc	kovidgoyal	Calibre	68	05-30-2011 08:46 PM
RSVP Ebook Reader for Nokia e63	laboheme	Alternative Devices	0	10-29-2010 03:03 AM
eReader 2.61 for Palm does not have RSVP feature	cvsmale	Reading and Management	0	04-26-2005 02:52 PM

10-30-2021, 02:02 AM	#2
kovidgoyal creator of calibre Posts: 45,208 Karma: 27110894 Join Date: Oct 2006 Location: Mumbai, India Device: Various	No, currently there is no viewer plugin capability. It's on my TODO list, however I havent got to it yet as its fairly painful, the viewer has independent processes that co-operate (it's essentially a browser) and different processes use different languages for their code, (rapydscript and python). So creating a plugin framework for it is not easy. That said if you wish to help with such an endeavour, I can be persuaded to move it up my TODO list

10-30-2021, 11:03 PM	#3
fructose Junior Member Posts: 2 Karma: 10 Join Date: Oct 2021 Device: PC	Yes, I am interested in helping with that. Do you know of any small tasks in this direction, to help familiarize myself with things?

10-30-2021, 11:11 PM	#4
kovidgoyal creator of calibre Posts: 45,208 Karma: 27110894 Join Date: Oct 2006 Location: Mumbai, India Device: Various	Well first start with setting up a calibre development environment https://manual.calibre-ebook.com/develop.html Then understand the existing calibre plugin framework, maybe create a small plugin as feet wet exercise. Then familiarise yourself with the viewer codebase (see in src/calibre/gui2/viewer and src/pyj/read_book). Then try to compe up with some set of integration points at which to call plugin code in the python part. Then craeate a viewerplugin class in customize/__init__.py and some functions for loading and calling them in customize/ui.py and implement those integration points. Once you get there we can talk about the best ways to enable loading of rapydscript in plugins and communication between the rapydscript and python parts of the plugin.

Advert