Configuration

SupportBot Configurations #

Once you’ve installed all modules, created your application & invited it to your server. You can now go ahead and configure SupportBot to your liking. This part of the documentation is more about what you want rather than us being informative.

You’ll find all the configuration files located in the /Configs/ folder.

/Configs/SupportBot.yml #

#      ___                            _    ___        _
#    / __> _ _  ___  ___  ___  _ _ _| |_ | . > ___ _| |_
#     \__ \| | || . \| . \/ . \| '_> | |  | . \/ . \ | |
#     <___/`___||  _/|  _/\___/|_|   |_|  |___/\___/ |_|
#                |_|  |_|
#
#           SupportBot created by Emerald Services
#           Installed with MIT License
#
#           Discord Support: https://emeraldsrv.dev/discord
#           Community Resources: https://emeraldsrv.dev/resources

SupportBot_Version: "v7.7"

# -------------------------
#   General Configuration
# -------------------------

Name: "SupportBot"
Token: "BOT_TOKEN HTTPS://DISCORD.COM/DEVELOPERS"

# -------------------------
#  Activity Configuration
# -------------------------

BotActivity: "Here to help!"

StreamingURL: "https://www.twitch.tv/YOUR_TWITCH_NAME"
# Set The ActivityType to "STREAMING" for a streaming status!

ActivityType: "PLAYING"
# Activity status can either be PLAYING, WATCHING, LISTENING or STREAMING.

# -------------------------
#  Embed Configuration
# -------------------------

EmbedColour: "#f74343"
EmbedFooter: "SupportBot | Developed by Emerald Services"

ErrorColour: "#d12519"
SuccessColour: "#04b545"
WarningColour: "#fca117"

# -------------------------
#  Role Configuration
# -------------------------

AutoRole: true
JoinRole: "Member"

Staff: "Staff"
Admin: "Admin"
TicketBlackListRole: "Blacklisted"

# ----------------------------
#  Join/Leave Configuration
# ----------------------------

Welcome: true
  # set to false to disable joining logs

WelcomeChannel: "join-leave-logs"
WelcomeColour: "#f74343"
WelcomeTitle: "User Joined!"
WelcomeMessage: "%joined_user% has joined the server!"
  # Available Placeholders:
  # %joined_user% - Mentions the user who joined

EmbedWelcomeImage: true
EmbedWelcomeImageURL: "https://media.discordapp.net/attachments/958247876344025108/986777740738986094/unknown.png"

EmbedWelcomeThumbnail: "BOT" 
  # "USER" will display the user's profile picture.
  # "BOT" will display the bot's profile picture.
  # false to disable

Leave: true
  # set to false to disable leaving logs

LeaveChannel: "join-leave-logs"
LeaveColour: "#f74343"
LeaveTitle: "User Left!"
LeaveMessage: "%joined_user% has left the server!"
  # Available Placeholders:
  # %joined_user% - Mentions the user who joined

EmbedLeaveImage: true
EmbedLeaveImageURL: "https://cdn.discordapp.com/attachments/958247876344025108/986778170223120384/unknown.png"

EmbedLeaveThumbnail: false 
  # "USER" will display the user's profile picture.
  # "BOT" will display the bot's profile picture.
  # false to disable

# -------------------------
#  Information Configuration
# -------------------------

InfoTitle: "Information"

InfoButtonText: "Visit Site"
InfoURL: "https://emeraldsrv.dev"
InfoColour: "#f74343"

# ----------------------------
#  Suggestions Configuration
# ----------------------------

SuggestionChannel: "suggestions"
SuggestionUpvote: "✅"
SuggestionDownvote: "❌"

SuggestionThreads: true
# set to false to disable threads being created from suggestions.

DisableSuggestions: false
# Set to true to disable the suggestions feature.

# -------------------------
#  Translate Configuration
# -------------------------

TranslateLogChannel: "translations-log"

# -------------------------
#  Tickets Configuration
# -------------------------

TicketPrefix: "ticket-" # The prefix for ticket channel names

TicketLog: "ticket-data"
TranscriptLog: "ticket-data"

DMTranscripts: true
TranscriptTitle: "Ticket Transcript"
TicketLog_Title: "Ticket Closed"
TicketBlackListMessage: "You are not allowed to open a ticket"
TicketRoleMention: "@here"
# To ping a role: <@ROLE_ID>

MaxAllowedTickets: 2

TicketSubject: "description"
# "description" will display the ticket reason within the channel description
# "embed" will display the ticket reason within the ticket embed

AllowTicketMentions: true
# Set to true to allow the ticket to mention the author and the support team.
# Set false to dis-allow mentions within tickets.

AllowThanksForReachingOutMessage: true 
# Set to true to allow the "Thanks for reaching out Message" to be sent when the ticket is created
DisableTicketLogChannel: false
# Set to true to disable the requirement of the "TicketLog"
# Set to true to also disable the ticket logs to be sent in the "TicketLogs" channel

# --- Creation Config ---
#      --- Start ---

# Available Placeholders:

# %ticketusername% - User who created the ticket.
# <@%ticketauthor%> - Tags the user who created the ticket.
# <#%ticketid%> - Mentions the ticket channel.

Ticket_Title: "Server Support | %ticketusername%"
TicketMessage: "Hello <@%ticketauthor%>, Thank you for creating a support ticket\nPlease wait patiently whilst a member of our team reaches out to you."

Ticket_Thumbnail: "https://images.emojiterra.com/google/android-pie/512px/1f39f.png"
NoTicketSubject: "No Reason Provided!"

TicketCreatedAlert: ":ticket: Your support ticket has been created: <#%ticketid%>"

AddedUser: "👍 <@%user%> has been added to this ticket"
RemovedUser: "👍 <@%user%> has been removed from this ticket"

# -------------------------
#   Tickets Categories
# -------------------------

Timeout: 5

# Set to true to allow all staff to access the ticket
AllowAllStaff: false

# Ticket roles are the roles that will be able to gain access to tickets depending on what department has been chosen.

Departments:
  - title: "Support"
    role: "Staff"
    color: "SECONDARY"
    emoji: "1️⃣"
    category: "Tickets"

  - title: "Billing Support"
    role: "Staff"
    color: "SECONDARY"
    emoji: "2️⃣"
    category: "Tickets"

  - title: "Admin Team"
    role: "Admin"
    color: "SECONDARY"
    emoji: "3️⃣"
    category: "Tickets"

#  - title: "Other"
#    role: "Staff"
#    color: "SECONDARY"
#    emoji: "3️⃣"
#    category: "Tickets"

# Discord Button Colour Selection
# PRIMARY - Blurple
# SECONDARY - Grey
# DANGER - Red
# SUCCESS - Green

# --- Buttons Config ---
#      --- Start ---

LockTicketCategory: "Archive"

TicketCloseEmoji: "❌"
TicketDeleteEmoji: "⛔"
TicketLockEmoji: "🔒"

TicketCloseColour: "DANGER"
TicketDeleteColour: "DANGER"
TicketLockColour: "PRIMARY"

# Discord Button Colour Selection
# PRIMARY - Blue
# SECONDARY - Grey
# DANGER - Red
# SUCCESS - Green

TranscriptSavedMessage: "📝 **Transcript Saved!**"
TicketLockMessage: "❌ **Ticket Locked!**"
TicketDeleteMessage: "⚠ **Ticket Deleting!**" # Tickets deleting after 5 seconds by default.

# --- Closing Config ---
#    --- Start ---

StaffOnly: true
ClosingTicket: ":warning: You have requested to close your support ticket."
ClosingConfirmation_Word: "confirm"
CloseConfirmation: true

# ---------------------------
#  Error / Warning Messages
# ---------------------------

IncorrectPerms: ":x: **Err!** You do not have the correct permissions to use this command."
InvalidChannel: ":x: **Err!** Channel not found. Please create it!"
UserNotFound: ":x: **Err!** This user doesn't exist, Are they in this server?"
NoValidTicket: ":warning: You cannot execute this command here."
TicketExists: ":warning: This ticket cannot be opened, It already exists!"

/Configs/Ticket-Panel.yml #

#      ___                            _    ___        _
#    / __> _ _  ___  ___  ___  _ _ _| |_ | . > ___ _| |_
#     \__ \| | || . \| . \/ . \| '_> | |  | . \/ . \ | |
#     <___/`___||  _/|  _/\___/|_|   |_|  |___/\___/ |_|
#                |_|  |_|
#
#           SupportBot created by Emerald Services
#           Installed with MIT License
#
#           Discord Support: https://emeraldsrv.dev/discord
#           Community Resources: https://emeraldsrv.dev/resources

# -------------------------------
#   Ticket Panel Configuration
# -------------------------------

TicketPanel: true

# ----------------------------------------
#   Ticket Panel Message Configuration
# ----------------------------------------

Channel: "ticket-creation"

PanelTitle: "Need Help? Create a Support Ticket."
PanelColour: "#f74343"

TicketPanel_Description: true
TicketPanel_Thumbnail: true
TicketPanel_Image: true

PanelMessage: "Click the button to open a new support ticket."
PanelThumbnail: "https://i.imgur.com/ieeZejl.png"
PanelImage: "https://i.imgur.com/5NkcmDq.png"

/Configs/Commands.yml #

#      ___                            _    ___        _
#    / __> _ _  ___  ___  ___  _ _ _| |_ | . > ___ _| |_
#     \__ \| | || . \| . \/ . \| '_> | |  | . \/ . \ | |
#     <___/`___||  _/|  _/\___/|_|   |_|  |___/\___/ |_|
#                |_|  |_|
#
#           SupportBot created by Emerald Services
#           Installed with MIT License
#
#           Discord Support: https://emeraldsrv.dev/discord
#           Community Resources: https://emeraldsrv.dev/resources

# -------------------------------
#   Command Name Configuration
# -------------------------------

Blacklist: "blacklist"
TicketAdd: "add"
TicketRemove: "remove"
OpenTicket: "ticket"
CloseTicket: "close"
InfoCommand: "info"
PingCommand: "ping"
HelpCommand: "help"
EmbedCommand: "embed"
SuggestCommand: "suggest"
TranslateCommand: "translate"
UserInfoCommand: "userinfo"

# ---------------------------------------
#   Command Description Configuration
# ---------------------------------------

BlacklistDesc: "Blacklist a user from creating Tickets."
TicketAddDesc: "Add a user to a support ticket."
TicketRemoveDesc: "Remove a user from a support ticket."
TranslateCommandDesc: "Translates the language provided, along with the abbreviation (2 char) long language code"
OpenTicketDesc: "Open a new support ticket."
CloseTicketDesc: "Close your support ticket."
InfoCommandDesc: "Get information about the brand."
PingCommandDesc: "Pong!"
HelpCommandDesc: "Get a list of all the commands."
EmbedCommandDesc: "Send a message as an embed."
SuggestCommandDesc: "Suggest a feature for the server."
UserInfoCommandDesc: "Get info about a user."

Powered by BetterDocs