discordrb.glue-bot.xyz Open in urlscan Pro
89.40.3.123  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Index » File: README



Table of Contents

 1.  Quick links to sections
 2.  Introduction
 3.  Dependencies
     1. Voice dependencies
 4.  Installation
     1. With Bundler
     2. With Gem
        1. Linux / macOS
        2. Windows
     3. Installation Troubleshooting
 5.  Usage
 6.  Webhooks Client
     1. Usage
 7.  Support
 8.  Contributing
 9.  Development setup
 10. License


DISCORDRB



An implementation of the Discord API using Ruby.


QUICK LINKS TO SECTIONS

 * Introduction

 * Dependencies

 * Installation

 * Usage

 * Webhooks Client

 * Support

 * Development, Contributing

 * License

See also: Documentation, Tutorials


INTRODUCTION

discordrb aims to meet the following design goals:

 1. Full coverage of the public bot API.

 2. Expressive, high level abstractions for rapid development of common
    applications.

 3. Friendly to Ruby beginners and beginners of open source contribution.

If you enjoy using the library, consider getting involved with the community to
help us improve and meet these goals!

You should consider using discordrb if:

 * You need a bot - and fast - for small or medium sized communities, and don’t
   want to be bogged down with “low level” details. Getting started takes
   minutes, and utilities like a command parser and tools for modularization
   make it simple to quickly add or change your bots functionality.

 * You like or want to learn Ruby, or want to contribute to a Ruby project. A
   lot of our users are new to Ruby, and eventually make their first open source
   contributions with us. We have an active Discord channel with experienced
   members who will happily help you get involved, either as a user or
   contributor.

 * You want to experiment with Discord’s API or prototype concepts for Discord
   bots without too much commitment.

You should consider other libraries if:

 * You need to scale to large volumes of servers (>2,500) with lots of members.
   It’s still possible, but it can be difficult to scale Ruby processes, and it
   requires more in depth knowledge to do so well. Especially if you already
   have a bot that is on a large amount of servers, porting to Ruby is unlikely
   to improve your performance in most cases.

 * You want full control over the library that you’re using. While we expose
   some “lower level” interfaces, they are unstable, and only exist to serve the
   more powerful abstractions in the library.


DEPENDENCIES

 * Ruby >= 2.7 supported

 * An installed build system for native extensions (on Windows, make sure you
   download the “Ruby+Devkit” version of RubyInstaller)


VOICE DEPENDENCIES

This section only applies to you if you want to use voice functionality.

 * libsodium

 * A compiled libopus distribution for your system, anywhere the script can find
   it. See here for installation instructions.

 * FFmpeg installed and in your PATH


INSTALLATION


WITH BUNDLER

Using Bundler, you can add discordrb to your Gemfile:

gem 'discordrb'


And then install via bundle install.

Run the ping example to verify that the installation works (make sure to replace
the token and client ID in there with your bots’!):

To run the bot while using bundler:

bundle exec ruby ping.rb



WITH GEM

Alternatively, while Bundler is the recommended option, you can also install
discordrb without it.

LINUX / MACOS

gem install discordrb


WINDOWS

> Make sure you have the DevKit installed! See the
> Dependencies[https://github.com/shardlab/discordrb#dependencies] section)

gem install discordrb --platform=ruby


To run the bot:

ruby ping.rb



INSTALLATION TROUBLESHOOTING

See github.com/shardlab/discordrb/wiki/FAQ#installation for a list of common
problems and solutions when installing discordrb.


USAGE

You can make a simple bot like this:

require 'discordrb'

bot = Discordrb::Bot.new token: '<token here>'

bot.message(with_text: 'Ping!') do |event|
  event.respond 'Pong!'
end

bot.run


This bot responds to every “Ping!” with a “Pong!”.

See additional examples here.

You can find examples of projects that use discordrb by searching for the
discordrb topic on GitHub.

If you’ve made an open source project on GitHub that uses discordrb, consider
adding the discordrb topic to your repo!


WEBHOOKS CLIENT

Also included is a webhooks client, which can be used as a separate gem
discordrb-webhooks. This special client can be used to form requests to Discord
webhook URLs in a high-level manner.

 * documentation[https://drb.shardlab.dev/v3.4.0/Discordrb/Webhooks.html]

 * More information about webhooks

 * Embed visualizer tool - Includes a discordrb code generator for forming
   embeds


USAGE

require 'discordrb/webhooks'

WEBHOOK_URL = 'https://discord.com/api/webhooks/424070213278105610/yByxDncRvHi02mhKQheviQI2erKkfRRwFcEp0MMBfib1ds6ZHN13xhPZNS2-fJo_ApSw'.freeze

client = Discordrb::Webhooks::Client.new(url: WEBHOOK_URL)
client.execute do |builder|
  builder.content = 'Hello world!'
  builder.add_embed do |embed|
    embed.title = 'Embed title'
    embed.description = 'Embed description'
    embed.timestamp = Time.now
  end
end


Note: The discordrb gem relies on discordrb-webhooks. If you already have
discordrb installed, require 'discordrb/webhooks' will include all of the
Webhooks features as well.


SUPPORT

If you need help or have a question, you can:

 1. Join our Discord channel. This is the fastest means of getting support.

 2. Open an issue. Be sure to read the issue template, and provide as much
    detail as you can.


CONTRIBUTING

Thank you for your interest in contributing! Bug reports and pull requests are
welcome on GitHub at github.com/shardlab/discordrb.

In general, we recommend starting by discussing what you would like to
contribute in the Discord channel. There are usually a handful of people working
on things for the library, and what you’re looking for may already be on the
way.

Additionally, there is a chance what you are looking for might already exist, or
we decided not to pursue it for some reason. Be sure to use the search feature
on our documentation, GitHub, and Discord to see if this might be the case.


DEVELOPMENT SETUP

This section is for developing discordrb itself! If you just want to make a bot,
see the Installation[https://github.com/shardlab/discordrb#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.


LICENSE

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

Generated on Thu Jul 13 12:16:36 2023 by yard 0.9.34 (ruby-3.2.2).