### A 24/7 Jackbox Party Pack Bot.

## How to Use the Bot
The bot operates using a voting system, which involves three main phases.

## Vote Phase
During or after a game, players can initiate the voting process by typing !vote X.
Once the first person has voted, a 60-second time limit is set for all players to cast their votes. To progress to the next phase, a minimum of 4 votes is required.

#### Examples of voting:

Type **!vote 1** to vote for **Pack 1**
Type **!vote 2** to vote for **Pack 2**
Type **!vote 3** to vote for **Pack 3**
...
Type **!vote 9** to vote for **Pack 9**

## Game Pick Phase
Following the vote, the pack to be played is chosen.
The bot generates a message with 5 reactions representing different games:

:one: Reaction for Game 1
:two: Reaction for Game 2
:three: Reaction for Game 3
:four: Reaction for Game 4
:five: Reaction for Game 5

Players can select one or more games they wish to play. When the time limit expires, the winning game will commence.

## Game Phase
A message displaying the current progress of the selected game's opening state will be presented by the bot.
Players can then engage in playing the game. After completing a game, you can use !vote to initiate another game.

Created by CCB for your enjoyment! :computer:

## Commands
Use **!commands** to see all commands
Use **!commands+** to get a description what all commands do

## Level 1 - Anyone

| Command | Parameters | Description |
|--------------|--------------------|----------------------------------------------------|
| `!commands` | - - - | Display commands |
| `!commands+` | - - - | Display more commands |
| `!help` | - - - | Get help |
| `!level` | - - - | Show user level |
| `!pack` | Number (1-9) | Displays an image of all games<br> their user requirements E.g 2-8 Players |
| `!rules` | - - - | Show rules |
| `!vote` | Number (1-9) | Vote for a pack <br>!vote 1 <br>!vote 2<br>...<br>!vote 9 |

## Level 2 - Level 2 Users and above

| Command | Parameters | Description |
|--------------|--------------------|---------------------|
| `!joke` | - - - | Tell a joke |
| `!report` | Text | Report an issue |
| `!version` | - - - | Show version |

## Level 3 - Top Host and above

| Command | Parameters | Description |
|--------------|--------------------|-----------------------------------------|
| `!break` | - - - | Pauses the game for a minute |
| `!closegame` | - - - | Closes the game, used after everyone stopped playing, to spare my bandwidth |
| `!join` | - - - | Let's the streamer join the VC |
| `!restart` | - - - | Restart the whole Bot |

## Level 4 - Staff and above

| Command | Parameters | Description |
|--------------|--------------------|-------------------------------------------------------------------------------|
|`!staff`|- - -| Get a List of all staff commands|
| `!banner-` | Number (Index of banner) | Remove a banner using the index. Check !banners to see what index a specific banner has |
| `!banner+` | Discord Url of Image | Add a banner (How to : post your banner in any discord chat and then copy the link of the image use this link as the parameter for the image) E.G !banner+ "https://media.discordapp.net/attachments/10563...." |
| `!banners` | - - - | List all banners with their respected indexes for deletion |
| `!input` | [button] | Used to navigate the game helpful for changing settings. !input [button] <br>Buttons = (l=left,r=right,u=up,d=down,esc=escape,enter=enter) <br>Example of open the settings for a game: <br>!input esc <br>!input d <br>!input d <br>!input enter <br>To open the settings (may not work for all packs if the settings menu isn't the second option from the top in the pause menu9 |
| `!say` | {Message} | Make the bot say something. Use !say "{Message}" for messages with multiple words <br>!say Hello ✔️ <br>!say "This is a sentence" ✔️ <br>!say This is a sentence ❌ <br> Some swear words will be filtered and your message will be logged into reports, don't abuse the bot :( |
| `!set` | [key] [value] | Set Data use the key words seen in !setview, this changes things like how long the voting phase takes |
| `!setview` | - - - | Views all keywords that can be set |
| `!start` | [GameId] | Instantly start a game [Not working currently...] |

## Level 5 - Developer only

| Command | Parameters | Description |
|--------------|--------------------|-------------|
| `!close` | - - - | - - - |
| `!toggle` | - - - | - - - |
| `!update` | - - - | - - - |

## Frequently Asked Questions

**Q: What is JackStreamBot?**
A: It's an automated bot that streams JackBox Party Packs! No host, just a computer...

**Q: Which commands can I use?**
A: Use !commands to see them and !commands+ to get information about all of them.

**Q: Someone is doing bad stuff, what should I do?**
A: Either report it to a Staff member or use !report "{Message}".

**Q: What is the NoBot Role?**
A: People that abused (spammed the bot or other stuff) will get this Role. Those people will no longer be able to interact with the bot.

**Q: Who made the bot?**
A: CCB (the kirby guy).

**Q: The bot is not working/doing stuff it should not do.**
A: Sorry JackStreamBox is still a development bot. It's no where near to be finished, just a Beta version. Use !report "{Message}" and tell the dev about it. You can even contact CCB about it via DM.
#### Some things that could have happend,
- the bot crashed for some reason (kind of unlikely).
- steam update, the bot can not open steam or its library anymore
- discord update - discord changed something that makes the streaming part not possible
- bot did something it shouldnt (for example streaming a wrong window) and staff members close the bot after a close the dev needs to restart the bot manually to protect from this stuff happening again.