An implementation of the Discord API using Ruby.
Quick links to sections
- Ruby 2.1+
- An installed build system for native extensions (on Windows, try the DevKit; installation instructions here)
This section only applies to you if you want to use voice functionality.
- A compiled libopus distribution for your system, anywhere the script can find it (on Windows, make sure it's named
- FFmpeg installed and in your PATH
On Linux, it should be as simple as running:
gem install discordrb
On Windows, to install discordrb, run this in a shell:
gem install discordrb
Run the ping example to verify that the installation works (make sure to replace the username and password in there with your own or your bots'!):
If you get an error like this when installing the gem:
ERROR: Error installing discordrb: The 'websocket-driver' native gem requires installed build tools.
You're missing the development kit required to build native extensions. Download the development kit here (scroll down to "Development Kit", then choose the one for Ruby 2.0 and your system architecture) and extract it somewhere. Open a command prompt in that folder and run:
ruby dk.rb init ruby dk.rb install
Then reinstall discordrb:
gem uninstall discordrb gem install discordrb
If you're having trouble getting voice playback to work:
You can make a simple bot like this:
require 'discordrb' bot = ::. token: '<token here>', application_id: 168123456789123456 bot.(with_text: 'Ping!') do |event| event.respond 'Pong!' end bot.run
This bot responds to every "Ping!" with a "Pong!".
You can find me (@meew0, ID 66237334693085184) on the unofficial Discord API server - if you have a question, just ask there, I or somebody else will probably answer you: https://discord.gg/0SBTUU1wZTWfFQL2
This section is for developing discordrb itself! If you just want to make a bot, see the Installation section.
After checking out the repo, run
bin/setup to install dependencies. You can then run tests via
bundle exec rspec spec. Make sure to run rubocop also:
bundle exec rubocop. You can also run
bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run
bundle exec rake install. To release a new version, update the version number in
version.rb, and then run
bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the
.gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/meew0/discordrb.
The gem is available as open source under the terms of the MIT License.