Files
SupportBot/supportbot-config.yml
T

327 lines
9.4 KiB
YAML
Raw Normal View History

2021-06-30 21:30:41 +01:00
# ___ _ ___ _
# / __> _ _ ___ ___ ___ _ _ _| |_ | . > ___ _| |_
# \__ \| | || . \| . \/ . \| '_> | | | . \/ . \ | |
# <___/`___|| _/| _/\___/|_| |_| |___/\___/ |_|
# |_| |_|
2020-06-15 23:58:37 +01:00
#
2021-06-30 21:30:41 +01:00
# SupportBot created by Emerald Services
# Installed with MIT License
2021-02-02 17:15:24 +00:00
#
2021-06-30 21:30:41 +01:00
# Discord Support: https://emeraldsrv.dev/discord
2020-06-15 23:58:37 +01:00
2021-08-05 13:40:19 +01:00
SupportBot_Version: "7.1 pre-2"
2020-06-15 23:58:37 +01:00
2021-06-30 21:30:41 +01:00
# -------------------------
# General Configuration
# -------------------------
2021-08-05 01:03:58 +01:00
Token: "BOT_TOKEN_HERE"
2021-06-30 21:30:41 +01:00
Prefix: "!!"
2020-07-15 18:42:07 +01:00
Bot_Name: "SupportBot"
2020-06-15 23:58:37 +01:00
2021-06-30 21:30:41 +01:00
DeleteMessages: true
# Should the bot delete command messages after executed?
# -------------------------
# Activity Configuration
# -------------------------
2021-02-02 16:07:28 +00:00
BotActivity: "-help | SupportBot"
2021-06-30 21:30:41 +01:00
2021-02-02 17:01:58 +00:00
StreamingURL: "https://www.twitch.tv/YOUR_TWITCH_NAME"
2021-06-30 21:30:41 +01:00
# Set The ActivityType to "STREAMING" for a streaming status!
2021-02-02 16:07:28 +00:00
2020-06-15 23:58:37 +01:00
ActivityType: "PLAYING"
2021-02-02 17:01:58 +00:00
# Activity status can either be PLAYING, WATCHING, LISTENING or STREAMING.
2020-06-24 09:50:14 +01:00
2021-06-30 21:30:41 +01:00
# -------------------------
# Embed Configuration
# -------------------------
2020-06-15 23:58:37 +01:00
2021-06-30 21:30:41 +01:00
EmbedColour: "#f74343"
2020-06-15 23:58:37 +01:00
EmbedFooter: "SupportBot | The #1 Supportive Discord Bot"
ErrorColour: "#d12519"
SuccessColour: "#04b545"
WarningColour: "#fca117"
2021-06-30 21:30:41 +01:00
# -------------------------
# Help Configuration
# -------------------------
2021-05-23 10:44:00 +02:00
2021-06-30 21:30:41 +01:00
HelpMenu: true # Do not change!
2021-06-30 21:33:16 +01:00
SendHelpPage: "channel" # Set to channel or dm
2021-05-23 10:44:00 +02:00
2021-06-30 21:30:41 +01:00
# -------------------------
# Role Configuration
# -------------------------
2020-06-15 23:58:37 +01:00
2021-05-22 23:41:39 +02:00
AutoRole: true
2020-06-20 13:02:46 +01:00
AutoRole_Role: "Member"
2020-07-11 13:17:57 +01:00
LockdownRole: "@everyone"
2020-06-15 23:58:37 +01:00
2021-03-27 16:58:27 +00:00
Staff: "Staff"
2021-06-30 21:30:41 +01:00
Admin: "Admin"
2021-04-17 22:15:59 +02:00
TicketBlackListRole: "Blacklisted"
2020-06-15 23:58:37 +01:00
2021-06-30 21:30:41 +01:00
# -------------------------
# Tickets Configuration
# -------------------------
# --- General Config ---
# --- Start ---
2020-06-15 23:58:37 +01:00
2021-08-05 01:03:58 +01:00
TicketCategory: "▬▬ TICKETS ▬▬"
2020-06-15 23:58:37 +01:00
TicketChannel: "ticket"
2021-06-30 21:30:41 +01:00
2020-06-15 23:58:37 +01:00
TicketLog: "ticket-logs"
TranscriptLog: "transcripts"
2021-06-30 21:30:41 +01:00
TranscriptTitle: "Ticket Transcript"
2021-08-05 13:39:44 +01:00
TicketLog_Title: "Ticket Log"
2021-06-30 21:30:41 +01:00
TicketBlackListMessage: "You are not allowed to open a ticket"
2020-06-15 23:58:37 +01:00
TicketSubject: "description"
2021-06-30 21:30:41 +01:00
# "description" will displays the ticket reason within the channel description
# "embed" will displays the ticket reason within the ticket embed
2020-12-18 13:37:56 +00:00
2021-05-22 23:41:39 +02:00
AllowTicketMentions: true
# Set to true to allow the ticket to mention the author and the support team.
# Set to false to dis-allow mentions within tickets.
2021-02-02 17:15:24 +00:00
2021-06-30 21:30:41 +01:00
# --- Panel Config ---
# --- Start ---
ReactionChannel: "create-ticket"
ReactionEmoji: "📩"
# For cusomt emojis: <:emoji_name:EMOJI_ID>
2021-02-02 16:09:23 +00:00
2021-03-24 16:25:16 +00:00
ReactionTickets: true
2020-12-18 13:37:56 +00:00
ReactionMessage: "React with %reaction_emoji% to create a Support Ticket!"
2021-06-30 21:30:41 +01:00
2021-03-24 16:25:16 +00:00
ReactionPanel_Description: true
ReactionDescription: "Create a support ticket to contact a member of staff."
2021-06-30 21:30:41 +01:00
2021-03-24 16:25:16 +00:00
ReactionPanel_Thumbnail: true
ReactionThumbnail: "https://hotemoji.com/images/dl/5/ticket-emoji-by-twitter.png"
2021-06-30 21:30:41 +01:00
2021-03-24 16:25:16 +00:00
ReactionPanel_Image: true
ReactionImage: "https://wallpapercave.com/wp/wp4462546.jpg"
2021-02-02 13:50:53 +00:00
2021-06-30 21:30:41 +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.
2020-06-15 23:58:37 +01:00
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."
2021-06-30 21:30:41 +01:00
Ticket_Thumbnail: "https://images.emojiterra.com/google/android-pie/512px/1f39f.png"
2020-06-15 23:58:37 +01:00
NoTicketSubject: "No Reason Provided!"
2021-06-30 21:30:41 +01:00
2020-06-15 23:58:37 +01:00
TicketCreatedAlert: ":ticket: Your support ticket has been created: <#%ticketid%>"
2020-07-14 19:17:40 +01:00
AddedUser: "👍 <@%user%> has been added to this ticket"
RemovedUser: "👍 <@%user%> has been removed from this ticket"
2021-08-05 01:03:58 +01:00
TicketLockReaction: "🔒"
TicketDeleteReaction: "⛔"
TranscriptSavedMessage: "📝 **Transcript Saved!**"
TicketLockMessage: "❌ **Ticket Locked!**"
TicketDeleteMessage: "⚠ **Ticket Deleting!**" # Tickets deleting after 5 seconds by default.
TicketDeleteTime: 5000 # Time must be set in miliseconds.
2021-06-30 21:30:41 +01:00
# --- Closing Config ---
# --- Start ---
2020-06-24 09:50:14 +01:00
ClosingTicket: ":warning: You have requested to close your support ticket."
ClosingConfirmation_Word: "confirm"
2021-05-22 23:41:39 +02:00
CloseConfirmation: true
2020-06-24 09:50:14 +01:00
2021-06-30 21:30:41 +01:00
# --- Departments Config ---
# --- Start ---
2020-06-15 23:58:37 +01:00
2021-05-22 23:41:39 +02:00
TicketDepartments: true
2020-06-15 23:58:37 +01:00
2021-05-22 23:41:39 +02:00
AllowStaff: true
2021-06-30 21:30:41 +01:00
# If set to true users with the "Staff" role will not be able to view tickets
# without a valid department role set below.
# Set to false to allow "Staff" to see tickets whether its a department for them or not.
2020-06-15 23:58:37 +01:00
DepartmentEmoji_1: "🙋"
DepartmentEmoji_2: "💸"
DepartmentEmoji_3: "📗"
# Ticket emojis, the emojis are what users will need to react with inorder to proceed furthur if departments are enabled.
DepartmentTitle_1: "Support"
DepartmentTitle_2: "Billing"
DepartmentTitle_3: "Other"
# Ticket department title, This is the title for a ticket department to help users know what is available.
DepartmentRole_1: "Support"
DepartmentRole_2: "Admin"
DepartmentRole_3: "Support"
# Ticket roles are the roles that will be able to gain access to tickets depending on what department has been choosen.
2021-06-30 21:30:41 +01:00
# --------------------------------
# System Messages Configuration
# --------------------------------
# Available Placeholders:
# %guildname% - This displays the name of the discord server.
2020-06-15 23:58:37 +01:00
2021-05-22 23:41:39 +02:00
SystemMessages: true
2021-06-30 21:30:41 +01:00
SystemMessage_EmbedFooter: false
2020-06-15 23:58:37 +01:00
SystemMessage_Channel: "system-messages"
2020-06-21 12:36:48 +01:00
SystemMessage_Type: "embed"
2020-06-20 13:02:46 +01:00
# There are 2 types of how you can send system messages, 'normal' or 'embed'
2021-06-30 21:30:41 +01:00
2020-06-21 15:56:16 +01:00
SystemMessage_Icon: "USER"
2021-06-30 21:30:41 +01:00
# USER - This will display the user's icon of who joins.
# BOT - This will display the bot's icon when a someone joins.
2021-08-05 13:39:44 +01:00
# CUSTOM - This will allow you to use a custom image, set this below!
SystemMessageIcon_URL: "https://imgur.com/example.png"
2020-06-20 13:02:46 +01:00
2020-06-21 15:56:16 +01:00
Welcome_Title: "User Joined!"
2020-06-20 13:02:46 +01:00
WelcomeMessage: "Hello %member%, Welcome to %guildname%!"
2020-07-15 18:42:07 +01:00
# %member% define the user who joined and %guildnamne% defines the server name.
2020-06-20 13:02:46 +01:00
2020-06-21 15:56:16 +01:00
Leave_Title: "User Left!"
2020-06-20 13:02:46 +01:00
LeaveMessage: "Goodbye %member%, Thank you for visting %guildname%!"
2020-07-15 18:42:07 +01:00
# %member% define the user who left and %guildnamne% defines the server name.
2020-06-15 23:58:37 +01:00
2021-06-30 21:30:41 +01:00
# -------------------------
# Links Configuration
# -------------------------
2020-06-15 23:58:37 +01:00
2021-06-30 21:30:41 +01:00
LinksTitle: "Server Links"
2020-06-15 23:58:37 +01:00
LINKS:
"Website": "https://www.example.com"
"Store": "https://store.example.com"
"Discord": "https://discord.gg/example"
2020-06-20 13:02:46 +01:00
# "Twitter": "https://twitter.com/example"
2021-06-30 21:30:41 +01:00
# "Add More": "Just follow this format!"
2020-06-15 23:58:37 +01:00
2021-06-30 21:30:41 +01:00
# --------------------------
# Suggestion Configuration
# --------------------------
2020-06-15 23:58:37 +01:00
SuggestionChannel: "suggestions"
SuggestionTitle: "Suggestion"
2021-06-30 21:30:41 +01:00
2020-06-15 23:58:37 +01:00
SuggestionStarter: "What would you like to suggest?"
SuggestReact_1: 👍
SuggestReact_2: 👎
2021-08-05 13:39:44 +01:00
SuggestionMessage_Icon: "USER"
# USER - This will display the user's icon of who joins.
# BOT - This will display the bot's icon when a someone joins.
# CUSTOM - This will allow you to use a custom image, set this below!
SuggestionIcon_URL: "https://imgur.com/example.png"
2021-06-30 21:30:41 +01:00
# ----------------------------
# Announcement Configuration
# ----------------------------
2020-06-15 23:58:37 +01:00
AnnouncementChannel: "announcements"
AnnouncementTitle: "Servername Announcement"
AnnouncementIcon: "https://i.imgur.com/HbkZyB7.png"
AnnouncementStarter: "What would you like to announce?"
2021-06-30 21:30:41 +01:00
# --------------------------
# Moderation Configuration
# --------------------------
2021-03-27 16:22:19 +00:00
2021-08-05 13:39:44 +01:00
ChatLog_Title: "Chat Log"
ChatLogChannel: "chat-logs"
ChatLogColour: "#1BA30C"
ChatLog_Thumbnail: "https://cdn.iconscout.com/icon/free/png-256/chat-2639493-2187526.png"
ChatLogSavedMessage: "📝 **Channel Transcript Saved!**"
2021-03-27 16:22:19 +00:00
BanTitle: "User Banned!"
DaysBannedFor: 7
BanLogColour: "#D911B4"
KickTitle: "User Kicked!"
KickLogColour: "#D9B111"
ModThumbnail: "https://i.imgur.com/l6P3DF6.png"
ModLogChannel: "mod-logs"
PruneLogTitle: "Bulk Delete"
PruneThumbnail: "https://i.imgur.com/OAgW2vR.png"
PruneColour: "#1BA30C"
2021-05-08 23:55:57 +02:00
BlacklistTitle: "Blacklisted User"
BlacklistColour: "#000000"
2021-06-30 21:30:41 +01:00
# --------------------------
# Command Configuration
# --------------------------
2021-03-27 16:22:19 +00:00
2021-06-30 21:30:41 +01:00
# --- User Commands ---
2020-06-15 23:58:37 +01:00
HelpCommand: "help"
LinksCommand: "links"
PingCommand: "ping"
SuggestCommand: "suggest"
2021-06-30 21:30:41 +01:00
# --- Ticket Commands ---
2020-06-15 23:58:37 +01:00
NewTicket: "ticket"
CloseTicket: "close"
AddUser: "add"
RemoveUser: "remove"
2020-07-11 13:17:57 +01:00
RenameTicket: "rename"
2021-06-30 21:30:41 +01:00
# --- Staff/Admin Commands ---
2020-07-11 13:17:57 +01:00
2021-08-05 13:39:44 +01:00
ChatLog: "transcript"
2020-07-14 19:17:40 +01:00
BotSay: "say"
2021-03-27 16:22:19 +00:00
PurgeMessage: "purge"
2020-07-11 13:17:57 +01:00
AnnounceCommand: "announce"
2021-03-27 16:22:19 +00:00
BanUser: "ban"
KickUser: "kick"
2021-05-08 23:42:35 +02:00
BlacklistUser: "blacklist"
2020-07-14 19:17:40 +01:00
2021-06-30 21:30:41 +01:00
# --------------------------
# Messages Configuration
# --------------------------
# --- Command Messages ---
2020-07-14 19:17:40 +01:00
2021-08-05 13:39:44 +01:00
BotSayDesc: "Say something with the bot"
ChatLogDesc: "Get a transcript of a channel"
2020-07-14 19:17:40 +01:00
NewTicketDesc: "Create a new support ticket"
AnnounceDesc: "Create a server announcement"
CloseTicketDesc: "Close your support ticket"
LinksDesc: "View some important links"
PingDesc: "Get the bot's latency"
HelpDesc: "Get a list of all the commands"
RemoveUserDesc: "Remove a user from a support ticket"
AddUserDesc: "Add a user to a support ticket"
SuggestionDesc: "Create a server suggestion"
2021-03-27 16:22:19 +00:00
BanDesc: "Ban a member from this server."
KickDesc: "Kick a member from this server."
PurgeDesc: "Purge messages from the chat."
2021-05-08 23:42:35 +02:00
BlacklistDesc: "Decline a member to open a ticket"
2020-07-14 19:17:40 +01:00
2021-06-30 21:30:41 +01:00
# Error / Warning Messages
2020-07-14 19:17:40 +01:00
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. This command is used when closing a ticket."
2021-06-30 21:33:16 +01:00
TicketExists: ":warning: This ticket cannot be opened, It already exists!"