# Vibez

Information about Vibez Development.

{% hint style="danger" %}
This webpage is still in progress, the information may be inacurrate.
{% endhint %}

**Welcome to Vibez Documentation.** 

Vibez is the largest bot provider for custom Roblox ranking and verification bots, along with that we also provide other categories like moderation, music, fun commands and more!

To get started and create a bot, head to the page below.

{% content-ref url="/pages/QyigrArkcBYJIAeyiGMt" %}
[Creating a bot](/setup/token)
{% endcontent-ref %}

{% hint style="info" %}
Feel free to join our [support server](https://vibez.dev/discord) for help and check out our [website](https://vibez.dev).
{% endhint %}


# Creating a bot

In this page you will learn how to create a bot with Vibez.

1. Head on over to [Discord's developer panel](https://discord.com/developers/applications).
2. Create a bot by clicking on "New Application".
3. Give the bot a nice username and click on "Create".
4. You can give the bot a profile picture and about me, this can be changed later on.
5. Click on "Bot" in the navigation menu on the left and then "Add bot" and then "Yes, do it!".
6. Quickly copy the bot token with "Copy", if you only see "Reset Token" you took to long and you'll have to press this.
7. IMPORTANT: Turn on all 3 intents. (Presence, Server Members & Message Content Intent)![](https://2358536857-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGvQ1spooMwwatkQ2qBRp%2Fuploads%2FOE9MTrPasdlV2ws9FDEX%2Fimage.png?alt=media\&token=dbf5b5a6-199b-4fcc-bbe7-a3ab877f1f5a)
8. DO NOT ENABLE "REQUIRES OAUTH2 CODE GRANT"!!!![](https://2358536857-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGvQ1spooMwwatkQ2qBRp%2Fuploads%2FHqvbpXPRjCcKre8QfgPt%2Fimage.png?alt=media\&token=671f0bf6-a502-443b-9fda-cb3479dce021)
9. In our [support server](https://vibez.dev/discord), click in #get-free-bots on "Create bot" and paste the token in the pop-up and then "Submit".\
   ![](https://2358536857-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGvQ1spooMwwatkQ2qBRp%2Fuploads%2FvRcaFETT5xluRQ7547FF%2Fimage.png?alt=media\&token=c790d5fd-a73a-4765-839c-b0f7dc2f48a2)
10. You will now see an invite in the bot's response, use this to add it to your server.

{% hint style="warning" %}
Make sure "Require 0Auth2 Grant" is **NOT** turned on!
{% endhint %}


# Configuring Roblox cmds

In this page you will learn what commands you will need to use the Ranking & Verification cmds.

{% hint style="danger" %}
You **MUST** be on PC/laptop to configure Roblox commands. \
A support member can help you if you need this.
{% endhint %}

{% tabs %}
{% tab title="Group ID" %}
To get your group ID, go to your group's page and copy the ID in the link. After this, run `<prefix>settings` then select "edit", and finally select "group ID" and paste the ID.

![The highlighted numbers is your group's ID.](https://media.discordapp.net/attachments/752947301160321044/927353859175751710/Screen_Shot_2022-01-03_at_11.12.56_am.png)
{% endtab %}

{% tab title="Cookie 🍪" %}
**To get your cookie, please follow the following steps or watch** [**this tutorial**](https://www.youtube.com/watch?v=hpAizRc7wxw\&t=32)**.**

Before attempting to get your cookie, please ensure your ranking account has joined your ROBLOX group and been ranked.&#x20;

1\. Open an Private / Incognito tab in google chrome&#x20;

2\. Go to [ROBLOX](https://www.roblox.com/) and login with your bot account / create a bot account&#x20;

3\. Right click and select Inspect&#x20;

4\. Click on Application at the top (You may need to click >> to see more if it does not appear at first.)&#x20;

5\. Click on the website link underneath the 'Cookies' dropdown on the left

6\. Copy the '.ROBLOSECURITY' value, it should look something like:

&#x20;\_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|\_4D........ etc.&#x20;

7\. Close the tab and return to Discord&#x20;

8\. Once you've copied your cookie, use the ​​​​​`<prefix>settings`​​​​​ command, then click `edit​​​`, followed by ​​​`cookie`. The bot will then send you a DM where you should paste your cookie.&#x20;

**Please note that you need to do this in an incognito window and also that you must not log out of the bot, just close the window.**
{% endtab %}
{% endtabs %}


# Overview

Here is an overview of all the commands in a neat space.

Most of our commands have switched over to slash commands! If your bot's slash commands aren't appearing, follow the steps below carefully:

1. Run `<prefix>invite`. (Example: !invite)
2. Kick the bot from your server.
3. Reinvite the bot using by click on the "Invite this bot!" button.

### Commands

In the tabs below is a list of Vibez (slash) commands with a description.

{% tabs %}
{% tab title="Roblox" %}

| Command      | Description                              |
| ------------ | ---------------------------------------- |
| promote      | Promote a member in your group.          |
| demote       | Demote a member in your group.           |
| setrank      | Change someone's rank in your group.     |
| setrankid    | Change someone's rank in your group.     |
| fire         | Fire a member in your group.             |
| getrank      | Check someone's rank in a certain group. |
| shout        | Shout a message to your group shout.     |
| hasgamepass  | Check if someone has a certain gamepass. |
| {% endtab %} |                                          |

{% tab title="Verification" %}

| Command      | Description                                               |
| ------------ | --------------------------------------------------------- |
| verify       | Verify yourself and update your roles.                    |
| reverify     | Change your connected Roblox account.                     |
| getroles     | Update your own roles.                                    |
| updateroles  | Update a member's Discord roles.                          |
| robloxsearch | Search a Roblox user.                                     |
| whois        | Check what Roblox account is connected to a Discord user. |
| {% endtab %} |                                                           |

{% tab title="Moderation" %}

| Command      | Description                                              |
| ------------ | -------------------------------------------------------- |
| modlogs      | Show all of the moderation actions taken against a user. |
| warn         | Warn someone in your Discord server.                     |
| warnings     | Show all the warnings taken against a user.              |
| deletecase   | Delete a case from your server.                          |
| mute         | Mute someone in your Discord server.                     |
| unmute       | Unmute someone in your Discord server.                   |
| kick         | Kick someone from your Discord server.                   |
| ban          | Ban someone from your Discord server.                    |
| unban        | Unban someone from your Discord server.                  |
| purge        | Purge messages in a channel.                             |
| {% endtab %} |                                                          |

{% tab title="Configuration" %}

| Command              | Description                                                      |
| -------------------- | ---------------------------------------------------------------- |
| setpermissions       | Set up permissions for the different roles/ranks and categories. |
| membercounter        | Configure the member counter!                                    |
| welcomer             | Configure the welcomer!                                          |
| cc (custom commands) | View, add or configure custom commands.                          |
| setstatus            | Change the bot's status.                                         |
| verification         | Set up verification.                                             |
| setlogs              | Configure the logging for the bot!                               |
| {% endtab %}         |                                                                  |

{% tab title="Music" %}

| Command      | Description                              |
| ------------ | ---------------------------------------- |
| play         | Plays a song in the voice channel.       |
| nowplaying   | Shows the current playing song.          |
| skip         | Skips the current song.                  |
| stop         | Stops the music and disconnects the bot. |
| pause        | Pauses the current song.                 |
| resume       | Resumes the paused song.                 |
| loop         | Loops the playing song forever.          |
| queue        | Shows the queue.                         |
| removequeue  | Removes a song from the queue.           |
| volume       | Changes the volume of the music.         |
| {% endtab %} |                                          |

{% tab title="Misc" %}

| Command      | Description                                                   |
| ------------ | ------------------------------------------------------------- |
| help         | See a list of all the commands.                               |
| invite       | Invite to Vibez Development and the custom bot it was run on. |
| ping         | Check the latency of the bot.                                 |
| announce     | Announce a message into a channel.                            |
| say          | Send a message as the bot.                                    |
| dm           | Send a DM to someone as the bot.                              |
| badges       | View all obtainable Vibez badges.                             |
| suggest      | Suggest something in the server.                              |
| {% endtab %} |                                                               |

{% tab title="Fun" %}

| Command       | Description                                        |
| ------------- | -------------------------------------------------- |
| jess          | Puppies!                                           |
| ollie         | Ollie is Jess' very cute doggo!                    |
| ship          | Ship someone with another human being... or robot. |
| 8ball         | Ask our magic 8ball anything!                      |
| meme          | Bored? Meme time!                                  |
| pun           | Puns!                                              |
| {% endtab %}  |                                                    |
| {% endtabs %} |                                                    |

{% hint style="info" %}
Currently not all commands are listed in here, this page will only contain slash cmds.
{% endhint %}


# Roblox

In here you will find the Roblox ranking and verification commands.


# Systems

Learn how to use our Roblox systems.

{% hint style="danger" %}
WARNING: Do not share your API key with anyone, doing this will give them access to rank people in your group.
{% endhint %}

{% hint style="info" %}
The products are still in development and are subject to change frequently.
{% endhint %}

## API key

At the moment you have to be a premium customer to get an API key, you can do this by messaging Jacob.#0001 or jess after donating 5 euros / 1000 Robux or more. (one-time payment)

## Usage

⚠ IT IS VERY IMPORTANT IT STAYS IN `ServiceScriptService` or your key will be stolen.  ⚠\
Create a new script in `ServiceScriptService` and put the following code on top:

```lua
local VibezService = require(10352069452)
local funcs = VibezService("YOURKEYHERE") --//YOUR KEY
```

## Implementation

Everything works with modules which you can enable/disable separately, as shown in the example below:

```lua
funcs:EnableCommands("YOURPREFIXHERE") --//YOUR PREFIX I.E "!" or ":"
```

{% hint style="info" %}

## Thank you

I would like to thank Tom (LearnCSharp) / Tom!#2769 for making the Roblox system.\
All credits go to him.
{% endhint %}


# In-game ranking

An overview of all our in-game ranking products.

### Implementation

```lua
--// In-game ranking commands
funcs:EnableCommands("YOURPREFIXHERE") --//YOUR PREFIX I.E "!" (default is "!")

--// In-game ranking UI
funcs:EnableUI()
```

### Usage

#### In-game ranking commands

In chat run the following you can run the following commands commands:

```
<prefix>promote username
<prefix>demote username
<prefix>fire username
<prefix>setrank username rankId
```

#### In-game ranking UI

1. Walk up to the player.
2. Click on the player.
3. Select desired option.

### Additional settings

#### Rank limiting

```lua
funcs.minRank = 1 --// DEFAULT is 255
funcs.maxRank = 255 --// DEFAULT is 255
```


# Ranking center

The ranking center will automatically rank people for you after they buy a gamepass.

### Implementation

To implement the ranking center, download it from our [downloads page](https://vibez.dev/downloads).

### Usage

#### Important

It is important you keep the Script in `ServerScriptStorage`\
In order for it to properly work, you need to enable "Allow Third Party Teleports" in > Home > Game Settings > Security.

![](https://2358536857-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGvQ1spooMwwatkQ2qBRp%2Fuploads%2FEV5iDBtCIii9e2sTKegN%2Fimage.png?alt=media\&token=44e5159e-836f-4d7a-8ae3-75f72e5520d2)

#### Configuration

In `ServerScriptStorage`you can find a configuration file, below you can find an example:

```lua
-- __     ___ _              
-- \ \   / (_) |__   ___ ____
--  \ \ / /| | '_ \ / _ \_  /
--   \ V / | | |_) |  __// / 
--    \_/  |_|_.__/ \___/___|


-- You are using Vibez ranking centre v1.2
-- Created by AnishMarapin & vdJacob (noob) with <3
-- Modified 2 years later by the one and only LearnCSharp


-- In this file you can edit all the settings on how the ranking centre should behave.
return {
	-- All messages it can display --
	SearchingMessage = 'Searching your inventory for gamepasses...'; -- Displays the message when searching.
	SuccessMessage = 'You were ranked sucessfully!'; -- Displays when a rank was sucessful
	LoadingMessage = 'Loading rank...';
	ErrorMessage = 'You do not own any gamepasses higher than the current rank you have.'; -- Displays when a user doesn't own any gamepases OR if the gamepass rank is lower than the rank the user currently has.
	NotInGroupKickMessage = 'Join the group first before trying to claim a rank.'; -- Is a kick message when the user is not in your group.
	
	-- Other settings --
	title = 'disable'; -- set it to 'disable' to disable, set it to anything else to enable. Displays a title with the text.
	
	-- Ranking Configuration --
	ApiKey = 'YOUR API KEY HERE'; -- Insert here your vibez ranking API key
	Ranks = {
		{
			RankID = 5;
			GamePass = 8787681;
		};
		{
			RankID = 2;
			GamePass = 51844649;
		};
	}
}
	
-- DOCUMENTATION OF THE RANKS --

	
-- 	Ranks = {
--		{
--			RankID = 0; -- Please here the ID the user needs to be ranked to upon purchasing the gamepass.
--			GamePass = 0; -- Place here the gamepassID.
--		};
--	}
--}

```


# App centre

With Vibez application centre you can let people apply in your game without having to interview them.

### Implementation

To implement the application centre, download it from our [downloads page](https://vibez.dev/downloads).

### Usage

#### Important

It is important you keep the Script in `ServerScriptStorage`\
In order for it to properly work, you need to enable "Allow Third Party Teleports" in > Home > Game Settings > Security.

![](https://2358536857-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGvQ1spooMwwatkQ2qBRp%2Fuploads%2FEV5iDBtCIii9e2sTKegN%2Fimage.png?alt=media\&token=44e5159e-836f-4d7a-8ae3-75f72e5520d2)

#### Configuration

To configure the application centre, publish the game and play the game **in studio**. You will see a prompt to enter your API Key and after that you will be able to create and edit applications. You can have infinite applications (LR, HR, ...).


# Verification

In this page, you will learn all about setting up verification.

### Automatic verification

With automatic verification, anyone who joins the server will immediately be verified without having to run the command if they are previously verified with Bloxlink or RoVer.\
Set it up with our slash command `/verification autoverification:True`

### Verified role

You can give people a basic role(s) when they verify (like "Verified"), you are able to set up multiple roles at once if you wish.\
Set it up with our slash command `/verification verifiedrole:@role`

{% hint style="info" %}
You can remove a verified role by running the command and selecting the role again.
{% endhint %}

### Nickname template

You can also set up a nickname template which will change the user's nickname in your server.\
Set it up with our slash command `/verification nicknametemplate:template`

| argument          | explanation                                 |
| ----------------- | ------------------------------------------- |
| {username}        | The roblox username of the user.            |
| {displayname}     | The roblox display name of the user.        |
| {id}              | The roblox ID of the user.                  |
| {rank}            | The rank of the user in your main group.    |
| {rankid}          | The rank ID of the user in your main group. |
| {discordusername} | The Discord username of this user.          |
| {discordid}       | The Discord ID of this user.                |
| {discordtag}      | The Discord username and tag of this user.  |


# Configuration

In this category, you can learn more about some popular configuration commands.


# Member counter

In this page, you will learn how to setup the membercounter.

{% hint style="danger" %}
This documentation might not be accurate as we prep for v2 of membercounters.
{% endhint %}

Display and track the member count of your group, showing who joined in real-time!

![An example in bgreenz's group Greenz Corporation](https://2358536857-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGvQ1spooMwwatkQ2qBRp%2Fuploads%2FkQLNiImiW0JJBGTj09j4%2FScreenshot%202023-07-18%20at%202.58.13%20PM.png?alt=media\&token=ae164614-9afe-458d-81e1-08347de9d85d)

### Commands

<table><thead><tr><th>Argument</th><th width="347">Description</th></tr></thead><tbody><tr><td>group-id</td><td>The ID of your Roblox group.</td></tr><tr><td>gained-message</td><td>The message sent when someone joins.</td></tr><tr><td>lost-message</td><td>The message sent when someone leaves. (see message below)</td></tr><tr><td>embed-enabled</td><td>Enable (True) or Disable (False) embeds with the membercounter.</td></tr><tr><td>channel-gained</td><td>The channel to log new members into.</td></tr><tr><td>channel-lost</td><td>The channel to log old members into.</td></tr><tr><td>separator</td><td>The character you want to use to separate the numbers. (more info below)</td></tr></tbody></table>

{% tabs %}
{% tab title="Message" %}
The membercounter has a default message, however you are able to customise it to say what you'd like!

An example of this is the membercounter set up in Vibez:\
`💚`` `**`Username`**` ``has joined {name}.{newline} We've reached {membercount} members! We're {togo} away from {goal}.`\
\
In the table below, you can find variables and their descriptions which you are able to use in your membercounter message.

| Variable      | Description                                                 |
| ------------- | ----------------------------------------------------------- |
| {name}        | The name of the group.                                      |
| {change}      | The amount has the group has gained/lost.                   |
| {type}        | The group has "lost" or "gained".                           |
| {membercount} | The amount of members now.                                  |
| {togo}        | Amount until goal.                                          |
| {goal}        | Goal.                                                       |
| {username}    | \[NEW] The username of the user which joined the group.     |
| {userid}      | \[NEW] The user ID of the user which joined the group.      |
| {displayname} | \[NEW] The display name of the user which joined the group. |
| {ordinal}     | Add an ordinal to your message (st, nd, rd)                 |
| {% endtab %}  |                                                             |

{% tab title="Increment" %}
The increment is a fixed number that allows you to choose the amount of members that are needed to meet the group's next goal.&#x20;

For example: If the increment is set to 100 it will make the goal higher with 100 every time!

If your group's goal is 400, once the goal is met the goal will become 500 automatically.
{% endtab %}

{% tab title="Separator" %}
The separator is used when the group has 1000 members or more. It lets the bot know how you'd like to display the numbers! Whatever you put as the separator will be shown between the thousands and hundreds units. (1\<separator>000)\
\
The table below will show you different ways you are able to use the function:

| Variable  | Description |
| --------- | ----------- |
| {space}   | 1 000       |
| ,         | 1,000       |
| noob      | 1noob000    |
| {default} | 1000        |

If you have already set up the separator and would like to remove it, you are able to use the variable {default}.
{% endtab %}
{% endtabs %}


# Welcomer

In this page, you will learn how to setup the welcomer.

When someone joins/leaves your Discord server, the bot will send a message of your choice into a channel!

![](https://2358536857-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGvQ1spooMwwatkQ2qBRp%2Fuploads%2FXYv7EWcmy97GqqTtG5fv%2FScreen%20Shot%202022-02-19%20at%202.25.23%20pm.png?alt=media\&token=ab424f51-ecbc-468b-bf0a-c6d12ee48409)

{% hint style="info" %}
The welcomer command has a join and leave option.
{% endhint %}

### Commands

{% tabs %}
{% tab title="Join" %}

* To enable(true)/disable(false) this command, run `/welcomer join enabled true|false`
* To choose the channel, run `/welcomer join channel <#channel>`
* To customize the message, run `/welcomer join message <message>`
  {% endtab %}

{% tab title="Leave" %}

* To enable(true)/disable(false) this command, run `/welcomer leave enabled true|false`
* To choose the channel, run `/welcomer leave channel <#channel>`
* To customize the message, run `/welcomer leave message <message>`
  {% endtab %}
  {% endtabs %}

In the table there are variables and their descriptions which you are able to use in your welcomer message.

| Variable         | Description                                                             |
| ---------------- | ----------------------------------------------------------------------- |
| {memberusername} | Shows the username of the member who joined/left. (Jacob.)              |
| {membertag}      | Shows the username and tag of the member who joined/left. (Jacob.#0001) |
| {memberid}       | Shows the ID of the member who joined/left. (514350060515885058)        |
| {membermention}  | Mentions the user who joined/left. (@Jacob.#0001)                       |
| {server}         | Show your server name in the message.                                   |
| {membercount}    | Shows the amount of people in your server currently.                    |


# Custom commands (cc)

In this page, you will learn how to create, view, edit and delete custom commands.

When a user runs a custom command, the bot will send respond with the set message!

{% hint style="info" %}
There are two types of custom commands: text and embed.
{% endhint %}

### Commands

#### Creating custom commands!

{% tabs %}
{% tab title="Text" %}
To create a cc, please run the following command:

* `/cc add text name: <command name>`
* You then need to add a response by using the option `response: <response>`

You are then able to include the following options if you wish:

* `channel: <channel>` (The channel it is allowed to be sent in)
* `allowedroles: <role>` (The role allowed to run the command)
  {% endtab %}

{% tab title="Embed" %}
To create a cc, please run the following command:

* `/cc add embed name: <command name>`

You are then able to include the following options if you wish:

* `title: <title>` ()
* `description: <description>` ()
* `footer: <footer>` ()
* `thumbnail: <thumbnail>` ()
* `image: <image>` ()
* `channel: <channel>` (The channel it is allowed to be sent in)
* `allowedroles: <role>` (The role allowed to run the command)
  {% endtab %}

{% tab title="Variables" %}
You can also have variables which will be filled when a custom command is executed.

| key               | result                                     |
| ----------------- | ------------------------------------------ |
| {discordusername} | The username of the person who ran the CC. |
| {discordid}       | The ID of the person who ran the CC.       |
| {% endtab %}      |                                            |
| {% endtabs %}     |                                            |

{% hint style="danger" %}
We highly advise against using capitals in a command name.
{% endhint %}

#### Viewing custom commands!

There are two ways to view custom commands: a list of all the custom commands or the settings of a particular command.

To view a list of all the custom commands created with your bot run `/cc view list`.

To view a particular command, run `/cc view settings command: <command name>`. This will show you all of settings for that command from the response to who created/edited the command!

#### Editing custom commands!

Editing a custom command is simple! Start by running `/cc edit text|embed name: <command name>`. You are then able to select the option you want changed and replace it with the new value. Keep in mind if you don't edit a certain option it will not change!

#### Deleting custom commands!

To delete a custom command, run `/cc delete command name: <command name>`.

{% hint style="warning" %}
Multiline slash commands are only supported on Discord mobile. \
If you don't have access to a mobile, don't hesitate to contact our support team! We'll happily do it for you.
{% endhint %}


# Tickets

In this page, you will learn how to setup and use tickets.

{% hint style="danger" %}
Tickets are a brand new feature to Vibez, so you may come across a bug! If this happens, please report it in bug-reports.
{% endhint %}

When a ticket is created, the user who created the ticket, and ticket staff and admins will be able to interact with the ticket.

![](https://2358536857-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGvQ1spooMwwatkQ2qBRp%2Fuploads%2FO5ZVhXjSGOhUy8K8P1M0%2FScreen%20Shot%202022-04-23%20at%209.57.57%20pm.png?alt=media\&token=35434309-c363-4b87-b02a-f8d54a0d74ce)

### Commands

#### Setting up tickets!

Setting up tickets can be difficult, but we've tried to make it as simple as possible! You're able to use the deafult settings which are listed in the tab, or set it up yourself using the information we've provided in the other tabs. The command to setup tickets is `/setup tickets <options>`.

{% tabs %}
{% tab title="Default" %}
If you'd prefer to use Vibez default ticket system, you're able to run `/setup tickets`. If not, make sure to look at the other tabs so you can correctly set up your ticket system!

The default settings for tickets can be found below:

| Option          | Description                                                                                                                                                                                                                                                     |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| message         | Create a new ticket by clicking on the button below!                                                                                                                                                                                                            |
| button\_label   | Create ticket                                                                                                                                                                                                                                                   |
| button\_emoji   | <img src="https://2358536857-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGvQ1spooMwwatkQ2qBRp%2Fuploads%2FLUhvcxEaITN2e7ZtsGj7%2Fbutton%20emoji.webp?alt=media&amp;token=1554361a-e334-41b5-a8d6-71a7739bc3b1" alt="" data-size="line"> |
| button\_colour  | Green                                                                                                                                                                                                                                                           |
| channel         | The channel where `/setup` was ran                                                                                                                                                                                                                              |
| ticketcategory  | It goes to the top of the server and has no category                                                                                                                                                                                                            |
| ticketstaffrole | A role named "Ticket Support" (role not automatically made)                                                                                                                                                                                                     |
| ticketping      | @everyone                                                                                                                                                                                                                                                       |

![Some of the options positions are shown on the image above, however not all are included.](https://2358536857-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGvQ1spooMwwatkQ2qBRp%2Fuploads%2FwJFNoZ2WMBU4s2NY32RP%2FScreen%20Shot%202022-04-23%20at%2010.37.54%20pm.png?alt=media\&token=593d7e8a-10ba-4697-a911-1a0f402431f4)
{% endtab %}

{% tab title="Message & button" %}

* `message`

When setting up tickets, the bot will send a message into the specified channel. This is the message displayed above the button that people click on to create tickets.

Along with the message, a button will be attached so users are able to  create their tickets. You are able to customise the button's label, colour and emoji.

* `button_label`

The button label is the message displayed on button to create a ticket.

* `button_colour`

The button colour option allows you to choose from 4 options: blue, grey, green and red.

* `button_emoji`

The emoji on the button is displayed on the left hand side, next to the button label. You're able to use any emoji, whether that be a Discord default emoji or a Nitro animated\emoji.
{% endtab %}

{% tab title="Placement" %}

* `channel`

The channel option is where the message and button will be sent so users are able to create tickets.&#x20;

* `ticketcategory`

The category option is where new/open tickets will be moved to.
{% endtab %}

{% tab title="Ticket roles" %}

* `ticketstaffrole`

Ticket staff are able to view, claim, and read all tickets. Once a ticket is claimed, only the user who claimed the ticket is able to speak in it and close the ticket when it's completed. Additionally, only the claimer is allowed to add and/or remove users from the ticket.

* `ticketadminrole`

Ticket admins bypass many restrictions set in place for ticket staff. They are able to read, view and claim tickets, however they are able to speak in all tickets, even if they have not claimed it. Along with this, ticket admins are able to close tickets (even if they haven't claimed it), add and/or remove users from tickets, and create tickets for users.
{% endtab %}

{% tab title="Creation response" %}
When a ticket is created, the bot sends a message in the channel with information staff may find helpful. This includes a welcome message, the ticket description, and information about the ticker creator (ID, server nickname, when the user joined the server, and their roles).

You are able to choose the welcome message and the ping.

* `welcomemessage`

The welcomemessage is the first thing sent inside of a ticket - it's the perfect place to present information to customers before your staff respond.\
An example of this is: Thank you for contacting Vibez Support! A member of our Team will be here with you shortly. If you haven't yet, please describe your issue and attach necessary screenshots.

* `ticketping`

The ticketping is the ping used to notify staff once a ticket is opened. It is placed directtly below the welcomemessage. You are able to choose between the everyone and here ping, or not to add any ping.<br>

![This is what a ticket looks like when it's created!](https://2358536857-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGvQ1spooMwwatkQ2qBRp%2Fuploads%2FYMFDywqXfuc11zheh6le%2FScreen%20Shot%202022-04-23%20at%2010.08.30%20pm.png?alt=media\&token=6f70e349-e8fa-4228-98bd-2070f10892a7)
{% endtab %}

{% tab title="Ticket logs" %}
When a ticket is closed, the ticket is logged in a txt file. Inside of the logs you are able to see who claimed, closed, sent messages and images, and everything inbetween inside of the ticket.

![](https://2358536857-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGvQ1spooMwwatkQ2qBRp%2Fuploads%2F7lJ0wT3TLL5yYXjtQzX2%2FScreen%20Shot%202022-04-23%20at%2010.34.50%20pm.png?alt=media\&token=25d7dfca-2615-4651-b355-c25ad337f296)

* `logchannel`

The logchannel option allows you to choose the channel ticket logs are sent to.
{% endtab %}
{% endtabs %}

#### Using ticket commands!

Tickets have commands staff/admins are able to use to make your experience better! The command is `/ticket <subcategory>`. More information can be found in the tabs below.

{% tabs %}
{% tab title="Create" %}

* `/ticket create user:<user>`

With the create ticket command, users with the ticket admin role are able to create a ticket for someone else.&#x20;
{% endtab %}

{% tab title="Add/remove user" %}

* `/ticket adduser user:<user>`

If a second individual needs to be added to a ticket, the staff member that claimed the ticket or a ticket admin is able to run the command and give them access to the channel.

* `/ticket removeuser user:<user>`

If a user needs to be removed from a ticket, the staff member that claimed the ticket or a ticket admin is able to run the command and remove them from the channel.
{% endtab %}
{% endtabs %}