Skip to content

bdanklin/remedy

Repository files navigation

remedy

Hex Version MIT License

Hex Version Hex Version Hex Version

Remedy is an elixir library for interracting with the Discord API. It supports both the events Gateway and REST API.

The project began as an experimental fork of the Nostrum library, which I have also contributed to from time to time. If you would like a more widely used and supported library check them out on Github or on the Unofficial Discord API Server

However as the scope of the changes grew it became clear that it was too much to push upstream into Nostrum and decided to release it separately. At the time of writing the entire library has been re-written. The primary interfaces will be familiar to anyone who has used Nostrum.

Installation

Add remedy to your deps.

defp deps() do
  [
    {:remedy, "~> 0.6.9"}
  ]
end

Configuration

This is the most basic configuration example.

config :remedy,
  token: "Nzg2NTkzNjUyMzAxMzY1MjQ5.X9IqbA.1sMfTqLa0C2fnWBcKNF865lsGpA"

For more advanced configuration see the guides.

Supporting Libraries

A number of issues plagued Discord libraries written in Elixir. Rather than wait for upstream fixes either from Cowlib, Gun or Discord respectively I have published patched versions of gun and cowlib which alleviate these issues. They are included by default, however if you encounter dependency clashes you should override them using the below libraries.

More information can be found in the documentation.

defp deps() do
  [
    ...
    {:gun, hex: :remedy_gun, "2.0.1"},
    {:cowlib, hex: :remedy_cowlib, "2.11.1"}
  ]
end

Links

License

MIT

About

Discord Library written in Elixir

Resources

Stars

Watchers

Forks

Contributors 42

Languages