Scratchi

This page talk about the irc bot scratchi on the #debian-nl channel of the Freenode network. This page is a scratchi reference.

Essential informations

Scratchi is a irc robot on #debian-nl. This is our tool to manage some stuff on the #debian-nl channel. This bot is written in the Python language, and no, I'm (David Van Mosselbeen) not the author of it. See supybot's documentation for more info.

• All stuff in [somethings] are optional.
• All stuff in <somethings> are required.

Talking to the bot

There are 2 different ways to talk to the bot, in the #debian-nl channel or in a private conversation. The later won't be viewable by other peoples and is the recommended way to use when you work with the tool. There's no valid reason to spam the channel.

Note that your nick name needs to be registered on the freenode network before you will be able to talk in private with someone. Even the bot!

To talk to the bot use the bot prefix !. For example, to get the list of functions the bot have:

! 

The bot will reply with somethings like:

Admin, Channel, ChannelLogger, ChannelStats, Config, Misc,   MoobotFactoids, Owner, Seen, Status, and User 

Sometimes, when talking to the bot and when it replies, you see somethings like (1 more message). This means that you may use the command !more to display the next message. Note that the person who initiated the (1 more message) can get the next message.

Plugins

The bot have different plugins, see this as extra tools.

Debian

This is my own made plugin.

psearch

...

pshow

...

pcount

...

moo

...

MoobotFactoids

The moobotfactoids contains the most of the data. The bot will be probably the most used for this. The goal of the bot is to fill it with useful informations that you or other peoples could use. The idea is to store reminders into the database.

Add somethings to the database:

!Debian is http://www.debian.org 

Get some factoid:

!debian 

Append to an existing factoid:

!Debian is also Debian GNU/Linux is a free distribution 

Change a whole factoid:

!no debian is Debian GNU/Linux is a free distribution of the GNU/Linux operating system. It is maintained and updated through the work of many users who volunteer their ... 

Create some multiples predefined results

!beer is <reply> (Stella! | Maes) 

The <reply> may be useful if you want to avoid that the bot, in this case, reply somethings like beer is Stella.

!literal beer 

Remove a factoid:

!remove debian 

Returns the various bits of info on the factoid for the given key. <channel> is only necessary if the message isn't sent in the channel itself:

![<channel>] <author name> 

Returns the various bits of info on the factoid for the given key. <channel> is only necessary if the message isn't sent in the channel itself:

factinfo [<channel>] <factoid key> 

Lists the keys of the factoids whose key contains the provided text. <channel> is only necessary if the message isn't sent in the channel itself:

listkeys [<channel>] <text> 

Lists the keys of the factoids whose value contains the provided text. <channel> is only necessary if the message isn't sent in the channel itself:

listvalues [<channel>] <text> 

Returns the literal factoid for the given factoid key. No parsing of the factoid value is done as it is with normal retrieval. <channel> is only necessary if the message isn't sent in the channel itself:

literal [<channel>] <text> 

Locks the factoid with the given factoid key. Requires that the user be registered and have created the factoid originally. <channel> is only necessary if the message isn't sent in the channel itself.

lock [<channel>] <text> 

Unlocks the factoid with the given factoid key. Requires that the user be registered and have locked the factoid. <channel> is only necessary if the message isn't sent in the channel itself:

unlock [<channel>] <factoid key> 

Lists the most {popular|authored|recent} factoids. "popular" lists the most frequently requested factoids. "authored" lists the author with the most factoids. "recent" lists the most recently created factoids. <channel> is only necessary if the message isn't sent in the channel itself:

most [<channel>] {popular|authored|recent} 

Displays a random factoid (along with its key) from the database. <channel> is only necessary if the message isn't sent in the channel itself:

random [<channel>] 

Administrating the bot

This chapter is only useful for the admins and owner of the bot.

Configuring the bot online

...

Add a user

...

Comments leaved by users (total: 0)

[ Add a comment ]

Add a comment

Name: Email: Comment: Captcha:

Do you know that you may use some special markup syntax to create header, italic, bold, styling and links and much more. See the sandbox for the markup language. Do you need some other help?