# discord-graf

> A framework for Discord bots to use

Latest version **0.15.4** (published 2017-02-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install discord-graf
pnpm add discord-graf
yarn add discord-graf
bun add discord-graf
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.15.4 |
| Published | 2017-02-01 |
| First published | 2016-08-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.0.0 |
| Dependencies | 9 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 20 |
| Author | Schuyler Cebulskie |
| Maintainers | gawdl3y |
| Keywords | discord, bot |

## Links

- npm: https://www.npmjs.com/package/discord-graf
- Repository: https://github.com/Gawdl3y/discord-graf
- Homepage: https://github.com/Gawdl3y/discord-graf#readme
- Issues: https://github.com/Gawdl3y/discord-graf/issues
- npm.io page: https://npm.io/package/discord-graf

## Dependencies (9)

- [semver](https://npm.io/package/semver.md) ^5.3.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.7.0
- [request](https://npm.io/package/request.md) ^2.79.0
- [winston](https://npm.io/package/winston.md) ^2.3.0
- [discord.js](https://npm.io/package/discord.js.md) ^11.0.0
- [common-tags](https://npm.io/package/common-tags.md) ^1.4.0
- [node-localstorage](https://npm.io/package/node-localstorage.md) ^1.3.0
- [escape-string-regexp](https://npm.io/package/escape-string-regexp.md) ^1.0.0
- [request-promise-native](https://npm.io/package/request-promise-native.md) ^1.0.3

## Recent versions

- 0.15.4 (latest) — 2017-02-01
- 0.15.3 — 2016-12-07
- 0.15.2 — 2016-12-05
- 0.15.1 — 2016-12-05
- 0.15.0 — 2016-10-27
- 0.14.6 — 2016-10-01
- 0.14.5 — 2016-09-29
- 0.14.4 — 2016-09-22
- 0.14.3 — 2016-09-19
- 0.14.2 — 2016-09-17
- 0.14.1 — 2016-09-17
- 0.14.0 — 2016-09-17
- 0.13.3 — 2016-09-17
- 0.13.2 — 2016-09-17
- 0.13.1 — 2016-09-13
- … 56 more at https://npm.io/package/discord-graf/versions

## README

# Discord GRAF
[![Discord](https://discordapp.com/api/guilds/214147099133083659/embed.png)](https://discord.gg/a5ZD9n7)
[![Downloads](https://img.shields.io/npm/dt/discord-graf.svg)](https://www.npmjs.com/package/discord-graf)
[![Version](https://img.shields.io/npm/v/discord-graf.svg)](https://www.npmjs.com/package/discord-graf)
[![Dependency status](https://david-dm.org/Gawdl3y/discord-graf.svg)](https://david-dm.org/Gawdl3y/discord-graf)
[![License](https://img.shields.io/npm/l/discord-graf.svg)](LICENSE)

**GRAF:** Great Rad-Ass Framework

This is a framework for Discord bots to use that makes it stupidly easy to build a bot with Node.js.  
It is written in ES2017 using Babel, and is built on top of [discord.js v10](https://github.com/hydrabolt/discord.js/).

## Features
GRAF contains loads of functionality that any bots built on it can use.
Here's a quick list:
- Command framework (probably the most robust command system of any bot)
	* Plain names and aliases
	* Robust argument parsing (with "quoted strings" support)
	* Regular expression triggers
	* Multiple responses
	* Command editing
- Module system (allows you to disable modules and individual commands per server)
- Admin/moderator permissions (moderators are configurable)
- Channel restrictions (allow the bot to operate only in specific channels in a server)
- Storages to associate arbitrary data with a server
- Configurable command prefix (change the trigger for commands)
- Help system and detailed about command
- Eval command with a system for registering your own objects to make available in its scope, and some utilities
- Lots of utility methods to simplify your logic
- Update checking for your bot
- Stats sending to Carbon and bots.discord.pw

## Documentation
The documentation is a work-in-progress.
You may view it [here](https://gawdl3y.github.io/discord-graf/manual/index.html).  
You may also take a look at other bots' source code to see how they use GRAF.

## Known bots using GRAF
- [RPBot](https://github.com/Gawdl3y/discord-rpbot)
- [Oh Please](https://github.com/datitisev/DiscordBot-OhPlease)
- [Moosik](https://github.com/Gawdl3y/discord-moosik)

---
_Source: https://npm.io/package/discord-graf · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._