mirror of https://github.com/koreader/koreader
Created User patches (markdown)
parent
7d2c07ade4
commit
007bb00682
@ -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`
|
||||
|
||||
*
|
||||
|
||||
|
Loading…
Reference in New Issue