Skip to main content

Welcome

Sapphire Logo

Discord server NPM version NPM downloads Patreon PayPal

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

Optional packages

Official Plugins

Official Utilities and configurations

Example usage

const { SapphireClient } = require('@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.