# Timmy [![invite bot](https://img.shields.io/badge/discord_bot-invite-blueviolet)](https://discordapp.com/oauth2/authorize?client_id=679423390804606986&scope=bot&permissions=3149312)

You can play sound files either by using attachments or a URL.
Timmy will join your current channel and play that file if it is valid.

Following formats are supported:

- mp3
- ogg
- mp4
- webm
- soundcloud
- youtube\*
- spotify\*

\* using `ytdl-core`

Following commands are available:

- [play](#Playing-Files)
- [playnext](#Playing-Files---Ignoring-Queue)
- [stop](#Stopping-Playback)
- [pause](#Pausing-Playback)
- [resume](#Resuming-Playback)
- [skip](#Skipping-Playback)
- [now](#Now-Playing)
- [queue](#Queue)
- [remove](#Removing-Files-from-Queue)
- [clear](#Clearing-Queue)
- [volume](#Setting-Playback-Volume)
- [stats](#Retrieving-Stats)
- [promote*](#Administration)
- [degrade*](#Degrading-Users)
- [prefix*](#Setting-A-Custom-Prefix)
- [help](#Help)

\* These commands require `MANAGE_GUILD` Permission or need to be executed by an [administrator](#Administration) of Timmy

## Usage:

Timmy reacts to every command using the prefix (default is `t!`) or by `@mentioning`.

### Playing files

`t!play <URL>` or `t!play <attachment>`

> You can also mention timmy and omit the play command:

`@Timmy <attachment or URL>`

#### example:

`t!play https://www.youtube.com/watch?v=oHg5SJYRHA0`

 

### Playing files - Ignoring Queue

Sometimes you want to overide the queue to play your favourite song, to do this you can run

`t!playnext <URL or attachment>` or `t!n <URL or attachment>`

which adds this url or attachment to queue after current playing track.

#### example:

`t!playnext https://www.youtube.com/watch?v=oHg5SJYRHA0`

 

### Stopping Playback

`t!stop`

 

### Pausing Playback

`t!pause` or `t!p`

 

### Resuming Playback

`t!resume` or `t!r`

### Skipping Playback

You can skip the current playing file, if there are more files in the queue:

`t!skip` or `t!s`

 

### Now Playing

`t!now` or `t!np`

 

### Queue

`t!queue` or `t!q`

 

### Removing Files from Queue

`t!remove <index>` or `t!rm <index>`

#### example:

`t!remove 3` (removes the third track from the queue)

 

### Clearing Queue

`t!clear` or `t!c`

 

### Setting Playback Volume

`t!volume <number>` or `t!v <number>`

#### example:

`t!volume 0.25` (sets volume to 25%)

 

### Retrieving Stats

You can display stats of the bot and your server's playback:

`t!stats`

 

### Administration

This bot allows you to do certain actions that are considered security relevant. For those commands you might want to set a custom list of administrators (mods) that are permitted to execute these commands.

> This command requires MANAGE_GUILD Permission or administrator status by Timmy

`t!promote <user(s)>` or `su <user(s)>`

#### example:

`t!promote @user` (promotes `@user` as administrator who may execute all commands)

### Degrading Users

Sometimes you might make a mistake in promoting users, or you might want to revoke permissions.

> This command requires MANAGE_GUILD Permission or administrator status by Timmy

`t!degrade <user(s)>` or `t!d <user(s)>`

#### example:

`t!degrade @user` (degrades `@user` and removes them from administrator list)

### Setting A Custom Prefix

Yes! This is absolutely possible!

> This command requires MANAGE_GUILD Permission or administrator status by Timmy

`t!prefix <prefix>` or `t!pr <prefix>`

#### example:

`t!prefix do` (sets Timmy's prefix to `do`)

### Help

`t!help` or `t!h` (displays general help of the bot)

`t!help <command>` or `t!h <command>` (displays help of `<command>`)

#### example:

`t!help play` (displays help of `play`)

Timmy

Timmy is a music bot that plays attachments, youtube, soundcloud and spotify.

Stemmen voor Timmy

Wil je ons ondersteunen?