Skip to main content

Welcome

Sapphire Logo

Discord server NPM version NPM downloads Patreon PayPal

danger

The @sapphire/framework API documentation section of this website is currently based on the main branch of @sapphire/framework. This means it will mention any breaking changes that are not yet released to NPM, including but not limited to support for Application Commands. In the grand scheme of things, this means that the API documentation may show properties, functions and classes that will not be available until the next major release of @sapphire/framework. That said, if you wish to use this next version of @sapphire/framework in your project, you can install it by using the @next tag from NPM.

npm install @sapphire/framework@next

We are working on fixing this by providing multiple versions of the documentation, similar to what you may be used to from the Discord.js website, however this fix will take some time to be released.

About

Sapphire is a next-gen object-oriented Discord.js bot framework.

Sapphire is a community driven framework that aims to give you all the features you need to make your Discord bot.

With a history of many other Discord bot frameworks (both for NodeJS and other languages) to inspire Sapphire, it has become the ultimate modern experience of writing your code.

Key Features

  • Advanced plugin support
  • Supports both CommonJS and ESM
  • Completely modular and extendable
  • Designed with first class TypeScript support in mind
  • Includes optional utilities that you can use in any project

Installation

Node.js 16.6.0 or newer is required.

npm install @sapphire/framework discord.js@v13-lts

Optional packages

Official Plugins

Official Utilities and configurations

Example usage

import { SapphireClient } from '@sapphire/framework';const client = new SapphireClient({ intents: ['GUILDS', 'GUILD_MESSAGES'] });client.login('your-token-goes-here');

Contributing

Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the documentation.

See the contribution guide if you'd like to submit a PR.

Help

If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official Sapphire Community Server.