Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ljneon/patron
The cleanest discord.js and eris command framework.
https://github.com/ljneon/patron
bot discord discordjs nodejs
Last synced: 3 months ago
JSON representation
The cleanest discord.js and eris command framework.
- Host: GitHub
- URL: https://github.com/ljneon/patron
- Owner: LJNeon
- License: lgpl-2.1
- Created: 2017-06-29T00:08:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-10-08T17:09:12.000Z (about 3 years ago)
- Last Synced: 2024-05-23T00:27:39.466Z (8 months ago)
- Topics: bot, discord, discordjs, nodejs
- Language: JavaScript
- Homepage: https://ljneon.github.io/patron/
- Size: 1.73 MB
- Stars: 19
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## About
**Patron** is an efficient and maintainable command framework for [discord.js](https://github.com/hydrabolt/discord.js) and [Eris](https://github.com/abalabahaha/eris) that aims for true flexibility. Patron doesn't have a modified client, manage the message event for you, or clutter other libraries with extensions. Patron has full support for TypeScript, as well as ECMAScript Modules.
## Should I use Patron?
Patron isn't designed for beginners, but for those who want a highly flexible framework and fast development time. Bots with complex or many features will see higher maintainability and reusable code.
## Installation
Patron is available on NPM and can be installed easily.
```js
npm install patron
```
If you are using TypeScript (or rely on typings for code completion) you will need to use an additional command to properly set up typings. You need to have the Discord library installed beforehand. This command will need to be run again if you switch between libraries.
```js
npx patron --typings=eris // or 'discordjs'
```
## Documentation
Patron's API documentation is in [an `index.d.ts` file](https://github.com/LJNeon/patron/blob/master/types/index.d.ts) with detailed comments, and there's a [folder of guides](https://github.com/LJNeon/patron/blob/master/guides) explaining features with example code.