Files
SupportBot/Configs/supportbot.yml
T

264 lines
7.2 KiB
YAML
Raw Normal View History

2021-10-23 20:12:04 -05:00
# ___ _ ___ _
# / __> _ _ ___ ___ ___ _ _ _| |_ | . > ___ _| |_
# \__ \| | || . \| . \/ . \| '_> | | | . \/ . \ | |
# <___/`___|| _/| _/\___/|_| |_| |___/\___/ |_|
# |_| |_|
2021-10-04 20:41:05 +01:00
#
# SupportBot created by Emerald Services
# Installed with MIT License
#
2021-10-25 00:15:54 -05:00
# Discord Support: https://emeraldsrv.dev/discord
# Community Resources: https://emeraldsrv.dev/resources
2021-10-04 20:41:05 +01:00
2023-04-19 15:58:03 +02:00
SupportBot_Version: "v7.7.2"
2021-10-07 20:46:18 +01:00
2021-10-04 20:41:05 +01:00
# -------------------------
# General Configuration
# -------------------------
Name: "SupportBot"
2022-06-28 03:14:54 +01:00
Token: "BOT_TOKEN HTTPS://DISCORD.COM/DEVELOPERS"
2021-10-04 20:41:05 +01:00
# -------------------------
# Activity Configuration
# -------------------------
2022-06-23 00:05:08 +01:00
BotActivity: "Here to help!"
2021-10-04 20:41:05 +01:00
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"
2022-06-23 00:05:08 +01:00
EmbedFooter: "SupportBot | Developed by Emerald Services"
2021-10-04 20:41:05 +01:00
ErrorColour: "#d12519"
SuccessColour: "#04b545"
2021-10-23 20:12:04 -05:00
WarningColour: "#fca117"
2021-10-04 20:41:05 +01:00
# -------------------------
# Role Configuration
# -------------------------
AutoRole: true
2022-06-21 01:38:22 +01:00
JoinRole: "Member"
2021-10-04 20:41:05 +01:00
2021-10-27 19:48:00 -05:00
Staff: "Staff"
Admin: "Admin"
2021-10-04 20:41:05 +01:00
TicketBlackListRole: "Blacklisted"
2021-10-07 20:46:18 +01:00
2022-06-16 02:31:58 +01:00
# ----------------------------
# Join/Leave Configuration
# ----------------------------
2022-06-16 22:12:14 +01:00
Welcome: true
# set to false to disable joining logs
2022-06-16 02:31:58 +01:00
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
2022-06-16 22:12:14 +01:00
Leave: true
# set to false to disable leaving logs
2022-06-16 02:31:58 +01:00
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
2022-06-22 23:30:59 +01:00
# -------------------------
# Information Configuration
# -------------------------
InfoTitle: "Information"
InfoButtonText: "Visit Site"
2022-08-20 23:02:47 +01:00
AboutMe: "I am SupportBot"
2022-06-22 23:30:59 +01:00
InfoURL: "https://emeraldsrv.dev"
InfoColour: "#f74343"
2022-06-16 02:31:58 +01:00
2021-10-25 23:19:07 +01:00
# ----------------------------
# Suggestions Configuration
# ----------------------------
SuggestionChannel: "suggestions"
2021-10-28 19:08:06 -05:00
SuggestionUpvote: "✅"
SuggestionDownvote: "❌"
2021-10-25 23:19:07 +01:00
2022-06-21 01:38:22 +01:00
SuggestionThreads: true
# set to false to disable threads being created from suggestions.
2022-06-21 01:41:17 +01:00
DisableSuggestions: false
2022-06-23 00:05:08 +01:00
# Set to true to disable the suggestions feature.
2022-06-21 01:41:17 +01:00
2022-06-16 02:31:58 +01:00
# -------------------------
# Translate Configuration
# -------------------------
TranslateLogChannel: "translations-log"
2021-10-04 20:41:05 +01:00
# -------------------------
# Tickets Configuration
# -------------------------
2021-10-27 19:48:00 -05:00
TicketPrefix: "ticket-" # The prefix for ticket channel names
2021-10-04 20:41:05 +01:00
2022-06-16 02:31:58 +01:00
TicketLog: "ticket-data"
TranscriptLog: "ticket-data"
2021-10-04 20:41:05 +01:00
2022-02-27 00:39:36 +00:00
DMTranscripts: true
2021-10-04 20:41:05 +01:00
TranscriptTitle: "Ticket Transcript"
2021-11-23 15:50:56 -06:00
TicketLog_Title: "Ticket Closed"
2021-10-04 20:41:05 +01:00
TicketBlackListMessage: "You are not allowed to open a ticket"
2022-06-23 00:05:08 +01:00
TicketRoleMention: "@here"
2022-11-12 12:54:57 +01:00
TicketClaimMessage: "Your ticket will be handled by" #Automaticly tags user to the end
TicketClaimTitle: "Ticket Claimed"
2022-06-23 00:05:08 +01:00
# To ping a role: <@ROLE_ID>
2021-10-04 20:41:05 +01:00
2021-12-18 20:54:01 -06:00
MaxAllowedTickets: 2
2021-10-04 20:41:05 +01:00
TicketSubject: "description"
2022-02-04 20:00:31 -06:00
# "description" will display the ticket reason within the channel description
# "embed" will display the ticket reason within the ticket embed
2021-10-04 20:41:05 +01:00
AllowTicketMentions: true
# Set to true to allow the ticket to mention the author and the support team.
2022-02-04 20:00:31 -06:00
# Set false to dis-allow mentions within tickets.
2021-10-04 20:41:05 +01:00
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
2021-10-04 20:41:05 +01:00
# --- 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"
2022-06-22 23:30:59 +01:00
# -------------------------
# Tickets Categories
# -------------------------
2021-10-04 20:41:05 +01:00
2021-12-18 20:54:01 -06:00
Timeout: 5
2022-06-23 00:05:08 +01:00
2022-02-11 23:34:38 -06:00
# Set to true to allow all staff to access the ticket
AllowAllStaff: false
2021-10-04 20:41:05 +01:00
2021-10-23 20:15:07 -05:00
# Ticket roles are the roles that will be able to gain access to tickets depending on what department has been chosen.
2021-10-04 20:41:05 +01:00
2022-02-11 23:34:38 -06:00
Departments:
2022-06-16 02:31:58 +01:00
- title: "Support"
role: "Staff"
color: "SECONDARY"
2022-02-11 23:34:38 -06:00
emoji: "1️⃣"
2022-06-22 23:30:59 +01:00
category: "Tickets"
2022-06-21 01:38:22 +01:00
2022-02-11 23:34:38 -06:00
- title: "Billing Support"
2022-06-16 02:31:58 +01:00
role: "Staff"
color: "SECONDARY"
2022-02-11 23:34:38 -06:00
emoji: "2️⃣"
2022-06-23 00:05:08 +01:00
category: "Tickets"
2022-06-21 01:38:22 +01:00
2022-02-11 23:34:38 -06:00
- title: "Admin Team"
role: "Admin"
2022-06-16 02:31:58 +01:00
color: "SECONDARY"
2022-02-11 23:34:38 -06:00
emoji: "3️⃣"
2022-06-23 00:05:08 +01:00
category: "Tickets"
2022-06-22 23:30:59 +01:00
2022-06-16 02:31:58 +01:00
# - title: "Other"
# role: "Staff"
# color: "SECONDARY"
# emoji: "3️⃣"
# category: "Tickets"
# Discord Button Colour Selection
# PRIMARY - Blurple
# SECONDARY - Grey
# DANGER - Red
# SUCCESS - Green
2022-02-11 23:34:38 -06:00
2022-06-23 00:05:08 +01:00
# --- Buttons Config ---
# --- Start ---
LockTicketCategory: "Archive"
TicketCloseEmoji: "❌"
TicketDeleteEmoji: "⛔"
TicketLockEmoji: "🔒"
2022-11-12 12:54:57 +01:00
TicketClaimEmoji: "🧑‍💻"
2022-06-23 00:05:08 +01:00
TicketCloseColour: "DANGER"
TicketDeleteColour: "DANGER"
TicketLockColour: "PRIMARY"
2022-11-12 12:54:57 +01:00
TicketClaimColour: "SUCCESS"
2022-06-23 00:05:08 +01:00
# 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.
2021-10-04 20:41:05 +01:00
# --- Closing Config ---
# --- Start ---
2021-12-18 19:39:59 -06:00
StaffOnly: true
2021-10-04 20:41:05 +01:00
ClosingTicket: ":warning: You have requested to close your support ticket."
ClosingConfirmation_Word: "confirm"
2022-06-16 02:31:58 +01:00
CloseConfirmation: true
2021-10-04 20:41:05 +01:00
2021-10-21 19:28:23 +01:00
# ---------------------------
# 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!"