Configuration

The config is not easy to understand at first sight, so let's break down the whole config line per line.

General Settings

Defines how long cooldown there should be on tickets (in seconds)

ticket-cooldown

Defines how many tickets each player can create in total.

max-tickets-per-player

Defines how many characters should show on a single line in a GUI, before being split into multiple lines

max-length-for-text-gui

Message Settings

This section is pretty straightforward. Handles how messages & titles will look in-game.

Ticket Settings

Status display name

This section allows you to change the display name of the various ticket statuses.

Priority display name

This section allows you to change the display name of the various ticket priorities.

Ticket Categories

Now, for creating your own ticket categories. It's not too hard. Below is an example for a "Bug Reports" ticket category.

ticket-categories:
  bug-reports:
    display-name: "&c&lBug Reports"
    required-permission: ""
    player-ticket-limit: -1
    global-ticket-limit: -1
    command: "bugreport"
    archive-only: false
    input-fields:
      when:
        ordinal: 0
        display-name: "When did the bug occur?"
        required: true
        type: "text"
        min-length: 3
        max-length: 150
      description:
        ordinal: 1
        display-name: "Describe the bug in detail"
        required: true
        type: "text"
        min-length: 10
      reproduce:
        ordinal: 2
        display-name: "How to reproduce?"
        required: false
        type: "text"

Firstly, the name of the ticket category is important. This name must be unique and cannot contain spaces. The name is on line 2 in the example.

Then there are some additional variables for the ticket category.

Name	Required	Description
display-name	Yes	The display name of the ticket category
required-permission	No	The permission required to view tickets in this category
command	No	Will create a command that automatically opens the ticket creation GUI for this category
player-ticket-limit	No	How many tickets a player can create in this category
global-ticket-limit	No	How many tickets can be active in this category at once
archive-only	No	If set to true, tickets will not be deleted when their status is changed to "Archived".

Now, for creating your custom input fields, similar to the name of the category, there must be a unique name for the variable. And there are some required variables.

Name	Required	Description
ordinal	Yes	This decides in which order the inputs appear for the player. The lower number, the earlier it gets sorted. The first input should have ordinal 0.
display-name	Yes	This is which is displayed to the player when asked for this input. We recommend using a question or statement here.
required	Yes	Is the input field required or can players leave empty?
type	Yes	The type of the input field. Read more below.

There are currently 4 different types of input fields available: boolean, decimal, number and text. I will explain each below, aswell as which variables are available for each input field.

Text

This input field represents a text input. The following variables are available:

• url-only: Only allows submitting URLs.

• min-length: Choose the minimum amount of characters in the text.

• max-length: Choose the maximum amount of characters in the text.

Boolean

This input field represents a yes/no value.

Number

This input field represents a number input (non-decimal). The following variables are available:

• min-number: Choose the lowest number possible.

• max-number: Choose the highest number possible.

Decimal

This input field represents a number input (decimal). The following variables are available:

• min-number: Choose the lowest number possible.

• max-number: Choose the highest number possible.