https://github.com/mplewis/discosay

Build auto-responding Discord bots.
https://github.com/mplewis/discosay

Last synced: 2 months ago
JSON representation

Build auto-responding Discord bots.

• Host: GitHub
• URL: https://github.com/mplewis/discosay
• Owner: mplewis
• License: mit
• Created: 2019-09-04T03:32:23.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-08-30T14:01:26.000Z (over 1 year ago)
• Last Synced: 2024-06-19T19:34:02.038Z (7 months ago)
• Language: Go
• Homepage:
• Size: 161 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Discosay

Build auto-responding Discord bots.

# Usage

All configuration is done via environment variables:

| Name                     | Example                                     | Description                                                                                |

| ------------------------ | ------------------------------------------- | ------------------------------------------------------------------------------------------ |

| `CONFIG_PATH`            | `/path/to/my/config.yaml`                   | The path to a YAML config file for Discosay.                                               |

| `CONFIG_URL`             | `http://example.com/path/to/my/config.yaml` | A URL that returns a YAML config file for Discosay. (You must specify either path or URL.) |

| `CONFIG_UPDATE_INTERVAL` | `15`                                        | If set, polls for config updates at the given interval, in seconds.                        |

| `DEBUG`                  | `1`                                         | Set to enable debug-level logging.                                                         |

## Config Structure

The config file is structured as shown:

```yaml

templates:

  danger: |

    ####################

    DANGER DANGER DANGER

    ####################

    $MSG

    ####################

    DANGER DANGER DANGER

    ####################

bots:

  rolldice:

    - rolld6

  lostinspace:

    - dangerwill

    - dangersay

responders:

  rolld6:

    match: "^!rolld6$"

    responses:

      - You rolled a 1

      - You rolled a 2

      - You rolled a 3

      - You rolled a 4

      - You rolled a 5

      - You rolled a 6

  dangersay:

    match: "^!dangersay (.+)$"

    template: danger

  dangerwill:

    match: '\bdanger\b'

    probability: 0.1

    template: danger

    responses:

      - Danger, Will Robinson!

```

- `templates`: A `dict[str: str]` of named templates that responders can optionally use.

- `bots`: A `dict[str: array[str]]` of bots and the named responders they use.

- `responders`: A `dict[str, dict]` of responders that bots use.

  - `match`: A regex string. If this regex matches a message, the responder will reply in the channel. If this regex has a capture group, it will be used as the reply.

  - `responses`: Optional. An `array[str]` of possible responses. If provided, the responder selects one of these as the reply.

  - `template`: Optional. String. If provided, the reply message is injected into this template in place of the string `$MSG`.

  - `case_sensitive`: Optional. Bool. Defaults to true. If false, the `match` regex will match regardless of case.

  - `delete_parent`: Optional. Bool. If true, this responder deletes the parent message after responding.

  - `probability`: Optional. Float from 0.0 to 1.0. Defaults to 1.0 (100%). If provided, this is the probability this responder will send a reply for a message it matches.