Bucket (pail on snoonet) documentation

• Make sure you're prefixing messages properly. Bucket~ [command] and Bucket [command] will not trigger him.
• Bucket will not trigger non-addressed factoids which are shorter than 6 letters long. Bucket, dogs will trigger bucket. Dogs on its own line will not. Bucket, how2love and how2love will trigger the same factoid.
• In PM, do not preface your commands with Bucket, =, just use the =[command] directly. You can only query, you cannot teach factoids in PM.
• Bucket might be shut up at the time. Use #bucket (or configured control channel) or PM to check.
• Bucket might be ignoring you – and only you – because an op has told it to. Probably because you put in some bad factoids.

The most common type of factoid you can teach to Bucket is by simply saying X is Y. If someone says "X" later on, Bucket will reply X is Y

• Be careful about accidentally creating a new factoid while talking to Bucket.
• You can also say X is also Y, this was formerly required to attach multiple factoids to one trigger so you may see older users use this.
• If you type X is Y is Z, Bucket will split it on the first is, making the trigger X and the factoid Y is Z and Bucket will respond X is Y is Z.
• If you wanted X is Y to trigger Z, teach Bucket X is Y <is> Z. See more ways to verb.

Similar to X is Y, you can teach this kind of factoid by simply saying X are Y and if someone says X later on, Bucket will reply X are Y

You can use other things instead of is or are by putting them inside greater and lesser-than signs, such as X <loves> Y or X <compliments> Y

You can say X <reply> Y, when someone says X, Bucket will respond Y.

• You might see some people using X is <reply> Y, this was formerly required so you may see older users use it.

If you use X <action> Y, when someone says X, Bucket will use /me Y.

• Like the above two types, retain the greater-than and lesser-than signs.

Bucket is not run on a client; she is her own entity. This means that slash commands (things like /me, /msg, /quit, etc) do not work. Do not put them in, you'll only anger those who have to clean up your mess.

• Also, escaping (using the \ to get things like question marks to go in on a factoid) is no longer needed.

If you type remember {nick} {snippet} where {snippet} is a snippet from a line that has been said by the person in {nick}, Bucket will remember that factoid under the trigger {nick} quotes. When that quote factoid is triggered, Bucket will respond <Example> Lorem Ipsum

• When Bucket is remembering a /me action, instead of the regular <Example> Lorem Ipsum he'll make an action * Example lorem ipsumed.

Teh literal X command will give you a list of factoids associated with that trigger separated with |. If the list of factoids is too large, Bucket will put them them on another "page" and indicate how many factoids are on the subsequent pages by appending something like 72 more on the list of factoids. You can browse the next pages by using literal[2] X, replacing 2 with the number of the page you wish to check.

Typing literal[*] X will make Bucket produce a url linking to a text file of all the factoids associated with that trigger.

X =~ /m/ will make Bucket reply with the first factoid in that trigger which contains m.

what was that? will make Bucket list the factoid's details thusly: That was X(#77777): <reply> Y, the number being the factoid's ID.

Telling Bucket X =~ s/m/n/ will replace m with n in the factoids for the trigger X. Adding an i flag as in X =~ s/m/n/i replaces case-insensitively. If there are multiple occurrences of m, Bucket will edit the first instance in the trigger's first matching factoid. Ops can add a g flag to replace all occurrences.

Slashes should not be backslash-escaped in the string–use any other delimiter, such as a comma, as a replacement for slashes. Example: to change The best site <is> http://google.com/search to The best site <is> http://xkcd.com, you could type: Bucket: The best site =~ s,http://google.com/search,http://xkcd.com

undo last undoes the last change made to a factoid (editing one, adding one, deleting one.) Non-ops can undo last only if they made the last change.

Use $noun to place a noun variable which will become a noun when the factoid is triggered. Bucket knows plurals and will properly work if you use a $noun or some $nouns.

Use $verb to place a verb variable which will become a verb when the factoid is triggered. Bucket knows plurals and tenses so $verbs, $verbed and $verbing may be used.

Use $adjective to place an adjective variable which will become an adjective when the factoid is triggered.

Use $preposition to place a proposition variable which will become a preposition when the factoid is triggered.

$who will be replaced by the name of the person who triggered the factoid.

$someone will be replaced by a username chosen from recent posters. Note, $someone used to be completely random, but was changed so that Bucket doesn't bother idle users as much.

$to will be replaced by the intended recipient, e.g. <Someone> Bucket: yada yada will replace $to with Bucket. If there is no intended recipient, it will fall back on $someone.

$op will be replaced by the name of one of the Ops. Pro tip: annoy ops at your own risk.

$vehicle will be replaced with a vehicle.

$room will be replaced with a room.

$ejaculation will be replaced with a exclamation. Support for this feature is deprecated

$celebrity will be replaced with a name of a celebrity.

$mood will be replaced with a name of a mood.

$color will be replaced with the name of a color.

$bodypart will be replaced with a (probably not scientific) name of a body part.

$digit will be replaced with a random digit from 0 to 9.

$nonzero will be replaced with a random digit from 1 to 9.

Address inventory to Bucket to get a list of what Bucket contains.

You can give Bucket new items by making a message that follows the basic patterns outlined below. (Replacing {item} with the object you wish to give to Bucket.)

/me puts {item} in Bucket.
/me gives Bucket {item}
/me gives {item} to Bucket

Bucket will ignore your attempt to keep an item in him if the line ends with a question mark. Bucket will also ignore your attempt to keep an item in him if the message contains the word to.

Bucket will replace the word his or her with {nick}'s, with {nick} being the nick of the person giving him the item. Example: /me gives Bucket his banana would add <nick>' banana to Bucket's inventory. Bucket will not accept duplicate items.

Ops can delete items from the inventory (which will also stop them from ever being automatically created) using the detailed inventory and delete item #X commands.

This is a table of the five types of genders that you can choose and what pronouns are associated with them:

• The male set of pronouns uses the traditionally male pronouns, "he", "him" and "himself".
• The female set of pronouns uses the traditionally female pronouns, "she", "her" and "herself".
• The androgynous set of pronouns uses the gender neutral singular they, "they", "them" and "themself".
• The inanimate set of pronouns uses the gender neutral "it", often used on inanimate objects, "it" "its" and "itself".
• The Full name set of…"pronouns" simply uses the user's name.

You can set your own gender by addressing I am {gender} to Bucket, replacing {gender} with the gender of your choice.

You can ask what is the gender of another user by asking what gender is {username}.

The following variables can be used in factoids, and will use the correct pronoun if a factoid contains $someone or $who.

The following configuration variables are available when the appropriate plugin is loaded:

All editable variables are currently protected, which means they cannot be edited by normal users.

Parts of speech

• $adjective
• $adverb
• $article
• $noun
• $preposition
• $soiafpreposition
• $verb

People

• $band
• $op
• $celebrity

Places

• $country
• $room
• $state
• $place

Things

• $bodypart
• $color
• $ejaculation
• $gait
• $mood
• $occupation
• $profession
• $official
• $vehicle
• $weekday

Critters

• $animal
• $op
• $pokemon

Numbers

• $digit
• $nonzero
• $hex

Address list vars to Bucket to get a list of known variables that are editable.

You can get all the values in a variable by using list var {variable} with {variable} being replaced by the variable you wish to see.

• :: Bucket will display a link to the list of variables if there are too many variables to list. (Similar to literal[*])

Addressing add value {variable} {value} (replace {variable} with the variable you wish to add to and replace {value} with the thing you wish to add to the variable) to Bucket will add a value to that variable.

remove value {variable} {value} (again, replace {variable} with the variable you wish to remove from and replace {value} with the thing you wish to remove from the variable).

var {variable} type {var|verb|noun} Sets the "type" of a variable. Verb type variables can accept a "-ing" and "-ed" and "-s" suffix, while noun types can accept "-s" and update the "a/an" prefix. You can see whether a variable what type a variable is by using "list vars" and checking if there is a "(n)" for noun-types or a "(v)" for verb-types behind the variable.

X is Y
X are Y (plural)
X <reply> Y
X <action> Y
X <<verb>> Y

Where <verb> is some verb, for example: X <drinks> Y. It lets you use a verb that isn't "is" or "are"!

• literal X gives the first few factoids for X
• literal[#] X pages through the next factoids for X
• literal[*] X dump out all the factoids for X to a URL
• list items or inventory lists out the current inventory.

Pick a factoid at random from the factoids of X that includes phrase:

X =~ /phrase/

Bucket will replace the first instance of a it finds with b in the factoid called X:

X =~ s/a/b/

Or, undo last will undo the last modification made (only works if it was done by the same user who calls undo)

$who

when a factoid is triggered, all instances of this keyword will be substituted for by the nick of whomever triggers the factoid.

$someone

replaces with the nick of a random person who may or may not be in channel at the time.

$item

replaces with a random item in his inventory.

$giveitem

replaces with a random item in his inventory, and deletes that item.

shut up

stop talking in channel for one minute.

stats

Give some numbers on what Bucket knows and has learned. The totals update every 10 minutes or so.

something random

Show a random factoid.

what was that?

will respond with the factoid related to the last tidbit uttered.

list vars

show all the defined variables

list var {variable}

show all the values of a variable (or at least as many as would fit in one line)

add value {variable} {value}

add a new value to the already defined variable (only if it's unprotected)

remove value {var} {value}

remove value <value> from variable (only if it's unprotected)

remember {nick} {snippet}

Look in the last few lines in channel for a line containing the partial line mentioned. If found, add it to a nick quotes factoid in the form of <{nick}> {line that was found}. The number of lines remembered per channel is controlled by the history_size parameter.

I am {gender}

Tell bucket what gender he should use to refer to you. See the gender docs for complete details.

what is my gender?

Ask bucket to report your gender.

restore topic

Ask Bucket to restore the previous topic in the current channel, if possible.

how many syllables in {word}?

Find the number of syllables Bucket believes to be in the word, as used to find haiku.