Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jchristgit/nosedrum
a command framework for nostrum
https://github.com/jchristgit/nosedrum
discord discord-api discord-bot elixir library nostrum
Last synced: about 2 months ago
JSON representation
a command framework for nostrum
- Host: GitHub
- URL: https://github.com/jchristgit/nosedrum
- Owner: jchristgit
- License: isc
- Created: 2019-02-03T13:06:39.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T17:04:06.000Z (8 months ago)
- Last Synced: 2024-04-29T18:27:13.945Z (8 months ago)
- Topics: discord, discord-api, discord-bot, elixir, library, nostrum
- Language: Elixir
- Homepage: https://hexdocs.pm/nosedrum/Nosedrum.html
- Size: 271 KB
- Stars: 32
- Watchers: 2
- Forks: 10
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nosedrum
`nosedrum` is a command framework for use with the excellent
[`nostrum`](https://github.com/Kraigie/nostrum) library.
It contains behaviour specifications for easily implementing command handling
for both Discord's application commands and the traditional text-based
commands in your bot along with other conveniences to ease creating an
interactive bot.
`nosedrum`s provided implementations are largely based off what was originally
written for [bolt](https://github.com/jchristgit/bolt). bolt also contains
around [57
commands](https://github.com/jchristgit/bolt/tree/master/lib/bolt/cogs) based
off the `Nosedrum.TextCommand` behaviour that you can explore if you're looking
for inspiration.
The application command related parts of the framework consist of two parts:
- `Nosedrum.ApplicationCommand`, the behaviour that all application commands
must implement.
- `Nosedrum.Storage`, the behaviour for any slash command storage. A default
implementation provided by nosedrum resides at `Nosedrum.Storage.Dispatcher`.
The traditional command processing related parts of the framework consists of
three parts:
- `Nosedrum.TextCommand`, the behaviour that all commands must implement.
- `Nosedrum.TextCommand.Invoker`, the behaviour of command processors. Command processors
take a message, look it up in the provided storage implementation,
and invoke commands as required. nosedrum ships with an implementation of
this based on bolt's original command parser named `Nosedrum.TextCommand.Invoker.Split`.
- `Nosedrum.TextCommand.Storage`, the behaviour of command storages. Command storages
allow for fast and simple lookups of commands and command groups and store
command names along with their corresponding `Nosedrum.TextCommand`
implementations internally. An ETS-based command storage implementation is
provided with `Nosedrum.TextCommand.Storage.ETS`.
Additionally, the following utilities are provided:
- `Nosedrum.Converters`, functions for converting parts of messages to objects
from Nostrum such as channels, members, and roles.
- `Nosedrum.MessageCache`, a behaviour for defining message caches, along with
an ETS-based and an Agent-based implementation.
The documentation can be found at https://hexdocs.pm/nosedrum.
## Installation
Simply add `:nosedrum` to your `mix.exs`:
```elixir
def deps do
[
{:nosedrum, "~> 0.5"},
]
end
```
If you want to install the GitHub version of Nostrum, you will need to specify
it with `override: true` in your `mix.exs`, for example:
```elixir
def deps do
[
{:nosedrum, "~> 0.5"},
{:nostrum, github: "Kraigie/nostrum", override: true}
]
end
```