summaryrefslogtreecommitdiff
path: root/MakingPlugins.md
blob: 0e39a41d8899df2b7893e91ad783bac09d206f62 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Making plugins
==============

Sorry, plugin API documentation is not written yet. You can use example
plugins bundled with tt-rss and other finished plugins as a starting
point. Ask on the forums if you need help with anything specific.

Plugins may render new preference panes or embed themselves into several
existing one, store data using simple key -\> value data or directly in
the database, modify how articles are rendered, alter feed data, and
many more things.

List of hooks you can use is available in <code>classes/pluginhost.php</code>.
Some javascript hooks are also available.

Example plugins are available in the [attic](https://git.tt-rss.org/git/tt-rss-attic) and
[samples](https://git.tt-rss.org/git/tt-rss-samples) repositores.