# JSL Bot
A true multipurpose discord bot.

| [Invite Bot](https://bit.ly/jsl-default) | [Support Server](https://bit.ly/jsl-support) | [Vote JSL](https://bit.ly/jsl-vote) | [Getting Started](https://github.com/DiabolusGX/JSL#Setup) |

-----

### Before you start
***Do not literally type out <> \[\] | etc. (Unless Mentioned)***
- **Aliases:** \[foo | bar\] means that you can use either foo or bar.
- **Optional:** \[foo\] means that this argument can be ignored.
- **Required:** \<foo\> means that you must use this argument for the command to work.
- ***If you want to remove config you changed, set it's value to `none` like `.booster message none`***

*Commands marked with*
- `*` can be unlocked for 12 hours after you [Vote JSL Bot.](https://bit.ly/jsl-bot 'Vote on top.gg')
- `**` can only be used in NSFW channels.

### Setup
Starting with bot setup?

You can start with `.help setup` to see what configurations you can edit & you want to set.

**Note** : 
- *You can remove any config anytime by setting it's value to `none`*
 
 *ex : `.setup bot none` will remove bot channel.*

Name | Example | Usage
------- | ------------ | -------
prefix | `.setup prefix jsl.` | Sets new prefix. Prefix can't have *space*. 
bot channel | `.setup bot <channel>` | Only admins can use bot-commands outside *bot channel* If you don't want this, set value to `none`(default). You can mention the channel or use channel id.
welcome | `.setup welcome <channel>` | To get welcome messages when someone joins. Use `.help welcome` to edit welcome configs. You can mention the channel or use channel id.
mod channel | `.setup modchnl <channel>` | To get log of JSL Bot Moderation Command used. You can mention the channel or use channel id.
coins channel | `.setup general <channel>` | To enable [Economy Module](#Economy), members will get coins in this channel. You can mention the channel or use channel id.

-----

# Commands
Here are the categories the commands are divided in :
Click on category to get available commands with example and usage.

> - [Featured Commands & Functionalities](#Featured) 
- [Utility](#Utility)
- [Fun](#Fun)
- [Music](#Music)
- [Other](#Other)
- [Economy](#Economy)
- [Mods](#Mod)

-----

### **Featured**

These are the core commands and functionalities of the bot and some of them are quite unique like : 
- [Steam Module](#Steam) is covered seperatly because it can be a little complex to understand. 
If you have any doubts, you can always join [Support Server](https://bit.ly/jsl-support) 
- [Movies](#Utility), [TV Shows](#Utility) & [Movie Trailers](#Utlity) are some of the most used commands of JSL Bot.
 Bot searches respective movies & seriese then you can respond with the `number` *next to the result* to get more info on respective result. **Like :** 
 > `.movie now you see me` if you reply with numner `2` and bot will show movie details `Now You See Me 2`.
 `.show Lucifer` if you reply `1` and bot will show you all about `Lucifer`.
 `.trailer avengers` and reply with `2` to get YouTube trailer URL of ` Avengers: Endgame`. 
- **Giveaway** Command can be used to select random winner(s) from given message or role. 
 `.giveaway <message_id | role> [number of winners]` 
 > Using **Message ID** : `.giveaway <message_id> <channel> [number of winners]` 
 > -> Winner(s) will be selected randomly from 1st reaction on message (In case there are many reactions). -> Usage : `.giveaway 783388440431296543 #giveaways 5`. 
 > **Role** can also be used to select random winners from given role. -> Usage : `.giveaway @ActiveMembers 2` (You can also use role id) 
- [Event Management](#Event) is the newest addition that can : 
 > Create event, Convert event time in yout city time, Reminds you on event start(if you want), Ping `@role(s)` or `@everyone` or `@here` on event start.
- **Booster** Command lets you setup the Custom Message, Image, Embed or Ping & Give custom role when someone boosts your server. 
 > `.booster message You are awesome. Check #booster-perks for info.` It'll send this custom message in [System Message Channel](https://prnt.sc/vrurxn). 
 > `.booster image <URL>` Sned URL without `<>` and URL must end with proper file extention. i.e `gif, png, jpeg...`. 
 > `.booster embed disable` It'll disable the embed and user will be pinged (`ENABLED` by default). 
 > `.booster stats disable` If you disable stats, bot will not show *number of boosts* and *level achieved on boost(if any)* (`ENABLED` by default). 
 > `.booster role 741641608079867905` It'll add `741641608079867905` role to the user. You can mention the role or use role id. 
 > `.booster preview` Will show you a preview of how booster message will look like. 
 >> **Note** : To disable message or remove image, set `none` in value. Like `.booster message none` will `DISABLE` these messages.
- Using **Time** command, you can see current time all over the glove or time in any city. 
 You may ask HOW? 
 > `.time globe` Have a glance on current time all across the globe. 
 > `.time Sydney` Will show current date, day & time in Sydney, Australia. 
 > `.time link Sydney` Will link your timezone to Sydney, Australia timezone (i.e `GMT +11`). 
 > `.time update New York` To update your city to new city (i.e your new timezone will be `GMT -5`). 
 >> **Note** : You MUST line timezone to convert [Event](#Event) time in your local timen 

-----

### Utility

Various utility commands and modules are one of the main features of JSL Bot.
Check the table to get available commands with their proper usage and examples.
Name | Example | Usage
------------ | ------------- | -------------
steam | `.steam <game | user | link | groups | play ...>` | Steam module is covered saperatly [Over Here](#Steam)
movie | `.movie now you see me` | Searches for available Moves. [Featured Command](#Featured)
tvshow | `.show Lucifer` | Searches for available TV Series. [Featured Command](#Featured)
trailer | `.trailer Avengers` | Searches for available trailers on YouTube. [Featured Command](#Featured)
booster | `.booster <message | image | role | embed | stats | preview>` | Send custom message in [System Message Channel](https://prnt.sc/vrurxn) when someone. [Featured Command](#Featured)
giveaway | `.give <message_id | role> [no. of winners]` | Selects ramdon winner(s) from given msg or role [Featured Command](#Featured)
event | `.event <custom | alert>` | Organize events and set alerts on event start. [Featured Command](#Featured)
time | `.time <globe | city | link | update>` | Get current time in any city or all over the globe. [Featured Command](#Featured)
short | `.short https://top.gg/bot/699505785847283785` | Shorten the given URL.
bin | `.bin <paste | get> <Data | Paste ID>` | You can easily save data to Pastebin and get an URL or get the data using the PasteID (end part of url).
gif | `.gif celebration` | Sends a gif related to provided keyword else It'll send a random trending gif.
reddit | `.reddit pcmasterrace` | Search a subreddit for you and returns a random popular post.
image** | `.image steam` | Shows Image related to provided keyword.
urban** | `.urban bots` | Search your query on Urban Disctionary.


Go back to [Commands](#Commands)

-----

### Steam

Get steam game info, user info, recent played games, common games and friends that has perticular game.

You can start with `.steam setup` to make your profile privacy settings work with bot & other 3rd party websites.

- I suggest you to link your steam profile using `.steam link` so that users can diretly mention you instead of typing your steam url or steam user id.
- For `steam game` command You can respond with the `number`(1, 2, 3...) *next to the result* to get information about that game. 
 
 **OR** You can directly use `AppID` like `.steam game 1085660` to quickly get game info.


Name | Example | Usage
------------ | ------------- | -------------
user | `.steam user Y0kenB` | Shows you details of provided steam user.
owned | `.steam owned Y0kenB` | Shows owned games of provided steam user.
recent | `.steam recent Y0kenB` | Shows recently (last 14 days) played games.
groups | `.steam groups Y0kenB` | Shows all steam groups users has joined.
common | `.steam common DiabolusGX Y0kenB` | Shows *common owned* games of 2 users.
game | `.steam game Destiny 2` | Searches game on steam and shows you the available info.
link | `.steam link DiabolusGX` | Links your discord to your steam account.
play | `.steam play Destiny 2` | Shows list of your friends on steam that owns this game.
groupinfo | `.steam groupinfo ESL` | Shows you information available on mentioned steam group.


Go back to [Commands](#Commands)


-----

### Event

This command can be used to host events that server members can attend and set the alert types (`DM`, `PING`, `NONE`-default) on event start. 
- To create new event use `.event custom` command. **Symboles - \| & \[\] will be included in this command** Example: 
 `.event custom Movie Night | 1 d | Movie will be streamed in Movie Night VC [@Creator join now!]` [**This event will look like this**](https://prnt.sc/vsmjg5) 
 > `Movie Night` Will be the event name. 
 > `1 d` Is starting time. It can be anything between `5 minutes` & `7 days`. Like : `5 m`, `10 hr`, `50 hr`, `3 d`. 
 > `Movie will be streamed...` Is event Description.
 > `@everyone Join Now!` Is [***Alert Message***](https://prnt.sc/vsmqb5). That'll appear when event starts. It has to be closed in `[]`. 
- To edit the event name, timing or alert message, You can use `.event edit <event message id>` like : 
 > `.event edit 782859872802570311 name Streaming Event` Will change event name to *"Streaming Night"* 
 > `.event edit 782859872802570311 time 10 hr` Will prepone the event time from 1 day to 10 hours from now. 
 > `.event edit 782859872802570311 desc Streaming VC Will be General vc.` It'll update event description. 
 > `.event edit 782859872802570311 message @event Streaming Now!` Will set [***Alert Message***](https://prnt.sc/vsmqb5) to *"@event Streaming Now!"* 
- You can also personal alert, so that bot will `DM` or `PING` you when event will start. To set the alert : 
 > You have to react with `✅` to mark yourself as `ATTENDEE`. 
 > Use `.event alert ping` If you want to get a ping message on event start. 
 > or `.event alert dm` If you want to recieve DM when event starts. 
 > You can always disable the alert by `.event alert none` (default). 
- To get Event Start Time in your local time
 1. Set your city using `.time link` like : `.time link NY`.
 1. Then react with `⏰` on event message to convert *Event Start Time* in your *Local Time*. *Make sure your DMs are open!*
 1. If you want time in any other timezone then update your city like : `.time update Delhi` then bot will show *Event Time* accordig to time in Delhi, India.

Go back to [Commands](#Commands)


-----

### Fun

Name | Example | Usage
------------ | ------------- | -------------
ascii | `.ascii <query>` | Convert your query to ascii-art.


Go back to [Commands](#Commands)

-----

### Music

- Make sure bot has requires permissions (i.e `JOIN`, `SPEAK`, `USE_VOICE_AVTIVITY`) in the Voice Channel hwere you want to listen to music :)
- The additional `.sound` command has some cool sound effects that you can play. 
- `.help sound` to see available sound effects and play like : `.sound drum-roll`

Bot will Join Voice Channel and leave as soon as song or soundeffect is over.


Name | Example | Usage
------------ | ------------- | -------------
play | `.play perfect` | Plays the song or playlist from youtube (including livestreams), soundcloud, bandcamp, twitch, vimeo, mixer, direct file links.
search | `.search moonlight` | Searches youtube for videos matching your query. You can then respond with the *number* next to the result to enqueue that result.
queue | `.queue` | Shows the queue, paginated and the full duration of the playlist.
np | `.np` | Shows the current song being played
skip | `.skip` | Skips if you have *DJ Role* or if you requested the song, voteskips otherwise.
pause | `.pause` | Pause the song.
resume | `.resume` | Resume the song.
loop | `.loop` | Switch b/w repeating the playlist and current song.
lyrics | `.lyrics` | Shows lyrics of currently playing song or the song you entered. You have to respond with the *number* to the result to get lyrics.
volume | `.volume 75` | Changes the volume between 1 and 100% (100 is pretty loud as you can probably tell)
leave | `.leave` | Disconnects the bot from the voice channel and clears the queue.


Go back to [Commands](#Commands)


-----

### Other

Name | Example | Usage
------------ | ------------- | -------------
ping | `.ping` | Shows response time & ping of bot.


Go back to [Commands](#Commands)


-----


### Economy

Economy module can be enabled from [Setup](#Setup) command.
- i.e `.setup general <channel>` You can mention the channel or use Channel ID.
- Users will get coins only in `general` channel.

Other available Economy Commands are : 

Name | Example | Usage
------------ | ------------- | -------------
cions | `.coins [user]` | Shows your or mentioned user's coins (if any).
pay | `.pay @DiabolusGX 2020` | Sends `x` coins to mentioned user's account.
work | `.work` | You can work every 12 hr and get upto 250 coins.
shop | `.shop <rep | chicken> [quantity]` | Buy reputation points or chicken to take part in cock-fight.
fight | `.fight 100` | Bets 100 on your chicken. You win & earn 100 else cock dies
buy | `.buy <1 | 2 | 3>` | Buy from server shop that you can setup using `.buysetup`
items | `.items [user]` | Shows your or mentioned user's inventory.
rep | `.rep @DiabolusGX` | gives 1 reputatation point to mentioned user.


To setup server shop (`.buysetup`) :
- To set name of 1st item : `.buysetup role1 name Epic Role`
- To set value/price of 1st item : `.buysetup role1 value 10000`
- To remove, set value to `none` like `.buysetup role1 name none`

**You can setup upto 3 items using `buysetup`**


Go back to [Commands](#Commands)


-----


### Mods

Name | Example | Usage
------------ | ------------- | -------------
setup | `.setup` | [**Explained HERE!**](#Setup)


Go back to [Commands](#Commands)


-----

A bot that has something for everyone. Steam Module, Movies, TV Shows, Custom Server Boost message, Event Organizer, Giveaways, Music & more

Voter pour JSL

Tu veux nous soutenir ?