Skip to content

Latest commit

 

History

History
62 lines (48 loc) · 1.99 KB

README.md

File metadata and controls

62 lines (48 loc) · 1.99 KB

Discord Soundboard Framework

Installation

npm i discord-soundboard

Usage

const Soundboard = require('discord-soundboard');
const soundboard = new Soundboard('BOT_TOKEN');

Constructor Parameters

Soundboard(token, title, prefix, info)

Required

token - Bot token from Discord dev portal

Optional

title - Name of soundboard. Primarily for the help

prefix - Prefix to trigger bot. Default is -

info - JSON file for the audio information. Default is info.json.

info.json

A JSON file for the audio information is required. By default this file is info.json located in the root directory.

info.json is required to have two entires. blocks which is an array, and audio, which is an object of arrays.

Structure

{
  // categories for audio files
  "blocks":["category1", "category2"],
  
  // audio files
  "audio":{
    "category1": ["file1", "file2"],
    "category2": ["file3", "file4", "file5"]
  }
}

To better illustrate this, here are some example commands:

  • -category1 - plays a random audio clip from array category1
  • -category2 file5 will specifically play the audio file named file5 from category2

This file is processed on service start. Any changes to info.json requires a restart of the service.

/audio

This is where the audio files are saved. By default the /audio folder is in the root directory. This cannot be changed. File structure should be the same as the structure in info.json where the categories are the folders. folders and audio names must match what is in info.json Currently only .mp3 files are supported.

I finished the soundboard...now what?

The service must be running in order for the bot to work in discord. You can set this up on your local machine or a cloud computing service like Vultr.

Bugs

If you encounter any bugs/weird errors, please create an issue here.