IRCCD-PLUGIN-JOKE(7) - Miscellaneous Information Manual

NAME

joke - irccd joke plugin

DESCRIPTION

The joke plugin is a convenient command to display jokes in a random order without displaying always the same.

It loads jokes per channel/server pair and display a unique joke each time it is invoked.

INSTALLATION

The plugin joke is distributed with irccd. To enable it add the following to your plugins section:

[plugins]
joke = ""

USAGE

The joke plugin requires a database of jokes file, it consists of a plain JSON file of array of array of strings.

Example of jokes.json file:

[
    [
        "Tip to generate a good random password:",
        "Ask a Windows user to quit vim."
    ],
    [
        "Have you tried turning it off and on again?"
    ]
]

This file contains two jokes, the first one will be printed on two lines while the second only has one.

Then, invoke the plugin:

markand: !joke
irccd: Have you tried turning it off and on again?
markand: !joke
irccd: Tip to generate a good random password:
irccd: Ask a Windows user to quit vim.

CONFIGURATION

The following options are available under the [plugin.joke] section:

file (string)

path to the JSON jokes files (Optional: defaults to data directory/jokes.json). Keywords: channel, server

Warning: if you use keywords in the **file** parameter, you won’t have a default joke database anymore.

TEMPLATES

The joke plugin supports the following templates in [templates.joke] section:

error

Template when an internal error occured. Keywords: channel, nickname, origin, server.

SEE ALSO

irccd(1), irccd-templates(7)

macOS 11.2 - @IRCCD_MAN_DATE@