mirror of
https://github.com/pragma-/pbot.git
synced 2024-11-22 03:49:29 +01:00
Update README.md and docs
This commit is contained in:
Pragmatic Software
parent
8b92ba4731
commit
8b09dd17ac
26
README.md
26
README.md
@ -16,13 +16,13 @@ PBot is a pragmatic IRCv3 Bot written in Perl
|
||||
* [Output customization](#output-customization)
|
||||
* [Newlines in messages](#newlines-in-messages)
|
||||
* [Truncating long messages](#truncating-long-messages)
|
||||
* [Scripting interface](#scripting-interface)
|
||||
* [Extensible](#extensible)
|
||||
* [Factoids](#factoids)
|
||||
* [Code factoids](#code-factoids)
|
||||
* [Plugins](#plugins)
|
||||
* [Modules](#modules)
|
||||
* [Functions](#functions)
|
||||
* [Scripting interface](#scripting-interface)
|
||||
* [Virtual machine to safely execute user-submitted code](#virtual-machine-to-safely-execute-user-submitted-code)
|
||||
* [Powerful user management](#powerful-user-management)
|
||||
* [Useful IRC quality-of-life improvements](#useful-irc-quality-of-life-improvements)
|
||||
@ -154,13 +154,6 @@ When `preserve_newlines` is enabled, if there are more lines available than `max
|
||||
all of the lines will be pasted, with formatting preserved, to a web paste service. PBot will then
|
||||
output up to `max_newlines` lines as distinct messages and then output the URL to the paste.
|
||||
|
||||
### Scripting interface
|
||||
PBot uses [Plang](https://github.com/pragma-/Plang) as a scripting language. You can use the
|
||||
scripting language to construct advanced commands that are capable of interacting with PBot
|
||||
internal API functions.
|
||||
|
||||
[Learn more.](doc/Plugins/Plang.md)
|
||||
|
||||
### Extensible
|
||||
Additional commands and functionality can be added to PBot in the following ways.
|
||||
|
||||
@ -321,6 +314,13 @@ Additional Functions can easily be added by making a very simple PBot Plugin.
|
||||
|
||||
For more information, see the [Functions documentation](doc/Functions.md).
|
||||
|
||||
#### Scripting interface
|
||||
PBot uses [Plang](https://github.com/pragma-/Plang) as a scripting language. You can use the
|
||||
scripting language to construct advanced commands that are capable of interacting with PBot
|
||||
internal API functions.
|
||||
|
||||
[Learn more.](doc/Plugins/Plang.md)
|
||||
|
||||
### Virtual machine to safely execute user-submitted code
|
||||
PBot can integrate with a virtual machine to safely execute arbitrary user-submitted
|
||||
operating system commands or code.
|
||||
@ -383,11 +383,11 @@ For more information, see the [Admin documentation.](doc/Admin.md)
|
||||
### Channel management and protection
|
||||
PBot can perform the typical channel management tasks.
|
||||
|
||||
* opping/deopping, etc
|
||||
* channel-mode tracking
|
||||
* user hostmask/alias tracking
|
||||
* ban-evasion detection
|
||||
* flood detection
|
||||
* opping/deopping known users, etc
|
||||
* channel-mode tracking/protection
|
||||
* [user hostmask/alias tracking](doc/Admin.md#message-historyuser-tracking)
|
||||
* [ban-evasion detection](doc/Admin.md#akalink)
|
||||
* [flood detection](doc/AntiAbuse.md)
|
||||
* whitelisting, blacklisting, etc
|
||||
* spam/advertisement detection
|
||||
* and much, much more!
|
||||
|
||||
14
doc/Admin.md
14
doc/Admin.md
@ -671,7 +671,7 @@ Option | Description
|
||||
If neither options `-a` or `-t` are provided then the `pids...` option is required.
|
||||
|
||||
## Message-history/user-tracking
|
||||
Message history has an advanced user tracking algorithm in order to ensure that
|
||||
PBot's message history uses an advanced user tracking algorithm in order to ensure that
|
||||
messages are being stored in the right message history accounts. The following commands
|
||||
query and manipulate the message history account links.
|
||||
|
||||
@ -765,11 +765,13 @@ Examples:
|
||||
<PBot> bob also known as: bob!~bob@user/bob (seen 5m ago), bobby!~bob@user/bob (seen 6d ago), robert!~bob@127.0.0.1 (seen 20d ago)
|
||||
|
||||
### akalink
|
||||
PBot's message history has an advanced user-tracking algorithm in order to ensure that
|
||||
messages are being stored in the right message history accounts. But sometimes
|
||||
users connect from wholly distinct accounts with no obviously linkable metadata. If
|
||||
you know for certain that they are the same individual, you can use the `akalink`
|
||||
command to manually link two message history accounts together.
|
||||
PBot's message history uses an advanced user-tracking algorithm in order to ensure that
|
||||
messages are being stored in the right message history accounts. This is also used for
|
||||
detecting ban-evasions and looking up also-known-as aliases.
|
||||
|
||||
But sometimes users connect from wholly distinct accounts with no obviously linkable metadata.
|
||||
If you know for certain that they are the same individual, you can use the `akalink` command
|
||||
to manually link two message history accounts together.
|
||||
|
||||
Usage: `akalink <target id> <alias id> [type]`
|
||||
|
||||
|
||||
@ -422,7 +422,7 @@ enabled | If set to false, PBot will not autojoin or respond to this channel. |
|
||||
chanop | If set to true, PBot will perform OP duties in this channel. | 0
|
||||
permop | If set to true, PBot will not de-OP itself in this channel. | 0
|
||||
|
||||
For more information, see the [Channels documentation](Admin.md#channel-management-commands).
|
||||
For more information, see the [Channels documentation](Admin.md#channel-management).
|
||||
|
||||
## Further Reading
|
||||
That should get you started. For further information about PBot, check out these topics.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user