GitHub
/
pbot
mirror of https://github.com/pragma-/pbot.git
3
0
Fork 0
Code Issues Projects Releases Wiki Activity

Document ~/.pbot/PBot/Plugin for third-party plugins

This commit is contained in:
Pragmatic Software 2021-07-14 19:57:55 -07:00
parent 28f04acd04
commit 7610f5f8ec
2 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/Plugins.md
View File

@ -10,9 +10,14 @@
A Plugin is an independent unit of PBot code that can be loaded and unloaded at will.
Plugins have full access to PBot internal APIs and state.
These are the Plugins that come with PBot. Click a Plugin to learn more about it.
The default plugins loaded by PBot is set by the [`plugin_autoload`](../data/plugin_autoload)
file in your data-directory. To autoload additional plugins, add their name to this file.
Note that this list is probably incomplete. For the complete list of Plugins, see [the Plugins directory.](../lib/PBot/Plugin)
The plugins that come with PBot live in [`lib/PBot/Plugin/`](../lib/PBot/Plugin). Additional third-party
plugins may be installed to `~/.pbot/PBot/Plugin/`.
This is the woefully incomplete documentation for the plugins. For more documentation,
browse the headers of the various plugin source files.
## [Plang](Plugins/Plang.md)
Scripting interface to PBot.

3
doc/QuickStart.md
View File

@ -440,6 +440,9 @@ Plugins provide optional PBot features. The default plugins loaded by PBot is se
the [`plugin_autoload`](../data/plugin_autoload) file in your data-directory. To autoload additional plugins,
add their name to this file.
The plugins that come with PBot live in [`lib/PBot/Plugin/`](../lib/PBot/Plugin). Additional third-party
plugins may be installed to `~/.pbot/PBot/Plugin/`.
You may manually load plugins using the `plug` command.
plug <plugin>