diff --git a/bin/readme.txt b/bin/readme.txt new file mode 100644 index 0000000..c5c7715 --- /dev/null +++ b/bin/readme.txt @@ -0,0 +1,5 @@ +This is where kobopatch.sh looks for the kobopatch binary and the patcher itself looks for the firmware zip. merge-kfmon.sh also looks for KFmon.tgz (the KoboRoot.tgz for Kute File Monitor, renamed). Download links for these are below. + +Kobopatch: https://github.com/pgaskin/kobopatch/releases +Kobo firmware: https://pgaskin.net/KoboStuff/kobofirmware.html +KFMon: https://www.mobileread.com/forums/showthread.php?t=274231 diff --git a/merge-kfmon.sh b/merge-kfmon.sh index d3079e9..052c780 100755 --- a/merge-kfmon.sh +++ b/merge-kfmon.sh @@ -1,4 +1,4 @@ -# taken from NiLuJe's autopatch.sh: http://trac.ak-team.com/trac/browser/niluje/Configs/trunk/Kindle/Kobo_Hacks/Patches/autopatch.sh +# modified from NiLuJe's autopatch.sh: http://trac.ak-team.com/trac/browser/niluje/Configs/trunk/Kindle/Kobo_Hacks/Patches/autopatch.sh echo "Uncompressing tarballs" gunzip -c bin/KFmon.tgz > KFMon.tar diff --git a/other-conf/kfmon/kfmon-log.ini b/other-conf/kfmon/kfmon-log.ini new file mode 100644 index 0000000..d5f8f87 --- /dev/null +++ b/other-conf/kfmon/kfmon-log.ini @@ -0,0 +1,16 @@ +; KFMon Log +[watch] +; Those next two keys are MANDATORY +filename = /mnt/onboard/kfmon.png ; Absolute path of the icon to watch for +action = /mnt/onboard/.adds/kfmon/bin/kfmon-printlog.sh ; Absolute path of the command to launch when the icon is opened +; The following keys are NOT mandatory +label = Show KFMon log ; Label available for use by a GUI frontend +hidden = 1 ; Whether to hide this entry from a GUI frontend +block_spawns = 0 ; Prevents *any* script from being launched via KFMon while the command launched by this watch is still running. + ; This is useful for document readers, because they could otherwise trigger unwanted + ; behavior through their file manager, metadata reader, or thumbnailer. +do_db_update = 0 ; Do we want to update Nickel's DB for this icon? (Potentially unsafe, disabled by default) +; If you enabled do_db_update, the next three keys NEED to be set +db_title = KFMon Log ; Title to use for the icon's Library entry if do_db_update = 1 +db_author = NiLuJe ; Author to use for the icon's Library entry if do_db_update = 1 +db_comment = Print the last few lines of KFMon's log ; Comment to use for the icon's Library entry if do_db_update = 1 diff --git a/other-conf/kfmon/kfmon.ini b/other-conf/kfmon/kfmon.ini new file mode 100644 index 0000000..f436235 --- /dev/null +++ b/other-conf/kfmon/kfmon.ini @@ -0,0 +1,9 @@ +; This is KFMon's main config. +; It holds basic information concerning the behavior of the daemon itself. +[daemon] +db_timeout = 500 ; Maximum amount of time to wait (in ms) before deeming that the Nickel DB is really busy. + ; Amount is automatically doubled on CLOSE events. + ; Increase this value if your Nickel DB is large, and you trip too many "busy" false-positives on OPEN. + ; Good news: you shouldn't have to worry too much about this on FW >= 4.6 ;). +use_syslog = 0 ; Log to syslog instead of a file? Might be useful to save a few flash writes... +with_notifications = 1 ; Show on screen notifications for informational messages (i.e., successful startup of an action) diff --git a/other-conf/kfmon/koreader.ini b/other-conf/kfmon/koreader.ini new file mode 100644 index 0000000..7a0f118 --- /dev/null +++ b/other-conf/kfmon/koreader.ini @@ -0,0 +1,25 @@ +; This is a working example of a full config file to setup a new watch. +; You can only define a *single* watch per ini file, and the section name *needs* to be "watch". +[watch] +; Those next two keys are MANDATORY +filename = /mnt/onboard/koreader.png ; Absolute path of the icon to watch for +action = /mnt/onboard/.adds/koreader/koreader.sh ; Absolute path of the command to launch when the icon is opened +; The following keys are NOT mandatory +label = KOReader ; Label available for use by a GUI frontend +hidden = 0 ; Whether to hide this entry from a GUI frontend +block_spawns = 1 ; Prevents *any* script from being launched via KFMon while the command launched by this watch is still running. + ; This is useful for document readers, because they could otherwise trigger unwanted + ; behavior through their file manager, metadata reader, or thumbnailer. +do_db_update = 0 ; Do we want to update Nickel's DB for this icon? (Potentially unsafe, disabled by default) +; If you enabled do_db_update, the next three keys NEED to be set +db_title = KOReader ; Title to use for the icon's Library entry if do_db_update = 1 +db_author = KOReader Devs ; Author to use for the icon's Library entry if do_db_update = 1 +db_comment = An eBook reader application ; Comment to use for the icon's Library entry if do_db_update = 1 + + +; This is not part of the actual KFMon config, it's just a sentinel value used by the KOReader startup script. +; If you encounter weird Nickel behavior after exiting KOReader, set this to true +; On some HW/FW combos, this may translate into wonky power management. +; For instance, and somewhat more severely, on my H2O, the IR grid touchscreen will often never wakeup after a suspend. +; I've also seen broken USBMS behavior on some newer FW versions, so, that's fun, too... +;reboot_on_exit=false diff --git a/other-conf/kfmon/plato.ini b/other-conf/kfmon/plato.ini new file mode 100644 index 0000000..38fca29 --- /dev/null +++ b/other-conf/kfmon/plato.ini @@ -0,0 +1,18 @@ +; Plato (https://www.mobileread.com/forums/showthread.php?t=292914) +; Relies on upstream's fmon scripts (i.e., plato-launcher-fmon-x.y.z.zip) +; This means you can follow upstream's installation instructions to the letter, and expect things to work just fine ;). +[watch] +; Those next two keys are MANDATORY +filename = /mnt/onboard/icons/plato.png ; Absolute path of the icon to watch for +action = /mnt/onboard/.adds/plato/plato.sh ; Absolute path of the command to launch when the icon is opened +; The following keys are NOT mandatory +label = Plato ; Label available for use by a GUI frontend +hidden = 0 ; Whether to hide this entry from a GUI frontend +block_spawns = 1 ; Prevents *any* script from being launched via KFMon while the command launched by this watch is still running. + ; This is useful for document readers, because they could otherwise trigger unwanted + ; behavior through their file manager, metadata reader, or thumbnailer. +do_db_update = 0 ; Do we want to update Nickel's DB for this icon? (Potentially unsafe, disabled by default) +; If you enabled do_db_update, the next three keys NEED to be set +db_title = Plato ; Title to use for the icon's Library entry if do_db_update = 1 +db_author = Baskerville ; Author to use for the icon's Library entry if do_db_update = 1 +db_comment = A document reader ; Comment to use for the icon's Library entry if do_db_update = 1 diff --git a/other-conf/kfmon/vlasovsoft.ini b/other-conf/kfmon/vlasovsoft.ini new file mode 100644 index 0000000..f11c60f --- /dev/null +++ b/other-conf/kfmon/vlasovsoft.ini @@ -0,0 +1,9 @@ +[watch] +; Those next two keys are MANDATORY +filename = /mnt/onboard/vlasovsoft.png +action = /mnt/onboard/.adds/vlasovsoft/launcher.sh +; The following keys are NOT mandatory +label = Vlasovsoft Suite +block_spawns = 1 +do_db_update = 0 + diff --git a/other-conf/nickelmenu/doc b/other-conf/nickelmenu/doc new file mode 100644 index 0000000..675c33c --- /dev/null +++ b/other-conf/nickelmenu/doc @@ -0,0 +1,206 @@ +# NickelMenu (libnm.so) +# +# This tool injects menu items into Nickel. +# +# It should work on firmware 4.6+, but it has only been tested on 4.20.14622 - +# 4.22.15268. It is perfectly safe to try out on any newer firmware version, as +# it has a lot of error checking, and a failsafe mechanism which automatically +# uninstalls it as a last resort. +# +# Place your configuration files in this folder. They can be named anything, and +# should consist of multiple lines either starting with # for a comment, or in +# one of the the following formats (spaces around fields are ignored): +# +# menu_item::