https://github.com/butlerx/butlerbot-popping

https://github.com/butlerx/butlerbot-popping

Last synced: 15 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/butlerx/butlerbot-popping
• Owner: butlerx
• License: mit
• Created: 2017-11-26T11:38:13.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T10:07:31.000Z (about 2 years ago)
• Last Synced: 2024-10-31T22:12:07.274Z (2 months ago)
• Language: JavaScript
• Size: 195 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# popping

This plugin allows users to get links to popping related content

## Install

```

yarn add butlerbot-popping

```

Create a file in the plugin dir as follows

```js

import popping from 'butlerbot-pooping';

export default pop({

  development: {

    channels: ['#butlerbot'],

    channelsToExclude: [],

    channelsToJoin: ['#butlerbot'],

    reddit: {

      userAgent: 'irc-bot',

      refreshToken: 'Will Need to get your own',

      clientId: 'ZZifBCPKv9cUOQ',

      clientSecret: 'Get it your self',

    },

  },

  production: {

    channels: ['#butlerbot'],

    channelsToExclude: [],

    channelsToJoin: ['#butlerbot'],

    reddit: {

      userAgent: 'irc-bot',

      refreshToken: 'Will Need to get your own',

      clientId: 'ZZifBCPKv9cUOQ',

      clientSecret: 'Get it your self',

    },

  },

});

```

## Commands

- **!pop ** - gives a random link to something popping related

- **!pop [link]** - adds link to list of links

## Usage

### pop

To get a random link:

```

 !pop

 NSFW!(most likely) https://www.youtube.com/watch?v=rGBdeQfcjLU

```

To add a link:

```

!pop https://www.youtube.com/watch?v=rGBdeQfcjLU

```

## Configuration

# channels

This option contains a list of channels that the plugin should respond to commands it defines.

# channelsToExclude

This is an array of strings that the command should ignore commands in. Only used if the channels option is set to 'all'

# channelsToJoin

This is an array of channels that the bot should join. The cards against humanity plugin doesn't support playing the games in multiple channels, so this should only contain one entry.