{"name":"discord-soundbot","version":"1.6.0-dev","description":"A Soundboard for Discord","main":"dist/src/index.js","bin":{"soundbot":"dist/bin/soundbot.js"},"repository":{"type":"git","url":"git+https://github.com/markokajzer/discord-soundbot.git"},"keywords":["discord","bot","soundboard","voice","sounds","mp3","nodejs","typescript"],"author":{"name":"Marko Kajzer"},"license":"MIT","dependencies":{"awilix":"^4.2.2","discord.js":"11.5.1","fluent-ffmpeg":"^2.1.2","i18n":"^0.8.3","lowdb":"^1.0.0","node-opus":"^0.2.7","replace-in-file":"^4.1.3","ytdl-core":"^0.29.6","bufferutil":"^3.0.5","erlpack":"github:discordapp/erlpack","libsodium-wrappers":"^0.7.5"},"optionalDependencies":{"bufferutil":"^3.0.5","erlpack":"discordapp/erlpack","libsodium-wrappers":"^0.7.5"},"devDependencies":{"@types/fluent-ffmpeg":"2.1.2","@types/glob":"7.1.1","@types/i18n":"0.8.5","@types/jest":"^24.0.18","@types/lowdb":"1.0.7","@types/node":"10.14.6","@typescript-eslint/eslint-plugin":"^1.13.0","@typescript-eslint/parser":"^1.13.0","eslint":"^6.3.0","eslint-config-airbnb-base":"^13.2.0","eslint-config-prettier":"^6.2.0","eslint-plugin-import":"^2.18.2","eslint-plugin-jest":"^22.17.0","eslint-plugin-prettier":"^3.1.0","jest":"^24.9.0","prettier":"^1.18.2","ts-jest":"^24.0.2","typescript":"^3.6.2"},"engines":{"node":">=8.0.0"},"scripts":{"clean":"rm -rf dist","build":"tsc -p tsconfig.json","format":"prettier --config .prettierrc.yml --ignore-path .prettierignore --write '**/**.ts'","lint":"eslint --rulesdir ./vendor/rules/ -c .eslintrc.yml --ext ts .","postbuild":"node dist/lib/postbuild.js","serve":"node dist/bin/soundbot.js","start":"npm run build && npm run serve","translate":"node dist/lib/checkTranslations.js","rebuild":"npm run clean && npm run build","release":"npm run rebuild && npm run lint && npm run format"},"readme":"Discord Soundbot\n================\n\n[<img title=\"Join us on Discord\" src=\"https://discordapp.com/api/guilds/236732117524938754/widget.png?style=shield\">](https://discord.gg/JBw2BNx)\n\nA Soundboard Bot for Discord to play your favorite sounds or music. You can add and play sounds, ignore users, set an avatar and more!\n\nThis is a *self-hosted* bot which means that you have to install and start the bot yourself. This is due to the bot being heavily involved with voice functionality. But don't sweat it! You can find a thorough installation and configuration guide in this README!\n\nIf you still need any help *after reading this guide and the wiki*, or you want to stay tuned, feel free to [join my Discord server](https://discord.gg/JBw2BNx).\n\nHave fun!\n\n\n\n## Installation\n\n### General\n\nTo use this bot, you first have to create your own [Discord Application](https://discordapp.com/developers/applications). If you don't know how to do it, [this wiki page](../../wiki/Setting-up-a-Discord-Application) will guide you through every step of the way.\n\n\n### Configuration\n\nCheck `config/config.example.json` for an example configuration and create a new file `config.json` inside the `config` folder with your desired configuration. For a detailed description on all of the options, see [here](../../wiki/Configuration). Make sure to restart the bot whenever you change the configuration.\n\nTo learn how to edit the config while the bot is running, see [below](#changing-the-config).\n\n\n### Building\n\nThe bot can be installed manually, via Docker, or as an npm package. When not using Docker the bot needs at least **Node.js v8.0.0** or newer and **FFmpeg** for its voice functionality.\n\n#### Building manually\n\n+ Clone the repository.\n+ Install `yarn` with `npm install -g yarn`.\n+ Install the bot's dependencies with `yarn install`.\n+ Run the bot with `yarn start`.\n\nNeed more details? You can find more detailed installation guides for [Unix](../../wiki/Unix) (including your Raspberry Pi), [macOS](../../wiki/macOS), and [Windows](../../wiki/Windows).\n\n#### Building/Running via Docker\n\n+ Make sure to have Docker installed.\n+ Clone the repo and run `docker-compose build` inside the folder.\n+ If you do not already have one, create an empty `db.json` file.\n+ Afterwards start the bot via `docker-compose up`.\n+ To run the container in the background use `docker-compose up -d`.\n\n#### Using npm\n\nInstall the bot as a dependency using npm.\n\n```\n  $ npm install discord-soundbot\n```\n\nStart the bot.\n\n```js\nconst SoundBot = require('discord-soundbot');\n\nconst myBot = new SoundBot({\n  clientID: 'YOUR_CLIENT_ID',\n  token: 'YOUR_BOT_USER_TOKEN'\n});\nmyBot.start();\n```\n\nFor more configuration options see [here](../../wiki/Configuration). You can also add additional commands using this method, see [here](../../wiki/Commands).\n\n\n### Adding the bot to your server\n\nIn both cases the bot will print a message to your console which should look a little bit like this\n\n```\nUse the following URL to let the bot join your server!\nhttps://discordapp.com/oauth2/authorize?client_id={YOUR_CLIENT_ID}&scope=bot\n```\n\nFollow the link and allow the bot to join your Discord server.\n\nTry out the sample sounds `!airhorn` and `!johncena`, or see below to learn how to add your own sounds.\n\n\n## Commands\n\nType `!help` or `!commands` to print a list of available commands. To see the welcome message (again), use `!welcome`.\n\nYou can add, rename, download, tag, play, and remove sounds, ignore users, set the avatar, and more.\n\n*Note*: The commands `!rename`, `!remove`, `!tag <sound> clear`, `!ignore`, `!unignore`, `!avatar` and `!config` are restricted and can only be accessed by **administrators**.\n\n\n### Adding sounds\n\nYou can add sounds to the bot by typing `!add` and attaching a file. Accepted file formats and a limit to the size are configurable. The name of the sound can only contain alphanumeric characters.\n\nYou can instead also add a sound from YouTube with `!add <name> <link>`. A range in decimals can be specified with `!add <name> <link> <start> <duration>` where the duration is optional. Both the start time and the duration have to be specified as timestamp strings with the format [[hh:]mm:]ss[.xxx].\n\n### Playing sounds\n\nType `!sounds` to get a list of all sounds that are available to your bot. Play any sound by prefixing it with your prefix, e.g. `!rickroll`. Play a random sound with `!random`. You can specify a tag with `!random` to play a random sound with a specific tag.\n\nAll sounds will be added to a queue and played in succession. To halt the playback and empty the queue type `!stop`.\n\nYou can use `!combo <sound1> ... <soundN>` to add multiple sounds to the queue.\n\nYou can loop sounds by using `!loop <sound>`. To loop only a couple of times, use `!loop <sound> <times>`\n\nYou can skip the current sound with the `!skip` command. To interrupt the currently playing sound with a new one use `!next <sound>`.\n\n### Setting entrance sounds\n\nEvery user can set his own entrance sound, a sound that will play whenever the user joins a voice channel by using `!entrance <sound>`. To remove your entrance sound use `!entrance` without specifying a sound.\n\nThe same is possible for exit sounds with `!exit <sound>` which will play the specified sound when leaving a voice channel.\n\n### Tagging and searching sounds\n\nWhen your library of sounds gets too big and you forget what kinds of sounds you have, you can add tags to sounds.\n\nYou can add tags to sounds with `!tag <sound> <tag>`. You can specify one or more sounds. You can get the tags of a sound with `!tag <sound>`. You can also remove all tags from a sound with `!tag <sound> clear`.\n\nTo search for specific sounds use `!search <tag>`. It will look for the name of the sound as well as tags that you might have added to the sound.\n\nTo see all sounds with their respective tags use `!tags`.\n\n### Renaming sounds\n\nSounds can be renamed by using `!rename <old> <new>`. The bot will respond with a status update.\n\n### Removing sounds\n\nYou can delete sounds by typing `!remove <sound>`. The bot will respond with the status of the deletion in the channel of the message.\n\n### Downloading sounds\n\nYou can send existing sounds to chat with `!download <sound>` in case you do not have the files anymore.\n\n### Ignoring users\n\nUsers can be ignore from using **any** command by the `!ignore <user>` command while specifying their respective ID. The user will be mentioned by the bot in the channel of the message. Use `!unignore <user>` to allow the user to interact with the bot again.\n\n### Setting an avatar\n\nUse `!avatar` and attach an image to set the bot's avatar. You can remove the avatar to go back to the default by using the optional `remove` parameter as in `!avatar remove`.\n\n### Changing the config\n\nThe config can be changed by editing the `config.json` file, after which the bot needs to be restarted.\n\nTo change the config on the go, use `!config <option> <value>`. This will change the configuration immediately and update the configuration file.\n\n\n\n## Contributing\n\nThis bot is a dear passion project of mine. If you encounter any bugs, or have any suggestions for new features or improvements, feel free to open an issue or talk to me on Discord. I'll be glad to look into it!\n\nIn particular, thanks to these splendid lads for providing localization:\n\n+ Dutch, [@nstapelbroek](https://github.com/nstapelbroek)\n+ French, [@sipahius](https://github.com/hugoSip)\n+ Hungarian, [@alma](https://github.com/stroopwafel1337)\n+ Italian, [@Reckless](https://github.com/MarcoReckless)\n+ Spanish, [@ibito](https://github.com/ibito)\n+ Japanese, [@Sigmy](https://github.com/sigmy)\n","readmeFilename":"README.md","gitHead":"71034898b4d2e80a3f8dbcf204a1496ccc29ad32","bugs":{"url":"https://github.com/markokajzer/discord-soundbot/issues"},"homepage":"https://github.com/markokajzer/discord-soundbot#readme","_id":"[email protected]","_shasum":"181349592feb5e9d45938c6349dd8e3976f88052","_from":"../../root/dBot/discord-soundbot","_resolved":"file:../../root/dBot/discord-soundbot"}