AlekEagle / oceanic.js-interactions

An interaction command handler for Oceanic.js

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Oceanic.js Interactions

IMPORTANT: This is a work in progress. It is NOT ready for production use.

Interactions made simple for Oceanic.js.

Installation

npm install oceanic.js-interactions

Usage

Coming soon, this will be here when the rest of the library is completed.

License

MIT

TODO

  • Slash commands.
    • Slash command interaction handling.
    • Command arguments.
    • Subcommands.
    • Subcommand groups.
    • Command permissions.
    • Guild scoped commands. (Commands that are only available in a specific guild.)
    • Unregistering commands.
      • Automatically unregister unused commands. (This won't be default behavior, but it will be an option.)
  • User commands. (Right clicking a user and selecting a command from the apps menu.)
  • Message commands. (Right clicking a message and selecting a command from the apps menu.)
  • Message components.
    • Message component interaction handling.
    • One-shot message components.
    • Persistent message components.
    • Action Rows.
    • Buttons. (Both buttons that trigger interactions and buttons that redirect to a URL.)
    • Select Menus. (Implemented, but not tested.)
  • Autocomplete interactions.
  • Modals.
    • Text Inputs (for modals).
  • Shims for interactions we handle. (to make it easier for the end user using our library)
    • Command interactions.
    • Message component interactions.
    • Autocomplete interactions.
    • Initial response message.
  • Include examples.
  • Documentation.
  • Tests.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

About

An interaction command handler for Oceanic.js

License:MIT License


Languages

Language:TypeScript 100.0%