# wumpy

> Wumpy is a minimal framework built on top of [discord.js](https://github.com/discordjs/discord.js).

Latest version **0.1.1** (published 2020-06-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install wumpy
pnpm add wumpy
yarn add wumpy
bun add wumpy
```

Provides the command `wumpy`.

## Health

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

Positive: has types; no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2020-06-26 |
| First published | 2020-06-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 14 |
| Unpacked size | 990.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ross Bratton |
| Maintainers | brattonross |
| Keywords | discord, javascript, bot, node |

## Links

- npm: https://www.npmjs.com/package/wumpy
- Repository: https://github.com/brattonross/wumpy
- Homepage: https://github.com/brattonross/wumpy/tree/master/#readme
- Issues: https://github.com/brattonross/wumpy/issues
- npm.io page: https://npm.io/package/wumpy

## Dependencies (14)

- [esm](https://npm.io/package/esm.md) ^3.2.25
- [dotenv](https://npm.io/package/dotenv.md) ^8.2.0
- [rollup](https://npm.io/package/rollup.md) ^2.16.1
- [semver](https://npm.io/package/semver.md) ^7.3.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.1
- [hash-sum](https://npm.io/package/hash-sum.md) ^2.0.0
- [commander](https://npm.io/package/commander.md) ^5.1.0
- [discord.js](https://npm.io/package/discord.js.md) ^12.2.0
- [lodash.template](https://npm.io/package/lodash.template.md) ^4.5.0
- [@rollup/plugin-alias](https://npm.io/package/@rollup/plugin-alias.md) ^3.1.1
- [@rollup/plugin-commonjs](https://npm.io/package/@rollup/plugin-commonjs.md) ^13.0.0
- [rollup-plugin-node-globals](https://npm.io/package/rollup-plugin-node-globals.md) ^1.4.0
- [@rollup/plugin-node-resolve](https://npm.io/package/@rollup/plugin-node-resolve.md) ^8.0.1
- [rollup-plugin-node-builtins](https://npm.io/package/rollup-plugin-node-builtins.md) ^2.1.2

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2020-06-26
- 0.1.0 — 2020-06-26

## README

# wumpy

Wumpy is a minimal framework built on top of [discord.js](https://github.com/discordjs/discord.js).

Inspired by the Next.js and Nuxt.js frameworks, wumpy uses a convention over configuration approach.

### Status

Please note that this project is still a work in progress, and the public api is likely to change a lot.

## Getting Started

Install `wumpy` in your project:

```bash
npm install wumpy
```

Add a build script to your `package.json`:

```json
"scripts": {
  "build": "wumpy build"
}
```

A wumpy bot doesn't do much without commands. A command is simply a function that is exported from a `.js` file in the `commands` directory.

By default, a command's trigger is based off of its file name. For example `commands/ping.js` will be triggered by a message starting with `!ping`.

Create a `commands` directory inside of your project, then create the `ping.js` file in the `commands` directory and populate it with the following:

```js
export function run(message) {
  message.channel.send('pong')
}
```

Build your app by running `npm run build`. This will build your app to the `out` directory.

You can then run your bot as you would any other node program. Run the following in your terminal:

```bash
node ./out/main.js
```

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