Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sapphiredev/framework
Discord bot framework built on top of discord.js for advanced and amazing bots.
https://github.com/sapphiredev/framework
bot discord discord-bot-framework framework hacktoberfest
Last synced: 3 months ago
JSON representation
Discord bot framework built on top of discord.js for advanced and amazing bots.
- Host: GitHub
- URL: https://github.com/sapphiredev/framework
- Owner: sapphiredev
- License: mit
- Created: 2020-07-20T10:01:22.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-31T16:06:45.000Z (3 months ago)
- Last Synced: 2024-04-06T08:19:19.750Z (3 months ago)
- Topics: bot, discord, discord-bot-framework, framework, hacktoberfest
- Language: TypeScript
- Homepage: https://www.sapphirejs.dev/
- Size: 17.1 MB
- Stars: 604
- Watchers: 14
- Forks: 69
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Lists
- awesome-discord - Sapphire - Discord bot framework built on top of discord.js. (Misc Resources)
- discord-api-libs - framework - Discord bot framework built on top of discord.js for advanced and amazing bots. (Libraries / TypeScript)
README
# Sapphire
**A pleasant Discord Bot framework**
[](https://github.com/sapphiredev/framework/blob/main/LICENSE.md)
[](https://codecov.io/gh/sapphiredev/framework)
[](https://www.npmjs.com/package/@sapphire/framework)
[](https://sapphirejs.dev/discord)
---
## Description
Sapphire is a Discord bot framework built on top of [discord.js] for advanced and amazing bots.
| [**Click here for the documentation and guides**](https://www.sapphirejs.dev/) |
| ------------------------------------------------------------------------------ |
## Features
- Written in TypeScript
- Command Handler, Arguments, Pre-conditions and Listeners Store
- Completely Modular and Extendable
- Advanced Plugins Support
- Supports many [plugins](https://github.com/sapphiredev/plugins)
- Full TypeScript & JavaScript support
## Installation
`@sapphire/framework` depends on the following packages. Be sure to install these along with this package!
- [`discord.js`](https://www.npmjs.com/package/discord.js)
You can use the following command to install this package, or replace `npm install` with your package manager of choice.
```sh
npm install @sapphire/framework [email protected]
```
---
## Buy us some doughnuts
Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!
We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.
| Donate With | Address |
| :-------------: | :-------------------------------------------------: |
| Open Collective | [Click Here](https://sapphirejs.dev/opencollective) |
| Ko-fi | [Click Here](https://sapphirejs.dev/kofi) |
| Patreon | [Click Here](https://sapphirejs.dev/patreon) |
| PayPal | [Click Here](https://sapphirejs.dev/paypal) |
## Contributors
Please make sure to read the [Contributing Guide][contributing] before making a pull request.
Thank you to all the people who already contributed to Sapphire!
[contributing]: https://github.com/sapphiredev/.github/blob/main/.github/CONTRIBUTING.md
[discord.js]: https://github.com/discordjs/discord.js