# discord-quiz

> A package built ontop of Discord.js to make creating quiz commands much easier!

Latest version **1.0.6** (published 2022-11-24) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2022-11-24 |
| First published | 2021-01-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | SkyMocha |
| Maintainers | skymocha |
| Keywords | Discord.js, Discord, Quiz, Command |

## Links

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

## Dependencies (1)

- [discord.js](https://npm.io/package/discord.js.md) ^13.7.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.6 (latest) — 2022-11-24
- 1.0.5 — 2022-06-01
- 1.0.4 — 2021-01-22
- 1.0.3 — 2021-01-22
- 1.0.2 — 2021-01-22
- 1.0.1 — 2021-01-22
- 1.0.0 — 2021-01-22

## README

# Discord Quiz

An NPM package to help create simple quizzes for Discord bots.
By SkyMocha.

**NOTE**: This package was originally built on v.11 and updated for v.12 so it may not work on versions beyond v.12 (my favorite version <3).If this doesn't fit your fancy, maybe try implementing a command to send Mastodon toots via Discord using [tootcord](https://www.npmjs.com/package/tootcord). Consider supporting me by following me on [Mastodon](https://m.skymocha.net/@skymocha), [YouTube](https://www.youtube.com/@skymochi64) (where I primarily do video-essays), [TikTok](https://www.tiktok.com/@skymochi64) or even supporting me on [Patreon](https://www.patreon.com/skymocha)!

## Installation

```bash
npm i discord-quiz
```

## Usage

```javascript
const Discord = require ('discord.js');
const dquiz = require ('discord-quiz');
const client = new Discord.Client();

// Adds a question to the pool of available questions
dquiz.add_question('When was the war of 1812?', '1812', ['1800', '2020', '777']);

client.on ('message', (message) => {
    if (message.content.toLowerCase().startsWith('!quiz'))
        dquiz.quiz(message, 10, 'ffb7c5'); // Runs the quiz command
}) 

client.login (<your token>);
```

## Documentation
**void** add_question(**String** *question*, **String** *correct_answer*, **String[]** *false_answers*)

**void** quiz(`Discord Message`, `Time in Seconds`, `Hex Code`)

## License
[ISC](https://choosealicense.com/licenses/isc/)

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