caldav client development! (need help am lua noob)

n00dlephr0g · 05-04-2025, 10:49 AM

hey guys I'm pretty new to the KOReader community (around 2 weeks)

))
my motivation behind writing this plugin is digital minimalism and my honestly abysmal organisational skills :P
I've done a little bit of research into the CalDAV protocol, iCalendar protocol and KOReader plugin development to get myself started on writing the plugin. And I will not lie, the KOReader documentations for developers SUCK!
Anyways I've got the main menu stuff sorted and i plan on writing the entire UI before moving to developing the backend. I'm currently stuck on getting a widget to pop up on screen from the main menu (tho i think there are other ways to do this...).
But here is a link to the repository and if anyone would like to have a look and give some targeted feedback, or even just drop some gems in this thread that would be amazing, thanks!!

Gregariously;
Joseph

pazos · 05-04-2025, 02:07 PM

I'm not sure if I follow. Reading your post it seems you managed to write a plugin but looking at the repo you linked the plugin lacks the entry point and the logic you want to include.

It is just an "ical" module you picked somewhere.

If you want to write a plugin I would suggest you to look at plugin examples: https://github.com/koreader/koreader...master/plugins

The "developer docs" you mention are not there as an alternative to read & understand chunks of lua code.

There's no API for plugins. Plugins can do whatever you want, there's no isolation between plugins and "core". Everything shares a state.

I would suggest to start reading "hello.koplugin" and shift focus to other non-trivial plugins as you manage to understand and implement the chunks of code there that are required for your plugin to "show on the UI" and "do something"

n00dlephr0g · 05-05-2025, 03:40 AM

hey thanks so much for replying, i got so tired that i forgot to actually push to the repo, ive since pushed to the repo.
which plugin would you say is feature rich in terms of widget usage? i dont seem to come by UIManager.show() a lot

pazos · 05-05-2025, 07:37 PM

Quote:

Originally Posted by n00dlephr0g

hey thanks so much for replying, i got so tired that i forgot to actually push to the repo, ive since pushed to the repo.

ok, now makes sense

Quote:

Originally Posted by n00dlephr0g

which plugin would you say is feature rich in terms of widget usage? i dont seem to come by UIManager.show() a lot

Upstream code uses core widgets in https://github.com/koreader/koreader...tend/ui/widget

Third party plugins can use core widgets as well and/or bundle their own widget stack built on top of core

See an example of a complex plugin that does quite a bit of UI work: https://github.com/Billiam/hardcoverapp.koplugin

The best way to develop is always an emulator.
There's a tool `tools/wbuilder.lua` that spawns a window and lets you preview quickly the widgets you declared in there. You can use it as a playground for testing available widgets and building your own.

n00dlephr0g · 05-06-2025, 01:18 AM

hmmm i cant seem to get the kodev library working. is this tools/wbuilder.lua you speak of essentially the native way to do that?

i havent really figured out how koreader interacts with the underlying system so i havent bothered with that.

the way ive been doing it is using the filebrowser plugin to upload the plugins directly to my kindle and restarting koreader everytime to test...

thanks for the reply and support, i plan to work more on it this afternoon, wish me luck!

05-04-2025, 10:49 AM	#1
n00dlephr0g Junior Member Posts: 3 Karma: 10 Join Date: May 2025 Device: kindle paperwhite gen 6	caldav client development! (need help am lua noob) hey guys I'm pretty new to the KOReader community (around 2 weeks) )) my motivation behind writing this plugin is digital minimalism and my honestly abysmal organisational skills :P I've done a little bit of research into the CalDAV protocol, iCalendar protocol and KOReader plugin development to get myself started on writing the plugin. And I will not lie, the KOReader documentations for developers SUCK! Anyways I've got the main menu stuff sorted and i plan on writing the entire UI before moving to developing the backend. I'm currently stuck on getting a widget to pop up on screen from the main menu (tho i think there are other ways to do this...). But here is a link to the repository and if anyone would like to have a look and give some targeted feedback, or even just drop some gems in this thread that would be amazing, thanks!! Gregariously; Joseph

05-05-2025, 03:40 AM	#3
n00dlephr0g Junior Member Posts: 3 Karma: 10 Join Date: May 2025 Device: kindle paperwhite gen 6	whoops :P hey thanks so much for replying, i got so tired that i forgot to actually push to the repo, ive since pushed to the repo. which plugin would you say is feature rich in terms of widget usage? i dont seem to come by UIManager.show() a lot

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
input.lua permanent changes	cherusker	KOReader	6	03-24-2023 04:29 PM
#kindle-dev THE IRC channel for Kindle development. JOIN US. (IRC ≈ CHAT CLIENT)	twobob	Kindle Developer's Corner	56	01-17-2022 05:11 PM
Update on Development! Reason for Slow Development	PMrev	Calibre Companion	18	03-25-2020 01:17 PM
Dropbox client, Seafile client	trap000d	Kindle Developer's Corner	32	04-16-2017 09:35 AM
iLiad Lua: scripting for Iliad	hansel	iRex Developer's Corner	3	12-14-2008 06:51 PM

05-04-2025, 02:07 PM	#2
pazos cosiñeiro Posts: 1,406 Karma: 2451781 Join Date: Apr 2014 Device: BQ Cervantes 4	I'm not sure if I follow. Reading your post it seems you managed to write a plugin but looking at the repo you linked the plugin lacks the entry point and the logic you want to include. It is just an "ical" module you picked somewhere. If you want to write a plugin I would suggest you to look at plugin examples: https://github.com/koreader/koreader...master/plugins The "developer docs" you mention are not there as an alternative to read & understand chunks of lua code. There's no API for plugins. Plugins can do whatever you want, there's no isolation between plugins and "core". Everything shares a state. I would suggest to start reading "hello.koplugin" and shift focus to other non-trivial plugins as you manage to understand and implement the chunks of code there that are required for your plugin to "show on the UI" and "do something"

05-06-2025, 01:18 AM	#5
n00dlephr0g Junior Member Posts: 3 Karma: 10 Join Date: May 2025 Device: kindle paperwhite gen 6	hmmm i cant seem to get the kodev library working. is this tools/wbuilder.lua you speak of essentially the native way to do that? i havent really figured out how koreader interacts with the underlying system so i havent bothered with that. the way ive been doing it is using the filebrowser plugin to upload the plugins directly to my kindle and restarting koreader everytime to test... thanks for the reply and support, i plan to work more on it this afternoon, wish me luck!

Advert

Advert