Skip to content

sledgang/dex

Repository files navigation

dex

A Discord bot for discordrb.

The bot works by using the YARD gem to parse discordrb's documentation, wrapping it in a handful of classes to render the documentation in a concise format within Discord.

Running

Fill out a config.yml:

---
token: token
channels:
- 298822592104759307
- 83281822225530880
- 345687437722386433
owner: 120571255635181568

And run:

$ rake install
$ rake

Usage

dex.doc (alias: ?doc)

Looks up a class or method.

dex.doc Server#kick
?doc Server#ban
?doc API::Channel.resolve

dex.source (alias: dex.sauce, ?source, ?sauce)

Displays the source code of methods.

dex.source Channel#message
?source Server#kick
?sauce Message#delete

Method source code over 20 lines in length won't be displayed, only a link will be given.

dex.info

Shows bot info.

Contributors

  • z64 Zac Nowicki - creator