https://github.com/Kraigie/nostrum
Elixir Discord Library
https://github.com/Kraigie/nostrum
bot discord discord-api discord-bot discordapp elixir library nostrum
Last synced: about 1 month ago
JSON representation
Elixir Discord Library
- Host: GitHub
- URL: https://github.com/Kraigie/nostrum
- Owner: Kraigie
- License: mit
- Created: 2016-08-26T21:18:34.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-09T07:58:33.000Z (about 1 month ago)
- Last Synced: 2025-03-09T08:20:33.431Z (about 1 month ago)
- Topics: bot, discord, discord-api, discord-bot, discordapp, elixir, library, nostrum
- Language: Elixir
- Homepage: https://kraigie.github.io/nostrum/
- Size: 108 MB
- Stars: 649
- Watchers: 13
- Forks: 132
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- discord-api-libs - nostrum - Elixir Discord Library (Libraries / Elixir)
- awesome-discord - Nostrum
- awesome-discord-bot-tools - Nostrum - An Elixir library for the Discord API. (Libraries / Elixir)
- awesome-discord-bot-tools - Nostrum - An Elixir library for the Discord API. (Libraries / Elixir)
README
# Nostrum
[](https://github.com/Kraigie/nostrum/actions)
[](https://discord.gg/2Bgn8nW)
[](https://hex.pm/packages/nostrum/)
An [Elixir](http://elixir-lang.org/) library for the Discord API. nostrum
supports the following:
- Clean REST API implementation and ratelimiting.
- Documented structs and abstractions over API objects.
- Automatic, configurable maintenance of local caches of Discord data, with
cache swapping functionality.
- Ability to run multiple bots.
- Support for multi-node distribution of caches and internal state, including
live migration of bots between nodes.
- Listening and sending voice data, with helpers for common functionality.
It is highly recommended to check out the [release
documentation](https://hexdocs.pm/nostrum/) first. It includes all of the
information listed here and more. **This README is for the master branch**,
which includes recent developments and may be unstable. If you want to live on
the edge regardless, you can check the [pre-release
documentation](https://kraigie.github.io/nostrum/).
## Installation
It is recommended to use a **stable** release by specifying a published
version from Hex:
```elixir
def deps do
[{:nostrum, "~> 0.10"}]
end
```
For stable installations, documentation can be found at
https://hexdocs.pm/nostrum. However, if you want the latest changes and help
test the library, you can also install directly from GitHub:
```elixir
def deps do
[{:nostrum, github: "Kraigie/nostrum"}]
end
```
Documentation for master can be found at https://kraigie.github.io/nostrum/.
See the [intro guide (master)](https://kraigie.github.io/nostrum/intro.html) or
the [intro guide for the stable release](https://hexdocs.pm/nostrum/intro.html)
to learn how to get started with your bot.
> **Note:** Due to Discord API changes, _in order to receive message content_ (e.g.
for non-slash commands or moderation tools), you need to have the "Message
Content Intent" enabled on your [Bot's application
settings](https://discord.com/developers/applications/), and the
`:message_content` intent specified in the `:intents` bot option.
For more information about the differences between dev and stable as well as
additional config parameters, please see the
[documentation](https://kraigie.github.io/nostrum/).
## Example Usage
The below module needs to be defined and configured as your bot's consumer to capture
events. See [here](https://github.com/Kraigie/nostrum/blob/master/examples/event_consumer.ex)
for a full example.
```elixir
defmodule ExampleConsumer do
@behaviour Nostrum.Consumer
alias Nostrum.Api.Message
def handle_event({:MESSAGE_CREATE, msg, _ws_state}) do
case msg.content do
"ping!" ->
Message.create(msg.channel_id, "I copy and pasted this code")
_ ->
:ignore
end
end
end
```
You can define and start your bot under your application supervision tree:
```elixir
defmodule MyApp.Application do
use Application
def start(_type, _args) do
bot_options = %{
consumer: ExampleConsumer,
intents: [:direct_messages, :guild_messages, :message_content],
wrapped_token: fn -> System.fetch_env!("BOT_TOKEN") end
}
children = [{Nostrum.Bot, bot_options}]
Supervisor.start_link(children, strategy: :one_for_one)
end
end
```
You may also start bots dynamically at runtime from `iex`:
```elixir
iex()> bot_options = %{
...()> consumer: ExampleConsumer,
...()> intents: [:direct_messages, :guild_messages, :message_content],
...()> wrapped_token: fn -> System.fetch_env!("BOT_TOKEN") end
...()> }
iex()> Supervisor.start_link([{Nostrum.Bot, bot_options}], strategy: :one_for_one)
{:ok, #PID<0.208.0>}
```
## Getting Help
If you need help, visit `#elixir_nostrum` on the unofficial Discord API guild!
[](https://discord.gg/2Bgn8nW)
## Testimonials
> my first choice is always nostrum
>
> **- big nutty, javascript developer**
> i would feed my baby the latest nostrum release
>
> **- also big nutty**
> i've used nostrum for 6 years and i have never been let down. [...]
>
> **- Broman, Discord API Expert**
## License
[MIT](https://opensource.org/licenses/MIT)