# kahoot-toolkit
> The easiest way to interact with Kahoot games. Flood games with bots, or even win one autonomously!
Latest version **1.0.1** (published 2022-04-13) · Apache-2.0 license · 0 weekly downloads
> **Deprecated.** This package is deprecated.
## Install
```sh
npm install kahoot-toolkit
pnpm add kahoot-toolkit
yarn add kahoot-toolkit
bun add kahoot-toolkit
```
Provides the commands `kahoot`, `kahoot-cli`, `kahoot-toolkit`.
## Health
**Score 10/100 (F)** — status: deprecated.
Negative: deprecated.
## Facts
| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-04-13 |
| First published | 2021-11-21 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 29.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | WillTDA |
| Maintainers | willtda |
## Links
- npm: https://www.npmjs.com/package/kahoot-toolkit
- npm.io page: https://npm.io/package/kahoot-toolkit
## Dependencies (6)
- [ws](https://npm.io/package/ws.md) ^8.2.3
- [got](https://npm.io/package/got.md) ^11.8.3
- [@inquirer/input](https://npm.io/package/@inquirer/input.md) ^0.0.17-alpha.0
- [@inquirer/select](https://npm.io/package/@inquirer/select.md) ^0.0.17-alpha.0
- [random-useragent](https://npm.io/package/random-useragent.md) ^0.5.0
- [kahoot.js-updated-fixed](https://npm.io/package/kahoot.js-updated-fixed.md) ^1.0.0
## Recent versions
- 1.0.1 (latest) — 2022-04-13
- 1.0.0 — 2021-11-21
## README
🎮 Kahoot Toolkit 🎮
[](https://npmjs.com/package/kahoot-toolkit)
[](https://npmjs.com/package/kahoot-toolkit) [](https://discord.gg/P2g24jp)
Kahoot Toolkit is the easiest way to interact with Kahoot games.
## Features
- 🌊 Flood Games | Spam join a Kahoot game with a customisable amount of bots.
- 🕹️ Win Games with Autoplay | Configure a bot to play a game for you and attempt to win it with a single function. This is the first time something like this has been published to NPM!
- 🖥️ Command Line Interface | Don't want to use code? No problem! Kahoot Toolkit has a CLI built in to do everything for you.
## Installation
There are two ways to install and use Kahoot Toolkit, either as a dependency in your project, or the CLI. Here are the commands to install them in both ways:
### **Install as a Dependency**
`npm i kahoot-toolkit --save`
### **Install CLI**
`npm i -g kahoot-toolkit`
## Example Code
Setting up Kahoot Toolkit is really easy. Simply import the package and create an instance of the Kahoot class!
```js
const Kahoot = require("kahoot-toolkit");
const client = new Kahoot("Game PIN Here", "Bot Name Here"); // If the bot name is not specified, it will be randomly generated.
```
To flood a game, you can use the `flood` method.
```js
client.flood(1000); // Floods the game with 1,000 bots.
// To avoid Kahoot's Anti-Cheat, you can set a second parameter to true.
client.flood(1000, true); // Floods the game with 1,000 bots, but uses randomly generated names for each bot.
```
To win a game autonomously, use the `autoplay` method.
```js
client.autoplay("Quiz Name or ID Here");
// To log any progress the bot makes, you can set a second parameter to true.
client.autoplay("Quiz Name or ID Here", true);
```
## CLI Usage
To open the CLI, simply type `kahoot-toolkit`, `kahoot-cli` or `kahoot` into your Terminal. You should be met with this prompt:
Simply choose which action you would like to perform to continue. Then, just follow the instructions and prompts!
### **Flooding a Game**
### **Winning a Game**
## Contact Me
- 👋 Need Help? [Join Our Discord Server](https://discord.gg/P2g24jp)!
- 👾 Found a Bug? [Open an Issue](https://github.com/WillTDA/Kahoot-Toolkit/issues), or Fork and [Submit a Pull Request](https://github.com/WillTDA/Kahoot-Toolkit/pulls) on our [GitHub Repository](https://github.com/WillTDA/Kahoot-Toolkit)!
---
_Source: https://npm.io/package/kahoot-toolkit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._