Sha256: 9a80dc90bab608ff8004e178d591fac617335d8308fd23d4ad49b620e3079fb5

Contents?: true

Size: 1.66 KB

Versions: 1

Compression:

Stored size: 1.66 KB

Contents

# dispander.rb

An extension that adds message expanding feature for discorb bot.
![image](https://user-images.githubusercontent.com/59691627/131650571-ec50bf35-c971-4aeb-9a58-8fbf9b3e759b.png)

Ruby version of [DiscordBotPortalJP/dispander](https://github.com/DiscordBotPortalJP/dispander).

## Install

Add this to Gemfile...

```ruby
gem 'dispander'
```

And run this:

    $ bundle install

Or...

    $ gem install dispander

## Usage

### Load as Extension

```ruby
require "discorb"
require "discorb"
require "dispander"

client = Discorb::Client.new

client.once :standby do
  puts "Logged in as #{client.user}"
end

client.load_extension(Dispander::Core)

client.run ENV["DISCORD_BOT_TOKEN"]
```

### Expand Manually

`Dispander::Core#dispand` to expand, `Dispander::Core#delete_message` to delete message.

```ruby
require "discorb"
require "dispander"

client = Discorb::Client.new

dispander = Dispander::Core.new(client)

client.on :message do |message|
  next if message.author.bot?

  dispander.dispand(message)
end

client.on :reaction_add do |event|
  dispander.delete_message(event)
end

client.run ENV["DISCORD_BOT_TOKEN"]
```

### Change emoji of deletion

Set emoji to `Dispander#delete_emoji`, or specify it in `Client#load_extension`.

```ruby
client.load_extension(Dispander::Core, delete_emoji: Discorb::UnicodeEmoji["x"])
```

## Change the condition to expand

Override `Dispander#should_expand?`.

```ruby
dispander = Dispander::Core.new(client)

def dispander.should_expand?(base_message, ids)
  ENV["ALLOWED_GUILDS"].split(",").include?(ids[0])
end

client.load_extension(dispander)
```

## License

Source is open under [MIT License](https://opensource.org/licenses/MIT).

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
dispander.rb-0.4.2 README.en.md