Files
SupportBot/Configs/supportbot.yml
T

369 lines
8.6 KiB
YAML
Raw Normal View History

2021-10-23 20:12:04 -05:00
# ___ _ ___ _
# / __> _ _ ___ ___ ___ _ _ _| |_ | . > ___ _| |_
# \__ \| | || . \| . \/ . \| '_> | | | . \/ . \ | |
# <___/`___|| _/| _/\___/|_| |_| |___/\___/ |_|
# |_| |_|
2021-10-04 20:41:05 +01:00
#
2024-11-09 00:37:51 +00:00
# SupportBot created by Emerald Services
2021-10-04 20:41:05 +01:00
# Installed with MIT License
#
2024-11-09 00:37:51 +00:00
# Discord Support: https://discord.gg/emeraldsrv
# Website: https://emeraldsrv.dev
2024-11-09 00:37:51 +00:00
#
# SupportBot Configuration (supportbot.yml)
2021-10-04 20:41:05 +01:00
2026-05-19 23:22:11 +01:00
SupportBot_Version: "v26.3.0"
2021-10-07 20:46:18 +01:00
2021-10-04 20:41:05 +01:00
# -------------------------
2022-08-12 01:35:36 +01:00
# General
2021-10-04 20:41:05 +01:00
# -------------------------
2022-07-22 13:19:05 +01:00
General:
2026-05-16 15:10:27 +01:00
Name: "SupportBo"
2026-03-10 20:02:43 +00:00
Token: "BOT_TOKEN"
2022-08-12 01:35:36 +01:00
Addons:
2024-07-03 13:46:57 +01:00
Enabled: true
2026-05-26 20:11:22 +01:00
GuildId: ""
2026-05-16 15:10:27 +01:00
2021-10-04 20:41:05 +01:00
# -------------------------
2022-08-12 01:35:36 +01:00
# Activity
2021-10-04 20:41:05 +01:00
# -------------------------
2022-07-23 07:50:12 +01:00
Activity:
2026-05-16 15:10:27 +01:00
Status: "Char"
Type: "Watching"
2022-07-23 07:50:12 +01:00
StreamingURL: "https://www.twitch.tv/YOUR_TWITCH_NAME"
2024-11-09 00:37:51 +00:00
# Available Types:
# Playing
# Watching
# Listening
# Competing
# Streaming (URL required)
# You can also update the activity via Discord using: /settings
2024-10-10 19:14:45 +01:00
2026-05-16 15:10:27 +01:00
# -------------------------
# Embeds
# -------------------------
2021-10-04 20:41:05 +01:00
2022-08-11 19:19:29 +01:00
Embed:
Colours:
2025-09-23 23:23:19 +01:00
General: "#0cc559"
Success: "#04b545"
Error: "#d13030"
Warn: "#fca117"
2022-08-11 19:19:29 +01:00
Footer: "SupportBot | Developed by Emerald Development"
2024-11-09 00:37:51 +00:00
# Use 0x<hexcode> to change the colour of the embeds.
2026-05-16 15:10:27 +01:00
# -------------------------
# Roles
# -------------------------
2021-10-04 20:41:05 +01:00
2022-08-12 01:35:36 +01:00
Roles:
AutoRole:
Enabled: true
2026-05-26 20:11:22 +01:00
Role: "ROLE_ID"
2021-10-04 20:41:05 +01:00
2022-08-12 01:35:36 +01:00
StaffMember:
2026-05-26 20:11:22 +01:00
Staff: "ROLE_ID"
Admin: "ROLE_ID"
Moderator: "ROLE_ID"
2024-11-09 00:37:51 +00:00
Mod:
AllowSupportStaff: false
# Allow Support Staff to use the /mod command. (More in detail customisation in commands.yml)
2021-10-07 20:46:18 +01:00
2026-05-16 15:10:27 +01:00
# ----------------------------
# System Messages
# ----------------------------
2022-06-16 02:31:58 +01:00
2026-05-16 15:10:27 +01:00
Welcome:
2026-05-16 17:35:39 +01:00
Enabled: false
2026-03-10 20:02:43 +00:00
Channel: "CHANNEL_ID"
2022-06-22 23:30:59 +01:00
2026-05-16 15:10:27 +01:00
Leave:
2026-05-16 17:35:39 +01:00
Enabled: false
2026-03-10 20:02:43 +00:00
Channel: "CHANNEL_ID"
2022-06-16 02:31:58 +01:00
2021-10-25 23:19:07 +01:00
# ----------------------------
2022-08-12 01:35:36 +01:00
# Suggestions
2021-10-25 23:19:07 +01:00
# ----------------------------
2022-08-12 01:35:36 +01:00
Suggestions:
2025-09-20 23:09:22 +01:00
Mode: "Channel" # Channel or Forum
2026-02-14 13:05:07 +00:00
ForumChannel: "FORUM_CHANNEL_ID" # A forum channel, disabled if mode is set to Channel.
2026-03-10 20:02:43 +00:00
Channel: "CHANNEL_ID" # A text channel, disabled if mode is set to Forum.
2025-08-07 13:54:35 +01:00
2022-08-12 01:35:36 +01:00
UpvoteEmoji: "✅"
DownvoteEmoji: "❌"
2024-06-12 12:54:31 +01:00
UpvoteTitle: "Yes"
DownvoteTitle: "No"
OwnSuggestion: true
2024-11-09 00:37:51 +00:00
2024-06-12 12:54:31 +01:00
# 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
2026-05-16 15:10:27 +01:00
2022-08-12 01:35:36 +01:00
Threads:
Enabled: true
Title: "Suggestion-releated Thread"
Reason: "A thread releted to this suggestion"
2022-06-16 02:31:58 +01:00
2024-06-12 12:54:31 +01:00
Buttons:
Upvote: "2"
Downvote: "2"
RemoveVote: "4"
RemoveVote_Title: "Remove Vote"
# Available Button Styles
# 1 - Blurple
# 2 - Grey
# 3 - Green
# 4 - Red
2025-09-20 23:09:22 +01:00
Tags:
2026-05-16 15:10:27 +01:00
Created: "TAG_ID"
Considering: "TAG_ID"
Solved: "TAG_ID"
Denied: "TAG_ID"
2025-09-20 23:09:22 +01:00
2021-10-04 20:41:05 +01:00
# -------------------------
2022-08-12 01:35:36 +01:00
# Tickets
2021-10-04 20:41:05 +01:00
# -------------------------
2024-11-09 00:37:51 +00:00
VoiceTickets:
2026-05-16 15:10:27 +01:00
Name: "%username%'s VC"
2026-03-10 20:02:43 +00:00
Category: "CATEGORY_ID"
2024-11-09 00:37:51 +00:00
2022-08-12 01:35:36 +01:00
Ticket:
2026-05-16 15:10:27 +01:00
TicketType: "channels"
2024-11-09 00:37:51 +00:00
# Available TicketTypes:
# channels - Tickets will be created as channels in the TicketChannelsCategory
# threads - Tickets will be created as threads through the "TicketHome" channel.
2024-10-10 19:14:45 +01:00
2026-03-10 20:02:43 +00:00
UserManagement:
DMOnAdd: true # DM the user when they are added to the ticket
DMOnRemove: true # DM the user when they are removed from the ticket
DMTranscript: true # DM the user a transcript of the ticket when it is closed
2026-05-26 20:11:22 +01:00
TicketHome: "CHANNEL_ID"
2024-11-09 00:37:51 +00:00
2024-10-10 19:14:45 +01:00
# What is TicketHome?
# - Channel where the Ticket creation panel is sent.
# - Channel where ticket threads are made. (only if ticket threads is enabled above.)
2024-11-09 00:37:51 +00:00
# For TicketType: channels
2026-05-26 20:11:22 +01:00
TicketChannelsCategory: "CATEGORY_ID"
2026-03-10 20:02:43 +00:00
TicketChannelsCategory2: "CATEGORY_ID" # This will be used if the first category has reached the max channel limit.
2026-05-26 20:11:22 +01:00
TicketArchiveCategory: "CATEGORY_ID"
2024-10-10 19:14:45 +01:00
# ---
2024-06-12 12:54:31 +01:00
2022-08-12 01:35:36 +01:00
Channel: "ticket-" # The prefix for ticket channel names
2024-06-12 12:54:31 +01:00
TicketsPerUser: 100
TicketReason: true
# If ticket reason is set to false, It will not prompt to create a reason
2024-11-09 00:37:51 +00:00
2022-08-12 01:35:36 +01:00
TicketSubject: "description"
2024-11-09 00:37:51 +00:00
# Available TicketSubjects:
2022-08-12 01:35:36 +01:00
# "description" will display the ticket reason within the channel description
# "embed" will display the ticket reason within the ticket embed
2024-11-09 00:37:51 +00:00
2022-08-12 01:35:36 +01:00
Timeout: 5
# Set to true to allow all staff to access the ticket
2021-12-18 20:54:01 -06:00
2022-08-12 01:35:36 +01:00
Close:
StaffOnly: true
# Set to false is anyone is able to close a ticket.
2024-10-10 19:14:45 +01:00
2026-05-16 15:10:27 +01:00
Invites:
# Invites is for ticket threads.
2024-06-12 12:54:31 +01:00
StaffOnly: true
ClaimTickets:
2026-03-11 18:58:15 +00:00
Enabled: false
2026-05-26 20:11:22 +01:00
Channel: "CHANNEL_ID"
2024-11-09 00:37:51 +00:00
# Channel where the ticket assignments are sent for staff to claim.
2026-05-16 15:10:27 +01:00
2024-07-03 13:46:57 +01:00
ClaimAcceptTime: 120000
# How long the assigned user has to accept the ticket before it gets re-assigned to someone else.
2024-10-10 19:14:45 +01:00
# 120000 = 2 Minutes
# 180000 = 3 Minutes
# 240000 = 4 Minutes
# 300000 = 5 Minutes
# Time in Mliseconds
2024-07-03 13:46:57 +01:00
2024-06-12 12:54:31 +01:00
ButtonTitle: "Claim Ticket"
2024-07-03 13:46:57 +01:00
ButtonEmoji: "🎫"
2024-06-12 12:54:31 +01:00
Button: "1"
# Available Button Styles
# 1 - Blurple
# 2 - Grey
# 3 - Green
# 4 - Red
2024-11-09 00:37:51 +00:00
ReviewSystem:
2026-05-16 15:10:27 +01:00
Enabled: false
2026-03-10 20:02:43 +00:00
Channel: "CHANNEL_ID"
2024-11-09 00:37:51 +00:00
UseModal: true
2026-05-16 15:10:27 +01:00
Questions:
# Default questions asked when a ticket is created, these are used if departments are disabled.
Enabled: false
2024-11-09 00:37:51 +00:00
List:
- "Please provide your account email?"
- "What is the nature of your issue?"
- "Have you tried resolving the issue yourself?"
Log:
2026-05-26 20:11:22 +01:00
TicketDataLog: "CHANNEL_ID"
2024-11-09 00:37:51 +00:00
TickeDataTitle: "Ticket Data"
2026-05-26 20:11:22 +01:00
TicketBlacklistLog: "CHANNEL_ID"
2026-03-10 20:02:43 +00:00
2026-03-11 18:58:15 +00:00
AIMode:
2026-05-16 17:35:39 +01:00
Enabled: false
2026-03-11 18:58:15 +00:00
ThreadName: "Chat with SupportBot AI"
WelcomeMessage: "Hi! I’m SupportBot AI. You can chat with me here about your issue."
2026-05-16 15:10:27 +01:00
# -------------------------
# Ticket Departments
# -------------------------
2026-03-10 20:02:43 +00:00
DepartmentSystem:
2026-05-16 17:35:39 +01:00
Enabled: false
2026-03-10 20:02:43 +00:00
Placeholder: "Choose a ticket department"
DefaultDepartment: "general"
Departments:
general:
Name: "General Support"
2026-04-21 13:37:39 +01:00
Description: "Open a general support ticket"
2026-03-10 20:02:43 +00:00
Emoji: "🎫"
Category: "CATEGORY_ID"
Role: "ROLE_ID"
ChannelPrefix: "support-"
DefaultPriority: "normal"
Questions:
- "What do you need help with?"
- "When did the issue start?"
purchase:
Name: "Purchase Support"
2026-04-21 13:37:39 +01:00
Description: "Get help with store purchases"
2026-03-10 20:02:43 +00:00
Emoji: "💳"
Category: "CATEGORY_ID"
Role: "ROLE_ID"
ChannelPrefix: "purchase-"
DefaultPriority: "high"
Questions:
- "What is your order ID?"
- "What product did you purchase?"
- "What payment issue are you having?"
reports:
Name: "Player Report"
2026-04-21 13:37:39 +01:00
Description: "Report a player for breaking the rules"
2026-03-10 20:02:43 +00:00
Emoji: "🚨"
Category: "CATEGORY_ID"
Role: "ROLE_ID"
ChannelPrefix: "report-"
DefaultPriority: "normal"
Questions:
- "Who are you reporting?"
- "What happened?"
- "Do you have evidence?"
appeals:
Name: "Ban Appeals"
2026-04-21 13:37:39 +01:00
Description: "Appeal a server punishment"
2026-03-10 20:02:43 +00:00
Emoji: "⚖️"
Category: "CATEGORY_ID"
Role: "ROLE_ID"
ChannelPrefix: "appeals-"
DefaultPriority: "low"
Questions:
- "What punishment are you appealing?"
- "Why should it be reviewed?"
- "Anything else staff should know?"
PrioritySystem:
2026-03-11 18:58:15 +00:00
Enabled: false
2026-03-10 20:02:43 +00:00
DefaultPriority: "Normal"
AllowUsersToChooseOnOpen: true
Priorities:
low:
Name: "Low"
Emoji: "🟢"
normal:
Name: "Normal"
Emoji: "🟡"
high:
Name: "High"
Emoji: "🟠"
urgent:
Name: "Urgent"
Emoji: "🔴"
2024-11-09 00:37:51 +00:00
2022-08-12 01:35:36 +01:00
# -------------------------
# Buttons
# -------------------------
Buttons:
2024-11-09 00:37:51 +00:00
General:
Delete: "🗑️"
DeleteStyle: "4"
Voice:
TicketDeleteText: "Delete Voice Channel"
2022-08-12 01:35:36 +01:00
Tickets:
2024-06-12 12:54:31 +01:00
ClaimEmoji: "🧑‍💻"
ClaimStyle: "1"
2024-07-30 17:45:35 +01:00
Unarchive: "Unarchive Ticket"
Unarchive_Emoji: "♻️"
Unarchive_Style: "2"
Unlock: "Unlock Ticket"
Unlock_Emoji: "🔓"
Unlock_Style: "2"
2024-06-12 12:54:31 +01:00
# Available Button Styles
# 1 - Blurple
# 2 - Grey
# 3 - Green
# 4 - Red
2022-06-23 00:05:08 +01:00
2026-05-16 15:10:27 +01:00
# -------------------------
# Select Menus
# -------------------------
2024-06-12 12:54:31 +01:00
SelectMenus:
Tickets:
PanelEmoji: "⚙️"
2026-05-16 15:10:27 +01:00
2024-06-12 12:54:31 +01:00
CloseEmoji: "🗑️"
ArchiveEmoji: "♻️"
2024-07-30 17:45:35 +01:00
LockEmoji: "🔐"
2024-10-10 19:14:45 +01:00
RenameEmoji: "🏷️"
2024-11-09 00:37:51 +00:00
VCEmoji: "🔊"
2024-07-30 17:45:35 +01:00
EnableInvitesEmoji: "📤"
DisableInvitesEmoji: "📥"
2022-06-23 00:05:08 +01:00
2022-08-12 01:35:36 +01:00
# -------------------------
2024-11-09 00:37:51 +00:00
# Logging
2022-08-12 01:35:36 +01:00
# -------------------------
2021-10-21 19:28:23 +01:00
2024-11-09 00:37:51 +00:00
MessageDelete:
2026-05-26 20:11:22 +01:00
Channel: "CHANNEL_ID"
2024-11-09 00:37:51 +00:00
Colour: "#d92525"
MessageUpdate:
2026-05-26 20:11:22 +01:00
Channel: "CHANNEL_ID"
2024-11-09 00:37:51 +00:00
Colour: "#f2a024"
2022-08-12 01:35:36 +01:00
Translate:
2026-05-26 20:11:22 +01:00
TranslateLog: "CHANNEL_ID"