Getting Started

Enabling the Ticket System

Configuration Options

Set up and customize your ticket panel with the following options:

Option	Description	Example
Enabled	Set this to true to enable the ticket panel.	true
LogsChannelID	Specify the channel ID for logging ticket activities.	"LOGS_CHANNEL_ID"
MaxTickets	Set the maximum number of tickets a user can have open at once.	3
useSelectMenu	Set to true to use a select menu for ticket options.	true

Ticket Panel Configuration

Define how your ticket panel should look and function.

Example Configuration

TicketPanelSettings:
  Panel1:
    Embed:
      Title: "Support Tickets"
      Description:
        - "> If you need any assistance, click the button below!"
        - "> Our staff team will assist you shortly!"
      Footer:
        Text: "Your Server Name | Ticket System"
        Icon: "https://i.imgur.com/w5XxKpc.png"
      Color: "#F44336"
      Image: "https://i.imgur.com/LbjDuZ8.png"

Hint: Customize the embed to match your server's branding and provide clear instructions to users.

How the Panel Links into TicketType

The TicketPanelSettings configuration defines how the ticket panel looks and functions. Each panel is linked to specific ticket types defined in the TicketTypes section. This linking allows for multiple panels, each with its own set of ticket types.

Example Ticket Type Configuration

Set up different types of tickets and link them to the ticket panels.

TicketTypes:
  TicketType1:
    Enabled: true
    Panel: "Panel1" # Link to the panel defined in TicketPanelSettings
    Name: "General Support"
    ChannelName: "{ticket-id}-General-{user}-{priority}"
    ChannelTopic: "{userid}-{priority}"
    CategoryID: "CATEGORY_ID"
    ArchiveCategory: "CATEGORY_ID"
    SupportRole: ["ROLE_ID1", "ROLE_ID2"]
    UserRole: ["ROLE_ID3", "ROLE_ID4"]
    TagSupport: true # Should SupportRole be tagged on creation
    TagCreator: true # Should UserRole be tagged on creation
    Button: # Styling used in the panel
      Name: "Get Support"
      Emoji: "🔍"
      Style: "Primary"
      Description: "Get help with any issues."

Option	Description	Example
Enabled	Set this to true to enable the ticket type.	true
Panel	Link to the panel defined in TicketPanelSettings.	"Panel1"
Name	The name of the ticket type.	"General Support"
ChannelName	Define the channel name format.	"{ticket-id}-General-{user}-{priority}"
ChannelTopic	Define the channel topic format.	"{userid}-{priority}"
CategoryID	ID of the category where the ticket channels will be created.	"CATEGORY_ID"
ArchiveCategory	ID of the category where tickets will be archived.	"CATEGORY_ID"
SupportRole	Roles that will have access to support tickets.	["ROLE_ID1", "ROLE_ID2"]
UserRole	Roles that will have access to their own tickets.	["ROLE_ID3", "ROLE_ID4"]
TagSupport	Should SupportRole be tagged on creation.	true
TagCreator	Should UserRole be tagged on creation.	true
Button	Define the styling and text for the button used in the panel.	See example above