Skip to content

Commit

Permalink
Prep v1.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
markokajzer committed Aug 19, 2018
1 parent b0cc3b7 commit f000037
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 28 deletions.
18 changes: 14 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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 `!<sound>` commands if sound does not exist
+ Remove all previous `!<sound>` 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`
Expand All @@ -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
Expand Down Expand Up @@ -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
35 changes: 12 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Discord Soundbot

[<img title="Join us on Discord" src="https://discordapp.com/api/guilds/236732117524938754/widget.png?style=shield">](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!

Expand All @@ -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
Expand All @@ -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

Expand All @@ -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 <sound> <tag> Add tag to sound
!search <tag> Search for specific sound
!add Add the attached sound
!<sound> Play the specified sound
!random Play random sounds
!rename <old> <new> Rename specified sound
!remove <sound> 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 <user> Ignore specified user
!unignore <user> 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

Expand All @@ -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 <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`.

To get all sounds with their respective tags use `!tags`.

To 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.

### Renaming sounds
Expand All @@ -106,6 +91,10 @@ Sounds can be renamed by using `!rename <old> <new>`. The bot will respond with

You can delete sounds by typing `!remove <sound>`. 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 <sound>` in case you do not have the files anymore.

### Ignoring users

Users 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.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "discord-soundbot",
"version": "1.0.2",
"version": "1.1.0",
"description": "A Soundboard for Discord",
"repository": {
"type": "git",
Expand Down

0 comments on commit f000037

Please sign in to comment.