Skip to content
This repository has been archived by the owner on Nov 27, 2020. It is now read-only.
/ ezdrb Public archive

Write Discord bots faster (Discordrb-only).

License

Notifications You must be signed in to change notification settings

greenbigfrog/ezdrb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Apparently the orginal creator deleted their account and repos. This only exists for archival purposes, and shouldn't really be used.

Ezdrb

Write Discord bots faster (Discordrb-only).

Install

$ gem install ezdrb

Usage

$ ezdrb <command>

Commands available

  • help [command]: Lists all commands available.
  • event <event>: Creates new event handler (see all available events: https://www.rubydoc.info/github/meew0/discordrb/Discordrb/EventContainer)
  • init: Creates a new bot in the current directory (recommended: run this in an empty directory)
  • command <command>: Creates a new bot command. You can find all bot commands in the commands/ directory.

Example

1. Create the bot:

$ mkdir my-awesome-bot && cd "$_"
$ ezdrb init
Creating new EZDRB project...

Set prefix: ++
Set token: 123456789

By running ls you should get this structure:

$ ls
Attributes.rb  bot.rb  commands/  Commands.rb  config/

2. Add commands to the bot:

$ ezdrb command ping

All available commands are in config/commands.yml:

$ cat config/commands.yml
commands:
- ping

3. Edit commands:

$ vim commands/Ping.rb. You should get something like this:

class Ping

  def activate(bot)
    bot.command :ping do |event|
      puts "pong!"
    end
  end

end

Ping.new

Write your command script inside the bot.command block.

4. Add event handlers to the bot:

$ ezdrb event channel_create

All bot handlers are stored in config/events.yml:

$ cat config/events.yml
events:
- Channel_create

See all available events here.

5. Edit handlers

$ vim commands/Channel_create.rb. You should get something like this:

class Channel_create

  def activate(bot)
    bot.channel_create do |event|
      puts "channel has been added"
    end
  end

end

Channel_create.new

Write what your bot should do when the event is triggered inside the bot.channel_create block.

6. Run the bot:

Run bot.rb:

$ ruby bot.rb

To do

  • delete a bot command
  • add events
  • remove events
  • run the bot from ezdrb
  • use erb for code generation

License

The gem is available as open source under the terms of the MIT License.

About

Write Discord bots faster (Discordrb-only).

Resources

License

Stars

Watchers

Forks

Packages