Skip to content

clarify that plugin folder name must match plugin class name #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
supahgreg merged 1 commit into from
Sep 14, 2026
Merged

clarify that plugin folder name must match plugin class name #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/Plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,10 @@ If you are interested in making plugins, see [Making-Plugins](Making-Plugins),
{: .note }
> First party plugins can be added via built-in plugin installer in `Preferences` → `Plugins`.

Copy plugin folder to ```tt-rss/plugins.local``` then activate it in the settings panel.
Plugin folder name should correspond to plugin class name defined in ``(plugin)/init.php``,
i.e. ``Af_ExamplePlugin`` should be copied to ``plugins.local/af_exampleplugin``.
Copy the plugin folder to ```tt-rss/plugins.local``` then activate it in the settings panel.
The plugin folder name must correspond to the plugin class name defined in ``(plugin)/init.php``, lowercased,
i.e. ``Af_ExamplePlugin`` must be copied to ``plugins.local/af_exampleplugin``,
otherwise the plugin is not detected.

## First party plugins (maintained as part of the project but not bundled with tt-rss)

Expand Down