3
0
mirror of https://github.com/pragma-/pbot.git synced 2024-12-28 21:52:35 +01:00
pbot/doc/Factoids.md

643 lines
27 KiB
Markdown
Raw Normal View History

2020-01-09 06:08:45 +01:00
# Factoids
2019-12-24 02:30:57 +01:00
<!-- md-toc-begin -->
2020-01-11 01:14:31 +01:00
* [About](#about)
* [Channel namespaces](#channel-namespaces)
* [Special commands](#special-commands)
* [/say](#say)
* [/me](#me)
* [/call](#call)
* [/msg](#msg)
* [/code](#code)
* [Supported languages](#supported-languages)
* [Special variables](#special-variables)
* [testargs example](#testargs-example)
* [Setting a usage message](#setting-a-usage-message)
* [poll/vote example](#pollvote-example)
* [SpongeBob Mock meme example](#spongebob-mock-meme-example)
* [Using command-piping](#using-command-piping)
* [Improving SpongeBob Mock meme](#improving-spongebob-mock-meme)
* [Special variables](#special-variables-1)
* [$args](#args)
* [$arg[n]](#argn)
* [$arg[n:m]](#argnm)
* [$arglen](#arglen)
* [$channel](#channel)
2020-01-09 07:10:40 +01:00
* [$nick](#nick)
* [$randomnick](#randomnick)
* [$0](#0)
* [List variables](#list-variables)
* [modifiers](#modifiers)
* [action_with_args](#action_with_args)
* [add_nick](#add_nick)
2020-01-08 13:26:08 +01:00
* [Adding a factoid](#adding-a-factoid)
2020-01-09 06:08:45 +01:00
* [factadd](#factadd)
2020-01-08 13:26:08 +01:00
* [Viewing/triggering a factoid](#viewingtriggering-a-factoid)
* [Viewing/triggering another channel's factoid](#viewingtriggering-another-channels-factoid)
2020-01-09 06:08:45 +01:00
* [fact](#fact)
2020-01-08 13:26:08 +01:00
* [Deleting a factoid](#deleting-a-factoid)
2020-01-09 06:08:45 +01:00
* [factrem](#factrem)
* [forget](#forget)
2020-01-08 13:26:08 +01:00
* [Aliasing a factoid](#aliasing-a-factoid)
2020-01-09 06:08:45 +01:00
* [factalias](#factalias)
2020-01-08 13:26:08 +01:00
* [Moving/renaming a factoid](#movingrenaming-a-factoid)
2020-01-09 06:08:45 +01:00
* [factmove](#factmove)
2020-01-08 13:26:08 +01:00
* [Changing a factoid](#changing-a-factoid)
2020-01-09 06:08:45 +01:00
* [factchange](#factchange)
* [factundo](#factundo)
* [factredo](#factredo)
* [Factoid Metadata](#factoid-metadata)
* [factset](#factset)
* [factunset](#factunset)
* [Factoid Metadata List](#factoid-metadata-list)
2020-01-08 13:26:08 +01:00
* [Finding a factoid](#finding-a-factoid)
2020-01-09 06:08:45 +01:00
* [factfind](#factfind)
2020-01-08 13:26:08 +01:00
* [Information about a factoid](#information-about-a-factoid)
2020-01-09 06:08:45 +01:00
* [factinfo](#factinfo)
* [factshow](#factshow)
* [factset](#factset-1)
* [factlog](#factlog)
* [count](#count)
* [histogram](#histogram)
* [top20](#top20)
2019-12-24 02:30:57 +01:00
<!-- md-toc-end -->
2020-01-11 01:14:31 +01:00
## About
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 creator of the factoid to prevent them from being edited by others.
At its most simple, factoids merely output the text the creator sets.
<pragma-> !factadd hello /say Hello, $nick!
<PBot> hello added to global channel.
2020-01-11 01:14:31 +01:00
<pragma-> PBot, hello
<PBot> Hello, pragma-!
2020-01-11 01:14:31 +01:00
Significantly more complex factoids can be built by using $variables, command-substitution, command-piping, /code invocation, and more!
## Channel namespaces
2019-12-24 02:30:57 +01:00
Factoids added in one channel may be called/triggered in another channel or in private message, providing that the other channel doesn't already have a factoid of the same name (in which case that channel's factoid will be triggered).
2020-01-08 13:26:08 +01:00
Factoids may be added to a special channel named `global`. Factoids that are set in this channel will be accessible to any channels. Factoids that are set in a specific channel will override factoids of the same name that are set in the `global` channel or other channels.
2019-12-24 02:30:57 +01:00
2020-01-08 13:26:08 +01:00
For example, if there were factoid named `malloc` set in `##c` and in `global`, and you invoke it in `##c` then the `##c` version would be used. If the factoid were triggered in any other channel, then the `global` version would be invoked.
2019-12-24 02:30:57 +01:00
2020-01-08 13:26:08 +01:00
Now imagine `##c++` also has a `malloc` factoid. If you invoke it in `##c++` then its version of the factoid would be used instead of `##c`'s or `global`'s versions. If you invoke it in a channel that is not `##c++` or `##c` then the `global` version would be used.
2019-12-24 02:30:57 +01:00
2020-01-08 13:26:08 +01:00
However, if there is no `malloc` factoid in the `global` channel but there is one in `##c` and `##c++`, and you attempt to invoke it in any other channel then PBot will display a disambiguation message listing which channels it belongs to and instructing you to use the [`fact`](#fact) command to call the desired factoid.
2019-12-24 02:30:57 +01:00
## Special commands
### /say
If a factoid begins with `/say` then PBot will not use the `<factoid> is <description>` format when displaying the factoid. Instead, it will simply say only the `<description>`.
2019-12-24 02:30:57 +01:00
2020-01-08 13:26:08 +01:00
<pragma-> !factadd global hi /say Well, hello there, $nick.
<PBot> hi added to the global channel
2019-12-24 02:30:57 +01:00
<prec> PBot, hi
<PBot> Well, hello there, prec.
### /me
If a factoid begins with `/me` then PBot will `CTCP ACTION` the factoid.
2019-12-24 02:30:57 +01:00
2020-01-08 13:45:07 +01:00
<pragma-> !factadd global bounce /me bounces around.
<PBot> bounce added to the global channel
2020-01-08 13:45:07 +01:00
<pragma-> !bounce
2019-12-24 02:30:57 +01:00
* PBot bounces around.
### /call
If a factoid begins with `/call` then PBot will call an existing command. This is what [`factalias`](#factalias) does internally.
2019-12-24 02:30:57 +01:00
2020-01-08 13:45:07 +01:00
<pragma-> !factadd global boing /call bounce
<PBot> boing added to the global channel
2020-01-08 13:45:07 +01:00
<pragma-> !boing
2019-12-24 02:30:57 +01:00
* PBot bounces around.
### /msg
If a factoid begins with `/msg <nick>` then PBot will privately message the factoid text to `<nick>`. Only admins can use this command.
2019-12-24 02:30:57 +01:00
### /code
Code Factoids are a special type of factoid whose text is treated as code and executed with a chosen programming language
or interpreter. The output from code is then parsed and treated like any other factoid text. This allows anybody to add
new and unique commands to PBot without the need for installing Plugins or modules.
Code Factoids are executed within a virtual machine. You must install and set up a virtual machine with your operating system.
2020-01-11 23:37:26 +01:00
See the [Virtual Machine](VirtualMachine.md) documentation for more information.
To create a Code Factoid, use the `/code` command. The syntax is:
2020-01-09 05:40:51 +01:00
factadd <keyword> /code <language> <code>
The `<language>` parameter selects a programming/scripting language or interpreter to use.
#### Supported languages
As of this writing, these are the languages and interpreters that PBot supports. It is easy to add additional
languages or interpreters.
Name | Description
--- | ---
[bash](../modules/compiler_vm/languages/bash.pm) | Bourne-again Shell scripting language
[bc](../modules/compiler_vm/languages/bc.pm) | An arbitrary precision calculator language
[bf](../modules/compiler_vm/languages/bf.pm) | BrainFuck esoteric language
[c11](../modules/compiler_vm/languages/c11.pm) | C programming language using GCC -std=c11
[c89](../modules/compiler_vm/languages/c89.pm) | C programming language using GCC -std=c89
[c99](../modules/compiler_vm/languages/c99.pm) | C programming language using GCC -std=c99
[clang11](../modules/compiler_vm/languages/clang11.pm) | C programming language using Clang -std=c11
[clang89](../modules/compiler_vm/languages/clang89.pm) | C programming language using Clang -std=c89
[clang99](../modules/compiler_vm/languages/clang99.pm) | C programming language using Clang -std=c99
[clang](../modules/compiler_vm/languages/clang.pm) | Alias for `clang11`
[clangpp](../modules/compiler_vm/languages/clangpp.pm) | C++ programming language using Clang
[clisp](../modules/compiler_vm/languages/clisp.pm) | Common Lisp dialect of the Lisp programming language
[cpp](../modules/compiler_vm/languages/cpp.pm) | C++ using GCC
[freebasic](../modules/compiler_vm/languages/freebasic.pm) | FreeBasic BASIC compiler/interpreter
[go](../modules/compiler_vm/languages/go.pm) | Golang programming language
[haskell](../modules/compiler_vm/languages/haskell.pm) | Haskell programming language
[java](../modules/compiler_vm/languages/java.pm) | Java programming language
[javascript](../modules/compiler_vm/languages/javascript.pm) | JavaScript programming language
[ksh](../modules/compiler_vm/languages/ksh.pm) | Korn shell scripting language
2020-01-09 19:59:38 +01:00
[lua](../modules/compiler_vm/languages/lua.pm) | Lua programming language
[perl](../modules/compiler_vm/languages/perl.pm) | Perl programming language
[python3](../modules/compiler_vm/languages/python3.pm) | Python3 programming language
[python](../modules/compiler_vm/languages/python.pm) | Python programming language
[qbasic](../modules/compiler_vm/languages/qbasic.pm) | QuickBasic option using FreeBasic
[ruby](../modules/compiler_vm/languages/ruby.pm) | Ruby programming language
[scheme](../modules/compiler_vm/languages/scheme.pm) | Scheme dialect of the Lisp programming language
[sh](../modules/compiler_vm/languages/sh.pm) | Bourne Shell scripting language
[tcl](../modules/compiler_vm/languages/tcl.pm) | TCL scripting language
[zsh](../modules/compiler_vm/languages/zsh.pm) | Z Shell scripting language
#### Special variables
All the variables listed in [Special Variables](#special-variables-1) are expanded within Code Factoids before
the code is executed or interpreted.
[List variables](#list-variables) are also expanded beforehand as well. You can prevent this by using [`factset`](#factset)
2020-01-09 06:08:45 +01:00
to set the `interpolate` [factoid meta-data](#factoid-metadata) to `0`. Alternatively, you can prevent `$variables` in
the code from expanding by prefixing their name with an underscore, i.e. `$_variable`.
#### testargs example
Let's make a simple Code Factoid that demonstrates command-line arguments. Let's use
the C programming language because why not?
<pragma-> !factadd testargs /code c11 printf("/say args: "); while (*++argv) printf("[%s] ", *argv);
<PBot> testargs added to the global channel.
<pragma-> testargs foo bar
<PBot> args: [foo] [bar]
<pragma-> testargs "abc 123" xyz
<PBot> args: [abc 123] [xyz]
#### Setting a usage message
2020-01-09 07:10:40 +01:00
Suppose you want the command to display a usage message if there are no arguments provided. You can use
2020-01-09 06:08:45 +01:00
the [`factset`](#factset) command to set the `usage` [factoid meta-data](#factoid-metadata).
<pragma-> !testargs
<PBot> args:
<pragma-> !factset testargs usage Usage: testargs <arguments>
<PBot> [global] testcargs 'usage' set to 'Usage: testargs <arguments>'
<pragma-> !testargs
<PBot> Usage: testargs <arguments>
#### poll/vote example
Here is a basic poll/vote example. Let's use Perl this time.
First we add the factoids. Note that we use `$_variable` with underscore prefixing
the name to prevent them from being expanded as [List Variables](#list-variables).
<pragma-> !factadd startvote /code perl use Storable; my $_question = "@ARGV";
print "Starting poll: $_question Use `vote <keyword>` to record your vote.";
my %_votes = (); my @data = ({%_votes}, $_question);
system 'rm -rf vote-data'; mkdir 'vote-data' or print "$!";
store \@data, 'vote-data/data';
<pragma-> !factset startvote usage Usage: startvote <question>
<pragma-> !factadd vote /code perl use Storable; my $_data = retrieve 'vote-data/data';
my %_votes = %{shift @$_data}; ($_votes{"$nick"}) = (lc "@ARGV");
unshift @$_data, {%_votes}; store $_data, 'vote-data/data';
<pragma-> !factset vote usage Usage: vote <keyword>
<pragma-> !factadd votes /code perl no warnings; use Storable; my $_data = retrieve 'vote-data/data';
my %_votes = %{shift @$_data}; my $_question = shift @$_data;
if (not keys %_votes) { print "No votes for \"$_question\" yet."; exit; }
my %_count; map { $_count{$_}++ } values %_votes;
my $_result = "Poll results for \"$_question\": "; my $_comma = "";
map { $_result .= "$_comma$_: $_count{$_}"; $_comma = ', '; }
sort { $_count{$b} <=> $_count{$a} } keys %_count; print "/say $_result";
And action:
<pragma-> !startvote Isn't this cool?
<PBot> Starting poll: Isn't this cool? Use `vote <keyword>` to record your vote.
<pragma-> !vote yes
<luser69> !vote no
<someguy> !vote yes
<derpy3> !vote hamburger
<pragma-> !votes
<PBot> Poll results for "Isn't this cool?": yes: 2, no: 1, hamburger: 1
#### SpongeBob Mock meme example
Here is an example demonstrating how Code Factoids and command piping can work together.
The SpongeBob Mock meme takes something ridiculous somebody said and repeats it with the
letters in alternating lower and upper case.
<derpy3> Girls are dumb!
<SpBob> smh @ derpy3... gIrLs ArE dUmB!
Let's make a command, using a Code Factoid, to do this! `sm` stands for "SpongeBob Mock".
This time we'll use the Bash shell scripting language.
<pragma-> !factadd sm /code bash echo "${@,,}"|perl -pe 's/(?<!^)[[:alpha:]].*?([[:alpha:]]|$)/\L\u$&/g'
<pragma-> !factset sm usage Usage: sm <text>
<pragma-> !sm Testing one, two...
<PBot> tEsTiNg OnE, tWo...
#### Using command-piping
You can pipe the output of other commands to Code Factoids.
<pragma-> !echo Testing three, four... | {sm}
<PBot> tEsTiNg ThReE, fOuR...
<pragma-> !version | {sm}
<PBot> pBoT vErSiOn 2696 2020-01-04
#### Improving SpongeBob Mock meme
Let's improve the SpongeBob Mock meme by using the `recall` command to select
the mock text for us.
First of all, the `recall` command prints output like this:
<derpy3> Girls are dumb!
<pragma-> !recall derpy3 girls
<PBot> [5m30s ago] <derpy3> Girls are dumb!
So we're going to use the `func` command to invoke the built-in `sed` function
to strip the timestamp and the name, leaving only the message. `smr` stands for
"SpongeBob Mock Recall".
<pragma-> !factadd smr /call recall $args | {func sed s/^.*?\] (<.*?> )?(\S+:\s*)?//} | {sm}
<derpy3> Girls are dumb!
<pragma-> !smr derpy3 girls
<PBot> gIrLs ArE dUmB!
We can make an alias with a more friendly name.
<pragma-> !factalias mock smr
If the recalled message is the most recent, there is no need to use an argument (e.g., `girls`).
<derpy3> Girls are dumb!
<pragma-> !mock derpy3
<PBot> gIrLs ArE dUmB!
## Special variables
2020-01-09 07:10:40 +01:00
You can use the following variables in a factoid or, in some cases, as an argument to one.
2019-12-24 02:30:57 +01:00
### $args
2019-12-24 02:30:57 +01:00
`$args` expands to any text following the keyword. If there is no text then it expands to the nick of the caller.
### $arg[n]
2019-12-24 02:30:57 +01:00
`$arg[n]` expands to the nth argument. Indexing begins from 0 (the first argument is `$arg[0]`). You may use a negative number to count from the end; e.g., `$arg[-2]` means the 2nd argument from the end. Multiple words can be double-quoted to constitute one argument. If the argument does not exist, the variable and the leading space before it will be silently removed.
### $arg[n:m]
2020-01-09 20:50:20 +01:00
`$arg[n:m]` expands to a slice of arguments between `n` and `m`. Indexing begins from 0 (the first argument is `$arg[0]`). Omitting the `m` value will use up the arguments after the `n`th value; e.g., `$arg[2:]` means the remaining arguments after the first two. Multiple words can be double-quoted to constitute one argument. If the argument does not exist, the variable and the leading space before it will be silently removed.
2019-12-24 02:30:57 +01:00
### $arglen
2019-12-24 02:30:57 +01:00
`$arglen` expands to the number of arguments provided to a factoid.
### $channel
2019-12-24 02:30:57 +01:00
`$channel` expands to the name of the channel in which the factoid is used.
2020-01-09 07:10:40 +01:00
### $nick
`$nick` expands to the nick of the caller.
### $randomnick
2020-01-08 13:26:08 +01:00
`$randomnick` expands to a random nick from the channel in which the factoid is used. Filtered to nicks who have spoken in channel in the last two hours.
2019-12-24 02:30:57 +01:00
### $0
`$0` expands to the original keyword used to invoke a factoid.
2019-12-24 02:30:57 +01:00
## List variables
2020-01-09 05:38:24 +01:00
You may create a factoid containing a list of quoted values. When this factoid is used as a `$variable` a random value
2020-01-08 13:45:07 +01:00
will be selected from the list.
For example, first create a normal factoid.
2019-12-24 02:30:57 +01:00
2020-01-08 13:26:08 +01:00
<pragma-> !factadd global colors is red green blue "bright yellow" pink "dark purple" orange
2019-12-24 02:30:57 +01:00
<PBot> colors added to the global channel
2020-01-08 13:45:07 +01:00
Then use the factoid as a `$variable`.
<pragma-> !echo $colors
<PBot> red
<!-- -->
2019-12-24 02:30:57 +01:00
2020-01-08 13:26:08 +01:00
<pragma-> !factadd global sky is /say The sky is $colors.
2019-12-24 02:30:57 +01:00
<PBot> sky added to the global channel
2020-01-08 13:26:08 +01:00
<pragma-> !sky
2019-12-24 02:30:57 +01:00
<PBot> The sky is dark purple.
2020-01-08 13:26:08 +01:00
<pragma-> !sky
2019-12-24 02:30:57 +01:00
<PBot> The sky is green.
2020-01-08 13:45:07 +01:00
Another example, creating the RTFM trigger:
2019-12-24 02:30:57 +01:00
2020-01-08 13:26:08 +01:00
<pragma-> !factadd global sizes is big large tiny small huge gigantic teeny
<PBot> sizes added to the global channel
2020-01-08 13:26:08 +01:00
<pragma-> !factadd global attacks is whaps thwacks bashes smacks punts whacks
<PBot> attacks added to the global channel
2020-01-08 13:26:08 +01:00
<pragma-> !factadd global rtfm is /me $attacks $args with a $sizes $colors manual.
<PBot> rtfm added to the global channel
2020-01-08 13:26:08 +01:00
<pragma-> !rtfm mauke
2019-12-24 02:30:57 +01:00
* PBot thwacks mauke with a big red manual.
### modifiers
2020-01-08 13:45:07 +01:00
Factoid `$variables` can accept trailing modifier keywords prefixed with a colon. These can be chained together to combine their effects.
<pragma-> !echo $colors:uc
<PBot> RED
2020-01-08 13:45:07 +01:00
<pragma-> !echo $colors:ucfirst
<PBot> Blue
2019-12-24 02:30:57 +01:00
2020-01-08 13:26:08 +01:00
Modifier | Description
--- | ---
`:uc` | Uppercases the expansion
`:lc` | Lowercases the expansion
`:ucfirst` | Uppercases the first letter in the expansion
`:title` | Lowercases the expansion and then uppercases the initial letter of each word
`:<channel>` | Looks for variable in `<channel>` first; use `global` to refer to the global channel
2019-12-24 02:30:57 +01:00
## action_with_args
2020-01-09 06:08:45 +01:00
You can use the [`factset`](#factset) command to set a special [factoid meta-data](#factoid-metadata) key named `action_with_args` to trigger an alternate message if an argument has been supplied.
2019-12-24 02:30:57 +01:00
2020-01-08 13:26:08 +01:00
<pragma-> !factadd global snack is /me eats a cookie.
<PBot> snack added to the global channel
2020-01-08 13:26:08 +01:00
<pragma-> !factset global snack action_with_args /me gives $args a cookie.
2019-12-24 02:30:57 +01:00
<PBot> [Factoids] (global) snack: 'action_with_args' set to '/me gives $args a cookie.'
2020-01-08 13:26:08 +01:00
<pragma-> !snack
2019-12-24 02:30:57 +01:00
* PBot eats a cookie.
2020-01-08 13:26:08 +01:00
<pragma-> !snack orbitz
2019-12-24 02:30:57 +01:00
* PBot gives orbitz a cookie.
## add_nick
2020-01-09 06:08:45 +01:00
You can use the [`factset`](#factset) command to set a special [factoid meta-data](#factoid-metadata) key named `add_nick` to prepend the nick of the caller to the output. This is mostly useful for modules.
2019-12-24 02:30:57 +01:00
2020-01-09 06:08:45 +01:00
## Adding a factoid
### factadd
2020-01-08 13:26:08 +01:00
Usage: `factadd [channel] <keyword> <description>`
To add a factoid to the global channel, use `global` as the channel.
<pragma-> !factadd ##c c /say C rocks!
2019-12-24 02:30:57 +01:00
2020-01-09 06:08:45 +01:00
## Viewing/triggering a factoid
2019-12-24 02:30:57 +01:00
To view or trigger a factoid, one merely issues its keyword as a command.
<pragma-> PBot, c?
<PBot> C rocks!
2020-01-09 06:08:45 +01:00
## Viewing/triggering another channel's factoid
### fact
2019-12-24 02:30:57 +01:00
To view or trigger a factoid belonging to a specific channel, use the `fact` command.
Usage: `fact <channel> <keyword> [arguments]`
2020-01-09 06:08:45 +01:00
## Deleting a factoid
### factrem
### forget
2019-12-24 02:30:57 +01:00
To remove a factoid, use the `factrem` or `forget` command.
2020-01-08 13:26:08 +01:00
Usage: `factrem [channel] <keyword>` `forget [channel] <keyword>`
2019-12-24 02:30:57 +01:00
2020-01-09 06:08:45 +01:00
## Aliasing a factoid
### factalias
2020-01-08 13:45:07 +01:00
To create an factoid that acts as an alias for a command, use the `factalias` command or set the factoid's `action` meta-data to `/call <command>`.
2019-12-24 02:30:57 +01:00
2020-01-08 13:45:07 +01:00
Usage: `factalias [channel] <keyword> <command>`
2019-12-24 02:30:57 +01:00
2020-01-08 13:26:08 +01:00
<pragma-> !factadd ##c offtopic is /say In this channel, $args is off-topic.
2020-01-08 13:26:08 +01:00
<pragma-> !offtopic C++
2019-12-24 02:30:57 +01:00
<PBot> In this channel, C++ is off-topic.
2020-01-08 13:26:08 +01:00
<pragma-> !factalias ##c C++ offtopic C++
2020-01-08 13:26:08 +01:00
<pragma-> !C++
2019-12-24 02:30:57 +01:00
<PBot> In this channel, C++ is off-topic.
<!-- -->
2020-01-08 13:26:08 +01:00
<pragma-> !factadd ##c book is /me points accusingly at $args, "Where is your book?!"
<PBot> book added to ##c
2020-01-08 13:26:08 +01:00
<pragma-> !book newbie
2019-12-24 02:30:57 +01:00
* PBot points accusingly at newbie, "Where is your book?!"
2020-01-08 13:26:08 +01:00
<pragma-> !factadd ##c rafb /call book
<PBot> rafb added to ##c
2020-01-08 13:26:08 +01:00
<pragma-> !rafb runtime
2019-12-24 02:30:57 +01:00
* PBot points accusingly at runtime, "Where is your book?!"
2020-01-09 06:08:45 +01:00
## Moving/renaming a factoid
### factmove
2019-12-24 02:30:57 +01:00
To rename a factoid or move a factoid to a different channel, use the `factmove` command:
Usage: `factmove <source channel> <source factoid> <target channel/factoid> [target factoid]`
If three arguments are given, the factoid is renamed in the source channel. If four arguments are given, the factoid is moved to the target channel with the target name.
2020-01-09 06:08:45 +01:00
## Changing a factoid
### factchange
2019-12-24 02:30:57 +01:00
To change a factoid, use the `factchange` command:
2020-01-08 13:45:07 +01:00
Usage: `factchange [channel] <keyword> s/<pattern>/<change to>/[gi]`
2019-12-24 02:30:57 +01:00
2020-01-08 13:26:08 +01:00
<pragma-> !c
2019-12-24 02:30:57 +01:00
<PBot> C rocks!
2020-01-08 13:26:08 +01:00
<pragma-> !factchange ##c c s/rocks/rules/
2019-12-24 02:30:57 +01:00
<PBot> c changed.
2020-01-08 13:26:08 +01:00
<pragma-> !c
2019-12-24 02:30:57 +01:00
<PBot> C rules!
Note that the final argument is a Perl-style substitution regex. See `man perlre` on your system.
2020-01-08 13:26:08 +01:00
For instance, it is possible to append to a factoid by using: `factchange channel factoid s/$/text to append/`. Likewise, you can prepend to a factoid by using: `factchange channel factoid s/^/text to prepend/`.
2019-12-24 02:30:57 +01:00
2020-01-09 06:08:45 +01:00
### factundo
2020-01-08 13:26:08 +01:00
To revert to an older revision, use the `factundo` command. You can repeatedly undo a factoid until there are no more undos remaining.
2019-12-24 02:30:57 +01:00
Usage: `factundo [channel] <keyword>`
2020-01-09 06:08:45 +01:00
### factredo
2020-01-08 13:26:08 +01:00
To revert to a newer revision, use the `factredo` command. You can repeatedly redo a factoid until there are no more redos available.
2019-12-24 02:30:57 +01:00
Usage: `factredo [channel] <keyword>`
2020-01-09 06:08:45 +01:00
## Factoid Metadata
### factset
2020-01-08 13:26:08 +01:00
To view or set [factoid meta-data](#factoid-metadata-list), such as owner, rate-limit, etc, use the [`factset`](#factset) command.
2019-12-24 02:30:57 +01:00
2020-01-08 13:26:08 +01:00
Usage: `factset [channel] <factoid> [<key> [value]]`
2019-12-24 02:30:57 +01:00
Omit `<key>` and `<value>` to list all the keys and values for a factoid. Specify `<key>`, but omit `<value>` to see the value for a specific key.
2020-01-09 06:08:45 +01:00
### factunset
2020-01-08 13:26:08 +01:00
To unset [factoid meta-data](#factoid-metadata-list), use the `factunset` command.
2019-12-24 02:30:57 +01:00
2020-01-08 13:26:08 +01:00
Usage: `factunset [channel] <factoid> <key>`
2020-01-09 06:08:45 +01:00
### Factoid Metadata List
2020-01-08 13:26:08 +01:00
This is a list of recognized factoid meta-data fields. An admin level of `0` signifies that anybody can set the field.
Name | Admin level | Description
--- | --- | ---
`created_on` | 90 | The timestamp of when the factoid was created.
`enabled` | 10 | Whether the factoid can be invoked or not. If it is disabled, the command will be silently ignored.
`last_referenced_in` | 90 | The channel or private-message in which the factoid was last used.
`last_referenced_on` | 90 | The timestamp of when the factoid was last used.
`modulelauncher_subpattern` | 90 | A substitution expression used to modify the arguments into a command-line for a module factoid.
`owner` | 90 | The creator of the factoid. The creator has the ability to lock the factoid, etc.
`rate_limit` | 10 | The factoid may be invoked only once per this many seconds. `0` for no limit.
`ref_count` | 90 | How many times the factoid has been invoked in its life-time.
`ref_user` | 90 | The hostmask of the last person to invoke the factoid.
`type` | 90 | The type of the factoid. "text" for regular factoid; "module" for module.
`edited_by` | 90 | The hostmask of the person to last edit the factoid.
`edited_on` | 90 | The timestamp of when the factoid was last edited.
`locked` | 10 | If enabled, prevents the factoid from being changed or removed.
`add_nick` | 10 | Prepends the nick of the person invoking the factoid to the output of the factoid.
`nooverride` | 10 | Prevents the creation of a factoid with an identical name in a different channel.
`effective-level` | 20 | the effective admin level at which this factoid executes (i.e., for /kick, etc)
`persist-key` | 20 | the storage key for allowing code-factoids to persist variables
`action_with_args` | 0 | Alternate action to perform if an argument has been supplied when invoking the factoid.
`interpolate` | 0 | When set to a false value, `$variables` will not be expanded.
2020-01-09 06:08:45 +01:00
`usage` | 0 | Prints a usage message when no arguments are provided.
2020-01-08 13:26:08 +01:00
`use_output_queue` | 0 | When set to a true value, the output will be delayed by a random number of seconds to simulate reading/typing.
2019-12-24 02:30:57 +01:00
2020-01-09 06:08:45 +01:00
## Finding a factoid
### factfind
2019-12-24 02:30:57 +01:00
To search the database for a factoid, use the 'factfind` command. You may optionally specify whether to narrow by channel and/or include factoid owner and/or last referenced by in the search.
If there is only one match for the query, it will display that factoid and its text, otherwise it will list all matching keywords.
Usage: `factfind [-channel channel] [-owner nick] [-by nick] [-regex] [text]`
If you specify the `-regex` flag, the `text` argument will be treated as a regex.
2020-01-08 13:26:08 +01:00
<pragma-> !factfind cast
2019-12-24 02:30:57 +01:00
<PBot> 3 factoids match: [##c] NULL casting dontcastmalloc
2020-01-09 06:08:45 +01:00
## Information about a factoid
### factinfo
2019-12-24 02:30:57 +01:00
To get information about a factoid, such as who submitted it and when, use the `factinfo` command.
Usage: `factinfo [channel] <keyword>`
2020-01-08 13:26:08 +01:00
<pragma-> !factinfo ##c NULL
2019-12-24 02:30:57 +01:00
<PBot> NULL: Factoid submitted by Major-Willard for all channels on Sat Jan 1 16:17:42 2005 [5 years and 178 days ago], referenced 39 times (last by pragma- on Sun Jun 27 04:40:32 2010 [5 seconds ago])
2020-01-09 06:08:45 +01:00
### factshow
2020-01-08 13:26:08 +01:00
To see the factoid `action` meta-data, use the `factshow` command.
2019-12-24 02:30:57 +01:00
Usage: `factshow [channel] <keyword>`
2020-01-08 13:26:08 +01:00
<pragma-> !factshow hi
2019-12-24 02:30:57 +01:00
<PBot> hi: /say $greetings, $nick.
2020-01-09 06:08:45 +01:00
### factset
2020-01-08 13:26:08 +01:00
To view [factoid meta-data](#factoid-metadata-list), such as owner, rate-limit, etc, use the `factset` command.
2019-12-24 02:30:57 +01:00
Usage: `factset [channel] <factoid> [<key> [value]]`
2019-12-24 02:30:57 +01:00
Omit `<key>` and `<value>` to list all the keys and values for a factoid. Specify `<key>`, but omit `<value>` to see the value for a specific key.
2020-01-09 06:08:45 +01:00
### factlog
2019-12-24 02:30:57 +01:00
To see a factoid's changelog history, use the `factlog` command.
Usage: `factlog [-h] [-t] [channel] <factoid>`
2020-01-08 13:45:07 +01:00
`-h` shows full hostmasks instead of just the nick.
`-t` shows the actual timestamp instead of relative.
2019-12-24 02:30:57 +01:00
2020-01-08 13:26:08 +01:00
<pragma-> !factadd hi /say Hello there!
2019-12-24 02:30:57 +01:00
<PBot> hi added to global channel.
2020-01-08 13:26:08 +01:00
<pragma-> !factchange hi s/!$/, $nick!/
2019-12-24 02:30:57 +01:00
<PBot> Changed: hi is /say Hello there, $nick!
2020-01-08 13:26:08 +01:00
<pragma-> !forget hi
2019-12-24 02:30:57 +01:00
<PBot> hi removed from the global channel.
2020-01-08 13:26:08 +01:00
<pragma-> !factadd hi /say Hi!
2019-12-24 02:30:57 +01:00
<!-- -->
2020-01-08 13:26:08 +01:00
<pragma-> !factlog hi
2019-12-24 02:30:57 +01:00
<PBot> [3m ago] pragma- created: /say Hi! [5m ago] pragma- deleted [8m ago] pragma- changed to /say Hello there, $nick! [10m ago] pragma- created: /say Hello there!
2020-01-09 06:08:45 +01:00
### count
2019-12-24 02:30:57 +01:00
To see how many factoids and what percentage of the database `<nick>` has submitted, use the `count` command.
Usage: `count <nick>`
2020-01-08 13:26:08 +01:00
<pragma-> !count prec
2019-12-24 02:30:57 +01:00
<PBot> prec has submitted 28 factoids out of 233 (12%)
2020-01-08 13:45:07 +01:00
2020-01-08 13:26:08 +01:00
<pragma-> !count twkm
2019-12-24 02:30:57 +01:00
<PBot> twkm has submitted 74 factoids out of 233 (31%)
2020-01-08 13:45:07 +01:00
2020-01-08 13:26:08 +01:00
<pragma-> !count pragma
2019-12-24 02:30:57 +01:00
<PBot> pragma has submitted 27 factoids out of 233 (11%)
2020-01-09 06:08:45 +01:00
### histogram
2019-12-24 02:30:57 +01:00
To see a histogram of the top factoid submitters, use the `histogram` command.
2020-01-08 13:26:08 +01:00
<pragma-> !histogram
2019-12-24 02:30:57 +01:00
<PBot> 268 factoids, top 10 submitters: twkm: 74 (27%) Major-Willard: 64 (23%) pragma-: 40 (14%) prec: 39 (14%) defrost: 14 (5%) PoppaVic: 10 (3%) infobahn: 7 (2%) orbitz: 3 (1%) mauke: 3 (1%) Tom^: 2 (1%)
2020-01-09 06:08:45 +01:00
### top20
2020-01-08 13:45:07 +01:00
To see the top 20 most popular factoids, use the `top20` command. It can also show you the 50 most recent factoids that were added to a channel.
2020-01-08 13:26:08 +01:00
Usage: `top20 <channel> [<nick> or 'recent']`
<pragma-> !top20 ##c
<PBot> Top 20 referenced factoids for ##c: explain (3459) c11 (2148) book (1070) books (1049) K&R (1000) dontcastmalloc (991) notC (696) standard (655) c99 (506) scanf (501) declare (453) std (434) cstd (344) tias (305) parens (291) int (287) c1x (272) UB (263) H&S (257) binky (236)
<pragma-> !top20 ##c pragma-
<PBot> 20 factoids last referenced by pragma- (pragma-!~chaos@unaffiliated/pragmatic-chaos): to [1d20h ago] realloc [3d15h ago] deport [4d16h ago] long [4d16h ago] decay [6d17h ago] x [6d16h ago] sizeof [13d18h ago] ENOQUESTION [13d19h ago] main [13d10h ago] cfaq [14d22h ago] heap [14d23h ago] malloc [15d15h ago] _ [16d20h ago] declareuse [17d15h ago] rot13 [17...
<pragma-> !top20 ##c recent
<PBot> 50 most recent ##c submissions: barometer [9h ago by kurahaupo] glib-pcre [21h ago by aozt] unspecified [1d13h ago by pragma-] rules [1d17h ago by oldlaptop] pjp [2d3h ago by d3738] gnu-errno-name-num [2d21h ago by aozt] cbreak [5d8h ago by jp] test case [5d9h ago by pragma-] googlearn [6d2h ago by glacial] threads [8d10h ago by glacial] cjeopard...
2019-12-24 02:30:57 +01:00