Supportbot Wiki

Brought to you by: itsnyoty

Configuration Setup

SupportBot Configuration

First thing you'll need to do is configure the bot to match with your Discord server.

SupportBot.yml

#      ___                            _    ___        _
#    / __> _ _  ___  ___  ___  _ _ _| |_ | . > ___ _| |_
#     \__ \| | || . \| . \/ . \| '_> | |  | . \/ . \ | |
#     <___/`___||  _/|  _/\___/|_|   |_|  |___/\___/ |_|
#                |_|  |_|
#
#           SupportBot created by Emerald Development
#           Installed with MIT License
#
#           Discord Support: https://dsc.gg/emerald-dev
#           Official Documentation: https://github.com/Emerald-Services/SupportBot/wiki
#           Third-Party Documentation: COMING SOON

SupportBot_Version: "v8.0"
# Do not change the version number

# -------------------------
#   General
# -------------------------

General:
  Name: "SupportBot"
  Token: "BOT_TOKEN_HERE"
  # To get your Discord Bot Token, Go to https://discord.com/developers/applications

  Addons:
    Enabled: false

# -------------------------
#  Activity
# -------------------------

Activity:
  Status: "SupportBot v8"
  Type: "Competing"
  # The Type can either be Playing, Watching, Listening or Competing
  StreamingURL: "https://www.twitch.tv/YOUR_TWITCH_NAME"
  # Set The Type to "Streaming" for a streaming status!

# -------------------------
#  Embeds
# -------------------------

Embed:
  Colours:
    General: 0x0cc559 # 0x<hexcode>
    Success: 0x04b545 # 0x<hexcode>
    Error: 0xd13030 # 0x<hexcode>
    Warn: 0xfca117 # 0x<hexcode>

  Footer: "SupportBot | Developed by Emerald Development"

# -------------------------
#  Roles
# -------------------------

Roles:
  AutoRole:
    Enabled: true
    Role: "Member"

  StaffMember:
    Staff: "Staff"
    Admin: "Admin"

  ModRoles:
    Muted: "Muted"
    Blacklisted: "Blacklisted"

# ----------------------------
#  System Messages
# ----------------------------

Welcome: 
  Enabled: true
  Channel: "🚨┃join-leave-logs"

Leave: 
  Enabled: true
  Channel: "🚨┃join-leave-logs"

# ----------------------------
#  Suggestions
# ----------------------------

Suggestions:
  Channel: "📗┃suggestions"
  UpvoteEmoji: "✅"
  DownvoteEmoji: "❌"

  UpvoteTitle: "Yes"
  DownvoteTitle: "No"

  OwnSuggestion: true
  # If false this will not allow the user to vote for a suggestion they created
  # If true this will allow the user to vote for a suggestion they created

  ShowUsers: true

  Threads:
    Enabled: true
    Title: "Suggestion-releated Thread"
    Reason: "A thread releted to this suggestion"

  Buttons:
    Upvote: "2"
    Downvote: "2"
    RemoveVote: "4"
    RemoveVote_Title: "Remove Vote"

    # Available Button Styles
    # 1 - Blurple
    # 2 - Grey
    # 3 - Green
    # 4 - Red

# -------------------------
#  Tickets
# -------------------------

Ticket:
  TicketCategory: "📗┃tickets" #Where tickets normally go with the /ticket command
  # This is the channel name for the ticket threads to be created, NOT A DISCORD CATEGORY!

  Channel: "ticket-" # The prefix for ticket channel names
  TicketsPerUser: 100
  DMTranscripts: true
  TicketReason: true
  # If ticket reason is set to false, It will not prompt to create a reason
  TicketSubject: "description"
  # "description" will display the ticket reason within the channel description
  # "embed" will display the ticket reason within the ticket embed
  Timeout: 5
  # Set to true to allow all staff to access the ticket

  Log:
    TicketLog: "🚨┃ticket-data"
    TicketLog_Title: "Ticket Closed"
    DisableTicketLogChannel: false

    TranscriptLog: "🚨┃ticket-data"
    TranscriptTitle: "Ticket Transcript"

  Close:
    StaffOnly: true
    # Set to false is anyone is able to close a ticket.
    Confirmation_Button: "Confirm Close"
    Title: "Are you sure you want to close this ticket?"

  Invites:
    StaffOnly: true

  ClaimTickets:
    Enabled: true
    Channel: "0000000000000000000" 
    # Channel name or Channel ID

    ButtonTitle: "Claim Ticket"
    Button: "1"

    # Available Button Styles
    # 1 - Blurple
    # 2 - Grey
    # 3 - Green
    # 4 - Red


# -------------------------
#   Departments - NOT IN THIS UPDATE
# -------------------------

Departments:
  - title: "Create Ticket"
    role: "Staff"
    color: "2"
    emoji: "🎫"
    category: "TICKETS"

# -------------------------
#  Buttons
# -------------------------
Buttons:
  Tickets:
    ClaimEmoji: "🧑‍💻"
    ClaimStyle: "1"

    # Available Button Styles
    # 1 - Blurple
    # 2 - Grey
    # 3 - Green
    # 4 - Red


# -------------------------
#  Select Menus
# -------------------------

SelectMenus:
  Tickets:
    PanelEmoji: "⚙️"
    CloseEmoji: "🗑️"
    ArchiveEmoji: "♻️"
    LockTicketEmoji: "🔒"
    UnLockTicketEmoji: "🔓"
    EnableInvitesEmoji: "🔒"
    DisableInvitesEmoji: "🔓"
    AddUserEmoji: "➕"
    RemoveUserEmoji: "➖"


# -------------------------
#  Misc
# -------------------------

Translate:
  Log: "🚨┃logs"

Commands.yml

#      ___                            _    ___        _
#    / __> _ _  ___  ___  ___  _ _ _| |_ | . > ___ _| |_
#     \__ \| | || . \| . \/ . \| '_> | |  | . \/ . \ | |
#     <___/`___||  _/|  _/\___/|_|   |_|  |___/\___/ |_|
#                |_|  |_|
#
#           SupportBot created by Emerald Services
#           Installed with MIT License
#
#           Discord Support: https://dsc.gg/emerald-dev
#           Official Documentation: https://emeraldsrv.dev/wiki
#           Third-Party Documentation: https://emeraldsrv.dev/third-party
#
#           Command Configuration

Help:
  Command: "help"
  Description: "Get a list of all the commands."
  Permission: ["SendMessages"]
  Enabled: true

EnableAI:
  Command: "enableai"
  Description: "Talk with SupportBot"
  Permission: ["SendMessages"]
  Enabled: true

Info:
  Command: "info"
  Description: "Get information about the **ServerName**."
  Permission: ["SendMessages"]
  Enabled: true

TicketPanel:
  Command: "ticketpanel"
  Description: "Create the ticket creation panel"
  Permission: ["Administrator"]
  Enabled: true

TicketStats:
  Command: "ticketstats"
  Description: "Shows staff members their ticket statistics"
  Permission: ["SendMessages"]
  # Command is automatically disabled when the TicketClaims is disabled.

OpenTicket:
  Command: "ticket"
  Description: "Create a support ticket."
  Permission: ["SendMessages"]
  Enabled: true

Add:
  Command: "add"
  Description: "Add a user to the ticket."
  Permission: ["SendMessages"]
  Enabled: true

CloseTicket:
  Command: "close"
  Description: "Close a support ticket"
  Permission: ["SendMessages"]
  Enabled: true

Suggestion:
  Command: "suggest"
  Description: "Create a suggestion."
  Permission: ["SendMessages"]
  Enabled: true

Embed:
  Command: "embed"
  Description: "Build a discord embed."
  Permission: ["SendMessages"]
  Enabled: true

Translate:
  Command: "translate"
  Description: "Translate something to english"
  Permission: ["SendMessages"]
  Enabled: false

UserInfo:
  Command: "userinfo"
  Description: "Get info about a user."
  Permission: ["SendMessages"]
  Enabled: true

Ping:
  Command: "ping"
  Description: "Pong."
  Permission: ["SendMessages"]
  Enabled: true

# ---------------------------------------
#   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."

Messages.yml

#      ___                            _    ___        _
#    / __> _ _  ___  ___  ___  _ _ _| |_ | . > ___ _| |_
#     \__ \| | || . \| . \/ . \| '_> | |  | . \/ . \ | |
#     <___/`___||  _/|  _/\___/|_|   |_|  |___/\___/ |_|
#                |_|  |_|
#
#           SupportBot created by Emerald Services
#           Installed with MIT License
#
#           Discord Support: https://dsc.gg/emerald-dev
#           Official Documentation: https://emeraldsrv.com/wiki
#           Third-Party Documentation: https://emeraldsrv.com/third-party
#
#           Messages Configuration

Info:
  Title: "About Us"
  Description: "SupportBot is an open-sourced support system for discord. It's completely free to use with high amounts of customization to match your own brand."
  Button: "Visit Site"
  URL: "https://emeraldsrv.com"
  Colour: "#f74343"

Welcome:
  Embed:
    Colour: "#f74343"
    Title: "Welcome to ServerName"
    Message: "> :smile: %joined_user% has just landed!"
    Thumbnail: "BOT"

    ImageEnabled: false
    ImageURL: "https://animagelink.png/"

Leave:
  Embed:
    Colour: "#f74343"
    Title: "Goodbye!"
    Message: "> :slight_frown: %joined_user% has recently dropped out!"
    Thumbnail: "BOT"

    ImageEnabled: false
    ImageURL: "https://animagelink.png/"

Suggestions:
  Sent_Title: "Suggestion Sent!"
  Sent: "> :white_check_mark: **You have successfully sent a suggestion.**"
  NoSelfVote: "> :x: **You cannot vote on your own suggestion.**"
  RemoveVoteButton: "Remove Vote"

Ticket:

#  Available Placeholders:

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

  TicketAuthorTitle: "%ticketusername%'s Ticket"
  TicketTitle: "Support Ticket"
  TicketMessage: "> Hello <@%ticketauthor%>, Thank you for creating a support ticket\nPlease wait patiently whilst a member of our team reaches out to you."
  TicketThumbnail: "https://images.emojiterra.com/google/android-pie/512px/1f39f.png"
  TicketCreatedAlert: "> :ticket: Ticked Created: <#%ticketid%>"
  TicketExists: "> ❌ Ticket already exists"
  TicketClaim: "> :white_check_mark: Ticket claimed by" #The user who claimed the ticket will be added to the end of this message
  TicketUnclaim: "> :white_check_mark: Ticket unclaimed by" #The user who claimed the ticket will be added to the end of this message

  DisableInvites: "> 🔒 Invites have been disabled for this ticket." 
  EnableInvites: "> 🔓 Invites have been enabled for this ticket."

#  Available Placeholders:

#  <@%user%> - Tags the user who was added to the ticket.

  AddUserToTicket_Title: "➕ Add User!"
  AddUserToTicket: "> To add a user to this ticket, Tag them."

  RemovedUserFromTicket_Title: "➖ Removed User!"
  RemovedUserFromTicket: "> <@%user%> has been `Removed` from this ticket"

  Blacklisted: "> :x: You are not allowed to open a ticket"
  Muted: "> :x: You are `Muted` and therefore not allowed to open any tickets"
  InvalidSubject: "> No Reason Provided!"

  TranscriptSavedMessage: "📝 **Transcript Saved!**"
  TicketLockMessage: "❌ **Ticket Locked!**"
  TicketDeleteMessage: "⚠ **Ticket Deleting!**"

  ClosingTicket: "> :warning: You have requested to close your support ticket."
  ConfirmClose: "> Please confirm closing the ticket by clicking the button below."
  CloseTimeout: "> Ticket close confirmation timed out."

  ClaimTickets:
    ClaimTitle: "Incoming Support Request!"
    ClaimMessage: "> A new ticket has been created by <@!%user%>. Click the button below to claim this ticket."
    ClaimMessage_Edit: "> <#%channel%> was claimed by <@!%user%>."

    ClaimedTitle: "Ticket Claimed!"
    Claimed: "> You have successfully claimed this ticket. <#%channel%>"
    NoPermsToClaimTitle: "Error, no permissions!"
    NoPermsToClaim: "> :x: **Err!** You do not permissions to claim this ticket."

TicketStats: 
  OpenTickets: "✅ Open Tickets"
  TotalTickets: "🎫 Total Tickets"
  ResponseTime: "⏱️ Average Response Time"

  Title: "Your Ticket Stats"

Error:
  IncorrectPerms: "> :x: **Err!** You do not have the correct permissions to use this."
  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!"

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
# -------------------------------

Panel: true

# ----------------------------------------
#   Ticket Panel Message Configuration #2b2d31
# ----------------------------------------

TicketCategory: "📗┃tickets"
# This is the channel name for the ticket threads to be created, NOT A DISCORD CATEGORY!

PanelTitle: "SupportBot"
PanelColour: "#0cc559"

Button:
  Text: "Create Ticket"
  Emoji: "🎫"
  Color: "2"

# Available Button Styles
# 1 - Blurple
# 2 - Grey
# 3 - Red
# 4 - Green

TicketPanel_Description: true
TicketPanel_Thumbnail: false
TicketPanel_Image: true

PanelMessage: "Click on the button to file a `Ticket` and our team will try their best to assist you in the best way we can!"
PanelThumbnail: "https://i.imgur.com/ieeZejl.png"
PanelImage: "https://i.imgur.com/dejQvkg.png"

SupportBot-AI.yml

# -------------------------
#   SupportBot AI
#
# In order to use the SupportBot AI, You need to setup an OpenAI Account. 
# this can be done at https://platform.openai.com/
# -------------------------

Enabled: true

General:
  Name: "SupportBot AI"
  # What would you like to call your AI
  Model: "gpt-4o"
  # You can see a list of OpenAI Models here: https://platform.openai.com/docs/models

  Tokens: 400
  # Max tokens you can set is 400
  # For more information about tokens, go to https://openai.com/api/pricing/

  OpenAI_Key: "OPEN_AI_APIKEY_HERE"
  # To create an OpenAI API key, go to https://platform.openai.com/api-keys


  PastebinAPI_Key: "PASTEBIN_API_KEY"
  # You can get your Pastebin API Key from https://pastebin.com
  PastebinAPI_URL: "https://pastebin.com/api/api_post.php"

Channels:
  AIChannel: "1250190338954498048"
  # This is the channel where AI will respond in without needing to mention the bot.

Embed:
  Color: 0x0cc559  # 0x<hexcode>
  Footer: "SupportBot | Developed by Emerald Development"

Messages:
  MessageTooLong: "The response was too long, so I've posted it here: {pastebin}"
  ErrorResponse: "I didn't receive a proper response from OpenAI. Please try again later."
  OpenAIError: "I'm having some trouble talking to SupportBot AI's Model, OpenAI. Please try again later."
  AIDisabled: "I am disabled, You have enable me in `supportbot-ai.yml`"