zoku-fi/README.md

A simple tool to create lofi bot for discord server

# [✨] Zokuru Lofi
A simple tool to create lofi bot for discord server

## [☁️] What's in this package?
> This package contains a simple module that can help you create a lofi bot for your discord server

## [🌸] Start setup
### [❄️] Before you start..
Before you start using this package, make sure you:
* Have [NodeJS](https://nodejs.org) version 16.9 or higher
* Installing [ffmpeg](https://npmjs.com/package/ffmpeg) and [ffmpeg-static](https://npmjs.com/package/ffmpeg-static)
* Install [sodium](https://npmjs.com/package/sodium) or [libsodium-wrappers](https://npmjs.com/package/libsodium:-wrappers) for audio player

## [👨‍💻] Start making
* Step 1: First you have to import `LoFi` from this package.
```js
const { LoFi } = require("zoku-fi");
```
* Step 2: It's very very simple, you just have to enter the token and voice channel into LoFi
```js
const lofi = new LoFi({ token: "your-bot-token", channel: "voice-channel-id" });
```
<div align="center"><sub><strong>⚠️ WARNING ⚠️</strong></sub></div>
<div align="center"><sub><strong>If you're using an online IDE like replit or something like that, it's better if you put the token in the environment so that it doesn't get stolen by others</strong></sub></div>
* Step 3: Activating bots

> If you see `✨ | *your-bot-name* ready to sing`

That means the bot can already be used

# [💫] Install this package
```js
$ npm i zoku-fi@latest
```