# Configuring Solix Ticketing

Solix Ticketing is broken down into two parts: General settings and ticket panels. This is done to make it easier for you to configure this module. All configuration are within the same file, but for simplicities sake, we have broken up this guide into the above sections.

#### General Settings

This part of the configuration file controls general settings that will apply globally to the bot. It is important that this is configured correctly otherwise the rest of the bot will not function. No extra explanation is given as this section is relatively simple. 

```yaml
####################
# GENERAL SETTINGS #
####################
enabled: true # This determines whether the module is enabled not, false by default.
logsChannel: "CHANNEL_ID" # Where ticket transcripts are sent. 
port: 8000 # The port the server is running on
```

#### Ticket Panels

This below is the ticket panels, it controls each individual ticketing instance. To create another ticketing instance, simply copy the configuration file after panelId and paste it underneath. Ensure that it is all in-line, as otherwise it will not work.

```yaml
#################
# TICKET PANELS #
#################
ticketPanel:
  - panelId: 0 # Indexing must start at 0
    panelName: "General Ticket" # The name of the panel. 
    prefix: "ticket-{user}" # {user} will be replaced with the user's username, {ran} replaces it with a random integer.

    options:
      maxTickets: 1 # Max amount of tickets, 0 means unlimited
      questions: # Questions to be asked when opening a ticket.
        enabled: true # Whether questions should be asked.
        questions: # The questions to be asked, you should only have up to 5 questions.
          - "Example question 1"
          - "Example question 2?"
      claiming: # Whether tickets should be claimed by a staff member.
        enabled: true 
        channel: "CHANNEL_ID" # Channel where the ticket will be claimed.

    embeds:
      ticketPanel: # Embed where the user will open a ticket
        title: "Create a general ticket" # The title of the ticket panel.
        description: "Het help from our support team" # The description of the ticket panel.
        colors: "Blue" # The color of the ticket panel.
        footer: "Solix" # The footer of the ticket panel.

        button: # Button for embed.
          label: "Create Ticket" # The label of the button for the ticket panel.
          style: 1 # The style of the button for the ticket panel [Read more here: https://discord.com/developers/docs/interactions/message-components#buttons-button-styles]
          emoji: 🎫 # The emoji of the button for the ticket panel.

      ticketOpened: # Embed displayed after opening a ticket.
        title: "Thanks for contacting support" # The title of the embed displayed after opening a ticket.
        description: "One of our team members will be in touch shortly to discuss your ticket." # The description of the embed displayed after opening a ticket.
        colors: "Green" # The color of the embed displayed after opening a ticket.
        footer: "Solix" # The footer of the embed displayed after opening a ticket.

      questions: # This is the embed where the question answers will be displayed.
        title: "Ticket Details" # Title of embed
        colors: "Blue" # Colour of embed
        footer: "Solix" # Footer of embed

    permissions: # Permissions for the ticket panel.
      roles: # Roles that can view the ticket panel. You can have as many as you want. 
        - "ROLE_ID"
      category: "CATEGORY_ID" # Category where the ticket panel will be created.
```