{"id":17290968,"url":"https://github.com/jchristgit/nosedrum","last_synced_at":"2025-04-10T19:10:40.643Z","repository":{"id":34148674,"uuid":"168946144","full_name":"jchristgit/nosedrum","owner":"jchristgit","description":"a command framework for nostrum","archived":false,"fork":false,"pushed_at":"2024-04-29T17:04:06.000Z","size":277,"stargazers_count":32,"open_issues_count":11,"forks_count":10,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-29T18:27:13.945Z","etag":null,"topics":["discord","discord-api","discord-bot","elixir","library","nostrum"],"latest_commit_sha":null,"homepage":"https://hexdocs.pm/nosedrum/Nosedrum.html","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jchristgit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-03T13:06:39.000Z","updated_at":"2024-04-29T18:27:25.888Z","dependencies_parsed_at":"2024-04-29T18:27:18.289Z","dependency_job_id":null,"html_url":"https://github.com/jchristgit/nosedrum","commit_stats":{"total_commits":135,"total_committers":6,"mean_commits":22.5,"dds":"0.24444444444444446","last_synced_commit":"bf68a55fc161b001d815aea098f6d83062101ac0"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jchristgit%2Fnosedrum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jchristgit%2Fnosedrum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jchristgit%2Fnosedrum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jchristgit%2Fnosedrum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jchristgit","download_url":"https://codeload.github.com/jchristgit/nosedrum/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248279602,"owners_count":21077407,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["discord","discord-api","discord-bot","elixir","library","nostrum"],"created_at":"2024-10-15T10:39:32.749Z","updated_at":"2025-04-10T19:10:40.623Z","avatar_url":"https://github.com/jchristgit.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nosedrum\n\n\u003c!-- MDOC !--\u003e\n\n`nosedrum` is a command framework for use with the excellent\n[`nostrum`](https://github.com/Kraigie/nostrum) library.\n\nIt contains behaviour specifications for easily implementing command handling\nfor both Discord's application commands and the traditional text-based\ncommands in your bot along with other conveniences to ease creating an\ninteractive bot.\n\n`nosedrum`s provided implementations are largely based off what was originally\nwritten for [bolt](https://github.com/jchristgit/bolt). bolt also contains\naround [57\ncommands](https://github.com/jchristgit/bolt/tree/master/lib/bolt/cogs) based\noff the `Nosedrum.TextCommand` behaviour that you can explore if you're looking\nfor inspiration.\n\nThe application command related parts of the framework consist of two parts:\n\n- `Nosedrum.ApplicationCommand`, the behaviour that all application commands\n  must implement.\n- `Nosedrum.Storage`, the behaviour for any slash command storage. A default\n  implementation provided by nosedrum resides at `Nosedrum.Storage.Dispatcher`.\n\nThe traditional command processing related parts of the framework consists of\nthree parts:\n\n- `Nosedrum.TextCommand`, the behaviour that all commands must implement.\n- `Nosedrum.TextCommand.Invoker`, the behaviour of command processors. Command processors\n  take a message, look it up in the provided storage implementation,\n  and invoke commands as required. nosedrum ships with an implementation of\n  this based on bolt's original command parser named `Nosedrum.TextCommand.Invoker.Split`.\n- `Nosedrum.TextCommand.Storage`, the behaviour of command storages. Command storages\n  allow for fast and simple lookups of commands and command groups and store\n  command names along with their corresponding `Nosedrum.TextCommand`\n  implementations internally. An ETS-based command storage implementation is\n  provided with `Nosedrum.TextCommand.Storage.ETS`.\n\nAdditionally, the following utilities are provided:\n\n- `Nosedrum.Converters`, functions for converting parts of messages to objects\n  from Nostrum such as channels, members, and roles.\n- `Nosedrum.MessageCache`, a behaviour for defining message caches, along with\n  an ETS-based and an Agent-based implementation.\n\nThe documentation can be found at https://hexdocs.pm/nosedrum.\n\n## Installation\n\nSimply add `:nosedrum` to your `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:nosedrum, \"~\u003e 0.5\"},\n  ]\nend\n```\n\nIf you want to install the GitHub version of Nostrum, you will need to specify\nit with `override: true` in your `mix.exs`, for example:\n\n```elixir\ndef deps do\n  [\n    {:nosedrum, \"~\u003e 0.5\"},\n    {:nostrum, github: \"Kraigie/nostrum\", override: true}\n  ]\nend\n```\n\n\u003c!-- vim: set textwidth=80 sw=2 ts=2: --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjchristgit%2Fnosedrum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjchristgit%2Fnosedrum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjchristgit%2Fnosedrum/lists"}