GitHub/pbot
3
0
Fork 0
mirror of https://github.com/pragma-/pbot.git synced 2025-02-04 08:24:06 +01:00
Code Issues Projects Releases Wiki Activity

README.md: improvements

Browse Source
This commit is contained in:
Pragmatic Software 2020-02-17 14:46:09 -08:00
parent 2d3d31f9f3
commit 37c0bb677c
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -8,7 +8,7 @@ PBot is a versatile IRC Bot written in Perl
* [Channel management](#channel-management) * [Channel management](#channel-management)
* [User management](#user-management) * [User management](#user-management)
* [Easy configuration](#easy-configuration) * [Easy configuration](#easy-configuration)
* [Extensible](#extensible) * [Reload core modules without disconnecting](#reload-core-modules-without-disconnecting)
* [Powerful command interpreter](#powerful-command-interpreter) * [Powerful command interpreter](#powerful-command-interpreter)
* [Piping](#piping) * [Piping](#piping)
* [Substitution](#substitution) * [Substitution](#substitution)
@ -16,6 +16,7 @@ PBot is a versatile IRC Bot written in Perl
* [Variables](#variables) * [Variables](#variables)
* [Inline invocation](#inline-invocation) * [Inline invocation](#inline-invocation)
* [Background processing](#background-processing) * [Background processing](#background-processing)
* [Extensible](#extensible)
* [Factoids](#factoids) * [Factoids](#factoids)
* [Code Factoids](#code-factoids) * [Code Factoids](#code-factoids)
* [Plugins](#plugins) * [Plugins](#plugins)
@ -77,9 +78,14 @@ These settings can easily be configured via several methods:
For more information, see the [Registry documentation.](doc/Registry.md) For more information, see the [Registry documentation.](doc/Registry.md)
### Extensible ### Reload core modules without disconnecting
PBot is extensible in multiple ways. Additional commands and functionality can be added to PBot through Suppose you edit some PBot source file, be it a core file such as PBot/Factoids.pm or
[Factoids](#factoids), [Plugins](#plugins), [Modules](#modules) and [Functions](#functions). a Plugin such as Plugins/Wttr.pm. Or suppose there's a PBot update available.
Most simple bots would require you to shut down the bot and restart it in order
to see the modifications. Not PBot! Rather than shut PBot down and restart it, you
can simply use the [`refresh`](doc/Admin.md#refresh) command to reload all modified PBot
core files and Plugins.
### Powerful command interpreter ### Powerful command interpreter
PBot has an powerful command interpreter with useful functionality, and tons of PBot has an powerful command interpreter with useful functionality, and tons of
@ -157,6 +163,10 @@ The familiar [`ps`](doc/Admin.md#ps) and [`kill`](doc/Admin.md#kill) commands ca
You can also [`cmdset`](doc/Admin.md#cmdset) the `process-timeout` [command metadata](doc/Admin.md#command-metadata-list) to set the timeout, in seconds, before the command is automatically killed. Otherwise the `processmanager.default_timeout` [registry value](doc/Registry.md) will be used. You can also [`cmdset`](doc/Admin.md#cmdset) the `process-timeout` [command metadata](doc/Admin.md#command-metadata-list) to set the timeout, in seconds, before the command is automatically killed. Otherwise the `processmanager.default_timeout` [registry value](doc/Registry.md) will be used.
### Extensible
PBot is extensible in multiple ways. Additional commands and functionality can be added to PBot through
[Factoids](#factoids), [Plugins](#plugins), [Modules](#modules) and [Functions](#functions).
### Factoids ### Factoids
Factoids are a very special type of command. Anybody interacting with PBot Factoids are a very special type of command. Anybody interacting with PBot
can create, edit, delete and invoke factoids. Factoids can be locked by the can create, edit, delete and invoke factoids. Factoids can be locked by the