# Quick Start

## 🚀 Quick Start

### Invite

Make sure <mark style="color:red;">InHouseQueue</mark> is in your server before getting started.

Invite InHouseQueue [here](https://discord.com/oauth2/authorize?client_id=1001168331996409856).

{% hint style="warning" %}
You must have **Administrator** or **Manage channels** permissions for these commands.
{% endhint %}

### Basic Setup

#### Starting the setup

1. Run the `/setup` command. Use this in any channel, but a dedicated commands channel is best.

{% hint style="info" %}
You can **only have one setup per game** at a time.
{% endhint %}

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2FoXUHsw15NgwIFLyCoMfh%2F1.png?alt=media&#x26;token=1917ab31-80f3-4701-97c1-6382ef34034e" alt="" width="395"><figcaption></figcaption></figure></div>

2. Select <mark style="color:green;">**Start Setup**</mark>.

<div align="left" data-full-width="false"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2F9Rp0cqKvmnmqYV82fQPE%2F2.png?alt=media&#x26;token=8e8db026-62b8-462b-ab0d-769f5652858a" alt="" width="401"><figcaption></figcaption></figure></div>

3. Select your Game

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2FhaI1jOIDedTDkf1aH1yq%2F3.png?alt=media&#x26;token=e73d8c0e-1b37-4828-a16f-793991b0d8e7" alt="" width="390"><figcaption></figcaption></figure></div>

**Available Presets:**

* **League of Legends**
* **Valorant**
* **Overwatch 2**
* **Dota 2**
* **Crossfire**
* **Pokemon Unite**
* **Counter-Strike 2**
* **Rainbow Six Siege X**
* **Marvel Rivals**

**Custom Setup:**

* For this tutorial, we will select **Custom**.
* **Custom** allows you to:
  * **Customize Team Sizes**
  * **Customize Button/Label Names**

#### **Customising**

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2FVkBohNB0V7T8omxIRmNk%2F4.png?alt=media&#x26;token=6c21e309-2aad-4bc4-802e-91451bdc9bf4" alt=""><figcaption></figcaption></figure></div>

4. For this example, we'll use <mark style="color:purple;">**Call of Duty**</mark> for the <mark style="color:purple;">**Game Name**</mark>. <mark style="color:orange;">**4**</mark> for the <mark style="color:orange;">**Team Sizes**</mark> and <mark style="color:red;">**Obj, Slayer, Anchor and Support**</mark> for the <mark style="color:red;">**Role Labels**</mark>.
   1. <mark style="color:blue;">**Game Name**</mark><mark style="color:purple;">**:**</mark>
      1. Enter any characters from 1-200 characters
   2. <mark style="color:orange;">**Team Size:**</mark>
      * Enter a number between **1 and 8**.
      * *Example:* `4`
   3. <mark style="color:red;">**Role Labels:**</mark>
      * Each role must have a **unique name**.
      * Do **not** use the same name more than once.
      * If your game has similar roles, add a number or identifier to make them unique.
      * *Example:* Use `Slayer 1` and `Slayer 2` instead of just `Slayer`.
   4. **Matching Roles to Team Size:**
      * The number of roles you enter should **match your team size**.
      * *Example:* If your team size is `4`, you need to enter `4` unique role labels.

#### Selecting a game mode

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2FmrT7uRDbgzxIhlS193oI%2F5.png?alt=media&#x26;token=ef7c8be0-e3e4-4c50-84a9-c201f5bcee51" alt="" width="446"><figcaption></figcaption></figure></div>

5. Now select a **Game Mode**. For more information on each Game mode please visit the [dedicated section](https://docs.inhousequeue.xyz/docs/commands/game-modes). For this example, we will pick **Rosters.**

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2FO8MODxbhgIyy5DqpXb9G%2F6.png?alt=media&#x26;token=e1fefd10-f1f8-4524-97d1-37c70319a57b" alt="" width="447"><figcaption></figcaption></figure></div>

#### Review your changes

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2F5qK9PuRmY44Fd7AmSAC9%2F7.png?alt=media&#x26;token=118e92b7-64c9-4afe-b55b-82de478d697e" alt=""><figcaption></figcaption></figure></div>

6. Please review your changes. If you are happy click <mark style="color:green;">**Confirm**</mark>

All done.

<mark style="color:red;">InHouseQueue</mark> will take a moment to create all your channels and categories.

Channels and Categories are explained below.

***

#### Channels and Categories Explained

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2FnMlMj7Pjlmtjy5SLIiYZ%2F8.png?alt=media&#x26;token=937b452f-4bca-4406-a9be-bac1c222efb2" alt=""><figcaption></figcaption></figure></div>

<mark style="color:red;">InHouseQueue</mark> will create **2** <mark style="color:purple;">Discord Categories</mark> and **5** <mark style="color:yellow;">Text channels</mark> automatically.

**Categories**

* **INHOUSE - CALL OF DUTY**
  * This is the main category for <mark style="color:red;">InHouseQueue</mark>, helping to keep your server organized.
  * **Purpose:** Contains all the channels needed for your InHouse games.
  * **Customization:** You can rename the channels in this category to fit your preferences.
  * **Recommendation:** Use this category for all your InHouse games to keep everything tidy.
* **ONGOING CUSTOM GAMES**
  * When a match starts, <mark style="color:red;">InHouseQueue</mark> automatically creates voice channels for each team and a general lobby.
  * **Channels created:** <mark style="color:red;">Red</mark> Team Voice Lobby, <mark style="color:blue;">Blue</mark> Team Voice Lobby and a <mark style="color:green;">**General Lobby**</mark> for both teams.
  * **Location:** These channels will be made inside the **ONGOING CUSTOM GAMES** category.
  * **Customization:** You can rename or move this category as you like.
  * **Note:** If this is deleted, it will automatically get recreated when a new game starts. You can also manually recreate it, or reuse an existing category with [`/game ongoing_games_category`](https://docs.inhousequeue.xyz/docs/commands/game-commands#crown-recreateselect-ongoing-games-category)

**Text Channels**

* **Match History**
  * **Purpose:** Stores the results of every completed game.
  * **Note:** You can only have **ONE** Match History channel per server.

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2Fgit-blob-64497764fa977f181158cd5a5b523bba1239b62f%2Fmatch_history_channel.png?alt=media" alt="" width="404"><figcaption></figcaption></figure></div>

* **Top-20**
  * **Purpose:** Displays the leaderboard.
  * **Features:**
    * Updated after every match.
    * Tracks scores on the [**Global Leaderboard**](https://docs.inhousequeue.xyz/docs/quick-start/leaderboards-explained) by default.

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2Fgit-blob-e9cf8cadf7b0f91141877d98ed455e1891f6573e%2Ftop_ten_wins.png?alt=media" alt="" width="404"><figcaption></figcaption></figure></div>

* **Inhouse-Admin-Logs**
  * **Purpose:** [Logs important actions](https://docs.inhousequeue.xyz/docs/commands/server-commands#crown-server-logs) for Admins and Moderators.
  * **Features:**
    * Automatically records key events.
    * Helps admins monitor and manage the server effectively.

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2Feq0f1muaMtBr4QnNigva%2Fadmin_log.png?alt=media&#x26;token=60ab9f2e-dd03-4e96-9c7c-f9b418b5a6b1" alt="" width="404"><figcaption></figcaption></figure></div>

* **Queue**
  * **Purpose:** Where players can join to participate in games!
  * **Features:**
    * Players can sign up and get matched.
    * Players are notified when a game is about to start
    * Players Ready up
    * Players Unready up

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2Ff8YhAdjcA5EEznrlanls%2F9.png?alt=media&#x26;token=689fdf0b-243d-4432-8e2d-82332582945f" alt=""><figcaption></figcaption></figure></div>

* **In progress**
  * **Purpose:** Matches that are in progress will logged in here. Spectators are muted members who can join Blue or Red team voice channel. A player of the game can [share their screen](https://support.discord.com/hc/en-us/articles/360040816151-Go-Live-and-Screen-Share) to allow them to watch along.

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2Fgit-blob-bdc70b8625acc611f8d5b464f839e23004b7ed8e%2Fin_progress4.png?alt=media" alt=""><figcaption></figcaption></figure></div>

That's it! Start playing by clicking the <mark style="color:green;">Green</mark> buttons to join the queue!

Continue reading for more advanced settings...

***

### Basic Setup continued

After completing the Basic setup, you'll see an embed with some of our most frequently used settings.

Each setting is explained clearly. Just click on the setting you want, and the command will automatically appear in your Discord text bar!

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2FuafoInl98iIHJe1ybbyi%2F10.png?alt=media&#x26;token=5210f704-a3c5-402b-bcfa-5283fafa9ba5" alt="" width="451"><figcaption></figcaption></figure></div>

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2FHjeKRWNPSI0Kx9TXzJl6%2F11.png?alt=media&#x26;token=0f9bfd34-134a-4837-8acf-db2f6d82c71a" alt="" width="461"><figcaption></figcaption></figure></div>

***

## InHouseQueue Game flow 🔧

It's a good idea for Owners or Admins to understand how the game flow of <mark style="color:red;">InHouseQueue</mark> works. This will help you guide your members better. Here's how to test it:

1. **Enable Test Mode:** Use the `/queue test_mode` command and set it to **True**.
2. **Start a Queue:** Run the `/start` command in your queue channel to begin a new queue.

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2Fgit-blob-ea87c3f97867a0e0e582fd6c18cabdef4ebcc96b%2Ftest_mode1.png?alt=media" alt=""><figcaption></figcaption></figure></div>

3. **Invite a Friend:** You’ll need another person to test this. If you don’t have anyone available, you can use a second account.
4. **Test Joining:** In Test Mode, all buttons except one will be greyed out. Both you and your friend (or your second account) should join the queue.
5. **Ready Up Phase:** This will trigger the ready-up phase. Ready up, and <mark style="color:red;">InHouseQueue</mark> will create a Game with two voice channels and a Lobby channel.

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2Fgit-blob-fc79ff5bf7904df70bbd99d024fb90f1db0abfc3%2Ftest_mode2.png?alt=media" alt=""><figcaption></figcaption></figure></div>

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2Fgit-blob-0900172dfd4b63fdfaffd451e8e81ef4e350cf1c%2Ftest_mode3.png?alt=media" alt=""><figcaption></figcaption></figure></div>

6. **Ending a Test Game:** Once you're satisfied, you can close the Test Mode game using `/cancel`. If you want to test leaderboard updates use the `/winner` command to declare a winner.
7. Select either the Red or Blue role using the <mark style="color:green;">GameID</mark> created by <mark style="color:red;">InHouseQueue</mark>. Note that ending with `/winner` will affect the leaderboard.
8. If you want to test the MVP voting flow, you should end the game by starting a vote with `/win` - See more details [here](https://docs.inhousequeue.xyz/docs/commands/game-commands#bulb-begin-vote-for-a-winner)

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2Fgit-blob-5c4a536f9c50faf5f148310da1405d156b1802e2%2Ftest_mode4.png?alt=media" alt=""><figcaption></figcaption></figure></div>

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2Fgit-blob-7460f954d58cf66625193a985be84893b50e9a4c%2Ftest_mode5.png?alt=media" alt=""><figcaption></figcaption></figure></div>

#### MVP Voting

1. At this point you may click the <mark style="color:green;">Vote MVP</mark> button. Use this to vote for the player you thought played the best! The player with the most votes will win MVP for that match and their MVP score will increase by 1. If there is a tie, both players get the points!

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2Fgit-blob-5c83e997bedcddfea79c5f1d08fe02b5a62e42d4%2Fmvp_vote.png?alt=media" alt=""><figcaption></figcaption></figure></div>

2. Once one player has voted, a 5-minute timer begins. After 1 minute, all players who haven't voted receive a reminder. The voting phase ends after 5 minutes — anyone who hasn't voted by then won't be able to.

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2Fgit-blob-b1fc37129486eb40e8958f478ca6bfefe204c6d1%2Fmvp_reminder.png?alt=media" alt=""><figcaption></figcaption></figure></div>

3. The Winner(s) are announced in the Queue channel.

<div align="left"><figure><img src="https://1130318129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwcHfLjgS9hMDSoOpDEDo%2Fuploads%2Fgit-blob-e4aec2a81445dd5ddc03ab78c149101d7f02dfda%2Fmvp_vote_winners.png?alt=media" alt=""><figcaption></figcaption></figure></div>

#### What’s next

Now that you’re familiar with <mark style="color:red;">InHouseQueue</mark>, you’re ready to help your community use it effectively!
