view plugins/ask/ask.md @ 817:ebe561276c33

doc: start reworking, continue #752 @8h
author David Demelier <markand@malikania.fr>
date Mon, 19 Nov 2018 07:04:42 +0100
parents c143682678b9
children
line wrap: on
line source

# Ask plugin

The plugin **ask** is funny script that helps you in your life. It will tells
you if you will be rich, famous and so on.

# Installation

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

```ini
[plugins]
ask = ""
```

## Usage

The plugin **ask** reacts to special command, you just need to do
`!ask the question` and it will give you a response.

## Example

```nohighlight
markand: !ask will I be rich?
irccd: markand, No.
```

## File

By default, **ask** will only answer yes or no. It's possible to add any answers
you want in the file **answers.conf** located in the ask configuration
directory.

Just add one line per answer like this (e.g. ~/.config/irccd/plugin/ask/answers.conf).

```nohighlight
Stop dreaming,
Definitely sure!
Maybe
```

## Configuration

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

- file: (string) the path to the database file (Optional, default: answers.conf
        in configuration directory).