1
1
mirror of https://github.com/profanity-im/profanity.git synced 2025-01-03 14:57:42 -05:00

Add more help about how to use plugins

`/plugins install` installs a plugin to
`.local/share/profanity/plugins`.
And also loads it.
When a plugin is loaded it will automatically be added to the `profrc`
file like this:

```
[plugins]
load=my.py;
```

On the next start Profanity will try to load this plugin again unless
`/plugin unload my.py` is called.
This commit is contained in:
Michael Vetter 2021-09-29 17:25:18 +02:00
parent b0e0012c22
commit 3120636367
2 changed files with 4 additions and 4 deletions

View File

@ -2157,10 +2157,10 @@ static struct cmd_t command_defs[] = {
CMD_DESC(
"Manage plugins. Passing no arguments lists currently loaded plugins and global plugins which are available for local installation. Global directory for Python plugins is " GLOBAL_PYTHON_PLUGINS_PATH " and for C Plugins is " GLOBAL_C_PLUGINS_PATH ".")
CMD_ARGS(
{ "install [<path>]", "Install a plugin, or all plugins found in a directory (recursive)." },
{ "install [<path>]", "Install a plugin, or all plugins found in a directory (recursive). And loads it/them." },
{ "uninstall [<plugin>]", "Uninstall a plugin." },
{ "update [<path>]", "Updates an installed plugin" },
{ "load [<plugin>]", "Load a plugin that already exists in the plugin directory, passing no argument loads all found plugins." },
{ "load [<plugin>]", "Load a plugin that already exists in the plugin directory, passing no argument loads all found plugins. It will be loaded upon next start too unless unloaded." },
{ "unload [<plugin>]", "Unload a loaded plugin, passing no argument will unload all plugins." },
{ "reload [<plugin>]", "Reload a plugin, passing no argument will reload all plugins." },
{ "python_version", "Show the Python interpreter version." })

View File

@ -6965,7 +6965,7 @@ cmd_plugins_install(ProfWin* window, const char* const command, gchar** args)
gchar* plugin_name = g_path_get_basename(path);
gboolean result = plugins_install(plugin_name, path, error_message);
if (result) {
cons_show("Plugin installed: %s", plugin_name);
cons_show("Plugin installed and loaded: %s", plugin_name);
} else {
cons_show("Failed to install plugin: %s. %s", plugin_name, error_message->str);
}
@ -6978,7 +6978,7 @@ cmd_plugins_install(ProfWin* window, const char* const command, gchar** args)
if (result->installed || result->failed) {
if (result->installed) {
cons_show("");
cons_show("Installed plugins:");
cons_show("Installed and loaded plugins:");
GSList* curr = result->installed;
while (curr) {
cons_show(" %s", curr->data);