From 007bb0068270687b65eebfd8b49958b3f0abff3d Mon Sep 17 00:00:00 2001 From: zwim <36999612+zwim@users.noreply.github.com> Date: Sun, 16 Oct 2022 20:53:50 +0200 Subject: [PATCH] Created User patches (markdown) --- User-patches.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 User-patches.md diff --git a/User-patches.md b/User-patches.md new file mode 100644 index 0000000..c0922dc --- /dev/null +++ b/User-patches.md @@ -0,0 +1,29 @@ +# Overview +It is possible to add or change some provided features in KOReader by user patches. + +For implementing or applying such patches only limited support _might_ be given by the KOReader developers. + +# Installation +It is necessary to create a subfolder named `patches` in the `koreader` folder. (On Android this folder is located on the SD-card.) + +The patch can than be put into a file in `koreader\patches`. + +The name of a patch has to start witch a number followed by a minus (`1234-name-of-the-patch.lua`). + +The execution time of a patch is determined by the first digit of the number in the patch name. If there are several patches starting with the same digit, the execution order is the natural order (`1`<`10`<`11`<`12`<`13`<...<`109`<...<`10010`). + +Names starting with: +* `0` are executed very early and only once after an update, +* `1` are executed very early on every start of KOReader (but after `0` if applicable), +* `2` are executed after UIManager is ready on every start of KOReader, +* `3-7` reserved +* `8` are executed before exit and before settings get saved, +* `9` are executed right before exit. + +# [Available patches](https://github.com/koreader/koreader/issues?q=+label%3A%22User+patch+available%22+) + +The following list will show available patches in historical order with its `name`, `function` and `comments` + +* + +