Hyperion

Hyperion guide

Hyperion is a framework for building Discord bots with discord.js v15. You put commands, buttons, menus, modals, and event handlers in folders, and Hyperion loads them, deploys your commands, and routes every interaction to the right place. You write the parts that make your bot yours.

Hyperion is in beta until discord.js v15 has a stable release, so expect breaking changes between versions until 1.0.

New here? Start with getting started, then pick whatever your bot needs next.

Basics

  • Getting started: create a client and your first command.
  • Commands: slash commands, subcommands, and context menus.
  • Responding: replying, deferring, and what happens on errors.

Interactions

Validation

  • Guards: checks that run before your handler.
  • Typed input: validate command options and form fields with a schema.

Everything else

Packages

Optional packages that work with any discord.js bot, and fit Hyperion well.

  • JSX: embeds, buttons, layout messages, and forms as JSX. JSX with Hyperion keeps them as handler templates.
  • SQLite: keep data in SQLite with validated tables and key-value namespaces.

How-to

When something breaks

Looking for exact contracts, edge cases, or how something is implemented? The reference docs one folder up (docs/*.md) cover every detail.

On this page