Skip to content

Commit

Permalink
[Update] updated readme and added instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
@naseif
naseif committed Nov 1, 2021
1 parent 307a129 commit 2ebb5c6
Showing 1 changed file with 22 additions and 53 deletions.
75 changes: 22 additions & 53 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<a href="https://discord.com/oauth2/authorize?client_id=881856452157898842&scope=applications.commands%20bot&permissions=536079414">Invite</a> |
<a href="https://discord.gg/JCdpeeNP9N">Support</a>
<br><br>
<img width="400" height="400" src="https://cdn.discordapp.com/attachments/506267292993191947/896386593181560873/eyesense.png">
<img width="300" height="300" src="https://cdn.discordapp.com/attachments/506267292993191947/896386593181560873/eyesense.png">
</p>

<p align="center">
Expand All @@ -21,60 +21,11 @@
## Features

- Support for slash commands 💯
- Support for Youtube, Spotify and Soundcloud 🎧
- <p>Support for <img width="20" height="20" src="https://cdn.discordapp.com/attachments/547844388492148737/904662813757288468/Logo-SoundCloud-Sketch-SoundCloud-logo-512512-transprent-.png"> <img width="20" height="20" src="https://cdn.discordapp.com/attachments/547844388492148737/904660894347296798/file-spotify-logo-png-4.png"> <img width="20" height="20" src="https://cdn.discordapp.com/attachments/547844388492148737/904665487860973588/hd-youtube-logo-png-transparent-background-20.png"></p>
- Can run on multiple servers at the same time 🚀
- Moderation Commands 🔨
- and more ⌛️


## Commands

| Name | Description |
|:--------------------|:----------------------------------------------------------------:|
| **/addrole** | adds a role for a user |
| **/ban** | Bans a user from the server |
| **/deletemessages** | deletes x number of messages |
| **/kick** | kicks a user from the server |
| **/region** | changes the region of the voice channel the user is connected to |
| **/regionbyid** | changes a voice channel region by channel id |
| **/removerole** | removes a role for a user |
| **/servericon** | chnages the server icon! |
| **/unban** | unbans a user with id |
| **/highfive** | sends a highfive gif |
| **/hug** | sends a hug gif |
| **/waifu** | gets waifu pic :P |
| **/whatanime** | Scans an Image to get the anime name! <whatanime 'link'> |
| **/8ball** | ask the magic ball a question! |
| **/insult** | insult your fav user <3 |
| **/joke** | gets a random joke! |
| **/avatar** | Sends the user's avatar |
| **/help** | Shows all available commands for this bot! |
| **/invite** | Get my link to invite me to other servers! |
| **/nickname** | Changes your own nickname or other user's |
| **/perms** | Shows the permission for another member or your own |
| **/ping** | ping the bot connection to the server |
| **/serverstats** | Shows some stats about the server |
| **/summon** | ping the bot connection to the server |
| **/uptime** | Since how long the bot is online |
| **/247** | 24/7 Mode for the bot |
| **/8d** | 8D Audio Filter |
| **/back** | plays previous track from the queue |
| **/bassboost** | bassboost Audio Filter |
| **/clear** | clears the music queue |
| **/disconnect** | disconnects from the channel |
| **/lyrics** | gets the lyrics of the current song |
| **/nowplaying** | shows the current music name |
| **/pause** | pauses the song |
| **/play** | plays music from Youtube |
| **/queue** | Shows the current queue |
| **/loop** | repeats the current song |
| **/resume** | resumes the song |
| **/reverse** | Reverse Audio Filter |
| **/seek** | seeks the current song to the given position |
| **/shuffle** | shuffles the music queue |
| **/skip** | skips a song from the queue |
| **/stop** | stops the current song playing |

## Requirements

- Node.js (v16.6 or higher)
Expand All @@ -89,15 +40,33 @@ git clone https://github.com/naseif/Eyesense-Music-Bot.git
cd Eyesense-Music-Bot
npm i
```
if you are having problems installing sodium, make sure to install the following packages `apt-get install autoconf automake g++ libtool`
if you are having problems installing sodium or libsodium-wrappers, make sure to install the following packages `sudo apt-get install autoconf automake g++ libtool -y`

## Configuration

First you need to create a new application in the [Discord Developer Portal](https://discord.com/developers/applications) and then create a bot to get your own discord Token and invite the bot to your server. Once you got your key, rename `config.example.json` to `config.json`. Now open the `config.json` file and add your discord bot tokens.
### What you will need:

- Your own Bot token
- prefix
- [mongodb url](https://account.mongodb.com/account/login)
- genius ApiKey (For lyrics <optional>)
- TMDb Key (For tv and movie search <optional>)

First you need to create a new application in the [Discord Developer Portal](https://discord.com/developers/applications) and then create a bot to get your own discord Token and invite the bot to your server. A complete guide is available on [here](https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot).

Once you got your key, rename `config.example.json` to `config.json`. Now open the `config.json` file and add your data.

Once you are done, you can now start the bot by running the following:
```node index.js```

### <p><img width="20" height="20" src="https://cdn.discordapp.com/attachments/547844388492148737/904660894347296798/file-spotify-logo-png-4.png"> Spotify Configuration</p>

Since play-dl is being used as alternative for ytdl-core, a manual configuration for spotify is needed. You can find the instructions [here](https://github.com/play-dl/play-dl/discussions/64)


### <p><img width="20" height="20" src="https://cdn.discordapp.com/attachments/547844388492148737/904662813757288468/Logo-SoundCloud-Sketch-SoundCloud-logo-512512-transprent-.png"> Soundcloud Configuration</p>

As of this moment, there is no need to configure soundcloud manuely after play-dl latest update!
### Recommendation

Use pm2 to run the bot in the background and automatically restart it when e.g. your server has internet issues:
Expand Down

0 comments on commit 2ebb5c6

Please sign in to comment.