diff --git a/CHANGELOG.md b/CHANGELOG.md index 9ce1149c..bab009fc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,16 @@ +## 1.1.0 (2018-08-17) + ++ Added `!download` command ++ Added `!tags` command ++ Added `volume` configuration option ++ Added welcome message when bot first joins a server ++ Ignore `!` commands if sound does not exist ++ Remove all previous `!` messages when using `!stop` ++ `!sounds` does not try to send an empty message when no sounds exist ++ `!sounds` sends message in code blocks ++ `!sounds` and `!tags` are chunked if message is too large ++ Updated dependencies + ## 1.0.2 (2018-04-14) + Fixed bot not leaving channel on `!leave` @@ -19,9 +32,6 @@ + Tags are included in the `!search` command + Sanitize sound on `!add`, `!remove` + Restricted access to `!rename`, `!remove`, `!ignore`, `!unignore` - -##### Under the hood - + Moved to TypeScript + Complete rewrite + Removed `config` dependency @@ -79,6 +89,6 @@ + This fixed compatibility issues with the offical Discord API + Queueing sounds now also stores the channel in which a sound should be played -## 0.1.0 +## 0.1.0 (2016-08-06) + Initial Release diff --git a/README.md b/README.md index ee3068da..fce404d8 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Discord Soundbot [](https://discord.gg/JBw2BNx) -A Soundboard Bot for Discord to play your favorite sounds or music. You can also add / rename / remove sounds, ignore certain users, and more! +A Soundboard Bot for Discord to play your favorite sounds or music. You can add and play sounds, ignore users, set an avatar and more! This 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! @@ -17,7 +17,7 @@ Have fun! ### General -To use this bot, you first have to create your own [Discord Application](https://discordapp.com/developers/applications/me). 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. +To 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. ### Configuration @@ -27,7 +27,7 @@ Check `config/config.example.json` for an example configuration and create a new ### Building -The bot can be installed manually or via Docker. +The bot can be installed manually or via Docker. #### Building manually @@ -53,32 +53,15 @@ Use the following URL to let the bot join your server! https://discordapp.com/oauth2/authorize?client_id={YOUR_CLIENT_ID}&scope=bot ``` -Follow the link and allow your bot to join your Discord server. +Follow the link and allow your bot to join your Discord server. The bot will leave a message containing additional information. ## Commands -Type `!commands` to print the following list of available commands. +Type `!help` or `!commands` to print a list of available commands. -``` -!commands Show this message -!sounds Show available sounds -!tag Add tag to sound -!search Search for specific sound -!add Add the attached sound -! Play the specified sound -!random Play random sounds -!rename Rename specified sound -!remove Remove specified sound -!stop Stop playing and clear queue -!leave Leave the channel -!mostplayed Show 15 most used sounds -!lastadded Show 5 last added sounds -!ignore Ignore specified user -!unignore Unignore specified user -!avatar [remove] Set, show or remove the avatar -``` +You can add, rename, download, tag, play, and remove sounds, ignore users, set the avatar, and more. ### Adding sounds @@ -96,6 +79,8 @@ When your library of sounds gets too big and you forget what kinds of sounds you You can add tags to sounds with `!tag `. You can specify one or more sounds. You can get the tags of a sound with `!tag `. You can also remove all tags from a sound with `!tag clear`. +To get all sounds with their respective tags use `!tags`. + To search for specific sounds use `!search `. It will look for the name of the sound as well as tags that you might have added to the sound. ### Renaming sounds @@ -106,6 +91,10 @@ Sounds can be renamed by using `!rename `. The bot will respond with You can delete sounds by typing `!remove `. The bot will respond with the status of the deletion in the channel of the message. +### Downloading sounds + +You can send existing sounds to chat with `!download ` in case you do not have the files anymore. + ### Ignoring users Users can be ignore from using **any** command by the `!ignore ` command while specifying their respective ID. The user will be mentioned by the bot in the channel of the message. Use `!unignore ` to allow the user to interact with the bot again. diff --git a/package.json b/package.json index 8cfd3a73..363b1568 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "discord-soundbot", - "version": "1.0.2", + "version": "1.1.0", "description": "A Soundboard for Discord", "repository": { "type": "git",